Elgg / Elgg

engine/classes/Elgg/Cron.php

<?php

namespace Elgg;

use DateTime;
use GO\Job;
use GO\Scheduler;
use Zend\Validator\Date;

/**
 * Cron
 *
 * @internal
 */
class Cron {

	use TimeUsing;

	static $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 *',
	];

	/**
	 * @var PluginHooksService
	 */
	protected $hooks;

	/**
	 * @var Printer
	 */
	protected $printer;

	/**
	 * Constructor
	 *
	 * @param PluginHooksService $hooks   Hooks service
	 * @param Printer            $printer Printer
	 */
	public function __construct(PluginHooksService $hooks, Printer $printer) {
		$this->hooks = $hooks;
		$this->printer = $printer;
	}

	/**
	 * Executes handlers for periods that have elapsed since last cron
	 *
	 * @param array $intervals Interval names to run
	 *
	 * @return Job[]
	 * @throws \CronException
	 */
	public function run(array $intervals = null) {

		if (!isset($intervals)) {
			$intervals = array_keys(self::$intervals);
		}

		$scheduler = new Scheduler();

		$time = $this->getCurrentTime();

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

			$scheduler
				->call(function () use ($interval, $time) {
					return $this->execute($interval, $time);
				})
				->at(self::$intervals[$interval])
				->before(function () use ($interval, $time) {
					$this->before($interval, $time);
				})
				->then(function ($output) use ($interval) {
					$this->after($output, $interval);
				});
		}

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

	/**
	 * Execute commands before cron interval is run
	 *
	 * @param string   $interval Interval name
	 * @param DateTime $time     Time of the cron initialization
	 *
	 * @return void
	 */
	protected function before($interval, DateTime $time = null) {

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

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

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

		$formatted_time = $time->format('r');

		$msg = elgg_echo('admin:cron:started', [$interval, $formatted_time]) . PHP_EOL;

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

	/**
	 * Execute handlers attached to a specific cron interval
	 *
	 * @param string   $interval Cron interval to execute
	 * @param DateTime $time     Time of cron initialization
	 *
	 * @return string
	 */
	protected function execute($interval, DateTime $time = null) {

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

		$output = [];

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

		ob_start();

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

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

		$time = $this->getCurrentTime();

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

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

	/**
	 * Printers handler result
	 *
	 * @param string $output   Output string
	 * @param string $interval Interval name
	 *
	 * @return void
	 */
	protected function after($output, $interval) {

		$time = new \DateTime();

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

		$this->printer->write($output, null, Logger::$verbosity);

The call to Elgg\Printer::write() has too many arguments starting with Elgg\Logger::verbosity.

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

	/**
	 * Populate sites private settings with cron info
	 *
	 * @param string $setting  'output'|'completion'
	 * @param string $interval Interval name
	 * @param string $msg      Logged message
	 *
	 * @return void
	 */
	protected function log($setting, $interval, $msg = '') {
		$suffix = $setting === 'completion' ? 'ts' : 'msg';
		$msg_key = "cron_latest:$interval:$suffix";

		elgg_get_site_entity()->setPrivateSetting($msg_key, $msg);
	}

}