Declare automated translations as AI generated

Author: nezaniel

Classes/Command/LostInTranslationCommandController.php

@@ -4,13 +4,13 @@
 
 namespace Sitegeist\LostInTranslation\Command;
 
-use Neos\ContentGraph\DoctrineDbalAdapter\Domain\Repository\ContentSubgraph;
 use Neos\ContentRepository\Core\ContentRepository;
 use Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePoint;
 use Neos\ContentRepository\Core\DimensionSpace\OriginDimensionSpacePoint;
 use Neos\ContentRepository\Core\Feature\NodeVariation\Command\CreateNodeVariant;
 use Neos\ContentRepository\Core\Feature\Security\Exception\AccessDenied;
 use Neos\ContentRepository\Core\Projection\ContentGraph\AbsoluteNodePath;
+use Neos\ContentRepository\Core\Projection\ContentGraph\ContentSubgraphInterface;
 use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindChildNodesFilter;
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
@@ -69,7 +69,7 @@ public function translateCommand(string $source, string $target, string $content
             $this->translateNodeRecursive($cr, $start, $originSubgraph, $targetSubgraph);
     }
 
-    public function translateNodeRecursive(ContentRepository $cr, Node $originNode, ContentSubgraph $originSubgraph, ContentSubgraph $targetSubgraph): void
+    public function translateNodeRecursive(ContentRepository $cr, Node $originNode, ContentSubgraphInterface $originSubgraph, ContentSubgraphInterface $targetSubgraph): void
     {
         $targetNode = $targetSubgraph->findNodeById($originNode->aggregateId);
         if ($targetNode === null) {

Classes/ContentRepository/AuthProvider/AIAwareContentRepositoryAuthProvider.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sitegeist\LostInTranslation\ContentRepository\AuthProvider;
+
+use Neos\ContentRepository\Core\CommandHandler\CommandInterface;
+use Neos\ContentRepository\Core\Feature\Security\AuthProviderInterface;
+use Neos\ContentRepository\Core\Feature\Security\Dto\Privilege;
+use Neos\ContentRepository\Core\Feature\Security\Dto\UserId;
+use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
+use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName;
+use Neos\Flow\Annotations as Flow;
+
+#[Flow\Proxy(false)]
+final class AIAwareContentRepositoryAuthProvider implements AuthProviderInterface
+{
+    public function __construct(
+        private readonly AuthProviderInterface $baseAuthProvider,
+        private readonly AISystemTranslationRuntimeState $aiSystemTranslationRuntimeState,
+    ) {
+    }
+
+    public function getAuthenticatedUserId(): ?UserId
+    {
+        return $this->aiSystemTranslationRuntimeState->getActiveAIServiceId()
+            ?: $this->baseAuthProvider->getAuthenticatedUserId();
+    }
+
+    public function canReadNodesFromWorkspace(WorkspaceName $workspaceName): Privilege
+    {
+        return $this->baseAuthProvider->canReadNodesFromWorkspace($workspaceName);
+    }
+
+    public function getVisibilityConstraints(WorkspaceName $workspaceName): VisibilityConstraints
+    {
+        return $this->baseAuthProvider->getVisibilityConstraints($workspaceName);
+    }
+
+    public function canExecuteCommand(CommandInterface $command): Privilege
+    {
+        return $this->baseAuthProvider->canExecuteCommand($command);
+    }
+}

Classes/ContentRepository/AuthProvider/AIAwareContentRepositoryAuthProviderFactory.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sitegeist\LostInTranslation\ContentRepository\AuthProvider;
+
+use Neos\ContentRepository\Core\Factory\AuthProviderFactoryInterface;
+use Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphReadModelInterface;
+use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Security\Context as SecurityContext;
+use Neos\Neos\Domain\Service\UserService;
+use Neos\Neos\Security\Authorization\ContentRepositoryAuthorizationService;
+use Neos\Neos\Security\ContentRepositoryAuthProvider\ContentRepositoryAuthProvider;
+
+/**
+ * Implementation of the {@see AuthProviderFactoryInterface} in order to provide authentication and authorization for Content Repositories
+ * and distinguish between human and AI editors
+ *
+ * @api
+ */
+#[Flow\Scope('singleton')]
+final readonly class AIAwareContentRepositoryAuthProviderFactory implements AuthProviderFactoryInterface
+{
+    public function __construct(
+        private UserService $userService,
+        private ContentRepositoryAuthorizationService $contentRepositoryAuthorizationService,
+        private SecurityContext $securityContext,
+        private AISystemTranslationRuntimeState $aiSystemTranslationRuntimeState,
+    ) {
+    }
+
+    public function build(
+        ContentRepositoryId $contentRepositoryId,
+        ContentGraphReadModelInterface $contentGraphReadModel
+    ): AIAwareContentRepositoryAuthProvider {
+        return new AIAwareContentRepositoryAuthProvider(
+            baseAuthProvider: new ContentRepositoryAuthProvider(
+                $contentRepositoryId,
+                $this->userService,
+                $contentGraphReadModel,
+                $this->contentRepositoryAuthorizationService,
+                $this->securityContext
+            ),
+            aiSystemTranslationRuntimeState: $this->aiSystemTranslationRuntimeState,
+        );
+    }
+}

Classes/ContentRepository/AuthProvider/AIAwareFakeAuthProviderFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sitegeist\LostInTranslation\ContentRepository\AuthProvider;
+
+use Neos\ContentRepository\Core\Factory\AuthProviderFactoryInterface;
+use Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphReadModelInterface;
+use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
+use Neos\ContentRepository\TestSuite\Fakes\FakeAuthProvider;
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * Implementation of the {@see AuthProviderFactoryInterface} in order to provide authentication and authorization for Content Repositories
+ * and distinguish between human and AI editors
+ *
+ * @api
+ */
+#[Flow\Scope('singleton')]
+final readonly class AIAwareFakeAuthProviderFactory implements AuthProviderFactoryInterface
+{
+    public function __construct(
+        private AISystemTranslationRuntimeState $aiSystemTranslationRuntimeState,
+    ) {
+    }
+
+    public function build(
+        ContentRepositoryId $contentRepositoryId,
+        ContentGraphReadModelInterface $contentGraphReadModel
+    ): AIAwareContentRepositoryAuthProvider {
+        return new AIAwareContentRepositoryAuthProvider(
+            /** @phpstan-ignore class.notFound (requires dev dependencies) */
+            baseAuthProvider: new FakeAuthProvider(),
+            aiSystemTranslationRuntimeState: $this->aiSystemTranslationRuntimeState,
+        );
+    }
+}

Classes/ContentRepository/AuthProvider/AISystemTranslationRuntimeState.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sitegeist\LostInTranslation\ContentRepository\AuthProvider;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\ContentRepository\Core\Feature\Security\Dto\UserId;
+
+/**
+ * The state tracking if an AI system - and which one - is currently running a translation
+ */
+#[Flow\Scope('singleton')]
+final class AISystemTranslationRuntimeState
+{
+    public function __construct(
+        private ?UserId $activeAIServiceId = null
+    ) {
+    }
+
+    public function setActiveAIServiceId(UserId $aiServiceId): void
+    {
+        $this->activeAIServiceId = $aiServiceId;
+    }
+
+    public function getActiveAIServiceId(): ?UserId
+    {
+        return $this->activeAIServiceId;
+    }
+
+    public function resetActiveAIServiceId(): void
+    {
+        $this->activeAIServiceId = null;
+    }
+}

Classes/ContentRepository/CommandHook/TranslationCommandHook.php

@@ -15,6 +15,7 @@
 use Neos\ContentRepository\Core\NodeType\NodeTypeManager;
 use Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphReadModelInterface;
 use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
+use Sitegeist\LostInTranslation\ContentRepository\AuthProvider\AISystemTranslationRuntimeState;
 use Sitegeist\LostInTranslation\Domain\Directive\DimensionValueDirectiveFactory;
 use Sitegeist\LostInTranslation\Domain\Directive\NodeTypeTranslationDirectiveFactory;
 use Sitegeist\LostInTranslation\Domain\TranslationServiceInterface;
@@ -29,6 +30,7 @@ public function __construct(
         private readonly DimensionValueDirectiveFactory $dimensionValueDirectiveFactory,
         private readonly TranslationServiceInterface $translationService,
         private readonly ContentDimension $languageDimension,
+        private readonly AISystemTranslationRuntimeState $aiSystemTranslationRuntimeState,
     ) {
     }
 
@@ -43,11 +45,13 @@ public function onBeforeHandle(CommandInterface $command): CommandInterface
 
     public function onAfterHandle(CommandInterface $command, PublishedEvents $events): Commands
     {
+        $this->aiSystemTranslationRuntimeState->resetActiveAIServiceId();
         if ($this->enabled === false) {
             return Commands::createEmpty();
         }
 
         if ($command instanceof CreateNodeVariant) {
+            $this->aiSystemTranslationRuntimeState->setActiveAIServiceId($this->translationService->getAIServiceId());
             return $this->createNodeVariantCommandWasHandled($command);
         } else {
             return Commands::createEmpty();

Classes/ContentRepository/CommandHook/TranslationCommandHookFactory.php

@@ -11,6 +11,7 @@
 use Neos\ContentRepository\Core\Factory\CommandHooksFactoryDependencies;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\Annotations as Flow;
+use Sitegeist\LostInTranslation\ContentRepository\AuthProvider\AISystemTranslationRuntimeState;
 use Sitegeist\LostInTranslation\Domain\Directive\DimensionValueDirectiveFactory;
 use Sitegeist\LostInTranslation\Domain\Directive\NodeTypeTranslationDirectiveFactory;
 use Sitegeist\LostInTranslation\Domain\TranslationServiceInterface;
@@ -27,6 +28,7 @@ public function __construct(
         protected readonly ContentRepositoryRegistry $contentRepositoryRegistry,
         protected readonly NodeTypeTranslationDirectiveFactory $translatablePropertyNamesFactory,
         protected readonly TranslationServiceInterface $translationService,
+        protected readonly AISystemTranslationRuntimeState $aiSystemTranslationRuntimeState,
     ) {
     }
 
@@ -44,7 +46,8 @@ public function build(CommandHooksFactoryDependencies $commandHooksFactoryDepend
                 $this->translatablePropertyNamesFactory,
                 new DimensionValueDirectiveFactory(),
                 $this->translationService,
-                $languageDimension
+                $languageDimension,
+                $this->aiSystemTranslationRuntimeState,
             );
         } else {
             throw new \Exception(sprintf('Lamguage dimension %s was nou found in content repository %s', $this->languageDimensionName, $commandHooksFactoryDependencies->contentRepositoryId->value));

Classes/Domain/TranslationServiceInterface.php

@@ -4,6 +4,8 @@
 
 namespace Sitegeist\LostInTranslation\Domain;
 
+use Neos\ContentRepository\Core\Feature\Security\Dto\UserId;
+
 interface TranslationServiceInterface
 {
     /**
@@ -15,4 +17,6 @@ interface TranslationServiceInterface
     public function translate(array $texts, string $targetLanguage, ?string $sourceLanguage = null): array;
 
     public function getStatus(): ApiStatus;
+
+    public function getAIServiceId(): UserId;
 }

Classes/Infrastructure/DeepL/DeepLTranslationService.php

@@ -10,6 +10,7 @@
 use DeepL\TranslatorOptions;
 use DeepL\Usage;
 use Neos\Cache\Frontend\StringFrontend;
+use Neos\ContentRepository\Core\Feature\Security\Dto\UserId;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Http\Client\Browser;
 use Neos\Flow\Http\Client\CurlEngine;
@@ -209,6 +210,11 @@ public function getStatus(): ApiStatus
         }
     }
 
+    public function getAIServiceId(): UserId
+    {
+        return UserId::fromString('AI:DeepL:DeepL');
+    }
+
     protected function getDeeplAuthenticationKey(): DeepLAuthenticationKey
     {
         return $this->authenticationKeyFactory->create();

Classes/Infrastructure/Dummy/DummyTranslationService.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sitegeist\LostInTranslation\Infrastructure\Dummy;
+
+use Neos\ContentRepository\Core\Feature\Security\Dto\UserId;
+use Neos\Flow\Annotations as Flow;
+use Sitegeist\LostInTranslation\Domain\ApiStatus;
+use Sitegeist\LostInTranslation\Domain\TranslationServiceInterface;
+
+#[Flow\Scope('singleton')]
+class DummyTranslationService implements TranslationServiceInterface
+{
+    public function translate(array $texts, string $targetLanguage, ?string $sourceLanguage = null): array
+    {
+        return array_map(
+            fn (string $text): string => $text . ' translated',
+            $texts,
+        );
+    }
+
+    public function getStatus(): ApiStatus
+    {
+        return new ApiStatus(true);
+    }
+
+    public function getAIServiceId(): UserId
+    {
+        return UserId::fromString('AI:dummy:my-dummy');
+    }
+}