class.assQuestionGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\TestQuestionPool\QuestionPoolDIC;
use ILIAS\TestQuestionPool\RequestDataCollector;
use ILIAS\TestQuestionPool\ilTestLegacyFormsHelper;
use ILIAS\TestQuestionPool\Questions\QuestionAutosaveable;
use ILIAS\TestQuestionPool\Questions\SuggestedSolution\SuggestedSolution;
use ILIAS\TestQuestionPool\Questions\SuggestedSolution\SuggestedSolutionsDatabaseRepository;
use ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Notes\GUIService;

abstract class assQuestionGUI
{
    public const ALLOWED_PLAIN_TEXT_TAGS = "<em>, <strong>";

    public const SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers';

    public const FORM_MODE_EDIT = 'edit';
    public const FORM_MODE_ADJUST = 'adjust';

    public const FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded';
    public const FORM_ENCODING_MULTIPART = 'multipart/form-data';

    public const CORRECTNESS_NOT_OK = 0;
    public const CORRECTNESS_MOSTLY_OK = 1;
    public const CORRECTNESS_OK = 2;

    public const RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback';
    public const RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay';
    public const RENDER_PURPOSE_PREVIEW = 'renderPurposePreview';
    public const RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf';
    public const RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue';

    public const EDIT_CONTEXT_AUTHORING = 'authoring';
    public const EDIT_CONTEXT_ADJUSTMENT = 'adjustment';

    public const PRESENTATION_CONTEXT_TEST = 'pContextTest';
    public const PRESENTATION_CONTEXT_RESULTS = 'pContextResults';

    protected const HAS_SPECIAL_QUESTION_COMMANDS = false;

    protected const SUGGESTED_SOLUTION_COMMANDS_CANCEL = 'cancelSuggestedSolution';
    protected const SUGGESTED_SOLUTION_COMMANDS_SAVE = 'saveSuggestedSolution';
    protected const SUGGESTED_SOLUTION_COMMANDS_DEFAULT = 'suggestedsolution';

    private const CMD_SAVE = 'save';
    private const CMD_SAVE_AND_RETURN = 'saveReturn';

    private const CMD_SYNC_QUESTION = 'syncQuestion';
    public const CMD_SYNC_QUESTION_AND_RETURN = 'syncQuestionReturn';

    protected const QUESTION_SAVE_CMDS = [
        self::CMD_SAVE,
        self::CMD_SAVE_AND_RETURN
    ];

    protected const ADDITIONAL_CMDS_NEEDING_EXISTING_QST = [
        'uploadchoice',
        'uploadImage',
        'changeToPictures',
        'uploadElementImage',
        'uploadterms',
        'uploaddefintions'
    ];

    private $ui;
    private ilObjectDataCache $ilObjDataCache;
    private ilHelpGUI $ilHelp;
    private ilAccessHandler $access;
    private ilTabsGUI $tabs_gui;
    private ilRbacSystem $rbacsystem;
    private ilTree $tree;
    private ilDBInterface $db;
    protected ilLogger $logger;
    private ilComponentRepository $component_repository;
    protected GeneralQuestionPropertiesRepository $questionrepository;
    protected GUIService $notes_gui;
    protected ilCtrl $ctrl;
    private ?ilAssQuestionPreviewSession $preview_session = null;
    protected assQuestion $object;
    protected ilGlobalPageTemplate $tpl;
    protected ilLanguage $lng;
    protected Refinery $refinery;

    protected $error;
    protected string $errormessage;

    protected int $sequence_no;

    protected int $question_count;

    private $taxonomyIds = [];

    private $targetGuiClass = null;

    private string $questionActionCmd = 'handleQuestionAction';

    private ilQuestionHeaderBlockBuilder $questionHeaderBlockBuilder;

    private ?ilTestQuestionNavigationGUI $navigationGUI = null;


    private ?string $presentationContext = null;

    private string $renderPurpose = self::RENDER_PURPOSE_PLAYBACK;

    private string $editContext = self::EDIT_CONTEXT_AUTHORING;

    private bool $previousSolutionPrefilled = false;

    protected ?ilPropertyFormGUI $editForm = null;
    protected readonly ilTestLegacyFormsHelper $forms_helper;
    protected readonly RequestDataCollector $request_data_collector;
    protected bool $parent_type_is_lm = false;

    private ?int $copy_to_existing_pool_on_save = null;
    private ?string $copy_to_new_pool_on_save = null;

    private ?int $move_after_question_with_id = null;
    private bool $context_allows_sync_to_pool = false;
    private string $question_sync_modal = '';

    public function __construct()
    {
        global $DIC;
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->ui = $DIC->ui();
        $this->ilObjDataCache = $DIC['ilObjDataCache'];
        $this->access = $DIC->access();
        $this->ilHelp = $DIC['ilHelp'];
        $this->tabs_gui = $DIC['ilTabs'];
        $this->rbacsystem = $DIC['rbacsystem'];
        $this->tree = $DIC['tree'];
        $this->db = $DIC->database();
        $this->logger = $DIC['ilLog'];
        $this->component_repository = $DIC['component.repository'];
        $this->refinery = $DIC['refinery'];

        $local_dic = QuestionPoolDIC::dic();
        $this->forms_helper = new ilTestLegacyFormsHelper();
        $this->request_data_collector = $local_dic['request_data_collector'];
        $this->questionrepository = $local_dic['question.general_properties.repository'];

        $this->errormessage = $this->lng->txt("fill_out_all_required_fields");
        $this->notes_gui = $DIC->notes()->gui();
    }

    abstract public function editQuestion(
        bool $checkonly = false,
        ?bool $is_save_cmd = null
    ): bool;

    abstract public function getSpecificFeedbackOutput(array $userSolution): string;

    abstract public function getSolutionOutput(
        int $active_id,
        ?int $pass = null,
        bool $graphical_output = false,
        bool $result_output = false,
        bool $show_question_only = true,
        bool $show_feedback = false,
        bool $show_correct_solution = false,
        bool $show_manual_scoring = false,
        bool $show_question_text = true,
        bool $show_inline_feedback = true
    ): string;

    abstract public function getPreview(
        bool $show_question_only = false,
        bool $show_inline_feedback = false
    ): string;

    abstract public function getTestOutput(
        int $active_id,
        int $pass,
        bool $is_question_postponed = false,
        array|bool $user_post_solutions = false,
        bool $show_specific_inline_feedback = false
    ): string;

    public function renderSolutionOutput(
        mixed $user_solutions,
        int $active_id,
        ?int $pass,
        bool $graphical_output = false,
        bool $result_output = false,
        bool $show_question_only = true,
        bool $show_feedback = false,
        bool $show_correct_solution = false,
        bool $show_manual_scoring = false,
        bool $show_question_text = true,
        bool $show_autosave_title = false,
        bool $show_inline_feedback = false,
    ): ?string {
        return null;
    }

    public function getObject(): assQuestion
    {
        return $this->object;
    }

    public function setObject(assQuestion $question): void
    {
        $this->object = $question;
    }

    public function setCopyToExistingPoolOnSave(?int $pool_ref_id): void
    {
        $this->copy_to_existing_pool_on_save = $pool_ref_id;
    }

    public function getCopyToExistingPoolOnSave(): ?int
    {
        return $this->copy_to_existing_pool_on_save;
    }

    public function setCopyToNewPoolOnSave(?string $pool_title): void
    {
        $this->copy_to_new_pool_on_save = $pool_title;
    }

    public function getCopyToNewPoolOnSave(): ?string
    {
        return $this->copy_to_new_pool_on_save;
    }

    public function setMoveAfterQuestionId(?int $question_id): void
    {
        $this->move_after_question_with_id = $question_id;
    }

    public function getMoveAfterQuestionId(): ?int
    {
        return $this->move_after_question_with_id;
    }

    public function hasInlineFeedback(): bool
    {
        return false;
    }

    public function addHeaderAction(): void
    {
    }

    public function redrawHeaderAction(): void
    {
        echo $this->getHeaderAction() . $this->ui->mainTemplate()->getOnLoadCodeForAsynch();
        exit;
    }

