cron.php

Go to the documentation of this file.

<?php
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', array(
        'minute',
        'fiveminute',
        'fifteenmin',
        'halfhour',
        'hourly',
        'daily',
        'weekly',
        'monthly',
        'yearly',
        // reboot is deprecated and probably does not work
        'reboot',
    ));

    elgg_register_admin_menu_item('administer', 'cron', 'statistics');
}

function _elgg_cron_run() {
    $now = time();
    $params = array();
    $params['time'] = $now;

    $all_std_out = "";

    $periods = array(
        'minute' => 60,
        'fiveminute' => 300,
        'fifteenmin' => 900,
        'halfhour' => 1800,
        'hourly' => 3600,
        'daily' => 86400,
        'weekly' => 604800,
        'monthly' => 2628000,
        'yearly' => 31536000,
        'reboot' => 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;
}

function _elgg_cron_page_handler($page) {
    if (!isset($page[0])) {
        forward();
    }

    $period = strtolower($page[0]);

    $allowed_periods = elgg_get_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 = array();
        $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;
}

function _elgg_cron_monitor($hook, $period, $output, $params) {
    $time = $params['time'];
    $periods = elgg_get_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) {
    $events->registerHandler('init', 'system', '_elgg_cron_init');
};