From f5cba4de97170c5f3323b6c008326b30c619380d Mon Sep 17 00:00:00 2001
From: Martin Ficzel <ficzel@sitegeist.de>
Date: Tue, 4 Jun 2024 22:23:24 +0200
Subject: [PATCH] WIP: Basic infrastructure for focal points in thumbnails and
 image variants

No actual calculation yet
---
 .../Classes/Domain/Model/FocalPointTrait.php  | 52 +++++++++++++++++++
 .../Classes/Domain/Model/ImageVariant.php     |  1 +
 Neos.Media/Classes/Domain/Model/Thumbnail.php |  1 +
 .../ImageThumbnailGenerator.php               |  5 ++
 .../Domain/Service/ThumbnailService.php       | 11 ++++
 .../Mysql/Version20240604184831.php           | 36 +++++++++++++
 6 files changed, 106 insertions(+)
 create mode 100644 Neos.Media/Classes/Domain/Model/FocalPointTrait.php
 create mode 100644 Neos.Media/Migrations/Mysql/Version20240604184831.php

diff --git a/Neos.Media/Classes/Domain/Model/FocalPointTrait.php b/Neos.Media/Classes/Domain/Model/FocalPointTrait.php
new file mode 100644
index 00000000000..5ab519f3c66
--- /dev/null
+++ b/Neos.Media/Classes/Domain/Model/FocalPointTrait.php
@@ -0,0 +1,52 @@
+<?php
+namespace Neos\Media\Domain\Model;
+
+/*
+ * This file is part of the Neos.Media package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Trait for methods regarding the focal point of an asset
+ */
+trait FocalPointTrait
+{
+    /**
+     * @var integer
+     * @ORM\Column(nullable=true)
+     */
+    protected $focalPointX = null;
+
+    /**
+     * @var integer
+     * @ORM\Column(nullable=true)
+     */
+    protected $focalPointY = null;
+
+    public function getFocalPointX(): ?int
+    {
+        return $this->focalPointX;
+    }
+
+    public function setFocalPointX(?int $focalPointX): void
+    {
+        $this->focalPointX = $focalPointX;
+    }
+
+    public function getFocalPointY(): ?int
+    {
+        return $this->focalPointY;
+    }
+
+    public function setFocalPointY(?int $focalPointY): void
+    {
+        $this->focalPointY = $focalPointY;
+    }
+}
diff --git a/Neos.Media/Classes/Domain/Model/ImageVariant.php b/Neos.Media/Classes/Domain/Model/ImageVariant.php
index 01a6b6476a3..626935fc8f2 100644
--- a/Neos.Media/Classes/Domain/Model/ImageVariant.php
+++ b/Neos.Media/Classes/Domain/Model/ImageVariant.php
@@ -35,6 +35,7 @@
 class ImageVariant extends Asset implements AssetVariantInterface, ImageInterface
 {
     use DimensionsTrait;
+    use FocalPointTrait;
 
     /**
      * @var ImageService
diff --git a/Neos.Media/Classes/Domain/Model/Thumbnail.php b/Neos.Media/Classes/Domain/Model/Thumbnail.php
index 56d3cf87c82..18168f4a88b 100644
--- a/Neos.Media/Classes/Domain/Model/Thumbnail.php
+++ b/Neos.Media/Classes/Domain/Model/Thumbnail.php
@@ -33,6 +33,7 @@ class Thumbnail implements ImageInterface
 {
     use DimensionsTrait;
     use QualityTrait;
+    use FocalPointTrait;
 
     /**
      * @var ThumbnailGeneratorStrategy
diff --git a/Neos.Media/Classes/Domain/Model/ThumbnailGenerator/ImageThumbnailGenerator.php b/Neos.Media/Classes/Domain/Model/ThumbnailGenerator/ImageThumbnailGenerator.php
index 8d8058cda3a..1710a6f5bff 100644
--- a/Neos.Media/Classes/Domain/Model/ThumbnailGenerator/ImageThumbnailGenerator.php
+++ b/Neos.Media/Classes/Domain/Model/ThumbnailGenerator/ImageThumbnailGenerator.php
@@ -57,6 +57,11 @@ public function canRefresh(Thumbnail $thumbnail)
     public function refresh(Thumbnail $thumbnail)
     {
         try {
+            /**
+             * @todo ... add additional crop to ensure that the focal point is
+             * in view after resizing ... needs common understanding wit
+             * the thumbnail service here: Packages/Neos/Neos.Media/Classes/Domain/Service/ThumbnailService.php:151
+             */
             $adjustments = [
                 new ResizeImageAdjustment(
                     [
diff --git a/Neos.Media/Classes/Domain/Service/ThumbnailService.php b/Neos.Media/Classes/Domain/Service/ThumbnailService.php
index 32843c971c3..8c3c76a6c8e 100644
--- a/Neos.Media/Classes/Domain/Service/ThumbnailService.php
+++ b/Neos.Media/Classes/Domain/Service/ThumbnailService.php
@@ -147,6 +147,17 @@ public function getThumbnail(AssetInterface $asset, ThumbnailConfiguration $conf
         if ($thumbnail === null) {
             $thumbnail = new Thumbnail($asset, $configuration);
 
+            if ($asset instanceof ImageVariant) {
+                // @todo: needs common understanding of dimension change with resize adjustment
+                // - if a focal point was set
+                // - calculate target dimensions here
+                // - calculate new focalPointAfter transformation
+                // - store focal point in new image
+                // has to work closely with: Packages/Neos/Neos.Media/Classes/Domain/Model/ThumbnailGenerator/ImageThumbnailGenerator.php:58
+                $thumbnail->setFocalPointX($asset->getFocalPointX() + 1);
+                $thumbnail->setFocalPointY($asset->getFocalPointY() + 1);
+            }
+
             // If the thumbnail strategy failed to generate a valid thumbnail
             if ($async === false && $thumbnail->getResource() === null && $thumbnail->getStaticResource() === null) {
                 // the thumbnail should not be persisted at this point, but remove is a no-op if the thumbnail
diff --git a/Neos.Media/Migrations/Mysql/Version20240604184831.php b/Neos.Media/Migrations/Mysql/Version20240604184831.php
new file mode 100644
index 00000000000..f7429b9014f
--- /dev/null
+++ b/Neos.Media/Migrations/Mysql/Version20240604184831.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\Flow\Persistence\Doctrine\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20240604184831 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on "mysql".');
+
+        $this->addSql('ALTER TABLE neos_media_domain_model_imagevariant ADD focalpointx INT DEFAULT NULL, ADD focalpointy INT DEFAULT NULL');
+        $this->addSql('ALTER TABLE neos_media_domain_model_thumbnail ADD focalpointx INT DEFAULT NULL, ADD focalpointy INT DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on "mysql".');
+
+        $this->addSql('ALTER TABLE neos_media_domain_model_imagevariant DROP focalpointx, DROP focalpointy');
+        $this->addSql('ALTER TABLE neos_media_domain_model_thumbnail DROP focalpointx, DROP focalpointy');
+
+    }
+}