vendor/shopware/core/Content/Cms/Subscriber/CmsPageDefaultChangeSubscriber.php line 50

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Cms\Subscriber;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Category\CategoryDefinition;
  7. use Shopware\Core\Content\Cms\CmsException;
  8. use Shopware\Core\Content\Cms\CmsPageDefinition;
  9. use Shopware\Core\Content\Cms\Exception\PageNotFoundException;
  10. use Shopware\Core\Content\Product\ProductDefinition;
  11. use Shopware\Core\Defaults;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Event\BeforeDeleteEvent;
  13. use Shopware\Core\Framework\Uuid\Uuid;
  14. use Shopware\Core\System\SystemConfig\Event\BeforeSystemConfigChangedEvent;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. class CmsPageDefaultChangeSubscriber implements EventSubscriberInterface
  18. {
  19.     /**
  20.      * @var array<string>
  21.      */
  22.     public static array $defaultCmsPageConfigKeys = [
  23.         ProductDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_PRODUCT,
  24.         CategoryDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_CATEGORY,
  25.     ];
  27.     private Connection $connection;
  29.     /**
  30.      * @internal
  31.      */
  32.     public function __construct(
  33.         Connection $connection
  34.     ) {
  35.         $this->connection = $connection;
  36.     }
  38.     public static function getSubscribedEvents(): array
  39.     {
  40.         return [
  41.             BeforeSystemConfigChangedEvent::class => 'validateChangeOfDefaultCmsPage',
  42.             BeforeDeleteEvent::class => 'beforeDeletion',
  43.         ];
  44.     }
  46.     /**
  47.      * @throws CmsException
  48.      * @throws \JsonException
  49.      */
  50.     public function beforeDeletion(BeforeDeleteEvent $event): void
  51.     {
  52.         $cmsPageIds = $event->getIds(CmsPageDefinition::ENTITY_NAME);
  54.         // no cms page is affected by this deletion event
  55.         if (empty($cmsPageIds)) {
  56.             return;
  57.         }
  59.         $defaultPages = $this->cmsPageIsDefault($cmsPageIds);
  61.         // count !== 0 indicates that there are some cms pages which would be deleted but are currently a default
  62.         if (\count($defaultPages) !== 0) {
  63.             throw CmsException::deletionOfDefault($defaultPages);
  64.         }
  65.     }
  67.     /**
  68.      * @throws CmsException
  69.      * @throws PageNotFoundException
  70.      */
  71.     public function validateChangeOfDefaultCmsPage(BeforeSystemConfigChangedEvent $event): void
  72.     {
  73.         $newDefaultCmsPageId = $event->getValue();
  74.         $systemConfigKey = $event->getKey();
  75.         $salesChannelId = $event->getSalesChannelId();
  77.         if (!\in_array($systemConfigKey, self::$defaultCmsPageConfigKeys, true)) {
  78.             return;
  79.         }
  81.         // prevent deleting the overall default (salesChannelId === null)
  82.         // a sales channel specific default can still be deleted (salesChannelId !== null)
  83.         if ($newDefaultCmsPageId === null && $salesChannelId === null) {
  84.             $oldCmsPageId = $this->getCurrentOverallDefaultCmsPageId($systemConfigKey);
  86.             throw CmsException::overallDefaultSystemConfigDeletion($oldCmsPageId);
  87.         }
  89.         if (!\is_string($newDefaultCmsPageId) && $newDefaultCmsPageId !== null) {
  90.             throw new PageNotFoundException('invalid page');
  91.         }
  93.         // prevent changing the default to an invalid cms page id
  94.         if (\is_string($newDefaultCmsPageId) && !$this->cmsPageExists($newDefaultCmsPageId)) {
  95.             throw new PageNotFoundException($newDefaultCmsPageId);
  96.         }
  97.     }
  99.     private function getCurrentOverallDefaultCmsPageId(string $systemConfigKey): string
  100.     {
  101.         $result = $this->connection->fetchOne(
  102.             'SELECT configuration_value FROM system_config WHERE configuration_key = :configKey AND sales_channel_id is NULL;',
  103.             [
  104.                 'configKey' => $systemConfigKey,
  105.             ]
  106.         );
  108.         $config = json_decode($result, true);
  110.         return $config['_value'];
  111.     }
  113.     /**
  114.      * @param array<string> $cmsPageIds
  115.      *
  116.      * @return array<string>
  117.      */
  118.     private function cmsPageIsDefault(array $cmsPageIds): array
  119.     {
  120.         $configurations = $this->connection->fetchAllAssociative(
  121.             'SELECT DISTINCT configuration_value FROM system_config WHERE configuration_key IN (:configKeys);',
  122.             [
  123.                 'configKeys' => self::$defaultCmsPageConfigKeys,
  124.             ],
  125.             [
  126.                 'configKeys' => Connection::PARAM_STR_ARRAY,
  127.             ]
  128.         );
  130.         $defaultIds = [];
  131.         foreach ($configurations as $configuration) {
  132.             $configValue = $configuration['configuration_value'];
  133.             $config = json_decode($configValue, true);
  135.             $defaultIds[] = $config['_value'];
  136.         }
  138.         // returns from all provided cms pages the ones which are default
  139.         return array_intersect($cmsPageIds, $defaultIds);
  140.     }
  142.     private function cmsPageExists(string $cmsPageId): bool
  143.     {
  144.         $count = $this->connection->fetchOne(
  145.             'SELECT count(*) FROM cms_page WHERE id = :cmsPageId AND version_id = :versionId LIMIT 1;',
  146.             [
  147.                 'cmsPageId' => Uuid::fromHexToBytes($cmsPageId),
  148.                 'versionId' => Uuid::fromHexToBytes(Defaults::LIVE_VERSION),
  149.             ]
  150.         );
  152.         return $count === '1';
  153.     }
  154. }