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

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