class.ilAssQuestionPreviewGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Services as HTTPServices;
use ILIAS\TestQuestionPool\QuestionPoolDIC;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Random\Group as RandomGroup;
use ILIAS\Refinery\Random\Seed\RandomSeed;
use ILIAS\Refinery\Random\Seed\GivenSeed;
use ILIAS\Refinery\Transformation;
use ILIAS\GlobalScreen\Services as GlobalScreen;
use ILIAS\TestQuestionPool\RequestDataCollector;

class ilAssQuestionPreviewGUI
{
    public const CMD_SHOW = 'show';
    public const CMD_RESET = 'reset';
    public const CMD_STATISTICS = 'assessment';
    public const CMD_INSTANT_RESPONSE = 'instantResponse';
    public const CMD_HANDLE_QUESTION_ACTION = 'handleQuestionAction';
    public const CMD_GATEWAY_CONFIRM_HINT_REQUEST = 'gatewayConfirmHintRequest';
    public const CMD_GATEWAY_SHOW_HINT_LIST = 'gatewayShowHintList';

    public const TAB_ID_QUESTION = 'question';

    public const FEEDBACK_FOCUS_ANCHOR = 'focus';

    protected readonly RequestDataCollector $request_data_collector;

    private ?assQuestionGUI $question_gui = null;
    private ?assQuestion $question_obj = null;
    private ?ilAssQuestionPreviewSettings $preview_settings = null;
    private ?ilAssQuestionPreviewSession $preview_session = null;
    private ?ilAssQuestionPreviewHintTracking $hint_tracking = null;

    private ?string $info_message = null;

    private array $primary_cmd = [];

    private array $additional_cmds = [];

    public function __construct(
        private readonly ilCtrl $ctrl,
        private readonly ilRbacSystem $rbac_system,
        private ilTabsGUI $tabs,
        private ilToolbarGUI $toolbar,
        private ilGlobalTemplateInterface $tpl,
        private readonly UIFactory $ui_factory,
        private readonly ilLanguage $lng,
        private readonly ilDBInterface $db,
        private readonly RandomGroup $random_group,
        private readonly GlobalScreen $global_screen,
        private readonly HTTPServices $http,
        private readonly Refinery $refinery,
        private readonly int $parent_obj_ref_id
    ) {
        $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());