    public function getHeaderAction(): string
    {
        $parentObjType = $this->ilObjDataCache->lookupType($this->object->getObjId());

        $dispatcher = new ilCommonActionDispatcherGUI(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $this->access,
            $parentObjType,
            $this->request_data_collector->getRefId(),
            $this->object->getObjId()
        );

        $dispatcher->setSubObject("quest", $this->object->getId());

        $ha = $dispatcher->initHeaderAction();
        $ha->enableComments(true, false);

        return $ha->getHeaderAction($this->ui->mainTemplate());
    }

    public function getCommentsPanelHTML(): string
    {
        $comment_gui = new ilCommentGUI($this->object->getObjId(), $this->object->getId(), 'quest');
        return $comment_gui->getListHTML();
    }

    public function executeCommand()
    {
        $this->ilHelp->setScreenIdComponent('qpl');

        $next_class = $this->ctrl->getNextClass($this);

        switch ($next_class) {
            case 'ilformpropertydispatchgui':
                $form = $this->buildEditForm();
                $form_prop_dispatch = new ilFormPropertyDispatchGUI();
                $form_prop_dispatch->setItem($form->getItemByPostVar(ilUtil::stripSlashes($this->request_data_collector->string('postvar'))));
                $this->ctrl->forwardCommand($form_prop_dispatch);
                break;
            default:
                $cmd = $this->ctrl->getCmd('editQuestion');
                switch ($cmd) {
                    case self::SUGGESTED_SOLUTION_COMMANDS_CANCEL:
                    case self::SUGGESTED_SOLUTION_COMMANDS_SAVE:
                    case self::SUGGESTED_SOLUTION_COMMANDS_DEFAULT:
                    case 'saveSuggestedSolutionType':
                    case 'saveContentsSuggestedSolution':
                    case 'deleteSuggestedSolution':
                    case 'linkChilds':
                    case 'cancelExplorer':
                    case 'outSolutionExplorer':
                    case 'addST':
                    case 'addPG':
                    case 'addGIT':
                    case 'save':
                    case 'saveReturn':
                    case self::CMD_SYNC_QUESTION:
                    case self::CMD_SYNC_QUESTION_AND_RETURN:
                    case 'editQuestion':
                        $this->$cmd();
                        break;
                    default:
                        if (method_exists($this, $cmd)) {
                            $this->$cmd();
                        }
                }
        }
    }

    protected function hasSpecialQuestionCommands(): bool
    {
        return static::HAS_SPECIAL_QUESTION_COMMANDS;
    }

    public function getType(): string
    {
        return $this->getQuestionType();
    }

    public function getPresentationContext(): ?string
    {
        return $this->presentationContext;
    }

    public function setPresentationContext(string $presentationContext): void
    {
        $this->presentationContext = $presentationContext;
    }

    public function isTestPresentationContext(): bool
    {
        return $this->getPresentationContext() == self::PRESENTATION_CONTEXT_TEST;
    }

    // hey: previousPassSolutions - setter/getter for Previous Solution Prefilled flag
    public function isPreviousSolutionPrefilled(): bool
    {
        return $this->previousSolutionPrefilled;
    }

    public function setPreviousSolutionPrefilled(bool $previousSolutionPrefilled): void
    {
        $this->previousSolutionPrefilled = $previousSolutionPrefilled;
    }
    // hey.

    public function getRenderPurpose(): string
    {
        return $this->renderPurpose;
    }

    public function setRenderPurpose(string $renderPurpose): void
    {
        $this->renderPurpose = $renderPurpose;
    }

    public function isRenderPurposePrintPdf(): bool
    {
        return $this->getRenderPurpose() == self::RENDER_PURPOSE_PRINT_PDF;
    }

    public function isRenderPurposePreview(): bool
    {
        return $this->getRenderPurpose() == self::RENDER_PURPOSE_PREVIEW;
    }

    public function isRenderPurposeInputValue(): bool
    {
        return $this->getRenderPurpose() == self::RENDER_PURPOSE_INPUT_VALUE;
    }

    public function isRenderPurposePlayback(): bool
    {
        return $this->getRenderPurpose() == self::RENDER_PURPOSE_PLAYBACK;
    }

    public function isRenderPurposeDemoplay(): bool
    {
        return $this->getRenderPurpose() == self::RENDER_PURPOSE_DEMOPLAY;
    }

    public function renderPurposeSupportsFormHtml(): bool
    {
        if ($this->isRenderPurposePrintPdf()) {
            return false;
        }

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

        return true;
    }

    public function getEditContext(): string
    {
        return $this->editContext;
    }

    public function setEditContext(string $editContext): void
    {
        $this->editContext = $editContext;
    }

    public function isAuthoringEditContext(): bool
    {
        return $this->getEditContext() == self::EDIT_CONTEXT_AUTHORING;
    }

    public function isAdjustmentEditContext(): bool
    {
        return $this->getEditContext() == self::EDIT_CONTEXT_ADJUSTMENT;
    }

    public function setAdjustmentEditContext(): void
    {
        $this->setEditContext(self::EDIT_CONTEXT_ADJUSTMENT);
    }

    public function getNavigationGUI(): ?ilTestQuestionNavigationGUI
    {
        return $this->navigationGUI;
    }

    public function setNavigationGUI(?ilTestQuestionNavigationGUI $navigationGUI): void
    {
        $this->navigationGUI = $navigationGUI;
    }

    public function setTaxonomyIds(array $taxonomyIds): void
    {
        $this->taxonomyIds = $taxonomyIds;
    }

    public function getTaxonomyIds(): array
    {
        return $this->taxonomyIds;
    }

    public function setTargetGui($linkTargetGui): void
    {
        $this->setTargetGuiClass(get_class($linkTargetGui));
    }

    public function setTargetGuiClass(string $targetGuiClass): void
    {
        $this->targetGuiClass = $targetGuiClass;
    }

    public function getTargetGuiClass(): ?string
    {
        return $this->targetGuiClass;
    }

    public function setQuestionHeaderBlockBuilder(\ilQuestionHeaderBlockBuilder $questionHeaderBlockBuilder): void
    {
        $this->questionHeaderBlockBuilder = $questionHeaderBlockBuilder;
    }

    // fau: testNav - get the question header block bulder (for tweaking)
    public function getQuestionHeaderBlockBuilder(): \ilQuestionHeaderBlockBuilder
    {
        return $this->questionHeaderBlockBuilder;
    }
    // fau.

    public function setQuestionActionCmd(string $questionActionCmd): void
    {
        $this->questionActionCmd = $questionActionCmd;

        if (is_object($this->object)) {
            $this->object->questionActionCmd = $questionActionCmd;
        }
    }

    public function getQuestionActionCmd(): string
    {
        return $this->questionActionCmd;
    }

    protected function writePostData(bool $always = false): int
    {
        return 0;
    }

    public function assessment(): void
    {
        $stats_table = new ilQuestionCumulatedStatisticsTableGUI($this, 'assessment', '', $this->object, $this->questionrepository);
        $usage_table = new ilQuestionUsagesTableGUI($this, 'assessment', '', $this->object);

        $this->tpl->setContent(implode('<br />', [
            $stats_table->getHTML(),
            $usage_table->getHTML()
        ]));
    }

