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

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