Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Task executor for adhoc tasks.
 *
 * @package    core
 * @subpackage cli
 * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

define('CLI_SCRIPT', true);

require(__DIR__ . '/../../config.php');
require_once("{$CFG->libdir}/clilib.php");
< require_once("{$CFG->libdir}/cronlib.php");
list($options, $unrecognized) = cli_get_params( [
< 'execute' => false,
'help' => false,
< 'keep-alive' => 0,
'showsql' => false, 'showdebugging' => false,
> 'execute' => false, 'ignorelimits' => false, > 'keep-alive' => 0,
'force' => false,
> 'id' => null, ], [ > 'classname' => null, 'h' => 'help', > 'taskslimit' => null, 'e' => 'execute', > 'failed' => false,
'k' => 'keep-alive', 'i' => 'ignorelimits', 'f' => 'force',
> 'c' => 'classname', ] > 'l' => 'taskslimit',
); if ($unrecognized) { $unrecognized = implode("\n ", $unrecognized); cli_error(get_string('cliunknowoption', 'admin', $unrecognized)); }
< if ($options['help'] or empty($options['execute'])) {
$help = <<<EOT Ad hoc cron tasks. Options: -h, --help Print out this help --showsql Show sql queries before they are executed --showdebugging Show developer level debugging information -e, --execute Run all queued adhoc tasks -k, --keep-alive=N Keep this script alive for N seconds and poll for new adhoc tasks -i --ignorelimits Ignore task_adhoc_concurrency_limit and task_adhoc_max_runtime limits -f, --force Run even if cron is disabled
> --id Run (failed) task with id > -c, --classname Run tasks with a certain classname (FQN) Example: > -l, --taskslimit=N Run at most N tasks \$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --execute > --failed Run only tasks that failed, ie those with a fail delay
< Example:
> Run all queued tasks:
< EOT;
> Run all queued tasks of specific class: > \$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --classname=\\\\core_course\\\\task\\\\course_delete_modules
< echo $help; < die; < }
> Double backslash for the shell escape reasons. > Run a specific task: > \$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --id=123456
< if ($options['showdebugging']) { < set_debugging(DEBUG_DEVELOPER, true); < }
> Run a specific task with debugging: > \$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --id=123456 --showsql --showdebugging
< if ($options['showsql']) { < $DB->set_debug(true);
> To profile a long running task: > \$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --taskslimit=1 --classname='\\some\\class\\name' --ignorelimits > > EOT; > > if ($options['help']) { > echo $help; > exit(0);
} if (CLI_MAINTENANCE) { echo "CLI maintenance mode active, cron execution suspended.\n"; exit(1); } if (moodle_needs_upgrading()) { echo "Moodle upgrade pending, cron execution suspended.\n"; exit(1); }
< if (empty($options['execute'])) { < exit(0); < } <
if (!get_config('core', 'cron_enabled') && !$options['force']) { mtrace('Cron is disabled. Use --force to override.'); exit(1); }
< if (empty($options['keep-alive'])) { < $options['keep-alive'] = 0;
> // Common debugging options. > if ($options['showdebugging']) { > set_debugging(DEBUG_DEVELOPER, true); > } > > if ($options['showsql']) { > $DB->set_debug(true);
} if (!empty($CFG->showcronsql)) { $DB->set_debug(true); } if (!empty($CFG->showcrondebugging)) { set_debugging(DEBUG_DEVELOPER, true); }
< $checklimits = empty($options['ignorelimits']); <
> // Process params.
core_php_time_limit::raise(); // Increase memory limit. raise_memory_limit(MEMORY_EXTRA); // Emulate normal session - we use admin account by default.
< cron_setup_user();
> \core\cron::setup_user();
> \core\local\cli\shutdown::script_supports_graceful_exit();
$humantimenow = date('r', time());
< $keepalive = (int)$options['keep-alive'];
> mtrace("Server Time: {$humantimenow}\n");
< \core\local\cli\shutdown::script_supports_graceful_exit();
> $classname = $options['classname'];
< mtrace("Server Time: {$humantimenow}\n"); < cron_run_adhoc_tasks(time(), $keepalive, $checklimits);
> // Run a single adhoc task only, if requested. > if (!empty($options['id'])) { > $taskid = (int) $options['id']; > \core\cron::run_adhoc_task($taskid); > exit(0); > } > > // Run all failed tasks. > if (!empty($options['failed'])) { > \core\cron::run_failed_adhoc_tasks($classname); > exit(0); > } > > // Examine params and determine if we should run. > $execute = (bool) $options['execute']; > $keepalive = empty($options['keep-alive']) ? 0 : (int) $options['keep-alive']; > $taskslimit = empty($options['taskslimit']) ? null : (int) $options['taskslimit']; > $checklimits = empty($options['ignorelimits']); > > if ($classname || $keepalive || $taskslimit) { > $execute = true; > } > > // Output the help text if no criteria for running the adhoc tasks are given. > if (!$execute) { > echo $help; > exit(0); > } > > \core\cron::run_adhoc_tasks(time(), $keepalive, $checklimits, null, $taskslimit, $classname);