class.TestScoringByParticipantGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\Scoring\Manual;

use ILIAS\Test\Presentation\TabsManager;
use ILIAS\Test\Logging\TestScoringInteractionTypes;
use ILIAS\Test\Logging\AdditionalInformationGenerator;
use ilInfoScreenGUI;
use ilObjTestGUI;

class TestScoringByParticipantGUI extends \ilTestServiceGUI
{
    public const PART_FILTER_ALL_USERS = 3; // default
    public const PART_FILTER_MANSCORING_DONE = 4;
    public const PART_FILTER_MANSCORING_NONE = 5;

    protected \ilTestAccess $test_access;

    public function __construct(\ilObjTest $object)
    {
        parent::__construct($object);
    }

    public function getTestAccess(): \ilTestAccess
    {
        return $this->test_access;
    }

    public function setTestAccess($test_access)
    {
        $this->test_access = $test_access;
    }

    protected function buildSubTabs(string $active_sub_tab = 'man_scoring_by_qst'): void
    {
        $this->tabs->addSubTab(
            'man_scoring_by_qst',
            $this->lng->txt('tst_man_scoring_by_qst'),
            $this->ctrl->getLinkTargetByClass([\ilObjTestGUI::class, TestScoringByQuestionGUI::class], 'showManScoringByQuestionParticipantsTable')
        );
        $this->tabs->addSubTab(
            'man_scoring',
            $this->lng->txt('tst_man_scoring_by_part'),
            $this->ctrl->getLinkTargetByClass([\ilObjTestGUI::class, self::class], 'showManScoringParticipantsTable')
        );
        $this->tabs->setSubTabActive($active_sub_tab);
    }

    private function fetchActiveIdParameter(): int
    {
        if (!$this->testrequest->isset('active_id') || $this->testrequest->int('active_id') === 0) {
            $this->tpl->setOnScreenMessage('failure', 'no active id given!', true);
            $this->ctrl->redirectByClass([\ilRepositoryGUI::class, \ilObjTestGUI::class, \ilInfoScreenGUI::class]);
        }

        return $this->testrequest->int('active_id');
    }

    private function fetchPassParameter(int $active_id): int
    {
        $max_pass = $this->object->_getMaxPass($active_id);


        if ($this->testrequest->isset('pass')) {
            $pass_from_request = $this->testrequest->int('pass');
            if ($pass_from_request >= 0
                && $pass_from_request <= $max_pass
            ) {
                return $pass_from_request;
            }
        }

        if ($this->object->getPassScoring() === \ilObjTest::SCORE_LAST_PASS) {
            return $max_pass;
        }

        return $this->object->_getResultPass($active_id);
    }

    public function executeCommand(): void
    {
        if (!$this->getTestAccess()->checkScoreParticipantsAccess()
            && !$this->getTestAccess()->checkScoreParticipantsAccessAnon()
        ) {
            \ilObjTestGUI::accessViolationRedirect();
        }

        if (!$this->object->getGlobalSettings()->isManualScoringEnabled()) {
            // allow only if at least one question type is marked for manual scoring
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("manscoring_not_allowed"), true);
            $this->ctrl->redirectByClass([ilRepositoryGUI::class, ilObjTestGUI::class, ilInfoScreenGUI::class]);
        }

        $this->tabs->activateTab(TabsManager::TAB_ID_MANUAL_SCORING);
        $this->buildSubTabs($this->getActiveSubTabId());

