Draft: T&A Export/Import Refactoring

components/ILIAS/Export/classes/ExportHandler/Info/Export/Component/Handler.php

@@ -58,7 +58,7 @@ protected function init(): void
                 throw new ilExportException('Export class file "' . $export_class_file . '" not found.');
             }
         }
-        $this->sv = $this->getMinimalComponentExporter()->determineSchemaVersion($component, $this->getTarget()->getTargetRelease());
+        $this->sv = $this->getMinimalComponentExporter()->determineSchemaVersion($this->getTarget()->getType(), $this->getTarget()->getTargetRelease());
         $this->sv["uses_dataset"] ??= false;
         $this->sv['xsd_file'] ??= '';
     }

components/ILIAS/Export/xml/SchemaValidation/ilias_md_10_0.xsd

@@ -197,7 +197,7 @@
  <xs:element name="lom">
   <xs:complexType>
    <xs:sequence>
-    <xs:element ref="general"/>
+    <xs:element ref="general" minOccurs="0" maxOccurs="1"/>
     <xs:element ref="lifeCycle" minOccurs="0" maxOccurs="1"/>
     <xs:element ref="metaMetadata" minOccurs="0" maxOccurs="1"/>
     <xs:element ref="technical" minOccurs="0" maxOccurs="1"/>

components/ILIAS/Filesystem/src/Stream/ReattachableStream.php

@@ -25,15 +25,23 @@
  */
 class ReattachableStream extends Stream
 {
-    /**
-     * Checks if the stream is attached to the wrapper.
-     * If not, the stream is reattached.
-     */
+    private ?string $reattach_uri = null;
+    private ?string $reattach_mode = null;
+
+    #[\Override]
+    public function detach()
+    {
+        $this->reattach_uri = $this->uri;
+        $this->reattach_mode = $this->_mode;
+
+        return parent::detach();
+    }
+
     #[\Override]
     protected function assertStreamAttached(): void
     {
         if ($this->stream === null) {
-            $this->stream = fopen($this->uri, $this->_mode);
+            $this->stream = fopen($this->reattach_uri, $this->reattach_mode);
         }
     }
 }

components/ILIAS/Test/classes/class.ilObjTestGUI.php

@@ -18,6 +18,7 @@
 
 declare(strict_types=1);
 
+use ILIAS\Test\ExportImport\Import\PersistStage;
 use ILIAS\Test\Logging\AdditionalInformationGenerator;
 use ILIAS\Skill\Service\SkillUsageService;
 use ILIAS\Test\Results\Data\Repository as TestResultRepository;
@@ -61,6 +62,14 @@
 use ILIAS\Test\Results\Toplist\TestTopListRepository;
 use ILIAS\Test\ExportImport\Factory as ExportImportFactory;
 use ILIAS\Test\ExportImport\DBRepository as ExportRepository;
+use ILIAS\TestQuestionPool\ExportImport\Foundation\Importing\ImportContext;
+use ILIAS\TestQuestionPool\ExportImport\Foundation\Importing\ImportSessionRepository;
+use ILIAS\TestQuestionPool\ExportImport\Foundation\Importing\ImportStageRunner;
+use ILIAS\TestQuestionPool\ExportImport\Foundation\Importing\StageResultType;
+use ILIAS\TestQuestionPool\ExportImport\Import\CleanupStage;
+use ILIAS\TestQuestionPool\ExportImport\Import\DetectLegacyImportStage;
+use ILIAS\TestQuestionPool\ExportImport\Import\QuestionSelectionStage;
+use ILIAS\TestQuestionPool\ExportImport\Import\UploadValidationStage;
 use ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository;
 use ILIAS\TestQuestionPool\RequestDataCollector as QPLRequestDataCollector;
 use ILIAS\TestQuestionPool\Import\TestQuestionsImportTrait;
@@ -81,6 +90,7 @@
 use ILIAS\Style\Content\Service as ContentStyle;
 use ILIAS\User\Profile\PublicProfileGUI;
 use ILIAS\Test\GUIFactory;
