Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.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/>.

/**
 * Output rendering for the plugin.
 *
 * @package     tool_task
 * @copyright   2014 Damyon Wiese
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

use core\task\scheduled_task;


/**
 * Implements the plugin renderer
 *
 * @copyright 2014 Damyon Wiese
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class tool_task_renderer extends plugin_renderer_base {
> /** > /** * This function will render one beautiful table with all the scheduled tasks. > * This function will render a table with the summary of all adhoc tasks. * > * * @param \core\task\scheduled_task[] $tasks - list of all scheduled tasks. > * @param array $summary * @param string $lastchanged (optional) the last task edited. Gets highlighted in teh table. > * @return string HTML to output. * @return string HTML to output. > */ */ > public function adhoc_tasks_summary_table(array $summary): string { public function scheduled_tasks_table($tasks, $lastchanged = '') { > $adhocurl = '/admin/tool/task/adhoctasks.php'; global $CFG; > $adhocrunurl = '/admin/tool/task/run_adhoctasks.php'; > $showloglink = \core\task\logmanager::has_log_report(); > // Main tasks table. > $table = new html_table(); $table = new html_table(); > $table->caption = get_string('adhoctasks', 'tool_task'); $table->caption = get_string('scheduledtasks', 'tool_task'); > $table->head = [ $table->head = [ > get_string('component', 'tool_task') . ' / ' . get_string('classname', 'tool_task'), get_string('name'), > get_string('adhoctasksrunning', 'tool_task'), get_string('component', 'tool_task'), > get_string('adhoctasksdue', 'tool_task'), get_string('edit'), > get_string('adhoctasksfuture', 'tool_task'), get_string('logs'), > get_string('adhoctasksfailed', 'tool_task'), get_string('lastruntime', 'tool_task'), > get_string('nextruntime', 'tool_task'), get_string('nextruntime', 'tool_task'), > ]; get_string('taskscheduleminute', 'tool_task'), > get_string('taskschedulehour', 'tool_task'), > $table->attributes['class'] = 'admintable generaltable'; get_string('taskscheduleday', 'tool_task'), > $table->colclasses = []; get_string('taskscheduledayofweek', 'tool_task'), > get_string('taskschedulemonth', 'tool_task'), > // For each task entry (row) show action buttons/logs link depending on the user permissions. get_string('faildelay', 'tool_task'), > $data = []; get_string('default', 'tool_task'), > $canruntasks = \core\task\manager::is_runnable() && get_config('tool_task', 'enablerunnow'); ]; > foreach ($summary as $component => $classes) { > // Component cell. $table->attributes['class'] = 'admintable generaltable'; > $componentcell = new html_table_cell($component); $table->colclasses = []; > $componentcell->header = true; > $componentcell->id = "tasks-$component"; if (!$showloglink) { > $componentcell->colspan = 6; // Hide the log links. > $table->colclasses['3'] = 'hidden'; > $data[] = new html_table_row([$componentcell]); } > > foreach ($classes as $classname => $stats) { $data = []; > // Task class cell. $yes = get_string('yes'); > $classbits = explode('\\', $classname); $no = get_string('no'); > $classcontent = html_writer::link( $canruntasks = \core\task\manager::is_runnable(); > new moodle_url($adhocurl, ['classname' => $classname]), foreach ($tasks as $task) { > end($classbits) $classname = get_class($task); > ); $defaulttask = \core\task\manager::get_default_scheduled_task($classname, false); > $classcell = new html_table_cell($classcontent); > $classcell->header = true; $customised = $task->is_customised() ? $no : $yes; > $classcell->attributes['class'] = "task-class-summary text-ltr"; if (empty($CFG->preventscheduledtaskchanges) && !$task->is_overridden()) { > $configureurl = new moodle_url('/admin/tool/task/scheduledtasks.php', > $duecontent = $stats['due']; ['action' => 'edit', 'task' => $classname]); > if ($canruntasks && ($stats['due'] > 0 || $stats['failed'] > 0)) { $editlink = $this->output->action_icon($configureurl, new pix_icon('t/edit', > $duecontent .= html_writer::div( get_string('edittaskschedule', 'tool_task', $task->get_name()))); > html_writer::link( } else { > new moodle_url( $editlink = $this->render(new pix_icon('t/locked', > $adhocrunurl, get_string('scheduledtaskchangesdisabled', 'tool_task'))); > ['classname' => $classname] } > ), > get_string('runclassname', 'tool_task') $loglink = ''; > ), if ($showloglink) { > 'task-runnow' $loglink = $this->output->action_icon( > ); \core\task\logmanager::get_url_for_task_class($classname), > } new pix_icon('e/file-text', get_string('viewlogs', 'tool_task', $task->get_name()) > )); > // Mark cell if has failed tasks. } > $failed = $stats['failed']; > if ($canruntasks && $failed > 0) { $namecellcontent = $task->get_name() . "\n" . > $failed .= html_writer::div( html_writer::span('\\' . $classname, 'task-class text-ltr'); > html_writer::link( if ($task->is_overridden()) { > new moodle_url( // Let the user know the scheduled task is defined in config. > $adhocrunurl, $namecellcontent .= "\n" . html_writer::div(get_string('configoverride', 'admin'), 'alert-info'); > ['classname' => $classname, 'failedonly' => 1] } > ), $namecell = new html_table_cell($namecellcontent); > get_string('runclassnamefailedonly', 'tool_task') $namecell->header = true; > ), > 'task-runnow' $plugininfo = core_plugin_manager::instance()->get_plugin_info($task->get_component()); > ); $plugindisabled = $plugininfo && $plugininfo->is_enabled() === false && > } !$task->get_run_if_component_disabled(); > $failedcell = new html_table_cell($failed); $disabled = $plugindisabled || $task->get_disabled(); > if ($failed > 0) { > $failedcell->attributes['class'] = 'table-danger'; $runnow = ''; > } if (!$plugindisabled && get_config('tool_task', 'enablerunnow') && $canruntasks ) { > $runnow = html_writer::div(html_writer::link( > // Prepares the next run time cell contents. new moodle_url('/admin/tool/task/schedule_task.php', > $nextrun = ''; ['task' => $classname]), > if ($stats['due'] > 0) { get_string('runnow', 'tool_task')), 'task-runnow'); > $nextrun = get_string('asap', 'tool_task'); } > } else if ($stats['nextruntime']) { > $nextrun = userdate($stats['nextruntime']); $faildelaycell = new html_table_cell($task->get_fail_delay()); > } if ($task->get_fail_delay()) { > $faildelaycell->text .= html_writer::div(html_writer::link( > $data[] = new html_table_row([ new moodle_url('/admin/tool/task/clear_fail_delay.php', > $classcell, ['task' => $classname, 'sesskey' => sesskey()]), > new html_table_cell($stats['running']), get_string('clear')), 'task-clearfaildelay'); > new html_table_cell($duecontent), $faildelaycell->attributes['class'] = 'table-danger'; > new html_table_cell($stats['count'] - $stats['running'] - $stats['due']), } > $failedcell, > new html_table_cell($nextrun), $row = new html_table_row([ > ]); $namecell, > } new html_table_cell($this->component_name($task->get_component())), > } new html_table_cell($editlink), > $table->data = $data; new html_table_cell($loglink), > return html_writer::table($table); new html_table_cell($this->last_run_time($task) . $runnow), > } new html_table_cell($this->next_run_time($task)), > $this->time_cell($task->get_minute(), $defaulttask->get_minute()), > /** $this->time_cell($task->get_hour(), $defaulttask->get_hour()), > * This function will render a table with all the adhoc tasks for the class. $this->time_cell($task->get_day(), $defaulttask->get_day()), > * $this->time_cell($task->get_day_of_week(), $defaulttask->get_day_of_week()), > * @param string $classname $this->time_cell($task->get_month(), $defaulttask->get_month()), > * @param array $tasks - list of all adhoc tasks. $faildelaycell, > * @param array|null $params new html_table_cell($customised)]); > * @return string HTML to output. > */ $classes = []; > public function adhoc_tasks_class_table(string $classname, array $tasks, ?array $params = []): string { if ($disabled) { > $adhocurl = '/admin/tool/task/adhoctasks.php'; $classes[] = 'disabled'; > $adhocrunurl = '/admin/tool/task/run_adhoctasks.php'; } > $showloglink = \core\task\logmanager::has_log_report(); if (get_class($task) == $lastchanged) { > $failedonly = !empty($params['failedonly']); $classes[] = 'table-primary'; > $canruntasks = \core\task\manager::is_runnable() && get_config('tool_task', 'enablerunnow'); } > $row->attributes['class'] = implode(' ', $classes); > // Depending on the currently set parameters, set up toggle buttons. $data[] = $row; > $failedorall = html_writer::link( } > new moodle_url( $table->data = $data; > $adhocurl, if ($lastchanged) { > array_merge($params, ['classname' => $classname, 'failedonly' => !$failedonly]) // IE does not support this, and the ancient version of Firefox we use for Behat > ), // has the method, but then errors on 'centre'. So, just try to scroll, and if it fails, don't care. > get_string($failedonly ? 'showall' : 'showfailedonly', 'tool_task') $this->page->requires->js_init_code( > ); 'try{document.querySelector("tr.table-primary").scrollIntoView({block: "center"});}catch(e){}'); > } > // Main tasks table. return html_writer::table($table); > $table = $this->generate_adhoc_tasks_simple_table($tasks, $canruntasks); } > > $table->caption = s($classname) . " " /** > . get_string($failedonly ? 'adhoctasksfailed' : 'adhoctasks', 'tool_task'); * Nicely display the name of a component, with its disabled status and internal name. > $table->head[3] .= " $failedorall"; // Spice up faildelay heading. * > * @param string $component component name, e.g. 'core' or 'mod_forum'. > if ($showloglink) { * @return string HTML. > // Insert logs as the second col. */ > array_splice($table->head, 1, 0, [get_string('logs')]); public function component_name(string $component): string { > array_walk($table->data, function ($row, $idx) use ($classname) { list($type) = core_component::normalize_component($component); > $loglink = ''; if ($type === 'core') { > $faildelaycell = $row->cells[3]; return get_string('corecomponent', 'tool_task'); > if ($faildelaycell->attributes['class'] == 'table-danger') { } > // Failed task. > $loglink = $this->output->action_icon( $plugininfo = core_plugin_manager::instance()->get_plugin_info($component); > \core\task\logmanager::get_url_for_task_class($classname), if (!$plugininfo) { > new pix_icon('e/file-text', get_string('viewlogs', 'tool_task', $classname) return $component; > )); } > } > $plugininfo->init_display_name(); > array_splice($row->cells, 1, 0, [new html_table_cell($loglink)]); > }); $componentname = $plugininfo->displayname; > } if ($plugininfo->is_enabled() === false) { > $componentname .= ' ' . html_writer::span( > return html_writer::table($table) get_string('disabled', 'tool_task'), 'badge badge-secondary'); > . html_writer::div( } > html_writer::link( $componentname .= "\n" . html_writer::span($plugininfo->component, 'task-class text-ltr'); > new moodle_url( > $adhocrunurl, return $componentname; > array_merge($params, ['classname' => $classname]) } > ), > get_string('runclassname', 'tool_task') /** > ), * Standard display of a tasks last run time. > 'task-runnow' * > ) * @param scheduled_task $task > . html_writer::div( * @return string HTML. > html_writer::link( */ > new moodle_url( public function last_run_time(scheduled_task $task): string { > $adhocurl if ($task->get_last_run_time()) { > ), return userdate($task->get_last_run_time()); > get_string('showsummary', 'tool_task') } else { > ), return get_string('never'); > 'task-show-summary' } > ); } > } > /** > /** * Standard display of a tasks next run time. > * This function will render a plain adhoc tasks table. * > * * @param scheduled_task $task > * @param array $tasks - list of adhoc tasks. * @return string HTML. > * @return string HTML to output. */ > */ public function next_run_time(scheduled_task $task): string { > public function adhoc_tasks_simple_table(array $tasks): string { $plugininfo = core_plugin_manager::instance()->get_plugin_info($task->get_component()); > $table = $this->generate_adhoc_tasks_simple_table($tasks); > $nextrun = $task->get_next_run_time(); > return html_writer::table($table); if ($plugininfo && $plugininfo->is_enabled() === false && !$task->get_run_if_component_disabled()) { > } $nextrun = get_string('plugindisabled', 'tool_task'); > } else if ($task->get_disabled()) { > /** $nextrun = get_string('taskdisabled', 'tool_task'); > * This function will render a plain adhoc tasks table. } else if ($nextrun > time()) { > * $nextrun = userdate($nextrun); > * @param array $tasks - list of adhoc tasks. } else { > * @param bool $wantruntasks add 'Run now' link $nextrun = get_string('asap', 'tool_task'); > * @return html_table } > */ > private function generate_adhoc_tasks_simple_table(array $tasks, bool $wantruntasks = false): html_table { return $nextrun; > $adhocrunurl = '/admin/tool/task/run_adhoctasks.php'; } > $now = time(); > $failedstr = get_string('failed', 'tool_task'); /** > * Get a table cell to show one time, comparing it to the default. > // Main tasks table. * > $table = new html_table(); * @param string $current the current setting. > $table->caption = get_string('adhoctasks', 'tool_task'); * @param string $default the default setting from the db/tasks.php file. > $table->head = [ * @return html_table_cell for use in the table. > get_string('taskid', 'tool_task'), */ > get_string('nextruntime', 'tool_task'), protected function time_cell(string $current, string $default): html_table_cell { > get_string('payload', 'tool_task'), $cell = new html_table_cell($current); > $failedstr // Cron-style values must always be LTR. > ]; $cell->attributes['class'] = 'text-ltr'; > > $table->attributes['class'] = 'generaltable'; // If the current value is default, that is all we want to do. > $table->colclasses = []; if ($default === '*') { > if ($current === '*') { > // For each task entry (row) show action buttons/logs link depending on the user permissions. return $cell; > $data = []; } > foreach ($tasks as $task) { } else if ($default === 'R' ) { > $taskid = $task->get_id(); if (is_numeric($current)) { > $started = $task->get_timestarted(); return $cell; > } > // Task id cell. } else { > $taskidcellcontent = html_writer::span($taskid, 'task-id'); if ($default === $current) { > $taskidcell = new html_table_cell($taskidcellcontent); return $cell; > $taskidcell->header = true; } > $taskidcell->id = "task-$taskid"; } > > // Mark cell if task has failed. // Otherwise, highlight and show the default. > $faildelay = $task->get_fail_delay(); $cell->attributes['class'] .= ' table-warning'; > $faildelaycell = new html_table_cell($faildelay ? $failedstr : ''); $cell->text .= ' ' . html_writer::span( > if ($faildelay) { get_string('defaultx', 'tool_task', $default), 'task-class'); > $faildelaycell->attributes['class'] = 'table-danger'; return $cell; > } } > > // Prepares the next run time cell contents. /** > $nextrun = get_string('started', 'tool_task'); * Displays a warning on the page if cron is disabled. > if (!$started) { * > $nextruntime = $task->get_next_run_time(); * @return string HTML code for information about cron being disabled > $due = $nextruntime < $now; * @throws moodle_exception > $nextrun = $due ? userdate($nextruntime) : get_string('asap', 'tool_task'); */ > public function cron_disabled(): string { > if ($wantruntasks && ($faildelay || $due)) { return $this->output->notification(get_string('crondisabled', 'tool_task'), 'warning'); > $nextrun .= ' '.html_writer::div( } > html_writer::link( > new moodle_url( /** > $adhocrunurl, * Renders a link back to the scheduled tasks page (used from the 'run now' screen). > ['id' => $taskid] * > ), * @param string $taskclassname if specified, the list of tasks will scroll to show this task. > get_string('runnow', 'tool_task') * @return string HTML code > ), */ > 'task-runnow' public function link_back($taskclassname = '') { > ); $url = new moodle_url('/admin/tool/task/scheduledtasks.php'); > } if ($taskclassname) { > } $url->param('lastchanged', $taskclassname); > } > $data[] = new html_table_row([ return $this->render_from_template('tool_task/link_back', ['url' => $url]); > $taskidcell, } > new html_table_cell($nextrun), } > new html_table_cell($task->get_custom_data_as_string()), > $faildelaycell, > ]); > } > $table->data = $data; > > return $table; > } > > /** > * Displays a notification on ad hoc task run request. > * > * @return string HTML notification block for task initiated message > */ > public function adhoc_task_run(): string { > return $this->output->notification(get_string('adhoctaskrun', 'tool_task'), 'info'); > } >
< $canruntasks = \core\task\manager::is_runnable();
> $canruntasks = \core\task\manager::is_runnable() && get_config('tool_task', 'enablerunnow');
< < $plugininfo = core_plugin_manager::instance()->get_plugin_info($task->get_component()); < $plugindisabled = $plugininfo && $plugininfo->is_enabled() === false && < !$task->get_run_if_component_disabled(); < $disabled = $plugindisabled || $task->get_disabled();
> $namecell->id = scheduled_task::get_html_id($classname);
< if (!$plugindisabled && get_config('tool_task', 'enablerunnow') && $canruntasks ) {
> $canrunthistask = $canruntasks && $task->can_run(); > if ($canrunthistask) {
< $faildelaycell->text .= html_writer::div(html_writer::link(
> $faildelaycell->text .= html_writer::div( > $this->output->single_button(
< ['task' => $classname, 'sesskey' => sesskey()]), < get_string('clear')), 'task-clearfaildelay');
> ['task' => $classname]), > get_string('clear') > ), > 'task-runnow' > );
< if ($disabled) {
> if (!$task->is_enabled()) {
< $plugininfo = core_plugin_manager::instance()->get_plugin_info($task->get_component()); <
< if ($plugininfo && $plugininfo->is_enabled() === false && !$task->get_run_if_component_disabled()) {
> > if (!$task->is_component_enabled() && !$task->get_run_if_component_disabled()) {