class.ilCronManager.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCronManager implements \ilCronManagerInterface
{
    protected $settings;

    protected $logger;

    public function __construct(\ilSetting $settings, \ilLogger $logger)
    {
        $this->settings = $settings;
        $this->logger = $logger;
    }

    public function runActiveJobs()
    {
        $this->logger->info("CRON - batch start");

        $ts = time();
        $this->settings->set("last_cronjob_start_ts", $ts);

        $useRelativeDates = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        $this->logger->info(sprintf('Set last datetime to: %s', ilDatePresentation::formatDate(new ilDateTime($ts, IL_CAL_UNIX))));
        $this->logger->info(sprintf(
            'Verification of last run datetime (read from database): %s',
            ilDatePresentation::formatDate(
                new ilDateTime(ilSetting::_lookupValue('common', 'last_cronjob_start_ts'), IL_CAL_UNIX)
            )
        ));
        ilDatePresentation::setUseRelativeDates((bool) $useRelativeDates);

        // ilLink::_getStaticLink() should work in crons
        if (!defined("ILIAS_HTTP_PATH")) {
            define("ILIAS_HTTP_PATH", ilUtil::_getHttpPath());
        }

        // system
        foreach (self::getCronJobData(null, false) as $row) {
            $job = self::getJobInstanceById($row["job_id"]);
            if ($job) {
                // #18411 - we are NOT using the initial job data as it might be outdated at this point
                self::runJob($job);
            }
        }

        // plugins
        foreach (self::getPluginJobs(true) as $item) {
            self::runJob($item[0], $item[1]);
        }

        $this->logger->info("CRON - batch end");
    }
    
    public static function runJobManual($a_job_id)
    {
        global $DIC;

        $ilLog = $DIC->logger()->root();

        $result = false;
        
        $ilLog->write("CRON - manual start (" . $a_job_id . ")");
        
        $job = self::getJobInstanceById($a_job_id);
        if ($job) {
            if ($job->isManuallyExecutable()) {
                $result = self::runJob($job, null, true);
            } else {
                $ilLog->write("CRON - job " . $a_job_id . " is not intended to be executed manually");
            }
        } else {
            $ilLog->write("CRON - job " . $a_job_id . " seems invalid or is inactive");
        }
        
        $ilLog->write("CRON - manual end (" . $a_job_id . ")");
        
        return $result;
    }
        
