src/Core/System/Language/LanguageValidator.php line 52

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\Language;
  5. use Doctrine\DBAL\Connection;
  6. use Doctrine\DBAL\FetchMode;
  7. use Shopware\Core\Defaults;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\CascadeDeleteCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PostWriteValidationEvent;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  15. use Shopware\Core\Framework\Log\Package;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\Validator\ConstraintViolation;
  20. use Symfony\Component\Validator\ConstraintViolationInterface;
  21. use Symfony\Component\Validator\ConstraintViolationList;
  23. /**
  24.  * @internal
  25.  */
  26. #[Package('core')]
  27. class LanguageValidator implements EventSubscriberInterface
  28. {
  29.     final public const VIOLATION_PARENT_HAS_PARENT = 'parent_has_parent_violation';
  31.     final public const VIOLATION_CODE_REQUIRED_FOR_ROOT_LANGUAGE = 'code_required_for_root_language';
  33.     final public const VIOLATION_DELETE_DEFAULT_LANGUAGE = 'delete_default_language_violation';
  35.     final public const VIOLATION_DEFAULT_LANGUAGE_PARENT = 'default_language_parent_violation';
  37.     /**
  38.      * @internal
  39.      */
  40.     public function __construct(private readonly Connection $connection)
  41.     {
  42.     }
  44.     public static function getSubscribedEvents(): array
  45.     {
  46.         return [
  47.             PreWriteValidationEvent::class => 'preValidate',
  48.             PostWriteValidationEvent::class => 'postValidate',
  49.         ];
  50.     }
  52.     public function postValidate(PostWriteValidationEvent $event): void
  53.     {
  54.         $commands = $event->getCommands();
  55.         $affectedIds = $this->getAffectedIds($commands);
  56.         if (\count($affectedIds) === 0) {
  57.             return;
  58.         }
  60.         $violations = new ConstraintViolationList();
  61.         $violations->addAll($this->getInheritanceViolations($affectedIds));
  62.         $violations->addAll($this->getMissingTranslationCodeViolations($affectedIds));
  64.         if ($violations->count() > 0) {
  65.             $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  66.         }
  67.     }
  69.     public function preValidate(PreWriteValidationEvent $event): void
  70.     {
  71.         $commands = $event->getCommands();
  73.         foreach ($commands as $command) {
  74.             $violations = new ConstraintViolationList();
  76.             if ($command instanceof CascadeDeleteCommand || $command->getDefinition()->getClass() !== LanguageDefinition::class) {
  77.                 continue;
  78.             }
  80.             $pk = $command->getPrimaryKey();
  81.             $id = mb_strtolower(Uuid::fromBytesToHex($pk['id']));
  83.             if ($command instanceof DeleteCommand && $id === Defaults::LANGUAGE_SYSTEM) {
  84.                 $violations->add(
  85.                     $this->buildViolation(
  86.                         'The default language {{ id }} cannot be deleted.',
  87.                         ['{{ id }}' => $id],
  88.                         '/' . $id,
  89.                         $id,
  90.                         self::VIOLATION_DELETE_DEFAULT_LANGUAGE
  91.                     )
  92.                 );
  93.             }
  95.             if ($command instanceof UpdateCommand && $id === Defaults::LANGUAGE_SYSTEM) {
  96.                 $payload = $command->getPayload();
  97.                 if (\array_key_exists('parent_id', $payload) && $payload['parent_id'] !== null) {
  98.                     $violations->add(
  99.                         $this->buildViolation(
  100.                             'The default language {{ id }} cannot inherit from another language.',
  101.                             ['{{ id }}' => $id],
  102.                             '/parentId',
  103.                             $payload['parent_id'],
  104.                             self::VIOLATION_DEFAULT_LANGUAGE_PARENT
  105.                         )
  106.                     );
  107.                 }
  108.             }
  110.             if ($violations->count() > 0) {
  111.                 $event->getExceptions()->add(new WriteConstraintViolationException($violations, $command->getPath()));
  112.             }
  113.         }
  114.     }
  116.     /**
  117.      * @param array<string> $affectedIds
  118.      */
  119.     private function getInheritanceViolations(array $affectedIds): ConstraintViolationList
  120.     {
  121.         $statement = $this->connection->executeQuery(
  122.             'SELECT child.id
  123.              FROM language child
  124.              INNER JOIN language parent ON parent.id = child.parent_id
  125.              WHERE (child.id IN (:ids) OR child.parent_id IN (:ids))
  126.              AND parent.parent_id IS NOT NULL',
  127.             ['ids' => $affectedIds],
  128.             ['ids' => Connection::PARAM_STR_ARRAY]
  129.         );
  130.         $ids = $statement->fetchAll(FetchMode::COLUMN);
  132.         $violations = new ConstraintViolationList();
  133.         foreach ($ids as $binId) {
  134.             $id = Uuid::fromBytesToHex($binId);
  135.             $violations->add(
  136.                 $this->buildViolation(
  137.                     'Language inheritance limit for the child {{ id }} exceeded. A Language must not be nested deeper than one level.',
  138.                     ['{{ id }}' => $id],
  139.                     '/' . $id . '/parentId',
  140.                     $id,
  141.                     self::VIOLATION_PARENT_HAS_PARENT
  142.                 )
  143.             );
  144.         }
  146.         return $violations;
  147.     }
  149.     /**
  150.      * @param array<string> $affectedIds
  151.      */
  152.     private function getMissingTranslationCodeViolations(array $affectedIds): ConstraintViolationList
  153.     {
  154.         $statement = $this->connection->executeQuery(
  155.             'SELECT lang.id
  156.              FROM language lang
  157.              LEFT JOIN locale l ON lang.translation_code_id = l.id
  158.              WHERE l.id IS NULL # no translation code
  159.              AND lang.parent_id IS NULL # root
  160.              AND lang.id IN (:ids)',
  161.             ['ids' => $affectedIds],
  162.             ['ids' => Connection::PARAM_STR_ARRAY]
  163.         );
  164.         $ids = $statement->fetchAll(FetchMode::COLUMN);
  166.         $violations = new ConstraintViolationList();
  167.         foreach ($ids as $binId) {
  168.             $id = Uuid::fromBytesToHex($binId);
  169.             $violations->add(
  170.                 $this->buildViolation(
  171.                     'Root language {{ id }} requires a translation code',
  172.                     ['{{ id }}' => $id],
  173.                     '/' . $id . '/translationCodeId',
  174.                     $id,
  175.                     self::VIOLATION_CODE_REQUIRED_FOR_ROOT_LANGUAGE
  176.                 )
  177.             );
  178.         }
  180.         return $violations;
  181.     }
  183.     /**
  184.      * @param WriteCommand[] $commands
  185.      *
  186.      * @return array<string>
  187.      */
  188.     private function getAffectedIds(array $commands): array
  189.     {
  190.         $ids = [];
  191.         foreach ($commands as $command) {
  192.             if ($command->getDefinition()->getClass() !== LanguageDefinition::class) {
  193.                 continue;
  194.             }
  195.             if ($command instanceof InsertCommand || $command instanceof UpdateCommand) {
  196.                 $ids[] = $command->getPrimaryKey()['id'];
  197.             }
  198.         }
  200.         return $ids;
  201.     }
  203.     /**
  204.      * @param array<string, string> $parameters
  205.      */
  206.     private function buildViolation(
  207.         string $messageTemplate,
  208.         array $parameters,
  209.         ?string $propertyPath = null,
  210.         ?string $invalidValue = null,
  211.         ?string $code = null
  212.     ): ConstraintViolationInterface {
  213.         return new ConstraintViolation(
  214.             str_replace(array_keys($parameters), array_values($parameters), $messageTemplate),
  215.             $messageTemplate,
  216.             $parameters,
  217.             null,
  218.             $propertyPath,
  219.             $invalidValue,
  220.             null,
  221.             $code
  222.         );
  223.     }
  224. }