!!! FEATURE: Extensible meta data properties

Classes/Command/AssetMetaDataCommandController.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\MetaData\Command;
+
+use InvalidArgumentException;
+use JsonException;
+use Neos\Flow\Cli\CommandController;
+use Neos\MetaData\Domain\Dto\MetaDataAssetReference;
+use Neos\MetaData\Domain\Dto\MetaDataDimensionSpacePoint;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyName;
+use Neos\MetaData\MetaDataManager;
+
+final class AssetMetaDataCommandController extends CommandController
+{
+
+    public function __construct(
+        private readonly MetaDataManager $metaDataManager,
+    )
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Sets a metadata property for an asset to a specific value
+     *
+     * @param string $assetId ID of the asset to set the metadata property for
+     * @param string $property name of the metadata property to set
+     * @param string $value value of the metadata property
+     * @param string|null $assetSource optional asset source - default = "neos"
+     * @param string|null $dimensionSpacePoint optional dimension space point as JSON (e.g. `'{"language": "de"}') - default = the configured defaultDimensionSpacePoint
+     */
+    public function setCommand(string $assetId, string $property, string $value, string|null $assetSource = null, string|null $dimensionSpacePoint = null): void
+    {
+        $dimensionSpacePointDecoded = $dimensionSpacePoint !== null ? self::parseDimensionSpacePoint($dimensionSpacePoint) : null;
+        $assetReference = MetaDataAssetReference::create($assetSource ?? 'neos', $assetId);
+        $this->metaDataManager->setMetaDataPropertyValue(
+            $assetReference,
+            MetaDataPropertyName::fromString($property),
+            $value,
+            $dimensionSpacePointDecoded,
+        );
+        $message = sprintf('Metadata property "%s" of asset "%s" was set to "%s"', $property, $value, $assetId);
+        if ($dimensionSpacePointDecoded !== null) {
+            $message .= sprintf(' for dimension space point "%s"', $dimensionSpacePointDecoded->hash);
+        }
+        $this->outputLine("<success>$message</success>");
+    }
+
+    /**
+     * Removes a metadata property for an asset
+     *
+     * @param string $assetId ID of the asset to unset the metadata property for
+     * @param string $property name of the metadata property to unset
+     * @param string|null $assetSource optional asset source - default = "neos"
+     * @param string|null $dimensionSpacePoint optional dimension space point as JSON (e.g. `'{"language": "de"}') - default = the configured defaultDimensionSpacePoint
+     */
+    public function unsetCommand(string $assetId, string $property, string|null $assetSource = null, string|null $dimensionSpacePoint = null): void
+    {
+        $dimensionSpacePointDecoded = $dimensionSpacePoint !== null ? self::parseDimensionSpacePoint($dimensionSpacePoint) : null;
+        $assetReference = MetaDataAssetReference::create($assetSource ?? 'neos', $assetId);
+        $this->metaDataManager->unsetMetaDataPropertyValue(
+            $assetReference,
+            MetaDataPropertyName::fromString($property),
+            $dimensionSpacePointDecoded,
+        );
+        $message = sprintf('Metadata property "%s" of asset "%s" was unset', $property, $assetId);
+        if ($dimensionSpacePointDecoded !== null) {
+            $message .= sprintf(' for dimension space point "%s"', $dimensionSpacePointDecoded->hash);
+        }
+        $this->outputLine("<success>$message</success>");
+    }
+
+    /**
+     * Lists all metadata properties for an asset
+     *
+     * @param string $assetId ID of the asset to unset the metadata property for
+     * @param string|null $assetSource optional asset source - default = "neos"
+     * @param string|null $dimensionSpacePoint optional dimension space point as JSON (e.g. `'{"language": "de"}') - default = the configured defaultDimensionSpacePoint
+     */
+    public function listCommand(string $assetId, string|null $assetSource = null, string|null $dimensionSpacePoint = null): void
+    {
+        $dimensionSpacePointDecoded = $dimensionSpacePoint !== null ? self::parseDimensionSpacePoint($dimensionSpacePoint) : null;
+        $assetReference = MetaDataAssetReference::create($assetSource ?? 'neos', $assetId);
+        $metaDataPropertyValues = $this->metaDataManager->getMetaDataPropertyValues(
+            $assetReference,
+            $dimensionSpacePointDecoded,
+        );
+        $message = sprintf('Metadata properties of asset "%s"', $assetId);
+        if ($dimensionSpacePointDecoded !== null) {
+            $message .= sprintf(' for dimension space point "%s"', $dimensionSpacePointDecoded->hash);
+        }
+        $message .= ':';
+        $this->outputLine($message);
+        foreach ($metaDataPropertyValues as $propertyName => $propertyValue) {
+            $this->outputLine('  <b>%s:</b> %s', [$propertyName, $propertyValue ?? '-']);
+        }
+    }
+
+    private static function parseDimensionSpacePoint(string $dimensionSpacePoint): MetaDataDimensionSpacePoint
+    {
+        try {
+            return MetaDataDimensionSpacePoint::fromCoordinates(json_decode($dimensionSpacePoint, true, 512, JSON_THROW_ON_ERROR));
+        } catch (JsonException $e) {
+            throw new InvalidArgumentException('Failed to parse dimension space point: ' . $e->getMessage(), 1776274597, $e);
+        }
+    }
+
+}

