class.ilCronManagerGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Wrapper\WrapperFactory;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\Collection\OrderedJobEntities;
use ILIAS\Cron\Job\JobRepository;
use ILIAS\Cron\Job\JobManager;
use ILIAS\Cron\Job\JobEntity;
use ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator;
use ILIAS\Cron\Job\Manager\UI\JobTable;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;

class ilCronManagerGUI
{
    private const TABLE_ACTION_NAMESPACE = ['cron', 'jobs'];
    private const TABLE_ACTION_PARAM_NAME = 'table_action';
    private const TABLE_ACTION_IDENTIFIER_NAME = 'jid';
    private const FORM_PARAM_SCHEDULE_PREFIX = 'schedule_';
    public const FORM_PARAM_MAIN_SECTION = 'main';
    public const FORM_PARAM_JOB_INPUT = 'additional_job_input';
    public const FORM_PARAM_GROUP_SCHEDULE = 'schedule';

    private readonly ilLanguage $lng;
    private readonly ilCtrlInterface $ctrl;
    private readonly ilSetting $settings;
    private readonly ilGlobalTemplateInterface $tpl;
    private readonly Factory $ui_factory;
    private readonly Renderer $ui_renderer;
    private readonly ilUIService $ui_service;
    private readonly JobRepository $cron_repository;
    private readonly \ILIAS\DI\RBACServices $rbac;
    private readonly ilErrorHandling $error;
    private readonly WrapperFactory $http_wrapper;
    private readonly \ILIAS\HTTP\GlobalHttpState $http;
    private readonly \ILIAS\Refinery\Factory $refinery;
    private readonly JobManager $cron_manager;
    private readonly ilObjUser $actor;

    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ui_service = $DIC->uiService();
        $this->rbac = $DIC->rbac();
        $this->error = $DIC['ilErr'];
        $this->http_wrapper = $DIC->http()->wrapper();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->actor = $DIC->user();
        $this->cron_repository = $DIC->cron()->repository();
        $this->cron_manager = $DIC->cron()->manager();

