class.ilCronManagerTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Cron\Schedule\CronJobScheduleType;

class ilCronManagerTableGUI extends ilTable2GUI
{
    public function __construct(
        ilCronManagerGUI $a_parent_obj,
        private readonly ilCronJobRepository $cronRepository,
        string $a_parent_cmd,
        private readonly bool $mayWrite = false
    ) {
        $this->setId('crnmng'); // #14526 / #16391

        parent::__construct($a_parent_obj, $a_parent_cmd);

        if ($this->mayWrite) {
            $this->addColumn("", "", '1px', true);
        }
        $this->addColumn($this->lng->txt('cron_job_id'), 'title');
        $this->addColumn($this->lng->txt('cron_component'), 'component');
        $this->addColumn($this->lng->txt('cron_schedule'), 'schedule');
        $this->addColumn($this->lng->txt('cron_status'), 'status');
        $this->addColumn($this->lng->txt('cron_status_info'), '');
        $this->addColumn($this->lng->txt('cron_result'), 'result');
        $this->addColumn($this->lng->txt('cron_result_info'), '');
        $this->addColumn($this->lng->txt('cron_last_run'), 'last_run');
        if ($this->mayWrite) {
            $this->addColumn($this->lng->txt('actions'), '');
        }

        $this->setTitle($this->lng->txt('cron_jobs'));
        $this->setDefaultOrderField('title');

        if ($this->mayWrite) {
            $this->setSelectAllCheckbox('mjid');
            $this->addMultiCommand('activate', $this->lng->txt('cron_action_activate'));
            $this->addMultiCommand('deactivate', $this->lng->txt('cron_action_deactivate'));
            $this->addMultiCommand('reset', $this->lng->txt('cron_action_reset'));
        }

        $this->setRowTemplate('tpl.cron_job_row.html', 'Services/Cron');
        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
    }

    private function formatSchedule(ilCronJobEntity $entity, array $row): string
    {
        $schedule = match ($entity->getEffectiveScheduleType()) {
            CronJobScheduleType::SCHEDULE_TYPE_DAILY => $this->lng->txt('cron_schedule_daily'),
            CronJobScheduleType::SCHEDULE_TYPE_WEEKLY => $this->lng->txt('cron_schedule_weekly'),
            CronJobScheduleType::SCHEDULE_TYPE_MONTHLY => $this->lng->txt('cron_schedule_monthly'),
            CronJobScheduleType::SCHEDULE_TYPE_QUARTERLY => $this->lng->txt('cron_schedule_quarterly'),
            CronJobScheduleType::SCHEDULE_TYPE_YEARLY => $this->lng->txt('cron_schedule_yearly'),
            CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES => sprintf(
                $this->lng->txt('cron_schedule_in_minutes'),
                $entity->getEffectiveScheduleValue()
            ),
            CronJobScheduleType::SCHEDULE_TYPE_IN_HOURS => sprintf(
                $this->lng->txt('cron_schedule_in_hours'),
                $entity->getEffectiveScheduleValue()
            ),
            CronJobScheduleType::SCHEDULE_TYPE_IN_DAYS => sprintf(
                $this->lng->txt('cron_schedule_in_days'),
                $entity->getEffectiveScheduleValue()
            )
        };

        return $schedule;
    }

    private function formatStatusInfo(ilCronJobEntity $entity): string
    {
        $status_info = [];
        if ($entity->getJobStatusTimestamp()) {
            $status_info[] = ilDatePresentation::formatDate(
                new ilDateTime($entity->getJobStatusTimestamp(), IL_CAL_UNIX)
            );
        }

        if ($entity->getJobStatusType()) {
            $status_info[] = ilUserUtil::getNamePresentation($entity->getJobStatusUsrId());
        } else {
            $status_info[] = $this->lng->txt('cron_changed_by_crontab');
        }

        return implode('<br />', $status_info);
    }

    private function formatResult(ilCronJobEntity $entity): string
    {
        $result = '-';
        if ($entity->getJobResultStatus()) {
            switch ($entity->getJobResultStatus()) {
                case ilCronJobResult::STATUS_INVALID_CONFIGURATION:
                    $result = $this->lng->txt('cron_result_status_invalid_configuration');
                    break;

                case ilCronJobResult::STATUS_NO_ACTION:
                    $result = $this->lng->txt('cron_result_status_no_action');
                    break;

                case ilCronJobResult::STATUS_OK:
                    $result = $this->lng->txt('cron_result_status_ok');
                    break;

                case ilCronJobResult::STATUS_CRASHED:
                    $result = $this->lng->txt('cron_result_status_crashed');
                    break;

                case ilCronJobResult::STATUS_RESET:
                    $result = $this->lng->txt('cron_result_status_reset');
                    break;

                case ilCronJobResult::STATUS_FAIL:
                    $result = $this->lng->txt('cron_result_status_fail');
                    break;
            }
        }

        return $result;
    }

    private function formatResultInfo(ilCronJobEntity $entity): string
    {
        $result_info = [];
        if ($entity->getJobResultDuration()) {
            $result_info[] = ($entity->getJobResultDuration() / 1000) . ' sec';
        }

        // #23391 / #11866
        $resultCode = $entity->getJobResultCode();
        if (in_array($resultCode, ilCronJobResult::getCoreCodes(), true)) {
            $result_info[] = $this->lng->txt('cro_job_rc_' . $resultCode);
        } elseif ($entity->getJobResultMessage()) {
            $result_info[] = $entity->getJobResultMessage();
        }

        if (defined('DEVMODE') && DEVMODE && $resultCode) {
            $result_info[] = $resultCode;
        }

        if ($entity->getJobResultType()) {
            $result_info[] = ilUserUtil::getNamePresentation($entity->getJobResultUsrId());
        } else {
            $result_info[] = $this->lng->txt('cron_changed_by_crontab');
        }

        return implode('<br />', $result_info);
    }

