IBX-5630: Added possibility to extend URL schema resolving

src/bundle/Core/ApiLoader/RepositoryFactory.php

@@ -10,6 +10,7 @@
 use Ibexa\Contracts\Core\Persistence\Filter\Location\Handler as LocationFilteringHandler;
 use Ibexa\Contracts\Core\Persistence\Handler as PersistenceHandler;
 use Ibexa\Contracts\Core\Repository\LanguageResolver;
+use Ibexa\Contracts\Core\Repository\NameSchema\NameSchemaServiceInterface;
 use Ibexa\Contracts\Core\Repository\PasswordHashService;
 use Ibexa\Contracts\Core\Repository\PermissionService;
 use Ibexa\Contracts\Core\Repository\Repository;
@@ -63,7 +64,7 @@ public function __construct(
         $this->repositoryClass = $repositoryClass;
         $this->policyMap = $policyMap;
         $this->languageResolver = $languageResolver;
-        $this->logger = null !== $logger ? $logger : new NullLogger();
+        $this->logger = $logger ?? new NullLogger();
     }
 
     /**
@@ -91,9 +92,10 @@ public function buildRepository(
         ContentFilteringHandler $contentFilteringHandler,
         LocationFilteringHandler $locationFilteringHandler,
         PasswordValidatorInterface $passwordValidator,
-        ConfigResolverInterface $configResolver
+        ConfigResolverInterface $configResolver,
+        NameSchemaServiceInterface $nameSchemaService
     ): Repository {
-        $config = $this->container->get(\Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider::class)->getRepositoryConfig();
+        $config = $this->container->get(RepositoryConfigurationProvider::class)->getRepositoryConfig();
 
         return new $this->repositoryClass(
             $persistenceHandler,
@@ -116,6 +118,7 @@ public function buildRepository(
             $locationFilteringHandler,
             $passwordValidator,
             $configResolver,
+            $nameSchemaService,
             [
                 'role' => [
                     'policyMap' => $this->policyMap,

src/bundle/Core/Resources/config/papi.yml

@@ -11,7 +11,6 @@ parameters:
 services:
     # API
     Ibexa\Bundle\Core\ApiLoader\RepositoryFactory:
-        class: Ibexa\Bundle\Core\ApiLoader\RepositoryFactory
         arguments:
             - '@ibexa.config.resolver'
             - Ibexa\Core\Repository\Repository

src/contracts/Event/ResolveUrlAliasSchemaEvent.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Event;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use Symfony\Contracts\EventDispatcher\Event;
+
+final class ResolveUrlAliasSchemaEvent extends Event
+{
+    /** @var array<string, array> */
+    private array $schemaIdentifiers;
+
+    private Content $content;
+
+    /**
+     * @var array<string, array<string>>
+     */
+    private array $names = [];
+
+    public function __construct(
+        array $schemaIdentifiers,
+        Content $content
+    ) {
+        $this->schemaIdentifiers = $schemaIdentifiers;
+        $this->content = $content;
+    }
+
+    public function getSchemaIdentifiers(): array
+    {
+        return $this->schemaIdentifiers;
+    }
+
+    public function getContent(): Content
+    {
+        return $this->content;
+    }
+
+    public function getTokenValues(): array
+    {
+        return $this->names;
+    }
+
+    public function setTokenValues(array $names): void
+    {
+        $this->names = $names;
+    }
+}

src/contracts/Repository/NameSchema/NameSchemaServiceInterface.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\NameSchema;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
+
+/**
+ * @internal Meant to be used by 1st party only
+ *
+ * @experimental
+ */
+interface NameSchemaServiceInterface
+{
+    /**
+     * @return array<string, string> key value map of names for a language code
+     */
+    public function resolveUrlAliasSchema(Content $content, ContentType $contentType = null): array;
+
+    /**
+     * @param array<string, array<string, string>> $fieldMap
+     * @param array<string> $languageCodes
+     *
+     * @return array
+     */
+    public function resolveNameSchema(
+        Content $content,
+        array $fieldMap = [],
+        array $languageCodes = [],
+        ContentType $contentType = null
+    ): array;
+
+    /**
+     * Returns the real name for a content name pattern.
+     *
+     * @param array<string, array<string, string>> $fieldMap
+     * @param array<string> $languageCodes
+     *
+     * @return array<string>
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     */
+    public function resolve(string $nameSchema, ContentType $contentType, array $fieldMap, array $languageCodes): array;
+}

src/contracts/Repository/NameSchema/SchemaIdentifierExtractorInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\NameSchema;
+
+interface SchemaIdentifierExtractorInterface
+{
+    /**
+     * @return array<string, array<string, string>>
+     */
+    public function extract(string $schemaString): array;
+}

src/contracts/Test/IbexaKernelTestTrait.php

@@ -19,6 +19,7 @@
 use Ibexa\Contracts\Core\Repository\RoleService;
 use Ibexa\Contracts\Core\Repository\SearchService;
 use Ibexa\Contracts\Core\Repository\SectionService;
+use Ibexa\Contracts\Core\Repository\URLAliasService;
 use Ibexa\Contracts\Core\Repository\UserService;
 use Ibexa\Contracts\Core\Test\Persistence\Fixture\FixtureImporter;
 use Ibexa\Core\Repository\Values\User\UserReference;
@@ -163,6 +164,11 @@ protected static function getSectionService(): SectionService
         return self::getServiceByClassName(SectionService::class);
     }
 
