Merge branch 'MDL-57822_master' of git://github.com/dmonllao/moodle
[moodle.git] / admin / tool / task / schedule_task.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Web cron single task
19  *
20  * This script runs a single scheduled task from the web UI.
21  *
22  * @package tool_task
23  * @copyright 2016 The Open University
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require('../../../config.php');
29 require_once($CFG->libdir.'/cronlib.php');
31 /**
32  * Function used to handle mtrace by outputting the text to normal browser window.
33  *
34  * @param string $message Message to output
35  * @param string $eol End of line character
36  */
37 function tool_task_mtrace_wrapper($message, $eol) {
38     echo s($message . $eol);
39     // Both types of flush may be necessary in order to actually output progressively to browser.
40     // It depends on the theme.
41     if (ob_get_status()) {
42         ob_flush();
43     }
44     flush();
45 }
47 // Allow execution of single task. This requires login and has different rules.
48 $taskname = required_param('task', PARAM_RAW_TRIMMED);
50 // Basic security checks.
51 require_login();
52 $context = context_system::instance();
53 require_capability('moodle/site:config', $context);
55 if (!get_config('tool_task', 'enablerunnow')) {
56     print_error('nopermissions', 'error', '', get_string('runnow', 'tool_task'));
57 }
59 // Check input parameter against all existing tasks (this ensures it isn't possible to
60 // create some kind of security problem by specifying a class that isn't a task or whatever).
61 $task = \core\task\manager::get_scheduled_task($taskname);
62 if (!$task) {
63     print_error('cannotfindinfo', 'error', $taskname);
64 }
66 // Start output.
67 $PAGE->set_url(new moodle_url('/admin/tool/task/schedule_task.php'));
68 $PAGE->set_context($context);
69 $PAGE->navbar->add(get_string('scheduledtasks', 'tool_task'), new moodle_url('/admin/tool/task/scheduledtasks.php'));
70 $PAGE->navbar->add(s($task->get_name()));
71 echo $OUTPUT->header();
72 echo $OUTPUT->heading($task->get_name());
74 // The initial request just shows the confirmation page; we don't do anything further unless
75 // they confirm.
76 if (!optional_param('confirm', 0, PARAM_INT)) {
77     echo $OUTPUT->confirm(get_string('runnow_confirm', 'tool_task', $task->get_name()),
78             new single_button(new moodle_url('/admin/tool/task/schedule_task.php',
79             array('task' => $taskname, 'confirm' => 1, 'sesskey' => sesskey())),
80             get_string('runnow', 'tool_task')),
81             new single_button(new moodle_url('/admin/tool/task/scheduledtasks.php'),
82             get_string('cancel'), false));
83     echo $OUTPUT->footer();
84     exit;
85 }
87 // Action requires session key.
88 require_sesskey();
90 // Prepare to handle output via mtrace.
91 echo html_writer::start_tag('pre');
92 $CFG->mtrace_wrapper = 'tool_task_mtrace_wrapper';
94 // Run the specified task (this will output an error if it doesn't exist).
95 cron_run_single_task($task);
96 echo html_writer::end_tag('pre');
98 $output = $PAGE->get_renderer('tool_task');
99 echo $output->link_back();
101 echo $OUTPUT->footer();