    public function populate(ilCronJobCollection $collection): self
    {
        $this->setData(array_map(function (ilCronJobEntity $entity): array {
            $row = [];

            $row['schedule'] = $this->formatSchedule($entity, $row);
            $row['status'] = $this->lng->txt('cron_status_inactive');
            if ($entity->getJobStatus()) {
                $row['status'] = $this->lng->txt('cron_status_active');
            }
            $row['status_info'] = $this->formatStatusInfo($entity);
            $row['result'] = $this->formatResult($entity);
            $row['result_info'] = $this->formatResultInfo($entity);

            $row['last_run'] = null;
            if ($entity->getRunningTimestamp()) {
                $row['last_run'] = strtotime('+1year', $entity->getRunningTimestamp());
            } elseif ($entity->getJobResultTimestamp()) {
                $row['last_run'] = $entity->getJobResultTimestamp();
            }

            $row['job_id'] = $entity->getJobId();
            $row['component'] = $entity->getComponent();
            if ($entity->isPlugin()) {
                $row['job_id'] = 'pl__' . $row['component'] . '__' . $row['job_id'];
                $row['component'] = $this->lng->txt('cmps_plugin') . '/' . $row['component'];
            }

            $row['title'] = $entity->getEffectiveTitle();
            $row['description'] = $entity->getJob()->getDescription();
            $row['is_manually_executable'] = $entity->getJob()->isManuallyExecutable();
            $row['has_settings'] = $entity->getJob()->hasCustomSettings();
            $row['job_result_status'] = $entity->getJobResultStatus();
            $row['job_status'] = $entity->getJobStatus();
            $row['alive_ts'] = $entity->getAliveTimestamp();
            $row['running_ts'] = $entity->getRunningTimestamp();

            if ($entity->getJob()->hasFlexibleSchedule()) {
                $row['editable_schedule'] = true;
                if ($entity->getScheduleType() === null) {
                    $this->cronRepository->updateJobSchedule(
                        $entity->getJob(),
                        $entity->getEffectiveScheduleType(),
                        $entity->getEffectiveScheduleValue()
                    );
                }
            } elseif ($entity->getScheduleType() !== null) {
                $this->cronRepository->updateJobSchedule($entity->getJob(), null, null);
            }

            return $row;
        }, $collection->toArray()));

        return $this;
    }

    protected function fillRow(array $a_set): void
    {
        if ($this->mayWrite) {
            $this->tpl->setVariable('VAL_JID', $a_set['job_id']);
        }
        $this->tpl->setVariable('VAL_ID', $a_set['title']);

        if ($a_set['description']) {
            $this->tpl->setVariable('VAL_DESC', $a_set['description']);
        }

        $this->tpl->setVariable('VAL_COMPONENT', $a_set['component']);
        $this->tpl->setVariable('VAL_SCHEDULE', $a_set['schedule']);
        $this->tpl->setVariable('VAL_STATUS', $a_set['status']);
        $this->tpl->setVariable('VAL_STATUS_INFO', $a_set['status_info']);
        $this->tpl->setVariable('VAL_RESULT', $a_set['result']);
        $this->tpl->setVariable('VAL_RESULT_INFO', $a_set['result_info']);
        if ($a_set['last_run'] > time()) {
            $a_set['last_run'] = $this->lng->txt('cron_running_since') . ' ' .
                ilDatePresentation::formatDate(new ilDateTime($a_set['running_ts'], IL_CAL_UNIX));

            // job has pinged
            if ($a_set['alive_ts'] !== $a_set['running_ts']) {
                $a_set['last_run'] .= '<br />(Ping: ' .
                    ilDatePresentation::formatDate(new ilDateTime($a_set['alive_ts'], IL_CAL_UNIX)) . ')';
            }
        } elseif ($a_set['last_run']) {
            $a_set['last_run'] = ilDatePresentation::formatDate(new ilDateTime($a_set['last_run'], IL_CAL_UNIX));
        }
        $this->tpl->setVariable('VAL_LAST_RUN', $a_set['last_run'] ?: '-');

        $actions = [];
        if ($this->mayWrite && !$a_set['running_ts']) {
            if ($a_set['job_result_status'] === ilCronJobResult::STATUS_CRASHED) {
                $actions[] = 'reset';
            } elseif (!$a_set['job_status']) {
                $actions[] = 'activate';
            } else {
                if ($a_set['is_manually_executable']) {
                    $actions[] = 'run';
                }
                $actions[] = 'deactivate';
            }

            if (
                (isset($a_set['editable_schedule']) && $a_set['editable_schedule']) ||
                (isset($a_set['has_settings']) && $a_set['has_settings'])
            ) {
                $actions[] = 'edit';
            }

            $this->ctrl->setParameter($this->getParentObject(), 'jid', $a_set['job_id']);
            foreach ($actions as $action) {
                $this->tpl->setCurrentBlock('action_bl');
                $this->tpl->setVariable(
                    'URL_ACTION',
                    $this->ctrl->getLinkTarget($this->getParentObject(), $action)
                );
                $this->tpl->setVariable('TXT_ACTION', $this->lng->txt('cron_action_' . $action));
                $this->tpl->parseCurrentBlock();
            }
            $this->ctrl->setParameter($this->getParentObject(), 'jid', '');
        }
    }
}