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

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