src/Core/Content/Cms/Subscriber/CmsPageDefaultChangeSubscriber.php line 72

  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\Log\Package;
  14. use Shopware\Core\Framework\Uuid\Uuid;
  15. use Shopware\Core\System\SystemConfig\Event\BeforeSystemConfigChangedEvent;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. /**
  19.  * @internal
  20.  */
  21. #[Package('content')]
  22. class CmsPageDefaultChangeSubscriber implements EventSubscriberInterface
  23. {
  24.     /**
  25.      * @var array<string>
  26.      */
  27.     public static array $defaultCmsPageConfigKeys = [
  28.         ProductDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_PRODUCT,
  29.         CategoryDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_CATEGORY,
  30.     ];
  32.     /**
  33.      * @internal
  34.      */
  35.     public function __construct(private readonly Connection $connection)
  36.     {
  37.     }
  39.     public static function getSubscribedEvents(): array
  40.     {
  41.         return [
  42.             BeforeSystemConfigChangedEvent::class => 'validateChangeOfDefaultCmsPage',
  43.             BeforeDeleteEvent::class => 'beforeDeletion',
  44.         ];
  45.     }
  47.     /**
  48.      * @throws CmsException
  49.      * @throws \JsonException
  50.      */
  51.     public function beforeDeletion(BeforeDeleteEvent $event): void
  52.     {
  53.         $cmsPageIds = $event->getIds(CmsPageDefinition::ENTITY_NAME);
  55.         // no cms page is affected by this deletion event
  56.         if (empty($cmsPageIds)) {
  57.             return;
  58.         }
  60.         $defaultPages = $this->cmsPageIsDefault($cmsPageIds);
  62.         // count !== 0 indicates that there are some cms pages which would be deleted but are currently a default
  63.         if (\count($defaultPages) !== 0) {
  64.             throw CmsException::deletionOfDefault($defaultPages);
  65.         }
  66.     }
  68.     /**
  69.      * @throws CmsException
  70.      * @throws PageNotFoundException
  71.      */
  72.     public function validateChangeOfDefaultCmsPage(BeforeSystemConfigChangedEvent $event): void
  73.     {
  74.         $newDefaultCmsPageId = $event->getValue();
  75.         $systemConfigKey = $event->getKey();
  76.         $salesChannelId = $event->getSalesChannelId();
  78.         if (!\in_array($systemConfigKey, self::$defaultCmsPageConfigKeys, true)) {
  79.             return;
  80.         }
  82.         // prevent deleting the overall default (salesChannelId === null)
  83.         // a sales channel specific default can still be deleted (salesChannelId !== null)
  84.         if ($newDefaultCmsPageId === null && $salesChannelId === null) {
  85.             $oldCmsPageId = $this->getCurrentOverallDefaultCmsPageId($systemConfigKey);
  87.             throw CmsException::overallDefaultSystemConfigDeletion($oldCmsPageId);
  88.         }
  90.         if (!\is_string($newDefaultCmsPageId) && $newDefaultCmsPageId !== null) {
  91.             throw new PageNotFoundException('invalid page');
  92.         }
  94.         // prevent changing the default to an invalid cms page id
  95.         if (\is_string($newDefaultCmsPageId) && !$this->cmsPageExists($newDefaultCmsPageId)) {
  96.             throw new PageNotFoundException($newDefaultCmsPageId);
  97.         }
  98.     }
  100.     private function getCurrentOverallDefaultCmsPageId(string $systemConfigKey): string
  101.     {
  102.         $result = $this->connection->fetchOne(
  103.             'SELECT configuration_value FROM system_config WHERE configuration_key = :configKey AND sales_channel_id is NULL;',
  104.             [
  105.                 'configKey' => $systemConfigKey,
  106.             ]
  107.         );
  109.         $config = json_decode((string) $result, true, 512, \JSON_THROW_ON_ERROR);
  111.         return $config['_value'];
  112.     }
  114.     /**
  115.      * @param array<string> $cmsPageIds
  116.      *
  117.      * @return array<string>
  118.      */
  119.     private function cmsPageIsDefault(array $cmsPageIds): array
  120.     {
  121.         $configurations = $this->connection->fetchAllAssociative(
  122.             'SELECT DISTINCT configuration_value FROM system_config WHERE configuration_key IN (:configKeys);',
  123.             [
  124.                 'configKeys' => self::$defaultCmsPageConfigKeys,
  125.             ],
  126.             [
  127.                 'configKeys' => Connection::PARAM_STR_ARRAY,
  128.             ]
  129.         );
  131.         $defaultIds = [];
  132.         foreach ($configurations as $configuration) {
  133.             $configValue = $configuration['configuration_value'];
  134.             $config = json_decode((string) $configValue, true, 512, \JSON_THROW_ON_ERROR);
  136.             $defaultIds[] = $config['_value'];
  137.         }
  139.         // returns from all provided cms pages the ones which are default
  140.         return array_intersect($cmsPageIds, $defaultIds);
  141.     }
  143.     private function cmsPageExists(string $cmsPageId): bool
  144.     {
  145.         $count = $this->connection->fetchOne(
  146.             'SELECT count(*) FROM cms_page WHERE id = :cmsPageId AND version_id = :versionId LIMIT 1;',
  147.             [
  148.                 'cmsPageId' => Uuid::fromHexToBytes($cmsPageId),
  149.                 'versionId' => Uuid::fromHexToBytes(Defaults::LIVE_VERSION),
  150.             ]
  151.         );
  153.         return $count === '1';
  154.     }
  155. }