class.ilTestParticipantsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Test\ResponseHandler;
use ILIAS\Test\Presentation\TabsManager;
use ILIAS\Test\Participants\ParticipantTable;
use ILIAS\Test\ExportImport\Factory as ExportImportFactory;
use ILIAS\Test\ExportImport\Types as ExportImportTypes;
use ILIAS\Test\RequestDataCollector;
use ILIAS\Test\Results\Data\Factory as ResultsDataFactory;
use ILIAS\Test\Results\Presentation\Factory as ResultsPresentationFactory;
use ILIAS\Test\Participants\ParticipantRepository;
use ILIAS\Test\Participants\ParticipantTableActions;
use ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction;
use ILIAS\Test\Participants\ParticipantTableIpRangeAction;
use ILIAS\Test\Participants\ParticipantTableExtraTimeAction;
use ILIAS\Test\Participants\ParticipantTableFinishTestAction;
use ILIAS\Test\Participants\ParticipantTableDeleteResultsAction;
use ILIAS\Test\Participants\ParticipantTableShowResultsAction;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Test\Results\Data\Repository as TestResultRepository;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\Component\Modal\Modal;

class ilTestParticipantsGUI
{
    public const CMD_SHOW = 'show';

    public const CALLBACK_ADD_PARTICIPANT = 'addParticipants';

    private const EXPORT_TYPE_PARAMETER = 'export_type';
    private const EXPORT_PLUGIN_TYPE_PARAMETER = 'export_plugin_type';

    protected ilTestParticipantAccessFilterFactory $participant_access_filter;

    public function __construct(
        protected ilObjTest $test_obj,
        protected readonly ilObjUser $current_user,
        protected readonly ilTestObjectiveOrientedContainer $objective_parent,
        protected readonly ilTestQuestionSetConfig $question_set_config,
        protected ilAccess $access,
        protected ilTestAccess $test_access,
        protected ilGlobalTemplateInterface $main_tpl,
        protected UIFactory $ui_factory,
        protected UIRenderer $ui_renderer,
        protected ilUIService $ui_service,
        protected DataFactory $data_factory,
        protected ilLanguage $lng,
        protected ilCtrlInterface $ctrl,
        protected Refinery $refinery,
        protected ilDBInterface $db,
        protected TabsManager $tabs_manager,
        protected ilToolbarGUI $toolbar,
        protected ilComponentFactory $component_factory,
        protected ExportImportFactory $export_factory,
        protected RequestDataCollector $testrequest,
        protected ResponseHandler $response_handler,
        protected ParticipantRepository $participant_repository,
        protected readonly ResultsDataFactory $results_data_factory,
        protected readonly ResultsPresentationFactory $results_presentation_factory,
        protected readonly TestResultRepository $test_pass_result_repository
    ) {
        $this->participant_access_filter = new ilTestParticipantAccessFilterFactory($access);
    }

    public function executeCommand(): void
    {
        if (!$this->test_access->checkManageParticipantsAccess()
            && !$this->test_access->checkParticipantsResultsAccess()) {
            ilObjTestGUI::accessViolationRedirect();
        }
        switch ($this->ctrl->getNextClass($this)) {
            case 'ilrepositorysearchgui':
                $gui = new ilRepositorySearchGUI();
                $gui->setCallback($this, self::CALLBACK_ADD_PARTICIPANT, []);

                $gui->addUserAccessFilterCallable($this->participant_access_filter->getManageParticipantsUserFilter(
                    $this->test_obj->getRefId()
                ));


                $this->ctrl->setReturnByClass(self::class, self::CMD_SHOW);
                $this->ctrl->forwardCommand($gui);

                break;

            default:
                $command = $this->ctrl->getCmd(self::CMD_SHOW) . 'Cmd';
                $this->{$command}();
        }
    }