        $command = $this->ctrl->getCmd($this->getDefaultCommand());
        $this->$command();
    }

    protected function getDefaultCommand(): string
    {
        return 'manscoring';
    }

    protected function getActiveSubTabId(): string
    {
        return 'man_scoring';
    }

    private function showManScoringParticipantsTable(): void
    {
        $table = $this->buildManScoringParticipantsTable(true);
        $this->tpl->setContent($table->getHTML());
    }

    private function applyManScoringParticipantsFilter(): void
    {
        $table = $this->buildManScoringParticipantsTable(false);
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->showManScoringParticipantsTable();
    }

    private function resetManScoringParticipantsFilter(): void
    {
        $table = $this->buildManScoringParticipantsTable(false);
        $table->resetOffset();
        $table->resetFilter();

        $this->showManScoringParticipantsTable();
    }

    private function showManScoringParticipantScreen(?\ilPropertyFormGUI $form = null): void
    {
        $active_id = $this->fetchActiveIdParameter();

        if (!$this->getTestAccess()->checkScoreParticipantsAccessForActiveId($active_id, $this->object->getTestId())) {
            \ilObjTestGUI::accessViolationRedirect();
        }

        $pass = $this->fetchPassParameter($active_id);

        $content_html = '';

        $table = new TestScoringByParticipantPassesOverviewTableGUI($this, 'showManScoringParticipantScreen');

        $user_id = $this->object->_getUserIdFromActiveId($active_id);
        $user_fullname = $this->object->userLookupFullName($user_id, false, true);
        $participant_name = $this->getUserNamePresentation(
            $active_id,
            $pass,
            $user_fullname
        );
        $table_title = sprintf($this->lng->txt('tst_pass_overview_for_participant'), $participant_name);
        $table->setTitle($table_title);

        $passOverviewData = $this->service->getPassOverviewData($active_id);
        $table->setData($passOverviewData['passes']);

        $content_html .= $table->getHTML() . '<br />';

        if ($form === null) {
            $question_gui_list = $this->getManScoringQuestionGuiList($active_id, $pass);
            $form = $this->buildManScoringParticipantForm($question_gui_list, $active_id, $pass, true);
        }

        $content_html .= $form->getHTML();

        $this->tpl->setContent($content_html);
    }

    private function saveManScoringParticipantScreen(bool $redirect = true): bool
    {
        $active_id = $this->fetchActiveIdParameter();

        if (!$this->getTestAccess()->checkScoreParticipantsAccessForActiveId($active_id, $this->object->getTestId())) {
            \ilObjTestGUI::accessViolationRedirect();
        }

        $attempt = $this->fetchPassParameter($active_id);

        $question_gui_list = $this->getManScoringQuestionGuiList($active_id, $attempt);
        $form = $this->buildManScoringParticipantForm($question_gui_list, $active_id, $attempt, false);

        $form->setValuesByPost();

        if (!$form->checkInput()) {
            $this->tpl->setOnScreenMessage('failure', sprintf($this->lng->txt('tst_save_manscoring_failed'), $attempt + 1));
            $this->showManScoringParticipantScreen($form);
            return false;
        }

        $max_points_by_question_id = [];
        $max_points_exceeded = false;
        foreach (array_keys($question_gui_list) as $question_id) {
            $reached_points = $form->getItemByPostVar("question__{$question_id}__points")->getValue();
            $max_points = $this->questionrepository->getForQuestionId($question_id)->getAvailablePoints();

            if ($reached_points > $max_points) {
                $max_points_exceeded = true;

                $form->getItemByPostVar("question__{$question_id}__points")->setAlert(sprintf(
                    $this->lng->txt('tst_manscoring_maxpoints_exceeded_input_alert'),
                    $max_points
                ));
            }

            $max_points_by_question_id[$question_id] = $max_points;
        }

        if ($max_points_exceeded) {
            $this->tpl->setOnScreenMessage('failure', sprintf($this->lng->txt('tst_save_manscoring_failed'), $attempt + 1));
            $this->showManScoringParticipantScreen($form);
            return false;
        }

        foreach (array_keys($question_gui_list) as $question_id) {
            $old_points = \assQuestion::_getReachedPoints($active_id, $question_id, $attempt);
            $reached_points = $this->refinery->byTrying([
                $this->refinery->kindlyTo()->float(),
                $this->refinery->always($old_points)
            ])->transform($form->getItemByPostVar("question__{$question_id}__points")?->getValue());

            $finalized = (bool) $form->getItemByPostVar("{$question_id}__evaluated")?->getChecked();
            // fix #35543: save manual points only if they differ from the existing points
            // this prevents a question being set to "answered" if only feedback is entered
            if ($reached_points !== $old_points) {
                \assQuestion::_setReachedPoints(
                    $active_id,
                    $question_id,
                    $reached_points,
                    $max_points_by_question_id[$question_id],
                    $attempt,
                    true
                );
            }

            $feedback_text = \ilUtil::stripSlashes(
                (string) $form->getItemByPostVar("question__{$question_id}__feedback")->getValue(),
                false,
                \ilRTESettings::_getUsedHTMLTagsAsString("assessment")
            );

            $this->object->saveManualFeedback(
                $active_id,
                $question_id,
                $attempt,
                $feedback_text,
                $finalized
            );

            if ($this->logger->isLoggingEnabled()) {
                $this->logger->getInteractionFactory()->buildScoringInteraction(
                    $this->getObject()->getRefId(),
                    $question_id,
                    $this->user->getId(),
                    \ilObjTestAccess::_getParticipantId($active_id),
                    TestScoringInteractionTypes::QUESTION_GRADED,
                    [
                            AdditionalInformationGenerator::KEY_REACHED_POINTS => $reached_points,
                            AdditionalInformationGenerator::KEY_FEEDBACK => $feedback_text,
                            AdditionalInformationGenerator::KEY_EVAL_FINALIZED => $this->logger
                                ->getAdditionalInformationGenerator()->getTrueFalseTagForBool(true)
                        ]
                );
            }

            $notification_data[$question_id] = [
                'points' => $reached_points, 'feedback' => $feedback_text
           ];
        }

        \ilLPStatusWrapper::_updateStatus(
            $this->object->getId(),
            \ilObjTestAccess::_getParticipantId($active_id)
        );

        $manScoringDone = $form->getItemByPostVar("manscoring_done")->getChecked();
        \ilTestService::setManScoringDone($active_id, $manScoringDone);

        $manScoringNotify = $form->getItemByPostVar("manscoring_notify")->getChecked();
        if ($manScoringNotify) {
            $notification = new \ilTestManScoringParticipantNotification(
                $this->object->_getUserIdFromActiveId($active_id),
                $this->object->getRefId()
            );

            $notification->setAdditionalInformation([
                'test_title' => $this->object->getTitle(),
                'test_pass' => $attempt + 1,
                'questions_gui_list' => $question_gui_list,
                'questions_scoring_data' => $notification_data
            ]);

            $notification->send();
        }

        $scorer = new TestScoring($this->object, $this->user, $this->db, $this->test_result_repository);
        $scorer->setPreserveManualScores(true);
        $scorer->recalculateSolution($active_id, $attempt);

        if (!$this->object->getAnonymity()
            && $this->getTestAccess()->checkScoreParticipantsAccess()
        ) {
            $user_name = ilObjUser::_lookupName(ilObjTestAccess::_getParticipantId($active_id));
            $name_real_or_anon = $user_name['firstname'] . ' ' . $user_name['lastname'];
        } else {
            $name_real_or_anon = $this->lng->txt('anonymous');
        }
        $this->tpl->setOnScreenMessage('success', sprintf($this->lng->txt('tst_saved_manscoring_successfully'), $attempt + 1, $name_real_or_anon), true);
        if ($redirect == true) {
            $this->ctrl->redirect($this, 'showManScoringParticipantScreen');
        }
        return true;
    }

    private function saveNextManScoringParticipantScreen(): void
    {
        $table = $this->buildManScoringParticipantsTable(true);

        if ($this->saveManScoringParticipantScreen(false)) {
            $participantData = $table->getInternalyOrderedDataValues();

            $nextIndex = null;
            foreach ($participantData as $index => $participant) {
                if ($participant['active_id'] == $this->testrequest->raw('active_id')) {
                    $nextIndex = $index + 1;
                    break;
                }
            }

            if ($nextIndex && isset($participantData[$nextIndex])) {
                $this->ctrl->setParameter($this, 'active_id', $participantData[$nextIndex]['active_id']);
                $this->ctrl->redirect($this, 'showManScoringParticipantScreen');
            }

            $this->ctrl->redirectByClass(self::class, 'showManScoringParticipantsTable');
        }
    }

    private function saveReturnManScoringParticipantScreen(): void
    {
        if ($this->saveManScoringParticipantScreen(false)) {
            $this->ctrl->redirectByClass(self::class, 'showManScoringParticipantsTable');
        }
    }

    private function buildManScoringParticipantForm(
        array $question_gui_list,
        int $active_id,
        int $pass,
        bool $initValues = false
    ): \ilPropertyFormGUI {
        $this->ctrl->setParameter($this, 'active_id', $active_id);
        $this->ctrl->setParameter($this, 'pass', $pass);

        $form = new \ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));

        $form->setTitle(sprintf($this->lng->txt('manscoring_results_pass'), $pass + 1));
        $form->setTableWidth('100%');

        foreach ($question_gui_list as $question_id => $question_gui) {
            $question_header = sprintf(
                $this->lng->txt('tst_manscoring_question_section_header'),
                $question_gui->getObject()->getTitleForHTMLOutput()
            );
            $question_solution = $question_gui->getSolutionOutput($active_id, $pass, false, false, true, false, false, true);
            $best_solution = $question_gui->getObject()->getSuggestedSolutionOutput();

            $feedback = \ilObjTest::getSingleManualFeedback($active_id, $question_id, $pass);

            $disabled = false;
            if (isset($feedback['finalized_evaluation']) && $feedback['finalized_evaluation'] == 1) {
                $disabled = true;
            }

            $sect = new \ilFormSectionHeaderGUI();
            $sect->setTitle($question_header . ' [' . $this->lng->txt('question_id_short') . ': ' . $question_gui->getObject()->getId() . ']');
            $form->addItem($sect);

            $cust = new \ilCustomInputGUI($this->lng->txt('tst_manscoring_input_question_and_user_solution'));
            $cust->setHtml($question_solution);
            $form->addItem($cust);

            $number_input_gui = new \ilNumberInputGUI(
                $this->lng->txt('tst_change_points_for_question'),
                "question__{$question_id}__points"
            );
            $number_input_gui->allowDecimals(true);

            if ($initValues) {
                $number_input_gui->setValue((string) \assQuestion::_getReachedPoints($active_id, $question_id, $pass));
            }
            if ($disabled) {
                $number_input_gui->setDisabled($disabled);
            }
            $form->addItem($number_input_gui);

            $nonedit = new \ilNonEditableValueGUI($this->lng->txt('tst_manscoring_input_max_points_for_question'), "question__{$question_id}__maxpoints");
            if ($initValues) {
                $nonedit->setValue($this->questionrepository->getForQuestionId($question_id)->getAvailablePoints());
            }
            $form->addItem($nonedit);

            $area = new \ilTextAreaInputGUI($this->lng->txt('set_manual_feedback'), "question__{$question_id}__feedback");
            $area->setUseRTE(true);
            if ($initValues) {
                $area->setValue(\ilObjTest::getSingleManualFeedback((int) $active_id, (int) $question_id, (int) $pass)['feedback'] ?? '');
            }
            if ($disabled) {
                $area->setDisabled($disabled);
            }
            $form->addItem($area);

            $check = new \ilCheckboxInputGUI($this->lng->txt('finalized_evaluation'), "{$question_id}__evaluated");
            if ($disabled) {
                $check->setChecked(true);
            }
            $form->addItem($check);

            if (strlen(trim($best_solution))) {
                $cust = new \ilCustomInputGUI($this->lng->txt('tst_show_solution_suggested'));
                $cust->setHtml($best_solution);
                $form->addItem($cust);
            }
        }

        $sect = new \ilFormSectionHeaderGUI();
        $sect->setTitle($this->lng->txt('tst_participant'));
        $form->addItem($sect);

        $check = new \ilCheckboxInputGUI($this->lng->txt('set_manscoring_done'), 'manscoring_done');
        if ($initValues && \ilTestService::isManScoringDone($active_id)) {
            $check->setChecked(true);
        }
        $form->addItem($check);

        $check = new \ilCheckboxInputGUI($this->lng->txt('tst_manscoring_user_notification'), 'manscoring_notify');
        $form->addItem($check);

        $form->addCommandButton('saveManScoringParticipantScreen', $this->lng->txt('save'));
        $form->addCommandButton('saveReturnManScoringParticipantScreen', $this->lng->txt('save_return'));
        $form->addCommandButton('saveNextManScoringParticipantScreen', $this->lng->txt('save_and_next'));

        return $form;
    }

    private function getManScoringQuestionGuiList(int $active_id, int $pass): array
    {
        $test_result_data = $this->object->getTestResult($active_id, $pass);
        $man_scoring_question_gui_list = [];

        foreach ($test_result_data as $question_data) {
            if (!isset($question_data['qid'])) {
                continue;
            }

            if (!isset($question_data['type'])) {
                throw new ilTestException('no question type given!');
            }

            $man_scoring_question_gui_list[ $question_data['qid'] ] = $this->object
                ->createQuestionGUI('', $question_data['qid']);
        }
        return $man_scoring_question_gui_list;
    }

    private function buildManScoringParticipantsTable(bool $with_data = false): TestScoringByParticipantTableGUI
    {
        $table = new TestScoringByParticipantTableGUI(
            $this,
            $this->object->getAnonOnlyParticipantIds()
        );

        if ($with_data) {
            $participant_list = new \ilTestParticipantList($this->object, $this->user, $this->lng, $this->db);
            $participant_list->initializeFromDbRows(
                $this->object->getTestParticipantsForManualScoring(
                    $table->getFilterItemByPostVar('participant_status')->getValue()
                )
            );

            $table->setData(
                $participant_list->getAccessFilteredList(
                    $this->participant_access_filter->getScoreParticipantsUserFilter($this->ref_id)
                )->getScoringTableRows()
            );
        }

        return $table;
    }

    public function getUserNamePresentation(
        int $active_id,
        int|string $pass,
        ?string $name = null
    ): string {
        $anon_only_usr_ids = $this->object->getAnonOnlyParticipantIds();
        $user_id = $this->object->_getUserIdFromActiveId($active_id);
        if ($name !== null && !in_array($user_id, $anon_only_usr_ids)) {
            return $name;
        }

        return $this->getUserExamId($active_id, (string) $pass);
    }

    public function getUserExamId(int $active_id, string $pass): string
    {
        return \ilObjTest::buildExamId($active_id, $pass, $this->object->getId());
    }
}