+use Psr\Log\LoggerInterface;
 
 /**
  * Class ilObjTestGUI
@@ -180,6 +190,8 @@ class ilObjTestGUI extends ilObjectGUI implements ilCtrlBaseClassInterface, ilDe
     protected TaxonomyService $taxonomy;
     protected GUIFactory $gui_factory;
     protected SkillUsageService $skill_usage_service;
+    protected ImportSessionRepository $import_session_repository;
+    protected LoggerInterface $import_logger;
 
     protected bool $create_question_mode;
 
@@ -234,6 +246,8 @@ public function __construct()
         $this->mark_schema_factory = $local_dic['marks.factory'];
         $this->additional_information_generator = $local_dic['logging.information_generator'];
         $this->personal_settings_exporter = $local_dic['settings.personal_templates.exporter'];
+        $this->import_session_repository = $local_dic['exportimport.session'];
+        $this->import_logger = $local_dic['exportimport.logging']();
 
         $ref_id = 0;
         if ($this->testrequest->hasRefId() && is_numeric($this->testrequest->getRefId())) {
@@ -1362,81 +1376,116 @@ public function runObject()
         $this->ctrl->redirectByClass([ilRepositoryGUI::class, self::class, ilInfoScreenGUI::class]);
     }
 
+
     protected function importFile(string $file_to_import, string $path_to_uploaded_file_in_temp_dir): void
     {
-        list($subdir, $importdir, $xmlfile, $qtifile) = $this->buildImportDirectoriesFromImportFile($file_to_import);
-
-        $options = (new ILIAS\Filesystem\Util\Archive\UnzipOptions())
-            ->withZipOutputPath($this->getImportTempDirectory());
+        $this->import_session_repository->clear();
 
-        $unzip = $this->archives->unzip(Streams::ofResource(fopen($file_to_import, 'r')), $options);
-        $unzip->extract();
+        $context = new ImportContext([UploadValidationStage::FILE_TO_IMPORT => $file_to_import]);
+        $this->import_session_repository->setContext($context);
+        $this->import_session_repository->setCurrentStageIndex(0);
 
-        if (!is_file($qtifile)) {
-            ilFileUtils::delDir($importdir);
-            $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
-            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('tst_import_non_ilias_zip'), true);
-        }
-        $qtiParser = new ilQTIParser($importdir, $qtifile, ilQTIParser::IL_MO_VERIFY_QTI, 0, [], [], true);
-        try {
-            $qtiParser->startParsing();
-        } catch (ilSaxParserException) {
-            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('import_file_not_valid'), true);
-            $this->ctrl->redirect($this, 'create');
-        }
-        $founditems = $qtiParser->getFoundItems();
-
-        $complete = 0;
-        $incomplete = 0;
-        foreach ($founditems as $item) {
-            if ($item["type"] !== '') {
-                $complete++;
-            } else {
-                $incomplete++;
-            }
-        }
+        $this->ctrl->redirectByClass(self::class, 'processImport');
+    }
 
-        if (count($founditems) && $complete == 0) {
-            ilFileUtils::delDir($importdir);
-            $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
-            $this->tpl->setOnScreenMessage('info', $this->lng->txt('qpl_import_non_ilias_files'));
+    public function processImportObject(): void
+    {
+        $permission = $this->creation_mode ? 'create' : 'read';
+        if (!$this->checkPermissionBool($permission, '', $this->object->getType())) {
+            $this->redirectAfterMissingWrite();
             return;
         }
 
-        ilSession::set('path_to_import_file', $file_to_import);
-        ilSession::set('path_to_uploaded_file_in_temp_dir', $path_to_uploaded_file_in_temp_dir);
+        $runner = $this->buildImportStageRunner();
+        $result = $runner->run();
 
-        if ($qtiParser->getQuestionSetType() !== ilObjTest::QUESTION_SET_TYPE_FIXED
-            || file_exists($this->buildResultsFilePath($importdir, $subdir))
-            || $founditems === []) {
-            $this->importVerifiedFileObject(true);
-            return;
+        switch ($result->type) {
+            case StageResultType::INTERACT:
+                $this->tpl->setContent(
+                    $this->ui_renderer->render($result->components)
+                );
+                break;
+
+            case StageResultType::ADVANCE:
+                $this->ctrl->redirectByClass(self::class, 'processImport');
+                break;
+
+            case StageResultType::ERROR:
+                $this->tpl->setOnScreenMessage('failure', $result->error_message, true);
+                break;
+
+            case StageResultType::COMPLETE:
+                $this->afterImportCompleted($result->context);
+                break;
         }
+    }
 
-        $form = $this->buildImportQuestionsSelectionForm(
-            'importVerifiedFile',
-            $importdir,
-            $qtifile,
-            $file_to_import,
-            $path_to_uploaded_file_in_temp_dir
-        );
+    private function afterImportCompleted(ImportContext $context): void
+    {
+        $new_obj = new ilObjTest(0, false);
+        $new_obj->setId($context->get('test_obj_id'));
+        $new_obj->setRefId($context->get('test_ref_id'));
 
-        if ($form === null) {
-            return;
+        if ($new_obj->getTestLogger()->isLoggingEnabled()) {
+            $new_obj->getTestLogger()->logTestAdministrationInteraction(
+                $new_obj->getTestLogger()->getInteractionFactory()->buildTestAdministrationInteraction(
+                    $new_obj->getRefId(),
+                    $this->user->getId(),
+                    TestAdministrationInteractionTypes::NEW_TEST_CREATED,
+                    []
+                )
+            );
         }
 
-        $panel = $this->ui_factory->panel()->standard(
-            $this->lng->txt('import_tst'),
+        $question_skill_assignments_import_fails = new ilAssQuestionSkillAssignmentImportFails($new_obj->getId());
+        if ($question_skill_assignments_import_fails->failedImportsRegistered()) {
+            $this->tpl->setOnScreenMessage(
+                'info',
+                $question_skill_assignments_import_fails->getFailedImportsMessage($this->lng),
+                true
+            );
+        }
+
+        $this->tpl->setOnScreenMessage('success', $this->lng->txt('object_imported'), true);
+        $this->ctrl->setParameterByClass(ilObjTestGUI::class, 'ref_id', $new_obj->getRefId());
+        $this->ctrl->redirectByClass(self::class, self::SHOW_QUESTIONS_CMD);
+    }
+
+    private function buildImportStageRunner(): ImportStageRunner
+    {
+        $form_action = $this->ctrl->getFormActionByClass(self::class, 'processImport');
+
+        return new ImportStageRunner(
             [
-                $this->ui_factory->legacy()->content($this->lng->txt('qpl_import_verify_found_questions')),
-                $form
-            ]
+                new UploadValidationStage(
+                    $this->archives,
+                    $this->lng,
+                    $this->import_logger,
+                    'components/ILIAS/Test'
+                ),
+                new DetectLegacyImportStage($this->import_logger),
+                new QuestionSelectionStage(
+                    $this->lng,
+                    $this->import_logger,
+                    $this->component_factory,
+                    $this->ui_factory,
+                    $this->request,
+                    $form_action,
+                    $this->lng->txt('import_tst')
+                ),
+                new PersistStage(
+                    $this->lng,
+                    $this->import_logger,
+                    $this->requested_ref_id,
+                    $this->import_session_repository
+                ),
+            ],
+            $this->import_session_repository,
+            new CleanupStage($this->import_logger)
         );
-        $this->tpl->setContent($this->ui_renderer->render($panel));
-        $this->tpl->printToStdout();
-        exit;
     }
 
+
     /**
     * save object
     * @access	public
@@ -1478,97 +1527,6 @@ public function getTestObject(): ?ilObjTest
         return $this->object;
     }
 
-    /**
-    * imports question(s) into the questionpool (after verification)
-    */
-    public function importVerifiedFileObject(
-        bool $skip_retrieve_selected_questions = false
-    ): void {
-        if (!$this->checkPermissionBool('create', '', 'tst')) {
-            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'), true);
-            $this->ctrl->returnToParent($this);
-        }
-        $file_to_import = ilSession::get('path_to_import_file');
-        $path_to_uploaded_file_in_temp_dir = ilSession::get('path_to_uploaded_file_in_temp_dir');
-        list($subdir, $importdir, $xmlfile, $qtifile) = $this->buildImportDirectoriesFromImportFile($file_to_import);
-
-        $new_obj = new ilObjTest(0, true);
-        $new_obj->setTitle('dummy');
-        $new_obj->setDescription('test import');
-        $new_obj->create(true);
-        $new_obj->createReference();
-        $new_obj->putInTree($this->testrequest->getRefId());
-        $new_obj->setPermissions($this->testrequest->getRefId());
-        $new_obj->saveToDb();
-
-        $selected_questions = [];
-        if (!$skip_retrieve_selected_questions) {
-            $selected_questions = $this->retrieveSelectedQuestionsFromImportQuestionsSelectionForm(
-                'importVerifiedFile',
-                $importdir,
-                $qtifile,
-                $this->request
-            );
-        }
-
-        ilSession::set('tst_import_selected_questions', $selected_questions);
-
-        $imp = new ilImport($this->testrequest->getRefId());
-        $map = $imp->getMapping();
-        $map->addMapping('components/ILIAS/Test', 'tst', 'new_id', (string) $new_obj->getId());
-
-        /**
-         * 2025-03-22, sk: This is now only needed for legacy exports as
-         * now also exports with results do contain a manifest.xml.
-         */
-        if (is_file($importdir . DIRECTORY_SEPARATOR . '/manifest.xml')) {
-            $imp->importObject($new_obj, $file_to_import, basename($file_to_import), 'tst', 'components/ILIAS/Test', true);
-        } else {
-            $test_importer = new ilTestImporter();
-            $test_importer->setImport($imp);
-            $test_importer->setInstallId(IL_INST_ID);
-            $test_importer->setImportDirectory($importdir . '/' . $subdir);
-            $test_importer->init();
-
-            $test_importer->importXmlRepresentation(
-                '',
-                '',
-                '',
-                $map,
-            );
-        }
-
-        if ($new_obj->getTestLogger()->isLoggingEnabled()) {
-            $new_obj->getTestLogger()->logTestAdministrationInteraction(
-                $new_obj->getTestLogger()->getInteractionFactory()->buildTestAdministrationInteraction(
-                    $new_obj->getRefId(),
-                    $this->user->getId(),
-                    TestAdministrationInteractionTypes::NEW_TEST_CREATED,
-                    []
-                )
-            );
-        }
-
-        ilFileUtils::delDir($importdir);
-        $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
-        ilSession::clear('path_to_import_file');
-        ilSession::clear('path_to_uploaded_file_in_temp_dir');
-
-        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_imported"), true);
-
-        $question_skill_assignments_import_fails = new ilAssQuestionSkillAssignmentImportFails($new_obj->getId());
-        if ($question_skill_assignments_import_fails->failedImportsRegistered()) {
-            $this->tpl->setOnScreenMessage(
-                'info',
-                $question_skill_assignments_import_fails->getFailedImportsMessage($this->lng),
-                true
-            );
-        }
-
-        $this->ctrl->setParameterByClass(ilObjTestGUI::class, 'ref_id', $new_obj->getRefId());
-        $this->ctrl->redirectByClass(ilObjTestGUI::class);
-    }
-
     /**
     * download file
     */
@@ -2362,6 +2320,7 @@ public function addLocatorItems(): void
                 );
                 break;
             case "importFile":
+            case "processImport":
             case "cloneAll":
             case "importVerifiedFile":
             case "cancelImport":