    public function addParticipants($user_ids = []): ?bool
    {
        $filter_closure = $this->participant_access_filter->getManageParticipantsUserFilter($this->test_obj->getRefId());
        $filtered_user_ids = $filter_closure($user_ids);

        $users_count = 0;
        $client_ips = $this->testrequest->retrieveArrayOfStringsFromPost('client_ip');
        foreach ($filtered_user_ids as $user_id) {
            $this->test_obj->inviteUser($user_id, $client_ips[$users_count] ?? '');
            $users_count++;
        }

        $message = '';
        if ($users_count > 0) {
            $message = $this->lng->txt('tst_invited_selected_users');
        }
        if ($message !== '') {
            $this->main_tpl->setOnScreenMessage('info', $message, true);
        } else {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('tst_invited_nobody'), true);
            return false;
        }

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

    public function showCmd(?Modal $modal = null): void
    {
        $this->addUserSearchControls($this->toolbar);

        if ($this->test_obj->evalTotalPersons() > 0) {
            $this->addExportDropdown($this->toolbar);
        }

        $components = $this->getParticipantTable()->getComponents(
            $this->getTableActionUrlBuilder(),
            $this->ctrl->getLinkTargetByClass(self::class, 'show')
        );

        if ($modal !== null) {
            $components[] = $modal;
        }

        $this->main_tpl->setContent(
            $this->ui_renderer->render($components)
        );
    }

    public function executeTableActionCmd(): void
    {
        $modal = $this->getParticipantTable()->execute($this->getTableActionUrlBuilder());
        if ($modal !== null) {
            $this->showCmd($modal);
            return;
        }
        $this->ctrl->redirectByClass(self::class, self::CMD_SHOW);
    }

    private function getParticipantTable(): ParticipantTable
    {
        return new ParticipantTable(
            $this->ui_factory,
            $this->ui_service,
            $this->lng,
            $this->test_access,
            $this->testrequest,
            $this->participant_access_filter,
            $this->participant_repository,
            $this->results_data_factory,
            $this->results_presentation_factory->getAttemptResultsSettings(
                $this->test_obj,
                false
            ),
            $this->current_user,
            $this->test_obj,
            $this->buildParticipantTableActions()
        );
    }

