class.ilCronFinishUnfinishedTestPasses.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Test\Results\Data\StatusOfAttempt;
use ILIAS\Test\Results\Data\Repository as TestResultRepository;
use ILIAS\Test\TestDIC;
use ILIAS\Test\Logging\TestLogger;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;

class ilCronFinishUnfinishedTestPasses extends CronJob
{
    protected readonly TestLogger $logger;

    protected readonly ilLanguage $lng;
    protected readonly ilDBInterface $db;
    protected readonly ilObjUser $user;
    protected readonly ilObjectDataCache $obj_data_cache;
    protected int $now;
    protected array $unfinished_passes;
    protected array $test_ids;
    protected array $test_ending_times;
    protected ilTestProcessLockerFactory $processLockerFactory;
    protected TestResultRepository $test_pass_result_repository;

    public function __construct()
    {
        global $DIC;

        $this->logger = TestDIC::dic()['logging.logger'];
        $this->lng = $DIC['lng'];
        $this->user = $DIC['ilUser'];
        $this->lng->loadLanguageModule('assessment');
        $this->db = $DIC->database();
        $this->obj_data_cache = $DIC['ilObjDataCache'];
        $this->now = time();
        $this->unfinished_passes = [];
        $this->test_ids = [];
        $this->test_ending_times = [];

        $this->processLockerFactory = new ilTestProcessLockerFactory(
            new ilSetting('assessment'),
            $this->db
        );

        $this->test_pass_result_repository = TestDic::dic()['results.data.test_result_repository'];
    }

    public function getId(): string
    {
        return 'finish_unfinished_passes';
    }

    public function getTitle(): string
    {
        return $this->lng->txt('finish_unfinished_passes');
    }

    public function getDescription(): string
    {
        return $this->lng->txt('finish_unfinished_passes_desc');
    }

    public function getDefaultScheduleType(): JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

    public function getDefaultScheduleValue(): int
    {
        return 1;
    }

    public function hasAutoActivation(): bool
    {
        return false;
    }

    public function hasFlexibleSchedule(): bool
    {
        return true;
    }

    public function hasCustomSettings(): bool
    {
        return true;
    }

    public function run(): JobResult
    {
        $this->logger->info('start inf cronjob...');

        $result = new JobResult();

        $this->gatherUsersWithUnfinishedPasses();
        if (count($this->unfinished_passes) > 0) {
            $this->logger->info('found ' . count($this->unfinished_passes) . ' unfinished passes starting analyses.');
            $this->getTestsFinishAndProcessingTime();
            $this->processPasses();
        } else {
            $this->logger->info('No unfinished passes found.');
        }

        $result->setStatus(JobResult::STATUS_OK);

        $this->logger->info(' ...finishing cronjob.');

        return $result;
    }

    protected function gatherUsersWithUnfinishedPasses(): void
    {
        $query = '
            SELECT      tst_active.active_id,
                    tst_active.tries,
                    tst_active.user_fi usr_id,
                    tst_active.test_fi test_fi,
                    usr_data.login,
                    usr_data.lastname,
                    usr_data.firstname,
                    tst_active.submitted test_finished,
                    usr_data.matriculation,
                    usr_data.active,
                    tst_active.lastindex,
                    tst_active.last_started_pass last_started
            FROM tst_active
            LEFT JOIN usr_data
            ON tst_active.user_fi = usr_data.usr_id
            WHERE IFNULL(tst_active.last_finished_pass, -1) <> tst_active.last_started_pass
        ';
        $result = $this->db->query($query);
        while ($row = $this->db->fetchAssoc($result)) {
            $this->unfinished_passes[] = $row;
            $this->test_ids[] = $row['test_fi'];
        }
    }

    protected function getTestsFinishAndProcessingTime(): void
    {
        $query = 'SELECT test_id, obj_fi, ending_time, ending_time_enabled, processing_time, enable_processing_time FROM tst_tests WHERE ' .
                    $this->db->in('test_id', $this->test_ids, false, 'integer');
        $result = $this->db->query($query);
        while ($row = $this->db->fetchAssoc($result)) {
            $this->test_ending_times[$row['test_id']] = $row;
        }
        $this->logger->info('Gathered data for ' . count($this->test_ids) . ' test id(s) => (' . implode(',', $this->test_ids) . ')');
    }

