src/Core/System/Language/TranslationValidator.php line 35

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\Language;
  5. use Shopware\Core\Defaults;
  6. use Shopware\Core\Framework\DataAbstractionLayer\EntityTranslationDefinition;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Field\FkField;
  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\WriteCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Uuid\Uuid;
  14. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\Validator\ConstraintViolation;
  17. use Symfony\Component\Validator\ConstraintViolationInterface;
  18. use Symfony\Component\Validator\ConstraintViolationList;
  20. /**
  21.  * @internal
  22.  */
  23. #[Package('core')]
  24. class TranslationValidator implements EventSubscriberInterface
  25. {
  26.     final public const VIOLATION_DELETE_SYSTEM_TRANSLATION = 'delete-system-translation-violation';
  28.     public static function getSubscribedEvents(): array
  29.     {
  30.         return [
  31.             PreWriteValidationEvent::class => 'preValidate',
  32.         ];
  33.     }
  35.     public function preValidate(PreWriteValidationEvent $event): void
  36.     {
  37.         if ($event->getContext()->getVersionId() !== Defaults::LIVE_VERSION) {
  38.             return;
  39.         }
  41.         $violations = new ConstraintViolationList();
  42.         $violations->addAll($this->getDeletedSystemTranslationViolations($event->getCommands()));
  44.         if ($violations->count()) {
  45.             $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  46.         }
  47.     }
  49.     /**
  50.      * @param list<WriteCommand> $writeCommands
  51.      */
  52.     private function getDeletedSystemTranslationViolations(array $writeCommands): ConstraintViolationList
  53.     {
  54.         $violations = new ConstraintViolationList();
  56.         foreach ($writeCommands as $writeCommand) {
  57.             if (!$writeCommand instanceof DeleteCommand || $writeCommand instanceof CascadeDeleteCommand) {
  58.                 continue;
  59.             }
  60.             $pk = $writeCommand->getPrimaryKey();
  61.             if (!isset($pk['language_id'])) {
  62.                 continue;
  63.             }
  65.             $def = $writeCommand->getDefinition();
  66.             if (!$def instanceof EntityTranslationDefinition) {
  67.                 continue;
  68.             }
  70.             if (Uuid::fromBytesToHex($pk['language_id']) !== Defaults::LANGUAGE_SYSTEM) {
  71.                 continue;
  72.             }
  74.             $fks = $this->getFkFields($def);
  75.             $id = Uuid::fromBytesToHex($pk[$fks['id']->getStorageName()]);
  76.             $violations->add(
  77.                 $this->buildViolation(
  78.                     'Cannot delete system translation',
  79.                     ['{{ id }}' => $id],
  80.                     '/' . $id . '/translations/' . Defaults::LANGUAGE_SYSTEM,
  81.                     [$id, Defaults::LANGUAGE_SYSTEM],
  82.                     self::VIOLATION_DELETE_SYSTEM_TRANSLATION
  83.                 )
  84.             );
  85.         }
  87.         return $violations;
  88.     }
  90.     /**
  91.      * @return FkField[]
  92.      */
  93.     private function getFkFields(EntityTranslationDefinition $definition): array
  94.     {
  95.         $rootEntity = $definition->getParentDefinition();
  96.         $idStorageName = $rootEntity->getEntityName() . '_id';
  97.         $versionIdStorageName = $rootEntity->getEntityName() . '_version_id';
  99.         $pks = $definition->getPrimaryKeys();
  100.         $idField = $pks->getByStorageName($idStorageName);
  101.         if (!$idField || !$idField instanceof FkField) {
  102.             throw new \RuntimeException(sprintf('`%s` primary key should have column `%s`', $definition->getEntityName(), $idStorageName));
  103.         }
  104.         $fields = [
  105.             'id' => $idField,
  106.         ];
  108.         $versionIdField = $pks->getByStorageName($versionIdStorageName);
  109.         if ($versionIdField && $versionIdField instanceof FkField) {
  110.             $fields['version'] = $versionIdField;
  111.         }
  113.         return $fields;
  114.     }
  116.     /**
  117.      * @param array<string, string> $parameters
  118.      * @param array<mixed>|null $invalidValue
  119.      */
  120.     private function buildViolation(
  121.         string $messageTemplate,
  122.         array $parameters,
  123.         ?string $propertyPath = null,
  124.         ?array $invalidValue = null,
  125.         ?string $code = null
  126.     ): ConstraintViolationInterface {
  127.         return new ConstraintViolation(
  128.             str_replace(array_keys($parameters), array_values($parameters), $messageTemplate),
  129.             $messageTemplate,
  130.             $parameters,
  131.             null,
  132.             $propertyPath,
  133.             $invalidValue,
  134.             null,
  135.             $code
  136.         );
  137.     }
  138. }