class.ilTestRandomQuestionSetConfigGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data\Factory as DataFactory;
use ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable;
use ILIAS\Test\Questions\RandomQuestionSetSourcePoolDefinitionListTable;
use ILIAS\Test\RequestDataCollector;
use ILIAS\Test\Utilities\TitleColumnsBuilder;
use ILIAS\Test\Presentation\TabsManager;
use ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository;
use ILIAS\Test\Logging\TestLogger;
use ILIAS\Test\Logging\TestAdministrationInteractionTypes;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;

class ilTestRandomQuestionSetConfigGUI
{
    public const CMD_SHOW_GENERAL_CONFIG_FORM = 'showGeneralConfigForm';
    public const CMD_SAVE_GENERAL_CONFIG_FORM = 'saveGeneralConfigForm';
    public const CMD_SHOW_SRC_POOL_DEF_LIST = 'showSourcePoolDefinitionList';
    public const CMD_SAVE_SRC_POOL_DEF_LIST = 'saveSourcePoolDefinitionList';
    public const CMD_DELETE_SRC_POOL_DEF = 'deleteSourcePoolDefinition';
    public const CMD_SHOW_POOL_SELECTOR_EXPLORER = 'showPoolSelectorExplorer';
    public const CMD_SHOW_CREATE_SRC_POOL_DEF_FORM = 'showCreateSourcePoolDefinitionForm';
    public const CMD_SAVE_CREATE_SRC_POOL_DEF_FORM = 'saveCreateSourcePoolDefinitionForm';
    public const CMD_SAVE_AND_NEW_CREATE_SRC_POOL_DEF_FORM = 'saveCreateAndNewSourcePoolDefinitionForm';
    public const CMD_SHOW_EDIT_SRC_POOL_DEF_FORM = 'showEditSourcePoolDefinitionForm';
    public const CMD_SAVE_EDIT_SRC_POOL_DEF_FORM = 'saveEditSourcePoolDefinitionForm';
    public const CMD_BUILD_QUESTION_STAGE = 'buildQuestionStage';
    public const CMD_SELECT_DERIVATION_TARGET = 'selectPoolDerivationTarget';
    public const CMD_DERIVE_NEW_POOLS = 'deriveNewPools';
    public const CMD_RESET_POOLSYNC = 'resetPoolSync';

    public const HTTP_PARAM_AFTER_REBUILD_QUESTION_STAGE_CMD = 'afterRebuildQuestionStageCmd';

    protected ilTestRandomQuestionSetConfig $question_set_config;
    protected ilTestRandomQuestionSetSourcePoolDefinitionFactory $source_pool_definition_factory;
    protected ilTestRandomQuestionSetSourcePoolDefinitionList $source_pool_definition_list;
    protected ilTestRandomQuestionSetStagingPoolBuilder $stagingPool;
    protected ilTestRandomQuestionSetConfigStateMessageHandler $configStateMessageHandler;

    public function __construct(
        private readonly ilObjTest $test_obj,
        private readonly ilCtrl $ctrl,
        private readonly ilObjUser $user,
        private readonly ilAccessHandler $access,
        private readonly UIFactory $ui_factory,
        private readonly UIRenderer $ui_renderer,
        private readonly DataFactory $data_factory,
        private readonly TabsManager $tabs_manager,
        private readonly ilLanguage $lng,
        private readonly TestLogger $logger,
        private readonly ilGlobalTemplateInterface $tpl,
        private readonly ilDBInterface $db,
        private readonly ilTree $tree,
        private readonly ilComponentRepository $component_repository,
        private readonly ilObjectDefinition $obj_definition,
        private readonly ilObjectDataCache $obj_cache,
        private ilTestProcessLockerFactory $processLockerFactory,
        private readonly RequestDataCollector $testrequest,
        private readonly TitleColumnsBuilder $title_builder,
        private readonly GeneralQuestionPropertiesRepository $questionrepository
    ) {
        $this->question_set_config = new ilTestRandomQuestionSetConfig(
            $this->tree,
            $this->db,
            $this->lng,
            $this->logger,
            $this->component_repository,
            $this->test_obj,
            $this->questionrepository
        );
        $this->question_set_config->loadFromDb();

        $this->source_pool_definition_factory = new ilTestRandomQuestionSetSourcePoolDefinitionFactory(
            $this->db,
            $this->test_obj
        );

        $this->source_pool_definition_list = new ilTestRandomQuestionSetSourcePoolDefinitionList(
            $this->db,
            $this->test_obj,
            $this->source_pool_definition_factory
        );

        $this->source_pool_definition_list->loadDefinitions();

        $this->stagingPool = new ilTestRandomQuestionSetStagingPoolBuilder(
            $this->db,
            $this->logger,
            $this->test_obj
        );

        $this->configStateMessageHandler = new ilTestRandomQuestionSetConfigStateMessageHandler(
            $this->lng,
            $this->ui_factory,
            $this->ui_renderer,
            $this->ctrl
        );

        $this->configStateMessageHandler->setTargetGUI($this);
        $this->configStateMessageHandler->setQuestionSetConfig($this->question_set_config);
        $this->configStateMessageHandler->setParticipantDataExists($this->test_obj->participantDataExist());
        $this->configStateMessageHandler->setLostPools($this->source_pool_definition_list->getLostPools());
        $this->processLockerFactory = $processLockerFactory;
    }

