vendor/shopware/core/Framework/DataAbstractionLayer/Write/Validation/LockValidator.php line 41

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Write\Validation;
  5. use Doctrine\DBAL\ArrayParameterType;
  6. use Doctrine\DBAL\Connection;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\EntityDefinitionQueryHelper;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  10. use Shopware\Core\Framework\Log\Package;
  11. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Symfony\Component\Validator\ConstraintViolation;
  14. use Symfony\Component\Validator\ConstraintViolationList;
  16. /**
  17.  * @internal
  18.  */
  19. #[Package('core')]
  20. class LockValidator implements EventSubscriberInterface
  21. {
  22.     final public const VIOLATION_LOCKED = 'FRAMEWORK__ENTITY_IS_LOCKED';
  24.     /**
  25.      * @internal
  26.      */
  27.     public function __construct(private readonly Connection $connection)
  28.     {
  29.     }
  31.     public static function getSubscribedEvents(): array
  32.     {
  33.         return [
  34.             PreWriteValidationEvent::class => 'preValidate',
  35.         ];
  36.     }
  38.     /**
  39.      * @throws WriteConstraintViolationException
  40.      */
  41.     public function preValidate(PreWriteValidationEvent $event): void
  42.     {
  43.         $violations = new ConstraintViolationList();
  44.         $writeCommands = $event->getCommands();
  45.         $lockedEntities = $this->containsLockedEntities($writeCommands);
  47.         if (empty($lockedEntities)) {
  48.             return;
  49.         }
  51.         $message = 'The %s entity is locked and can neither be modified nor deleted.';
  53.         foreach ($lockedEntities as $entity => $_isLocked) {
  54.             $violations->add(new ConstraintViolation(
  55.                 sprintf($message, $entity),
  56.                 sprintf($message, '{{ entity }}'),
  57.                 ['{{ entity }}' => $entity],
  58.                 null,
  59.                 '/',
  60.                 null,
  61.                 null,
  62.                 self::VIOLATION_LOCKED
  63.             ));
  64.         }
  66.         $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  67.     }
  69.     /**
  70.      * @param WriteCommand[] $writeCommands
  71.      *
  72.      * @return array<string, bool>
  73.      */
  74.     private function containsLockedEntities(array $writeCommands): array
  75.     {
  76.         $ids = [];
  77.         $locked = [];
  79.         foreach ($writeCommands as $command) {
  80.             if ($command instanceof InsertCommand) {
  81.                 continue;
  82.             }
  84.             if (!$command->getDefinition()->isLockAware()) {
  85.                 continue;
  86.             }
  88.             $ids[$command->getDefinition()->getEntityName()][] = $command->getPrimaryKey()['id'];
  89.         }
  91.         /** @var string $entityName */
  92.         foreach ($ids as $entityName => $primaryKeys) {
  93.             $locked[$entityName] = $this->connection->createQueryBuilder()
  94.                 ->select('1')
  95.                 ->from(EntityDefinitionQueryHelper::escape($entityName))
  96.                 ->where('`id` IN (:ids) AND `locked` = 1')
  97.                 ->setParameter('ids', $primaryKeys, ArrayParameterType::STRING)
  98.                 ->executeQuery()
  99.                 ->rowCount() > 0;
  100.         }
  102.         return array_filter($locked);
  103.     }
  104. }