class.ilXapiResultsCronjob.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;

class ilXapiResultsCronjob extends CronJob
{
    public const LAST_RUN_TS_SETTING_NAME = 'cron_xapi_res_eval_last_run';

    protected int $thisRunTS;

    protected int $lastRunTS;

    protected ilLogger $log;

    private \ILIAS\DI\Container $dic;

    public function __construct()
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $this->dic = $DIC;

        $DIC->language()->loadLanguageModule('cmix');

        $this->log = ilLoggerFactory::getLogger('cmix');

        $this->initThisRunTS();
        $this->readLastRunTS();
    }

    protected function initThisRunTS(): void
    {
        $this->thisRunTS = time();
    }

    protected function readLastRunTS(): void
    {
        $settings = new ilSetting('cmix');
        // Check return value of $settings->get, since this is string but a int is needed for lastRunTS
        $this->lastRunTS = (int) $settings->get(self::LAST_RUN_TS_SETTING_NAME, "0");
    }

    protected function writeThisAsLastRunTS(): void
    {
        $settings = new ilSetting('cmix');
        $settings->set(self::LAST_RUN_TS_SETTING_NAME, (string) $this->thisRunTS);
    }

    public function getThisRunTS(): int
    {
        return $this->thisRunTS;
    }

    public function getLastRunTS(): int
    {
        return $this->lastRunTS;
    }

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

    public function getTitle(): string
    {
        return $this->dic->language()->txt("cron_xapi_results_evaluation");
    }

    public function getDescription(): string
    {
        return $this->dic->language()->txt("cron_xapi_results_evaluation_desc");
    }

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

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

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

    public function getDefaultScheduleValue(): ?int
    {
        return null;
    }

    public function run(): JobResult
    {
        $objects = $this->getObjectsToBeReported();
        $objectIds = [];

        foreach ($objects as $objId) {
            $this->log->debug('handle object (' . $objId . ')');

            $filter = $this->buildReportFilter();

            $object = ilObjectFactory::getInstanceByObjId($objId, false);

            $evaluation = new ilXapiStatementEvaluation($this->log, $object);

            if ($object->getLaunchMode() != ilObjCmiXapi::LAUNCH_MODE_NORMAL) {
                $this->log->debug('skipped object due to launch mode (' . $objId . ')');
                continue;
            }

            $report = $this->getXapiStatementsReport($object, $filter);

            $evaluation->evaluateReport($report);

            //$this->log->debug('update lp for object (' . $objId . ')');
            //ilLPStatusWrapper::_refreshStatus($objId);

            $objectIds[] = $objId;
        }

        ilCmiXapiUser::updateFetchedUntilForObjects(
            new ilCmiXapiDateTime($this->getThisRunTS(), IL_CAL_UNIX),
            $objectIds
        );

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

        $this->writeThisAsLastRunTS();
        return $result;
    }

    protected function getXapiStatementsReport(
        ilObject $object,
        ilCmiXapiStatementsReportFilter $filter
    ): \ilCmiXapiStatementsReport {
        $filter->setActivityId($object->getActivityId());

        $linkBuilder = new ilCmiXapiStatementsReportLinkBuilder(
            $object->getId(),
            $object->getLrsType()->getLrsEndpointStatementsAggregationLink(),
            $filter
        );

        $request = new ilCmiXapiStatementsReportRequest(
            $object->getLrsType()->getBasicAuth(),
            $linkBuilder
        );

        return $request->queryReport($object->getId());
    }

    protected function buildReportFilter(): \ilCmiXapiStatementsReportFilter
    {
        $filter = new ilCmiXapiStatementsReportFilter();

        $start = $end = null;

        if ($this->getLastRunTS() !== 0) {
            $filter->setStartDate(new ilCmiXapiDateTime($this->getLastRunTS(), IL_CAL_UNIX));
            $start = $filter->getStartDate()->get(IL_CAL_DATETIME);
        }

        $filter->setEndDate(new ilCmiXapiDateTime($this->getThisRunTS(), IL_CAL_UNIX));
        $end = $filter->getEndDate()->get(IL_CAL_DATETIME);

        $this->log->debug("use filter from ($start) until ($end)");

        return $filter;
    }

    protected function getObjectsToBeReported(): array
    {
        return array_unique(array_merge(
            ilCmiXapiUser::getCmixObjectsHavingUsersMissingProxySuccess(),
            ilObjCmiXapi::getObjectsHavingBypassProxyEnabledAndRegisteredUsers()
        ));
    }
}