Feat/hkd 6/integration

actions/class.Creator.php

@@ -1,22 +1,22 @@
 <?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) 2013 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
-*/
+ * 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) 2013-2024 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
+ */
 
 use oat\taoQtiTest\models\TestCategoryPresetProvider;
 use oat\taoQtiTest\models\TestModelService;
@@ -45,6 +45,10 @@ public function index()
         $testUri   =  $this->getRequestParameter('uri');
         $testModel = $this->getServiceManager()->get(TestModelService::SERVICE_ID);
 
+        // Add support for translation and side-by-side view
+        $this->setData('translation', $this->getRequestParameter('translation') ?? "false");
+        $this->setData('originResourceUri', json_encode($this->getRequestParameter('originResourceUri')));
+
         $items = $testModel->getItems(new core_kernel_classes_Resource(tao_helpers_Uri::decode($testUri)));
         foreach ($items as $item) {
             $labels[$item->getUri()] = $item->getLabel();
@@ -91,9 +95,9 @@ public function index()
         $this->setView('creator.tpl');
     }
 
-        /**
-         * Get json's test content, the uri of the test must be provided in parameter
-         */
+    /**
+     * Get json's test content, the uri of the test must be provided in parameter
+     */
     public function getTest()
     {
         $test = $this->getCurrentTest();
@@ -104,11 +108,11 @@ public function getTest()
         $this->response = $this->getPsrResponse()->withBody(stream_for($qtiTestService->getJsonTest($test)));
     }
 
-        /**
-         * Save a test, test uri and
-         * The request must use the POST method and contains
-         * the test uri and a json string that represents the QTI Test in the model parameter.
-         */
+    /**
+     * Save a test, test uri and
+     * The request must use the POST method and contains
+     * the test uri and a json string that represents the QTI Test in the model parameter.
+     */
     public function saveTest()
     {
         $saved = false;

composer.json

@@ -64,10 +64,10 @@
     "oat-sa/oatbox-extension-installer": "~1.1||dev-master",
     "qtism/qtism": ">=0.28.3",
     "oat-sa/generis": ">=15.36.4",
-    "oat-sa/tao-core": ">=54.21.0",
-    "oat-sa/extension-tao-item" : ">=12.1.0",
-    "oat-sa/extension-tao-itemqti" : ">=30.12.0",
-    "oat-sa/extension-tao-test" : ">=16.0.0",
+    "oat-sa/tao-core": "dev-feat/HKD-6/integration as 99",
+    "oat-sa/extension-tao-item" : "dev-feat/HKD-6/integration as 99",
+    "oat-sa/extension-tao-itemqti" : "dev-feat/HKD-6/integration as 99",
+    "oat-sa/extension-tao-test" : "dev-feat/HKD-6/integration as 99",
     "oat-sa/extension-tao-delivery" : ">=15.0.0",
     "oat-sa/extension-tao-outcome" : ">=13.0.0",
     "league/flysystem": "~1.0",

manifest.php

@@ -23,21 +23,21 @@
 use oat\tao\model\user\TaoRoles;
 use oat\taoQtiTest\model\Container\TestQtiServiceProvider;
 use oat\taoQtiTest\models\classes\metadata\MetadataServiceProvider;
-// phpcs:disable Generic.Files.LineLength
+// phpcs:ignore Generic.Files.LineLength
 use oat\taoQtiTest\models\classes\render\CustomInteraction\ServiceProvider\CustomInteractionPostProcessingServiceProvider;
-// phpcs:enable Generic.Files.LineLength
 use oat\taoQtiTest\models\render\ItemsReferencesServiceProvider;
 use oat\taoQtiTest\models\TestSessionState\Container\TestSessionStateServiceProvider;
+use oat\taoQtiTest\models\Translation\ServiceProvider\TranslationServiceProvider;
+use oat\taoQtiTest\models\UniqueId\ServiceProvider\UniqueIdServiceProvider;
 use oat\taoQtiTest\models\xmlEditor\XmlEditorInterface;
-use oat\taoQtiTest\scripts\install\RegisterResultTransmissionEventHandlers;
-use oat\taoQtiTest\scripts\install\SetupProvider;
 use oat\taoQtiTest\scripts\install\CreateTestSessionFilesystem;
 use oat\taoQtiTest\scripts\install\DisableBRSinTestAuthoring;
 use oat\taoQtiTest\scripts\install\RegisterCreatorServices;
 use oat\taoQtiTest\scripts\install\RegisterFrontendPaths;
 use oat\taoQtiTest\scripts\install\RegisterQtiCategoryPresetProviders;
 use oat\taoQtiTest\scripts\install\RegisterQtiFlysystemManager;
 use oat\taoQtiTest\scripts\install\RegisterQtiPackageExporter;
+use oat\taoQtiTest\scripts\install\RegisterResultTransmissionEventHandlers;
 use oat\taoQtiTest\scripts\install\RegisterSectionPauseService;
 use oat\taoQtiTest\scripts\install\RegisterTestCategoryPresetProviderService;
 use oat\taoQtiTest\scripts\install\RegisterTestContainer;
@@ -50,6 +50,7 @@
 use oat\taoQtiTest\scripts\install\SetSynchronisationService;
 use oat\taoQtiTest\scripts\install\SetupDefaultTemplateConfiguration;
 use oat\taoQtiTest\scripts\install\SetupEventListeners;
+use oat\taoQtiTest\scripts\install\SetupProvider;
 use oat\taoQtiTest\scripts\install\SetUpQueueTasks;
 use oat\taoQtiTest\scripts\install\SetupStateOffloadQueue;
 use oat\taoQtiTest\scripts\install\SyncChannelInstaller;
@@ -185,6 +186,8 @@
         ItemsReferencesServiceProvider::class,
         TestQtiServiceProvider::class,
         TestSessionStateServiceProvider::class,
-        MetadataServiceProvider::class
+        MetadataServiceProvider::class,
+        TranslationServiceProvider::class,
+        UniqueIdServiceProvider::class,
     ],
 ];