        $this->lng->loadLanguageModule('cron');
        $this->lng->loadLanguageModule('cmps');
    }

    private function retrieveTableActionJobIds(): array
    {
        $retrieval = $this->http_wrapper->query();
        if (strtoupper($this->http->request()->getMethod()) === 'POST') {
            $retrieval = $this->http_wrapper->post();
        }

        $trafo = $this->refinery->byTrying([
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
            $this->refinery->always([])
        ]);

        $ids = $retrieval->retrieve(
            $this->getJobIdParameterName(),
            $trafo
        );

        if (count($ids) === 1 && $ids[0] === 'ALL_OBJECTS') {
            $tableFilterMediator = new JobTableFilterMediator(
                $this->cron_repository->findAll(),
                $this->ui_factory,
                $this->ui_service,
                $this->lng
            );
            $filter = $tableFilterMediator->filter(
                $this->ctrl->getFormAction(
                    $this,
                    'render',
                    '',
                    true
                )
            );
            $ids = array_map(
                static function (JobEntity $entity): string {
                    return $entity->getEffectiveJobId();
                },
                $tableFilterMediator->filteredJobs(
                    $filter
                )->toArray()
            );
        }

        return $ids;
    }

    private function getTableActionParameterName(): string
    {
        return implode('_', array_merge(self::TABLE_ACTION_NAMESPACE, [self::TABLE_ACTION_PARAM_NAME]));
    }

    private function addProblematicItemsInfo(
        \ILIAS\Cron\Job\JobCollection $filtered_jobs,
        \ILIAS\UI\Component\MessageBox\MessageBox $message,
        array $components
    ): array {
        $problematic_jobs = $filtered_jobs->filter(static function (JobEntity $entity): bool {
            return $entity->getJobResultStatus() === JobResult::STATUS_CRASHED;
        });
        if (count($problematic_jobs) > 0) {
            $problematic_jobs_info = $this->ui_factory->messageBox()->info(
                $this->lng->txt('cron_jobs_with_required_intervention')
            )->withLinks(
                array_map(
                    function (JobEntity $entity): \ILIAS\UI\Component\Link\Standard {
                        return $this->ui_factory->link()->standard(
                            $entity->getEffectiveTitle(),
                            '#job-' . $entity->getEffectiveJobId()
                        );
                    },
                    (new OrderedJobEntities(
                        $problematic_jobs,
                        OrderedJobEntities::ORDER_BY_NAME
                    ))->toArray()
                )
            );

            if (in_array($message, $components, true)) {
                $components = array_merge(
                    array_slice($components, 0, array_search($message, $components, true) + 1),
                    [$problematic_jobs_info],
                    array_slice($components, array_search($message, $components, true) + 1)
                );
            } else {
                array_unshift($components, $problematic_jobs_info);
            }
        }

        return $components;
    }

    private function getJobIdParameterName(): string
    {
        return implode('_', array_merge(self::TABLE_ACTION_NAMESPACE, [self::TABLE_ACTION_IDENTIFIER_NAME]));
    }

    private function getRequestValue(
        string $key,
        \ILIAS\Refinery\Transformation $trafo,
        bool $force_retrieval = false,
        $default = null
    ) {
        $exc = null;

        try {
            if ($force_retrieval || $this->http_wrapper->query()->has($key)) {
                return $this->http_wrapper->query()->retrieve($key, $trafo);
            }
        } catch (OutOfBoundsException $e) {
            $exc = $e;
        }

        try {
            if ($force_retrieval || $this->http_wrapper->post()->has($key)) {
                return $this->http_wrapper->post()->retrieve($key, $trafo);
            }
        } catch (OutOfBoundsException $e) {
            $exc = $e;
        }

        if ($force_retrieval && $exc) {
            throw $exc;
        }

        return $default ?? null;
    }

    public function executeCommand(): void
    {
        if (!$this->rbac->system()->checkAccess('visible,read', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

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

        switch (strtolower($class)) {
            case strtolower(ilPropertyFormGUI::class):
                $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
                $job = $this->cron_repository->getJobInstanceById(ilUtil::stripSlashes($job_id));
                $form = $this->initLegacyEditForm($job);
                $this->ctrl->forwardCommand($form);
                break;
        }

        $cmd = $this->ctrl->getCmd('render');
        $this->$cmd();
    }

    private function handleTableActions(): void
    {
        $action = $this->http_wrapper->query()->retrieve(
            $this->getTableActionParameterName(),
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'run' => $this->run(),
            'activate' => $this->activate(),
            'deactivate' => $this->deactivate(),
            'reset' => $this->reset(),
            'edit' => $this->edit(),
            default => $this->render()
        };
    }

    protected function render(): void
    {
        $tstamp = $this->lng->txt('cronjob_last_start_unknown');
        if ($this->settings->get('last_cronjob_start_ts')) {
            $tstamp = ilDatePresentation::formatDate(
                new ilDateTime(
                    $this->settings->get('last_cronjob_start_ts'),
                    IL_CAL_UNIX
                )
            );
        }

        $message = $this->ui_factory->messageBox()->info($this->lng->txt('cronjob_last_start') . ': ' . $tstamp);

        $cronJobs = $this->cron_repository->findAll();

        $tableFilterMediator = new JobTableFilterMediator(
            $cronJobs,
            $this->ui_factory,
            $this->ui_service,
            $this->lng
        );
        $filter = $tableFilterMediator->filter(
            $this->ctrl->getFormAction(
                $this,
                'render',
                '',
                true
            )
        );

        $filtered_jobs = $tableFilterMediator->filteredJobs(
            $filter
        );

        $tbl = new JobTable(
            $this,
            'handleTableActions',
            self::TABLE_ACTION_NAMESPACE,
            self::TABLE_ACTION_PARAM_NAME,
            self::TABLE_ACTION_IDENTIFIER_NAME,
            $this->ui_factory,
            $this->http->request(),
            $this->ctrl,
            $this->lng,
            $filtered_jobs,
            $this->cron_repository,
            $this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)
        );

        $this->tpl->setContent(
            $this->ui_renderer->render(
                $this->addProblematicItemsInfo(
                    $filtered_jobs,
                    $message,
                    [$message, $filter, $tbl->getComponent()]
                )
            )
        );
    }

    public function edit(?ILIAS\UI\Component\Input\Container\Form\Form $form = null): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        if ($form === null) {
            $job_ids = $this->retrieveTableActionJobIds();
            if (count($job_ids) !== 1) {
                $this->ctrl->redirect($this, 'render');
            }

            $job_id = current($job_ids);
            $job = $this->cron_repository->getJobInstanceById($job_id);
            if ($job && $job->usesLegacyForms()) {
                $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());
                $this->ctrl->redirect($this, 'editLegacy');
            }

            $form = $this->initEditForm($job);
        }

        $this->tpl->setContent($this->ui_renderer->render($form));
    }

    public function editLegacy(?ilPropertyFormGUI $a_form = null): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        if ($a_form === null) {
            $job_ids = $this->retrieveTableActionJobIds();
            if (count($job_ids) !== 1) {
                $this->ctrl->redirect($this, 'render');
            }

            $job_id = current($job_ids);
            $job = $this->cron_repository->getJobInstanceById($job_id);
            $a_form = $this->initLegacyEditForm($job);
        }

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

    private function getScheduleTypeFormElementName(JobScheduleType $schedule_type): string
    {
        return match ($schedule_type) {
            JobScheduleType::DAILY => $this->lng->txt('cron_schedule_daily'),
            JobScheduleType::WEEKLY => $this->lng->txt('cron_schedule_weekly'),
            JobScheduleType::MONTHLY => $this->lng->txt('cron_schedule_monthly'),
            JobScheduleType::QUARTERLY => $this->lng->txt('cron_schedule_quarterly'),
            JobScheduleType::YEARLY => $this->lng->txt('cron_schedule_yearly'),
            JobScheduleType::IN_MINUTES => sprintf($this->lng->txt('cron_schedule_in_minutes'), 'x'),
            JobScheduleType::IN_HOURS => sprintf($this->lng->txt('cron_schedule_in_hours'), 'x'),
            JobScheduleType::IN_DAYS => sprintf($this->lng->txt('cron_schedule_in_days'), 'x'),
        };
    }

    protected function getScheduleValueFormElementName(JobScheduleType $schedule_type): string
    {
        return match ($schedule_type) {
            JobScheduleType::IN_MINUTES => 'smini',
            JobScheduleType::IN_HOURS => 'shri',
            JobScheduleType::IN_DAYS => 'sdyi',
            default => throw new InvalidArgumentException(
                sprintf(
                    'The passed argument %s is invalid!',
                    var_export($schedule_type, true)
                )
            ),
        };
    }

    protected function hasScheduleValue(JobScheduleType $schedule_type): bool
    {
        return in_array($schedule_type, [
            JobScheduleType::IN_MINUTES,
            JobScheduleType::IN_HOURS,
            JobScheduleType::IN_DAYS
        ], true);
    }

    protected function initEditForm(?CronJob $job): ILIAS\UI\Component\Input\Container\Form\Form
    {
        if (!($job instanceof CronJob)) {
            $this->ctrl->redirect($this, 'render');
        }

        $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());

        $jobs_data = $this->cron_repository->getCronJobData($job->getId());
        $job_data = $jobs_data[0];

        $section_inputs = [];
        if ($job->hasFlexibleSchedule()) {
            $schedule_type_groups = [];
            foreach ($job->getAllScheduleTypes() as $schedule_type) {
                if (!in_array($schedule_type, $job->getValidScheduleTypes(), true)) {
                    continue;
                }

                $schedule_type_inputs = [];
                if (in_array($schedule_type, $job->getScheduleTypesWithValues(), true)) {
                    $schedule_value_input = $this->ui_factory
                        ->input()
                        ->field()
                        ->numeric(
                            $this->lng->txt('cron_schedule_value')
                        )->withAdditionalTransformation(
                            $this->refinery->in()->series([
                                $this->refinery->int()->isGreaterThanOrEqual(1)
                            ])
                        )->withRequired(true);

                    if (is_numeric($job_data['schedule_type']) &&
                        JobScheduleType::tryFrom((int) $job_data['schedule_type']) === $schedule_type) {
                        $schedule_value_input = $schedule_value_input->withValue(
                            $job_data['schedule_value'] === null ? null : (int) $job_data['schedule_value']
                        );
                    }

                    $schedule_type_inputs = [
                        $this->getScheduleValueFormElementName($schedule_type) => $schedule_value_input
                    ];
                }

                $schedule_type_groups[self::FORM_PARAM_SCHEDULE_PREFIX . $schedule_type->value] = $this->ui_factory
                    ->input()
                    ->field()
                    ->group(
                        $schedule_type_inputs,
                        $this->getScheduleTypeFormElementName($schedule_type)
                    )
                    ->withDedicatedName(self::FORM_PARAM_SCHEDULE_PREFIX . $schedule_type->value);
            }

            $default_schedule_type = current($job->getValidScheduleTypes())->value;

            $section_inputs['schedule'] = $this->ui_factory
                ->input()
                ->field()
                ->switchableGroup(
                    $schedule_type_groups,
                    $this->lng->txt('cron_schedule_type')
                )
                ->withRequired(true)
                ->withValue(
                    $job_data['schedule_type'] === null ?
                        self::FORM_PARAM_SCHEDULE_PREFIX . $default_schedule_type :
                        self::FORM_PARAM_SCHEDULE_PREFIX . $job_data['schedule_type']
                );
        }

        $main_section = $this->ui_factory->input()->field()->section(
            $section_inputs,
            $this->lng->txt('cron_action_edit') . ': "' . $job->getTitle() . '"'
        );

        $inputs = [
            self::FORM_PARAM_MAIN_SECTION => $main_section
        ];

        if ($job->hasCustomSettings()) {
            $inputs = array_merge(
                $inputs,
                [
                    self::FORM_PARAM_JOB_INPUT =>
                        $job->getCustomConfigurationInput(
                            $this->ui_factory,
                            $this->refinery,
                            $this->lng
                        )
                ]
            );
        }

        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard($this->ctrl->getFormAction($this, 'update'), $inputs)
            ->withDedicatedName('cron_form');
    }

    #[\Deprecated('Will be removed without any alternative, KS/UI forms will be expected', since: '13.0')]
    protected function initLegacyEditForm(?CronJob $job): ilPropertyFormGUI
    {
        if (!($job instanceof CronJob)) {
            $this->ctrl->redirect($this, 'render');
        }

        $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());

        $jobs_data = $this->cron_repository->getCronJobData($job->getId());
        $job_data = $jobs_data[0];

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'updateLegacy'));
        $form->setTitle($this->lng->txt('cron_action_edit') . ': "' . $job->getTitle() . '"');

        if ($job->hasFlexibleSchedule()) {
            $type = new ilRadioGroupInputGUI($this->lng->txt('cron_schedule_type'), 'type');
            $type->setRequired(true);
            $type->setValue($job_data['schedule_type'] === null ? null : (string) $job_data['schedule_type']);

            foreach ($job->getAllScheduleTypes() as $schedule_type) {
                if (!in_array($schedule_type, $job->getValidScheduleTypes(), true)) {
                    continue;
                }

                $option = new ilRadioOption(
                    $this->getScheduleTypeFormElementName($schedule_type),
                    (string) $schedule_type->value
                );
                $type->addOption($option);

                if (in_array($schedule_type, $job->getScheduleTypesWithValues(), true)) {
                    $scheduleValue = new ilNumberInputGUI(
                        $this->lng->txt('cron_schedule_value'),
                        $this->getScheduleValueFormElementName($schedule_type)
                    );
                    $scheduleValue->allowDecimals(false);
                    $scheduleValue->setRequired(true);
                    $scheduleValue->setSize(5);
                    if (is_numeric($job_data['schedule_type']) &&
                        JobScheduleType::tryFrom((int) $job_data['schedule_type']) === $schedule_type) {
                        $scheduleValue->setValue(
                            $job_data['schedule_value'] === null ? null : (string) $job_data['schedule_value']
                        );
                    }
                    $option->addSubItem($scheduleValue);
                }
            }

            $form->addItem($type);
        }

        if ($job->hasCustomSettings()) {
            $job->addCustomSettingsToForm($form);
        }

        $form->addCommandButton('updateLegacy', $this->lng->txt('save'));
        $form->addCommandButton('render', $this->lng->txt('cancel'));

        return $form;
    }

    public function update(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
        if (!$job_id) {
            $this->ctrl->redirect($this, 'render');
        }

        $job = $this->cron_repository->getJobInstanceById($job_id);
        $form = $this->initEditForm($job);

        $form_valid = false;
        $form_data = null;
        if ($this->http->request()->getMethod() === 'POST') {
            $form = $form->withRequest($this->http->request());
            $form_data = $form->getData();
            $form_valid = $form_data !== null;
        }

        if (!$form_valid) {
            $this->edit($form);
            return;
        }

        if ($job instanceof CronJob) {
            if ($job->hasFlexibleSchedule()) {
                $schedule_group = $form_data[self::FORM_PARAM_MAIN_SECTION][self::FORM_PARAM_GROUP_SCHEDULE];

                $type = JobScheduleType::from(
                    (int) ltrim($schedule_group[0], self::FORM_PARAM_SCHEDULE_PREFIX)
                );

                $value = match (true) {
                    $this->hasScheduleValue($type) => (int) $schedule_group[1][$this->getScheduleValueFormElementName(
                        $type
                    )],
                    default => null,
                };

                $this->cron_repository->updateJobSchedule($job, $type, $value);
            }

            if ($job->hasCustomSettings()) {
                $job->saveCustomConfiguration($form_data[self::FORM_PARAM_JOB_INPUT]);
            }

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

        $this->edit($form);
    }

    #[\Deprecated('Will be removed without any alternative, KS/UI forms will be expected', since: '12.0')]
    public function updateLegacy(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
        if (!$job_id) {
            $this->ctrl->redirect($this, 'render');
        }

        $job = $this->cron_repository->getJobInstanceById($job_id);

        $form = $this->initLegacyEditForm($job);
        if ($job instanceof CronJob && $form->checkInput()) {
            $valid = true;
            if ($job->hasCustomSettings() && !$job->saveCustomSettings($form)) {
                $valid = false;
            }

            if ($valid && $job->hasFlexibleSchedule()) {
                $type = JobScheduleType::from((int) $form->getInput('type'));
                $value = match (true) {
                    $this->hasScheduleValue($type) => (int) $form->getInput(
                        $this->getScheduleValueFormElementName($type)
                    ),
                    default => null,
                };

                $this->cron_repository->updateJobSchedule($job, $type, $value);
            }

            if ($valid) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_edit_success'), true);
                $this->ctrl->redirect($this, 'render');
            }
        }

        $form->setValuesByPost();
        $this->editLegacy($form);
    }

    public function run(): void
    {
        $this->confirm('run');
    }

    public function confirmedRun(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_ids = $this->retrieveTableActionJobIds();
        if (count($job_ids) !== 1) {
            $this->ctrl->redirect($this, 'render');
        }

        $job_id = current($job_ids);
        if ($this->cron_manager->runJobManual($job_id, $this->actor)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_run_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cron_action_run_fail'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

    public function activate(): void
    {
        $this->confirm('activate');
    }

    public function confirmedActivate(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                if ($this->cron_manager->isJobInactive($job->getId())) {
                    $this->cron_manager->resetJob($job, $this->actor);
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_activate_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

    public function deactivate(): void
    {
        $this->confirm('deactivate');
    }

    public function confirmedDeactivate(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                if ($this->cron_manager->isJobActive($job->getId())) {
                    $this->cron_manager->deactivateJob($job, $this->actor, true);
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_deactivate_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

    public function reset(): void
    {
        $this->confirm('reset');
    }

    public function confirmedReset(): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                $this->cron_manager->resetJob($job, $this->actor);
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_reset_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

    protected function getMultiActionData(): array
    {
        $res = [];

        $job_ids = [];
        try {
            $job_ids = $this->retrieveTableActionJobIds();
        } catch (\ILIAS\Refinery\ConstraintViolationException|OutOfBoundsException) {
        }

        foreach ($job_ids as $job_id) {
            $job = $this->cron_repository->getJobInstanceById($job_id);
            if ($job instanceof CronJob) {
                $res[$job_id] = $job;
            }
        }

        return $res;
    }

    protected function confirm(string $a_action): void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'render');
        }

        if ($a_action === 'run') {
            $jobs = array_filter($jobs, static function (CronJob $job): bool {
                return $job->isManuallyExecutable();
            });

            if ($jobs === []) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cron_no_executable_job_selected'), true);
                $this->ctrl->redirect($this, 'render');
            }
        }

        $cgui = new ilConfirmationGUI();

        if (count($jobs) === 1) {
            $jobKeys = array_keys($jobs);
            $job_id = array_pop($jobKeys);
            $job = array_pop($jobs);
            $title = $job->getTitle();
            if (!$title) {
                $title = preg_replace('[^A-Za-z0-9_\-]', '', $job->getId());
            }

            $cgui->setHeaderText(
                sprintf(
                    $this->lng->txt('cron_action_' . $a_action . '_sure'),
                    $title
                )
            );

            $cgui->addHiddenItem($this->getJobIdParameterName() . '[]', $job_id);
        } else {
            $cgui->setHeaderText($this->lng->txt('cron_action_' . $a_action . '_sure_multi'));

            foreach ($jobs as $job_id => $job) {
                $cgui->addItem($this->getJobIdParameterName() . '[]', $job_id, $job->getTitle());
            }
        }

        $cgui->setFormAction($this->ctrl->getFormAction($this, 'confirmed' . ucfirst($a_action)));
        $cgui->setCancel($this->lng->txt('cancel'), 'render');
        $cgui->setConfirm($this->lng->txt('cron_action_' . $a_action), 'confirmed' . ucfirst($a_action));

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

    public function addToExternalSettingsForm(int $a_form_id): array
    {
        $form_elements = [];
        $fields = [];
        $data = $this->cron_repository->getCronJobData();
        foreach ($data as $item) {
            $job = $this->cron_repository->getJobInstance(
                $item['job_id'],
                $item['component'],
                $item['class']
            );
            if ($job !== null) {
                $job->addToExternalSettingsForm($a_form_id, $fields, (bool) $item['job_status']);
            }
        }

        if ($fields !== []) {
            $form_elements = [
                'cron_jobs' => [
                    'jumpToCronJobs',
                    $fields
                ]
            ];
        }

        return $form_elements;
    }
}