vendor/shopware/core/System/SalesChannel/Validation/SalesChannelValidator.php line 54

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Validation;
  5. use Doctrine\DBAL\ArrayParameterType;
  6. use Doctrine\DBAL\Connection;
  7. use Shopware\Core\Defaults;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Uuid\Uuid;
  15. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  16. use Shopware\Core\System\SalesChannel\Aggregate\SalesChannelLanguage\SalesChannelLanguageDefinition;
  17. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\Validator\ConstraintViolation;
  20. use Symfony\Component\Validator\ConstraintViolationList;
  22. /**
  23.  * @internal
  24.  */
  25. #[Package('sales-channel')]
  26. class SalesChannelValidator implements EventSubscriberInterface
  27. {
  28.     private const INSERT_VALIDATION_MESSAGE = 'The sales channel with id "%s" does not have a default sales channel language id in the language list.';
  29.     private const INSERT_VALIDATION_CODE = 'SYSTEM__NO_GIVEN_DEFAULT_LANGUAGE_ID';
  31.     private const DUPLICATED_ENTRY_VALIDATION_MESSAGE = 'The sales channel language "%s" for the sales channel "%s" already exists.';
  32.     private const DUPLICATED_ENTRY_VALIDATION_CODE = 'SYSTEM__DUPLICATED_SALES_CHANNEL_LANGUAGE';
  34.     private const UPDATE_VALIDATION_MESSAGE = 'Cannot update default language id because the given id is not in the language list of sales channel with id "%s"';
  35.     private const UPDATE_VALIDATION_CODE = 'SYSTEM__CANNOT_UPDATE_DEFAULT_LANGUAGE_ID';
  37.     private const DELETE_VALIDATION_MESSAGE = 'Cannot delete default language id from language list of the sales channel with id "%s".';
  38.     private const DELETE_VALIDATION_CODE = 'SYSTEM__CANNOT_DELETE_DEFAULT_LANGUAGE_ID';
  40.     /**
  41.      * @internal
  42.      */
  43.     public function __construct(private readonly Connection $connection)
  44.     {
  45.     }
  47.     public static function getSubscribedEvents(): array
  48.     {
  49.         return [
  50.             PreWriteValidationEvent::class => 'handleSalesChannelLanguageIds',
  51.         ];
  52.     }
  54.     public function handleSalesChannelLanguageIds(PreWriteValidationEvent $event): void
  55.     {
  56.         $mapping = $this->extractMapping($event);
  58.         if (!$mapping) {
  59.             return;
  60.         }
  62.         $salesChannelIds = array_keys($mapping);
  63.         $states = $this->fetchCurrentLanguageStates($salesChannelIds);
  65.         $mapping = $this->mergeCurrentStatesWithMapping($mapping, $states);
  67.         $this->validateLanguages($mapping, $event);
  68.     }
  70.     /**
  71.      * Build a key map with the following data structure:
  72.      *
  73.      * 'sales_channel_id' => [
  74.      *     'current_default' => 'en',
  75.      *     'new_default' => 'de',
  76.      *     'inserts' => ['de', 'en'],
  77.      *     'updates' => ['de', 'de'],
  78.      *     'deletions' => ['gb'],
  79.      *     'state' => ['en', 'gb']
  80.      * ]
  81.      *
  82.      * @return array<string, array<string, list<string>>>
  83.      */
  84.     private function extractMapping(PreWriteValidationEvent $event): array
  85.     {
  86.         $mapping = [];
  87.         foreach ($event->getCommands() as $command) {
  88.             if ($command->getDefinition() instanceof SalesChannelDefinition) {
  89.                 $this->handleSalesChannelMapping($mapping, $command);
  91.                 continue;
  92.             }
  94.             if ($command->getDefinition() instanceof SalesChannelLanguageDefinition) {
  95.                 $this->handleSalesChannelLanguageMapping($mapping, $command);
  96.             }
  97.         }
  99.         return $mapping;
  100.     }
  102.     /**
  103.      * @param array<string, array<string, list<string>>> $mapping
  104.      */
  105.     private function handleSalesChannelMapping(array &$mapping, WriteCommand $command): void
  106.     {
  107.         if (!isset($command->getPayload()['language_id'])) {
  108.             return;
  109.         }
  111.         if ($command instanceof UpdateCommand) {
  112.             $id = Uuid::fromBytesToHex($command->getPrimaryKey()['id']);
  113.             $mapping[$id]['updates'] = Uuid::fromBytesToHex($command->getPayload()['language_id']);
  115.             return;
  116.         }
  118.         if (!$command instanceof InsertCommand || !$this->isSupportedSalesChannelType($command)) {
  119.             return;
  120.         }
  122.         $id = Uuid::fromBytesToHex($command->getPrimaryKey()['id']);
  123.         $mapping[$id]['new_default'] = Uuid::fromBytesToHex($command->getPayload()['language_id']);
  124.         $mapping[$id]['inserts'] = [];
  125.         $mapping[$id]['state'] = [];
  126.     }
  128.     private function isSupportedSalesChannelType(WriteCommand $command): bool
  129.     {
  130.         $typeId = Uuid::fromBytesToHex($command->getPayload()['type_id']);
  132.         return $typeId === Defaults::SALES_CHANNEL_TYPE_STOREFRONT
  133.             || $typeId === Defaults::SALES_CHANNEL_TYPE_API;
  134.     }
  136.     /**
  137.      * @param array<string, list<string>> $mapping
  138.      */
  139.     private function handleSalesChannelLanguageMapping(array &$mapping, WriteCommand $command): void
  140.     {
  141.         $language = Uuid::fromBytesToHex($command->getPrimaryKey()['language_id']);
  142.         $id = Uuid::fromBytesToHex($command->getPrimaryKey()['sales_channel_id']);
  143.         $mapping[$id]['state'] = [];
  145.         if ($command instanceof DeleteCommand) {
  146.             $mapping[$id]['deletions'][] = $language;
  148.             return;
  149.         }
  151.         if ($command instanceof InsertCommand) {
  152.             $mapping[$id]['inserts'][] = $language;
  153.         }
  154.     }
  156.     /**
  157.      * @param array<string, array<string, list<string>>> $mapping
  158.      */
  159.     private function validateLanguages(array $mapping, PreWriteValidationEvent $event): void
  160.     {
  161.         $inserts = [];
  162.         $duplicates = [];
  163.         $deletions = [];
  164.         $updates = [];
  166.         foreach ($mapping as $id => $channel) {
  167.             if (isset($channel['inserts'])) {
  168.                 if (!$this->validInsertCase($channel)) {
  169.                     $inserts[$id] = $channel['new_default'];
  170.                 }
  172.                 $duplicatedIds = $this->getDuplicates($channel);
  174.                 if ($duplicatedIds) {
  175.                     $duplicates[$id] = $duplicatedIds;
  176.                 }
  177.             }
  179.             if (isset($channel['deletions']) && !$this->validDeleteCase($channel)) {
  180.                 $deletions[$id] = $channel['current_default'];
  181.             }
  183.             if (isset($channel['updates']) && !$this->validUpdateCase($channel)) {
  184.                 $updates[$id] = $channel['updates'];
  185.             }
  186.         }
  188.         $this->writeInsertViolationExceptions($inserts, $event);
  189.         $this->writeDuplicateViolationExceptions($duplicates, $event);
  190.         $this->writeDeleteViolationExceptions($deletions, $event);
  191.         $this->writeUpdateViolationExceptions($updates, $event);
  192.     }
  194.     /**
  195.      * @param array<string, mixed> $channel
  196.      */
  197.     private function validInsertCase(array $channel): bool
  198.     {
  199.         return empty($channel['new_default'])
  200.             || \in_array($channel['new_default'], $channel['inserts'], true);
  201.     }
  203.     /**
  204.      * @param array<string, mixed> $channel
  205.      */
  206.     private function validUpdateCase(array $channel): bool
  207.     {
  208.         $updateId = $channel['updates'];
  210.         return \in_array($updateId, $channel['state'], true)
  211.             || empty($channel['new_default']) && $updateId === $channel['current_default']
  212.             || isset($channel['inserts']) && \in_array($updateId, $channel['inserts'], true);
  213.     }
  215.     /**
  216.      * @param array<string, mixed> $channel
  217.      */
  218.     private function validDeleteCase(array $channel): bool
  219.     {
  220.         return !\in_array($channel['current_default'], $channel['deletions'], true);
  221.     }
  223.     /**
  224.      * @param array<string, list<string>> $channel
  225.      *
  226.      * @return list<string>
  227.      */
  228.     private function getDuplicates(array $channel): array
  229.     {
  230.         return array_values(array_intersect($channel['state'], $channel['inserts']));
  231.     }
  233.     /**
  234.      * @param array<string, mixed> $inserts
  235.      */
  236.     private function writeInsertViolationExceptions(array $inserts, PreWriteValidationEvent $event): void
  237.     {
  238.         if (!$inserts) {
  239.             return;
  240.         }
  242.         $violations = new ConstraintViolationList();
  243.         $salesChannelIds = array_keys($inserts);
  245.         foreach ($salesChannelIds as $id) {
  246.             $violations->add(new ConstraintViolation(
  247.                 sprintf(self::INSERT_VALIDATION_MESSAGE, $id),
  248.                 sprintf(self::INSERT_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  249.                 ['{{ salesChannelId }}' => $id],
  250.                 null,
  251.                 '/',
  252.                 null,
  253.                 null,
  254.                 self::INSERT_VALIDATION_CODE
  255.             ));
  256.         }
  258.         $this->writeViolationException($violations, $event);
  259.     }
  261.     /**
  262.      * @param array<string, list<string>> $duplicates
  263.      */
  264.     private function writeDuplicateViolationExceptions(array $duplicates, PreWriteValidationEvent $event): void
  265.     {
  266.         if (!$duplicates) {
  267.             return;
  268.         }
  270.         $violations = new ConstraintViolationList();
  272.         foreach ($duplicates as $id => $duplicateLanguages) {
  273.             foreach ($duplicateLanguages as $languageId) {
  274.                 $violations->add(new ConstraintViolation(
  275.                     sprintf(self::DUPLICATED_ENTRY_VALIDATION_MESSAGE, $languageId, $id),
  276.                     sprintf(self::DUPLICATED_ENTRY_VALIDATION_MESSAGE, '{{ languageId }}', '{{ salesChannelId }}'),
  277.                     [
  278.                         '{{ salesChannelId }}' => $id,
  279.                         '{{ languageId }}' => $languageId,
  280.                     ],
  281.                     null,
  282.                     '/',
  283.                     null,
  284.                     null,
  285.                     self::DUPLICATED_ENTRY_VALIDATION_CODE
  286.                 ));
  287.             }
  288.         }
  290.         $this->writeViolationException($violations, $event);
  291.     }
  293.     /**
  294.      * @param array<string, mixed> $deletions
  295.      */
  296.     private function writeDeleteViolationExceptions(array $deletions, PreWriteValidationEvent $event): void
  297.     {
  298.         if (!$deletions) {
  299.             return;
  300.         }
  302.         $violations = new ConstraintViolationList();
  303.         $salesChannelIds = array_keys($deletions);
  305.         foreach ($salesChannelIds as $id) {
  306.             $violations->add(new ConstraintViolation(
  307.                 sprintf(self::DELETE_VALIDATION_MESSAGE, $id),
  308.                 sprintf(self::DELETE_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  309.                 ['{{ salesChannelId }}' => $id],
  310.                 null,
  311.                 '/',
  312.                 null,
  313.                 null,
  314.                 self::DELETE_VALIDATION_CODE
  315.             ));
  316.         }
  318.         $this->writeViolationException($violations, $event);
  319.     }
  321.     /**
  322.      * @param array<string, mixed> $updates
  323.      */
  324.     private function writeUpdateViolationExceptions(array $updates, PreWriteValidationEvent $event): void
  325.     {
  326.         if (!$updates) {
  327.             return;
  328.         }
  330.         $violations = new ConstraintViolationList();
  331.         $salesChannelIds = array_keys($updates);
  333.         foreach ($salesChannelIds as $id) {
  334.             $violations->add(new ConstraintViolation(
  335.                 sprintf(self::UPDATE_VALIDATION_MESSAGE, $id),
  336.                 sprintf(self::UPDATE_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  337.                 ['{{ salesChannelId }}' => $id],
  338.                 null,
  339.                 '/',
  340.                 null,
  341.                 null,
  342.                 self::UPDATE_VALIDATION_CODE
  343.             ));
  344.         }
  346.         $this->writeViolationException($violations, $event);
  347.     }
  349.     /**
  350.      * @param array<string> $salesChannelIds
  351.      *
  352.      * @return array<string, string>
  353.      */
  354.     private function fetchCurrentLanguageStates(array $salesChannelIds): array
  355.     {
  356.         /** @var array<string, mixed> $result */
  357.         $result = $this->connection->fetchAllAssociative(
  358.             'SELECT LOWER(HEX(sales_channel.id)) AS sales_channel_id,
  359.             LOWER(HEX(sales_channel.language_id)) AS current_default,
  360.             LOWER(HEX(mapping.language_id)) AS language_id
  361.             FROM sales_channel
  362.             LEFT JOIN sales_channel_language mapping
  363.                 ON mapping.sales_channel_id = sales_channel.id
  364.                 WHERE sales_channel.id IN (:ids)',
  365.             ['ids' => Uuid::fromHexToBytesList($salesChannelIds)],
  366.             ['ids' => ArrayParameterType::STRING]
  367.         );
  369.         return $result;
  370.     }
  372.     /**
  373.      * @param array<string, mixed> $mapping
  374.      * @param array<string, mixed> $states
  375.      *
  376.      * @return array<string, mixed>
  377.      */
  378.     private function mergeCurrentStatesWithMapping(array $mapping, array $states): array
  379.     {
  380.         foreach ($states as $record) {
  381.             $id = (string) $record['sales_channel_id'];
  382.             $mapping[$id]['current_default'] = $record['current_default'];
  383.             $mapping[$id]['state'][] = $record['language_id'];
  384.         }
  386.         return $mapping;
  387.     }
  389.     private function writeViolationException(ConstraintViolationList $violations, PreWriteValidationEvent $event): void
  390.     {
  391.         $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  392.     }
  393. }