Elgg / Elgg

engine/lib/cron.php

<?php
/**
 * Elgg cron library.
 *
 * @package    Elgg.Core
 * @subpackage Cron
 */

/**
 * Cron initialization
 *
 * @return void
 * @access private
 */
function _elgg_cron_init() {
	elgg_register_page_handler('cron', '_elgg_cron_page_handler');

	elgg_register_plugin_hook_handler('cron', 'all', '_elgg_cron_monitor', 1000);

	elgg_set_config('elgg_cron_periods', [
		'minute',
		'fiveminute',
		'fifteenmin',
		'halfhour',
		'hourly',
		'daily',
		'weekly',
		'monthly',
		'yearly',
	]);

	elgg_register_menu_item('page', [
		'name' => 'cron',
		'text' => elgg_echo('admin:cron'),
		'href' => 'admin/cron',
		'section' => 'information',
		'context' => 'admin',
	]);
}

/**
 * Cron run
 *
 * This function was designed to be called every one minute from a cron job to
 * executes each Elgg cron period at the desired interval.  Will also exeute
 * any Elgg cron period that have not fired by the expected deadline.
 *
 * Can be called manually by: http://YOUR.SITE/cron/run/
 *
 * This will only execute cron periods at specified intervals to force execution
 * of a specific period you will need to use http://YOUR.SITE/cron/<period>/
 *
 * @access private
 */
function _elgg_cron_run() {
	$now = time();
	$params = [];
	$params['time'] = $now;

	$all_std_out = "";

	$periods = [
		'minute' => 60,
		'fiveminute' => 300,
		'fifteenmin' => 900,
		'halfhour' => 1800,
		'hourly' => 3600,
		'daily' => 86400,
		'weekly' => 604800,
		'monthly' => 2628000,
		'yearly' => 31536000,
	];

	foreach ($periods as $period => $interval) {
		$key = "cron_latest:$period:ts";
		$ts = elgg_get_site_entity()->getPrivateSetting($key);
		$deadline = $ts + $interval;

		if ($now > $deadline) {
			$msg_key = "cron_latest:$period:msg";
			$msg = elgg_echo('admin:cron:started', [$period, date('r', time())]);
			elgg_get_site_entity()->setPrivateSetting($msg_key, $msg);

			ob_start();
			
			$old_stdout = elgg_trigger_plugin_hook('cron', $period, $params, '');
			$std_out = ob_get_clean();

			$period_std_out = $std_out .  $old_stdout;
			$all_std_out .= $period_std_out;

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

	echo $all_std_out;
}

/**
 * Cron handler
 *
 * @param array $page Pages
 *
 * @return bool
 * @throws CronException
 * @access private
 */
function _elgg_cron_page_handler($page) {
	if (!isset($page[0])) {
		forward();
	}

	if (PHP_SAPI !== 'cli' && _elgg_config()->security_protect_cron) {
		elgg_signed_request_gatekeeper();
	}
	
	$period = strtolower($page[0]);

	$allowed_periods = _elgg_config()->elgg_cron_periods;

	if (($period != 'run') && !in_array($period, $allowed_periods)) {
		throw new \CronException("$period is not a recognized cron period.");
	}

	if ($period == 'run') {
		_elgg_cron_run();
	} else {
		// Get a list of parameters
		$params = [];
		$params['time'] = time();

		// Data to return to
		$old_stdout = "";
		ob_start();

		$msg_key = "cron_latest:$period:msg";
		$msg = elgg_echo('admin:cron:started', [$period, date('r', time())]);
		elgg_get_site_entity()->setPrivateSetting($msg_key, $msg);
		
		$old_stdout = elgg_trigger_plugin_hook('cron', $period, $params, $old_stdout);
		$std_out = ob_get_clean();

		$msg = $std_out . $old_stdout;
		echo $msg;

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

/**
 * Record cron running
 *
 * @param string $hook   Hook name
 * @param string $period Cron period
 * @param string $output Output content
 * @param array  $params Hook parameters
 * @return void
 * @access private
 */
function _elgg_cron_monitor($hook, $period, $output, $params) {
	$time = $params['time'];
	$periods = _elgg_config()->elgg_cron_periods;

	if (in_array($period, $periods)) {
		$key = "cron_latest:$period:ts";
		elgg_get_site_entity()->setPrivateSetting($key, $time);
		echo elgg_echo('admin:cron:complete', [$period, date('r', $time)]);
	}
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {

The parameter $hooks is not used and could be removed.

	$events->registerHandler('init', 'system', '_elgg_cron_init');
};