Cron.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Exceptions\CronException;
use Elgg\Traits\Loggable;
use Elgg\Traits\TimeUsing;
use GO\Job;
use GO\Scheduler;

class Cron {

    use Loggable;
    use TimeUsing;

    protected $default_intervals = [
        'minute' => '* * * * *',
        'fiveminute' => '*/5 * * * *',
        'fifteenmin' => '*/15 * * * *',
        'halfhour' => '*/30 * * * *',
        'hourly' => '0 * * * *',
        'daily' => '0 0 * * *',
        'weekly' => '0 0 * * 0',
        'monthly' => '0 0 1 * *',
        'yearly' => '0 0 1 1 *',
    ];

    protected $events;

    public function __construct(EventsService $events) {
        $this->events = $events;
    }

    public function run(array $intervals = null, $force = false) {

        if (!isset($intervals)) {
            $intervals = array_keys($this->default_intervals);
        }
        
        $allowed_intervals = $this->getConfiguredIntervals();
        
        $scheduler = new Scheduler();
        $time = $this->getCurrentTime();

        foreach ($intervals as $interval) {
            if (!array_key_exists($interval, $allowed_intervals)) {
                throw new CronException("$interval is not a recognized cron interval");
            }

            $cron_interval = $force ? $allowed_intervals['minute'] : $allowed_intervals[$interval];

            $scheduler
                ->call(function () use ($interval, $time) {
                    return $this->execute($interval, $time);
                })
                ->at($cron_interval)
                ->before(function () use ($interval, $time) {
                    $this->before($interval, $time);
                })
                ->then(function ($output) use ($interval) {
                    $this->after($output, $interval);
                });
        }

        return $scheduler->run($time);
    }

    protected function before($interval, \DateTime $time = null) {

        if (!isset($time)) {
            $time = $this->getCurrentTime();
        }

        $this->events->triggerBefore('cron', $interval, $time);

        // give every period at least 'max_execution_time' (PHP ini setting)
        set_time_limit((int) ini_get('max_execution_time'));

        $now = new \DateTime();

        $msg = elgg_echo('admin:cron:started', [$interval, $time->format(DATE_RFC2822)]) . PHP_EOL;
        $msg .= elgg_echo('admin:cron:started:actual', [$interval, $now->format(DATE_RFC2822)]) . PHP_EOL;

        $this->cronLog('output', $interval, $msg);
    }

    protected function execute($interval, \DateTime $time = null) {

        if (!isset($time)) {
            $time = $this->getCurrentTime();
        }

        $now = new \DateTime();

        $output = [];

        $output[] = elgg_echo('admin:cron:started', [$interval, $time->format(DATE_RFC2822)]);
        $output[] = elgg_echo('admin:cron:started:actual', [$interval, $now->format(DATE_RFC2822)]);

        ob_start();

        $old_stdout = $this->events->triggerResults('cron', $interval, [
            'time' => $time->getTimestamp(),
            'dt' => $time,
        ], '');

        $output[] = ob_get_clean();
        $output[] = $old_stdout;

        $now = new \DateTime();

        $output[] = elgg_echo('admin:cron:complete', [$interval, $now->format(DATE_RFC2822)]);

        return implode(PHP_EOL, array_filter($output));
    }

    protected function after($output, $interval) {

        $time = new \DateTime();

        $this->cronLog('output', $interval, $output);
        $this->cronLog('completion', $interval, $time->getTimestamp());

        $this->getLogger()->info($output);

        $this->events->triggerAfter('cron', $interval, $time);
    }

    protected function cronLog($setting, $interval, $msg = '') {
        $suffix = $setting ?: 'output';
        
        $fh = new \ElggFile();
        $fh->owner_guid = elgg_get_site_entity()->guid;
        $fh->setFilename("{$interval}-{$suffix}.log");
        
        $fh->open('write');
        $fh->write($msg);
        $fh->close();
    }
    
    public function getLog($setting, $interval) {
        $suffix = $setting ?: 'output';
        
        $fh = new \ElggFile();
        $fh->owner_guid = elgg_get_site_entity()->guid;
        $fh->setFilename("{$interval}-{$suffix}.log");
        
        if (!$fh->exists()) {
            return '';
        }
        
        $contents = $fh->grabFile();
        if (!is_string($contents)) {
            $contents = '';
        }
        
        return $contents;
    }
    
    public function getConfiguredIntervals(bool $only_names = false) {
        $result = $this->events->triggerResults('cron:intervals', 'system', [], $this->default_intervals);
        if (!is_array($result)) {
            $this->getLogger()->warning("The event 'cron:intervals', 'system' should return an array, " . gettype($result) . ' given');
            
            $result = $this->default_intervals;
        }
        
        if ($only_names) {
            return array_keys($result);
        }
        
        return $result;
    }
}