Feat/aut 3590/add metadata check on import

composer.json

@@ -66,7 +66,7 @@
     "oat-sa/generis" : ">=15.22",
     "oat-sa/tao-core": ">=54.0.0",
     "oat-sa/extension-tao-item" : ">=12.1.0",
-    "oat-sa/extension-tao-itemqti" : ">=30.0.0",
+    "oat-sa/extension-tao-itemqti" : "dev-feat/aut-3590-add-metadata-check-on-import",
     "oat-sa/extension-tao-test" : ">=16.0.0",
     "oat-sa/extension-tao-delivery" : ">=15.0.0",
     "oat-sa/extension-tao-outcome" : ">=13.0.0",

manifest.php

@@ -21,6 +21,7 @@
 
 use oat\tao\model\user\TaoRoles;
 use oat\taoQtiTest\model\Container\TestQtiServiceProvider;
+use oat\taoQtiTest\models\classes\metadata\MetadataServiceProvider;
 // phpcs:disable Generic.Files.LineLength
 use oat\taoQtiTest\models\classes\render\CustomInteraction\ServiceProvider\CustomInteractionPostProcessingServiceProvider;
 // phpcs:enable Generic.Files.LineLength
@@ -182,6 +183,7 @@
         CustomInteractionPostProcessingServiceProvider::class,
         ItemsReferencesServiceProvider::class,
         TestQtiServiceProvider::class,
-        TestSessionStateServiceProvider::class
+        TestSessionStateServiceProvider::class,
+        MetadataServiceProvider::class
     ],
 ];

models/classes/class.QtiTestService.php

@@ -29,8 +29,12 @@
 use oat\taoItems\model\Command\DeleteItemCommand;
 use oat\taoQtiItem\model\qti\ImportService;
 use oat\taoQtiItem\model\qti\metadata\importer\MetadataImporter;
+use oat\taoQtiItem\model\qti\metadata\imsManifest\MetaMetadataExtractor;
+use oat\taoQtiItem\model\qti\metadata\importer\MetaMetadataImportMapper;
+use oat\taoQtiItem\model\qti\metadata\importer\PropertyDoesNotExistException;
 use oat\taoQtiItem\model\qti\metadata\MetadataGuardianResource;
 use oat\taoQtiItem\model\qti\metadata\MetadataService;
+use oat\taoQtiItem\model\qti\metadata\ontology\MappedMetadataInjector;
 use oat\taoQtiItem\model\qti\Resource;
 use oat\taoQtiItem\model\qti\Service;
 use oat\taoQtiTest\models\cat\AdaptiveSectionInjectionException;
@@ -50,6 +54,7 @@
 use qtism\data\storage\xml\XmlDocument;
 use qtism\data\storage\xml\XmlStorageException;
 use taoTests_models_classes_TestsService as TestService;
