feat: Delete old assets on test overwrite

models/classes/class.QtiTestService.php

@@ -15,31 +15,35 @@
  * 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-2018 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
- *
+ * Copyright (c) 2013-2023 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
  */
 
 use League\Flysystem\FileExistsException;
+use oat\oatbox\event\EventManager;
 use oat\oatbox\filesystem\Directory;
 use oat\oatbox\filesystem\File;
 use oat\oatbox\filesystem\FileSystemService;
+use oat\oatbox\service\ServiceNotFoundException;
+use oat\tao\model\metadata\exception\MetadataImportException;
 use oat\tao\model\resources\ResourceAccessDeniedException;
 use oat\tao\model\resources\SecureResourceServiceInterface;
 use oat\tao\model\TaoOntology;
-use oat\taoBackOffice\model\tree\TreeService;
 use oat\taoQtiItem\model\qti\ImportService;
 use oat\taoQtiItem\model\qti\metadata\importer\MetadataImporter;
 use oat\taoQtiItem\model\qti\metadata\MetadataGuardianResource;
 use oat\taoQtiItem\model\qti\metadata\MetadataService;
+use oat\taoQtiItem\model\qti\parser\ElementReferencesExtractor;
 use oat\taoQtiItem\model\qti\Resource;
 use oat\taoQtiItem\model\qti\Service;
 use oat\taoQtiTest\models\cat\AdaptiveSectionInjectionException;
 use oat\taoQtiTest\models\cat\CatEngineNotFoundException;
 use oat\taoQtiTest\models\cat\CatService;
+use oat\taoQtiTest\models\event\QtiTestsDeletedEvent;
 use oat\taoQtiTest\models\metadata\MetadataTestContextAware;
 use oat\taoQtiTest\models\render\QtiPackageImportPreprocessing;
 use oat\taoQtiTest\models\test\AssessmentTestXmlFactory;
 use oat\taoTests\models\event\TestUpdatedEvent;
+use Psr\Container\ContainerInterface;
 use qtism\common\utils\Format;
 use qtism\data\AssessmentItemRef;
 use qtism\data\QtiComponentCollection;
@@ -49,6 +53,7 @@
 use qtism\data\storage\xml\XmlDocument;
 use qtism\data\storage\xml\XmlStorageException;
 use taoTests_models_classes_TestsService as TestService;
