custom/plugins/SasBlogModule/src/SasBlogModule.php line 31

  1. <?php declare(strict_types=1);
  3. namespace Sas\BlogModule;
  5. use Doctrine\DBAL\Connection;
  6. use Doctrine\DBAL\Driver\Result;
  7. use Sas\BlogModule\Content\Blog\BlogEntriesDefinition;
  8. use Sas\BlogModule\Content\Blog\BlogSeoUrlRoute;
  9. use Sas\BlogModule\Content\Blog\Events\BlogIndexerEvent;
  10. use Sas\BlogModule\Util\Lifecycle;
  11. use Sas\BlogModule\Util\Update;
  12. use Shopware\Core\Content\Media\Aggregate\MediaThumbnailSize\MediaThumbnailSizeEntity;
  13. use Shopware\Core\Content\Seo\SeoUrlTemplate\SeoUrlTemplateCollection;
  14. use Shopware\Core\Content\Seo\SeoUrlTemplate\SeoUrlTemplateEntity;
  15. use Shopware\Core\Defaults;
  16. use Shopware\Core\Framework\Context;
  17. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\NotFilter;
  22. use Shopware\Core\Framework\Plugin;
  23. use Shopware\Core\Framework\Plugin\Context\InstallContext;
  24. use Shopware\Core\Framework\Plugin\Context\UninstallContext;
  25. use Shopware\Core\Framework\Plugin\Context\UpdateContext;
  26. use Shopware\Core\Framework\Uuid\Uuid;
  27. use Shopware\Core\Kernel;
  28. use Shopware\Core\System\SystemConfig\SystemConfigService;
  29. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  31. class SasBlogModule extends Plugin
  32. {
  33.     public const ANONYMOUS_AUTHOR_ID = '64f4c60194634128b9b85d9299797c45';
  35.     public function install(InstallContext $installContext): void
  36.     {
  37.         parent::install($installContext);
  39.         $this->createBlogMediaFolder($installContext->getContext());
  41.         $this->getLifeCycle()->install($installContext->getContext());
  42.     }
  44.     public function uninstall(UninstallContext $context): void
  45.     {
  46.         parent::uninstall($context);
  48.         // Always remove the SEO url template to avoid error that can't be changed afterward.
  49.         $this->deleteSeoUrlTemplate($context->getContext());
  51.         if ($context->keepUserData()) {
  52.             return;
  53.         }
  55.         /*
  56.          * We need to uninstall our default media folder,
  57.          * the media folder and the thumbnail sizes.
  58.          * However, we have to clean this up within a next update :)
  59.          */
  60.         $this->deleteMediaFolder($context->getContext());
  61.         $this->deleteDefaultMediaFolder($context->getContext());
  63.         /**
  64.          * And of course we need to drop our tables
  65.          */
  66.         $connection = Kernel::getConnection();
  68.         $connection->executeStatement('SET FOREIGN_KEY_CHECKS=0;');
  69.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_entries`');
  70.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_entries_translation`');
  71.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_blog_category`');
  72.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_product`');
  73.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_category_translation`');
  74.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_category`');
  75.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_author_translation`');
  76.         $connection->executeStatement('DROP TABLE IF EXISTS `sas_blog_author`');
  78.         /** @var EntityRepository $cmsBlockRepo */
  79.         $cmsBlockRepo = $this->container->get('cms_block.repository');
  81.         $context = Context::createDefaultContext();
  83.         $criteria = new Criteria();
  84.         $criteria->addFilter(new EqualsAnyFilter('type', ['blog-detail', 'blog-listing', 'blog-assignment']));
  86.         $cmsBlocks = $cmsBlockRepo->searchIds($criteria, $context);
  88.         $cmsBlockRepo->delete(array_values($cmsBlocks->getData()), $context);
  90.         $connection->executeQuery('SET FOREIGN_KEY_CHECKS=1;');
  91.     }
  93.     public function update(UpdateContext $updateContext): void
  94.     {
  95.         parent::update($updateContext);
  97.         (new Update())->update($this->container, $updateContext);
  99.         if (version_compare($updateContext->getCurrentPluginVersion(), '1.1.0', '<')) {
  100.             $this->createBlogMediaFolder($updateContext->getContext());
  101.         }
  103.         if (version_compare($updateContext->getCurrentPluginVersion(), '1.5.10', '<')) {
  104.             $this->fixSeoUrlTemplate($updateContext->getContext());
  105.             $this->updateSeoUrls($updateContext->getContext());
  106.         }
  107.     }
  109.     /**
  110.      * We need to create a folder for the blog media with it's,
  111.      * own configuration to generate thumbnails for the teaser image.
  112.      */
  113.     public function createBlogMediaFolder(Context $context): void
  114.     {
  115.         $this->deleteDefaultMediaFolder($context);
  116.         $thumbnailSizes = $this->getThumbnailSizes($context);
  118.         /** @var EntityRepository $mediaFolderRepository */
  119.         $mediaFolderRepository = $this->container->get('media_default_folder.repository');
  121.         $data = [
  122.             [
  123.                 'entity' => BlogEntriesDefinition::ENTITY_NAME,
  124.                 'associationFields' => ['media'],
  125.                 'folder' => [
  126.                     'name' => 'Blog Images',
  127.                     'useParentConfiguration' => false,
  128.                     'configuration' => [
  129.                         'createThumbnails' => true,
  130.                         'keepAspectRatio' => true,
  131.                         'thumbnailQuality' => 90,
  132.                         'mediaThumbnailSizes' => $thumbnailSizes,
  133.                     ],
  134.                 ],
  135.             ],
  136.         ];
  138.         $mediaFolderRepository->create($data, $context);
  139.     }
  141.     private function deleteDefaultMediaFolder(Context $context): void
  142.     {
  143.         $criteria = new Criteria();
  144.         $criteria->addFilter(
  145.             new EqualsAnyFilter('entity', [
  146.                 BlogEntriesDefinition::ENTITY_NAME,
  147.             ])
  148.         );
  150.         /** @var EntityRepository $mediaFolderRepository */
  151.         $mediaFolderRepository = $this->container->get('media_default_folder.repository');
  153.         $mediaFolderIds = $mediaFolderRepository->searchIds($criteria, $context)->getIds();
  155.         if (!empty($mediaFolderIds)) {
  156.             $ids = array_map(static function ($id) {
  157.                 return ['id' => $id];
  158.             }, $mediaFolderIds);
  159.             $mediaFolderRepository->delete($ids, $context);
  160.         }
  161.     }
  163.     private function deleteMediaFolder(Context $context): void
  164.     {
  165.         $criteria = new Criteria();
  166.         $criteria->addFilter(
  167.             new EqualsFilter('name', 'Blog Images')
  168.         );
  170.         /** @var EntityRepository $mediaFolderRepository */
  171.         $mediaFolderRepository = $this->container->get('media_folder.repository');
  173.         $mediaFolderRepository->search($criteria, $context);
  175.         $mediaFolderIds = $mediaFolderRepository->searchIds($criteria, $context)->getIds();
  177.         if (!empty($mediaFolderIds)) {
  178.             $ids = array_map(static function ($id) {
  179.                 return ['id' => $id];
  180.             }, $mediaFolderIds);
  181.             $mediaFolderRepository->delete($ids, $context);
  182.         }
  183.     }
  185.     private function deleteSeoUrlTemplate(Context $context): void
  186.     {
  187.         $criteria = new Criteria();
  188.         $criteria->addFilter(
  189.             new EqualsFilter('entityName', 'sas_blog_entries')
  190.         );
  192.         /** @var EntityRepository $seoUrlTemplateRepository */
  193.         $seoUrlTemplateRepository = $this->container->get('seo_url_template.repository');
  195.         $seoUrlTemplateRepository->search($criteria, $context);
  197.         $seoUrlTemplateIds = $seoUrlTemplateRepository->searchIds($criteria, $context)->getIds();
  199.         if (!empty($seoUrlTemplateIds)) {
  200.             $ids = array_map(static function ($id) {
  201.                 return ['id' => $id];
  202.             }, $seoUrlTemplateIds);
  203.             $seoUrlTemplateRepository->delete($ids, $context);
  204.         }
  205.     }
  207.     private function getThumbnailSizes(Context $context): array
  208.     {
  209.         $mediaThumbnailSizes = [
  210.             '330x185' => [
  211.                 'width' => 330,
  212.                 'height' => 185,
  213.             ],
  214.             '650x365' => [
  215.                 'width' => 650,
  216.                 'height' => 365,
  217.             ],
  218.             '900x506' => [
  219.                 'width' => 900,
  220.                 'height' => 506,
  221.             ],
  222.             '1280x720' => [
  223.                 'width' => 1280,
  224.                 'height' => 720,
  225.             ],
  226.         ];
  228.         $criteria = new Criteria();
  230.         /** @var EntityRepository $thumbnailSizeRepository */
  231.         $thumbnailSizeRepository = $this->container->get('media_thumbnail_size.repository');
  233.         $thumbnailSizes = $thumbnailSizeRepository->search($criteria, $context)->getEntities();
  235.         $mediaThumbnailSizesAddedIds = [];
  236.         /** @var MediaThumbnailSizeEntity $thumbnailSize */
  237.         foreach ($thumbnailSizes as $thumbnailSize) {
  238.             $key = $thumbnailSize->getWidth() . 'x' . $thumbnailSize->getHeight();
  239.             if (\array_key_exists($key, $mediaThumbnailSizes)) {
  240.                 $mediaThumbnailSize = $mediaThumbnailSizes[$key];
  241.                 $mediaThumbnailSizesAddedIds[$key] = array_merge(
  242.                     ['id' => $thumbnailSize->getId()],
  243.                     $mediaThumbnailSize,
  244.                 );
  245.                 unset($mediaThumbnailSizes[$key]);
  246.             }
  247.         }
  249.         $mediaThumbnailSizesCreateData = [];
  250.         foreach ($mediaThumbnailSizes as $key => $mediaThumbnailSize) {
  251.             $data = array_merge(
  252.                 ['id' => Uuid::randomHex()],
  253.                 $mediaThumbnailSize,
  254.             );
  256.             $mediaThumbnailSizesCreateData[$key] = $data;
  257.             $mediaThumbnailSizesAddedIds[$key] = $data;
  258.         }
  260.         if (\count($mediaThumbnailSizesCreateData) > 0) {
  261.             $thumbnailSizeRepository->create(array_values($mediaThumbnailSizesCreateData), $context);
  262.         }
  264.         return array_values($mediaThumbnailSizesAddedIds);
  265.     }
  267.     private function getLifeCycle(): Lifecycle
  268.     {
  269.         /** @var SystemConfigService $systemConfig */
  270.         $systemConfig = $this->container->get(SystemConfigService::class);
  272.         /** @var EntityRepository $cmsPageRepository */
  273.         $cmsPageRepository = $this->container->get('cms_page.repository');
  275.         return new Lifecycle(
  276.             $systemConfig,
  277.             $cmsPageRepository
  278.         );
  279.     }
  281.     private function fixSeoUrlTemplate(Context $context): void
  282.     {
  283.         $criteria = new Criteria();
  284.         $criteria->addFilter(new EqualsFilter('routeName', BlogSeoUrlRoute::ROUTE_NAME));
  285.         $criteria->addFilter(new EqualsFilter('entityName', BlogEntriesDefinition::ENTITY_NAME));
  286.         $criteria->addFilter(new NotFilter(
  287.             NotFilter::CONNECTION_AND,
  288.             [new EqualsFilter('template', null)]
  289.         ));
  291.         /** @var EntityRepository $seoUrlTemplateRepository */
  292.         $seoUrlTemplateRepository = $this->container->get('seo_url_template.repository');
  294.         /** @var SeoUrlTemplateCollection $seoUrlTemplates */
  295.         $seoUrlTemplates = $seoUrlTemplateRepository->search($criteria, $context)->getEntities();
  297.         $update = [];
  298.         /** @var SeoUrlTemplateEntity $seoUrlTemplate */
  299.         foreach ($seoUrlTemplates as $seoUrlTemplate) {
  300.             // If the clients fixed it in SEO template we don't have to do again
  301.             if (strpos($seoUrlTemplate->getTemplate(), 'entry.translated')) {
  302.                 continue;
  303.             }
  305.             // We found the issue
  306.             if (!strpos($seoUrlTemplate->getTemplate(), 'entry.title')) {
  307.                 continue;
  308.             }
  310.             $templateReplaced = str_replace('entry.title', 'entry.translated.title', $seoUrlTemplate->getTemplate());
  311.             if (!\is_string($templateReplaced)) {
  312.                 continue;
  313.             }
  315.             $update[] = [
  316.                 'id' => $seoUrlTemplate->getId(),
  317.                 'template' => $templateReplaced,
  318.             ];
  319.         }
  321.         if (\count($update) === 0) {
  322.             return;
  323.         }
  325.         $seoUrlTemplateRepository->update($update, $context);
  326.     }
  328.     private function updateSeoUrls(Context $context): void
  329.     {
  330.         $blogArticlesIds = $this->getBlogArticlesIds();
  331.         if (\count($blogArticlesIds) === 0) {
  332.             return;
  333.         }
  335.         if ($this->container->get('event_dispatcher') instanceof EventDispatcherInterface) {
  336.             $eventDispatcher = $this->container->get('event_dispatcher');
  337.             $eventDispatcher->dispatch(new BlogIndexerEvent($blogArticlesIds, $context));
  338.         }
  339.     }
  341.     private function getBlogArticlesIds(): array
  342.     {
  343.         /** @var Connection $connection */
  344.         $connection = $this->container->get(Connection::class);
  345.         if (!$connection->getSchemaManager()->tablesExist([BlogEntriesDefinition::ENTITY_NAME])) {
  346.             return [];
  347.         }
  349.         $now = (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  351.         $query = $connection->createQueryBuilder();
  352.         $query->select([
  353.             'LOWER(HEX(id)) as id',
  354.         ]);
  355.         $query->where('active = true')->andWhere('published_at <= :now');
  356.         $query->setParameter('now', $now);
  357.         $query->from(BlogEntriesDefinition::ENTITY_NAME);
  358.         if (!$query->execute() instanceof Result) {
  359.             return [];
  360.         }
  361.         $results = $query->execute()->fetchAllAssociative();
  363.         if (empty($results)) {
  364.             return [];
  365.         }
  367.         return array_column($results, 'id');
  368.     }
  369. }