    protected static function runJob(ilCronJob $a_job, array $a_job_data = null, $a_manual = false)
    {
        global $DIC;

        $ilLog = $DIC->logger()->root();
        $ilDB = $DIC->database();

        $did_run = false;
                
        include_once "Services/Cron/classes/class.ilCronJobResult.php";
        
        if ($a_job_data === null) {
            // aquire "fresh" job (status) data
            $jobData = self::getCronJobData($a_job->getId());
            $a_job_data = array_pop($jobData);
        }

        // already running?
        if ($a_job_data["alive_ts"]) {
            $ilLog->write("CRON - job " . $a_job_data["job_id"] . " still running");

            $cut = 60 * 60 * 3; // 3h

            // is running (and has not pinged) for 3 hours straight, we assume it crashed
            if (time() - $a_job_data["alive_ts"] > $cut) {
                $ilDB->manipulate("UPDATE cron_job SET" .
                    " running_ts = " . $ilDB->quote(0, "integer") .
                    " , alive_ts = " . $ilDB->quote(0, "integer") .
                    " WHERE job_id = " . $ilDB->quote($a_job_data["job_id"], "text"));

                self::deactivateJob($a_job); // #13082

                $result = new ilCronJobResult();
                $result->setStatus(ilCronJobResult::STATUS_CRASHED);
                $result->setCode(ilCronJobResult::CODE_SUPPOSED_CRASH);
                $result->setMessage("Cron job deactivated because it has been inactive for 3 hours");

                if (!$a_manual) {
                    self::sendNotification($a_job, $result);
                }

                self::updateJobResult($a_job, $result, $a_manual);

                $ilLog->write("CRON - job " . $a_job_data["job_id"] . " deactivated (assumed crash)");
            }
        }
        // initiate run?
        elseif ($a_job->isActive(
            $a_job_data["job_result_ts"],
            $a_job_data["schedule_type"],
            $a_job_data["schedule_value"],
            $a_manual
        )) {
            $ilLog->write("CRON - job " . $a_job_data["job_id"] . " started");

            $ilDB->manipulate("UPDATE cron_job SET" .
                " running_ts = " . $ilDB->quote(time(), "integer") .
                " , alive_ts = " . $ilDB->quote(time(), "integer") .
                " WHERE job_id = " . $ilDB->quote($a_job_data["job_id"], "text"));

            $ts_in = self::getMicrotime();
            try {
                $result = $a_job->run();
            } catch (\Exception $e) {
                $result = new \ilCronJobResult();
                $result->setStatus(\ilCronJobResult::STATUS_CRASHED);
                $result->setMessage(sprintf("Exception: %s", $e->getMessage()));

                $ilLog->error($e->getMessage());
                $ilLog->error($e->getTraceAsString());
            } catch (\Throwable $e) { // Could be appended to the catch block with a | in PHP 7.1
                $result = new \ilCronJobResult();
                $result->setStatus(\ilCronJobResult::STATUS_CRASHED);
                $result->setMessage(sprintf("Exception: %s", $e->getMessage()));

                $ilLog->error($e->getMessage());
                $ilLog->error($e->getTraceAsString());
            }
            $ts_dur = self::getMicrotime() - $ts_in;

            // no proper result
            if (!$result instanceof ilCronJobResult) {
                $result = new ilCronJobResult();
                $result->setStatus(ilCronJobResult::STATUS_CRASHED);
                $result->setCode(ilCronJobResult::CODE_NO_RESULT);
                $result->setMessage("Cron job did not return a proper result");

                if (!$a_manual) {
                    self::sendNotification($a_job, $result);
                }

                $ilLog->write("CRON - job " . $a_job_data["job_id"] . " no result");
            }
            // no valid configuration, job won't work
            elseif ($result->getStatus() == ilCronJobResult::STATUS_INVALID_CONFIGURATION) {
                self::deactivateJob($a_job);

                if (!$a_manual) {
                    self::sendNotification($a_job, $result);
                }

                $ilLog->write("CRON - job " . $a_job_data["job_id"] . " invalid configuration");
            }
            // success!
            else {
                $did_run = true;
            }

            $result->setDuration($ts_dur);

            self::updateJobResult($a_job, $result, $a_manual);

            $ilDB->manipulate("UPDATE cron_job SET" .
                " running_ts = " . $ilDB->quote(0, "integer") .
                " , alive_ts = " . $ilDB->quote(0, "integer") .
                " WHERE job_id = " . $ilDB->quote($a_job_data["job_id"], "text"));

            $ilLog->write("CRON - job " . $a_job_data["job_id"] . " finished");
        } else {
            $ilLog->write("CRON - job " . $a_job_data["job_id"] . " returned status inactive");
        }
        
        return $did_run;
    }
    
    public static function getJobInstanceById($a_job_id)
    {
        global $DIC;

        $ilLog = $DIC->logger()->root();
        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        // plugin
        if (substr($a_job_id, 0, 4) == "pl__") {
            $parts = explode("__", $a_job_id);
            $pl_name = $parts[1];
            $job_id = $parts[2];
            if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "Cron", "crnhk", $pl_name)) {
                $plugin_obj = $ilPluginAdmin->getPluginObject(
                    IL_COMP_SERVICE,
                    "Cron",
                    "crnhk",
                    $pl_name
                );
                $job = $plugin_obj->getCronJobInstance($job_id);
                if ($job instanceof ilCronJob) {
                    // should never happen but who knows...
                    if (!sizeof(ilCronManager::getCronJobData($job_id))) {
                        // as job is not "imported" from xml
                        ilCronManager::createDefaultEntry($job, $pl_name, IL_COMP_PLUGIN, "");
                    }
                    return $job;
                }
            }
            