migrations/Version202409111328132260_taoQtiTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace oat\taoQtiTest\migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use oat\oatbox\event\EventManager;
+use oat\tao\scripts\tools\migrations\AbstractMigration;
+use oat\taoQtiTest\models\UniqueId\Listener\TestCreatedEventListener;
+use oat\taoTests\models\event\TestCreatedEvent;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ *
+ * phpcs:disable Squiz.Classes.ValidClassName
+ */
+final class Version202409111328132260_taoQtiTest extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add new listener to populate translation properties';
+    }
+
+    public function up(Schema $schema): void
+    {
+        /** @var EventManager $eventManager */
+        $eventManager = $this->getServiceManager()->get(EventManager::SERVICE_ID);
+        $eventManager->attach(
+            TestCreatedEvent::class,
+            [TestCreatedEventListener::class, 'populateUniqueId']
+        );
+        $this->getServiceManager()->register(EventManager::SERVICE_ID, $eventManager);
+    }
+
+    public function down(Schema $schema): void
+    {
+        /** @var EventManager $eventManager */
+        $eventManager = $this->getServiceManager()->get(EventManager::SERVICE_ID);
+        $eventManager->detach(
+            TestCreatedEvent::class,
+            [TestCreatedEventListener::class, 'populateUniqueId']
+        );
+        $this->getServiceManager()->register(EventManager::SERVICE_ID, $eventManager);
+    }
+}

models/classes/Translation/Service/TestTranslator.php

