MDL-83424 core: Move admin/cli scripts to root directory

Note: Plugin-specific CLI directories cannot be moved.
2025-07-14 09:16:32 +07:00
parent 5eb64075f4
commit ba80ee68fb
31 changed files with 5 additions and 5 deletions
@@ -0,0 +1,174 @@
+<?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 <[email protected]>
+ * @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");
+
+list($options, $unrecognized) = cli_get_params(
+    [
+        'help' => false,
+        'showsql' => false,
+        'showdebugging' => false,
+        'execute' => false,
+        'keep-alive' => 0,
+        'ignorelimits' => false,
+        'force' => false,
+        'id' => null,
+        'classname' => null,
+        'taskslimit' => null,
+        'failed' => false,
+    ], [
+        'h' => 'help',
+        'e' => 'execute',
+        'k' => 'keep-alive',
+        'i' => 'ignorelimits',
+        'f' => 'force',
+        'c' => 'classname',
+        'l' => 'taskslimit',
+    ]
+);
+
+if ($unrecognized) {
+    $unrecognized = implode("\n  ", $unrecognized);
+    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
+}
+
+$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)
+ -l, --taskslimit=N        Run at most N tasks
+     --failed              Run only tasks that failed, ie those with a fail delay
+
+Run all queued tasks:
+\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --execute
+
+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
+
+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
+
+Run a specific task with debugging:
+\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --id=123456 --showsql --showdebugging
+
+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 (!get_config('core', 'cron_enabled') && !$options['force']) {
+    mtrace('Cron is disabled. Use --force to override.');
+    exit(1);
+}
+
+// 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);
+}
+
+// Process params.
+core_php_time_limit::raise();
+
+// Increase memory limit.
+raise_memory_limit(MEMORY_EXTRA);
+
+// Emulate normal session - we use admin account by default.
+\core\cron::setup_user();
+
+\core\local\cli\shutdown::script_supports_graceful_exit();
+$humantimenow = date('r', time());
+mtrace("Server Time: {$humantimenow}\n");
+
+$classname = $options['classname'];
+
+// 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);