admin/tool/task/renderer.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Output rendering for the plugin.
  20  *
  21  * @package     tool_task
  22  * @copyright   2014 Damyon Wiese
  23  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * Implements the plugin renderer
  30  *
  31  * @copyright 2014 Damyon Wiese
  32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class tool_task_renderer extends plugin_renderer_base {
  35     /**
  36      * This function will render one beautiful table with all the scheduled tasks.
  37      *
  38      * @param \core\task\scheduled_task[] $tasks - list of all scheduled tasks.
  39      * @return string HTML to output.
  40      */
  41     public function scheduled_tasks_table($tasks) {
  42         global $CFG;
  43
  44         $table = new html_table();
  45         $table->head  = array(get_string('name'),
  46                               get_string('component', 'tool_task'),
  47                               get_string('edit'),
  48                               get_string('lastruntime', 'tool_task'),
  49                               get_string('nextruntime', 'tool_task'),
  50                               get_string('taskscheduleminute', 'tool_task'),
  51                               get_string('taskschedulehour', 'tool_task'),
  52                               get_string('taskscheduleday', 'tool_task'),
  53                               get_string('taskscheduledayofweek', 'tool_task'),
  54                               get_string('taskschedulemonth', 'tool_task'),
  55                               get_string('faildelay', 'tool_task'),
  56                               get_string('default', 'tool_task'));
  57         $table->attributes['class'] = 'admintable generaltable';
  58         $data = array();
  59         $yes = get_string('yes');
  60         $no = get_string('no');
  61         $never = get_string('never');
  62         $asap = get_string('asap', 'tool_task');
  63         $disabledstr = get_string('taskdisabled', 'tool_task');
  64         $plugindisabledstr = get_string('plugindisabled', 'tool_task');
  65         foreach ($tasks as $task) {
  66             $customised = $task->is_customised() ? $no : $yes;
  67             if (empty($CFG->preventscheduledtaskchanges)) {
  68                 $configureurl = new moodle_url('/admin/tool/task/scheduledtasks.php', array('action'=>'edit', 'task' => get_class($task)));
  69                 $editlink = $this->action_icon($configureurl, new pix_icon('t/edit', get_string('edittaskschedule', 'tool_task', $task->get_name())));
  70             } else {
  71                 $editlink = $this->render(new pix_icon('t/locked', get_string('scheduledtaskchangesdisabled', 'tool_task')));
  72             }
  73
  74             $namecell = new html_table_cell($task->get_name() . "\n" . html_writer::tag('span', '\\'.get_class($task),
  75                 array('class' => 'task-class text-ltr')));
  76             $namecell->header = true;
  77
  78             $component = $task->get_component();
  79             $plugininfo = null;
  80             list($type, $plugin) = core_component::normalize_component($component);
  81             if ($type === 'core') {
  82                 $componentcell = new html_table_cell(get_string('corecomponent', 'tool_task'));
  83             } else {
  84                 if ($plugininfo = core_plugin_manager::instance()->get_plugin_info($component)) {
  85                     $plugininfo->init_display_name();
  86                     $componentcell = new html_table_cell($plugininfo->displayname);
  87                 } else {
  88                     $componentcell = new html_table_cell($component);
  89                 }
  90             }
  91
  92             $lastrun = $task->get_last_run_time() ? userdate($task->get_last_run_time()) : $never;
  93             $nextrun = $task->get_next_run_time();
  94             $disabled = false;
  95             if ($plugininfo && $plugininfo->is_enabled() === false && !$task->get_run_if_component_disabled()) {
  96                 $disabled = true;
  97                 $nextrun = $plugindisabledstr;
  98             } else if ($task->get_disabled()) {
  99                 $disabled = true;
 100                 $nextrun = $disabledstr;
 101             } else if ($nextrun > time()) {
 102                 $nextrun = userdate($nextrun);
 103             } else {
 104                 $nextrun = $asap;
 105             }
 106
 107             $runnow = '';
 108             if (!$disabled && get_config('tool_task', 'enablerunnow')) {
 109                 $runnow = html_writer::div(html_writer::link(
 110                         new moodle_url('/admin/tool/task/schedule_task.php',
 111                             array('task' => get_class($task))),
 112                         get_string('runnow', 'tool_task')), 'task-runnow');
 113             }
 114
 115             $clearfail = '';
 116             if ($task->get_fail_delay()) {
 117                 $clearfail = html_writer::div(html_writer::link(
 118                         new moodle_url('/admin/tool/task/clear_fail_delay.php',
 119                                 array('task' => get_class($task), 'sesskey' => sesskey())),
 120                         get_string('clear')), 'task-clearfaildelay');
 121             }
 122
 123             $row = new html_table_row(array(
 124                         $namecell,
 125                         $componentcell,
 126                         new html_table_cell($editlink),
 127                         new html_table_cell($lastrun . $runnow),
 128                         new html_table_cell($nextrun),
 129                         new html_table_cell($task->get_minute()),
 130                         new html_table_cell($task->get_hour()),
 131                         new html_table_cell($task->get_day()),
 132                         new html_table_cell($task->get_day_of_week()),
 133                         new html_table_cell($task->get_month()),
 134                         new html_table_cell($task->get_fail_delay() . $clearfail),
 135                         new html_table_cell($customised)));
 136
 137             // Cron-style values must always be LTR.
 138             $row->cells[5]->attributes['class'] = 'text-ltr';
 139             $row->cells[6]->attributes['class'] = 'text-ltr';
 140             $row->cells[7]->attributes['class'] = 'text-ltr';
 141             $row->cells[8]->attributes['class'] = 'text-ltr';
 142             $row->cells[9]->attributes['class'] = 'text-ltr';
 143
 144             if ($disabled) {
 145                 $row->attributes['class'] = 'disabled';
 146             }
 147             $data[] = $row;
 148         }
 149         $table->data = $data;
 150         return html_writer::table($table);
 151     }
 152
 153     /**
 154      * Renders a link back to the scheduled tasks page (used from the 'run now' screen).
 155      *
 156      * @return string HTML code
 157      */
 158     public function link_back() {
 159         return $this->render_from_template('tool_task/link_back',
 160                 array('url' => new moodle_url('/admin/tool/task/scheduledtasks.php')));
 161     }
 162 }