[Elements] Add new service to return if element is locked (#313)

* add logic for element locking status

* add tests

* Apply php-cs-fixer changes

* move wildcard to query type

---------

Co-authored-by: lukmzig <[email protected]>

Author: lukmzig

config/pimcore/config.yaml

@@ -84,8 +84,6 @@ pimcore_generic_data_index:
           type: integer
         lock:
           type: keyword
-        isLocked:
-          type: boolean
         hasWorkflowWithPermissions:
           type: boolean
         dependencies:

config/services/search-index-adapter/default-search.yaml

@@ -33,6 +33,11 @@ services:
         arguments:
             $client: '@generic-data-index.search-client'
 
+    Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\ElementLockServiceInterface:
+        class: Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DefaultSearch\ElementLockService
+        arguments:
+            $client: '@generic-data-index.search-client'
+
     Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface:
         class: Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DefaultSearch\Search\Pagination\PaginationInfoService
 

doc/01_Installation/02_Upgrade.md

@@ -5,6 +5,7 @@ Following steps are necessary during updating to newer versions.
 ## Upgrade to 2.0.0
 - [Indexing] Added inherited fields indicator to data object indexing
 - [Indexing] Added functionality to enqueue dependent items
+- Added a new method `isElementLocked()` to the `ElementLockService`, which provides functionality to retrieve element locked status based on the index data
 
 ### BC-Breaks
 - Removed deprecated alias `generic-data-index.opensearch-client` and replaced it with `generic-data-index.search-client`
@@ -19,6 +20,7 @@ Following steps are necessary during updating to newer versions.
 - Add element type to the `getIds` method of `Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\SearchResult\ElementSearchResult`
 - Added `getSpecialPermissions` method to `Pimcore\Bundle\GenericDataIndexBundle\Service\Permission\ElementPermissionServiceInterface` to get special permissions workspace language permissions for elements
 - Removed layout permission from `Pimcore\Bundle\GenericDataIndexBundle\Permission\DataObjectPermissions` as they are not index relevant
+- Removed property `isLocked` from Index for elements as it needs to be dynamically calculated
 
 #### Interface changes
 - Added `PermissionTypes $permissionType` parameter with default type `PermissionTypes::LIST` to

src/Enum/SearchIndex/DefaultSearch/QueryType.php

@@ -20,4 +20,5 @@ enum QueryType: string
 {
     case BOOL = 'bool';
     case TERMS = 'terms';
+    case WILDCARD = 'wildcard';
 }

src/Enum/SearchIndex/FieldCategory/SystemField.php

@@ -48,7 +48,6 @@ enum SystemField: string
     case USER_OWNER = 'userOwner';
     case USER_MODIFICATION = 'userModification';
     case LOCKED = 'locked';
-    case IS_LOCKED = 'isLocked';
     case HAS_WORKFLOW_WITH_PERMISSIONS = 'hasWorkflowWithPermissions';
     case FILE_SIZE = 'fileSize';
     case DEPENDENCIES = 'dependencies';

src/EventSubscriber/LockElementSubscriber.php

@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\EventSubscriber;
+
+use Exception;
+use Pimcore\Bundle\GenericDataIndexBundle\Installer;
+use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\ElementLockServiceInterface;
+use Pimcore\Event\ElementEvents;
+use Pimcore\Event\Model\ElementEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * @internal
+ */
+final readonly class LockElementSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        private Installer $installer,
+        private ElementLockServiceInterface $lockService,
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ElementEvents::POST_ELEMENT_UNLOCK_PROPAGATE => 'updateUnlockPropagate',
+        ];
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function updateUnlockPropagate(ElementEvent $event): void
+    {
+        if (!$this->installer->isInstalled()) {
+            return;
+        }
+
+        $this->lockService->unlockPropagate($event->getElement());
+    }
+}

src/Model/Search/Asset/SearchResult/AssetSearchResultItem.php

@@ -45,8 +45,6 @@ class AssetSearchResultItem implements ElementSearchResultItemInterface
 
     private ?string $locked;
 
-    private bool $isLocked;
-
     /** @var AssetMetaData[] */
     private array $metaData;
 
@@ -205,18 +203,6 @@ public function setLocked(?string $locked): AssetSearchResultItem
         return $this;
     }
 
-    public function isLocked(): bool
-    {
-        return $this->isLocked;
-    }
-
-    public function setIsLocked(bool $isLocked): AssetSearchResultItem
-    {
-        $this->isLocked = $isLocked;
-
-        return $this;
-    }
-
     /**
      * This will deliver searchable metadata only.
      * Custom metadata which is not relevant for the asset grid will not be included.

src/Model/Search/DataObject/SearchResult/DataObjectSearchResultItem.php

@@ -50,8 +50,6 @@ class DataObjectSearchResultItem implements ElementSearchResultItemInterface
 
     private ?string $locked;
 
-    private bool $isLocked;
-
     private ?int $creationDate;
 
     private ?int $modificationDate;
@@ -235,18 +233,6 @@ public function setLocked(?string $locked): DataObjectSearchResultItem
         return $this;
     }
 
-    public function isLocked(): bool
-    {
-        return $this->isLocked;
-    }
-
-    public function setIsLocked(?bool $isLocked): DataObjectSearchResultItem
-    {
-        $this->isLocked = (bool)$isLocked;
-
-        return $this;
-    }
-
     public function getCreationDate(): ?int
     {
         return $this->creationDate;

src/Model/Search/Document/SearchResult/DocumentSearchResultItem.php

@@ -43,8 +43,6 @@ class DocumentSearchResultItem implements ElementSearchResultItemInterface
 
     private ?string $locked;
 
-    private bool $isLocked;
-
     private ?int $creationDate;
 
     private ?int $modificationDate;
@@ -186,18 +184,6 @@ public function setLocked(?string $locked): DocumentSearchResultItem
         return $this;
     }
 
-    public function isLocked(): bool
-    {
-        return $this->isLocked;
-    }
-
-    public function setIsLocked(?bool $isLocked): DocumentSearchResultItem
-    {
-        $this->isLocked = (bool)$isLocked;
-
-        return $this;
-    }
-
     public function getCreationDate(): ?int
     {
         return $this->creationDate;

src/Model/Search/Interfaces/ElementSearchResultItemInterface.php

@@ -59,10 +59,6 @@ public function getLocked(): ?string;
 
     public function setLocked(?string $locked): ElementSearchResultItemInterface;
 
-    public function isLocked(): bool;
-
-    public function setIsLocked(bool $isLocked): ElementSearchResultItemInterface;
-
     public function getCreationDate(): ?int;
 
     public function setCreationDate(?int $creationDate): ElementSearchResultItemInterface;