feat: add translation feature

README.md

@@ -106,6 +106,7 @@ Here you can find the environment variables including feature flags
 | DATA_STORE_STATISTIC_PUB_SUB_TOPIC     | Topic name for statistic metadata Pub/Sub                                                                                            | -             |
 | REDIRECT_AFTER_LOGOUT_URL              | Allows to configure the redirect after logout via environment variable. The fallback is the configured redirect on urlroute.conf.php | -             |
 | PORTAL_URL                             | The Portal url used on the back button of Portal theme                                                                               | -             |
+| FEATURE_TRANSLATION_ENABLED            | Enable access to items/tests translations feature                                                                                    | -             |
 
 
 # Routing

actions/class.Main.php

@@ -521,11 +521,13 @@ private function getSections($shownExtension, $shownStructure)
         $sections = [];
         $user = $this->getSession()->getUser();
         $structure = MenuService::getPerspective($shownExtension, $shownStructure);
+        $sectionVisibilityFilter = $this->getSectionVisibilityFilter();
+
         if (!is_null($structure)) {
             foreach ($structure->getChildren() as $section) {
                 $resolver = new ActionResolver($section->getUrl());
 
-                if (!$this->getSectionVisibilityFilter()->isVisible($section->getId())) {
+                if (!$sectionVisibilityFilter->isVisible($section->getId())) {
                     continue;
                 }
 
@@ -540,6 +542,19 @@ private function getSections($shownExtension, $shownStructure)
 
                 if (FuncProxy::accessPossible($user, $resolver->getController(), $resolver->getAction())) {
                     foreach ($section->getActions() as $action) {
+                        $sectionPath = $sectionVisibilityFilter->createSectionPath(
+                            [
+                                $section->getId(),
+                                $action->getId()
+                            ]
+                        );
+
+                        if (!$sectionVisibilityFilter->isVisible($sectionPath)) {
+                            $section->removeAction($action);
+
+                            continue;
+                        }
+
                         $this->propagate($action);
                         $resolver = new ActionResolver($action->getUrl());
                         if (
@@ -580,7 +595,7 @@ protected function getUserService()
         return $this->getServiceLocator()->get(tao_models_classes_UserService::SERVICE_ID);
     }
 
-    private function getSectionVisibilityFilter(): SectionVisibilityFilterInterface
+    private function getSectionVisibilityFilter(): SectionVisibilityFilter
     {
         if (empty($this->sectionVisibilityFilter)) {
             $this->sectionVisibilityFilter = $this->getServiceLocator()->get(SectionVisibilityFilter::SERVICE_ID);

actions/class.Translation.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA;
+ */
+
+declare(strict_types=1);
+
+use oat\tao\model\http\HttpJsonResponseTrait;
+use oat\tao\model\Translation\Service\ResourceTranslationRetriever;
+use oat\tao\model\Translation\Service\ResourceTranslatableRetriever;
+
+class tao_actions_Translation extends tao_actions_CommonModule
+{
+    use HttpJsonResponseTrait;
+
+    public function translations(): void
+    {
+        try {
+            $this->setSuccessJsonResponse(
+                $this->getResourceTranslationRetriever()->getByRequest($this->getPsrRequest())
+            );
+        } catch (Throwable $exception) {
+            $this->setErrorJsonResponse($exception->getMessage());
+        }
+    }
+
+    public function translatable(): void
+    {
+        try {
+            $this->setSuccessJsonResponse(
+                $this->getResourceTranslatableRetriever()->getByRequest($this->getPsrRequest())
+            );
+        } catch (Throwable $exception) {
+            $this->setErrorJsonResponse($exception->getMessage());
+        }
+    }
+
+    private function getResourceTranslationRetriever(): ResourceTranslationRetriever
+    {
+        return $this->getServiceManager()->getContainer()->get(ResourceTranslationRetriever::class);
+    }
+
+    private function getResourceTranslatableRetriever(): ResourceTranslatableRetriever
+    {
+        return $this->getServiceManager()->getContainer()->get(ResourceTranslatableRetriever::class);
+    }
+}

doc/taoApi.yml

@@ -5,6 +5,60 @@ info:
   version: v1
 
 paths:
+  /tao/Translation/translations:
+    get:
+      summary: Return a list of translations for a given translatable resource
+      parameters:
+        - in: query
+          name: resourceType
+          required: true
+          schema:
+            type: string
+          description: The RDF resource type
+        - in: query
+          name: uniqueId
+          required: true
+          schema:
+            type: string
+          description: The uniqueId of a translation
+        - in: query
+          name: languageUri
+          required: false
+          schema:
+            type: string
+          description: The RDF language URI
+      responses:
+        200:
+          $ref: '#/components/responses/TranslationsResponse'
+        400:
+          $ref: '#/components/responses/BadRequestResponse'
+        500:
+          $ref: '#/components/responses/InternalServerErrorResponse'
+  /tao/Translation/translatable:
+    get:
+      summary: Return translatable resources
+      parameters:
+        - in: query
+          name: resourceType
+          required: true
+          schema:
+            type: string
+          description: The RDF resource type
+        - in: query
+          name: uniqueIds
+          required: true
+          schema:
+            type: array
+            items:
+              type: string
+          description: The uniqueIds for a translatable
+      responses:
+        200:
+          $ref: '#/components/responses/TranslationsResponse'
+        400:
+          $ref: '#/components/responses/BadRequestResponse'
+        500:
+          $ref: '#/components/responses/InternalServerErrorResponse'
   /tao/Languages/index:
     get:
       summary: Get a list of available languages in the TAO platform
@@ -46,6 +100,60 @@ paths:
           $ref: '#/components/responses/InternalServerErrorResponse'
 components:
   schemas:
+    Translations:
+      properties:
+        success:
+          type: boolean
+          example: true
+        data:
+          type: object
+          properties:
+            resources: 
+              type: array
+              items:
+                properties:
+                  originResourceUri:
+                    type: string
+                  resourceUri:
+                    type: string
+                  resourceLabel:
+                    type: string
+                  metadata:
+                    type: object
+                    properties:
+                      key:
+                        type: object
+                        properties:
+                          value:
+                            type: string
+                          literal:
+                            type: string
+    Translatable:
+      properties:
+        success:
+          type: boolean
+          example: true
+        data:
+          type: object
+          properties:
+            resources: 
+              type: array
+              items:
+                properties:
+                  resourceUri:
+                    type: string
+                  resourceLabel:
+                    type: string
+                  metadata:
+                    type: object
+                    properties:
+                      key:
+                        type: object
+                        properties:
+                          value:
+                            type: string
+                          literal:
+                            type: string
     ResourceRelationResource:
       description: 'A resource related to another resources'
       type: object
@@ -104,6 +212,18 @@ components:
         message:
           type: string
   responses:
+    TranslationsResponse:
+      description: The list of translations
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Translations'
+    TranslatableResponse:
+      description: The list of translatable
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Translatable'
     ResourceRelationsResponse:
       description: Bad request
       content:

helpers/form/class.FormContainer.php

@@ -26,7 +26,9 @@
 
 use oat\oatbox\service\ServiceManager;
 use oat\oatbox\validator\ValidatorInterface;
+use oat\tao\model\form\Modifier\AbstractFormModifier;
 use oat\tao\model\security\xsrf\TokenService;
+use Psr\Container\ContainerInterface;
 use tao_helpers_form_FormFactory as FormFactory;
 use oat\tao\helpers\form\elements\xhtml\CsrfToken;
 use oat\tao\helpers\form\elements\FormElementAware;
@@ -46,6 +48,7 @@ abstract class tao_helpers_form_FormContainer
     public const IS_DISABLED = 'is_disabled';
     public const ADDITIONAL_VALIDATORS = 'extraValidators';
     public const ATTRIBUTE_VALIDATORS = 'attributeValidators';
+    public const FORM_MODIFIERS = 'formModifiers';
 
     public const WITH_SERVICE_MANAGER = 'withServiceManager';
 
@@ -118,6 +121,14 @@ public function __construct(array $data = [], array $options = [])
         // initialize the elements of the form
         $this->initElements();
 
+        foreach ($options[self::FORM_MODIFIERS] ?? [] as $modifierClass) {
+            $modifier = $this->getContainer()->get($modifierClass);
+
+            if ($modifier instanceof AbstractFormModifier) {
+                $modifier->modify($this->form, $options);
+            }
+        }
+
         if ($this->form !== null) {
             $this->form->evaluateInputValues();
 
@@ -317,8 +328,7 @@ private function configureFormValidators(iterable $validators, tao_helpers_form_
     private function getSanitizerValidationFeeder(): SanitizerValidationFeederInterface
     {
         if (!isset($this->sanitizerValidationFeeder)) {
-            $serviceManager = $this->serviceManager ?? ServiceManager::getServiceManager();
-            $this->sanitizerValidationFeeder = $serviceManager->getContainer()->get(SanitizerValidationFeeder::class);
+            $this->sanitizerValidationFeeder = $this->getContainer()->get(SanitizerValidationFeeder::class);
         }
 
         return $this->sanitizerValidationFeeder;
@@ -335,4 +345,11 @@ private function withServiceManager(array &$options): void
 
         unset($options[self::WITH_SERVICE_MANAGER]);
     }
+
+    private function getContainer(): ContainerInterface
+    {
+        $serviceManager = $this->serviceManager ?? ServiceManager::getServiceManager();
+
+        return $serviceManager->getContainer();
+    }
 }

manifest.php

@@ -57,6 +57,7 @@
 use oat\tao\model\routing\ServiceProvider\RoutingServiceProvider;
 use oat\tao\model\search\ServiceProvider\SearchServiceProvider;
 use oat\tao\model\StatisticalMetadata\StatisticalMetadataServiceProvider;
+use oat\tao\model\Translation\ServiceProvider\TranslationServiceProvider;
 use oat\tao\model\user\TaoRoles;
 use oat\tao\model\user\UserSettingsServiceProvider;
 use oat\tao\model\webhooks\WebhookServiceProvider;
@@ -308,6 +309,7 @@
         [AccessRule::GRANT, TaoRoles::BASE_USER, ['ext' => 'tao', 'mod' => 'File', 'act' => 'accessFile']],
         [AccessRule::GRANT, TaoRoles::BASE_USER, ['ext' => 'tao', 'mod' => 'Log', 'act' => 'log']],
         [AccessRule::GRANT, TaoRoles::BASE_USER, ['ext' => 'tao', 'mod' => 'TaskQueueWebApi']],
+        [AccessRule::GRANT, TaoRoles::BACK_OFFICE, ['ext' => 'tao', 'mod' => 'Translation']],
         [AccessRule::GRANT, TaoRoles::BACK_OFFICE, ['ext' => 'tao', 'mod' => 'Languages', 'act' => 'index']],
         [AccessRule::GRANT, TaoRoles::BACK_OFFICE, ['ext' => 'tao', 'mod' => 'ResourceRelations', 'act' => 'index']],
         [AccessRule::GRANT, TaoRoles::BACK_OFFICE, ['ext' => 'tao', 'mod' => 'File', 'act' => 'upload']],
@@ -418,7 +420,8 @@
         MenuServiceProvider::class,
         FormDataProviderServiceProvider::class,
         PropertyServiceProvider::class,
-        DynamicConfigServiceProvider::class
+        DynamicConfigServiceProvider::class,
+        TranslationServiceProvider::class
     ],
     'middlewares' => [
         MiddlewareConfig::class,

migrations/Version202409040743452141_tao.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace oat\tao\migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use oat\oatbox\reporting\Report;
+use oat\tao\model\accessControl\func\AccessRule;
+use oat\tao\model\accessControl\func\AclProxy;
+use oat\tao\model\user\TaoRoles;
+use oat\tao\scripts\tools\migrations\AbstractMigration;
+use oat\tao\scripts\update\OntologyUpdater;
+
+final class Version202409040743452141_tao extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add new access to ' . TaoRoles::BACK_OFFICE;
+    }
+
+    public function up(Schema $schema): void
+    {
+        OntologyUpdater::syncModels();
+        $this->addReport(Report::createSuccess('Ontology models successfully synchronized'));
+
+        AclProxy::applyRule($this->getRule());
+        $this->addReport(Report::createSuccess('Applied access for role ' . TaoRoles::BACK_OFFICE));
+    }
+
+    public function down(Schema $schema): void
+    {
+        AclProxy::revokeRule($this->getRule());
+    }
+
+    private function getRule(): AccessRule
+    {
+        return new AccessRule(
+            AccessRule::GRANT,
+            TaoRoles::BACK_OFFICE,
+            [
+                'ext' => 'tao',
+                'mod' => 'Translation'
+            ]
+        );
+    }
+}