d3ac14c6da2180b0178fc5329520ec8c7f7fc069
[moodle.git] / admin / renderer.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  * Renderer for core_admin subsystem
19  *
20  * @package    core
21  * @subpackage admin
22  * @copyright  2011 David Mudrak <david@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->libdir . '/pluginlib.php');
30 /**
31  * Standard HTML output renderer for core_admin subsystem
32  */
33 class core_admin_renderer extends plugin_renderer_base {
35     /**
36      * Display the 'Do you acknowledge the terms of the GPL' page. The first page
37      * during install.
38      * @return string HTML to output.
39      */
40     public function install_licence_page() {
41         global $CFG;
42         $output = '';
44         $copyrightnotice = text_to_html(get_string('gpl3'));
45         $copyrightnotice = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $copyrightnotice); // extremely ugly validation hack
47         $continue = new single_button(new moodle_url('/admin/index.php', array('lang'=>$CFG->lang, 'agreelicense'=>1)), get_string('continue'), 'get');
49         $output .= $this->header();
50         $output .= $this->heading('<a href="http://moodle.org">Moodle</a> - Modular Object-Oriented Dynamic Learning Environment');
51         $output .= $this->heading(get_string('copyrightnotice'));
52         $output .= $this->box($copyrightnotice, 'copyrightnotice');
53         $output .= html_writer::empty_tag('br');
54         $output .= $this->confirm(get_string('doyouagree'), $continue, "http://docs.moodle.org/dev/License");
55         $output .= $this->footer();
57         return $output;
58     }
60     /**
61      * Display page explaining proper upgrade process,
62      * there can not be any PHP file leftovers...
63      *
64      * @return string HTML to output.
65      */
66     public function upgrade_stale_php_files_page() {
67         $output = '';
68         $output .= $this->header();
69         $output .= $this->heading(get_string('upgradestalefiles', 'admin'));
70         $output .= $this->box_start('generalbox', 'notice');
71         $output .= get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading'));
72         $output .= html_writer::empty_tag('br');
73         $output .= html_writer::tag('div', $this->single_button($this->page->url, get_string('reload'), 'get'), array('class' => 'buttons'));
74         $output .= $this->box_end();
75         $output .= $this->footer();
77         return $output;
78     }
80     /**
81      * Display the 'environment check' page that is displayed during install.
82      * @param int $maturity
83      * @param boolean $envstatus final result of the check (true/false)
84      * @param array $environment_results array of results gathered
85      * @param string $release moodle release
86      * @return string HTML to output.
87      */
88     public function install_environment_page($maturity, $envstatus, $environment_results, $release) {
89         global $CFG;
90         $output = '';
92         $output .= $this->header();
93         $output .= $this->maturity_warning($maturity);
94         $output .= $this->heading("Moodle $release");
95         $output .= $this->release_notes_link();
97         $output .= $this->environment_check_table($envstatus, $environment_results);
99         if (!$envstatus) {
100             $output .= $this->upgrade_reload(new moodle_url('/admin/index.php', array('agreelicense' => 1, 'lang' => $CFG->lang)));
101         } else {
102             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
103             $output .= $this->continue_button(new moodle_url('/admin/index.php', array('agreelicense'=>1, 'confirmrelease'=>1, 'lang'=>$CFG->lang)));
104         }
106         $output .= $this->footer();
107         return $output;
108     }
110     /**
111      * Displays the list of plugins with unsatisfied dependencies
112      *
113      * @param double|string|int $version Moodle on-disk version
114      * @param array $failed list of plugins with unsatisfied dependecies
115      * @return string HTML
116      */
117     public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
118         $output = '';
120         $output .= $this->header();
121         $output .= $this->heading(get_string('pluginscheck', 'admin'));
122         $output .= $this->warning(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
123         $output .= $this->plugins_check_table(plugin_manager::instance(), $version, array('xdep' => true));
124         $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
125         $output .= $this->continue_button($reloadurl);
127         $output .= $this->footer();
129         return $output;
130     }
132     /**
133      * Display the 'You are about to upgrade Moodle' page. The first page
134      * during upgrade.
135      * @param string $strnewversion
136      * @param int $maturity
137      * @return string HTML to output.
138      */
139     public function upgrade_confirm_page($strnewversion, $maturity) {
140         $output = '';
142         $continueurl = new moodle_url('index.php', array('confirmupgrade' => 1));
143         $cancelurl = new moodle_url('index.php');
145         $output .= $this->header();
146         $output .= $this->maturity_warning($maturity);
147         $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continueurl, $cancelurl);
148         $output .= $this->footer();
150         return $output;
151     }
153     /**
154      * Display the environment page during the upgrade process.
155      * @param string $release
156      * @param boolean $envstatus final result of env check (true/false)
157      * @param array $environment_results array of results gathered
158      * @return string HTML to output.
159      */
160     public function upgrade_environment_page($release, $envstatus, $environment_results) {
161         global $CFG;
162         $output = '';
164         $output .= $this->header();
165         $output .= $this->heading("Moodle $release");
166         $output .= $this->release_notes_link();
167         $output .= $this->environment_check_table($envstatus, $environment_results);
169         if (!$envstatus) {
170             $output .= $this->upgrade_reload(new moodle_url('/admin/index.php'), array('confirmupgrade' => 1));
172         } else {
173             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
175             if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
176                 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
177             }
179             $output .= $this->continue_button(new moodle_url('/admin/index.php', array('confirmupgrade' => 1, 'confirmrelease' => 1)));
180         }
182         $output .= $this->footer();
184         return $output;
185     }
187     /**
188      * Display the upgrade page that lists all the plugins that require attention.
189      * @param plugin_manager $pluginman provides information about the plugins.
190      * @param available_update_checker $checker provides information about available updates.
191      * @param int $version the version of the Moodle code from version.php.
192      * @param bool $showallplugins
193      * @param moodle_url $reloadurl
194      * @param moodle_url $continueurl
195      * @return string HTML to output.
196      */
197     public function upgrade_plugin_check_page(plugin_manager $pluginman, available_update_checker $checker,
198             $version, $showallplugins, $reloadurl, $continueurl) {
199         global $CFG;
201         $output = '';
203         $output .= $this->header();
204         $output .= $this->box_start('generalbox');
205         $output .= $this->container_start('generalbox', 'notice');
206         $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'));
207         if (empty($CFG->disableupdatenotifications)) {
208             $output .= $this->container_start('checkforupdates');
209             $output .= $this->single_button(new moodle_url($reloadurl, array('fetchupdates' => 1)), get_string('checkforupdates', 'core_plugin'));
210             if ($timefetched = $checker->get_last_timefetched()) {
211                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
212                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
213             }
214             $output .= $this->container_end();
215         }
216         $output .= $this->container_end();
218         $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
219         $output .= $this->box_end();
220         $output .= $this->upgrade_reload($reloadurl);
222         if ($pluginman->some_plugins_updatable()) {
223             $output .= $this->container_start('upgradepluginsinfo');
224             $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
225             $output .= $this->container_end();
226         }
228         $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
229         $button->class = 'continuebutton';
230         $output .= $this->render($button);
231         $output .= $this->footer();
233         return $output;
234     }
236     /**
237      * Display the admin notifications page.
238      * @param int $maturity
239      * @param bool $insecuredataroot warn dataroot is invalid
240      * @param bool $errorsdisplayed warn invalid dispaly error setting
241      * @param bool $cronoverdue warn cron not running
242      * @param bool $dbproblems warn db has problems
243      * @param bool $maintenancemode warn in maintenance mode
244      * @param array|null $availableupdates array of available_update_info objects or null
245      * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
246      *
247      * @return string HTML to output.
248      */
249     public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
250             $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch) {
251         global $CFG;
252         $output = '';
254         $output .= $this->header();
255         $output .= $this->maturity_info($maturity);
256         $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
257         $output .= $this->insecure_dataroot_warning($insecuredataroot);
258         $output .= $this->display_errors_warning($errorsdisplayed);
259         $output .= $this->cron_overdue_warning($cronoverdue);
260         $output .= $this->db_problems($dbproblems);
261         $output .= $this->maintenance_mode_warning($maintenancemode);
263         //////////////////////////////////////////////////////////////////////////////////////////////////
264         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
265         $output .= $this->moodle_copyright();
266         //////////////////////////////////////////////////////////////////////////////////////////////////
268         $output .= $this->footer();
270         return $output;
271     }
273     /**
274      * Display the plugin management page (admin/plugins.php).
275      *
276      * @param plugin_manager $pluginman
277      * @param available_update_checker $checker
278      * @return string HTML to output.
279      */
280     public function plugin_management_page(plugin_manager $pluginman, available_update_checker $checker) {
281         global $CFG;
283         $output = '';
285         $output .= $this->header();
286         $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
287         $output .= $this->plugins_overview_panel($pluginman);
289         if (empty($CFG->disableupdatenotifications)) {
290             $output .= $this->container_start('checkforupdates');
291             $output .= $this->single_button(new moodle_url($this->page->url, array('fetchremote' => 1)), get_string('checkforupdates', 'core_plugin'));
292             if ($timefetched = $checker->get_last_timefetched()) {
293                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
294                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
295             }
296             $output .= $this->container_end();
297         }
299         $output .= $this->box($this->plugins_control_panel($pluginman), 'generalbox');
300         $output .= $this->footer();
302         return $output;
303     }
305     /**
306      * Display the plugin management page (admin/environment.php).
307      * @param array $versions
308      * @param string $version
309      * @param boolean $envstatus final result of env check (true/false)
310      * @param array $environment_results array of results gathered
311      * @return string HTML to output.
312      */
313     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
314         $output = '';
315         $output .= $this->header();
317         // Print the component download link
318         $output .= html_writer::tag('div', html_writer::link(
319                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
320                     get_string('updatecomponent', 'admin')),
321                 array('class' => 'reportlink'));
323         // Heading.
324         $output .= $this->heading(get_string('environment', 'admin'));
326         // Box with info and a menu to choose the version.
327         $output .= $this->box_start();
328         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
329         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
330         $select->label = get_string('moodleversion');
331         $output .= $this->render($select);
332         $output .= $this->box_end();
334         // The results
335         $output .= $this->environment_check_table($envstatus, $environment_results);
337         $output .= $this->footer();
338         return $output;
339     }
341     /**
342      * Output a warning message, of the type that appears on the admin notifications page.
343      * @param string $message the message to display.
344      * @param string $type type class
345      * @return string HTML to output.
346      */
347     protected function warning($message, $type = 'warning') {
348         return $this->box($message, 'generalbox admin' . $type);
349     }
351     /**
352      * Render an appropriate message if dataroot is insecure.
353      * @param bool $insecuredataroot
354      * @return string HTML to output.
355      */
356     protected function insecure_dataroot_warning($insecuredataroot) {
357         global $CFG;
359         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
360             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
362         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
363             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
365         } else {
366             return '';
367         }
368     }
370     /**
371      * Render an appropriate message if dataroot is insecure.
372      * @param bool $errorsdisplayed
373      * @return string HTML to output.
374      */
375     protected function display_errors_warning($errorsdisplayed) {
376         if (!$errorsdisplayed) {
377             return '';
378         }
380         return $this->warning(get_string('displayerrorswarning', 'admin'));
381     }
383     /**
384      * Render an appropriate message if cron has not been run recently.
385      * @param bool $cronoverdue
386      * @return string HTML to output.
387      */
388     public function cron_overdue_warning($cronoverdue) {
389         if (!$cronoverdue) {
390             return '';
391         }
393         return $this->warning(get_string('cronwarning', 'admin') . '&nbsp;' .
394                 $this->help_icon('cron', 'admin'));
395     }
397     /**
398      * Render an appropriate message if there are any problems with the DB set-up.
399      * @param bool $dbproblems
400      * @return string HTML to output.
401      */
402     public function db_problems($dbproblems) {
403         if (!$dbproblems) {
404             return '';
405         }
407         return $this->warning($dbproblems);
408     }
410     /**
411      * Render an appropriate message if the site in in maintenance mode.
412      * @param bool $maintenancemode
413      * @return string HTML to output.
414      */
415     public function maintenance_mode_warning($maintenancemode) {
416         if (!$maintenancemode) {
417             return '';
418         }
420         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
421         $url = $url->out(); // get_string() does not support objects in params
423         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
424     }
426     /**
427      * Display a warning about installing development code if necesary.
428      * @param int $maturity
429      * @return string HTML to output.
430      */
431     protected function maturity_warning($maturity) {
432         if ($maturity == MATURITY_STABLE) {
433             return ''; // No worries.
434         }
436         $maturitylevel = get_string('maturity' . $maturity, 'admin');
437         return $this->box(
438                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
439                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
440                 'generalbox maturitywarning');
441     }
443     /**
444      * Output the copyright notice.
445      * @return string HTML to output.
446      */
447     protected function moodle_copyright() {
448         global $CFG;
450         //////////////////////////////////////////////////////////////////////////////////////////////////
451         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
452         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
453                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
454                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
455                          'and <a href="http://docs.moodle.org/dev/Credits">many other contributors</a>.<br />'.
456                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
457         //////////////////////////////////////////////////////////////////////////////////////////////////
459         return $this->box($copyrighttext, 'copyright');
460     }
462     /**
463      * Display a warning about installing development code if necesary.
464      * @param int $maturity
465      * @return string HTML to output.
466      */
467     protected function maturity_info($maturity) {
468         if ($maturity == MATURITY_STABLE) {
469             return ''; // No worries.
470         }
472         $maturitylevel = get_string('maturity' . $maturity, 'admin');
473         return $this->box(
474                     get_string('maturitycoreinfo', 'admin', $maturitylevel) . ' ' .
475                     $this->doc_link('admin/versions', get_string('morehelp')),
476                 'generalbox adminwarning maturityinfo maturity'.$maturity);
477     }
479     /**
480      * Displays the info about available Moodle updates
481      *
482      * @param array|null $updates array of available_update_info objects or null
483      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
484      * @return string
485      */
486     protected function available_updates($updates, $fetch) {
488         $updateinfo = $this->box_start('generalbox adminwarning availableupdatesinfo');
489         if (is_array($updates)) {
490             $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
491             foreach ($updates as $update) {
492                 $updateinfo .= $this->moodle_available_update_info($update);
493             }
494         } else {
495             $now = time();
496             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
497                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
498             }
499         }
501         $updateinfo .= $this->container_start('checkforupdates');
502         $updateinfo .= $this->single_button(new moodle_url($this->page->url, array('fetchupdates' => 1)), get_string('checkforupdates', 'core_plugin'));
503         if ($fetch) {
504             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
505                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
506         }
507         $updateinfo .= $this->container_end();
509         $updateinfo .= $this->box_end();
511         return $updateinfo;
512     }
514     /**
515      * Helper method to render the information about the available Moodle update
516      *
517      * @param available_update_info $updateinfo information about the available Moodle core update
518      */
519     protected function moodle_available_update_info(available_update_info $updateinfo) {
521         $boxclasses = 'moodleupdateinfo';
522         $info = array();
524         if (isset($updateinfo->release)) {
525             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
526                 array('class' => 'info release'));
527         }
529         if (isset($updateinfo->version)) {
530             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
531                 array('class' => 'info version'));
532         }
534         if (isset($updateinfo->maturity)) {
535             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
536                 array('class' => 'info maturity'));
537             $boxclasses .= ' maturity'.$updateinfo->maturity;
538         }
540         if (isset($updateinfo->download)) {
541             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
542         }
544         if (isset($updateinfo->url)) {
545             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
546                 array('class' => 'info more'));
547         }
549         $box  = $this->output->box_start($boxclasses);
550         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
551         $box .= $this->output->box_end();
553         return $box;
554     }
556     /**
557      * Display a link to the release notes.
558      * @return string HTML to output.
559      */
560     protected function release_notes_link() {
561         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
562         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
563         return $this->box($releasenoteslink, 'generalbox releasenoteslink');
564     }
566     /**
567      * Display the reload link that appears on several upgrade/install pages.
568      * @return string HTML to output.
569      */
570     function upgrade_reload($url) {
571         return html_writer::empty_tag('br') .
572                 html_writer::tag('div',
573                     html_writer::link($url, $this->pix_icon('i/reload', '') .
574                             get_string('reload'), array('title' => get_string('reload'))),
575                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
576     }
578     /**
579      * Displays all known plugins and information about their installation or upgrade
580      *
581      * This default implementation renders all plugins into one big table. The rendering
582      * options support:
583      *     (bool)full = false: whether to display up-to-date plugins, too
584      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
585      *
586      * @param plugin_manager $pluginman provides information about the plugins.
587      * @param int $version the version of the Moodle code from version.php.
588      * @param array $options rendering options
589      * @return string HTML code
590      */
591     public function plugins_check_table(plugin_manager $pluginman, $version, array $options = array()) {
592         global $CFG;
594         $plugininfo = $pluginman->get_plugins();
596         if (empty($plugininfo)) {
597             return '';
598         }
600         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
601         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
603         $table = new html_table();
604         $table->id = 'plugins-check';
605         $table->head = array(
606             get_string('displayname', 'core_plugin'),
607             get_string('rootdir', 'core_plugin'),
608             get_string('source', 'core_plugin'),
609             get_string('versiondb', 'core_plugin'),
610             get_string('versiondisk', 'core_plugin'),
611             get_string('requires', 'core_plugin'),
612             get_string('status', 'core_plugin'),
613         );
614         $table->colclasses = array(
615             'displayname', 'rootdir', 'source', 'versiondb', 'versiondisk', 'requires', 'status',
616         );
617         $table->data = array();
619         $numofhighlighted = array();    // number of highlighted rows per this subsection
621         foreach ($plugininfo as $type => $plugins) {
623             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
624             $header->header = true;
625             $header->colspan = count($table->head);
626             $header = new html_table_row(array($header));
627             $header->attributes['class'] = 'plugintypeheader type-' . $type;
629             $numofhighlighted[$type] = 0;
631             if (empty($plugins) and $options['full']) {
632                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
633                 $msg->colspan = count($table->head);
634                 $row = new html_table_row(array($msg));
635                 $row->attributes['class'] .= 'msg msg-noneinstalled';
636                 $table->data[] = $header;
637                 $table->data[] = $row;
638                 continue;
639             }
641             $plugintyperows = array();
643             foreach ($plugins as $name => $plugin) {
644                 $row = new html_table_row();
645                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
647                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
648                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
649                 } else {
650                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'smallicon pluginicon noicon'));
651                 }
652                 $displayname  = $icon . ' ' . $plugin->displayname;
653                 $displayname = new html_table_cell($displayname);
655                 $rootdir = new html_table_cell($plugin->get_dir());
657                 if ($isstandard = $plugin->is_standard()) {
658                     $row->attributes['class'] .= ' standard';
659                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
660                 } else {
661                     $row->attributes['class'] .= ' extension';
662                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
663                 }
665                 $versiondb = new html_table_cell($plugin->versiondb);
666                 $versiondisk = new html_table_cell($plugin->versiondisk);
668                 $statuscode = $plugin->get_status();
669                 $row->attributes['class'] .= ' status-' . $statuscode;
670                 $status = get_string('status_' . $statuscode, 'core_plugin');
672                 $availableupdates = $plugin->available_updates();
673                 if (!empty($availableupdates) and empty($CFG->disableupdatenotifications)) {
674                     foreach ($availableupdates as $availableupdate) {
675                         $status .= $this->plugin_available_update_info($availableupdate);
676                     }
677                 }
679                 $status = new html_table_cell($status);
681                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
683                 $statusisboring = in_array($statuscode, array(
684                         plugin_manager::PLUGIN_STATUS_NODB, plugin_manager::PLUGIN_STATUS_UPTODATE));
685                 $dependenciesok = $pluginman->are_dependencies_satisfied(
686                         $plugin->get_other_required_plugins()) && $plugin->is_core_dependency_satisfied($version);
688                 if ($options['xdep']) {
689                     // we want to see only plugins with failed dependencies
690                     if ($dependenciesok) {
691                         continue;
692                     }
694                 } else if ($isstandard and $statusisboring and $dependenciesok and empty($availableupdates)) {
695                     // no change is going to happen to the plugin - display it only
696                     // if the user wants to see the full list
697                     if (empty($options['full'])) {
698                         continue;
699                     }
700                 }
702                 // ok, the plugin should be displayed
703                 $numofhighlighted[$type]++;
705                 $row->cells = array($displayname, $rootdir, $source,
706                     $versiondb, $versiondisk, $requires, $status);
707                 $plugintyperows[] = $row;
708             }
710             if (empty($numofhighlighted[$type]) and empty($options['full'])) {
711                 continue;
712             }
714             $table->data[] = $header;
715             $table->data = array_merge($table->data, $plugintyperows);
716         }
718         $sumofhighlighted = array_sum($numofhighlighted);
720         if ($options['xdep']) {
721             // we do not want to display no heading and links in this mode
722             $out = '';
724         } else if ($sumofhighlighted == 0) {
725             $out  = $this->output->container_start('nonehighlighted', 'plugins-check-info');
726             $out .= $this->output->heading(get_string('nonehighlighted', 'core_plugin'));
727             if (empty($options['full'])) {
728                 $out .= html_writer::link(new moodle_url('/admin/index.php',
729                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
730                     get_string('nonehighlightedinfo', 'core_plugin'));
731             }
732             $out .= $this->output->container_end();
734         } else {
735             $out  = $this->output->container_start('somehighlighted', 'plugins-check-info');
736             $out .= $this->output->heading(get_string('somehighlighted', 'core_plugin', $sumofhighlighted));
737             if (empty($options['full'])) {
738                 $out .= html_writer::link(new moodle_url('/admin/index.php',
739                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
740                     get_string('somehighlightedinfo', 'core_plugin'));
741             } else {
742                 $out .= html_writer::link(new moodle_url('/admin/index.php',
743                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 0)),
744                     get_string('somehighlightedonly', 'core_plugin'));
745             }
746             $out .= $this->output->container_end();
747         }
749         if ($sumofhighlighted > 0 or $options['full']) {
750             $out .= html_writer::table($table);
751         }
753         return $out;
754     }
756     /**
757      * Formats the information that needs to go in the 'Requires' column.
758      * @param plugininfo_base $plugin the plugin we are rendering the row for.
759      * @param plugin_manager $pluginman provides data on all the plugins.
760      * @param string $version
761      * @return string HTML code
762      */
763     protected function required_column(plugininfo_base $plugin, plugin_manager $pluginman, $version) {
764         $requires = array();
766         if (!empty($plugin->versionrequires)) {
767             if ($plugin->versionrequires <= $version) {
768                 $class = 'requires-ok';
769             } else {
770                 $class = 'requires-failed';
771             }
772             $requires[] = html_writer::tag('li',
773                 get_string('moodleversion', 'core_plugin', $plugin->versionrequires),
774                 array('class' => $class));
775         }
777         foreach ($plugin->get_other_required_plugins() as $component => $requiredversion) {
778             $ok = true;
779             $otherplugin = $pluginman->get_plugin_info($component);
781             if (is_null($otherplugin)) {
782                 $ok = false;
783             } else if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
784                 $ok = false;
785             }
787             if ($ok) {
788                 $class = 'requires-ok';
789             } else {
790                 $class = 'requires-failed';
791             }
793             if ($requiredversion != ANY_VERSION) {
794                 $str = 'otherpluginversion';
795             } else {
796                 $str = 'otherplugin';
797             }
798             $requires[] = html_writer::tag('li',
799                     get_string($str, 'core_plugin',
800                             array('component' => $component, 'version' => $requiredversion)),
801                     array('class' => $class));
802         }
804         if (!$requires) {
805             return '';
806         }
807         return html_writer::tag('ul', implode("\n", $requires));
808     }
810     /**
811      * Prints an overview about the plugins - number of installed, number of extensions etc.
812      *
813      * @param plugin_manager $pluginman provides information about the plugins
814      * @return string as usually
815      */
816     public function plugins_overview_panel(plugin_manager $pluginman) {
817         global $CFG;
819         $plugininfo = $pluginman->get_plugins();
821         $numtotal = $numdisabled = $numextension = $numupdatable = 0;
823         foreach ($plugininfo as $type => $plugins) {
824             foreach ($plugins as $name => $plugin) {
825                 if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
826                     continue;
827                 }
828                 $numtotal++;
829                 if ($plugin->is_enabled() === false) {
830                     $numdisabled++;
831                 }
832                 if (!$plugin->is_standard()) {
833                     $numextension++;
834                 }
835                 if (empty($CFG->disableupdatenotifications) and $plugin->available_updates()) {
836                     $numupdatable++;
837                 }
838             }
839         }
841         $info = array();
842         $info[] = html_writer::tag('span', get_string('numtotal', 'core_plugin', $numtotal), array('class' => 'info total'));
843         $info[] = html_writer::tag('span', get_string('numdisabled', 'core_plugin', $numdisabled), array('class' => 'info disabled'));
844         $info[] = html_writer::tag('span', get_string('numextension', 'core_plugin', $numextension), array('class' => 'info extension'));
845         if ($numupdatable > 0) {
846             $info[] = html_writer::tag('span', get_string('numupdatable', 'core_plugin', $numupdatable), array('class' => 'info updatable'));
847         }
849         return $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '', 'plugins-overview-panel');
850     }
852     /**
853      * Displays all known plugins and links to manage them
854      *
855      * This default implementation renders all plugins into one big table.
856      *
857      * @param plugin_manager $pluginman provides information about the plugins.
858      * @return string HTML code
859      */
860     public function plugins_control_panel(plugin_manager $pluginman) {
861         global $CFG;
863         $plugininfo = $pluginman->get_plugins();
865         if (empty($plugininfo)) {
866             return '';
867         }
869         $table = new html_table();
870         $table->id = 'plugins-control-panel';
871         $table->head = array(
872             get_string('displayname', 'core_plugin'),
873             get_string('source', 'core_plugin'),
874             get_string('version', 'core_plugin'),
875             get_string('availability', 'core_plugin'),
876             get_string('actions', 'core_plugin'),
877             get_string('notes','core_plugin'),
878         );
879         $table->colclasses = array(
880             'pluginname', 'source', 'version', 'availability', 'actions', 'notes'
881         );
883         foreach ($plugininfo as $type => $plugins) {
885             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
886             $header->header = true;
887             $header->colspan = count($table->head);
888             $header = new html_table_row(array($header));
889             $header->attributes['class'] = 'plugintypeheader type-' . $type;
890             $table->data[] = $header;
892             if (empty($plugins)) {
893                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
894                 $msg->colspan = count($table->head);
895                 $row = new html_table_row(array($msg));
896                 $row->attributes['class'] .= 'msg msg-noneinstalled';
897                 $table->data[] = $row;
898                 continue;
899             }
901             foreach ($plugins as $name => $plugin) {
902                 $row = new html_table_row();
903                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
905                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
906                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
907                 } else {
908                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'smallicon pluginicon noicon'));
909                 }
910                 if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
911                     $msg = html_writer::tag('span', get_string('status_missing', 'core_plugin'), array('class' => 'notifyproblem'));
912                     $row->attributes['class'] .= ' missingfromdisk';
913                 } else {
914                     $msg = '';
915                 }
916                 $pluginname  = html_writer::tag('div', $icon . ' ' . $plugin->displayname . ' ' . $msg, array('class' => 'displayname')).
917                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
918                 $pluginname  = new html_table_cell($pluginname);
920                 if ($plugin->is_standard()) {
921                     $row->attributes['class'] .= ' standard';
922                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
923                 } else {
924                     $row->attributes['class'] .= ' extension';
925                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
926                 }
928                 $version = new html_table_cell($plugin->versiondb);
930                 $isenabled = $plugin->is_enabled();
931                 if (is_null($isenabled)) {
932                     $availability = new html_table_cell('');
933                 } else if ($isenabled) {
934                     $row->attributes['class'] .= ' enabled';
935                     $icon = $this->output->pix_icon('i/hide', get_string('pluginenabled', 'core_plugin'));
936                     $availability = new html_table_cell($icon . ' ' . get_string('pluginenabled', 'core_plugin'));
937                 } else {
938                     $row->attributes['class'] .= ' disabled';
939                     $icon = $this->output->pix_icon('i/show', get_string('plugindisabled', 'core_plugin'));
940                     $availability = new html_table_cell($icon . ' ' . get_string('plugindisabled', 'core_plugin'));
941                 }
943                 $actions = array();
945                 $settingsurl = $plugin->get_settings_url();
946                 if (!is_null($settingsurl)) {
947                     $actions[] = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
948                 }
950                 $uninstallurl = $plugin->get_uninstall_url();
951                 if (!is_null($uninstallurl)) {
952                     $actions[] = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'), array('class' => 'uninstall'));
953                 }
955                 $actions = new html_table_cell(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $actions));
957                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
958                 if ($requriedby) {
959                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
960                         array('class' => 'requiredby'));
961                 } else {
962                     $requiredby = '';
963                 }
965                 $updateinfo = '';
966                 if (empty($CFG->disableupdatenotifications) and is_array($plugin->available_updates())) {
967                     foreach ($plugin->available_updates() as $availableupdate) {
968                         $updateinfo .= $this->plugin_available_update_info($availableupdate);
969                     }
970                 }
972                 $notes = new html_table_cell($requiredby.$updateinfo);
974                 $row->cells = array(
975                     $pluginname, $source, $version, $availability, $actions, $notes
976                 );
977                 $table->data[] = $row;
978             }
979         }
981         return html_writer::table($table);
982     }
984     /**
985      * Helper method to render the information about the available plugin update
986      *
987      * The passed objects always provides at least the 'version' property containing
988      * the (higher) version of the plugin available.
989      *
990      * @param available_update_info $updateinfo information about the available update for the plugin
991      */
992     protected function plugin_available_update_info(available_update_info $updateinfo) {
994         $boxclasses = 'pluginupdateinfo';
995         $info = array();
997         if (isset($updateinfo->release)) {
998             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
999                 array('class' => 'info release'));
1000         }
1002         if (isset($updateinfo->maturity)) {
1003             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1004                 array('class' => 'info maturity'));
1005             $boxclasses .= ' maturity'.$updateinfo->maturity;
1006         }
1008         if (isset($updateinfo->download)) {
1009             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
1010         }
1012         if (isset($updateinfo->url)) {
1013             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
1014                 array('class' => 'info more'));
1015         }
1017         $box  = $this->output->box_start($boxclasses);
1018         $box .= html_writer::tag('div', get_string('updateavailable', 'core_plugin', $updateinfo->version), array('class' => 'version'));
1019         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
1020         $box .= $this->output->box_end();
1022         return $box;
1023     }
1025     /**
1026      * This function will render one beautiful table with all the environmental
1027      * configuration and how it suits Moodle needs.
1028      *
1029      * @param boolean $result final result of the check (true/false)
1030      * @param array $environment_results array of results gathered
1031      * @return string HTML to output.
1032      */
1033     public function environment_check_table($result, $environment_results) {
1034         global $CFG;
1036         // Table headers
1037         $servertable = new html_table();//table for server checks
1038         $servertable->head  = array(
1039             get_string('name'),
1040             get_string('info'),
1041             get_string('report'),
1042             get_string('status'),
1043         );
1044         $servertable->align = array('center', 'center', 'left', 'center');
1045         $servertable->wrap  = array('nowrap', '', '', 'nowrap');
1046         $servertable->size  = array('10', 10, '100%', '10');
1047         $servertable->attributes['class'] = 'environmenttable generaltable';
1049         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1051         $othertable = new html_table();//table for custom checks
1052         $othertable->head  = array(
1053             get_string('info'),
1054             get_string('report'),
1055             get_string('status'),
1056         );
1057         $othertable->align = array('center', 'left', 'center');
1058         $othertable->wrap  = array('', '', 'nowrap');
1059         $othertable->size  = array(10, '100%', '10');
1060         $othertable->attributes['class'] = 'environmenttable generaltable';
1062         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1064         // Iterate over each environment_result
1065         $continue = true;
1066         foreach ($environment_results as $environment_result) {
1067             $errorline   = false;
1068             $warningline = false;
1069             $stringtouse = '';
1070             if ($continue) {
1071                 $type = $environment_result->getPart();
1072                 $info = $environment_result->getInfo();
1073                 $status = $environment_result->getStatus();
1074                 $error_code = $environment_result->getErrorCode();
1075                 // Process Report field
1076                 $rec = new stdClass();
1077                 // Something has gone wrong at parsing time
1078                 if ($error_code) {
1079                     $stringtouse = 'environmentxmlerror';
1080                     $rec->error_code = $error_code;
1081                     $status = get_string('error');
1082                     $errorline = true;
1083                     $continue = false;
1084                 }
1086                 if ($continue) {
1087                     if ($rec->needed = $environment_result->getNeededVersion()) {
1088                         // We are comparing versions
1089                         $rec->current = $environment_result->getCurrentVersion();
1090                         if ($environment_result->getLevel() == 'required') {
1091                             $stringtouse = 'environmentrequireversion';
1092                         } else {
1093                             $stringtouse = 'environmentrecommendversion';
1094                         }
1096                     } else if ($environment_result->getPart() == 'custom_check') {
1097                         // We are checking installed & enabled things
1098                         if ($environment_result->getLevel() == 'required') {
1099                             $stringtouse = 'environmentrequirecustomcheck';
1100                         } else {
1101                             $stringtouse = 'environmentrecommendcustomcheck';
1102                         }
1104                     } else if ($environment_result->getPart() == 'php_setting') {
1105                         if ($status) {
1106                             $stringtouse = 'environmentsettingok';
1107                         } else if ($environment_result->getLevel() == 'required') {
1108                             $stringtouse = 'environmentmustfixsetting';
1109                         } else {
1110                             $stringtouse = 'environmentshouldfixsetting';
1111                         }
1113                     } else {
1114                         if ($environment_result->getLevel() == 'required') {
1115                             $stringtouse = 'environmentrequireinstall';
1116                         } else {
1117                             $stringtouse = 'environmentrecommendinstall';
1118                         }
1119                     }
1121                     // Calculate the status value
1122                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1123                         $status = get_string('bypassed');
1124                         $warningline = true;
1125                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1126                         $status = get_string('restricted');
1127                         $errorline = true;
1128                     } else {
1129                         if ($status) {                                          //Handle ok result (ok)
1130                             $status = get_string('ok');
1131                         } else {
1132                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1133                                 $status = get_string('check');
1134                                 $warningline = true;
1135                             } else {                                            //Handle error result (error)
1136                                 $status = get_string('check');
1137                                 $errorline = true;
1138                             }
1139                         }
1140                     }
1141                 }
1143                 // Build the text
1144                 $linkparts = array();
1145                 $linkparts[] = 'admin/environment';
1146                 $linkparts[] = $type;
1147                 if (!empty($info)){
1148                    $linkparts[] = $info;
1149                 }
1150                 if (empty($CFG->docroot)) {
1151                     $report = get_string($stringtouse, 'admin', $rec);
1152                 } else {
1153                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec));
1154                 }
1156                 // Format error or warning line
1157                 if ($errorline || $warningline) {
1158                     $messagetype = $errorline? 'error':'warn';
1159                 } else {
1160                     $messagetype = 'ok';
1161                 }
1162                 $status = '<span class="'.$messagetype.'">'.$status.'</span>';
1163                 // Here we'll store all the feedback found
1164                 $feedbacktext = '';
1165                 // Append the feedback if there is some
1166                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
1167                 //Append the bypass if there is some
1168                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
1169                 //Append the restrict if there is some
1170                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
1172                 $report .= $feedbacktext;
1174                 // Add the row to the table
1175                 if ($environment_result->getPart() == 'custom_check'){
1176                     $otherdata[$messagetype][] = array ($info, $report, $status);
1177                 } else {
1178                     $serverdata[$messagetype][] = array ($type, $info, $report, $status);
1179                 }
1180             }
1181         }
1183         //put errors first in
1184         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
1185         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
1187         // Print table
1188         $output = '';
1189         $output .= $this->heading(get_string('serverchecks', 'admin'));
1190         $output .= html_writer::table($servertable);
1191         if (count($othertable->data)){
1192             $output .= $this->heading(get_string('customcheck', 'admin'));
1193             $output .= html_writer::table($othertable);
1194         }
1196         // Finally, if any error has happened, print the summary box
1197         if (!$result) {
1198             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
1199         }
1201         return $output;
1202     }