+use oat\oatbox\reporting\Report;
 
 /**
  * the QTI TestModel service.
@@ -570,6 +575,7 @@ protected function importTest(
         $domManifest->load($folder . 'imsmanifest.xml');
 
         $metadataValues = $this->getMetadataImporter()->extract($domManifest);
+        $metaMetadataValues = $this->getMetaMetadataExtractor()->extract($domManifest);
 
         // Note: without this fix, metadata guardians do not work.
         $this->getMetadataImporter()->setMetadataValues($metadataValues);
@@ -583,6 +589,7 @@ protected function importTest(
         $reportCtx->overwrittenItems = [];
         $reportCtx->itemQtiResources = [];
         $reportCtx->testMetadata = $metadataValues[$qtiTestResourceIdentifier] ?? [];
+        $reportCtx->metaMetadata = $metaMetadataValues;
         $reportCtx->createdClasses = [];
 
         // 'uriResource' key is needed by javascript in tao/views/templates/form/import.tpl
@@ -625,6 +632,8 @@ protected function importTest(
                 }
 
                 $targetItemClass = $itemParentClass->createSubClass(self::IN_PROGRESS_LABEL);
+                $mappedProperties = $this->getMetaMetadataImporter()
+                    ->mapMetaMetadataToProperties($metaMetadataValues, $targetItemClass, $testClass);
 
                 // add real label without saving (to not pass it separately to item importer)
                 $targetItemClass->label = $testLabel;
@@ -679,7 +688,6 @@ protected function importTest(
                                             );
                                         }
                                     }
-
                                     // Skip if $qtiFile already imported (multiple assessmentItemRef "hrefing" the same
                                     // file).
                                     if (array_key_exists($qtiFile, $alreadyImportedTestItemFiles) === false) {
@@ -697,7 +705,8 @@ protected function importTest(
                                             $this->useMetadataValidators,
                                             $this->itemMustExist,
                                             $this->itemMustBeOverwritten,
-                                            $reportCtx->overwrittenItems
+                                            $reportCtx->overwrittenItems,
+                                            $mappedProperties['itemProperties']
                                         );
 
                                         $reportCtx->createdClasses = array_merge(
@@ -780,6 +789,11 @@ protected function importTest(
                             // 4. Import metadata for the resource (use same mechanics as item resources).
                             // Metadata will be set as property values.
                             $this->getMetadataImporter()->inject($qtiTestResource->getIdentifier(), $testResource);
+                            $this->getServiceManager()->getContainer()->get(MappedMetadataInjector::class)->inject(
+                                $mappedProperties['testProperties'],
+                                $metadataValues[$qtiTestResourceIdentifier],
+                                $testResource
+                            );
 
                             // 5. if $targetClass does not contain any instances
                             // (because everything resolved by class lookups),
@@ -833,6 +847,9 @@ protected function importTest(
 
                 $msg = __("Error found in the IMS QTI Test:\n%s", $finalErrorString);
                 $report->add(common_report_Report::createFailure($msg));
+            } catch (PropertyDoesNotExistException $e) {
+                $reportCtx->itemClass = $targetItemClass;
+                $report->add(Report::createError($e->getMessage()));
             } catch (CatEngineNotFoundException $e) {
                 $report->add(
                     new common_report_Report(
@@ -1411,6 +1428,12 @@ protected function getMetadataImporter()
         return $this->metadataImporter;
     }
 
+    private function getMetaMetadataExtractor(): MetaMetadataExtractor
+    {
+        return $this->getPsrContainer()->get(MetaMetadataExtractor::class);
+        return $this->getServiceManager()->getContainer()->get(MetaMetadataExtractor::class);
+    }
+
     private function getSecureResourceService(): SecureResourceServiceInterface
     {
         return $this->getServiceLocator()->get(SecureResourceServiceInterface::SERVICE_ID);
@@ -1488,4 +1511,9 @@ private function getPsrContainer(): ContainerInterface
     {
         return $this->getServiceLocator()->getContainer();
     }
+
+    private function getMetaMetadataImporter(): MetaMetadataImportMapper
+    {
+        return $this->getServiceManager()->getContainer()->get(MetaMetadataImportMapper::class);
+    }
 }

models/classes/export/AbstractQtiTestExporter.php

@@ -32,6 +32,8 @@
 use DOMXPath;
 use oat\oatbox\reporting\Report;
 use oat\oatbox\reporting\ReportInterface;
+use oat\tao\model\featureFlag\FeatureFlagChecker;
+use oat\taoQtiTest\models\classes\metadata\GenericLomOntologyExtractor;
 use qtism\data\storage\xml\marshalling\MarshallingException;
 use qtism\data\storage\xml\XmlDocument;
 use oat\oatbox\filesystem\Directory;
@@ -48,6 +50,8 @@
 
 abstract class AbstractQtiTestExporter extends ItemExporter implements QtiTestExporterInterface
 {
+    public const FEATURE_FLAG_LOM_ONTOLOGY_EXTRACTION = 'FEATURE_FLAG_LOM_ONTOLOGY_EXTRACTION';
+
     /** The QTISM XmlDocument representing the Test to be exported. */
     private XmlDocument $testDocument;
 
@@ -174,6 +178,13 @@ public function export(array $options = []): Report
         // 3. Export test metadata to manifest
         $this->getMetadataExporter()->export($this->getItem(), $this->getManifest());
 
+        if ($this->getFeatureFlagChecker()->isEnabled(self::FEATURE_FLAG_LOM_ONTOLOGY_EXTRACTION)) {
+            $this->genericLomOntologyExtractor()->extract(
+                array_merge([$this->getItem()], $this->getItems()),
+                $this->getManifest()
+            );
+        }
+
         // 4. Persist manifest in archive.
         $this->getZip()->addFromString('imsmanifest.xml', $this->getManifest()->saveXML());
 
@@ -350,4 +361,14 @@ protected function getServiceManager(): ServiceManager
     {
         return ServiceManager::getServiceManager();
     }
+
+    private function genericLomOntologyExtractor(): GenericLomOntologyExtractor
+    {
+        return $this->getServiceManager()->getContainer()->get(GenericLomOntologyExtractor::class);
+    }
+
+    private function getFeatureFlagChecker(): FeatureFlagChecker
+    {
+        return $this->getServiceManager()->getContainer()->get(FeatureFlagChecker::class);
+    }
 }

models/classes/metadata/GenericLomOntologyExtractor.php