    public function executeCommand(): void
    {
        if (!$this->access->checkAccess("write", "", $this->test_obj->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("cannot_edit_test"), true);
            $this->ctrl->redirectByClass([ilRepositoryGUI::class, ilObjTestGUI::class, ilInfoScreenGUI::class]);
        }

        if ($this->isAvoidManipulationRedirectRequired()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("tst_msg_cannot_modify_random_question_set_conf_due_to_part"), true);
            $this->ctrl->redirect($this);
        }

        $this->tabs_manager->getQuestionsSubTabs();
        $this->activateTabs();
        $next_class = $this->ctrl->getNextClass();

        switch ($next_class) {
            case 'iltestrandomquestionsetpooldefinitionformgui':
                $this->question_set_config->loadFromDb();
                $pool_id = $this->fetchQuestionPoolIdParameter();
                $source_pool_definition = $this->getSourcePoolDefinitionByAvailableQuestionPoolId($pool_id);
                $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($source_pool_definition->getPoolId());
                $form = $this->buildCreateSourcePoolDefinitionFormGUI();
                $form->build($source_pool_definition, $available_taxonomy_ids);

                $this->ctrl->forwardCommand($form);
                break;

            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW_GENERAL_CONFIG_FORM) . 'Cmd';
                $this->$cmd();
        }
    }

    private function isAvoidManipulationRedirectRequired(): bool
    {
        if (!$this->isFrozenConfigRequired()) {
            return false;
        }

        if (!$this->isManipulationCommand()) {
            return false;
        }

        return true;
    }

    private function isFrozenConfigRequired(): bool
    {
        if ($this->test_obj->participantDataExist()) {
            return true;
        }

        if ($this->source_pool_definition_list->hasLostPool()) {
            return true;
        }

        return false;
    }

    private function isManipulationCommand(): bool
    {
        if (in_array(
            $this->ctrl->getCmd(self::CMD_SHOW_GENERAL_CONFIG_FORM),
            [
                self::CMD_SAVE_GENERAL_CONFIG_FORM,
                self::CMD_SAVE_SRC_POOL_DEF_LIST,
                self::CMD_DELETE_SRC_POOL_DEF,
                self::CMD_SAVE_CREATE_SRC_POOL_DEF_FORM,
                self::CMD_SAVE_EDIT_SRC_POOL_DEF_FORM,
                self::CMD_SAVE_AND_NEW_CREATE_SRC_POOL_DEF_FORM,
                self::CMD_BUILD_QUESTION_STAGE
            ]
        )) {
            return true;
        }

        return false;
    }

    private function activateTabs(): void
    {
        $this->tabs_manager->activateTab('assQuestions');

        switch ($this->ctrl->getCmd(self::CMD_SHOW_GENERAL_CONFIG_FORM)) {
            case self::CMD_SHOW_GENERAL_CONFIG_FORM:
            case self::CMD_SAVE_GENERAL_CONFIG_FORM:
                $this->tabs_manager->activateSubTab('tstRandQuestSetGeneralConfig');
                break;

            case self::CMD_SHOW_SRC_POOL_DEF_LIST:
            case self::CMD_SAVE_SRC_POOL_DEF_LIST:
            case self::CMD_DELETE_SRC_POOL_DEF:
            case self::CMD_SHOW_CREATE_SRC_POOL_DEF_FORM:
            case self::CMD_SAVE_CREATE_SRC_POOL_DEF_FORM:
            case self::CMD_SHOW_EDIT_SRC_POOL_DEF_FORM:
            case self::CMD_SAVE_EDIT_SRC_POOL_DEF_FORM:
                $this->tabs_manager->activateSubTab('tstRandQuestSetPoolConfig');
                break;
        }
    }

    private function buildQuestionStageCmd(): void
    {
        if ($this->source_pool_definition_list->areAllUsedPoolsAvailable()) {
            $locker = $this->processLockerFactory->retrieveLockerForNamedOperation();
            $locker->executeNamedOperation(__FUNCTION__, function (): void {
                $this->stagingPool->rebuild($this->source_pool_definition_list);
                $this->source_pool_definition_list->saveDefinitions();

                $this->question_set_config->loadFromDb();
                $this->question_set_config->setLastQuestionSyncTimestamp(time());
                $this->question_set_config->saveToDb();

                $this->test_obj->saveCompleteStatus($this->question_set_config);

                $this->ctrl->setParameterByClass(self::class, 'modified', 'sync');
            });
            if ($this->logger->isLoggingEnabled()) {
                $this->logger->logTestAdministrationInteraction(
                    $this->logger->getInteractionFactory()->buildTestAdministrationInteraction(
                        $this->test_obj->getRefId(),
                        $this->user->getId(),
                        TestAdministrationInteractionTypes::QUESTIONS_SYNCHRONISED,
                        []
                    )
                );
            }
        }

        $this->ctrl->redirect($this, $this->fetchAfterRebuildQuestionStageCmdParameter());
    }

    private function fetchAfterRebuildQuestionStageCmdParameter()
    {
        if (!$this->testrequest->isset(self::HTTP_PARAM_AFTER_REBUILD_QUESTION_STAGE_CMD)) {
            return self::CMD_SHOW_GENERAL_CONFIG_FORM;
        }

        if (!strlen($this->testrequest->raw(self::HTTP_PARAM_AFTER_REBUILD_QUESTION_STAGE_CMD))) {
            return self::CMD_SHOW_GENERAL_CONFIG_FORM;
        }

        return $this->testrequest->raw(self::HTTP_PARAM_AFTER_REBUILD_QUESTION_STAGE_CMD);
    }

    private function showGeneralConfigFormCmd(?ilTestRandomQuestionSetGeneralConfigFormGUI $form = null): void
    {
        $disabled_form = $this->preventFormBecauseOfSync();

        if ($form === null) {
            $this->question_set_config->loadFromDb();
            $form = $this->buildGeneralConfigFormGUI($disabled_form);
        }

        $this->tpl->setContent($this->ctrl->getHTML($form));

        $this->configStateMessageHandler->setContext(
            ilTestRandomQuestionSetConfigStateMessageHandler::CONTEXT_GENERAL_CONFIG
        );

        $this->configStateMessageHandler->handle();

        $message = $this->buildOnScreenMessage();
        if ($message !== '') {
            $this->populateOnScreenMessage($message);
        }
    }

    private function saveGeneralConfigFormCmd(): void
    {
        $form = $this->buildGeneralConfigFormGUI();

        $errors = !$form->checkInput(); // ALWAYS CALL BEFORE setValuesByPost()
        $form->setValuesByPost(); // NEVER CALL THIS BEFORE checkInput()

        if ($errors) {
            $this->showGeneralConfigFormCmd($form);
            return;
        }

        $log_array = $form->save($this->logger->getAdditionalInformationGenerator());

        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();

        if ($this->logger->isLoggingEnabled()) {
            $this->logger->logTestAdministrationInteraction(
                $this->logger->getInteractionFactory()->buildTestAdministrationInteraction(
                    $this->test_obj->getRefId(),
                    $this->user->getId(),
                    TestAdministrationInteractionTypes::QUESTION_SELECTION_CRITERIA_MODIFIED,
                    $log_array
                )
            );
        }

        $this->test_obj->saveCompleteStatus($this->question_set_config);

        $this->ctrl->setParameter($this, 'modified', 'save');
        $this->ctrl->redirect($this, self::CMD_SHOW_GENERAL_CONFIG_FORM);
    }


    private function buildGeneralConfigFormGUI(bool $disabled = false): ilTestRandomQuestionSetGeneralConfigFormGUI
    {
        $form = new ilTestRandomQuestionSetGeneralConfigFormGUI(
            $this,
            $this->question_set_config
        );

        //TODO: should frozen config not lead to 'completely disabled' as well?!
        $form->setEditModeEnabled(!$this->isFrozenConfigRequired());

        if ($disabled) {
            $form->setEditModeEnabled(false);
        }

        $form->build();

        if ($disabled) {
            $form->clearCommandButtons();
        }

        return $form;
    }

    private function showSourcePoolDefinitionListCmd(): void
    {
        $disabled_form = $this->preventFormBecauseOfSync();

        $this->question_set_config->loadFromDb();

        $content = '';

        if (!$this->isFrozenConfigRequired() && !$disabled_form) {
            $toolbar = $this->buildSourcePoolDefinitionListToolbarGUI();
            $content .= $this->ctrl->getHTML($toolbar);
        }

        $table = $this->buildSourcePoolDefinitionListTableGUI($disabled_form);
        $content .= $this->ui_renderer->render($table->getComponent());

        if (!$this->source_pool_definition_list->areAllUsedPoolsAvailable()) {
            $table = new RandomQuestionSetNonAvailablePoolsTable(
                $this->ctrl,
                $this->lng,
                $this->ui_factory,
                $this->data_factory,
                $this->testrequest->getRequest(),
                $this->source_pool_definition_list
            );
            $content .= $this->ui_renderer->render($table->getComponent());
        }

        $this->tpl->setContent($content);

        $this->configStateMessageHandler->setContext(
            ilTestRandomQuestionSetConfigStateMessageHandler::CONTEXT_POOL_SELECTION
        );

        $this->configStateMessageHandler->handle();

        $message = $this->buildOnScreenMessage();
        if ($message) {
            $this->populateOnScreenMessage($message);
        }
    }

    private function saveSourcePoolDefinitionListCmd(): void
    {
        $this->question_set_config->loadFromDb();

        $table = $this->buildSourcePoolDefinitionListTableGUI();
        $table->applySubmit($this->testrequest);

        $this->source_pool_definition_list->reindexPositions();
        $this->source_pool_definition_list->saveDefinitions();

        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();

        $this->test_obj->saveCompleteStatus($this->question_set_config);

        $this->ctrl->setParameter($this, 'modified', 'save');
        $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
    }

    private function buildSourcePoolDefinitionListToolbarGUI(): ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI
    {
        $toolbar = new ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI(
            $this->ctrl,
            $this->lng,
            $this,
            $this->question_set_config
        );

        $toolbar->build();

        return $toolbar;
    }

    private function buildSourcePoolDefinitionListTableGUI(bool $disabled = false): RandomQuestionSetSourcePoolDefinitionListTable
    {
        $translator = new ilTestQuestionFilterLabelTranslator($this->db, $this->lng);
        $translator->loadLabels($this->source_pool_definition_list);

        return new RandomQuestionSetSourcePoolDefinitionListTable(
            $this->ctrl,
            $this->lng,
            $this->ui_factory,
            $this->data_factory,
            $this->testrequest->getRequest(),
            $this->title_builder,
            $translator,
            $this->source_pool_definition_list,
            !$this->isFrozenConfigRequired() && !$disabled,
            $this->question_set_config->isQuestionAmountConfigurationModePerPool()
        );
    }

    private function deleteSourcePoolDefinitionCmd(): void
    {
        $definition_ids = $this->fetchMultiSourcePoolDefinitionIdsParameter();
        foreach ($definition_ids as $definition_id) {
            $definition = $this->source_pool_definition_factory->getSourcePoolDefinitionByDefinitionId($definition_id);
            $definition->deleteFromDb();
        }

        $this->source_pool_definition_list->reindexPositions();
        $this->source_pool_definition_list->saveDefinitions();

        $this->question_set_config->loadFromDb();
        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();

        $this->test_obj->saveCompleteStatus($this->question_set_config);

        $this->ctrl->setParameterByClass(self::class, 'modified', 'remove');
        $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
    }

    protected function showPoolSelectorExplorerCmd(): void
    {
        $this->question_set_config->loadFromDb();

        $selector = new ilTestQuestionPoolSelectorExplorer(
            $this,
            self::CMD_SHOW_POOL_SELECTOR_EXPLORER,
            self::CMD_SHOW_CREATE_SRC_POOL_DEF_FORM,
            $this->obj_cache
        );

        $selector->setAvailableQuestionPools(
            array_keys($this->question_set_config->getSelectableQuestionPools())
        );

        if ($selector->handleCommand()) {
            return;
        }

        $this->tpl->setContent($selector->getHTML(true));
    }

    private function showCreateSourcePoolDefinitionFormCmd(?ilTestRandomQuestionSetPoolDefinitionFormGUI $form = null): void
    {
        $this->question_set_config->loadFromDb();

        $pool_id = $this->fetchQuestionPoolIdParameter();

        $source_pool_definition = $this->getSourcePoolDefinitionByAvailableQuestionPoolId($pool_id);
        $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($source_pool_definition->getPoolId());

        if ($form === null) {
            $form = $this->buildCreateSourcePoolDefinitionFormGUI();
            $form->build($source_pool_definition, $available_taxonomy_ids);
        }

        $this->tpl->setContent($this->ctrl->getHTML($form));
    }

    private function saveCreateAndNewSourcePoolDefinitionFormCmd(): void
    {
        $this->saveCreateSourcePoolDefinitionFormCmd(true);
    }

    private function saveCreateSourcePoolDefinitionFormCmd($redirect_back_to_form = false): void
    {
        $this->question_set_config->loadFromDb();

        $pool_id = $this->fetchQuestionPoolIdParameter();
        $source_pool_definition = $this->getSourcePoolDefinitionByAvailableQuestionPoolId($pool_id);
        $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($source_pool_definition->getPoolId());

        $form = $this->buildCreateSourcePoolDefinitionFormGUI();
        $form->build($source_pool_definition, $available_taxonomy_ids);

        $errors = !$form->checkInput(); // ALWAYS CALL BEFORE setValuesByPost()
        $form->setValuesByPost(); // NEVER CALL THIS BEFORE checkInput()

        if ($errors) {
            $this->showCreateSourcePoolDefinitionFormCmd($form);
            return;
        }

        $log_array = $form->applySubmit($source_pool_definition, $available_taxonomy_ids);

        $source_pool_definition->setSequencePosition($this->source_pool_definition_list->getNextPosition());
        $source_pool_definition->saveToDb();
        $this->source_pool_definition_list->addDefinition($source_pool_definition);

        $this->source_pool_definition_list->saveDefinitions();

        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();

        $this->test_obj->saveCompleteStatus($this->question_set_config);

        if ($this->logger->isLoggingEnabled()) {
            $this->logger->logTestAdministrationInteraction(
                $this->logger->getInteractionFactory()->buildTestAdministrationInteraction(
                    $this->test_obj->getRefId(),
                    $this->user->getId(),
                    TestAdministrationInteractionTypes::QUESTION_SELECTION_CRITERIA_MODIFIED,
                    $log_array
                )
            );
        }

        if ($redirect_back_to_form) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("tst_msg_random_qsc_modified_add_new_rule"), true);
            $this->ctrl->setParameter($this, 'src_pool_def_id', $source_pool_definition->getId());
            $this->ctrl->setParameter($this, 'quest_pool_id', $source_pool_definition->getPoolId());
            $this->ctrl->redirect($this, self::CMD_SHOW_CREATE_SRC_POOL_DEF_FORM);
            return;
        }

        $this->ctrl->setParameterByClass(self::class, 'modified', 'save');
        $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
    }

    private function buildCreateSourcePoolDefinitionFormGUI(): ilTestRandomQuestionSetPoolDefinitionFormGUI
    {
        $form = new ilTestRandomQuestionSetPoolDefinitionFormGUI(
            $this->ctrl,
            $this->lng,
            $this->test_obj,
            $this,
            $this->question_set_config
        );

        $form->setSaveCommand(self::CMD_SAVE_CREATE_SRC_POOL_DEF_FORM);
        $form->setSaveAndNewCommand(self::CMD_SAVE_AND_NEW_CREATE_SRC_POOL_DEF_FORM);

        return $form;
    }

    private function showEditSourcePoolDefinitionFormCmd(?ilTestRandomQuestionSetPoolDefinitionFormGUI $form = null): void
    {
        $this->question_set_config->loadFromDb();

        $defId = $this->fetchSingleSourcePoolDefinitionIdParameter();
        $source_pool_definition = $this->source_pool_definition_factory->getSourcePoolDefinitionByDefinitionId($defId);
        $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($source_pool_definition->getPoolId());

        if ($form === null) {
            $form = $this->buildEditSourcePoolDefinitionFormGUI();
            $form->build($source_pool_definition, $available_taxonomy_ids);
        }

        $this->tpl->setContent($this->ctrl->getHTML($form));
    }

    private function saveEditSourcePoolDefinitionFormCmd(): void
    {
        $this->question_set_config->loadFromDb();

        $defId = $this->fetchSingleSourcePoolDefinitionIdParameter();
        $source_pool_definition = $this->source_pool_definition_factory->getSourcePoolDefinitionByDefinitionId($defId);
        $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($source_pool_definition->getPoolId());

        $form = $this->buildEditSourcePoolDefinitionFormGUI();
        $form->build($source_pool_definition, $available_taxonomy_ids);

        $errors = !$form->checkInput(); // ALWAYS CALL BEFORE setValuesByPost()
        $form->setValuesByPost(); // NEVER CALL THIS BEFORE checkInput()

        if ($errors) {
            $this->showSourcePoolDefinitionListCmd();
            return;
        }

        $log_array = $form->applySubmit($source_pool_definition, $available_taxonomy_ids);

        $source_pool_definition->saveToDb();

        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();

        $this->test_obj->saveCompleteStatus($this->question_set_config);

        if ($this->logger->isLoggingEnabled()) {
            $this->logger->logTestAdministrationInteraction(
                $this->logger->getInteractionFactory()->buildTestAdministrationInteraction(
                    $this->test_obj->getRefId(),
                    $this->user->getId(),
                    TestAdministrationInteractionTypes::QUESTIONS_SYNCHRONISATION_RESET,
                    $log_array
                )
            );
        }

        $this->ctrl->setParameterByClass(self::class, 'modified', 'save');
        $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
    }

    private function buildEditSourcePoolDefinitionFormGUI(): ilTestRandomQuestionSetPoolDefinitionFormGUI
    {
        $form = new ilTestRandomQuestionSetPoolDefinitionFormGUI(
            $this->ctrl,
            $this->lng,
            $this->test_obj,
            $this,
            $this->question_set_config
        );

        $form->setSaveCommand(self::CMD_SAVE_EDIT_SRC_POOL_DEF_FORM);

        return $form;
    }

    private function fetchQuestionPoolIdParameter(): int
    {
        if ($this->testrequest->isset('quest_pool_id') && (int) $this->testrequest->raw('quest_pool_id')) {
            return (int) $this->testrequest->raw('quest_pool_id');
        }

        if ($this->testrequest->isset('quest_pool_ref') && (int) $this->testrequest->raw('quest_pool_ref')) {
            return $this->obj_cache->lookupObjId((int) $this->testrequest->raw('quest_pool_ref'));
        }

        throw new ilTestMissingQuestionPoolIdParameterException();
    }

    private function fetchMultiSourcePoolDefinitionIdsParameter(): array
    {
        if (!$this->testrequest->isset('src_pool_def_id')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('tst_please_select_source_pool'), true);
            $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
            return [];
        }

        $definition_ids = is_array($this->testrequest->raw('src_pool_def_id'))
            ? array_map('intval', $this->testrequest->raw('src_pool_def_id'))
            : [(int) $this->testrequest->raw('src_pool_def_id')];

        foreach ($definition_ids as $definition_id) {
            if ($definition_id === 0) {
                throw new ilTestMissingSourcePoolDefinitionParameterException();
            }
        }
        return $definition_ids;
    }

    private function fetchSingleSourcePoolDefinitionIdParameter(): int
    {
        //even a single id can be an array (set by table actions) or a single value (set by form actions)
        $definition_ids = $this->fetchMultiSourcePoolDefinitionIdsParameter();
        if (count($definition_ids) !== 1) {
            throw new ilTestMissingSourcePoolDefinitionParameterException();
        }
        return $definition_ids[0];
    }

    private function getSourcePoolDefinitionByAvailableQuestionPoolId($pool_id): ilTestRandomQuestionSetSourcePoolDefinition
    {
        $availablePools = $this->test_obj->getAvailableQuestionpools(
            true,
            $this->question_set_config->arePoolsWithHomogeneousScoredQuestionsRequired(),
            false,
            true,
            true
        );

        if (isset($availablePools[$pool_id])) {
            $originalPoolData = $availablePools[$pool_id];

            $originalPoolData['qpl_path'] = $this->question_set_config->getQuestionPoolPathString($pool_id);
            $originalPoolData['qpl_ref_id'] = $this->question_set_config->getFirstQuestionPoolRefIdByObjId($pool_id);

            return $this->source_pool_definition_factory->getSourcePoolDefinitionByOriginalPoolData($originalPoolData);
        }

        throw new ilTestQuestionPoolNotAvailableAsSourcePoolException();
    }

    protected function fetchPoolIdsParameter(): array
    {
        $pool_ids = [];
        if ($this->testrequest->isset('derive_pool_ids') && is_array($this->testrequest->raw('derive_pool_ids'))) {
            $pool_ids = [];

            foreach ($this->testrequest->raw('derive_pool_ids') as $pool_id) {
                $pool_ids[] = (int) $pool_id;
            }
        } elseif ($this->testrequest->isset('derive_pool_ids') && preg_match('/^\d+(\:\d+)*$/', $this->testrequest->raw('derive_pool_ids'))) {
            $pool_ids = array_map(
                fn(int $id) => (int) $id,
                explode(':', $this->testrequest->raw('derive_pool_ids'))
            );
        } elseif ($this->testrequest->isset('derive_pool_id') && (int) $this->testrequest->raw('derive_pool_id')) {
            $pool_ids = [(int) $this->testrequest->raw('derive_pool_id')];
        }

        return $pool_ids;
    }

    protected function fetchTargetRefParameter(): ?int
    {
        if ($this->testrequest->isset('target_ref') && (int) $this->testrequest->raw('target_ref')) {
            return (int) $this->testrequest->raw('target_ref');
        }
        return null;
    }

    private function selectPoolDerivationTargetCmd(): void
    {
        $this->ctrl->setParameter($this, 'derive_pool_ids', implode(':', $this->fetchPoolIdsParameter()));

        $explorer = new ilRepositorySelectorExplorerGUI(
            $this,
            self::CMD_SELECT_DERIVATION_TARGET,
            $this,
            self::CMD_DERIVE_NEW_POOLS,
            'target_ref'
        );
        $explorer->setClickableTypes($this->obj_definition->getExplorerContainerTypes());
        $explorer->setSelectableTypes([]);

        if (!$explorer->handleCommand()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('tst_please_select_target_for_pool_derives'));
            $this->tpl->setContent($this->ctrl->getHTML($explorer));
        }
    }

    private function deriveNewPoolsCmd(): void
    {
        $pool_ids = $this->fetchPoolIdsParameter();
        $target_ref = $this->fetchTargetRefParameter();
        if (!$this->access->checkAccess('write', '', $target_ref)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_permission"), true);
            $this->ctrl->setParameterByClass(ilObjTestGUI::class, 'ref_id', $this->test_obj->getRefId());
            $this->ctrl->redirectByClass(ilObjTestGUI::class);
        }

        if ($pool_ids !== []) {
            foreach ($pool_ids as $pool_id) {
                $lost_pool = $this->source_pool_definition_list->getLostPool($pool_id);

                $deriver = new ilTestRandomQuestionSetPoolDeriver(
                    $this->db,
                    $this->component_repository,
                    $this->test_obj,
                    $this->source_pool_definition_list,
                    $this->user->getId(),
                    $target_ref
                );
                $new_pool = $deriver->derive($lost_pool);

                $srcPoolDefinition = $this->source_pool_definition_list->getDefinitionBySourcePoolId($new_pool->getId());
                $srcPoolDefinition->setPoolTitle($new_pool->getTitle());
                $srcPoolDefinition->setPoolPath($this->question_set_config->getQuestionPoolPathString($new_pool->getId()));
                $srcPoolDefinition->setPoolRefId($this->question_set_config->getFirstQuestionPoolRefIdByObjId($new_pool->getId()));
                $srcPoolDefinition->saveToDb();

                ilTestRandomQuestionSetStagingPoolQuestionList::updateSourceQuestionPoolId(
                    $this->test_obj->getTestId(),
                    $lost_pool->getId(),
                    $new_pool->getId()
                );
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('tst_non_available_pool_newly_derived'), true);
        }

        $this->ctrl->redirect($this, self::CMD_SHOW_SRC_POOL_DEF_LIST);
    }

    protected function preventFormBecauseOfSync(): bool
    {
        $return = false;
        $last_sync = $this->question_set_config->getLastQuestionSyncTimestamp();

        if ($last_sync !== null && $last_sync !== 0 &&
            !$this->isFrozenConfigRequired() && $this->question_set_config->isQuestionSetBuildable()) {
            return true;
        }
        return false;
    }

    public function resetPoolSyncCmd(): void
    {
        $this->question_set_config->setLastQuestionSyncTimestamp(0);
        $this->question_set_config->saveToDb();
        if ($this->logger->isLoggingEnabled()) {
            $this->logger->logTestAdministrationInteraction(
                $this->logger->getInteractionFactory()->buildTestAdministrationInteraction(
                    $this->test_obj->getRefId(),
                    $this->user->getId(),
                    TestAdministrationInteractionTypes::QUESTIONS_SYNCHRONISATION_RESET,
                    []
                )
            );
        }
        $this->ctrl->redirect($this, self::CMD_SHOW_GENERAL_CONFIG_FORM);
    }

    protected function buildOnScreenMessage(): string
    {
        $message = $this->buildFormResultMessage();
        $message .= $this->buildValidationMessage();

        return $message;
    }

    protected function buildFormResultMessage(): string
    {
        $message = '';

        if ($this->testrequest->isset('modified')) {
            $action = $this->testrequest->raw('modified');
            if ($action === 'save') {
                $success_message = $this->ui_factory->messageBox()->success($this->lng->txt('tst_msg_random_question_set_config_modified'));
            } elseif ($action === 'remove') {
                $success_message = $this->ui_factory->messageBox()->success($this->lng->txt('tst_msg_source_pool_definitions_deleted'));
            } elseif ($action === 'sync') {
                $success_message = $this->ui_factory->messageBox()->success($this->lng->txt('tst_msg_random_question_set_synced'));
            }
            $message .= $this->ui_renderer->render(
                $success_message
            );
        }

        return $message;
    }

    protected function buildValidationMessage(): string
    {
        if ($this->configStateMessageHandler->isValidationFailed()) {
            return $this->ui_renderer->render(
                $this->ui_factory->messageBox()->failure($this->configStateMessageHandler->getValidationReportHtml())
            );
        }

        if ($this->configStateMessageHandler->hasValidationReports()) {
            return $this->ui_renderer->render(
                $this->ui_factory->messageBox()->info($this->configStateMessageHandler->getValidationReportHtml())
            );
        }

        return $this->configStateMessageHandler->getSyncInfoMessage();
    }

    protected function populateOnScreenMessage($message)
    {
        $this->tpl->setCurrentBlock('mess');
        $this->tpl->setVariable('MESSAGE', $message);
        $this->tpl->parseCurrentBlock();
    }
}