Classes/Command/AssetMetaDataMigrationCommandController.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\MetaData\Command;
+
+use Neos\Flow\Cli\CommandController;
+use Neos\Media\Domain\Model\Asset;
+use Neos\Media\Domain\Repository\AssetRepository;
+use Neos\MetaData\Domain\Dto\MetaDataAssetReference;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyName;
+use Neos\MetaData\MetaDataManager;
+
+final class AssetMetaDataMigrationCommandController extends CommandController
+{
+    public function __construct(
+        private readonly MetaDataManager $metaDataManager,
+        private readonly AssetRepository $assetRepository,
+    ) {
+        parent::__construct();
+    }
+
+    public function migrateExistingAssetPropertiesCommand(): void
+    {
+        foreach ($this->assetRepository->findAll() as $asset) {
+            /** @var Asset $asset */
+            $title = $asset->getTitle();
+            $caption = $asset->getCaption();
+            $copyrightNotice = $asset->getCopyrightNotice();
+            $metaDataAssetReference = MetaDataAssetReference::create($asset->assetSourceIdentifier, $asset->getIdentifier());
+
+            if (!empty($caption)) {
+                $this->metaDataManager->setMetaDataPropertyValue(
+                    $metaDataAssetReference,
+                    MetaDataPropertyName::fromString('caption'),
+                    $asset->getCaption(),
+                );
+            }
+            if (!empty($copyrightNotice)) {
+                $this->metaDataManager->setMetaDataPropertyValue(
+                    $metaDataAssetReference,
+                    MetaDataPropertyName::fromString('copyright'),
+                    $asset->getCopyrightNotice(),
+                );
+            }
+        }
+    }
+}

Classes/Configuration/MetaDataConfigurationProvider.php

@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace Neos\MetaData\Configuration;
+
+use Neos\MetaData\Domain\Dto\MetaDataPropertyDefinitions;
+
+/**
+ * Provider for global property configuration (usually from settings (YAML))
+ */
+interface MetaDataConfigurationProvider
+{
+    public function getPropertyConfiguration(): MetaDataPropertyDefinitions;
+}

Classes/Configuration/MetaDataConfigurationProviderYamlAdapter.php

@@ -0,0 +1,59 @@
+<?php
+declare(strict_types=1);
+
+namespace Neos\MetaData\Configuration;
+
+use Neos\Flow\I18n\Translator;
+use Neos\MetaData\Domain\Dto\MetaDataEditorDefinition;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyDefinition;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyDefinitions;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyName;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyType;
+use Neos\MetaData\Domain\Dto\MetaDataPropertyUiDefinition;
+
+class MetaDataConfigurationProviderYamlAdapter implements MetaDataConfigurationProvider
+{
+    public function __construct(
+        private readonly array $propertyConfiguration,
+        private readonly Translator $translator,
+    )
+    {
+    }
+
+    public function getPropertyConfiguration(): MetaDataPropertyDefinitions
+    {
+        $propertyDefinitions = [];
+        foreach ($this->propertyConfiguration as $propertyName => $propertyDefinition) {
+            $propertyDefinitions[] = new MetaDataPropertyDefinition(
+                MetaDataPropertyName::fromString($propertyName),
+                match ($propertyDefinition['type'] ?? null) {
+                    'integer' => MetaDataPropertyType::integer,
+                    'boolean' => MetaDataPropertyType::boolean,
+                    default => MetaDataPropertyType::string,
+                },
+                $propertyDefinition['globalScope'] ?? false,
+                new MetaDataPropertyUiDefinition(
+                    $this->translatePropertyName($propertyName, $propertyDefinition['ui']['label']),
+                    MetaDataEditorDefinition::create(
+                        editorType: $propertyDefinition['ui']['inspector']['editor'] ?? null,
+                        options: $propertyDefinition['ui']['inspector']['editorOptions'] ?? [],
+                    )
+                )
+            );
+        }
+        return MetaDataPropertyDefinitions::create(...$propertyDefinitions);
+    }
+
+    // -----------------------
+
+    private function translatePropertyName(string $propertyName, ?string $label): string
+    {
+        if ($label === 'i18n') {
+            $translationShortHandString = sprintf('properties.%s', $propertyName);
+             return $this->translator->translateById($translationShortHandString, [], null, null, 'Main', 'Neos.MetaData') ?? $propertyName;
+        } elseif ($label !== null) {
+            return $label;
+        }
+        return $propertyName;
+    }
+}

Classes/Configuration/MetaDataConfigurationProviderYamlAdapterFactory.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace Neos\MetaData\Configuration;
+
+use Neos\Flow\I18n\Translator;
+
+class MetaDataConfigurationProviderYamlAdapterFactory
+{
+    public function __construct(
+        private readonly array $propertyConfiguration,
+        private readonly Translator $translator,
+    )
+    {
+    }
+
+    public function create(): MetaDataConfigurationProvider
+    {
+        return new MetaDataConfigurationProviderYamlAdapter($this->propertyConfiguration, $this->translator);
+    }
+}

Classes/DimensionSpacePointProvider/DimensionSpacePointProvider.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\MetaData\DimensionSpacePointProvider;
+
+use Neos\MetaData\Domain\Dto\MetaDataDimensionSpacePoint;
+use Neos\MetaData\Domain\Dto\MetaDataDimensionSpacePoints;
+
+/**
+ * Provider for global dimension configuration (usually from the Neos Content Repository)
+ */
+interface DimensionSpacePointProvider
+{
+    public function getDimensionSpacePoints(): MetaDataDimensionSpacePoints;
+
+    public function getDefaultDimensionSpacePoint(): MetaDataDimensionSpacePoint;
+
+    public function getDimensionSpacePointChain(MetaDataDimensionSpacePoint $dimensionSpacePoint): MetaDataDimensionSpacePoints;
+
+    public function isDimensionSpacePointValid(MetaDataDimensionSpacePoint $dimensionSpacePoint): bool;
+}