From a83bbef556d43863cb5758f8d2727a5500c5e9c4 Mon Sep 17 00:00:00 2001
From: Matthias Schuhmayer <38959016+mattamon@users.noreply.github.com>
Date: Wed, 29 May 2024 10:54:33 +0200
Subject: [PATCH] Add Image Updater (#81)

* Add focal point saving

* Apply php-cs-fixer changes

* Remove constructor

---------

Co-authored-by: mattamon <mattamon@users.noreply.github.com>
---
 config/assets.yaml                            |  4 +-
 .../Attributes/Property/UpdateAssetImage.php  | 36 ++++++++++
 .../Request/UpdateAssetRequestBody.php        |  2 +
 src/Asset/Schema/Type/Image/FocalPoint.php    | 49 +++++++++++++
 src/Asset/Schema/Type/Image/ImageData.php     | 41 +++++++++++
 src/Asset/Updater/Adapter/ImageAdapter.php    | 69 +++++++++++++++++++
 src/Updater/Adapter/PropertiesAdapter.php     |  3 +
 src/Updater/Service/UpdateService.php         |  4 +-
 8 files changed, 203 insertions(+), 5 deletions(-)
 create mode 100644 src/Asset/Attributes/Property/UpdateAssetImage.php
 create mode 100644 src/Asset/Schema/Type/Image/FocalPoint.php
 create mode 100644 src/Asset/Schema/Type/Image/ImageData.php
 create mode 100644 src/Asset/Updater/Adapter/ImageAdapter.php

diff --git a/config/assets.yaml b/config/assets.yaml
index 79d494584..56c2d6799 100644
--- a/config/assets.yaml
+++ b/config/assets.yaml
@@ -28,5 +28,5 @@ services:
   Pimcore\Bundle\StudioBackendBundle\Asset\Service\DataServiceInterface:
     class: Pimcore\Bundle\StudioBackendBundle\Asset\Service\DataService
 
-
-
+  Pimcore\Bundle\StudioBackendBundle\Asset\Updater\Adapter\ImageAdapter:
+    tags: [ 'pimcore.studio_backend.update_adapter' ]
\ No newline at end of file
diff --git a/src/Asset/Attributes/Property/UpdateAssetImage.php b/src/Asset/Attributes/Property/UpdateAssetImage.php
new file mode 100644
index 000000000..d5d142c6d
--- /dev/null
+++ b/src/Asset/Attributes/Property/UpdateAssetImage.php
@@ -0,0 +1,36 @@
+<?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\Asset\Attributes\Property;
+
+use OpenApi\Attributes\Property;
+use Pimcore\Bundle\StudioBackendBundle\Asset\Schema\Type\Image\ImageData;
+
+/**
+ * @internal
+ */
+final class UpdateAssetImage extends Property
+{
+    public function __construct()
+    {
+        parent::__construct(
+            'image',
+            ref: ImageData::class,
+            type: 'object',
+            nullable: true,
+        );
+    }
+}
diff --git a/src/Asset/Attributes/Request/UpdateAssetRequestBody.php b/src/Asset/Attributes/Request/UpdateAssetRequestBody.php
index 10f078c77..702e9305e 100644
--- a/src/Asset/Attributes/Request/UpdateAssetRequestBody.php
+++ b/src/Asset/Attributes/Request/UpdateAssetRequestBody.php
@@ -20,6 +20,7 @@
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\RequestBody;
+use Pimcore\Bundle\StudioBackendBundle\Asset\Attributes\Property\UpdateAssetImage;
 use Pimcore\Bundle\StudioBackendBundle\Property\Attributes\Property\UpdateElementProperties;
 
 /**
@@ -37,6 +38,7 @@ public function __construct()
                     new Property('data',
                         properties: [
                             new UpdateElementProperties(),
+                            new UpdateAssetImage(),
                         ],
                         type: 'object',
                     ),
diff --git a/src/Asset/Schema/Type/Image/FocalPoint.php b/src/Asset/Schema/Type/Image/FocalPoint.php
new file mode 100644
index 000000000..aa8810fb5
--- /dev/null
+++ b/src/Asset/Schema/Type/Image/FocalPoint.php
@@ -0,0 +1,49 @@
+<?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\Asset\Schema\Type\Image;
+
+use OpenApi\Attributes\Property;
+use OpenApi\Attributes\Schema;
+
+/**
+ * @internal
+ */
+#[Schema(
+    title: 'FocalPoint',
+    type: 'object'
+)]
+final readonly class FocalPoint
+{
+
+    public function __construct(
+        #[Property(description: 'x', type: 'integer', example: 50)]
+        private int $x,
+        #[Property(description: 'y', type: 'integer', example: 50)]
+        private int $y,
+    ) {
+    }
+
+    public function getX(): int
+    {
+        return $this->x;
+    }
+
+    public function getY(): int
+    {
+        return $this->y;
+    }
+}
diff --git a/src/Asset/Schema/Type/Image/ImageData.php b/src/Asset/Schema/Type/Image/ImageData.php
new file mode 100644
index 000000000..4374fd4c3
--- /dev/null
+++ b/src/Asset/Schema/Type/Image/ImageData.php
@@ -0,0 +1,41 @@
+<?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\Asset\Schema\Type\Image;
+
+use OpenApi\Attributes\Property;
+use OpenApi\Attributes\Schema;
+
+/**
+ * @internal
+ */
+#[Schema(
+    title: 'ImageData',
+    type: 'object'
+)]
+final readonly class ImageData
+{
+    public function __construct(
+        #[Property(ref: FocalPoint::class, description: 'focalPoint', type: 'object')]
+        private array $focalPoint,
+    ) {
+    }
+
+    public function getFocalPoint(): array
+    {
+        return $this->focalPoint;
+    }
+}
diff --git a/src/Asset/Updater/Adapter/ImageAdapter.php b/src/Asset/Updater/Adapter/ImageAdapter.php
new file mode 100644
index 000000000..d185a0a3c
--- /dev/null
+++ b/src/Asset/Updater/Adapter/ImageAdapter.php
@@ -0,0 +1,69 @@
+<?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\Asset\Updater\Adapter;
+
+use Pimcore\Bundle\StudioBackendBundle\Updater\Adapter\UpdateAdapterInterface;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constants\ElementTypes;
+use Pimcore\Model\Asset\Image;
+use Pimcore\Model\Element\ElementInterface;
+use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
+
+/**
+ * @internal
+ */
+#[AutoconfigureTag('pimcore.studio_backend.update_adapter')]
+final readonly class ImageAdapter implements UpdateAdapterInterface
+{
+    private const INDEX_KEY = 'image';
+
+    public function update(ElementInterface $element, array $data): void
+    {
+        if (!$element instanceof Image) {
+            return;
+        }
+
+        $this->checkFocalPoint($element, $data);
+
+    }
+
+    public function getIndexKey(): string
+    {
+        return self::INDEX_KEY;
+    }
+
+    public function supportedElementTypes(): array
+    {
+        return [
+            ElementTypes::TYPE_ASSET,
+        ];
+    }
+
+    private function checkFocalPoint(Image $image, array $data): void
+    {
+        if (
+            !array_key_exists(self::INDEX_KEY, $data) ||
+            !array_key_exists('focalPoint', $data[self::INDEX_KEY])
+        ) {
+            $image->removeCustomSetting('focalPointX');
+            $image->removeCustomSetting('focalPointY');
+            return;
+        }
+
+        $image->setCustomSetting('focalPointX', $data[self::INDEX_KEY]['focalPoint']['x']);
+        $image->setCustomSetting('focalPointY', $data[self::INDEX_KEY]['focalPoint']['y']);
+    }
+}
diff --git a/src/Updater/Adapter/PropertiesAdapter.php b/src/Updater/Adapter/PropertiesAdapter.php
index 9f3621dd8..4027afec8 100644
--- a/src/Updater/Adapter/PropertiesAdapter.php
+++ b/src/Updater/Adapter/PropertiesAdapter.php
@@ -33,6 +33,9 @@ public function __construct(private PropertyRepositoryInterface $propertyReposit
 
     public function update(ElementInterface $element, array $data): void
     {
+        if (!array_key_exists($this->getIndexKey(), $data)) {
+            return;
+        }
         $this->propertyRepository->updateElementProperties($element, $data);
     }
 
diff --git a/src/Updater/Service/UpdateService.php b/src/Updater/Service/UpdateService.php
index b120aa3d2..6169e73c3 100644
--- a/src/Updater/Service/UpdateService.php
+++ b/src/Updater/Service/UpdateService.php
@@ -44,9 +44,7 @@ public function update(string $elementType, int $id, array $data): void
         $element = $this->getElement($this->serviceResolver, $elementType, $id);
 
         foreach ($this->adapterLoader->loadAdapters($elementType) as $adapter) {
-            if (array_key_exists($adapter->getIndexKey(), $data)) {
-                $adapter->update($element, $data);
-            }
+            $adapter->update($element, $data);
         }
 
         try {