@@ -0,0 +1,86 @@
+<?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\classes\metadata;
+
+use core_kernel_classes_Resource as Resource;
+use core_kernel_classes_Triple as Triple;
+use DOMDocument;
+use oat\generis\model\data\Ontology;
+use oat\taoQtiItem\model\qti\metadata\MetadataExtractionException;
+use oat\taoQtiTest\models\classes\metadata\metaMetadata\PropertyMapper;
+
+class GenericLomOntologyExtractor
+{
+    private Ontology $ontology;
+    private PropertyMapper $propertyMapper;
+    private MetadataLomService $metadataLomService;
+
+    public function __construct(
+        Ontology $ontology,
+        PropertyMapper $propertyMapper,
+        MetadataLomService $metadataLomService
+    ) {
+        $this->ontology = $ontology;
+        $this->propertyMapper = $propertyMapper;
+        $this->metadataLomService = $metadataLomService;
+    }
+
+    /**
+     * @param Resource[] $resourceCollection
+     * @throws MetadataExtractionException
+     */
+    public function extract(array $resourceCollection, DOMDocument $manifest): void
+    {
+        $properties = [];
+
+        foreach ($resourceCollection as $resource) {
+            if (!$resource instanceof Resource) {
+                throw new MetadataExtractionException(
+                    __('The given target is not an instance of core_kernel_classes_Resource')
+                );
+            }
+
+            foreach ($resource->getRdfTriples() as $triple) {
+                if ($this->mappingRequired($properties, $triple)) {
+                    $properties[] = $this->propertyMapper
+                        ->getMetadataProperties(
+                            $this->ontology->getProperty($triple->predicate)
+                        );
+                }
+            }
+        }
+
+        $this->metadataLomService->addPropertiesToMetadataBlock($properties, $manifest);
+    }
+
+    /**
+     * Mapping action only applies for confirmed properties that are not already mapped
+     */
+    private function mappingRequired(array $properties, Triple $triple): bool
+    {
+        return $this->ontology->getProperty($triple->predicate)->isProperty() &&
+            array_filter($properties, function ($property) use ($triple) {
+                return $property['uri'] === $triple->predicate;
+            }) === [];
+    }
+}

models/classes/metadata/MetadataLomService.php

@@ -0,0 +1,57 @@
+<?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\classes\metadata;
+
+use DOMDocument;
+use DOMNodeList;
+
+class MetadataLomService
+{
+    public function addPropertiesToMetadataBlock(array $properties, DOMDocument $manifest): void
+    {
+        /** @var DOMNodeList $metadataBlock */
+        $metadataBlock = $manifest->getElementsByTagName('metadata');
+
+        if ($metadataBlock === null) {
+            $metadataBlock = $manifest->createElement('metadata');
+            $manifest->documentElement->appendChild($metadataBlock);
+        }
+
+        $metadataBlock->item(0)
+            ->appendChild($manifest->createElement('imsmd:lom'))
+            ->appendChild($manifest->createElement('imsmd:metaMetadata'))
+            ->appendChild($manifest->createElement('extension'))
+            ->appendChild($manifest->createElement('customProperties'));
+
+        foreach ($properties as $property) {
+            $propertyNode = $manifest->createElement('property');
+            foreach ($property as $key => $value) {
+                $propertyNode->appendChild($manifest->createElement($key, $value));
+            }
+            $metadataBlock->item(0)
+                ->getElementsByTagName('customProperties')
+                ->item(0)
+                ->appendChild($propertyNode);
+        }
+    }
+}

models/classes/metadata/MetadataServiceProvider.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);
+
+namespace oat\taoQtiTest\models\classes\metadata;
+
+use oat\generis\model\data\Ontology;
+use oat\generis\model\DependencyInjection\ContainerServiceProviderInterface;
+use oat\generis\model\GenerisRdf;
+use oat\taoQtiItem\model\import\ChecksumGenerator;
+use oat\taoQtiTest\models\classes\metadata\metaMetadata\PropertyMapper;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
+
+class MetadataServiceProvider implements ContainerServiceProviderInterface
+{
+    public function __invoke(ContainerConfigurator $configurator): void
+    {
+        $services = $configurator->services();
+
+        $services->set(MetadataLomService::class, MetadataLomService::class);
+
+        $services->set(PropertyMapper::class, PropertyMapper::class)
+            ->args([
+                service(ChecksumGenerator::class),
+                [
+                    'label' => RDFS_LABEL,
+                    'domain' => RDFS_DOMAIN,
+                    'alias' => GenerisRdf::PROPERTY_ALIAS,
+                    'multiple' => GenerisRdf::PROPERTY_MULTIPLE
+                ]
+            ]);
+
+        $services
+            ->set(GenericLomOntologyExtractor::class, GenericLomOntologyExtractor::class)
+            ->public()
+            ->args([
+                service(Ontology::SERVICE_ID),
+                service(PropertyMapper::class),
+                service(MetadataLomService::class)
+            ]);
+    }
+}