MDL-55980 Scheduled tasks: Run individual scheduled tasks from web

2017-02-24 10:42:28 +00:00
parent 0f59b6dd75
commit 38fa1ca558
10 changed files with 348 additions and 48 deletions
@@ -0,0 +1,101 @@
+<?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/>.
+
+/**
+ * Web cron single task
+ *
+ * This script runs a single scheduled task from the web UI.
+ *
+ * @package tool_task
+ * @copyright 2016 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require('../../../config.php');
+
+require_once($CFG->libdir.'/cronlib.php');
+
+/**
+ * Function used to handle mtrace by outputting the text to normal browser window.
+ *
+ * @param string $message Message to output
+ * @param string $eol End of line character
+ */
+function tool_task_mtrace_wrapper($message, $eol) {
+    echo s($message . $eol);
+    // Both types of flush may be necessary in order to actually output progressively to browser.
+    // It depends on the theme.
+    if (ob_get_status()) {
+        ob_flush();
+    }
+    flush();
+}
+
+// Allow execution of single task. This requires login and has different rules.
+$taskname = required_param('task', PARAM_RAW_TRIMMED);
+
+// Basic security checks.
+require_login();
+$context = context_system::instance();
+require_capability('moodle/site:config', $context);
+
+if (!get_config('tool_task', 'enablerunnow')) {
+    print_error('nopermissions', 'error', '', get_string('runnow', 'tool_task'));
+}
+
+// Check input parameter against all existing tasks (this ensures it isn't possible to
+// create some kind of security problem by specifying a class that isn't a task or whatever).
+$task = \core\task\manager::get_scheduled_task($taskname);
+if (!$task) {
+    print_error('cannotfindinfo', 'error', $taskname);
+}
+
+// Start output.
+$PAGE->set_url(new moodle_url('/admin/tool/task/schedule_task.php'));
+$PAGE->set_context($context);
+$PAGE->navbar->add(get_string('scheduledtasks', 'tool_task'), new moodle_url('/admin/tool/task/scheduledtasks.php'));
+$PAGE->navbar->add(s($task->get_name()));
+echo $OUTPUT->header();
+echo $OUTPUT->heading($task->get_name());
+
+// The initial request just shows the confirmation page; we don't do anything further unless
+// they confirm.
+if (!optional_param('confirm', 0, PARAM_INT)) {
+    echo $OUTPUT->confirm(get_string('runnow_confirm', 'tool_task', $task->get_name()),
+            new single_button(new moodle_url('/admin/tool/task/schedule_task.php',
+            array('task' => $taskname, 'confirm' => 1, 'sesskey' => sesskey())),
+            get_string('runnow', 'tool_task')),
+            new single_button(new moodle_url('/admin/tool/task/scheduledtasks.php'),
+            get_string('cancel'), false));
+    echo $OUTPUT->footer();
+    exit;
+}
+
+// Action requires session key.
+require_sesskey();
+
+// Prepare to handle output via mtrace.
+echo html_writer::start_tag('pre');
+$CFG->mtrace_wrapper = 'tool_task_mtrace_wrapper';
+
+// Run the specified task (this will output an error if it doesn't exist).
+cron_run_single_task($task);
+echo html_writer::end_tag('pre');
+
+$output = $PAGE->get_renderer('tool_task');
+echo $output->link_back();
+
+echo $OUTPUT->footer();