src/Core/Framework/DataAbstractionLayer/Write/Validation/LockValidator.php line 40

  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.  * @internal
  17.  */
  18. #[Package('core')]
  19. class LockValidator implements EventSubscriberInterface
  20. {
  21.     final public const VIOLATION_LOCKED = 'FRAMEWORK__ENTITY_IS_LOCKED';
  23.     /**
  24.      * @internal
  25.      */
  26.     public function __construct(private readonly Connection $connection)
  27.     {
  28.     }
  30.     public static function getSubscribedEvents(): array
  31.     {
  32.         return [
  33.             PreWriteValidationEvent::class => 'preValidate',
  34.         ];
  35.     }
  37.     /**
  38.      * @throws WriteConstraintViolationException
  39.      */
  40.     public function preValidate(PreWriteValidationEvent $event): void
  41.     {
  42.         $violations = new ConstraintViolationList();
  43.         $writeCommands = $event->getCommands();
  44.         $lockedEntities = $this->containsLockedEntities($writeCommands);
  46.         if (empty($lockedEntities)) {
  47.             return;
  48.         }
  50.         $message = 'The %s entity is locked and can neither be modified nor deleted.';
  52.         foreach ($lockedEntities as $entity => $_isLocked) {
  53.             $violations->add(new ConstraintViolation(
  54.                 sprintf($message, $entity),
  55.                 sprintf($message, '{{ entity }}'),
  56.                 ['{{ entity }}' => $entity],
  57.                 null,
  58.                 '/',
  59.                 null,
  60.                 null,
  61.                 self::VIOLATION_LOCKED
  62.             ));
  63.         }
  65.         $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  66.     }
  68.     /**
  69.      * @param WriteCommand[] $writeCommands
  70.      *
  71.      * @return array<string, bool>
  72.      */
  73.     private function containsLockedEntities(array $writeCommands): array
  74.     {
  75.         $ids = [];
  76.         $locked = [];
  78.         foreach ($writeCommands as $command) {
  79.             if ($command instanceof InsertCommand) {
  80.                 continue;
  81.             }
  83.             if (!$command->getDefinition()->isLockAware()) {
  84.                 continue;
  85.             }
  87.             $ids[$command->getDefinition()->getEntityName()][] = $command->getPrimaryKey()['id'];
  88.         }
  90.         /** @var string $entityName */
  91.         foreach ($ids as $entityName => $primaryKeys) {
  92.             $locked[$entityName] = $this->connection->createQueryBuilder()
  93.                 ->select('1')
  94.                 ->from(EntityDefinitionQueryHelper::escape($entityName))
  95.                 ->where('`id` IN (:ids) AND `locked` = 1')
  96.                 ->setParameter('ids', $primaryKeys, Connection::PARAM_STR_ARRAY)
  97.                 ->execute()
  98.                 ->rowCount() > 0;
  99.         }
  101.         return array_filter($locked);
  102.     }
  103. }