[Asset Metadata] Implement adapter approach (#951)

* Add adapter approach for asset metadata

* Apply php-cs-fixer changes

* remove empty block

Author: lukmzig

config/metadata.yaml

@@ -16,6 +16,16 @@ services:
   Pimcore\Bundle\StudioBackendBundle\Metadata\Service\MetadataServiceInterface:
     class: Pimcore\Bundle\StudioBackendBundle\Metadata\Service\MetadataService
 
+  Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataAdapterLoaderInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Metadata\Service\Loader\TaggedIteratorMetadataAdapter
+
+  Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataResolverServiceInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataResolverServiceService
+
+  Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataAdapterServiceInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataAdapterService
+    arguments:
+      $loader: '@pimcore.implementation_loader.asset.metadata.data'
 
   # Hydrator
   Pimcore\Bundle\StudioBackendBundle\Metadata\Hydrator\MetadataHydratorInterface:

config/pimcore/config.yaml

@@ -99,6 +99,8 @@ pimcore_studio_backend:
             document: ['content', 'seo', 'warning', 'notice']
             data-object: ['content', 'seo', 'warning', 'notice']
 
+    asset_metadata_adapter_mapping: []
+
     data_object_data_adapter_mapping:
         Pimcore\Bundle\StudioBackendBundle\DataObject\Data\Adapter\AdvancedManyToManyRelationAdapter:
             - "advancedManyToManyRelation"

src/DataObject/Service/DataAdapterLoaderInterface.php

@@ -24,7 +24,7 @@
  */
 interface DataAdapterLoaderInterface
 {
-    public const ADAPTER_TAG = 'pimcore.studio_backend.data_adapter';
+    public const string ADAPTER_TAG = 'pimcore.studio_backend.data_adapter';
 
     /**
      * @throws InvalidArgumentException

src/DependencyInjection/Configuration.php

@@ -72,6 +72,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $this->addGridConfiguration($rootNode);
         $this->addSearchGridConfiguration($rootNode);
         $this->addNoteTypes($rootNode);
+        $this->addAssetMetadataAdapterMapping($rootNode);
         $this->addDataObjectAdapterMapping($rootNode);
         $this->addUserNode($rootNode);
         $this->addServerNode($rootNode);
@@ -370,6 +371,18 @@ private function addDataObjectAdapterMapping(ArrayNodeDefinition $node): void
             ->end();
     }
 
+    private function addAssetMetadataAdapterMapping(ArrayNodeDefinition $node): void
+    {
+        $node->children()
+            ->arrayNode('asset_metadata_adapter_mapping')
+                ->useAttributeAsKey('class')
+                ->arrayPrototype()
+                    ->scalarPrototype()
+                    ->end()
+                ->end()
+            ->end();
+    }
+
     private function addUserNode(ArrayNodeDefinition $node): void
     {
         $node->children()

src/DependencyInjection/PimcoreStudioBackendExtension.php

@@ -30,6 +30,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Grid\Column\Collector\DataObject\AdvancedColumnCollector;
 use Pimcore\Bundle\StudioBackendBundle\Grid\Service\ConfigurationServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Mercure\Service\HubServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataAdapterServiceInterface as MetadataAdapterServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Note\Service\NoteServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Service\OpenApiServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Perspective\Repository\ElementTreeWidgetConfigRepository;
@@ -162,6 +163,9 @@ public function load(array $configs, ContainerBuilder $container): void
             '$perspectiveConfigurations' => $config[Configuration::PERSPECTIVES_NODE],
             '$storageConfig' => $config['config_location'][Configuration::PERSPECTIVES_NODE],
         ]);
+
+        $definition = $container->getDefinition(MetadataAdapterServiceInterface::class);
+        $definition->setArgument('$studioAdapters', $config['asset_metadata_adapter_mapping']);
     }
 
     /**

src/Metadata/Data/DataDenormalizerInterface.php

@@ -0,0 +1,28 @@
+<?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\StudioBackendBundle\Metadata\Data;
+
+use Pimcore\Model\UserInterface;
+
+interface DataDenormalizerInterface
+{
+    public function denormalize(
+        mixed $value,
+        string $type,
+        UserInterface $user
+    ): mixed;
+}

src/Metadata/Data/DataNormalizerInterface.php

@@ -0,0 +1,25 @@
+<?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\StudioBackendBundle\Metadata\Data;
+
+interface DataNormalizerInterface
+{
+    public function normalize(
+        mixed $value,
+        string $type
+    ): mixed;
+}

src/Metadata/Data/MetaDataAdapterInterface.php

@@ -0,0 +1,21 @@
+<?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\StudioBackendBundle\Metadata\Data;
+
+interface MetaDataAdapterInterface
+{
+}

src/Metadata/Hydrator/MetadataHydrator.php

@@ -18,17 +18,19 @@
 
 use Pimcore\Bundle\StudioBackendBundle\Metadata\Schema\CustomMetadata;
 use Pimcore\Bundle\StudioBackendBundle\Metadata\Schema\PredefinedMetadata;
+use Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataResolverServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Resolver\Element\ReferenceResolverInterface;
-use Pimcore\Model\Element\ElementInterface;
 use Pimcore\Model\Metadata\Predefined;
 
 /**
  * @internal
  */
 final readonly class MetadataHydrator implements MetadataHydratorInterface
 {
-    public function __construct(private ReferenceResolverInterface $referenceResolver)
-    {
+    public function __construct(
+        private DataResolverServiceInterface $dataResolverService,
+        private ReferenceResolverInterface $referenceResolver
+    ) {
     }
 
     public function hydrate(array $customMetadata): CustomMetadata
@@ -37,10 +39,7 @@ public function hydrate(array $customMetadata): CustomMetadata
             $customMetadata['name'],
             $customMetadata['language'],
             $customMetadata['type'],
-            $this->resolveData(
-                $customMetadata['data'],
-                $customMetadata['type']
-            )
+            $this->dataResolverService->normalizeData($customMetadata),
         );
     }
 
@@ -65,19 +64,6 @@ public function hydratePredefined(Predefined $predefined): PredefinedMetadata
         );
     }
 