    private function getTableActionUrlBuilder(): URLBuilder
    {
        $uri = $this->ctrl->getLinkTargetByClass(self::class, 'executeTableAction', '', true);
        return new URLBuilder($this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $uri));
    }

    protected function addUserSearchControls(ilToolbarGUI $toolbar): void
    {
        if (!$this->test_access->checkManageParticipantsAccess()) {
            return;
        }
        ilRepositorySearchGUI::fillAutoCompleteToolbar(
            $this,
            $toolbar,
            [
                'auto_complete_name' => $this->lng->txt('user'),
                'submit_name' => $this->lng->txt('add')
            ]
        );
        $toolbar->addSeparator();

        $search_btn = $this->ui_factory->button()->standard(
            $this->lng->txt('tst_search_users'),
            $this->ctrl->getLinkTargetByClass('ilRepositorySearchGUI', 'start')
        );
        $toolbar->addComponent($search_btn);
    }

    private function addExportDropdown(ilToolbarGUI $toolbar): void
    {
        if ($this->test_access->checkManageParticipantsAccess()) {
            $toolbar->addSeparator();
        }

        $this->ctrl->clearParameterByClass(self::class, 'export_type');
        $toolbar->addComponent(
            $this->ui_factory->dropdown()->standard(
                $this->buildOptionsForTestWithNames()
            )->withLabel($this->lng->txt('exp_eval_data'))
        );
    }

    private function buildOptionsForTestWithNames(): array
    {
        $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::SCORED_ATTEMPT->value);
        $options = [
            $this->ui_factory->button()->shy(
                $this->lng->txt('exp_scored_test_attempt'),
                $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
            )
        ];
        $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::ALL_ATTEMPTS->value);
        $options[] = $this->ui_factory->button()->shy(
            $this->lng->txt('exp_all_test_runs'),
            $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
        );
        $options = $this->addPluginExportsToOptions($options);
        return $this->addCertificateExportToOptions($options);
    }

    private function addCertificateExportToOptions(array $options): array
    {
        try {
            if ((new ilCertificateActiveValidator())->validate()) {
                $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::CERTIFICATE_ARCHIVE->value);
                $options[] = $this->ui_factory->button()->shy(
                    $this->lng->txt('exp_grammar_as') . ' ' . $this->lng->txt('exp_type_certificate'),
                    $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
                );
            }
        } catch (ilException $e) {
        }
        return $options;
    }

    private function addPluginExportsToOptions(array $options): array
    {
        foreach ($this->component_factory->getActivePluginsInSlot('texp') as $plugin) {
            $plugin->setTest($this->test_obj);
            $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::PLUGIN->value);
            $this->ctrl->setParameterByClass(self::class, self::EXPORT_PLUGIN_TYPE_PARAMETER, $plugin->getFormat());
            $options[] = $this->ui_factory->button()->shy(
                $plugin->getFormatLabel(),
                $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
            );
        }
        $this->ctrl->clearParameterByClass(self::class, self::EXPORT_PLUGIN_TYPE_PARAMETER);
        return $options;
    }

    public function exportResultsCmd(): void
    {
        $export_type = ExportImportTypes::tryFrom(
            $this->testrequest->strVal(self::EXPORT_TYPE_PARAMETER)
        );

        if ($export_type === null) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('error'));
            $this->showCmd();
            return;
        }

        $plugin_type = null;
        if ($export_type === ExportImportTypes::PLUGIN) {
            $plugin_type = $this->testrequest->strVal(self::EXPORT_PLUGIN_TYPE_PARAMETER);
        }

        $this->export_factory->getExporter(
            $this->test_obj,
            $export_type,
            $plugin_type
        )->deliver();
        $this->showCmd();
    }

    private function buildParticipantTableActions(): ParticipantTableActions
    {
        return new ParticipantTableActions(
            $this->ctrl,
            $this->lng,
            $this->main_tpl,
            $this->ui_factory,
            $this->ui_renderer,
            $this->refinery,
            $this->testrequest,
            $this->response_handler,
            $this->participant_repository,
            $this->test_obj,
            [
                ParticipantTableShowResultsAction::ACTION_ID => new ParticipantTableShowResultsAction(
                    $this->lng,
                    $this->ui_factory,
                    $this->test_access,
                    $this->ctrl,
                    $this->test_obj
                ),
                ParticipantTableDeleteResultsAction::ACTION_ID => new ParticipantTableDeleteResultsAction(
                    $this->lng,
                    $this->main_tpl,
                    $this->ui_factory,
                    $this->db,
                    $this->participant_access_filter,
                    $this->test_access,
                    $this->test_obj
                ),
                ParticipantTableFinishTestAction::ACTION_ID => new ParticipantTableFinishTestAction(
                    $this->lng,
                    $this->main_tpl,
                    $this->ui_factory,
                    $this->db,
                    new \ilTestProcessLockerFactory(
                        new \ilSetting('assessment'),
                        $this->db
                    ),
                    $this->current_user,
                    $this->test_access,
                    $this->test_obj,
                    $this->test_pass_result_repository
                ),
                ParticipantTableIpRangeAction::ACTION_ID => new ParticipantTableIpRangeAction(
                    $this->lng,
                    $this->main_tpl,
                    $this->ui_factory,
                    $this->refinery,
                    $this->participant_repository,
                    $this->test_access
                ),
                ParticipantTableExtraTimeAction::ACTION_ID => new ParticipantTableExtraTimeAction(
                    $this->lng,
                    $this->refinery,
                    $this->main_tpl,
                    $this->ui_factory,
                    $this->participant_repository,
                    $this->current_user,
                    $this->test_access,
                    $this->test_obj
                ),
                ParticipantTableDeleteParticipantAction::ACTION_ID => new ParticipantTableDeleteParticipantAction(
                    $this->lng,
                    $this->main_tpl,
                    $this->ui_factory,
                    $this->participant_repository,
                    $this->test_access,
                    $this->test_obj
                )
            ]
        );
    }
}