Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are 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.
 *
 * @deprecated since Moodle 3.9 MDL-63580. Please use the admin/cli/adhoc_task.php.
< * @todo final deprecation. To be removed in Moodle 4.3 MDL-63594.
> * @todo final deprecation. To be removed in Moodle 4.1 MDL-63594.
* * @package tool_task * @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, 'ignorelimits' => false, ], [ 'h' => 'help', 'e' => 'execute', 'k' => 'keep-alive', 'i' => 'ignorelimits', ] ); debugging('admin/tool/task/cli/adhoc_task.php is deprecated. Please use admin/cli/adhoc_task.php instead.', DEBUG_DEVELOPER); 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 Example: \$sudo -u www-data /usr/bin/php admin/tool/task/cli/adhoc_task.php --execute EOT; echo $help; die; } if ($options['showdebugging']) { set_debugging(DEBUG_DEVELOPER, true); } if ($options['showsql']) { $DB->set_debug(true); } 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 (empty($options['keep-alive'])) { $options['keep-alive'] = 0; } if (!empty($CFG->showcronsql)) { $DB->set_debug(true); } if (!empty($CFG->showcrondebugging)) { set_debugging(DEBUG_DEVELOPER, true); } $checklimits = empty($options['ignorelimits']); 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(); $humantimenow = date('r', time()); $keepalive = (int)$options['keep-alive']; \core\local\cli\shutdown::script_supports_graceful_exit(); mtrace("Server Time: {$humantimenow}\n"); cron_run_adhoc_tasks(time(), $keepalive, $checklimits);