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

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. /**
  18.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  19.  */
  20. class CmsPageDefaultChangeSubscriber implements EventSubscriberInterface
  21. {
  22.     /**
  23.      * @var array<string>
  24.      */
  25.     public static array $defaultCmsPageConfigKeys = [
  26.         ProductDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_PRODUCT,
  27.         CategoryDefinition::CONFIG_KEY_DEFAULT_CMS_PAGE_CATEGORY,
  28.     ];
  30.     private Connection $connection;
  32.     /**
  33.      * @internal
  34.      */
  35.     public function __construct(
  36.         Connection $connection
  37.     ) {
  38.         $this->connection = $connection;
  39.     }
  41.     public static function getSubscribedEvents(): array
  42.     {
  43.         return [
  44.             BeforeSystemConfigChangedEvent::class => 'validateChangeOfDefaultCmsPage',
  45.             BeforeDeleteEvent::class => 'beforeDeletion',
  46.         ];
  47.     }
  49.     /**
  50.      * @throws CmsException
  51.      * @throws \JsonException
  52.      */
  53.     public function beforeDeletion(BeforeDeleteEvent $event): void
  54.     {
  55.         $cmsPageIds = $event->getIds(CmsPageDefinition::ENTITY_NAME);
  57.         // no cms page is affected by this deletion event
  58.         if (empty($cmsPageIds)) {
  59.             return;
  60.         }
  62.         $defaultPages = $this->cmsPageIsDefault($cmsPageIds);
  64.         // count !== 0 indicates that there are some cms pages which would be deleted but are currently a default
  65.         if (\count($defaultPages) !== 0) {
  66.             throw CmsException::deletionOfDefault($defaultPages);
  67.         }
  68.     }
  70.     /**
  71.      * @throws CmsException
  72.      * @throws PageNotFoundException
  73.      */
  74.     public function validateChangeOfDefaultCmsPage(BeforeSystemConfigChangedEvent $event): void
  75.     {
  76.         $newDefaultCmsPageId = $event->getValue();
  77.         $systemConfigKey = $event->getKey();
  78.         $salesChannelId = $event->getSalesChannelId();
  80.         if (!\in_array($systemConfigKey, self::$defaultCmsPageConfigKeys, true)) {
  81.             return;
  82.         }
  84.         // prevent deleting the overall default (salesChannelId === null)
  85.         // a sales channel specific default can still be deleted (salesChannelId !== null)
  86.         if ($newDefaultCmsPageId === null && $salesChannelId === null) {
  87.             $oldCmsPageId = $this->getCurrentOverallDefaultCmsPageId($systemConfigKey);
  89.             throw CmsException::overallDefaultSystemConfigDeletion($oldCmsPageId);
  90.         }
  92.         if (!\is_string($newDefaultCmsPageId) && $newDefaultCmsPageId !== null) {
  93.             throw new PageNotFoundException('invalid page');
  94.         }
  96.         // prevent changing the default to an invalid cms page id
  97.         if (\is_string($newDefaultCmsPageId) && !$this->cmsPageExists($newDefaultCmsPageId)) {
  98.             throw new PageNotFoundException($newDefaultCmsPageId);
  99.         }
  100.     }
  102.     private function getCurrentOverallDefaultCmsPageId(string $systemConfigKey): string
  103.     {
  104.         $result = $this->connection->fetchOne(
  105.             'SELECT configuration_value FROM system_config WHERE configuration_key = :configKey AND sales_channel_id is NULL;',
  106.             [
  107.                 'configKey' => $systemConfigKey,
  108.             ]
  109.         );
  111.         $config = json_decode($result, true);
  113.         return $config['_value'];
  114.     }
  116.     /**
  117.      * @param array<string> $cmsPageIds
  118.      *
  119.      * @return array<string>
  120.      */
  121.     private function cmsPageIsDefault(array $cmsPageIds): array
  122.     {
  123.         $configurations = $this->connection->fetchAllAssociative(
  124.             'SELECT DISTINCT configuration_value FROM system_config WHERE configuration_key IN (:configKeys);',
  125.             [
  126.                 'configKeys' => self::$defaultCmsPageConfigKeys,
  127.             ],
  128.             [
  129.                 'configKeys' => Connection::PARAM_STR_ARRAY,
  130.             ]
  131.         );
  133.         $defaultIds = [];
  134.         foreach ($configurations as $configuration) {
  135.             $configValue = $configuration['configuration_value'];
  136.             $config = json_decode($configValue, true);
  138.             $defaultIds[] = $config['_value'];
  139.         }
  141.         // returns from all provided cms pages the ones which are default
  142.         return array_intersect($cmsPageIds, $defaultIds);
  143.     }
  145.     private function cmsPageExists(string $cmsPageId): bool
  146.     {
  147.         $count = $this->connection->fetchOne(
  148.             'SELECT count(*) FROM cms_page WHERE id = :cmsPageId AND version_id = :versionId LIMIT 1;',
  149.             [
  150.                 'cmsPageId' => Uuid::fromHexToBytes($cmsPageId),
  151.                 'versionId' => Uuid::fromHexToBytes(Defaults::LIVE_VERSION),
  152.             ]
  153.         );
  155.         return $count === '1';
  156.     }
  157. }