-    private function resolveData(mixed $data, string $type): mixed
-    {
-        return match (true) {
-            $data instanceof ElementInterface => $this->referenceResolver->resolve($data),
-            $type === 'manyToManyRelation' => array_map(
-                fn (ElementInterface $element): array => $this->referenceResolver->resolve($element),
-                $data
-            ),
-            $type === 'checkbox' => (bool)$data,
-            default => $data,
-        };
-    }
-
     private function resolveDefinitionData(mixed $data, string $type): mixed
     {
         if (!$data) {

src/Metadata/Patcher/Adapter/CustomMetadataAdapter.php

@@ -18,6 +18,7 @@
 
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
 use Pimcore\Bundle\StudioBackendBundle\Metadata\Repository\MetadataRepositoryInterface;
+use Pimcore\Bundle\StudioBackendBundle\Metadata\Service\DataResolverServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Metadata\Service\MetadataServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Patcher\Adapter\PatchAdapterInterface;
 use Pimcore\Bundle\StudioBackendBundle\Patcher\Service\Loader\TaggedIteratorAdapter;
@@ -28,22 +29,25 @@
 use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
 use function array_key_exists;
 use function in_array;
+use function sprintf;
 
 /**
  * @internal
  */
 #[AutoconfigureTag(TaggedIteratorAdapter::ADAPTER_TAG)]
 final class CustomMetadataAdapter implements PatchAdapterInterface
 {
-    private const INDEX_KEY = 'metadata';
+    private const string INDEX_KEY = 'metadata';
 
-    private const PATCHABLE_KEYS = [
+    private const array PATCHABLE_KEYS = [
         'language',
         'data',
     ];
 
-    public function __construct(private readonly MetadataRepositoryInterface $metadataRepository)
-    {
+    public function __construct(
+        private readonly DataResolverServiceInterface $dataResolverService,
+        private readonly MetadataRepositoryInterface $metadataRepository
+    ) {
     }
 
     /**
@@ -67,9 +71,9 @@ public function patch(ElementInterface $element, array $data, UserInterface $use
                 continue;
             }
 
-            foreach (self::PATCHABLE_KEYS as $patchKeys) {
-                if (array_key_exists($patchKeys, $metadataForPatch[$index])) {
-                    $metadata[$patchKeys] = $metadataForPatch[$index][$patchKeys];
+            foreach (self::PATCHABLE_KEYS as $patchKey) {
+                if (array_key_exists($patchKey, $metadataForPatch[$index])) {
+                    $metadata[$patchKey] = $this->getExistingEntryValue($metadataForPatch[$index], $patchKey, $user);
                 }
             }
             $patchedMetadata[] = $metadata;
@@ -81,7 +85,7 @@ public function patch(ElementInterface $element, array $data, UserInterface $use
         $patchedMetadata = [
             ...$patchedMetadata,
             ...array_map(
-                fn (array $metaData) => $this->processNewMetadataEntry($metaData),
+                fn (array $metaData) => $this->processNewMetadataEntry($metaData, $user),
                 $metadataForPatch
             ),
         ];
@@ -103,10 +107,19 @@ public function supportedElementTypes(): array
         ];
     }
 
+    private function getExistingEntryValue(array $metadata, string $key, UserInterface $user): mixed
+    {
+        if ($key !== 'data') {
+            return $metadata[$key];
+        }
+
+        return $this->dataResolverService->denormalizeData($metadata, $user);
+    }
+
     /**
      * @throws InvalidArgumentException
      */
-    private function processNewMetadataEntry(array $metadata): array
+    private function processNewMetadataEntry(array $metadata, UserInterface $user): array
     {
         if (!isset($metadata['name'])) {
             throw new InvalidArgumentException('Metadata name is required');
@@ -119,14 +132,14 @@ private function processNewMetadataEntry(array $metadata): array
         $predefined = $this->metadataRepository->getPredefinedMetadataByName($metadata['name']);
 
         if (!$predefined) {
-            throw new InvalidArgumentException('Predefined metadata not found');
+            throw new InvalidArgumentException(sprintf('Predefined metadata %s not found', $metadata['name']));
         }
 
         return [
             'name' => $predefined->getName(),
             'language' => $metadata['language'] ?? '',
             'type' => $predefined->getType(),
-            'data' => $metadata['data'] ?? null,
+            'data' => $metadata['data'] ? $this->dataResolverService->denormalizeData($metadata, $user) : null,
         ];
     }