@@ -0,0 +1,160 @@
+<?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);
+
+namespace oat\taoQtiTest\models\Translation\Service;
+
+use core_kernel_classes_Resource;
+use core_kernel_persistence_Exception;
+use oat\generis\model\data\Ontology;
+use oat\tao\model\TaoOntology;
+use oat\tao\model\Translation\Entity\ResourceTranslation;
+use oat\tao\model\Translation\Exception\ResourceTranslationException;
+use oat\tao\model\Translation\Query\ResourceTranslationQuery;
+use oat\tao\model\Translation\Repository\ResourceTranslationRepository;
+use oat\taoTests\models\TaoTestOntology;
+use taoQtiTest_models_classes_QtiTestConverterException;
+use taoQtiTest_models_classes_QtiTestService;
+use taoQtiTest_models_classes_QtiTestServiceException;
+
+class TestTranslator
+{
+    private taoQtiTest_models_classes_QtiTestService $testQtiService;
+    private Ontology $ontology;
+    private ResourceTranslationRepository $resourceTranslationRepository;
+
+    public function __construct(
+        taoQtiTest_models_classes_QtiTestService $testQtiService,
+        Ontology $ontology,
+        ResourceTranslationRepository $resourceTranslationRepository
+    ) {
+        $this->testQtiService = $testQtiService;
+        $this->ontology = $ontology;
+        $this->resourceTranslationRepository = $resourceTranslationRepository;
+    }
+
+    /**
+     * @throws taoQtiTest_models_classes_QtiTestConverterException
+     * @throws taoQtiTest_models_classes_QtiTestServiceException
+     * @throws core_kernel_persistence_Exception
+     * @throws ResourceTranslationException
+     */
+    public function translate(core_kernel_classes_Resource $translationTest): core_kernel_classes_Resource
+    {
+        $this->assertIsTest($translationTest);
+
+        $originalTestUri = $translationTest->getOnePropertyValue(
+            $this->ontology->getProperty(TaoOntology::PROPERTY_TRANSLATION_ORIGINAL_RESOURCE_URI)
+        );
+        $originalTest = $this->ontology->getResource($originalTestUri->getUri());
+
+        $jsonTest = $this->testQtiService->getJsonTest($originalTest);
+        $originalTestData = json_decode($jsonTest, true, 512, JSON_THROW_ON_ERROR);
+
+        $originalItemUris = $this->collectItemUris($originalTestData);
+        $translationUris = $this->getItemTranslationUris($translationTest, $originalItemUris);
+
+        $translatedTestData = $this->doTranslation($originalTestData, $translationUris);
+
+        $this->testQtiService->saveJsonTest($translationTest, json_encode($translatedTestData));
+        $this->updateTranslationCompletionStatus($translationTest, $originalItemUris, $translationUris);
+
+        return $translationTest;
+    }
+
+    private function assertIsTest(core_kernel_classes_Resource $resource): void
+    {
+        if (!$resource->isInstanceOf($this->ontology->getClass(TaoOntology::CLASS_URI_TEST))) {
+            throw new ResourceTranslationException('Provided resources is not a Test');
+        }
+    }
+
+    private function doTranslation(array $testData, array $translationUris): array
+    {
+        foreach ($testData['testParts'] as &$testPart) {
+            foreach ($testPart['assessmentSections'] as &$assessmentSection) {
+                foreach ($assessmentSection['sectionParts'] as &$sectionPart) {
+                    $sectionPart['href'] = $translationUris[$sectionPart['href']] ?? $sectionPart['href'];
+                }
+            }
+        }
+
+        return $testData;
+    }
+
+    private function collectItemUris(array $testData): array
+    {
+        $uris = [];
+
+        foreach ($testData['testParts'] as $testPart) {
+            foreach ($testPart['assessmentSections'] as $assessmentSection) {
+                foreach ($assessmentSection['sectionParts'] as $sectionPart) {
+                    if (in_array($sectionPart['href'], $uris, true)) {
+                        continue;
+                    }
+
+                    $uris[] = $sectionPart['href'];
+                }
+            }
+        }
+
+        return $uris;
+    }
+
+    /**
+     * @param string[] $originalItemUris
+     * @return array<string, string>
+     */
+    private function getItemTranslationUris(core_kernel_classes_Resource $test, array $originalItemUris): array
+    {
+        $language = $test->getOnePropertyValue($this->ontology->getProperty(TaoOntology::PROPERTY_LANGUAGE));
+        $translations = $this->resourceTranslationRepository->find(
+            new ResourceTranslationQuery(
+                $originalItemUris,
+                $language->getUri()
+            )
+        );
+
+        $translationUris = [];
+
+        /** @var ResourceTranslation $translation */
+        foreach ($translations->jsonSerialize()['resources'] as $translation) {
+            $translationUris[$translation->getOriginResourceUri()] = $translation->getResourceUri();
+        }
+
+        return $translationUris;
+    }
+
+    private function updateTranslationCompletionStatus(
+        core_kernel_classes_Resource $test,
+        array $uniqueIds,
+        array $translationUris
+    ): void {
+        $status = count($uniqueIds) > count($translationUris)
+            ? TaoTestOntology::PROPERTY_VALUE_TRANSLATION_COMPLETION_MISSING_TRANSLATIONS
+            : TaoTestOntology::PROPERTY_VALUE_TRANSLATION_COMPLETION_TRANSLATED;
+
+        $test->editPropertyValues(
+            $this->ontology->getProperty(TaoTestOntology::PROPERTY_TRANSLATION_COMPLETION),
+            $status
+        );
+    }
+}