        $local_dic = QuestionPoolDIC::dic();
        $this->request_data_collector = $local_dic['request_data_collector'];
    }

    public function setInfoMessage(string $message): void
    {
        $this->info_message = $message;
    }

    public function setPrimaryCmd(string $label, string $cmd): void
    {
        $this->primary_cmd[$label] = $cmd;
    }

    public function addAdditionalCmd(string $label, string $cmd): void
    {
        $this->additional_cmds[$label] = $cmd;
    }

    public function getQuestion(): assQuestion
    {
        return $this->question_obj;
    }

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

    public function initQuestion(assQuestionGUI $question_gui, int $parent_obj_id): void
    {
        $this->question_gui = $question_gui;
        $this->question_obj = $this->question_gui->getObject();

        $this->question_obj->setObjId($parent_obj_id);

        $this->tabs->clearTargets();
        $this->tabs->addTarget(
            self::TAB_ID_QUESTION,
            $this->ctrl->getLinkTargetByClass(self::class, self::CMD_SHOW),
            '',
            [strtolower(__CLASS__)]
        );
        // Assessment of questions sub menu entry
        $q_type = $this->question_obj->getQuestionType();
        $classname = $q_type . 'GUI';
        $this->tabs->addTarget(
            'statistics',
            $this->ctrl->getLinkTargetByClass(self::class, 'assessment'),
            ['assessment'],
            $classname,
            ''
        );

        $this->question_gui->populateJavascriptFilesRequiredForWorkForm($this->tpl);
        $this->question_gui->setTargetGui($this);
        $this->question_gui->setQuestionActionCmd(self::CMD_HANDLE_QUESTION_ACTION);

        $this->question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_DEMOPLAY);
    }

    public function initPreviewSettings(int $parent_ref_id): void
    {
        $this->preview_settings = new ilAssQuestionPreviewSettings($parent_ref_id);

        $this->preview_settings->init();
    }

    public function initPreviewSession(int $user_id, int $question_id): void
    {
        $this->preview_session = new ilAssQuestionPreviewSession($user_id, $question_id);
        $this->preview_session->init();
    }

    public function initHintTracking(): void
    {
        $this->hint_tracking = new ilAssQuestionPreviewHintTracking($this->db, $this->preview_session);
    }

    public function initStyleSheets(): void
    {
        $this->tpl->setCurrentBlock('ContentStyle');
        $this->tpl->setVariable('LOCATION_CONTENT_STYLESHEET', ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->parseCurrentBlock();

        $this->tpl->setCurrentBlock('SyntaxStyle');
        $this->tpl->setVariable('LOCATION_SYNTAX_STYLESHEET', ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
    }

    public function executeCommand(): void
    {
        global $DIC;
        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent('qpl');

        $this->tabs->setTabActive(self::TAB_ID_QUESTION);

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

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

        switch ($nextClass) {
            case 'ilassquestionhintrequestgui':
                $gui = new ilAssQuestionHintRequestGUI(
                    $this,
                    self::CMD_SHOW,
                    $this->question_gui,
                    $this->hint_tracking,
                    $this->ctrl,
                    $this->lng,
                    $this->tpl,
                    $this->tabs,
                    $this->global_screen
                );
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilassspecfeedbackpagegui':
            case 'ilassgenfeedbackpagegui':
                $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->question_obj, $this->ctrl, $this->tabs, $this->lng);
                $forwarder->forward();
                break;
            case 'ilcommentgui':
                $comment_gui = new ilCommentGUI($this->question_obj->getObjId(), $this->question_obj->getId(), 'quest');
                $comments_panel_html = $this->ctrl->forwardCommand($comment_gui);
                $this->showCmd($comments_panel_html);
                break;
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW);
                $this->{$cmd . 'Cmd'}();
        }
    }

    protected function buildPreviewFormAction(): string
    {
        return $this->ctrl->getFormAction($this, self::CMD_SHOW) . '#' . self::FEEDBACK_FOCUS_ANCHOR;
    }

    protected function isCommentingRequired(): bool
    {
        return !$this->preview_settings->isTestRefId() &&
            $this->rbac_system->checkAccess('read', $this->request_data_collector->getRefId());
    }

    public function showCmd(string $commands_panel_html = ''): void
    {
        $tpl = new ilTemplate('tpl.qpl_question_preview.html', true, true, 'components/ILIAS/TestQuestionPool');
        $tpl->setVariable('PREVIEW_FORMACTION', $this->buildPreviewFormAction());

        $modal = '';
        if ($this->question_gui->isSaveCommand() && $this->question_gui->needsSyncQuery()) {
            $modal = $this->question_gui->getQuestionSyncModal(assQuestionGUI::CMD_SYNC_QUESTION_AND_RETURN);
        }

        if ($this->info_message !== null) {
            $this->tpl->setOnScreenMessage('info', $this->info_message, true);
        }

        $this->populateToolbar();
        $this->populateQuestionOutput($tpl);
        $this->handleInstantResponseRendering($tpl);

        if ($this->isCommentingRequired()) {
            $this->populateCommentsPanel($tpl, $commands_panel_html);
        }

        $this->tpl->setContent($tpl->get() . $modal);
    }

    public function assessmentCmd()
    {
        $this->tabs->activateTab('statistics');
        $this->question_gui->assessment();
    }

    public function handleInstantResponseRendering(ilTemplate $tpl): void
    {
        $response_required = false;
        $response_available = false;
        $jump_to_response = false;

        if ($this->isShowReachedPointsRequired()) {
            $this->populateReachedPointsOutput($tpl);
            $response_required = true;
            $response_available = true;
            $jump_to_response = true;
        }

        if ($this->isShowBestSolutionRequired()) {
            $this->populateSolutionOutput($tpl);
            $response_required = true;
            $response_available = true;
            $jump_to_response = true;
        }

        if ($this->isShowGenericQuestionFeedbackRequired()) {
            $response_required = true;
            if ($this->populateGenericQuestionFeedback($tpl)) {
                $response_available = true;
                $jump_to_response = true;
            }
        }

        if ($this->isShowSpecificQuestionFeedbackRequired()) {
            $response_required = true;

            if ($this->question_gui->hasInlineFeedback()) {
                // Don't jump to the feedback below the question if some feedback is shown within the question
                $jump_to_response = false;
            } else {
                if ($this->populateSpecificQuestionFeedback($tpl)) {
                    $response_available = true;
                    $jump_to_response = true;
                }
            }
        }

        if ($response_required) {
            $this->populateInstantResponseHeader($tpl, $jump_to_response);
            if (!$response_available) {
                if ($this->question_gui->hasInlineFeedback()) {
                    $this->populateInstantResponseMessage(
                        $tpl,
                        $this->lng->txt('tst_feedback_is_given_inline')
                    );
                } else {
                    $this->populateInstantResponseMessage(
                        $tpl,
                        $this->lng->txt('tst_feedback_not_available_for_answer')
                    );
                }
            }
        }
    }

    public function resetCmd(): void
    {
        $this->preview_session->setRandomizerSeed(null);
        $this->preview_session->setParticipantsSolution(null);
        $this->preview_session->resetRequestedHints();
        $this->preview_session->setInstantResponseActive(false);

        $this->tpl->setOnScreenMessage('info', $this->lng->txt('qst_preview_reset_msg'), true);

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

    public function instantResponseCmd(): void
    {
        if ($this->saveQuestionSolution()) {
            $this->preview_session->setInstantResponseActive(true);
        } else {
            $this->preview_session->setInstantResponseActive(false);
        }

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

    public function handleQuestionActionCmd(): void
    {
        $this->question_obj->persistPreviewState($this->preview_session);
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

    private function populateToolbar(): void
    {
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this, self::CMD_SHOW));

        if ($this->rbac_system->checkAccess('write', $this->parent_obj_ref_id)) {
            if ($this->primary_cmd !== []) {
                $this->toolbar->addComponent(
                    $this->ui_factory->button()->primary(key($this->primary_cmd), current($this->primary_cmd))
                );
            }
            foreach ($this->additional_cmds as $label => $action) {
                $this->toolbar->addComponent(
                    $this->ui_factory->button()->standard($label, $action)
                );
            }
        }

        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard(
                $this->lng->txt('qpl_reset_preview'),
                $this->ctrl->getLinkTargetByClass(ilAssQuestionPreviewGUI::class, self::CMD_RESET)
            )
        );
    }

    private function populateQuestionOutput(ilTemplate $tpl): void
    {
        // FOR WHAT EXACTLY IS THIS USEFUL?
        $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
        $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');

        $page_gui = new ilAssQuestionPageGUI($this->question_obj->getId());
        $page_gui->setRenderPageContainer(false);
        $page_gui->setEditPreview(true);
        $page_gui->setEnabledTabs(false);

        $this->question_gui->setPreviewSession($this->preview_session);
        $question = $this->question_gui->getObject();
        $question->setShuffler($this->getQuestionAnswerShuffler());
        $this->question_gui->setObject($question);

        $question_html = $this->question_gui->getPreview(true, $this->isShowSpecificQuestionFeedbackRequired());
        $this->question_gui->magicAfterTestOutput();

        $question_html .= $this->getQuestionNavigationHtml();

        $page_gui->setQuestionHTML([$this->question_obj->getId() => $question_html]);

        $page_gui->setPresentationTitle($this->question_obj->getTitleForHTMLOutput());

        $tpl->setVariable('QUESTION_OUTPUT', $page_gui->preview());
        // \ilPageObjectGUI::preview sets an undefined tab, so the "question" tab has to be activated again
        $this->tabs->setTabActive(self::TAB_ID_QUESTION);
    }

    protected function populateReachedPointsOutput(ilTemplate $tpl): void
    {
        $reachedPoints = $this->question_obj->calculateReachedPointsFromPreviewSession($this->preview_session);
        $maxPoints = $this->question_obj->getMaximumPoints();

        $scoreInformation = sprintf(
            $this->lng->txt("you_received_a_of_b_points"),
            $reachedPoints,
            $maxPoints
        );

        $tpl->setCurrentBlock("reached_points_feedback");
        $tpl->setVariable("REACHED_POINTS_FEEDBACK", $scoreInformation);
        $tpl->parseCurrentBlock();
    }

    private function populateSolutionOutput(ilTemplate $tpl): void
    {
        // FOR WHAT EXACTLY IS THIS USEFUL?
        $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
        $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');

        $pageGUI = new ilAssQuestionPageGUI($this->question_obj->getId());

        $pageGUI->setEditPreview(true);
        $pageGUI->setEnabledTabs(false);

        $this->question_gui->setPreviewSession($this->preview_session);

        $pageGUI->setQuestionHTML([$this->question_obj->getId() => $this->question_gui->getSolutionOutput(0, null, false, false, true, false, true, false, false)]);

        $output = $this->question_gui->getSolutionOutput(0, null, false, false, true, false, true, false, false);

        $tpl->setCurrentBlock('solution_output');
        $tpl->setVariable('TXT_CORRECT_SOLUTION', $this->lng->txt('tst_best_solution_is'));
        $tpl->setVariable('SOLUTION_OUTPUT', $output);
        $tpl->parseCurrentBlock();
    }

    private function getQuestionNavigationHtml(): string
    {
        $navGUI = new ilAssQuestionRelatedNavigationBarGUI($this->ctrl, $this->lng);

        $navGUI->setInstantResponseCmd(self::CMD_INSTANT_RESPONSE);
        $navGUI->setHintRequestCmd(self::CMD_GATEWAY_CONFIRM_HINT_REQUEST);
        $navGUI->setHintListCmd(self::CMD_GATEWAY_SHOW_HINT_LIST);

        $navGUI->setInstantResponseEnabled($this->preview_settings->isInstantFeedbackNavigationRequired());
        $navGUI->setHintProvidingEnabled($this->preview_settings->isHintProvidingEnabled());

        $navGUI->setHintRequestsPossible($this->hint_tracking->requestsPossible());
        $navGUI->setHintRequestsExist($this->hint_tracking->requestsExist());

        return $this->ctrl->getHTML($navGUI);
    }

    private function populateGenericQuestionFeedback(ilTemplate $tpl): bool
    {
        if ($this->question_obj->isPreviewSolutionCorrect($this->preview_session)) {
            $feedback = $this->question_gui->getGenericFeedbackOutputForCorrectSolution();
            $cssClass = ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT;
        } else {
            $feedback = $this->question_gui->getGenericFeedbackOutputForIncorrectSolution();
            $cssClass = ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG;
        }

        if ($feedback !== '') {
            $tpl->setCurrentBlock('instant_feedback_generic');
            $tpl->setVariable('GENERIC_FEEDBACK', $feedback);
            $tpl->setVariable('ILC_FB_CSS_CLASS', $cssClass);
            $tpl->parseCurrentBlock();
            return true;
        }
        return false;
    }

    private function populateSpecificQuestionFeedback(ilTemplate $tpl): bool
    {
        $fb = $this->question_gui->getSpecificFeedbackOutput(
            (array) $this->preview_session->getParticipantsSolution()
        );

        if (!empty($fb)) {
            $tpl->setCurrentBlock('instant_feedback_specific');
            $tpl->setVariable('ANSWER_FEEDBACK', $fb);
            $tpl->parseCurrentBlock();
            return true;
        }
        return false;
    }

    protected function populateInstantResponseHeader(ilTemplate $tpl, $withFocusAnchor): void
    {
        if ($withFocusAnchor) {
            $tpl->setCurrentBlock('inst_resp_id');
            $tpl->setVariable('INSTANT_RESPONSE_FOCUS_ID', self::FEEDBACK_FOCUS_ANCHOR);
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock('instant_response_header');
        $tpl->setVariable('INSTANT_RESPONSE_HEADER', $this->lng->txt('tst_feedback'));
        $tpl->parseCurrentBlock();
    }

    protected function populateInstantResponseMessage(ilTemplate $tpl, string $a_message)
    {
        $tpl->setCurrentBlock('instant_response_message');
        $tpl->setVariable('INSTANT_RESPONSE_MESSAGE', $a_message);
        $tpl->parseCurrentBlock();
    }

    private function isShowBestSolutionRequired()
    {
        if (!$this->preview_settings->isBestSolutionEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

    private function isShowGenericQuestionFeedbackRequired()
    {
        if (!$this->preview_settings->isGenericFeedbackEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

    private function isShowSpecificQuestionFeedbackRequired(): bool
    {
        if (!$this->preview_settings->isSpecificFeedbackEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

    private function isShowReachedPointsRequired()
    {
        if (!$this->preview_settings->isReachedPointsEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

    public function saveQuestionSolution(): bool
    {
        return $this->question_obj->persistPreviewState($this->preview_session);
    }

    public function gatewayConfirmHintRequestCmd(): void
    {
        if (!$this->saveQuestionSolution()) {
            $this->preview_session->setInstantResponseActive(false);
            $this->showCmd();
            return;
        }

        $this->ctrl->redirectByClass(
            'ilAssQuestionHintRequestGUI',
            ilAssQuestionHintRequestGUI::CMD_CONFIRM_REQUEST
        );
    }

    public function gatewayShowHintListCmd(): void
    {
        if (!$this->saveQuestionSolution()) {
            $this->preview_session->setInstantResponseActive(false);
            $this->showCmd();
            return;
        }

        $this->ctrl->redirectByClass(
            'ilAssQuestionHintRequestGUI',
            ilAssQuestionHintRequestGUI::CMD_SHOW_LIST
        );
    }

    private function getQuestionAnswerShuffler(): Transformation
    {
        if (!$this->preview_session->randomizerSeedExists()) {
            $this->preview_session->setRandomizerSeed((new RandomSeed())->createSeed());
        }
        return $this->random_group->shuffleArray(new GivenSeed((int) $this->preview_session->getRandomizerSeed()));
    }

    protected function populateCommentsPanel(ilTemplate $tpl, string $comments_panel_html): void
    {
        if ($comments_panel_html === '') {
            $comments_panel_html = $this->question_gui->getCommentsPanelHTML();
        }

        $tpl->setCurrentBlock('notes_panel');
        $tpl->setVariable('NOTES_PANEL', $comments_panel_html);
        $tpl->parseCurrentBlock();
    }
}