MDL-32329 fixed missing phpdoc and improved coding style
[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      * @param moodle_url $reloadurl URL of the page to recheck the dependencies
116      * @return string HTML
117      */
118     public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
119         $output = '';
121         $output .= $this->header();
122         $output .= $this->heading(get_string('pluginscheck', 'admin'));
123         $output .= $this->warning(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
124         $output .= $this->plugins_check_table(plugin_manager::instance(), $version, array('xdep' => true));
125         $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
126         $output .= $this->continue_button($reloadurl);
128         $output .= $this->footer();
130         return $output;
131     }
133     /**
134      * Display the 'You are about to upgrade Moodle' page. The first page
135      * during upgrade.
136      * @param string $strnewversion
137      * @param int $maturity
138      * @return string HTML to output.
139      */
140     public function upgrade_confirm_page($strnewversion, $maturity) {
141         $output = '';
143         $continueurl = new moodle_url('index.php', array('confirmupgrade' => 1));
144         $cancelurl = new moodle_url('index.php');
146         $output .= $this->header();
147         $output .= $this->maturity_warning($maturity);
148         $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continueurl, $cancelurl);
149         $output .= $this->footer();
151         return $output;
152     }
154     /**
155      * Display the environment page during the upgrade process.
156      * @param string $release
157      * @param boolean $envstatus final result of env check (true/false)
158      * @param array $environment_results array of results gathered
159      * @return string HTML to output.
160      */
161     public function upgrade_environment_page($release, $envstatus, $environment_results) {
162         global $CFG;
163         $output = '';
165         $output .= $this->header();
166         $output .= $this->heading("Moodle $release");
167         $output .= $this->release_notes_link();
168         $output .= $this->environment_check_table($envstatus, $environment_results);
170         if (!$envstatus) {
171             $output .= $this->upgrade_reload(new moodle_url('/admin/index.php'), array('confirmupgrade' => 1));
173         } else {
174             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
176             if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
177                 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
178             }
180             $output .= $this->continue_button(new moodle_url('/admin/index.php', array('confirmupgrade' => 1, 'confirmrelease' => 1)));
181         }
183         $output .= $this->footer();
185         return $output;
186     }
188     /**
189      * Display the upgrade page that lists all the plugins that require attention.
190      * @param plugin_manager $pluginman provides information about the plugins.
191      * @param available_update_checker $checker provides information about available updates.
192      * @param int $version the version of the Moodle code from version.php.
193      * @param bool $showallplugins
194      * @param moodle_url $reloadurl
195      * @param moodle_url $continueurl
196      * @return string HTML to output.
197      */
198     public function upgrade_plugin_check_page(plugin_manager $pluginman, available_update_checker $checker,
199             $version, $showallplugins, $reloadurl, $continueurl) {
200         global $CFG;
202         $output = '';
204         $output .= $this->header();
205         $output .= $this->box_start('generalbox');
206         $output .= $this->container_start('generalbox', 'notice');
207         $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'));
208         if (empty($CFG->disableupdatenotifications)) {
209             $output .= $this->container_start('checkforupdates');
210             $output .= $this->single_button(new moodle_url($reloadurl, array('fetchupdates' => 1)), get_string('checkforupdates', 'core_plugin'));
211             if ($timefetched = $checker->get_last_timefetched()) {
212                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
213                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
214             }
215             $output .= $this->container_end();
216         }
217         $output .= $this->container_end();
219         $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
220         $output .= $this->box_end();
221         $output .= $this->upgrade_reload($reloadurl);
223         if ($pluginman->some_plugins_updatable()) {
224             $output .= $this->container_start('upgradepluginsinfo');
225             $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
226             $output .= $this->container_end();
227         }
229         $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
230         $button->class = 'continuebutton';
231         $output .= $this->render($button);
232         $output .= $this->footer();
234         return $output;
235     }
237     /**
238      * Display the admin notifications page.
239      * @param int $maturity
240      * @param bool $insecuredataroot warn dataroot is invalid
241      * @param bool $errorsdisplayed warn invalid dispaly error setting
242      * @param bool $cronoverdue warn cron not running
243      * @param bool $dbproblems warn db has problems
244      * @param bool $maintenancemode warn in maintenance mode
245      * @param array|null $availableupdates array of available_update_info objects or null
246      * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
247      *
248      * @return string HTML to output.
249      */
250     public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
251             $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch) {
252         global $CFG;
253         $output = '';
255         $output .= $this->header();
256         $output .= $this->maturity_info($maturity);
257         $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
258         $output .= $this->insecure_dataroot_warning($insecuredataroot);
259         $output .= $this->display_errors_warning($errorsdisplayed);
260         $output .= $this->cron_overdue_warning($cronoverdue);
261         $output .= $this->db_problems($dbproblems);
262         $output .= $this->maintenance_mode_warning($maintenancemode);
264         //////////////////////////////////////////////////////////////////////////////////////////////////
265         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
266         $output .= $this->moodle_copyright();
267         //////////////////////////////////////////////////////////////////////////////////////////////////
269         $output .= $this->footer();
271         return $output;
272     }
274     /**
275      * Display the plugin management page (admin/plugins.php).
276      *
277      * @param plugin_manager $pluginman
278      * @param available_update_checker $checker
279      * @return string HTML to output.
280      */
281     public function plugin_management_page(plugin_manager $pluginman, available_update_checker $checker) {
282         global $CFG;
284         $output = '';
286         $output .= $this->header();
287         $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
288         $output .= $this->plugins_overview_panel($pluginman);
290         if (empty($CFG->disableupdatenotifications)) {
291             $output .= $this->container_start('checkforupdates');
292             $output .= $this->single_button(new moodle_url($this->page->url, array('fetchremote' => 1)), get_string('checkforupdates', 'core_plugin'));
293             if ($timefetched = $checker->get_last_timefetched()) {
294                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
295                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
296             }
297             $output .= $this->container_end();
298         }
300         $output .= $this->box($this->plugins_control_panel($pluginman), 'generalbox');
301         $output .= $this->footer();
303         return $output;
304     }
306     /**
307      * Display the plugin management page (admin/environment.php).
308      * @param array $versions
309      * @param string $version
310      * @param boolean $envstatus final result of env check (true/false)
311      * @param array $environment_results array of results gathered
312      * @return string HTML to output.
313      */
314     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
315         $output = '';
316         $output .= $this->header();
318         // Print the component download link
319         $output .= html_writer::tag('div', html_writer::link(
320                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
321                     get_string('updatecomponent', 'admin')),
322                 array('class' => 'reportlink'));
324         // Heading.
325         $output .= $this->heading(get_string('environment', 'admin'));
327         // Box with info and a menu to choose the version.
328         $output .= $this->box_start();
329         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
330         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
331         $select->label = get_string('moodleversion');
332         $output .= $this->render($select);
333         $output .= $this->box_end();
335         // The results
336         $output .= $this->environment_check_table($envstatus, $environment_results);
338         $output .= $this->footer();
339         return $output;
340     }
342     /**
343      * Output a warning message, of the type that appears on the admin notifications page.
344      * @param string $message the message to display.
345      * @param string $type type class
346      * @return string HTML to output.
347      */
348     protected function warning($message, $type = 'warning') {
349         return $this->box($message, 'generalbox admin' . $type);
350     }
352     /**
353      * Render an appropriate message if dataroot is insecure.
354      * @param bool $insecuredataroot
355      * @return string HTML to output.
356      */
357     protected function insecure_dataroot_warning($insecuredataroot) {
358         global $CFG;
360         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
361             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
363         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
364             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
366         } else {
367             return '';
368         }
369     }
371     /**
372      * Render an appropriate message if dataroot is insecure.
373      * @param bool $errorsdisplayed
374      * @return string HTML to output.
375      */
376     protected function display_errors_warning($errorsdisplayed) {
377         if (!$errorsdisplayed) {
378             return '';
379         }
381         return $this->warning(get_string('displayerrorswarning', 'admin'));
382     }
384     /**
385      * Render an appropriate message if cron has not been run recently.
386      * @param bool $cronoverdue
387      * @return string HTML to output.
388      */
389     public function cron_overdue_warning($cronoverdue) {
390         if (!$cronoverdue) {
391             return '';
392         }
394         return $this->warning(get_string('cronwarning', 'admin') . '&nbsp;' .
395                 $this->help_icon('cron', 'admin'));
396     }
398     /**
399      * Render an appropriate message if there are any problems with the DB set-up.
400      * @param bool $dbproblems
401      * @return string HTML to output.
402      */
403     public function db_problems($dbproblems) {
404         if (!$dbproblems) {
405             return '';
406         }
408         return $this->warning($dbproblems);
409     }
411     /**
412      * Render an appropriate message if the site in in maintenance mode.
413      * @param bool $maintenancemode
414      * @return string HTML to output.
415      */
416     public function maintenance_mode_warning($maintenancemode) {
417         if (!$maintenancemode) {
418             return '';
419         }
421         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
422         $url = $url->out(); // get_string() does not support objects in params
424         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
425     }
427     /**
428      * Display a warning about installing development code if necesary.
429      * @param int $maturity
430      * @return string HTML to output.
431      */
432     protected function maturity_warning($maturity) {
433         if ($maturity == MATURITY_STABLE) {
434             return ''; // No worries.
435         }
437         $maturitylevel = get_string('maturity' . $maturity, 'admin');
438         return $this->box(
439                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
440                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
441                 'generalbox maturitywarning');
442     }
444     /**
445      * Output the copyright notice.
446      * @return string HTML to output.
447      */
448     protected function moodle_copyright() {
449         global $CFG;
451         //////////////////////////////////////////////////////////////////////////////////////////////////
452         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
453         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
454                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
455                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
456                          'and <a href="http://docs.moodle.org/dev/Credits">many other contributors</a>.<br />'.
457                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
458         //////////////////////////////////////////////////////////////////////////////////////////////////
460         return $this->box($copyrighttext, 'copyright');
461     }
463     /**
464      * Display a warning about installing development code if necesary.
465      * @param int $maturity
466      * @return string HTML to output.
467      */
468     protected function maturity_info($maturity) {
469         if ($maturity == MATURITY_STABLE) {
470             return ''; // No worries.
471         }
473         $maturitylevel = get_string('maturity' . $maturity, 'admin');
474         return $this->box(
475                     get_string('maturitycoreinfo', 'admin', $maturitylevel) . ' ' .
476                     $this->doc_link('admin/versions', get_string('morehelp')),
477                 'generalbox adminwarning maturityinfo maturity'.$maturity);
478     }
480     /**
481      * Displays the info about available Moodle updates
482      *
483      * @param array|null $updates array of available_update_info objects or null
484      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
485      * @return string
486      */
487     protected function available_updates($updates, $fetch) {
489         $updateinfo = $this->box_start('generalbox adminwarning availableupdatesinfo');
490         if (is_array($updates)) {
491             $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
492             foreach ($updates as $update) {
493                 $updateinfo .= $this->moodle_available_update_info($update);
494             }
495         } else {
496             $now = time();
497             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
498                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
499             }
500         }
502         $updateinfo .= $this->container_start('checkforupdates');
503         $updateinfo .= $this->single_button(new moodle_url($this->page->url, array('fetchupdates' => 1)), get_string('checkforupdates', 'core_plugin'));
504         if ($fetch) {
505             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
506                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
507         }
508         $updateinfo .= $this->container_end();
510         $updateinfo .= $this->box_end();
512         return $updateinfo;
513     }
515     /**
516      * Helper method to render the information about the available Moodle update
517      *
518      * @param available_update_info $updateinfo information about the available Moodle core update
519      */
520     protected function moodle_available_update_info(available_update_info $updateinfo) {
522         $boxclasses = 'moodleupdateinfo';
523         $info = array();
525         if (isset($updateinfo->release)) {
526             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
527                 array('class' => 'info release'));
528         }
530         if (isset($updateinfo->version)) {
531             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
532                 array('class' => 'info version'));
533         }
535         if (isset($updateinfo->maturity)) {
536             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
537                 array('class' => 'info maturity'));
538             $boxclasses .= ' maturity'.$updateinfo->maturity;
539         }
541         if (isset($updateinfo->download)) {
542             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
543         }
545         if (isset($updateinfo->url)) {
546             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
547                 array('class' => 'info more'));
548         }
550         $box  = $this->output->box_start($boxclasses);
551         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
552         $box .= $this->output->box_end();
554         return $box;
555     }
557     /**
558      * Display a link to the release notes.
559      * @return string HTML to output.
560      */
561     protected function release_notes_link() {
562         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
563         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
564         return $this->box($releasenoteslink, 'generalbox releasenoteslink');
565     }
567     /**
568      * Display the reload link that appears on several upgrade/install pages.
569      * @return string HTML to output.
570      */
571     function upgrade_reload($url) {
572         return html_writer::empty_tag('br') .
573                 html_writer::tag('div',
574                     html_writer::link($url, $this->pix_icon('i/reload', '') .
575                             get_string('reload'), array('title' => get_string('reload'))),
576                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
577     }
579     /**
580      * Displays all known plugins and information about their installation or upgrade
581      *
582      * This default implementation renders all plugins into one big table. The rendering
583      * options support:
584      *     (bool)full = false: whether to display up-to-date plugins, too
585      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
586      *
587      * @param plugin_manager $pluginman provides information about the plugins.
588      * @param int $version the version of the Moodle code from version.php.
589      * @param array $options rendering options
590      * @return string HTML code
591      */
592     public function plugins_check_table(plugin_manager $pluginman, $version, array $options = array()) {
593         global $CFG;
595         $plugininfo = $pluginman->get_plugins();
597         if (empty($plugininfo)) {
598             return '';
599         }
601         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
602         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
604         $table = new html_table();
605         $table->id = 'plugins-check';
606         $table->head = array(
607             get_string('displayname', 'core_plugin'),
608             get_string('rootdir', 'core_plugin'),
609             get_string('source', 'core_plugin'),
610             get_string('versiondb', 'core_plugin'),
611             get_string('versiondisk', 'core_plugin'),
612             get_string('requires', 'core_plugin'),
613             get_string('status', 'core_plugin'),
614         );
615         $table->colclasses = array(
616             'displayname', 'rootdir', 'source', 'versiondb', 'versiondisk', 'requires', 'status',
617         );
618         $table->data = array();
620         $numofhighlighted = array();    // number of highlighted rows per this subsection
622         foreach ($plugininfo as $type => $plugins) {
624             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
625             $header->header = true;
626             $header->colspan = count($table->head);
627             $header = new html_table_row(array($header));
628             $header->attributes['class'] = 'plugintypeheader type-' . $type;
630             $numofhighlighted[$type] = 0;
632             if (empty($plugins) and $options['full']) {
633                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
634                 $msg->colspan = count($table->head);
635                 $row = new html_table_row(array($msg));
636                 $row->attributes['class'] .= 'msg msg-noneinstalled';
637                 $table->data[] = $header;
638                 $table->data[] = $row;
639                 continue;
640             }
642             $plugintyperows = array();
644             foreach ($plugins as $name => $plugin) {
645                 $row = new html_table_row();
646                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
648                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
649                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
650                 } else {
651                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'smallicon pluginicon noicon'));
652                 }
653                 $displayname  = $icon . ' ' . $plugin->displayname;
654                 $displayname = new html_table_cell($displayname);
656                 $rootdir = new html_table_cell($plugin->get_dir());
658                 if ($isstandard = $plugin->is_standard()) {
659                     $row->attributes['class'] .= ' standard';
660                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
661                 } else {
662                     $row->attributes['class'] .= ' extension';
663                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
664                 }
666                 $versiondb = new html_table_cell($plugin->versiondb);
667                 $versiondisk = new html_table_cell($plugin->versiondisk);
669                 $statuscode = $plugin->get_status();
670                 $row->attributes['class'] .= ' status-' . $statuscode;
671                 $status = get_string('status_' . $statuscode, 'core_plugin');
673                 $availableupdates = $plugin->available_updates();
674                 if (!empty($availableupdates) and empty($CFG->disableupdatenotifications)) {
675                     foreach ($availableupdates as $availableupdate) {
676                         $status .= $this->plugin_available_update_info($availableupdate);
677                     }
678                 }
680                 $status = new html_table_cell($status);
682                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
684                 $statusisboring = in_array($statuscode, array(
685                         plugin_manager::PLUGIN_STATUS_NODB, plugin_manager::PLUGIN_STATUS_UPTODATE));
687                 $coredependency = $plugin->is_core_dependency_satisfied($version);
688                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
689                 $dependenciesok = $coredependency && $otherpluginsdependencies;
691                 if ($options['xdep']) {
692                     // we want to see only plugins with failed dependencies
693                     if ($dependenciesok) {
694                         continue;
695                     }
697                 } else if ($isstandard and $statusisboring and $dependenciesok and empty($availableupdates)) {
698                     // no change is going to happen to the plugin - display it only
699                     // if the user wants to see the full list
700                     if (empty($options['full'])) {
701                         continue;
702                     }
703                 }
705                 // ok, the plugin should be displayed
706                 $numofhighlighted[$type]++;
708                 $row->cells = array($displayname, $rootdir, $source,
709                     $versiondb, $versiondisk, $requires, $status);
710                 $plugintyperows[] = $row;
711             }
713             if (empty($numofhighlighted[$type]) and empty($options['full'])) {
714                 continue;
715             }
717             $table->data[] = $header;
718             $table->data = array_merge($table->data, $plugintyperows);
719         }
721         $sumofhighlighted = array_sum($numofhighlighted);
723         if ($options['xdep']) {
724             // we do not want to display no heading and links in this mode
725             $out = '';
727         } else if ($sumofhighlighted == 0) {
728             $out  = $this->output->container_start('nonehighlighted', 'plugins-check-info');
729             $out .= $this->output->heading(get_string('nonehighlighted', 'core_plugin'));
730             if (empty($options['full'])) {
731                 $out .= html_writer::link(new moodle_url('/admin/index.php',
732                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
733                     get_string('nonehighlightedinfo', 'core_plugin'));
734             }
735             $out .= $this->output->container_end();
737         } else {
738             $out  = $this->output->container_start('somehighlighted', 'plugins-check-info');
739             $out .= $this->output->heading(get_string('somehighlighted', 'core_plugin', $sumofhighlighted));
740             if (empty($options['full'])) {
741                 $out .= html_writer::link(new moodle_url('/admin/index.php',
742                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
743                     get_string('somehighlightedinfo', 'core_plugin'));
744             } else {
745                 $out .= html_writer::link(new moodle_url('/admin/index.php',
746                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 0)),
747                     get_string('somehighlightedonly', 'core_plugin'));
748             }
749             $out .= $this->output->container_end();
750         }
752         if ($sumofhighlighted > 0 or $options['full']) {
753             $out .= html_writer::table($table);
754         }
756         return $out;
757     }
759     /**
760      * Formats the information that needs to go in the 'Requires' column.
761      * @param plugininfo_base $plugin the plugin we are rendering the row for.
762      * @param plugin_manager $pluginman provides data on all the plugins.
763      * @param string $version
764      * @return string HTML code
765      */
766     protected function required_column(plugininfo_base $plugin, plugin_manager $pluginman, $version) {
767         $requires = array();
769         if (!empty($plugin->versionrequires)) {
770             if ($plugin->versionrequires <= $version) {
771                 $class = 'requires-ok';
772             } else {
773                 $class = 'requires-failed';
774             }
775             $requires[] = html_writer::tag('li',
776                 get_string('moodleversion', 'core_plugin', $plugin->versionrequires),
777                 array('class' => $class));
778         }
780         foreach ($plugin->get_other_required_plugins() as $component => $requiredversion) {
781             $ok = true;
782             $otherplugin = $pluginman->get_plugin_info($component);
784             if (is_null($otherplugin)) {
785                 $ok = false;
786             } else if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
787                 $ok = false;
788             }
790             if ($ok) {
791                 $class = 'requires-ok';
792             } else {
793                 $class = 'requires-failed';
794             }
796             if ($requiredversion != ANY_VERSION) {
797                 $str = 'otherpluginversion';
798             } else {
799                 $str = 'otherplugin';
800             }
801             $requires[] = html_writer::tag('li',
802                     get_string($str, 'core_plugin',
803                             array('component' => $component, 'version' => $requiredversion)),
804                     array('class' => $class));
805         }
807         if (!$requires) {
808             return '';
809         }
810         return html_writer::tag('ul', implode("\n", $requires));
811     }
813     /**
814      * Prints an overview about the plugins - number of installed, number of extensions etc.
815      *
816      * @param plugin_manager $pluginman provides information about the plugins
817      * @return string as usually
818      */
819     public function plugins_overview_panel(plugin_manager $pluginman) {
820         global $CFG;
822         $plugininfo = $pluginman->get_plugins();
824         $numtotal = $numdisabled = $numextension = $numupdatable = 0;
826         foreach ($plugininfo as $type => $plugins) {
827             foreach ($plugins as $name => $plugin) {
828                 if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
829                     continue;
830                 }
831                 $numtotal++;
832                 if ($plugin->is_enabled() === false) {
833                     $numdisabled++;
834                 }
835                 if (!$plugin->is_standard()) {
836                     $numextension++;
837                 }
838                 if (empty($CFG->disableupdatenotifications) and $plugin->available_updates()) {
839                     $numupdatable++;
840                 }
841             }
842         }
844         $info = array();
845         $info[] = html_writer::tag('span', get_string('numtotal', 'core_plugin', $numtotal), array('class' => 'info total'));
846         $info[] = html_writer::tag('span', get_string('numdisabled', 'core_plugin', $numdisabled), array('class' => 'info disabled'));
847         $info[] = html_writer::tag('span', get_string('numextension', 'core_plugin', $numextension), array('class' => 'info extension'));
848         if ($numupdatable > 0) {
849             $info[] = html_writer::tag('span', get_string('numupdatable', 'core_plugin', $numupdatable), array('class' => 'info updatable'));
850         }
852         return $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '', 'plugins-overview-panel');
853     }
855     /**
856      * Displays all known plugins and links to manage them
857      *
858      * This default implementation renders all plugins into one big table.
859      *
860      * @param plugin_manager $pluginman provides information about the plugins.
861      * @return string HTML code
862      */
863     public function plugins_control_panel(plugin_manager $pluginman) {
864         global $CFG;
866         $plugininfo = $pluginman->get_plugins();
868         if (empty($plugininfo)) {
869             return '';
870         }
872         $table = new html_table();
873         $table->id = 'plugins-control-panel';
874         $table->head = array(
875             get_string('displayname', 'core_plugin'),
876             get_string('source', 'core_plugin'),
877             get_string('version', 'core_plugin'),
878             get_string('availability', 'core_plugin'),
879             get_string('actions', 'core_plugin'),
880             get_string('notes','core_plugin'),
881         );
882         $table->colclasses = array(
883             'pluginname', 'source', 'version', 'availability', 'actions', 'notes'
884         );
886         foreach ($plugininfo as $type => $plugins) {
888             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
889             $header->header = true;
890             $header->colspan = count($table->head);
891             $header = new html_table_row(array($header));
892             $header->attributes['class'] = 'plugintypeheader type-' . $type;
893             $table->data[] = $header;
895             if (empty($plugins)) {
896                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
897                 $msg->colspan = count($table->head);
898                 $row = new html_table_row(array($msg));
899                 $row->attributes['class'] .= 'msg msg-noneinstalled';
900                 $table->data[] = $row;
901                 continue;
902             }
904             foreach ($plugins as $name => $plugin) {
905                 $row = new html_table_row();
906                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
908                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
909                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
910                 } else {
911                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'smallicon pluginicon noicon'));
912                 }
913                 if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
914                     $msg = html_writer::tag('span', get_string('status_missing', 'core_plugin'), array('class' => 'notifyproblem'));
915                     $row->attributes['class'] .= ' missingfromdisk';
916                 } else {
917                     $msg = '';
918                 }
919                 $pluginname  = html_writer::tag('div', $icon . ' ' . $plugin->displayname . ' ' . $msg, array('class' => 'displayname')).
920                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
921                 $pluginname  = new html_table_cell($pluginname);
923                 if ($plugin->is_standard()) {
924                     $row->attributes['class'] .= ' standard';
925                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
926                 } else {
927                     $row->attributes['class'] .= ' extension';
928                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
929                 }
931                 $version = new html_table_cell($plugin->versiondb);
933                 $isenabled = $plugin->is_enabled();
934                 if (is_null($isenabled)) {
935                     $availability = new html_table_cell('');
936                 } else if ($isenabled) {
937                     $row->attributes['class'] .= ' enabled';
938                     $icon = $this->output->pix_icon('i/hide', get_string('pluginenabled', 'core_plugin'));
939                     $availability = new html_table_cell($icon . ' ' . get_string('pluginenabled', 'core_plugin'));
940                 } else {
941                     $row->attributes['class'] .= ' disabled';
942                     $icon = $this->output->pix_icon('i/show', get_string('plugindisabled', 'core_plugin'));
943                     $availability = new html_table_cell($icon . ' ' . get_string('plugindisabled', 'core_plugin'));
944                 }
946                 $actions = array();
948                 $settingsurl = $plugin->get_settings_url();
949                 if (!is_null($settingsurl)) {
950                     $actions[] = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
951                 }
953                 $uninstallurl = $plugin->get_uninstall_url();
954                 if (!is_null($uninstallurl)) {
955                     $actions[] = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'), array('class' => 'uninstall'));
956                 }
958                 $actions = new html_table_cell(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $actions));
960                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
961                 if ($requriedby) {
962                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
963                         array('class' => 'requiredby'));
964                 } else {
965                     $requiredby = '';
966                 }
968                 $updateinfo = '';
969                 if (empty($CFG->disableupdatenotifications) and is_array($plugin->available_updates())) {
970                     foreach ($plugin->available_updates() as $availableupdate) {
971                         $updateinfo .= $this->plugin_available_update_info($availableupdate);
972                     }
973                 }
975                 $notes = new html_table_cell($requiredby.$updateinfo);
977                 $row->cells = array(
978                     $pluginname, $source, $version, $availability, $actions, $notes
979                 );
980                 $table->data[] = $row;
981             }
982         }
984         return html_writer::table($table);
985     }
987     /**
988      * Helper method to render the information about the available plugin update
989      *
990      * The passed objects always provides at least the 'version' property containing
991      * the (higher) version of the plugin available.
992      *
993      * @param available_update_info $updateinfo information about the available update for the plugin
994      */
995     protected function plugin_available_update_info(available_update_info $updateinfo) {
997         $boxclasses = 'pluginupdateinfo';
998         $info = array();
1000         if (isset($updateinfo->release)) {
1001             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1002                 array('class' => 'info release'));
1003         }
1005         if (isset($updateinfo->maturity)) {
1006             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1007                 array('class' => 'info maturity'));
1008             $boxclasses .= ' maturity'.$updateinfo->maturity;
1009         }
1011         if (isset($updateinfo->download)) {
1012             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
1013         }
1015         if (isset($updateinfo->url)) {
1016             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
1017                 array('class' => 'info more'));
1018         }
1020         $box  = $this->output->box_start($boxclasses);
1021         $box .= html_writer::tag('div', get_string('updateavailable', 'core_plugin', $updateinfo->version), array('class' => 'version'));
1022         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
1023         $box .= $this->output->box_end();
1025         return $box;
1026     }
1028     /**
1029      * This function will render one beautiful table with all the environmental
1030      * configuration and how it suits Moodle needs.
1031      *
1032      * @param boolean $result final result of the check (true/false)
1033      * @param array $environment_results array of results gathered
1034      * @return string HTML to output.
1035      */
1036     public function environment_check_table($result, $environment_results) {
1037         global $CFG;
1039         // Table headers
1040         $servertable = new html_table();//table for server checks
1041         $servertable->head  = array(
1042             get_string('name'),
1043             get_string('info'),
1044             get_string('report'),
1045             get_string('status'),
1046         );
1047         $servertable->align = array('center', 'center', 'left', 'center');
1048         $servertable->wrap  = array('nowrap', '', '', 'nowrap');
1049         $servertable->size  = array('10', 10, '100%', '10');
1050         $servertable->attributes['class'] = 'environmenttable generaltable';
1052         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1054         $othertable = new html_table();//table for custom checks
1055         $othertable->head  = array(
1056             get_string('info'),
1057             get_string('report'),
1058             get_string('status'),
1059         );
1060         $othertable->align = array('center', 'left', 'center');
1061         $othertable->wrap  = array('', '', 'nowrap');
1062         $othertable->size  = array(10, '100%', '10');
1063         $othertable->attributes['class'] = 'environmenttable generaltable';
1065         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1067         // Iterate over each environment_result
1068         $continue = true;
1069         foreach ($environment_results as $environment_result) {
1070             $errorline   = false;
1071             $warningline = false;
1072             $stringtouse = '';
1073             if ($continue) {
1074                 $type = $environment_result->getPart();
1075                 $info = $environment_result->getInfo();
1076                 $status = $environment_result->getStatus();
1077                 $error_code = $environment_result->getErrorCode();
1078                 // Process Report field
1079                 $rec = new stdClass();
1080                 // Something has gone wrong at parsing time
1081                 if ($error_code) {
1082                     $stringtouse = 'environmentxmlerror';
1083                     $rec->error_code = $error_code;
1084                     $status = get_string('error');
1085                     $errorline = true;
1086                     $continue = false;
1087                 }
1089                 if ($continue) {
1090                     if ($rec->needed = $environment_result->getNeededVersion()) {
1091                         // We are comparing versions
1092                         $rec->current = $environment_result->getCurrentVersion();
1093                         if ($environment_result->getLevel() == 'required') {
1094                             $stringtouse = 'environmentrequireversion';
1095                         } else {
1096                             $stringtouse = 'environmentrecommendversion';
1097                         }
1099                     } else if ($environment_result->getPart() == 'custom_check') {
1100                         // We are checking installed & enabled things
1101                         if ($environment_result->getLevel() == 'required') {
1102                             $stringtouse = 'environmentrequirecustomcheck';
1103                         } else {
1104                             $stringtouse = 'environmentrecommendcustomcheck';
1105                         }
1107                     } else if ($environment_result->getPart() == 'php_setting') {
1108                         if ($status) {
1109                             $stringtouse = 'environmentsettingok';
1110                         } else if ($environment_result->getLevel() == 'required') {
1111                             $stringtouse = 'environmentmustfixsetting';
1112                         } else {
1113                             $stringtouse = 'environmentshouldfixsetting';
1114                         }
1116                     } else {
1117                         if ($environment_result->getLevel() == 'required') {
1118                             $stringtouse = 'environmentrequireinstall';
1119                         } else {
1120                             $stringtouse = 'environmentrecommendinstall';
1121                         }
1122                     }
1124                     // Calculate the status value
1125                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1126                         $status = get_string('bypassed');
1127                         $warningline = true;
1128                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1129                         $status = get_string('restricted');
1130                         $errorline = true;
1131                     } else {
1132                         if ($status) {                                          //Handle ok result (ok)
1133                             $status = get_string('ok');
1134                         } else {
1135                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1136                                 $status = get_string('check');
1137                                 $warningline = true;
1138                             } else {                                            //Handle error result (error)
1139                                 $status = get_string('check');
1140                                 $errorline = true;
1141                             }
1142                         }
1143                     }
1144                 }
1146                 // Build the text
1147                 $linkparts = array();
1148                 $linkparts[] = 'admin/environment';
1149                 $linkparts[] = $type;
1150                 if (!empty($info)){
1151                    $linkparts[] = $info;
1152                 }
1153                 if (empty($CFG->docroot)) {
1154                     $report = get_string($stringtouse, 'admin', $rec);
1155                 } else {
1156                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec));
1157                 }
1159                 // Format error or warning line
1160                 if ($errorline || $warningline) {
1161                     $messagetype = $errorline? 'error':'warn';
1162                 } else {
1163                     $messagetype = 'ok';
1164                 }
1165                 $status = '<span class="'.$messagetype.'">'.$status.'</span>';
1166                 // Here we'll store all the feedback found
1167                 $feedbacktext = '';
1168                 // Append the feedback if there is some
1169                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
1170                 //Append the bypass if there is some
1171                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
1172                 //Append the restrict if there is some
1173                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
1175                 $report .= $feedbacktext;
1177                 // Add the row to the table
1178                 if ($environment_result->getPart() == 'custom_check'){
1179                     $otherdata[$messagetype][] = array ($info, $report, $status);
1180                 } else {
1181                     $serverdata[$messagetype][] = array ($type, $info, $report, $status);
1182                 }
1183             }
1184         }
1186         //put errors first in
1187         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
1188         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
1190         // Print table
1191         $output = '';
1192         $output .= $this->heading(get_string('serverchecks', 'admin'));
1193         $output .= html_writer::table($servertable);
1194         if (count($othertable->data)){
1195             $output .= $this->heading(get_string('customcheck', 'admin'));
1196             $output .= html_writer::table($othertable);
1197         }
1199         // Finally, if any error has happened, print the summary box
1200         if (!$result) {
1201             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
1202         }
1204         return $output;
1205     }