+use oat\taoQtiItem\model\qti\Service as QtiItemService;
 
 /**
  * the QTI TestModel service.
@@ -57,7 +62,6 @@
  * @author Bertrand Chevrier <bertrand@taotesting.com>
  * @author Jerome Bogaerts <jerome@taotesting.com>
  * @package taoQtiTest
-
  */
 class taoQtiTest_models_classes_QtiTestService extends TestService
 {
@@ -348,7 +352,6 @@ public function importMultipleTests(
         bool $overwriteTest = false,
         ?string $itemClassUri = null
     ) {
-
         $testClass = $targetClass;
         $report = new common_report_Report(common_report_Report::TYPE_INFO);
         $validPackage = false;
@@ -866,24 +869,62 @@ protected function importTest(
         return $report;
     }
 
+    /**
+     * @throws common_Exception
+     */
     private function deleteTestsFromClassByLabel(
         string $testLabel,
         string $itemsClassLabel,
         core_kernel_classes_Resource $testClass,
         core_kernel_classes_Class $itemClass
     ): void {
-        $testService = $this->getTestService();
-        $itemTreeService = $this->getItemTreeService();
+        $itemClassesToDelete = $this->getSubclassesByLabel($itemClass, $itemsClassLabel);
+
+        /** @var string[] $refs */
+        $refs = $this->collectResourceReferences($itemClassesToDelete);
 
+        /** @var string[] $deletedTestsUris */
+        $deletedTestsUris = [];
         foreach ($testClass->getInstances() as $testInstance) {
+            /** @var core_kernel_classes_Resource $testInstance */
             if ($testInstance->getLabel() === $testLabel) {
-                $testService->deleteTest($testInstance);
+                $deletedTestsUris[] = $testInstance->getUri();
             }
         }
 
-        foreach ($itemClass->getSubClasses() as $subClass) {
-            if ($subClass->getLabel() === $itemsClassLabel) {
-                $itemTreeService->deleteClass($subClass);
+        /** @var string[] $deletedItemClassesUris */
+        $deletedItemClassesUris = [];
+        foreach ($itemClassesToDelete as $subClass) {
+            $deletedItemClassesUris[] = $subClass->getUri();
+        }
+
+        // Trigger the deletion event so extensions holding references to
+        // the deleted test or items can remove them first.
+        //
+        $this->getEventManager()->trigger(
+            new QtiTestsDeletedEvent(
+                $deletedTestsUris,
+                $deletedItemClassesUris,
+                $refs
+            )
+        );
+
+        // Actually delete the items (if this crashes the tests will
+        // hold refs to items that don't exist anymore).
+        //
+        $itemTreeService = $this->getItemTreeService();
+        foreach ($itemClassesToDelete as $subClass) {
+            $itemTreeService->deleteClass($subClass);
+        }
+
+        // Actually delete the tests, which already hold refs to
+        // non-existing items.
+        //
+        $testService = $this->getTestService();
+        foreach ($testClass->getInstances() as $testInstance) {
+            /** @var core_kernel_classes_Resource $testInstance */
+            if ($testInstance->getLabel() === $testLabel) {
+                $testService->deleteTest($testInstance);
             }
         }
     }
@@ -1447,20 +1488,62 @@ private function verifyItemPermissions(core_kernel_classes_Resource $oldTest, st
     }
 
     /**
-     * @return QtiPackageImportPreprocessing
+     * @param core_kernel_classes_Class[] $itemClasses
+     * @throws common_Exception
+     * @return string[]
      */
-    private function getQtiPackageImportPreprocessing()
+    private function collectResourceReferences(array $itemClasses): array
     {
-        return $this->getServiceLocator()->get(QtiPackageImportPreprocessing::SERVICE_ID);
+        $refs = [];
+
+        foreach ($itemClasses as $itemClass) {
+            foreach ($itemClass->getInstances(true) as $rdfItem) {
+                $qtiItem = $this->getQtiItemService()->getDataItemByRdfItem($rdfItem);
+                $itemReferences = $this->getElementReferencesExtractor()->extractAll($qtiItem);
+                $refs = array_merge($refs, $itemReferences->getAllReferences());
+            }
+        }
+
+        return $refs;
+    }
+
+    private function getSubclassesByLabel(core_kernel_classes_Class $root, string $label)
+    {
+        return array_filter(
+            $root->getSubClasses(),
+            function (core_kernel_classes_Class $subClass) use ($label) {
+                return $subClass->getLabel() === $label;
+            }
+        );
+    }
+
+    private function getQtiPackageImportPreprocessing(): QtiPackageImportPreprocessing
+    {
+        return $this->getPsrContainer()->get(QtiPackageImportPreprocessing::SERVICE_ID);
+    }
+
+    private function getQtiItemService(): QtiItemService
+    {
+        return $this->getPsrContainer()->get(QtiItemService::class);
+    }
+
+    private function getElementReferencesExtractor()
+    {
+        return $this->getPsrContainer()->get(ElementReferencesExtractor::class);
     }
 
     private function getItemTreeService(): taoItems_models_classes_ItemsService
     {
-        return taoItems_models_classes_ItemsService::singleton();
+        return $this->getPsrContainer()->get(taoItems_models_classes_ItemsService::class);
     }
 
     private function getTestService(): taoTests_models_classes_TestsService
     {
-        return taoTests_models_classes_TestsService::singleton();
+        return $this->getPsrContainer()->get(taoTests_models_classes_TestsService::class);
+    }
+
+    private function getPsrContainer(): ContainerInterface
+    {
+        return $this->getServiceLocator()->getContainer();
     }
 }

models/classes/event/QtiTestsDeletedEvent.php

@@ -0,0 +1,74 @@
+<?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) 2023 (original work) Open Assessment Technologies SA.
+ */
+
+declare(strict_types=1);
+
+namespace oat\taoQtiTest\models\event;
+
+use oat\oatbox\event\Event;
+
+class QtiTestsDeletedEvent implements Event
+{
+    /** @var string[] */
+    private array $testUris;
+
+    /** @var string[] */
+    private array $itemClassesUri;
+
+    /** @var string[] */
+    private array $referencedResources;
+
+    public function __construct(
+        array $testUris,
+        array $itemClassesUri,
+        array $referencedResources
+    ) {
+        $this->testUris = array_values(array_unique($testUris));
+        $this->itemClassesUri = array_values(array_unique($itemClassesUri));
+        $this->referencedResources = array_values(array_unique($referencedResources));
+    }
+
+    /**
+     * (non-PHPdoc)
+     * @see Event::getName
+     */
+    public function getName()
+    {
+        return self::class;
+    }
+
+    public function getTestUris(): array
+    {
+        return $this->testUris;
+    }
+
+    public function getItemClassesUri(): array
+    {
+        return $this->itemClassesUri;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getReferencedResources(): array
+    {
+        return $this->referencedResources;
+    }
+}

test/unit/models/classes/event/QtiTestsDeletedEventTest.php

@@ -0,0 +1,105 @@
+<?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) 2023 (original work) Open Assessment Technologies SA.
+ */
+
+declare(strict_types=1);
+
+namespace oat\taoQtiTest\test\unit\models\classes;
+
+use oat\taoQtiTest\models\event\QtiTestsDeletedEvent;
+use PHPUnit\Framework\TestCase;
+
+class QtiTestsDeletedEventTest extends TestCase
+{
+    /**
+     * @dataProvider removesDuplicatesDataProvider
+     */
+    public function testRemovesDuplicates(
+        array $expectedTestUris,
+        array $expectedItemClassesUris,
+        array $expectedReferencedResources,
+        array $testUris,
+        array $itemClassesUris,
+        array $referencedResources
+    ): void {
+        $event = new QtiTestsDeletedEvent(
+            $testUris,
+            $itemClassesUris,
+            $referencedResources
+        );
+
+        $this->assertEquals(QtiTestsDeletedEvent::class, $event->getName());
+        $this->assertEquals(
+            $expectedTestUris,
+            $event->getTestUris()
+        );
+        $this->assertEquals(
+            $expectedItemClassesUris,
+            $event->getItemClassesUri()
+        );
+        $this->assertEquals(
+            $expectedReferencedResources,
+            $event->getReferencedResources()
+        );
+    }
+
+    public function removesDuplicatesDataProvider(): array
+    {
+        return [
+            'Duplicated URIs on all parameters' => [
+                'expectedTestUris' => [
+                    'http://host/test1',
+                    'http://host/test2',
+                    'http://host/test3',
+                ],
+                'expectedItemClassesUris' => [
+                    'http://host/itemClass1',
+                    'http://host/itemClass2',
+                    'http://host/itemClass3',
+                ],
+                'expectedReferencedResources' => [
+                    'http://host/resource1',
+                    'http://host/resource2',
+                    'http://host/resource3',
+                ],
+                'testUris' => [
+                    'http://host/test1',
+                    'http://host/test1',
+                    'http://host/test2',
+                    'http://host/test2',
+                    'http://host/test3',
+                    'http://host/test3',
+                ],
+                'itemClassesUris' => [
+                    'http://host/itemClass1',
+                    'http://host/itemClass2',
+                    'http://host/itemClass3',
+                    'http://host/itemClass3',
+                ],
+                'referencedResources' => [
+                    'http://host/resource1',
+                    'http://host/resource1',
+                    'http://host/resource2',
+                    'http://host/resource2',
+                    'http://host/resource3',
+                ],
+            ]
+        ];
+    }
+}