            return null;
        }
        // system
        else {
            $job_data = self::getCronJobData($a_job_id);
            $job_data = array_pop($job_data);
            if ($job_data["job_id"] == $a_job_id) {
                return self::getJobInstance(
                    $job_data["job_id"],
                    $job_data["component"],
                    $job_data["class"],
                    $job_data["path"]
                );
            }
        }
        
        $ilLog->write("CRON - job " . $a_job_id . " seems invalid or is inactive");
    }
    
    public static function getJobInstance($a_id, $a_component, $a_class, $a_path = null)
    {
        global $DIC;

        $ilLog = $DIC->logger()->root();

        if (!$a_path) {
            $a_path = $a_component . "/classes/";
        }
        $class_file = $a_path . "class." . $a_class . ".php";
        if (file_exists($class_file)) {
            include_once $class_file;
            if (class_exists($a_class)) {
                $refl = new \ReflectionClass($a_class);
                $job = $refl->newInstanceWithoutConstructor();
                if ($refl->isSubclassOf(\ilCronJob::class)) {
                    if (0 === strlen($job->getId()) || !isset($_SERVER['PHP_SELF']) || basename($_SERVER['PHP_SELF']) !== 'setup.php') {
                        $job = new $a_class;
                    }

                    if ($job->getId() === $a_id) {
                        return $job;
                    } else {
                        $mess .= " - job id mismatch";
                    }
                } else {
                    $mess .= " - does not extend ilCronJob";
                }
            } else {
                $mess = "- class not found in file";
            }
        } else {
            $mess = " - class file not found";
        }
        
        $ilLog->write("Cron XML - Job " . $a_id . " in class " . $a_class . " (" .
            $class_file . ") is invalid." . $mess);
    }
    
    protected static function sendNotification(ilCronJob $a_job, $a_message)
    {
        // :TODO:
    }
    
    public static function createDefaultEntry(ilCronJob $a_job, $a_component, $a_class, $a_path)
    {
        global $DIC;

        $ilLog = $DIC->logger()->root();
        $ilDB = $DIC->database();

        if (!isset($DIC["ilSetting"])) {
            $DIC["ilSetting"] = function ($c) {
                return new ilSetting();
            };
        }

        $ilSetting = $DIC->settings();

        // already exists?
        $sql = "SELECT job_id, schedule_type, component, class, path FROM cron_job" .
            " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text");
        $set = $ilDB->query($sql);
        $row = $ilDB->fetchAssoc($set);
        $job_exists = ($row["job_id"] == $a_job->getId());
        $schedule_type = $row["schedule_type"];

        if ($job_exists && (
            $row['component'] != $a_component ||
            $row['class'] != $a_class ||
            $row['path'] != $a_path
        )) {
            $ilDB->manipulateF(
                'UPDATE cron_job SET component = %s, class = %s, path = %s WHERE job_id = %s',
                ['text', 'text', 'text', 'text'],
                [$a_component, $a_class, $a_path, $a_job->getId()]
            );
        }

        // new job
        if (!$job_exists) {
            $sql = "INSERT INTO cron_job (job_id, component, class, path)" .
                " VALUES (" . $ilDB->quote($a_job->getId(), "text") . ", " .
                $ilDB->quote($a_component, "text") . ", " .
                $ilDB->quote($a_class, "text") . ", " .
                $ilDB->quote($a_path, "text") . ")";
            $ilDB->manipulate($sql);
            
            $ilLog->write("Cron XML - Job " . $a_job->getId() . " in class " . $a_class .
                " added.");

            // only if flexible
            self::updateJobSchedule(
                $a_job,
                $a_job->getDefaultScheduleType(),
                $a_job->getDefaultScheduleValue()
            );
            
            // #12221
            if (!is_object($ilSetting)) {
                include_once "Services/Administration/classes/class.ilSetting.php";
                $ilSetting = new ilSetting();
            }

            if ($a_job->hasAutoActivation()) {
                self::activateJob($a_job);
            } else {
                // to overwrite dependent settings
                $a_job->activationWasToggled(false);
            }
        }
        // existing job - but schedule is flexible now
        elseif ($a_job->hasFlexibleSchedule() && !$schedule_type) {
            self::updateJobSchedule(
                $a_job,
                $a_job->getDefaultScheduleType(),
                $a_job->getDefaultScheduleValue()
            );
        }
        // existing job - but schedule is static now
        elseif (!$a_job->hasFlexibleSchedule() && $schedule_type) {
            self::updateJobSchedule($a_job, null, null);
        }
    }
    
    public static function updateFromXML($a_component, $a_id, $a_class, $a_path = null)
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$ilDB->tableExists("cron_job")) {
            return;
        }
        
        // only if job seems valid
        $job = self::getJobInstance($a_id, $a_component, $a_class, $a_path);
        if ($job) {
            self::createDefaultEntry($job, $a_component, $a_class, $a_path);
        }
    }
    
    public static function clearFromXML($a_component, array $a_xml_job_ids)
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilLog = $DIC->logger()->root();

        if (!$ilDB->tableExists("cron_job")) {
            return;
        }
        
        // gather existing jobs
        $all_jobs = array();
        $sql = "SELECT job_id FROM cron_job" .
            " WHERE component = " . $ilDB->quote($a_component, "text");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $all_jobs[] = $row["job_id"];
        }
        
        if (sizeof($all_jobs)) {
            if (sizeof($a_xml_job_ids)) {
                // delete obsolete job data
                foreach ($all_jobs as $job_id) {
                    if (!in_array($job_id, $a_xml_job_ids)) {
                        $ilDB->manipulate("DELETE FROM cron_job" .
                            " WHERE component = " . $ilDB->quote($a_component, "text") .
                            " AND job_id = " . $ilDB->quote($job_id, "text"));

                        $ilLog->write("Cron XML - Job " . $job_id . " in class " . $a_component .
                                " deleted.");
                    }
                }
            } else {
                $ilDB->manipulate("DELETE FROM cron_job" .
                    " WHERE component = " . $ilDB->quote($a_component, "text"));

                $ilLog->write("Cron XML - All jobs deleted for " . $a_component . " as component is inactive.");
            }
        }
    }
    
    public static function getPluginJobs($a_only_active = false)
    {
        global $DIC;

        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        $res = array();
        
        foreach ($ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Cron", "crnhk") as $pl_name) {
            $plugin_obj = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE, "Cron", "crnhk", $pl_name);
                                
            foreach ((array) $plugin_obj->getCronJobInstances() as $job) {
                $jobData = ilCronManager::getCronJobData($job->getId());
                $item = array_pop($jobData);
                if (!is_array($item) || 0 === count($item)) {
                    // as job is not "imported" from xml
                    ilCronManager::createDefaultEntry($job, $pl_name, IL_COMP_PLUGIN, "");
                }

                $jobData = ilCronManager::getCronJobData($job->getId());
                $item = array_pop($jobData);

                // #17941
                if (!$a_only_active ||
                    $item["job_status"] == 1) {
                    $res[$job->getId()] = array($job, $item);
                }
            }
        }
        
        return $res;
    }
    
    public static function getCronJobData($a_id = null, $a_include_inactive = true)
    {
        global $DIC;
        $ilDB = $DIC->database();

        $res = array();
        
        if ($a_id && !is_array($a_id)) {
            $a_id = array($a_id);
        }
        
        $sql = "SELECT * FROM cron_job";
        
        $where = array();
        if ($a_id) {
            $where[] = $ilDB->in("job_id", $a_id, "", "text");
        } else {
            $where[] = "class <> " . $ilDB->quote(IL_COMP_PLUGIN, "text");
        }
        if (!$a_include_inactive) {
            $where[] = "job_status = " . $ilDB->quote(1, "integer");
        }
        if (sizeof($where)) {
            $sql .= " WHERE " . implode(" AND ", $where);
        }
        
        // :TODO: discuss job execution order
        $sql .= " ORDER BY job_id";
        
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        
        return $res;
    }
    
    public static function resetJob(ilCronJob $a_job)
    {
        global $DIC;
        $ilDB = $DIC->database();

        include_once "Services/Cron/classes/class.ilCronJobResult.php";
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_RESET);
        $result->setCode(ilCronJobResult::CODE_MANUAL_RESET);
        $result->setMessage("Cron job re-activated by admin");
        self::updateJobResult($a_job, $result, true);
                
        $ilDB->manipulate("UPDATE cron_job" .
            " SET running_ts = " . $ilDB->quote(0, "integer") .
            " , alive_ts = " . $ilDB->quote(0, "integer") .
            " , job_result_ts = " . $ilDB->quote(0, "integer") .
            " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text"));
        
        self::activateJob($a_job, true);
    }
    
    public static function activateJob(ilCronJob $a_job, $a_manual = false)
    {
        global $DIC;
        $ilDB = $DIC->database();

        $user_id = 0;
        if ($DIC->isDependencyAvailable('user')) {
            $user = $DIC->user();
            $user_id = $a_manual ? $user->getId() : 0;
        }

        $sql = "UPDATE cron_job SET " .
            " job_status = " . $ilDB->quote(1, "integer") .
            " , job_status_user_id = " . $ilDB->quote($user_id, "integer") .
            " , job_status_type = " . $ilDB->quote($a_manual, "integer") .
            " , job_status_ts = " . $ilDB->quote(time(), "integer") .
            " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text");
        $ilDB->manipulate($sql);
        
        $a_job->activationWasToggled(true);
    }
    
    public static function deactivateJob(ilCronJob $a_job, $a_manual = false)
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        $user_id = $a_manual ? $ilUser->getId() : 0;
        
        $sql = "UPDATE cron_job SET " .
            " job_status = " . $ilDB->quote(0, "integer") .
            " , job_status_user_id = " . $ilDB->quote($user_id, "integer") .
            " , job_status_type = " . $ilDB->quote($a_manual, "integer") .
            " , job_status_ts = " . $ilDB->quote(time(), "integer") .
            " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text");
        $ilDB->manipulate($sql);
                
        $a_job->activationWasToggled(false);
    }
    
    public static function isJobActive($a_job_id)
    {
        $job = self::getCronJobData($a_job_id);
        if ((bool) $job[0]["job_status"]) {
            return true;
        }
        return false;
    }
    
    public static function isJobInactive($a_job_id)
    {
        $job = self::getCronJobData($a_job_id);
        if (!(bool) $job[0]["job_status"]) {
            return true;
        }
        return false;
    }
    
    protected static function updateJobResult(ilCronJob $a_job, ilCronJobResult $a_result, $a_manual = false)
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        $user_id = $a_manual ? $ilUser->getId() : 0;
        
        $sql = "UPDATE cron_job SET " .
            " job_result_status = " . $ilDB->quote($a_result->getStatus(), "integer") .
            " , job_result_user_id = " . $ilDB->quote($user_id, "integer") .
            " , job_result_code = " . $ilDB->quote($a_result->getCode(), "text") .
            " , job_result_message = " . $ilDB->quote($a_result->getMessage(), "text") .
            " , job_result_type = " . $ilDB->quote($a_manual, "integer") .
            " , job_result_ts = " . $ilDB->quote(time(), "integer") .
            " , job_result_dur = " . $ilDB->quote($a_result->getDuration() * 1000, "integer") .
            " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text");
        $ilDB->manipulate($sql);
    }
    
    public static function updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
    {
        global $DIC;
        $ilDB = $DIC->database();

        if ($a_schedule_type === null ||
            ($a_job->hasFlexibleSchedule() &&
                in_array($a_schedule_type, $a_job->getValidScheduleTypes()))) {
            $sql = "UPDATE cron_job SET " .
                " schedule_type = " . $ilDB->quote($a_schedule_type, "integer") .
                " , schedule_value = " . $ilDB->quote($a_schedule_value, "integer") .
                " WHERE job_id = " . $ilDB->quote($a_job->getId(), "text");
            $ilDB->manipulate($sql);
        }
    }
    
    protected static function getMicrotime()
    {
        list($usec, $sec) = explode(" ", microtime());
        return ((float) $usec + (float) $sec);
    }
    
    public static function ping($a_job_id)
    {
        global $DIC;
        $ilDB = $DIC->database();

        $ilDB->manipulate("UPDATE cron_job SET " .
            " alive_ts = " . $ilDB->quote(time(), "integer") .
            " WHERE job_id = " . $ilDB->quote($a_job_id, "text"));
    }
}