vendor/coreshop/optimistic-entity-lock-bundle/EventListener/LockListener.php line 66

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * CoreShop
  7.  *
  8.  * This source file is available under two different licenses:
  9.  *  - GNU General Public License version 3 (GPLv3)
  10.  *  - CoreShop Commercial License (CCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  * @copyright  Copyright (c) CoreShop GmbH (https://www.coreshop.org)
  15.  * @license    https://www.coreshop.org/license     GPLv3 and CCL
  16.  *
  17.  */
  19. namespace CoreShop\Bundle\OptimisticEntityLockBundle\EventListener;
  21. use CoreShop\Bundle\OptimisticEntityLockBundle\Exception\OptimisticLockException;
  22. use CoreShop\Bundle\OptimisticEntityLockBundle\Manager\EntityLockManager;
  23. use CoreShop\Bundle\OptimisticEntityLockBundle\Model\OptimisticLockedInterface;
  24. use Doctrine\DBAL\Connection;
  25. use Pimcore\Event\DataObjectEvents;
  26. use Pimcore\Event\Model\DataObjectEvent;
  27. use Pimcore\Model\DataObject\Concrete;
  28. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  30. class LockListener implements EventSubscriberInterface
  31. {
  32.     public function __construct(
  33.         protected EntityLockManager $lockManager,
  34.         protected Connection $connection,
  35.     ) {
  36.     }
  38.     public static function getSubscribedEvents(): array
  39.     {
  40.         return [
  41.             DataObjectEvents::PRE_ADD => 'preAddLock',
  42.             DataObjectEvents::PRE_UPDATE => 'checkLock',
  43.             DataObjectEvents::POST_UPDATE => 'postUpdateLock',
  44.         ];
  45.     }
  47.     public function preAddLock(DataObjectEvent $dataObjectEvent): void
  48.     {
  49.         $object = $dataObjectEvent->getObject();
  51.         if (!$object instanceof OptimisticLockedInterface) {
  52.             return;
  53.         }
  55.         if (!$object instanceof Concrete) {
  56.             return;
  57.         }
  59.         /**
  60.          * @var Concrete $object
  61.          * @var OptimisticLockedInterface $object
  62.          */
  63.         $object->setOptimisticLockVersion(1);
  64.     }
  66.     public function postUpdateLock(DataObjectEvent $dataObjectEvent): void
  67.     {
  68.         $object = $dataObjectEvent->getObject();
  70.         if (!$object instanceof OptimisticLockedInterface) {
  71.             return;
  72.         }
  74.         if (!$object instanceof Concrete) {
  75.             return;
  76.         }
  78.         /**
  79.          * @var Concrete $object
  80.          */
  81.         $this->lockManager->updateLock($object);
  82.     }
  84.     public function checkLock(DataObjectEvent $dataObjectEvent): void
  85.     {
  86.         $object = $dataObjectEvent->getObject();
  88.         if (!$object instanceof OptimisticLockedInterface) {
  89.             return;
  90.         }
  92.         if (!$object instanceof Concrete) {
  93.             return;
  94.         }
  96.         $this->ensureVersionMatch($object);
  98.         /**
  99.          * @var Concrete $object
  100.          * @var OptimisticLockedInterface $object
  101.          */
  102.         $object->setOptimisticLockVersion(($object->getOptimisticLockVersion() ?? 1) + 1);
  103.     }
  105.     private function ensureVersionMatch(Concrete $object): void
  106.     {
  107.         if (!$object instanceof OptimisticLockedInterface) {
  108.             return;
  109.         }
  111.         $queryBuilder = $this->connection->createQueryBuilder();
  112.         $queryBuilder->from('object_store_' . $object->getClassId())
  113.             ->select('optimisticLockVersion')
  114.             ->where('oo_id = :id')
  115.             ->setMaxResults(1)
  116.             ->setParameter('id', $object->getId())
  117.         ;
  119.         $currentVersion = (int) $this->connection->fetchOne($queryBuilder->getSQL(), $queryBuilder->getParameters());
  121.         if ($currentVersion === $object->getOptimisticLockVersion()) {
  122.             return;
  123.         }
  125.         throw OptimisticLockException::lockFailedVersionMismatch(
  126.             $object,
  127.             $object->getOptimisticLockVersion(),
  128.             $currentVersion,
  129.         );
  130.     }
  131. }