    public static function _getQuestionGUI(string $question_type = '', int $question_id = -1): ?assQuestionGUI
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];

        if (($question_type === '') && ($question_id > 0)) {
            $question_type = QuestionPoolDIC::dic()['question.general_properties.repository']
                ->getForQuestionId($question_id)?->getClassName();
        }

        if ($question_type === null || $question_type === '') {
            return null;
        }

        $question_type_gui = $question_type . 'GUI';
        $question = new $question_type_gui();

        $feedbackObjectClassname = assQuestion::getFeedbackClassNameByQuestionType($question_type);
        $question->object->feedbackOBJ = new $feedbackObjectClassname($question->object, $ilCtrl, $ilDB, $lng);

        if ($question_id > 0) {
            $question->object->loadFromDb($question_id);
        }

        return $question;
    }

    public function populateJavascriptFilesRequiredForWorkForm(ilGlobalTemplateInterface $tpl): void
    {
        foreach ($this->getPresentationJavascripts() as $jsFile) {
            $tpl->addJavaScript($jsFile);
        }
    }

    public function getPresentationJavascripts(): array
    {
        return [];
    }

    public function getQuestionTemplate(): void
    {
        // @todo Björn: Maybe this has to be changed for PHP 7/ILIAS 5.2.x because ass[XYZ]QuestionGUI::editQuestion is called multiple times
        if (!$this->tpl->blockExists('adm_content')) {
            $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.il_as_question.html', 'components/ILIAS/TestQuestionPool');
        }
    }

    protected function renderEditForm(ilPropertyFormGUI $form): void
    {
        $this->addSaveOnEnterOnLoadCode();
        $this->getQuestionTemplate();
        $this->tpl->setVariable('QUESTION_DATA', $form->getHTML() . $this->question_sync_modal);
    }

    public function getILIASPage(string $html = ""): string
    {
        $page_gui = new ilAssQuestionPageGUI($this->object->getId());
        $page_gui->setQuestionHTML(
            [$this->object->getId() => $html]
        );
        $presentation = $page_gui->presentation();
        $presentation = preg_replace("/src=\"\\.\\//ims", "src=\"" . ILIAS_HTTP_PATH . "/", $presentation);
        return $presentation;
    }

    public function outQuestionPage($a_temp_var, $a_postponed = false, $active_id = "", $html = "", $inlineFeedbackEnabled = false): string
    {
        if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
            // hey
            $this->tpl->setOnScreenMessage('info', $this->getPreviousSolutionProvidedMessage());
            $html .= $this->getPreviousSolutionConfirmationCheckboxHtml();
        } elseif ($this->object->getTestPresentationConfig()->isUnchangedAnswerPossible()) {
            $html .= $this->getUseUnchangedAnswerCheckboxHtml();
        }

        $this->lng->loadLanguageModule("content");

        $page_gui = new ilAssQuestionPageGUI($this->object->getId());
        $page_gui->setOutputMode("presentation");
        $page_gui->setTemplateTargetVar($a_temp_var);

        if ($this->getNavigationGUI()) {
            $html .= $this->getNavigationGUI()->getHTML();
            $page_gui->setQuestionActionsHTML($this->getNavigationGUI()->getActionsHTML());
        }

        if (strlen($html)) {
            $page_gui->setQuestionHTML([$this->object->getId() => $html]);
        }

        $page_gui->setPresentationTitle($this->questionHeaderBlockBuilder->getPresentationTitle());
        $page_gui->setQuestionInfoHTML($this->questionHeaderBlockBuilder->getQuestionInfoHTML());

        return $page_gui->presentation();
    }

    protected function getUseUnchangedAnswerCheckboxHtml(): string
    {
        $tpl = new ilTemplate('tpl.tst_question_additional_behaviour_checkbox.html', true, true, 'components/ILIAS/TestQuestionPool');
        $tpl->setVariable('TXT_FORCE_FORM_DIFF_LABEL', $this->object->getTestPresentationConfig()->getUseUnchangedAnswerLabel());
        return $tpl->get();
    }

    protected function getPreviousSolutionProvidedMessage(): string
    {
        return $this->lng->txt('use_previous_solution_advice');
    }

    protected function getPreviousSolutionConfirmationCheckboxHtml(): string
    {
        $tpl = new ilTemplate('tpl.tst_question_additional_behaviour_checkbox.html', true, true, 'components/ILIAS/TestQuestionPool');
        $tpl->setVariable('TXT_FORCE_FORM_DIFF_LABEL', $this->lng->txt('use_previous_solution'));
        return $tpl->get();
    }

    public function syncQuestion(): void
    {
        $original_id = $this->object->getOriginalId();
        if ($original_id !== null) {
            $this->object->syncWithOriginal();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        }
    }

    public function saveReturn(): void
    {
        $old_id = $this->request_data_collector->getQuestionId();
        $this->setAdditionalContentEditingModeFromPost();
        $result = $this->writePostData();
        if ($result !== 0) {
            $this->tabs_gui->setTabActive('edit_question');
            return;
        }

        $this->object->getCurrentUser()->setPref('tst_lastquestiontype', $this->object->getQuestionType());
        $this->object->getCurrentUser()->writePref('tst_lastquestiontype', $this->object->getQuestionType());
        $this->object->saveToDb($old_id);

        $this->questionrepository->questionExistsInPool($this->object->getOriginalId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirectByClass(ilAssQuestionPreviewGUI::class, ilAssQuestionPreviewGUI::CMD_SHOW);
    }

    public function saveQuestion(): bool
    {
        $this->setAdditionalContentEditingModeFromPost();
        $result = $this->writePostData();
        $this->tabs_gui->activateTab('edit_question');

        if ($result !== 0) {
            return  false;
        }

        $this->object->getCurrentUser()->setPref('tst_lastquestiontype', $this->object->getQuestionType());
        $this->object->getCurrentUser()->writePref('tst_lastquestiontype', $this->object->getQuestionType());

        if ($this->request_data_collector->getQuestionId() === 0) {
            if ($this->object->getId() < 1) {
                $this->object->createNewQuestion();
            }
            $this->setQuestionTabs();
        }

        if ($this->needsSyncQuery()) {
            $cmd = strpos($this->ctrl->getCmd(), 'Return') === false
                ? self::CMD_SYNC_QUESTION
                : self::CMD_SYNC_QUESTION_AND_RETURN;
            $this->question_sync_modal = $this->getQuestionSyncModal($cmd);
        }

        $this->object->saveToDb();
        return true;
    }

    public function setAdditionalContentEditingModeFromPost(): void
    {
        $additional_content_editing_mode = $this->request_data_collector->string('additional_content_editing_mode');
        if ($additional_content_editing_mode !== ''
            && in_array($additional_content_editing_mode, $this->object->getValidAdditionalContentEditingModes())) {
            $this->object->setAdditionalContentEditingMode($additional_content_editing_mode);
        }
    }

    protected function setTestSpecificProperties(): void
    {
        if ($this->request_data_collector->isset('pool_ref')) {
            $this->copy_to_existing_pool_on_save = $this->request_data_collector->int('pool_ref');
        }

        if ($this->request_data_collector->isset('pool_title')) {
            $this->copy_to_new_pool_on_save = $this->request_data_collector->string('pool_title');
        }

        if ($this->request_data_collector->isset('move_after_question_with_id')) {
            $this->move_after_question_with_id = $this->request_data_collector->int('move_after_question_with_id');
        }
    }

    public function getContextPath($cont_obj, int $a_endnode_id, int $a_startnode_id = 1): string
    {
        $path = "";

        $tmpPath = $cont_obj->getLMTree()->getPathFull($a_endnode_id, $a_startnode_id);

        // count -1, to exclude the learning module itself
        for ($i = 1; $i < (count($tmpPath) - 1); $i++) {
            if ($path != "") {
                $path .= " > ";
            }

            $path .= $tmpPath[$i]["title"];
        }

        return $path;
    }

    public function setSequenceNumber(int $nr): void
    {
        $this->sequence_no = $nr;
    }

    public function getSequenceNumber(): int
    {
        return $this->sequence_no;
    }

    public function setQuestionCount(int $a_question_count): void
    {
        $this->question_count = $a_question_count;
    }

    public function getQuestionCount(): int
    {
        return $this->question_count;
    }

    public function getErrorMessage(): string
    {
        return $this->errormessage;
    }

    public function setErrorMessage(string $errormessage): void
    {
        $this->errormessage = $errormessage;
    }

    public function addErrorMessage(string $errormessage): void
    {
        $this->errormessage .= ((strlen($this->errormessage)) ? "<br />" : "") . $errormessage;
    }

    public function getQuestionType(): string
    {
        return $this->object->getQuestionType();
    }

    public function getAsValueAttribute(string $a_value): string
    {
        $result = "";
        if (strlen($a_value)) {
            $result = " value=\"$a_value\" ";
        }
        return $result;
    }

    public function addQuestionFormCommandButtons(ilPropertyFormGUI $form): void
    {
        if (!$this->object->getSelfAssessmentEditingMode()) {
            $form->addCommandButton("saveReturn", $this->lng->txt("save_return"));
        }
        $form->addCommandButton("save", $this->lng->txt("save"));
    }

    public function addBasicQuestionFormProperties(ilPropertyFormGUI $form): void
    {
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setMaxLength(100);
        $title->setValue($this->object->getTitle());
        $title->setRequired(true);
        $form->addItem($title);

        if (!$this->object->getSelfAssessmentEditingMode()) {
            // author
            $author = new ilTextInputGUI($this->lng->txt('author'), 'author');
            $author->setValue($this->object->getAuthor());
            $author->setMaxLength(512);
            $author->setRequired(true);
            $form->addItem($author);

            // description
            $description = new ilTextInputGUI($this->lng->txt('description'), 'comment');
            $description->setValue($this->object->getComment());
            $description->setRequired(false);
            $description->setMaxLength(1000);
            $form->addItem($description);
        } else {
            // author as hidden field
            $hi = new ilHiddenInputGUI('author');
            $author = ilLegacyFormElementsUtil::prepareFormOutput($this->object->getAuthor());
            if (trim($author) == "") {
                $author = "-";
            }
            $hi->setValue($author);
            $form->addItem($hi);
        }

        // lifecycle
        $lifecycle = new ilSelectInputGUI($this->lng->txt('qst_lifecycle'), 'lifecycle');
        $lifecycle->setOptions($this->object->getLifecycle()->getSelectOptions($this->lng));
        $lifecycle->setValue($this->object->getLifecycle()->getIdentifier());
        $form->addItem($lifecycle);

        // questiontext
        $question = new ilTextAreaInputGUI($this->lng->txt('question'), 'question');
        $question->setValue($this->object->getQuestion());
        $question->setRequired(true);
        $question->setRows(10);
        $question->setCols(80);

        if (!$this->object->getSelfAssessmentEditingMode()) {
            if ($this->object->getAdditionalContentEditingMode() !== assQuestion::ADDITIONAL_CONTENT_EDITING_MODE_IPE) {
                $question->setUseRte(true);
                $question->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags('assessment'));
                $question->setRTESupport($this->object->getId(), 'qpl', 'assessment');
            }
        } else {
            $question->setRteTags(ilAssSelfAssessmentQuestionFormatter::getSelfAssessmentTags());
            $question->setUseTagsForRteOnly(false);
        }
        $form->addItem($question);

        $question_type = new ilHiddenInputGUI('question_type');
        $question_type->setValue((string) $this->getQuestionType());
        $form->addItem($question_type);

        if ($this->copy_to_existing_pool_on_save !== null) {
            $pool_ref = new ilHiddenInputGUI('pool_ref');
            $pool_ref->setValue((string) $this->copy_to_existing_pool_on_save);
            $form->addItem($pool_ref);
        }

        if ($this->copy_to_new_pool_on_save !== null) {
            $pool_title = new ilHiddenInputGUI('pool_title');
            $pool_title->setValue($this->copy_to_new_pool_on_save);
            $form->addItem($pool_title);
        }

        if ($this->move_after_question_with_id !== null) {
            $move_after_question_id = new ilHiddenInputGUI('move_after_question_with_id');
            $move_after_question_id->setValue((string) $this->move_after_question_with_id);
            $form->addItem($move_after_question_id);
        }

        $additional_content_editing_mode = new ilHiddenInputGUI('additional_content_editing_mode');
        $additional_content_editing_mode->setValue($this->object->getAdditionalContentEditingMode());
        $form->addItem($additional_content_editing_mode);

        $this->addNumberOfTriesToFormIfNecessary($form);
    }

    protected function addNumberOfTriesToFormIfNecessary(ilPropertyFormGUI $form)
    {
        if (!$this->object->getSelfAssessmentEditingMode()) {
            return;
        }

        $nr_tries = $this->object->getNrOfTries() ?? $this->object->getDefaultNrOfTries();

        if ($nr_tries < 1) {
            $nr_tries = "";
        }

        $ni = new ilNumberInputGUI($this->lng->txt("qst_nr_of_tries"), "nr_of_tries");
        $ni->setValue((string) $nr_tries);
        $ni->setMinValue(0);
        $ni->setSize(5);
        $ni->setMaxLength(5);
        $form->addItem($ni);
    }

    protected function saveTaxonomyAssignments(): void
    {
        if (count($this->getTaxonomyIds())) {
            foreach ($this->getTaxonomyIds() as $taxonomyId) {
                $postvar = "tax_node_assign_$taxonomyId";

                $tax_node_assign = new ilTaxAssignInputGUI($taxonomyId, true, '', $postvar);
                // TODO: determine tst/qpl when tax assigns become maintainable within tests
                $tax_node_assign->saveInput("qpl", $this->object->getObjId(), "quest", $this->object->getId());
            }
        }
    }

    protected function populateTaxonomyFormSection(ilPropertyFormGUI $form): void
    {
        if ($this->getTaxonomyIds() !== []) {
            $sectHeader = new ilFormSectionHeaderGUI();
            $sectHeader->setTitle($this->lng->txt('qpl_qst_edit_form_taxonomy_section'));
            $form->addItem($sectHeader);

            foreach ($this->getTaxonomyIds() as $taxonomyId) {
                $taxonomy = new ilObjTaxonomy($taxonomyId);
                $label = sprintf($this->lng->txt('qpl_qst_edit_form_taxonomy'), $taxonomy->getTitle());
                $postvar = "tax_node_assign_$taxonomyId";

                $taxSelect = new ilTaxSelectInputGUI($taxonomy->getId(), $postvar, true);
                $taxSelect->setTitle($label);


                $taxNodeAssignments = new ilTaxNodeAssignment(ilObject::_lookupType($this->object->getObjId()), $this->object->getObjId(), 'quest', $taxonomyId);
                $assignedNodes = $taxNodeAssignments->getAssignmentsOfItem($this->object->getId());

                $taxSelect->setValue(array_map(function ($assignedNode) {
                    return $assignedNode['node_id'];
                }, $assignedNodes));
                $form->addItem($taxSelect);
            }
        }
    }

    public function getGenericFeedbackOutput(int $active_id, ?int $pass): string
    {
        $manual_feedback = ilObjTest::getManualFeedback($active_id, $this->object->getId(), $pass);
        if ($manual_feedback !== '') {
            return $manual_feedback;
        }

        $output = $this->genericFeedbackOutputBuilder($active_id, $pass);

        if ($this->object->isAdditionalContentEditingModePageObject()) {
            return $output;
        }
        return ilLegacyFormElementsUtil::prepareTextareaOutput($output, true);
    }

    protected function genericFeedbackOutputBuilder(
        int $active_id,
        ?int $pass
    ): string {
        if ($pass === null) {
            return '';
        }
        $reached_points = $this->object->calculateReachedPoints($active_id, $pass);
        $max_points = $this->object->getMaximumPoints();

        $is_correct = false;
        if ($reached_points == $max_points) {
            $is_correct = true;
        }

        return $this->object->feedbackOBJ->getGenericFeedbackTestPresentation(
            $this->object->getId(),
            $is_correct
        );
    }

    public function getGenericFeedbackOutputForCorrectSolution(): string
    {
        return ilLegacyFormElementsUtil::prepareTextareaOutput(
            $this->object->feedbackOBJ->getGenericFeedbackTestPresentation($this->object->getId(), true),
            true
        );
    }

    public function getGenericFeedbackOutputForIncorrectSolution(): string
    {
        return ilLegacyFormElementsUtil::prepareTextareaOutput(
            $this->object->feedbackOBJ->getGenericFeedbackTestPresentation($this->object->getId(), false),
            true
        );
    }

    public function outQuestionType(): string
    {
        $count = $this->questionrepository->usageCount($this->object->getId());

        if ($this->questionrepository->questionExistsInPool($this->object->getId()) && $count) {
            if ($this->rbacsystem->checkAccess("write", $this->request_data_collector->getRefId())) {
                $this->tpl->setOnScreenMessage('info', sprintf($this->lng->txt("qpl_question_is_in_use"), $count));
            }
        }

        return $this->lng->txt($this->object->getQuestionType());
    }

    protected function getTypeOptions(): array
    {
        foreach (SuggestedSolution::TYPES as $k => $v) {
            $options[$k] = $this->lng->txt($v);
        }
        return $options;
    }

    public function saveSuggestedSolution(): void
    {
        $this->suggestedsolution(true);
    }

    public function cancelSuggestedSolution(): void
    {
        $this->suggestedsolution();
    }

    public function suggestedsolution(bool $save = false): void
    {
        if ($save && $this->request_data_collector->int('deleteSuggestedSolution') === 1) {
            $this->object->deleteSuggestedSolutions();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, 'suggestedsolution');
        }

        $output = '';

        $solution = $this->object->getSuggestedSolution();
        $options = $this->getTypeOptions();

        $solution_type = $this->ctrl->getCmd() === 'cancelSuggestedSolution'
            ? $solution->getType()
            : $this->request_data_collector->string('solutiontype');
        if ($solution_type === SuggestedSolution::TYPE_FILE
            && ($solution === null || $solution->getType() !== SuggestedSolution::TYPE_FILE)
        ) {
            $solution = $this->getSuggestedSolutionsRepo()->create(
                $this->object->getId(),
                SuggestedSolution::TYPE_FILE
            );
        }

        $solution_filename = $this->request_data_collector->string('filename');
        if ($save && !empty($solution_filename)) {
            $solution = $solution->withTitle($solution_filename);
        }

        if ($solution !== null) {
            $form = new ilPropertyFormGUI();
            $form->setFormAction($this->ctrl->getFormAction($this));
            $form->setTitle($this->lng->txt('solution_hint'));
            $form->setMultipart(true);
            $form->setTableWidth('100%');
            $form->setId('suggestedsolutiondisplay');

            $title = new ilSolutionTitleInputGUI($this->lng->txt('showSuggestedSolution'), 'solutiontype');
            $template = new ilTemplate(
                'tpl.il_as_qpl_suggested_solution_input_presentation.html',
                true,
                true,
                'components/ILIAS/TestQuestionPool'
            );

            if ($solution->isOfTypeLink()) {
                $href = $this->object->getInternalLinkHref($solution->getInternalLink());
                $template->setCurrentBlock('preview');
                $template->setVariable('TEXT_SOLUTION', $this->lng->txt('suggested_solution'));
                $template->setVariable(
                    'VALUE_SOLUTION',
                    " <a href='{$href}' target='content'>{$this->lng->txt('view')}</a> "
                );
                $template->parseCurrentBlock();
            } elseif (
                $solution->isOfTypeFile()
                && $solution->getFilename()
            ) {
                $href = $this->object->getSuggestedSolutionPathWeb() . $solution->getFilename();
                $link = " <a href='{$href}' target='content'>"
                    . ilLegacyFormElementsUtil::prepareFormOutput($solution->getTitle())
                    . '</a> ';
                $template->setCurrentBlock('preview');
                $template->setVariable('TEXT_SOLUTION', $this->lng->txt('suggested_solution'));
                $template->setVariable('VALUE_SOLUTION', $link);
                $template->parseCurrentBlock();
            }

            $template->setVariable('TEXT_TYPE', $this->lng->txt('type'));
            $template->setVariable('VALUE_TYPE', $options[$solution->getType()]);

            $title->setHtml($template->get());
            $deletesolution = new ilCheckboxInputGUI('', 'deleteSuggestedSolution');
            $deletesolution->setOptionTitle($this->lng->txt('deleteSuggestedSolution'));
            $title->addSubItem($deletesolution);
            $form->addItem($title);

            if ($solution->isOfTypeFile()) {
                $file = new ilFileInputGUI($this->lng->txt('fileDownload'), 'file');
                $file->setRequired(true);
                $file->enableFileNameSelection('filename');

                if ($save && $_FILES && $_FILES['file']['tmp_name'] && $file->checkInput()) {
                    if (!file_exists($this->object->getSuggestedSolutionPath())) {
                        ilFileUtils::makeDirParents($this->object->getSuggestedSolutionPath());
                    }

                    $res = ilFileUtils::moveUploadedFile(
                        $_FILES['file']['tmp_name'],
                        $_FILES['file']['name'],
                        $this->object->getSuggestedSolutionPath() . $_FILES['file']['name']
                    );
                    if ($res) {
                        ilFileUtils::renameExecutables($this->object->getSuggestedSolutionPath());

                        // remove an old file download
                        if ($solution->getFilename()) {
                            @unlink($this->object->getSuggestedSolutionPath() . $solution->getFilename());
                        }

                        $file->setValue($_FILES['file']['name']);
                        $solution = $solution
                            ->withFilename($_FILES['file']['name'])
                            ->withMime($_FILES['file']['type'])
                            ->withSize($_FILES['file']['size'])
                            ->withTitle($this->request_data_collector->string('filename'));

                        $this->getSuggestedSolutionsRepo()->update([$solution]);

                        $this->tpl->setOnScreenMessage('success', $this->lng->txt('suggested_solution_added_successfully'), true);
                        $this->ctrl->redirect($this, 'suggestedsolution');
                    } else {
                        // BH: $res as info string? wtf? it holds a bool or something else!!?
                        $this->tpl->setOnScreenMessage('info', $res);
                    }
                } else {
                    if ($solution->getFilename()) {
                        $file->setValue($solution->getFilename());
                        $file->setFilename($solution->getTitle());
                    }
                }
                $form->addItem($file);
                $hidden = new ilHiddenInputGUI('solutiontype');
                $hidden->setValue('file');
                $form->addItem($hidden);
            }
            if ($this->access->checkAccess('write', '', $this->request_data_collector->getRefId())) {
                $form->addCommandButton('cancelSuggestedSolution', $this->lng->txt('cancel'));
                $form->addCommandButton('saveSuggestedSolution', $this->lng->txt('save'));
            }

            if ($save) {
                if ($form->checkInput()) {
                    if ($solution->isOfTypeFile()) {
                        $solution = $solution->withTitle($this->request_data_collector->string('filename'));
                    }

                    if (!$solution->isOfTypeLink()) {
                        $this->getSuggestedSolutionsRepo()->update([$solution]);
                    }

                    $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
                    $this->ctrl->redirect($this, 'suggestedsolution');
                }
            }

            $output = $form->getHTML();
        }

        $savechange = $this->ctrl->getCmd() === 'saveSuggestedSolutionType';

        $changeoutput = '';
        if ($this->access->checkAccess('write', '', $this->request_data_collector->getRefId())) {
            $formchange = new ilPropertyFormGUI();
            $formchange->setFormAction($this->ctrl->getFormAction($this));

            $title = $solution ? $this->lng->txt('changeSuggestedSolution') : $this->lng->txt('addSuggestedSolution');
            $formchange->setTitle($title);
            $formchange->setMultipart(false);
            $formchange->setTableWidth('100%');
            $formchange->setId('suggestedsolution');

            $solutiontype = new ilRadioGroupInputGUI($this->lng->txt('suggestedSolutionType'), 'solutiontype');
            foreach ($options as $opt_value => $opt_caption) {
                $solutiontype->addOption(new ilRadioOption($opt_caption, $opt_value));
            }
            if ($solution) {
                $solutiontype->setValue($solution->getType());
            }
            $solutiontype->setRequired(true);
            $formchange->addItem($solutiontype);

            $formchange->addCommandButton('saveSuggestedSolutionType', $this->lng->txt('select'));

            if ($savechange) {
                $formchange->checkInput();
            }
            $changeoutput = $formchange->getHTML();
        }
        $this->tabs_gui->activateTab('suggested_solution');
        $this->tpl->setVariable('ADM_CONTENT', $changeoutput . $output);
    }

    public function outSolutionExplorer(): void
    {
        $type = $this->request_data_collector->string("link_new_type");
        $search = $this->request_data_collector->string("search_link_type");
        $this->ctrl->setParameter($this, "link_new_type", $type);
        $this->ctrl->setParameter($this, "search_link_type", $search);
        $this->ctrl->saveParameter($this, ["subquestion_index", "link_new_type", "search_link_type"]);

        $this->tpl->setOnScreenMessage('info', $this->lng->txt("select_object_to_link"));

        $parent_ref_id = $this->tree->getParentId($this->request_data_collector->getRefId());
        $exp = new ilSolutionExplorer($this->ctrl->getLinkTarget($this, 'suggestedsolution'), get_class($this));
        $exp->setExpand($this->request_data_collector->raw('expand_sol') ? $this->request_data_collector->raw('expand_sol') : $parent_ref_id);
        $exp->setExpandTarget($this->ctrl->getLinkTarget($this, 'outSolutionExplorer'));
        $exp->setTargetGet("ref_id");
        $exp->setRefId($this->request_data_collector->getRefId());
        $exp->addFilter($type);
        $exp->setSelectableType($type);
        if ($this->request_data_collector->isset('expandCurrentPath') && $this->request_data_collector->raw('expandCurrentPath')) {
            $exp->expandPathByRefId($parent_ref_id);
        }

        // build html-output
        $exp->setOutput(0);

        $template = new ilTemplate("tpl.il_as_qpl_explorer.html", true, true, "components/ILIAS/TestQuestionPool");
        $template->setVariable("EXPLORER_TREE", $exp->getOutput());
        $template->setVariable("BUTTON_CANCEL", $this->lng->txt("cancel"));
        $template->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "suggestedsolution"));
        $this->tpl->setVariable("ADM_CONTENT", $template->get());
    }

    public function saveSuggestedSolutionType(): void
    {
        $solution_type = $this->request_data_collector->string('solutiontype');

        switch ($solution_type) {
            case 'lm':
                $type = 'lm';
                $search = 'lm';
                break;
            case 'git':
                $type = 'glo';
                $search = 'glo';
                break;
            case 'st':
                $type = 'lm';
                $search = 'st';
                break;
            case 'pg':
                $type = 'lm';
                $search = 'pg';
                break;
            case 'file':
            case 'text':
            default:
                $this->suggestedsolution();
                return;
        }

        if (isset($solution_type)) {
            $this->ctrl->setParameter($this, 'expandCurrentPath', 1);
        }
        $this->ctrl->setParameter($this, 'link_new_type', $type);
        $this->ctrl->setParameter($this, 'search_link_type', $search);
        $this->ctrl->redirect($this, 'outSolutionExplorer');
    }

    public function cancelExplorer(): void
    {
        $this->ctrl->redirect($this, 'suggestedsolution');
    }

    public function outPageSelector(): void
    {
        $this->ctrl->setParameter($this, 'q_id', $this->object->getId());

        $cont_obj_gui = new ilObjContentObjectGUI('', $this->request_data_collector->int('source_id'), true);
        $cont_obj = $cont_obj_gui->getObject();
        $pages = ilLMPageObject::getPageList($cont_obj->getId());
        $shownpages = [];
        $tree = $cont_obj->getLMTree();
        $chapters = $tree->getSubtree($tree->getNodeData($tree->getRootId()));

        $rows = [];

        foreach ($chapters as $chapter) {
            $chapterpages = $tree->getChildsByType($chapter['obj_id'], 'pg');
            foreach ($chapterpages as $page) {
                if ($page['type'] == $this->request_data_collector->raw('search_link_type')) {
                    array_push($shownpages, $page['obj_id']);

                    if ($tree->isInTree($page['obj_id'])) {
                        $path_str = $this->getContextPath($cont_obj, $page['obj_id']);
                    } else {
                        $path_str = '---';
                    }

                    $this->ctrl->setParameter($this, $page['type'], $page['obj_id']);
                    $rows[] = [
                        'title' => $page['title'],
                        'description' => ilLegacyFormElementsUtil::prepareFormOutput($path_str),
                        'text_add' => $this->lng->txt('add'),
                        'href_add' => $this->ctrl->getLinkTarget($this, 'add' . strtoupper($page['type']))
                    ];
                }
            }
        }
        foreach ($pages as $page) {
            if (!in_array($page['obj_id'], $shownpages)) {
                $this->ctrl->setParameter($this, $page['type'], $page['obj_id']);
                $rows[] = [
                    'title' => $page['title'],
                    'description' => '---',
                    'text_add' => $this->lng->txt('add'),
                    'href_add' => $this->ctrl->getLinkTarget($this, 'add' . strtoupper($page['type']))
                ];
            }
        }

        $table = new ilQuestionInternalLinkSelectionTableGUI($this, 'cancelExplorer', __METHOD__);
        $table->setTitle($this->lng->txt('obj_' . ilUtil::stripSlashes($this->request_data_collector->string('search_link_type'))));
        $table->setData($rows);

        $this->tpl->setContent($table->getHTML());
    }

    public function outChapterSelector(): void
    {
        $this->ctrl->setParameter($this, 'q_id', $this->object->getId());

        $cont_obj_gui = new ilObjContentObjectGUI('', $this->request_data_collector->int('source_id'), true);
        $cont_obj = $cont_obj_gui->getObject();
        $ctree = $cont_obj->getLMTree();
        $nodes = $ctree->getSubtree($ctree->getNodeData($ctree->getRootId()));

        $rows = [];

        foreach ($nodes as $node) {
            if ($node['type'] == $this->request_data_collector->raw('search_link_type')) {
                $this->ctrl->setParameter($this, $node['type'], $node['obj_id']);
                $rows[] = [
                    'title' => $node['title'],
                    'description' => '',
                    'text_add' => $this->lng->txt('add'),
                    'href_add' => $this->ctrl->getLinkTarget($this, 'add' . strtoupper($node['type']))
                ];
            }
        }

        $table = new ilQuestionInternalLinkSelectionTableGUI($this, 'cancelExplorer', __METHOD__);
        $table->setTitle($this->lng->txt('obj_' . ilUtil::stripSlashes($this->request_data_collector->string('search_link_type'))));
        $table->setData($rows);

        $this->tpl->setContent($table->getHTML());
    }

    public function outGlossarySelector(): void
    {
        $this->ctrl->setParameter($this, 'q_id', $this->object->getId());

        $glossary = new ilObjGlossary($this->request_data_collector->int('source_id'), true);
        $terms = $glossary->getTermList();

        $rows = [];

        foreach ($terms as $term) {
            $this->ctrl->setParameter($this, 'git', $term['id']);
            $rows[] = [
                'title' => $term['term'],
                'description' => '',
                'text_add' => $this->lng->txt('add'),
                'href_add' => $this->ctrl->getLinkTarget($this, 'addGIT')
            ];
        }

        $table = new ilQuestionInternalLinkSelectionTableGUI($this, 'cancelExplorer', __METHOD__);
        $table->setTitle($this->lng->txt('glossary_term'));
        $table->setData($rows);

        $this->tpl->setContent($table->getHTML());
    }

    protected function createSuggestedSolutionLinkingTo(string $type, string $target)
    {
        $repo = $this->getSuggestedSolutionsRepo();
        $question_id = $this->object->getId();
        $subquestion_index = $this->request_data_collector->int('subquestion_index');
        $subquestion_index = ($subquestion_index > 0) ? $subquestion_index : 0;

        $solution = $repo->create($question_id, $type)
            ->withSubquestionIndex($subquestion_index)
            ->withInternalLink($target);

        $repo->update([$solution]);
    }

    public function linkChilds(): void
    {
        $this->ctrl->saveParameter($this, ["subquestion_index", "link_new_type", "search_link_type"]);
        switch ($this->request_data_collector->string("search_link_type")) {
            case "pg":
                $this->outPageSelector();
                break;
            case "st":
                $this->outChapterSelector();
                break;
            case "glo":
                $this->outGlossarySelector();
                break;
            case "lm":
                $target = "il__lm_" . $this->request_data_collector->raw("source_id");
                $this->createSuggestedSolutionLinkingTo('lm', $target);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("suggested_solution_added_successfully"), true);
                $this->ctrl->redirect($this, 'suggestedsolution');
                break;
        }
    }

    public function addPG(): void
    {
        $target = "il__pg_" . $this->request_data_collector->raw("pg");
        $this->createSuggestedSolutionLinkingTo('pg', $target);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("suggested_solution_added_successfully"), true);
        $this->ctrl->redirect($this, 'suggestedsolution');
    }

    public function addST(): void
    {
        $target = "il__st_" . $this->request_data_collector->raw("st");
        $this->createSuggestedSolutionLinkingTo('st', $target);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("suggested_solution_added_successfully"), true);
        $this->ctrl->redirect($this, 'suggestedsolution');
    }

    public function addGIT(): void
    {
        $target = "il__git_" . $this->request_data_collector->raw("git");
        $this->createSuggestedSolutionLinkingTo('git', $target);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("suggested_solution_added_successfully"), true);
        $this->ctrl->redirect($this, 'suggestedsolution');
    }

    public function isSaveCommand(): bool
    {
        return in_array($this->ctrl->getCmd(), self::QUESTION_SAVE_CMDS);
    }

    public static function getCommandsFromClassConstants(
        string $guiClassName,
        string $cmdConstantNameBegin = 'CMD_'
    ): array {
        $reflectionClass = new ReflectionClass($guiClassName);

        $commands = null;

        if ($reflectionClass instanceof ReflectionClass) {
            $commands = [];

            foreach ($reflectionClass->getConstants() as $constName => $constValue) {
                if (substr($constName, 0, strlen($cmdConstantNameBegin)) == $cmdConstantNameBegin) {
                    $commands[] = $constValue;
                }
            }
        }

        return $commands;
    }

    public function setQuestionTabs(): void
    {
        $this->tabs_gui->clearTargets();

        if ($this->object->getId() > 0) {
            $this->setDefaultTabs($this->tabs_gui);
            $this->setQuestionSpecificTabs($this->tabs_gui);
            $this->tabs_gui->activateTab('edit_question');
        }
        $this->addBackTab($this->tabs_gui);
    }

    protected function setDefaultTabs(ilTabsGUI $tabs_gui): void
    {
        $this->ctrl->setParameterByClass(ilAssQuestionPageGUI::class, 'q_id', $this->object->getId());
        $this->ctrl->setParameterByClass(static::class, 'q_id', $this->object->getId());

        $this->addTab_Question($tabs_gui);
        $this->addTab_QuestionFeedback($tabs_gui);
        $this->addTab_QuestionHints($tabs_gui);
        $this->addTab_SuggestedSolution($tabs_gui, static::class);
    }

    protected function setQuestionSpecificTabs(ilTabsGUI $tabs_gui): void
    {
    }

    public function addTab_SuggestedSolution(ilTabsGUI $tabs, string $classname): void
    {
        $this->ctrl->setParameterByClass($classname, 'q_id', $this->object->getId());
        $tabs->addTarget(
            'suggested_solution',
            $this->ctrl->getLinkTargetByClass($classname, 'suggestedsolution'),
            [
                'suggestedsolution',
                'saveSuggestedSolution',
                'outSolutionExplorer',
                'cancel',
                'addSuggestedSolution',
                'cancelExplorer' ,
                'linkChilds',
                'removeSuggestedSolution'
            ]
        );
    }

    final public function getEditQuestionTabCommands(): array
    {
        return array_merge($this->getBasicEditQuestionTabCommands(), $this->getAdditionalEditQuestionCommands());
    }

    protected function getBasicEditQuestionTabCommands(): array
    {
        return ['editQuestion', 'save', 'originalSyncForm'];
    }

    protected function getAdditionalEditQuestionCommands(): array
    {
        return [];
    }

    protected function addTab_QuestionFeedback(ilTabsGUI $tabs): void
    {
        $tabCommands = self::getCommandsFromClassConstants(ilAssQuestionFeedbackEditingGUI::class);

        $this->ctrl->setParameterByClass(ilAssQuestionFeedbackEditingGUI::class, 'q_id', $this->object->getId());
        $tabLink = $this->ctrl->getLinkTargetByClass(ilAssQuestionFeedbackEditingGUI::class, ilAssQuestionFeedbackEditingGUI::CMD_SHOW);

        $tabs->addTarget('feedback', $tabLink, $tabCommands, $this->ctrl->getCmdClass(), '');
    }

    protected function addTab_QuestionHints(ilTabsGUI $tabs): void
    {
        switch (strtolower($this->ctrl->getCmdClass())) {
            case 'ilassquestionhintsgui':
                $tab_commands = self::getCommandsFromClassConstants(ilAssQuestionHintsGUI::class);
                break;

            case 'ilassquestionhintgui':
                $tab_commands = self::getCommandsFromClassConstants(ilAssQuestionHintGUI::class);
                break;

            default:
                $tab_commands = [];
        }

        $this->ctrl->setParameterByClass(ilAssQuestionHintsGUI::class, 'q_id', $this->object->getId());
        $tabs->addTarget(
            'tst_question_hints_tab',
            $this->ctrl->getLinkTargetByClass(ilAssQuestionHintsGUI::class, ilAssQuestionHintsGUI::CMD_SHOW_LIST),
            $tab_commands,
            $this->ctrl->getCmdClass(),
            ''
        );
    }

    protected function addTab_Question(ilTabsGUI $tabs_gui): void
    {
        $tabs_gui->addTarget(
            'edit_question',
            $this->ctrl->getLinkTargetByClass(
                static::class,
                'editQuestion'
            ),
            'editQuestion',
            '',
            '',
            false
        );
    }

    protected function hasCorrectSolution($activeId, $passIndex): bool
    {
        $reachedPoints = $this->object->getAdjustedReachedPoints((int) $activeId, (int) $passIndex, true);
        $maximumPoints = $this->object->getMaximumPoints();

        return $reachedPoints == $maximumPoints;
    }

    public function isAutosaveable(): bool
    {
        return $this->object instanceof QuestionAutosaveable;
    }

    protected function writeQuestionGenericPostData(): void
    {
        $this->object->setTitle($this->request_data_collector->string('title'));
        $this->object->setAuthor($this->request_data_collector->string('author'));
        $this->object->setComment($this->request_data_collector->string('comment'));

        $nr_of_tries = $this->request_data_collector->int('nr_of_tries');
        if ($this->object->getSelfAssessmentEditingMode()) {
            $this->object->setNrOfTries($nr_of_tries);
        }

        try {
            $lifecycle = ilAssQuestionLifecycle::getInstance(
                $this->request_data_collector->string('lifecycle')
            );
            $this->object->setLifecycle($lifecycle);
        } catch (ilTestQuestionPoolInvalidArgumentException $e) {
        }

        $this->object->setQuestion(
            ilUtil::stripOnlySlashes(
                $this->request_data_collector->string('question')
            )
        );

        $this->setTestSpecificProperties();
    }

    final public function outQuestionForTest(
        string $formaction,
        int $active_id,
        ?int $pass,
        bool $is_question_postponed = false,
        array|bool $user_post_solutions = false,
        bool $show_specific_inline_feedback = false
    ): void {
        $formaction = $this->completeTestOutputFormAction($formaction, $active_id, $pass);

        $test_output = $this->getTestOutput(
            $active_id,
            $pass,
            $is_question_postponed,
            $user_post_solutions,
            $show_specific_inline_feedback
        );

        $this->magicAfterTestOutput();

        $this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
        $this->tpl->setVariable("FORMACTION", $formaction);
        $this->tpl->setVariable("ENCTYPE", 'enctype="' . $this->getFormEncodingType() . '"');
        $this->tpl->setVariable("FORM_TIMESTAMP", (string) time());
    }

    protected function completeTestOutputFormAction(
        string $form_action,
        int $active_id,
        int $pass
    ): string {
        return $form_action;
    }

    public function magicAfterTestOutput(): void
    {
        return;
    }

    public function getFormEncodingType(): string
    {
        return self::FORM_ENCODING_URLENCODE;
    }

    protected function addBackTab(ilTabsGUI $tabs_gui): void
    {
        if ($this->object->getId() <= 0) {
            $tabs_gui->setBackTarget(
                $this->lng->txt('cancel'),
                $this->ctrl->getParentReturnByClass(
                    ilObjectFactory::getClassByType(
                        ilObject::_lookupType($this->object->getObjId())
                    ) . 'GUI'
                )
            );
            return;
        }
        $this->ctrl->setParameterByClass(
            ilAssQuestionPreviewGUI::class,
            'q_id',
            $this->object->getId()
        );
        $this->ctrl->saveParameterByClass(ilAssQuestionPreviewGUI::class, 'prev_qid');
        $tabs_gui->setBackTarget(
            $this->lng->txt('backtocallingpage'),
            $this->ctrl->getLinkTargetByClass(
                ilAssQuestionPreviewGUI::class,
                ilAssQuestionPreviewGUI::CMD_SHOW
            )
        );
        $this->ctrl->clearParameterByClass(ilAssQuestionPreviewGUI::class, 'prev_qid');
    }

    public function setPreviewSession(ilAssQuestionPreviewSession $preview_session): void
    {
        $this->preview_session = $preview_session;
    }

    public function getPreviewSession(): ?ilAssQuestionPreviewSession
    {
        return $this->preview_session;
    }

    protected function buildBasicEditFormObject(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setId($this->getType());
        $form->setTitle($this->outQuestionType());
        $form->setTableWidth('100%');
        $form->setMultipart(true);
        return $form;
    }

    public function showHints(): void
    {
        $this->ctrl->redirectByClass(ilAssQuestionHintsGUI::class, ilAssQuestionHintsGUI::CMD_SHOW_LIST);
    }

    protected function escapeTemplatePlaceholders(string $text): string
    {
        return str_replace(['{','}'], ['&#123;','&#125;'], $text);
    }

    protected function buildEditForm(): ilPropertyFormGUI
    {
        $this->editQuestion(true); // TODO bheyser: editQuestion should be added to the abstract base class with a unified signature
        return $this->editForm;
    }

    public function buildFocusAnchorHtml(): string
    {
        return '<div id="focus"></div>';
    }

    public function isAnswerFrequencyStatisticSupported(): bool
    {
        return true;
    }

    public function getSubQuestionsIndex(): array
    {
        return [0];
    }

    public function getAnswersFrequency($relevantAnswers, $questionIndex): array
    {
        return [];
    }

    public function getAnswerFrequencyTableGUI($parentGui, $parentCmd, $relevantAnswers, $questionIndex): ilAnswerFrequencyStatisticTableGUI
    {
        $table = new ilAnswerFrequencyStatisticTableGUI($parentGui, $parentCmd, $this->object);
        $table->setQuestionIndex($questionIndex);
        $table->setData($this->getAnswersFrequency($relevantAnswers, $questionIndex));
        $table->initColumns();
        return $table;
    }

    public function prepareReprintableCorrectionsForm(ilPropertyFormGUI $form): void
    {
    }

    public function populateCorrectionsFormProperties(ilPropertyFormGUI $form): void
    {
    }

    public function saveCorrectionsFormProperties(ilPropertyFormGUI $form): void
    {
    }


    protected function generateCorrectnessIconsForCorrectness(int $correctness): string
    {
        switch ($correctness) {
            case self::CORRECTNESS_NOT_OK:
                $icon_name = 'standard/icon_not_ok.svg';
                $label = $this->lng->txt("answer_is_wrong");
                break;
            case self::CORRECTNESS_MOSTLY_OK:
                $icon_name = 'standard/icon_mostly_ok.svg';
                $label = $this->lng->txt("answer_is_not_correct_but_positive");
                break;
            case self::CORRECTNESS_OK:
                $icon_name = 'standard/icon_ok.svg';
                $label = $this->lng->txt("answer_is_right");
                break;
            default:
                return '';
        }
        $path = ilUtil::getImagePath($icon_name);
        $icon = $this->ui->factory()->symbol()->icon()->custom(
            $path,
            $label
        );
        return $this->ui->renderer()->render($icon);
    }

    public static function prepareTextareaOutput(
        ?string $txt_output,
        bool $prepare_for_latex_output = false,
        bool $omitNl2BrWhenTextArea = false
    ): string {
        if ($txt_output === null || $txt_output === '') {
            return '';
        }

        $result = $txt_output;
        $is_html = false;

        if (strlen(strip_tags($result)) < strlen($result)) {
            $is_html = true;
        }

        // removed: did not work with magic_quotes_gpc = On
        if (!$is_html) {
            if (!$omitNl2BrWhenTextArea) {
                // if the string does not contain HTML code, replace the newlines with HTML line breaks
                $result = preg_replace("/[\n]/", "<br />", $result);
            }
        } else {
            // patch for problems with the <pre> tags in tinyMCE
            if (preg_match_all("/(<pre>.*?<\/pre>)/ims", $result, $matches)) {
                foreach ($matches[0] as $found) {
                    $replacement = "";
                    if (strpos("\n", $found) === false) {
                        $replacement = "\n";
                    }
                    $removed = preg_replace("/<br\s*?\/>/ims", $replacement, $found);
                    $result = str_replace($found, $removed, $result);
                }
            }
        }

        // since server side mathjax rendering does include svg-xml structures that indeed have linebreaks,
        // do latex conversion AFTER replacing linebreaks with <br>. <svg> tag MUST NOT contain any <br> tags.
        if ($prepare_for_latex_output) {
            $result = ilMathJax::getInstance()->insertLatexImages($result, "<span class\=\"latex\">", "<\/span>");
            $result = ilMathJax::getInstance()->insertLatexImages($result, "\[tex\]", "\[\/tex\]");
        }

        if ($prepare_for_latex_output) {
            // replace special characters to prevent problems with the ILIAS template system
            // eg. if someone uses {1} as an answer, nothing will be shown without the replacement
            $result = str_replace("{", "&#123;", $result);
            $result = str_replace("}", "&#125;", $result);
            $result = str_replace("\\", "&#92;", $result);
        }

        return $result;
    }

    protected ?SuggestedSolutionsDatabaseRepository $suggestedsolution_repo = null;
    protected function getSuggestedSolutionsRepo(): SuggestedSolutionsDatabaseRepository
    {
        if (is_null($this->suggestedsolution_repo)) {
            $dic = QuestionPoolDIC::dic();
            $this->suggestedsolution_repo = $dic['question.repo.suggestedsolutions'];
        }
        return $this->suggestedsolution_repo;
    }

    protected function cleanupAnswerText(array $answer_text, bool $is_rte): array
    {
        if (!is_array($answer_text)) {
            return [];
        }

        if ($is_rte) {
            return ilArrayUtil::stripSlashesRecursive(
                $answer_text,
                false,
                ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")
            );
        }

        return ilArrayUtil::stripSlashesRecursive(
            $answer_text,
            true,
            self::ALLOWED_PLAIN_TEXT_TAGS
        );
    }

    public function isInLearningModuleContext(): bool
    {
        return $this->parent_type_is_lm;
    }
    public function setInLearningModuleContext(bool $flag): void
    {
        $this->parent_type_is_lm = $flag;
    }

    protected function addSaveOnEnterOnLoadCode(): void
    {
        $this->tpl->addOnloadCode("
            let form = document.querySelector('#ilContentContainer form');
            let button = form.querySelector('input[name=\"cmd[save]\"]');
            if (form && button) {
                form.addEventListener('keydown', function (e) {
                    if (e.key === 'Enter'
                        && e.target.type !== 'textarea'
                        && e.target.type !== 'submit'
                        && e.target.type !== 'file'
                    ) {
                        e.preventDefault();
                        form.requestSubmit(button);
                    }
                })
            }
        ");
    }

    public function cmdNeedsExistingQuestion(string $cmd): bool
    {
        return in_array($cmd, static::ADDITIONAL_CMDS_NEEDING_EXISTING_QST);
    }

    public function setContextAllowsSyncToPool(bool $sync_allowed): void
    {
        $this->context_allows_sync_to_pool = $sync_allowed;
    }

    public function needsSyncQuery(): bool
    {
        return $this->context_allows_sync_to_pool
            && $this->object->hasWritableOriginalInQuestionPool();
    }

    public function getQuestionSyncModal(string $cmd, string $cmd_class = ''): string
    {
        if ($cmd_class === '') {
            $cmd_class = static::class;
        }
        $modal = $this->ui->factory()->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt('confirm_sync_questions'),
            $this->ctrl->getFormActionByClass($cmd_class, $cmd)
        )->withAffectedItems([
            $this->ui->factory()->modal()->interruptiveItem()->standard(
                (string) $this->object->getOriginalId(),
                $this->object->getTitleForHTMLOutput()
            )
        ])->withActionButtonLabel($this->lng->txt('sync_question_to_pool'));
        return $this->ui->renderer()->render(
            $modal->withOnLoad($modal->getShowSignal())
        );
    }

    public function getAutoSavedSolutionOutput(
        int $active_id,
        int $pass,
        bool $graphical_output = false,
        bool $result_output = false,
        bool $show_question_only = true,
        bool $show_feedback = false,
        bool $show_correct_solution = false,
        bool $show_manual_scoring = false,
        bool $show_question_text = true,
        bool $show_autosave_title = false,
        bool $show_inline_feedback = false
    ): ?string {
        $autosave_solutions = $this->object->getSolutionValues($active_id, $pass, false);
        if ($autosave_solutions === []) {
            return null;
        }
        return $this->renderSolutionOutput(
            $autosave_solutions,
            $active_id,
            $pass,
            $graphical_output,
            $result_output,
            $show_question_only,
            $show_feedback,
            $show_correct_solution,
            $show_manual_scoring,
            $show_question_text,
            $show_autosave_title,
            $show_inline_feedback
        );
    }
}