+    protected static function getUrlAliasService(): URLAliasService
+    {
+        return self::getServiceByClassName(URLAliasService::class);
+    }
+
     protected static function setAnonymousUser(): void
     {
         $anonymousUserId = 10;

src/contracts/Test/IbexaTestKernel.php

@@ -89,6 +89,7 @@ class IbexaTestKernel extends Kernel implements IbexaTestKernelInterface
         Repository\SectionService::class,
         Repository\UserService::class,
         Repository\TokenService::class,
+        Repository\URLAliasService::class,
     ];
 
     /**
@@ -150,6 +151,7 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load(static function (ContainerBuilder $container): void {
             $container->setParameter('ibexa.core.test.resource_dir', self::getResourcesPath());
+            $container->setParameter('ibexa.kernel.root_dir', dirname(__DIR__, 3));
         });
 
         $this->loadConfiguration($loader);

src/lib/Base/Container/ApiLoader/RepositoryFactory.php

@@ -10,6 +10,7 @@
 use Ibexa\Contracts\Core\Persistence\Filter\Location\Handler as LocationFilteringHandler;
 use Ibexa\Contracts\Core\Persistence\Handler as PersistenceHandler;
 use Ibexa\Contracts\Core\Repository\LanguageResolver;
+use Ibexa\Contracts\Core\Repository\NameSchema\NameSchemaServiceInterface;
 use Ibexa\Contracts\Core\Repository\PasswordHashService;
 use Ibexa\Contracts\Core\Repository\PermissionService;
 use Ibexa\Contracts\Core\Repository\Repository;
@@ -83,6 +84,7 @@ public function buildRepository(
         LocationFilteringHandler $locationFilteringHandler,
         PasswordValidatorInterface $passwordValidator,
         ConfigResolverInterface $configResolver,
+        NameSchemaServiceInterface $nameSchemaService,
         array $languages
     ): Repository {
         return new $this->repositoryClass(
@@ -106,6 +108,7 @@ public function buildRepository(
             $locationFilteringHandler,
             $passwordValidator,
             $configResolver,
+            $nameSchemaService,
             [
                 'role' => [
                     'policyMap' => $this->policyMap,

src/lib/Repository/ContentService.php

@@ -25,6 +25,7 @@
 use Ibexa\Contracts\Core\Persistence\Handler;
 use Ibexa\Contracts\Core\Repository\ContentService as ContentServiceInterface;
 use Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException as APINotFoundException;
+use Ibexa\Contracts\Core\Repository\NameSchema\NameSchemaServiceInterface;
 use Ibexa\Contracts\Core\Repository\PermissionService;
 use Ibexa\Contracts\Core\Repository\Repository as RepositoryInterface;
 use Ibexa\Contracts\Core\Repository\Validator\ContentValidator;
@@ -87,8 +88,7 @@ class ContentService implements ContentServiceInterface
     /** @var \Ibexa\Core\Repository\Helper\RelationProcessor */
     protected $relationProcessor;
 
-    /** @var \Ibexa\Core\Repository\Helper\NameSchemaService */
-    protected $nameSchemaService;
+    protected NameSchemaServiceInterface $nameSchemaService;
 
     /** @var \Ibexa\Core\FieldType\FieldTypeRegistry */
     protected $fieldTypeRegistry;
@@ -110,7 +110,7 @@ public function __construct(
         Handler $handler,
         ContentDomainMapper $contentDomainMapper,
         Helper\RelationProcessor $relationProcessor,
-        Helper\NameSchemaService $nameSchemaService,
+        NameSchemaServiceInterface $nameSchemaService,
         FieldTypeRegistry $fieldTypeRegistry,
         PermissionService $permissionService,
         ContentMapper $contentMapper,

src/lib/Repository/EventSubscriber/NameSchemaSubscriber.php

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Core\Repository\EventSubscriber;
+
+use Ibexa\Contracts\Core\Event\ResolveUrlAliasSchemaEvent;
+use Ibexa\Core\FieldType\FieldTypeRegistry;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * @internal
+ */
+final class NameSchemaSubscriber implements EventSubscriberInterface
+{
+    private FieldTypeRegistry $fieldTypeRegistry;
+
+    public function __construct(FieldTypeRegistry $fieldTypeRegistry)
+    {
+        $this->fieldTypeRegistry = $fieldTypeRegistry;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ResolveUrlAliasSchemaEvent::class => [
+                ['onResolveUrlAliasSchema', -100],
+            ],
+        ];
+    }
+
+    /**
+     * Resolves the URL alias schema by setting token values for specified field identifiers and languages.
+     *
+     * @param \Ibexa\Contracts\Core\Event\ResolveUrlAliasSchemaEvent $event
+     */
+    public function onResolveUrlAliasSchema(ResolveUrlAliasSchemaEvent $event): void
+    {
+        if (!array_key_exists('field', $event->getSchemaIdentifiers())) {
+            return;
+        }
+
+        $content = $event->getContent();
+        $identifiers = $event->getSchemaIdentifiers()['field'];
+        $languages = $event->getContent()->getVersionInfo()->getLanguages();
+        $tokenValues = $event->getTokenValues();
+
+        $contentType = $content->getContentType();
+        foreach ($languages as $language) {
+            $languageCode = $language->getLanguageCode();
+            foreach ($identifiers as $identifier) {
+                $fieldDefinition = $contentType->getFieldDefinition($identifier);
+                if (null === $fieldDefinition) {
+                    continue;
+                }
+                $persistenceFieldType = $this->fieldTypeRegistry->getFieldType($fieldDefinition->fieldTypeIdentifier);
+
+                $fieldValue = $content->getFieldValue($identifier, $languageCode);
+                $fieldValue = $persistenceFieldType->getName(
+                    $fieldValue,
+                    $fieldDefinition,
+                    $languageCode
+                );
+
+                $tokenValues[$languageCode][$identifier] = $fieldValue;
+            }
+        }
+
+        $event->setTokenValues($tokenValues);
+    }
+}