    protected function processPasses(): void
    {
        foreach ($this->unfinished_passes as $data) {
            $test_id = $data['test_fi'];
            if (!array_key_exists($test_id, $this->test_ending_times)) {
                continue;
            }
            if (!$this->finishPassOnEndingTime($test_id, $data['active_id'])
                && !$this->finishPassOnProcessingTime(
                    $test_id,
                    $data['usr_id'],
                    $data['active_id']
                )
            ) {
                $this->logger->info('Test session with active id ('
                    . $data['active_id'] . ') can not be finished by this cron job.');
            }
        }

    }

    private function finishPassOnEndingTime(int $test_id, int $active_id): bool
    {
        $now = time();
        if ($this->test_ending_times[$test_id]['ending_time_enabled'] !== 1) {
            $this->logger->info('Test (' . $test_id . ') has no ending time.');
            return false;
        }

        $this->logger->info('Test (' . $test_id . ') has ending time ('
            . $this->test_ending_times[$test_id]['ending_time'] . ')');
        $ending_time = $this->test_ending_times[$test_id]['ending_time'];
        if ($ending_time >= $now) {
            $this->logger->info('Test (' . $test_id . ') ending time ('
                . $this->test_ending_times[$test_id]['ending_time']
                . ') > now (' . $now . ') is not reached.');
            return false;
        }

        $this->finishPassForUser($active_id, $this->test_ending_times[$test_id]['obj_fi']);
        return true;
    }

    private function finishPassOnProcessingTime(
        int $test_id,
        int $usr_id,
        int $active_id
    ): bool {
        if ($this->test_ending_times[$test_id]['enable_processing_time'] !== 1) {
            $this->logger->info('Test (' . $test_id . ') has no processing time.');
            return false;
        }

        $this->logger->info('Test (' . $test_id . ') has processing time (' . $this->test_ending_times[$test_id]['processing_time'] . ')');
        $obj_id = $this->test_ending_times[$test_id]['obj_fi'];

        if (!ilObject::_exists($obj_id)) {
            $this->logger->info('Test object with id (' . $obj_id . ') does not exist.');
            return false;
        }

        $test_obj = new ilObjTest($obj_id, false);
        $startingTime = $test_obj->getStartingTimeOfUser($active_id);
        $max_processing_time = $test_obj->isMaxProcessingTimeReached($startingTime, $active_id);
        if (!$max_processing_time) {
            $this->logger->info('Max Processing time not reached for user id ('
                . $usr_id . ') in test with active id ('
                . $active_id . '). Starting time: ' . $startingTime
                . ' Processing time: ' . $test_obj->getProcessingTime() . ' / '
                . $test_obj->getProcessingTimeInSeconds() . 's');
            return false;
        }

        $this->logger->info('Max Processing time reached for user id ('
            . $usr_id . ') so test with active id ('
            . $active_id . ') will be finished.');
        $this->finishPassForUser($active_id, $this->test_ending_times[$test_id]['obj_fi']);
        return true;
    }

    protected function finishPassForUser($active_id, $obj_id): void
    {
        $processLocker = $this->processLockerFactory->withContextId((int) $active_id)->getLocker();

        $test_session = new ilTestSession($this->db, $this->user);
        $test_session->loadFromDb($active_id);

        if (ilObject::_exists($obj_id)) {
            $test = new ilObjTest($obj_id, false);

            $test->updateTestPassResults(
                $active_id,
                $test_session->getPass(),
                null,
                $obj_id
            );

            (new ilTestPassFinishTasks(
                $test_session,
                $test,
                $this->test_pass_result_repository
            ))->performFinishTasks($processLocker, StatusOfAttempt::FINISHED_BY_CRONJOB);
            $this->logger->info('Test session with active id (' . $active_id . ') and obj_id (' . $obj_id . ') is now finished.');
        } else {
            $this->logger->info('Test object with id (' . $obj_id . ') does not exist.');
        }
    }
}