MDL-42078 multiple uninstall improvements and cleanup
[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();
29 /**
30  * Standard HTML output renderer for core_admin subsystem
31  */
32 class core_admin_renderer extends plugin_renderer_base {
34     /**
35      * Display the 'Do you acknowledge the terms of the GPL' page. The first page
36      * during install.
37      * @return string HTML to output.
38      */
39     public function install_licence_page() {
40         global $CFG;
41         $output = '';
43         $copyrightnotice = text_to_html(get_string('gpl3'));
44         $copyrightnotice = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $copyrightnotice); // extremely ugly validation hack
46         $continue = new single_button(new moodle_url('/admin/index.php', array('lang'=>$CFG->lang, 'agreelicense'=>1)), get_string('continue'), 'get');
48         $output .= $this->header();
49         $output .= $this->heading('<a href="http://moodle.org">Moodle</a> - Modular Object-Oriented Dynamic Learning Environment');
50         $output .= $this->heading(get_string('copyrightnotice'));
51         $output .= $this->box($copyrightnotice, 'copyrightnotice');
52         $output .= html_writer::empty_tag('br');
53         $output .= $this->confirm(get_string('doyouagree'), $continue, "http://docs.moodle.org/dev/License");
54         $output .= $this->footer();
56         return $output;
57     }
59     /**
60      * Display page explaining proper upgrade process,
61      * there can not be any PHP file leftovers...
62      *
63      * @return string HTML to output.
64      */
65     public function upgrade_stale_php_files_page() {
66         $output = '';
67         $output .= $this->header();
68         $output .= $this->heading(get_string('upgradestalefiles', 'admin'));
69         $output .= $this->box_start('generalbox', 'notice');
70         $output .= format_text(get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading')), FORMAT_MARKDOWN);
71         $output .= html_writer::empty_tag('br');
72         $output .= html_writer::tag('div', $this->single_button($this->page->url, get_string('reload'), 'get'), array('class' => 'buttons'));
73         $output .= $this->box_end();
74         $output .= $this->footer();
76         return $output;
77     }
79     /**
80      * Display the 'environment check' page that is displayed during install.
81      * @param int $maturity
82      * @param boolean $envstatus final result of the check (true/false)
83      * @param array $environment_results array of results gathered
84      * @param string $release moodle release
85      * @return string HTML to output.
86      */
87     public function install_environment_page($maturity, $envstatus, $environment_results, $release) {
88         global $CFG;
89         $output = '';
91         $output .= $this->header();
92         $output .= $this->maturity_warning($maturity);
93         $output .= $this->heading("Moodle $release");
94         $output .= $this->release_notes_link();
96         $output .= $this->environment_check_table($envstatus, $environment_results);
98         if (!$envstatus) {
99             $output .= $this->upgrade_reload(new moodle_url('/admin/index.php', array('agreelicense' => 1, 'lang' => $CFG->lang)));
100         } else {
101             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
102             $output .= $this->continue_button(new moodle_url('/admin/index.php', array('agreelicense'=>1, 'confirmrelease'=>1, 'lang'=>$CFG->lang)));
103         }
105         $output .= $this->footer();
106         return $output;
107     }
109     /**
110      * Displays the list of plugins with unsatisfied dependencies
111      *
112      * @param double|string|int $version Moodle on-disk version
113      * @param array $failed list of plugins with unsatisfied dependecies
114      * @param moodle_url $reloadurl URL of the page to recheck the dependencies
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(core_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      * @param string $testsite
138      * @return string HTML to output.
139      */
140     public function upgrade_confirm_page($strnewversion, $maturity, $testsite) {
141         $output = '';
143         $continueurl = new moodle_url('/admin/index.php', array('confirmupgrade' => 1));
144         $continue = new single_button($continueurl, get_string('continue'), 'get');
145         $cancelurl = new moodle_url('/admin/index.php');
147         $output .= $this->header();
148         $output .= $this->maturity_warning($maturity);
149         $output .= $this->test_site_warning($testsite);
150         $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continue, $cancelurl);
151         $output .= $this->footer();
153         return $output;
154     }
156     /**
157      * Display the environment page during the upgrade process.
158      * @param string $release
159      * @param boolean $envstatus final result of env check (true/false)
160      * @param array $environment_results array of results gathered
161      * @return string HTML to output.
162      */
163     public function upgrade_environment_page($release, $envstatus, $environment_results) {
164         global $CFG;
165         $output = '';
167         $output .= $this->header();
168         $output .= $this->heading("Moodle $release");
169         $output .= $this->release_notes_link();
170         $output .= $this->environment_check_table($envstatus, $environment_results);
172         if (!$envstatus) {
173             $output .= $this->upgrade_reload(new moodle_url('/admin/index.php'), array('confirmupgrade' => 1));
175         } else {
176             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
178             if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
179                 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
180             }
182             $output .= $this->continue_button(new moodle_url('/admin/index.php', array('confirmupgrade' => 1, 'confirmrelease' => 1)));
183         }
185         $output .= $this->footer();
187         return $output;
188     }
190     /**
191      * Display the upgrade page that lists all the plugins that require attention.
192      * @param core_plugin_manager $pluginman provides information about the plugins.
193      * @param \core\update\checker $checker provides information about available updates.
194      * @param int $version the version of the Moodle code from version.php.
195      * @param bool $showallplugins
196      * @param moodle_url $reloadurl
197      * @param moodle_url $continueurl
198      * @return string HTML to output.
199      */
200     public function upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,
201             $version, $showallplugins, $reloadurl, $continueurl) {
202         global $CFG;
204         $output = '';
206         $output .= $this->header();
207         $output .= $this->box_start('generalbox');
208         $output .= $this->container_start('generalbox', 'notice');
209         $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'));
210         if (empty($CFG->disableupdatenotifications)) {
211             $output .= $this->container_start('checkforupdates');
212             $output .= $this->single_button(new moodle_url($reloadurl, array('fetchupdates' => 1)), get_string('checkforupdates', 'core_plugin'));
213             if ($timefetched = $checker->get_last_timefetched()) {
214                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
215                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
216             }
217             $output .= $this->container_end();
218         }
219         $output .= $this->container_end();
221         $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
222         $output .= $this->box_end();
223         $output .= $this->upgrade_reload($reloadurl);
225         if ($pluginman->some_plugins_updatable()) {
226             $output .= $this->container_start('upgradepluginsinfo');
227             $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
228             $output .= $this->container_end();
229         }
231         $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
232         $button->class = 'continuebutton';
233         $output .= $this->render($button);
234         $output .= $this->footer();
236         return $output;
237     }
239     /**
240      * Prints a page with a summary of plugin deployment to be confirmed.
241      *
242      * @param \core\update\deployer $deployer
243      * @param array $data deployer's data package as returned by {@link \core\update\deployer::submitted_data()}
244      * @return string
245      */
246     public function upgrade_plugin_confirm_deploy_page(\core\update\deployer $deployer, array $data) {
248         if (!$deployer->initialized()) {
249             throw new coding_exception('Unable to render a page for non-initialized deployer.');
250         }
252         if (empty($data['updateinfo'])) {
253             throw new coding_exception('Missing required data component.');
254         }
256         $updateinfo = $data['updateinfo'];
258         $output  = '';
259         $output .= $this->header();
260         $output .= $this->container_start('generalbox updateplugin', 'notice');
262         $a = new stdClass();
263         if (get_string_manager()->string_exists('pluginname', $updateinfo->component)) {
264             $a->name = get_string('pluginname', $updateinfo->component);
265         } else {
266             $a->name = $updateinfo->component;
267         }
269         if (isset($updateinfo->release)) {
270             $a->version = $updateinfo->release . ' (' . $updateinfo->version . ')';
271         } else {
272             $a->version = $updateinfo->version;
273         }
274         $a->url = $updateinfo->download;
276         $output .= $this->output->heading(get_string('updatepluginconfirm', 'core_plugin'));
277         $output .= $this->output->container(format_text(get_string('updatepluginconfirminfo', 'core_plugin', $a)), 'updatepluginconfirminfo');
278         $output .= $this->output->container(get_string('updatepluginconfirmwarning', 'core_plugin', 'updatepluginconfirmwarning'));
280         if ($repotype = $deployer->plugin_external_source($data['updateinfo'])) {
281             $output .= $this->output->container(get_string('updatepluginconfirmexternal', 'core_plugin', $repotype), 'updatepluginconfirmexternal');
282         }
284         $widget = $deployer->make_execution_widget($data['updateinfo'], $data['returnurl']);
285         $output .= $this->output->render($widget);
287         $output .= $this->output->single_button($data['callerurl'], get_string('cancel', 'core'), 'get');
289         $output .= $this->container_end();
290         $output .= $this->footer();
292         return $output;
293     }
295     /**
296      * Display the admin notifications page.
297      * @param int $maturity
298      * @param bool $insecuredataroot warn dataroot is invalid
299      * @param bool $errorsdisplayed warn invalid dispaly error setting
300      * @param bool $cronoverdue warn cron not running
301      * @param bool $dbproblems warn db has problems
302      * @param bool $maintenancemode warn in maintenance mode
303      * @param bool $buggyiconvnomb warn iconv problems
304      * @param array|null $availableupdates array of \core\update\info objects or null
305      * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
306      *
307      * @return string HTML to output.
308      */
309     public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
310             $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
311             $buggyiconvnomb, $registered) {
312         global $CFG;
313         $output = '';
315         $output .= $this->header();
316         $output .= $this->maturity_info($maturity);
317         $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
318         $output .= $this->insecure_dataroot_warning($insecuredataroot);
319         $output .= $this->display_errors_warning($errorsdisplayed);
320         $output .= $this->buggy_iconv_warning($buggyiconvnomb);
321         $output .= $this->cron_overdue_warning($cronoverdue);
322         $output .= $this->db_problems($dbproblems);
323         $output .= $this->maintenance_mode_warning($maintenancemode);
324         $output .= $this->registration_warning($registered);
326         //////////////////////////////////////////////////////////////////////////////////////////////////
327         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
328         $output .= $this->moodle_copyright();
329         //////////////////////////////////////////////////////////////////////////////////////////////////
331         $output .= $this->footer();
333         return $output;
334     }
336     /**
337      * Display the plugin management page (admin/plugins.php).
338      *
339      * The filtering options array may contain following items:
340      *  bool contribonly - show only contributed extensions
341      *  bool updatesonly - show only plugins with an available update
342      *
343      * @param core_plugin_manager $pluginman
344      * @param \core\update\checker $checker
345      * @param array $options filtering options
346      * @return string HTML to output.
347      */
348     public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
349         global $CFG;
351         $output = '';
353         $output .= $this->header();
354         $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
355         $output .= $this->plugins_overview_panel($pluginman, $options);
357         if (empty($CFG->disableupdatenotifications)) {
358             $output .= $this->container_start('checkforupdates');
359             $output .= $this->single_button(
360                 new moodle_url($this->page->url, array_merge($options, array('fetchremote' => 1))),
361                 get_string('checkforupdates', 'core_plugin')
362             );
363             if ($timefetched = $checker->get_last_timefetched()) {
364                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
365                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
366             }
367             $output .= $this->container_end();
368         }
370         $output .= $this->box($this->plugins_control_panel($pluginman, $options), 'generalbox');
371         $output .= $this->footer();
373         return $output;
374     }
376     /**
377      * Display a page to confirm the plugin uninstallation.
378      *
379      * @param core_plugin_manager $pluginman
380      * @param \core\plugininfo\base $pluginfo
381      * @param moodle_url $continueurl URL to continue after confirmation
382      * @param moodle_url $cancelurl URL to to go if cancelled
383      * @return string
384      */
385     public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
386         $output = '';
388         $pluginname = $pluginman->plugin_name($pluginfo->component);
390         $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
391         if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
392             $confirm .= $extraconfirm;
393         }
395         $output .= $this->output->header();
396         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
397         $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
398         $output .= $this->output->footer();
400         return $output;
401     }
403     /**
404      * Display a page with results of plugin uninstallation and offer removal of plugin files.
405      *
406      * @param core_plugin_manager $pluginman
407      * @param \core\plugininfo\base $pluginfo
408      * @param progress_trace_buffer $progress
409      * @param moodle_url $continueurl URL to continue to remove the plugin folder
410      * @return string
411      */
412     public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
413                                                             progress_trace_buffer $progress, moodle_url $continueurl) {
414         $output = '';
416         $pluginname = $pluginman->plugin_name($pluginfo->component);
418         // Do not show navigation here, they must click one of the buttons.
419         $this->page->set_pagelayout('maintenance');
420         $this->page->set_cacheable(false);
422         $output .= $this->output->header();
423         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
425         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
427         $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
428             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
430         if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
431             $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
432                 'uninstalldeleteconfirmexternal');
433         }
435         // After any uninstall we must execute full upgrade to finish the cleanup!
436         $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
437         $output .= $this->output->footer();
439         return $output;
440     }
442     /**
443      * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
444      *
445      * @param core_plugin_manager $pluginman
446      * @param \core\plugininfo\base $pluginfo
447      * @param progress_trace_buffer $progress
448      * @return string
449      */
450     public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
451         $output = '';
453         $pluginname = $pluginfo->component;
455         $output .= $this->output->header();
456         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
458         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
460         $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
461             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
462         $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
463         $output .= $this->output->footer();
465         return $output;
466     }
468     /**
469      * Display the plugin management page (admin/environment.php).
470      * @param array $versions
471      * @param string $version
472      * @param boolean $envstatus final result of env check (true/false)
473      * @param array $environment_results array of results gathered
474      * @return string HTML to output.
475      */
476     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
477         $output = '';
478         $output .= $this->header();
480         // Print the component download link
481         $output .= html_writer::tag('div', html_writer::link(
482                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
483                     get_string('updatecomponent', 'admin')),
484                 array('class' => 'reportlink'));
486         // Heading.
487         $output .= $this->heading(get_string('environment', 'admin'));
489         // Box with info and a menu to choose the version.
490         $output .= $this->box_start();
491         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
492         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
493         $select->label = get_string('moodleversion');
494         $output .= $this->render($select);
495         $output .= $this->box_end();
497         // The results
498         $output .= $this->environment_check_table($envstatus, $environment_results);
500         $output .= $this->footer();
501         return $output;
502     }
504     /**
505      * Output a warning message, of the type that appears on the admin notifications page.
506      * @param string $message the message to display.
507      * @param string $type type class
508      * @return string HTML to output.
509      */
510     protected function warning($message, $type = 'warning') {
511         return $this->box($message, 'generalbox admin' . $type);
512     }
514     /**
515      * Render an appropriate message if dataroot is insecure.
516      * @param bool $insecuredataroot
517      * @return string HTML to output.
518      */
519     protected function insecure_dataroot_warning($insecuredataroot) {
520         global $CFG;
522         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
523             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
525         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
526             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
528         } else {
529             return '';
530         }
531     }
533     /**
534      * Render an appropriate message if dataroot is insecure.
535      * @param bool $errorsdisplayed
536      * @return string HTML to output.
537      */
538     protected function display_errors_warning($errorsdisplayed) {
539         if (!$errorsdisplayed) {
540             return '';
541         }
543         return $this->warning(get_string('displayerrorswarning', 'admin'));
544     }
546     /**
547      * Render an appropriate message if iconv is buggy and mbstring missing.
548      * @param bool $buggyiconvnomb
549      * @return string HTML to output.
550      */
551     protected function buggy_iconv_warning($buggyiconvnomb) {
552         if (!$buggyiconvnomb) {
553             return '';
554         }
556         return $this->warning(get_string('warningiconvbuggy', 'admin'));
557     }
559     /**
560      * Render an appropriate message if cron has not been run recently.
561      * @param bool $cronoverdue
562      * @return string HTML to output.
563      */
564     public function cron_overdue_warning($cronoverdue) {
565         if (!$cronoverdue) {
566             return '';
567         }
569         return $this->warning(get_string('cronwarning', 'admin') . '&nbsp;' .
570                 $this->help_icon('cron', 'admin'));
571     }
573     /**
574      * Render an appropriate message if there are any problems with the DB set-up.
575      * @param bool $dbproblems
576      * @return string HTML to output.
577      */
578     public function db_problems($dbproblems) {
579         if (!$dbproblems) {
580             return '';
581         }
583         return $this->warning($dbproblems);
584     }
586     /**
587      * Render an appropriate message if the site in in maintenance mode.
588      * @param bool $maintenancemode
589      * @return string HTML to output.
590      */
591     public function maintenance_mode_warning($maintenancemode) {
592         if (!$maintenancemode) {
593             return '';
594         }
596         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
597         $url = $url->out(); // get_string() does not support objects in params
599         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
600     }
602     /**
603      * Display a warning about installing development code if necesary.
604      * @param int $maturity
605      * @return string HTML to output.
606      */
607     protected function maturity_warning($maturity) {
608         if ($maturity == MATURITY_STABLE) {
609             return ''; // No worries.
610         }
612         $maturitylevel = get_string('maturity' . $maturity, 'admin');
613         return $this->box(
614                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
615                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
616                 'generalbox maturitywarning');
617     }
619     /*
620      * If necessary, displays a warning about upgrading a test site.
621      *
622      * @param string $testsite
623      * @return string HTML
624      */
625     protected function test_site_warning($testsite) {
627         if (!$testsite) {
628             return '';
629         }
631         return $this->box(
632             $this->container(get_string('testsiteupgradewarning', 'admin', $testsite)),
633             'generalbox testsitewarning'
634         );
635     }
637     /**
638      * Output the copyright notice.
639      * @return string HTML to output.
640      */
641     protected function moodle_copyright() {
642         global $CFG;
644         //////////////////////////////////////////////////////////////////////////////////////////////////
645         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
646         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
647                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
648                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
649                          'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
650                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
651         //////////////////////////////////////////////////////////////////////////////////////////////////
653         return $this->box($copyrighttext, 'copyright');
654     }
656     /**
657      * Display a warning about installing development code if necesary.
658      * @param int $maturity
659      * @return string HTML to output.
660      */
661     protected function maturity_info($maturity) {
662         if ($maturity == MATURITY_STABLE) {
663             return ''; // No worries.
664         }
666         $maturitylevel = get_string('maturity' . $maturity, 'admin');
667         return $this->box(
668                     get_string('maturitycoreinfo', 'admin', $maturitylevel) . ' ' .
669                     $this->doc_link('admin/versions', get_string('morehelp')),
670                 'generalbox adminwarning maturityinfo maturity'.$maturity);
671     }
673     /**
674      * Displays the info about available Moodle core and plugin updates
675      *
676      * The structure of the $updates param has changed since 2.4. It contains not only updates
677      * for the core itself, but also for all other installed plugins.
678      *
679      * @param array|null $updates array of (string)component => array of \core\update\info objects or null
680      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
681      * @return string
682      */
683     protected function available_updates($updates, $fetch) {
685         $updateinfo = $this->box_start('generalbox adminwarning availableupdatesinfo');
686         $someupdateavailable = false;
687         if (is_array($updates)) {
688             if (is_array($updates['core'])) {
689                 $someupdateavailable = true;
690                 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
691                 foreach ($updates['core'] as $update) {
692                     $updateinfo .= $this->moodle_available_update_info($update);
693                 }
694             }
695             unset($updates['core']);
696             // If something has left in the $updates array now, it is updates for plugins.
697             if (!empty($updates)) {
698                 $someupdateavailable = true;
699                 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
700                 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
701                 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
702                     array('url' => $pluginsoverviewurl->out())));
703             }
704         }
706         if (!$someupdateavailable) {
707             $now = time();
708             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
709                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
710             }
711         }
713         $updateinfo .= $this->container_start('checkforupdates');
714         $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 1));
715         $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
716         if ($fetch) {
717             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
718                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
719         }
720         $updateinfo .= $this->container_end();
722         $updateinfo .= $this->box_end();
724         return $updateinfo;
725     }
727     /**
728      * Display a warning about not being registered on Moodle.org if necesary.
729      *
730      * @param boolean $registered true if the site is registered on Moodle.org
731      * @return string HTML to output.
732      */
733     protected function registration_warning($registered) {
735         if (!$registered) {
737             $registerbutton = $this->single_button(new moodle_url('/admin/registration/register.php',
738                     array('huburl' =>  HUB_MOODLEORGHUBURL, 'hubname' => 'Moodle.org')),
739                     get_string('register', 'admin'));
741             return $this->warning( get_string('registrationwarning', 'admin')
742                     . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton );
743         }
745         return '';
746     }
748     /**
749      * Helper method to render the information about the available Moodle update
750      *
751      * @param \core\update\info $updateinfo information about the available Moodle core update
752      */
753     protected function moodle_available_update_info(\core\update\info $updateinfo) {
755         $boxclasses = 'moodleupdateinfo';
756         $info = array();
758         if (isset($updateinfo->release)) {
759             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
760                 array('class' => 'info release'));
761         }
763         if (isset($updateinfo->version)) {
764             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
765                 array('class' => 'info version'));
766         }
768         if (isset($updateinfo->maturity)) {
769             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
770                 array('class' => 'info maturity'));
771             $boxclasses .= ' maturity'.$updateinfo->maturity;
772         }
774         if (isset($updateinfo->download)) {
775             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
776         }
778         if (isset($updateinfo->url)) {
779             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
780                 array('class' => 'info more'));
781         }
783         $box  = $this->output->box_start($boxclasses);
784         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
785         $box .= $this->output->box_end();
787         return $box;
788     }
790     /**
791      * Display a link to the release notes.
792      * @return string HTML to output.
793      */
794     protected function release_notes_link() {
795         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
796         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
797         return $this->box($releasenoteslink, 'generalbox releasenoteslink');
798     }
800     /**
801      * Display the reload link that appears on several upgrade/install pages.
802      * @return string HTML to output.
803      */
804     function upgrade_reload($url) {
805         return html_writer::empty_tag('br') .
806                 html_writer::tag('div',
807                     html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
808                             get_string('reload'), array('title' => get_string('reload'))),
809                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
810     }
812     /**
813      * Displays all known plugins and information about their installation or upgrade
814      *
815      * This default implementation renders all plugins into one big table. The rendering
816      * options support:
817      *     (bool)full = false: whether to display up-to-date plugins, too
818      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
819      *
820      * @param core_plugin_manager $pluginman provides information about the plugins.
821      * @param int $version the version of the Moodle code from version.php.
822      * @param array $options rendering options
823      * @return string HTML code
824      */
825     public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
826         global $CFG;
828         $plugininfo = $pluginman->get_plugins();
830         if (empty($plugininfo)) {
831             return '';
832         }
834         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
835         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
837         $table = new html_table();
838         $table->id = 'plugins-check';
839         $table->head = array(
840             get_string('displayname', 'core_plugin'),
841             get_string('rootdir', 'core_plugin'),
842             get_string('source', 'core_plugin'),
843             get_string('versiondb', 'core_plugin'),
844             get_string('versiondisk', 'core_plugin'),
845             get_string('requires', 'core_plugin'),
846             get_string('status', 'core_plugin'),
847         );
848         $table->colclasses = array(
849             'displayname', 'rootdir', 'source', 'versiondb', 'versiondisk', 'requires', 'status',
850         );
851         $table->data = array();
853         $numofhighlighted = array();    // number of highlighted rows per this subsection
855         foreach ($plugininfo as $type => $plugins) {
857             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
858             $header->header = true;
859             $header->colspan = count($table->head);
860             $header = new html_table_row(array($header));
861             $header->attributes['class'] = 'plugintypeheader type-' . $type;
863             $numofhighlighted[$type] = 0;
865             if (empty($plugins) and $options['full']) {
866                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
867                 $msg->colspan = count($table->head);
868                 $row = new html_table_row(array($msg));
869                 $row->attributes['class'] .= 'msg msg-noneinstalled';
870                 $table->data[] = $header;
871                 $table->data[] = $row;
872                 continue;
873             }
875             $plugintyperows = array();
877             foreach ($plugins as $name => $plugin) {
878                 $row = new html_table_row();
879                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
881                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
882                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
883                 } else {
884                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'smallicon pluginicon noicon'));
885                 }
886                 $displayname  = $icon . ' ' . $plugin->displayname;
887                 $displayname = new html_table_cell($displayname);
889                 $rootdir = new html_table_cell($plugin->get_dir());
891                 if ($isstandard = $plugin->is_standard()) {
892                     $row->attributes['class'] .= ' standard';
893                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
894                 } else {
895                     $row->attributes['class'] .= ' extension';
896                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
897                 }
899                 $versiondb = new html_table_cell($plugin->versiondb);
900                 $versiondisk = new html_table_cell($plugin->versiondisk);
902                 $statuscode = $plugin->get_status();
903                 $row->attributes['class'] .= ' status-' . $statuscode;
904                 $status = get_string('status_' . $statuscode, 'core_plugin');
906                 $availableupdates = $plugin->available_updates();
907                 if (!empty($availableupdates) and empty($CFG->disableupdatenotifications)) {
908                     foreach ($availableupdates as $availableupdate) {
909                         $status .= $this->plugin_available_update_info($availableupdate);
910                     }
911                 }
913                 $status = new html_table_cell($status);
915                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
917                 $statusisboring = in_array($statuscode, array(
918                         core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
920                 $coredependency = $plugin->is_core_dependency_satisfied($version);
921                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
922                 $dependenciesok = $coredependency && $otherpluginsdependencies;
924                 if ($options['xdep']) {
925                     // we want to see only plugins with failed dependencies
926                     if ($dependenciesok) {
927                         continue;
928                     }
930                 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
931                     // no change is going to happen to the plugin - display it only
932                     // if the user wants to see the full list
933                     if (empty($options['full'])) {
934                         continue;
935                     }
936                 }
938                 // ok, the plugin should be displayed
939                 $numofhighlighted[$type]++;
941                 $row->cells = array($displayname, $rootdir, $source,
942                     $versiondb, $versiondisk, $requires, $status);
943                 $plugintyperows[] = $row;
944             }
946             if (empty($numofhighlighted[$type]) and empty($options['full'])) {
947                 continue;
948             }
950             $table->data[] = $header;
951             $table->data = array_merge($table->data, $plugintyperows);
952         }
954         $sumofhighlighted = array_sum($numofhighlighted);
956         if ($options['xdep']) {
957             // we do not want to display no heading and links in this mode
958             $out = '';
960         } else if ($sumofhighlighted == 0) {
961             $out  = $this->output->container_start('nonehighlighted', 'plugins-check-info');
962             $out .= $this->output->heading(get_string('nonehighlighted', 'core_plugin'));
963             if (empty($options['full'])) {
964                 $out .= html_writer::link(new moodle_url('/admin/index.php',
965                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
966                     get_string('nonehighlightedinfo', 'core_plugin'));
967             }
968             $out .= $this->output->container_end();
970         } else {
971             $out  = $this->output->container_start('somehighlighted', 'plugins-check-info');
972             $out .= $this->output->heading(get_string('somehighlighted', 'core_plugin', $sumofhighlighted));
973             if (empty($options['full'])) {
974                 $out .= html_writer::link(new moodle_url('/admin/index.php',
975                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 1)),
976                     get_string('somehighlightedinfo', 'core_plugin'));
977             } else {
978                 $out .= html_writer::link(new moodle_url('/admin/index.php',
979                     array('confirmupgrade' => 1, 'confirmrelease' => 1, 'showallplugins' => 0)),
980                     get_string('somehighlightedonly', 'core_plugin'));
981             }
982             $out .= $this->output->container_end();
983         }
985         if ($sumofhighlighted > 0 or $options['full']) {
986             $out .= html_writer::table($table);
987         }
989         return $out;
990     }
992     /**
993      * Formats the information that needs to go in the 'Requires' column.
994      * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
995      * @param core_plugin_manager $pluginman provides data on all the plugins.
996      * @param string $version
997      * @return string HTML code
998      */
999     protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) {
1000         $requires = array();
1002         if (!empty($plugin->versionrequires)) {
1003             if ($plugin->versionrequires <= $version) {
1004                 $class = 'requires-ok';
1005             } else {
1006                 $class = 'requires-failed';
1007             }
1008             $requires[] = html_writer::tag('li',
1009                 get_string('moodleversion', 'core_plugin', $plugin->versionrequires),
1010                 array('class' => $class));
1011         }
1013         foreach ($plugin->get_other_required_plugins() as $component => $requiredversion) {
1014             $ok = true;
1015             $otherplugin = $pluginman->get_plugin_info($component);
1017             if (is_null($otherplugin)) {
1018                 $ok = false;
1019             } else if ($requiredversion != ANY_VERSION and $otherplugin->versiondisk < $requiredversion) {
1020                 $ok = false;
1021             }
1023             if ($ok) {
1024                 $class = 'requires-ok';
1025             } else {
1026                 $class = 'requires-failed';
1027             }
1029             if ($requiredversion != ANY_VERSION) {
1030                 $str = 'otherpluginversion';
1031             } else {
1032                 $str = 'otherplugin';
1033             }
1034             $componenturl = new moodle_url('https://moodle.org/plugins/view.php?plugin='.$component);
1035             $componenturl = html_writer::tag('a', $component, array('href' => $componenturl->out()));
1036             $requires[] = html_writer::tag('li',
1037                     get_string($str, 'core_plugin',
1038                             array('component' => $componenturl, 'version' => $requiredversion)),
1039                     array('class' => $class));
1040         }
1042         if (!$requires) {
1043             return '';
1044         }
1045         return html_writer::tag('ul', implode("\n", $requires));
1046     }
1048     /**
1049      * Prints an overview about the plugins - number of installed, number of extensions etc.
1050      *
1051      * @param core_plugin_manager $pluginman provides information about the plugins
1052      * @param array $options filtering options
1053      * @return string as usually
1054      */
1055     public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1056         global $CFG;
1058         $plugininfo = $pluginman->get_plugins();
1060         $numtotal = $numdisabled = $numextension = $numupdatable = 0;
1062         foreach ($plugininfo as $type => $plugins) {
1063             foreach ($plugins as $name => $plugin) {
1064                 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1065                     continue;
1066                 }
1067                 $numtotal++;
1068                 if ($plugin->is_enabled() === false) {
1069                     $numdisabled++;
1070                 }
1071                 if (!$plugin->is_standard()) {
1072                     $numextension++;
1073                 }
1074                 if (empty($CFG->disableupdatenotifications) and $plugin->available_updates()) {
1075                     $numupdatable++;
1076                 }
1077             }
1078         }
1080         $info = array();
1081         $filter = array();
1082         $somefilteractive = false;
1083         $info[] = html_writer::tag('span', get_string('numtotal', 'core_plugin', $numtotal), array('class' => 'info total'));
1084         $info[] = html_writer::tag('span', get_string('numdisabled', 'core_plugin', $numdisabled), array('class' => 'info disabled'));
1085         $info[] = html_writer::tag('span', get_string('numextension', 'core_plugin', $numextension), array('class' => 'info extension'));
1086         if ($numextension > 0) {
1087             if (empty($options['contribonly'])) {
1088                 $filter[] = html_writer::link(
1089                     new moodle_url($this->page->url, array('contribonly' => 1)),
1090                     get_string('filtercontribonly', 'core_plugin'),
1091                     array('class' => 'filter-item show-contribonly')
1092                 );
1093             } else {
1094                 $filter[] = html_writer::tag('span', get_string('filtercontribonlyactive', 'core_plugin'),
1095                     array('class' => 'filter-item active show-contribonly'));
1096                 $somefilteractive = true;
1097             }
1098         }
1099         if ($numupdatable > 0) {
1100             $info[] = html_writer::tag('span', get_string('numupdatable', 'core_plugin', $numupdatable), array('class' => 'info updatable'));
1101             if (empty($options['updatesonly'])) {
1102                 $filter[] = html_writer::link(
1103                     new moodle_url($this->page->url, array('updatesonly' => 1)),
1104                     get_string('filterupdatesonly', 'core_plugin'),
1105                     array('class' => 'filter-item show-updatesonly')
1106                 );
1107             } else {
1108                 $filter[] = html_writer::tag('span', get_string('filterupdatesonlyactive', 'core_plugin'),
1109                     array('class' => 'filter-item active show-updatesonly'));
1110                 $somefilteractive = true;
1111             }
1112         }
1113         if ($somefilteractive) {
1114             $filter[] = html_writer::link($this->page->url, get_string('filterall', 'core_plugin'), array('class' => 'filter-item show-all'));
1115         }
1117         $output  = $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '', 'plugins-overview-panel');
1119         if (!empty($filter)) {
1120             $output .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $filter), '', 'plugins-overview-filter');
1121         }
1123         return $output;
1124     }
1126     /**
1127      * Displays all known plugins and links to manage them
1128      *
1129      * This default implementation renders all plugins into one big table.
1130      *
1131      * @param core_plugin_manager $pluginman provides information about the plugins.
1132      * @param array $options filtering options
1133      * @return string HTML code
1134      */
1135     public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1136         global $CFG;
1138         $plugininfo = $pluginman->get_plugins();
1140         // Filter the list of plugins according the options.
1141         if (!empty($options['updatesonly'])) {
1142             $updateable = array();
1143             foreach ($plugininfo as $plugintype => $pluginnames) {
1144                 foreach ($pluginnames as $pluginname => $pluginfo) {
1145                     if (!empty($pluginfo->availableupdates)) {
1146                         foreach ($pluginfo->availableupdates as $pluginavailableupdate) {
1147                             if ($pluginavailableupdate->version > $pluginfo->versiondisk) {
1148                                 $updateable[$plugintype][$pluginname] = $pluginfo;
1149                             }
1150                         }
1151                     }
1152                 }
1153             }
1154             $plugininfo = $updateable;
1155         }
1157         if (!empty($options['contribonly'])) {
1158             $contribs = array();
1159             foreach ($plugininfo as $plugintype => $pluginnames) {
1160                 foreach ($pluginnames as $pluginname => $pluginfo) {
1161                     if (!$pluginfo->is_standard()) {
1162                         $contribs[$plugintype][$pluginname] = $pluginfo;
1163                     }
1164                 }
1165             }
1166             $plugininfo = $contribs;
1167         }
1169         if (empty($plugininfo)) {
1170             return '';
1171         }
1173         $table = new html_table();
1174         $table->id = 'plugins-control-panel';
1175         $table->head = array(
1176             get_string('displayname', 'core_plugin'),
1177             get_string('source', 'core_plugin'),
1178             get_string('version', 'core_plugin'),
1179             get_string('availability', 'core_plugin'),
1180             get_string('actions', 'core_plugin'),
1181             get_string('notes','core_plugin'),
1182         );
1183         $table->headspan = array(1, 1, 1, 1, 2, 1);
1184         $table->colclasses = array(
1185             'pluginname', 'source', 'version', 'availability', 'settings', 'uninstall', 'notes'
1186         );
1188         foreach ($plugininfo as $type => $plugins) {
1189             $heading = $pluginman->plugintype_name_plural($type);
1190             $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1191             if ($manageurl = $pluginclass::get_manage_url()) {
1192                 $heading = html_writer::link($manageurl, $heading);
1193             }
1194             $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1195             $header->header = true;
1196             $header->colspan = array_sum($table->headspan);
1197             $header = new html_table_row(array($header));
1198             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1199             $table->data[] = $header;
1201             if (empty($plugins)) {
1202                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1203                 $msg->colspan = array_sum($table->headspan);
1204                 $row = new html_table_row(array($msg));
1205                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1206                 $table->data[] = $row;
1207                 continue;
1208             }
1210             foreach ($plugins as $name => $plugin) {
1211                 $row = new html_table_row();
1212                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1214                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
1215                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1216                 } else {
1217                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
1218                 }
1219                 $status = $plugin->get_status();
1220                 $row->attributes['class'] .= ' status-'.$status;
1221                 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1222                     $msg = html_writer::tag('span', get_string('status_missing', 'core_plugin'), array('class' => 'statusmsg'));
1223                 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1224                     $msg = html_writer::tag('span', get_string('status_new', 'core_plugin'), array('class' => 'statusmsg'));
1225                 } else {
1226                     $msg = '';
1227                 }
1228                 $pluginname  = html_writer::tag('div', $icon . '' . $plugin->displayname . ' ' . $msg, array('class' => 'displayname')).
1229                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1230                 $pluginname  = new html_table_cell($pluginname);
1232                 if ($plugin->is_standard()) {
1233                     $row->attributes['class'] .= ' standard';
1234                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
1235                 } else {
1236                     $row->attributes['class'] .= ' extension';
1237                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
1238                 }
1240                 $version = new html_table_cell($plugin->versiondb);
1242                 $isenabled = $plugin->is_enabled();
1243                 if (is_null($isenabled)) {
1244                     $availability = new html_table_cell('');
1245                 } else if ($isenabled) {
1246                     $row->attributes['class'] .= ' enabled';
1247                     $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1248                 } else {
1249                     $row->attributes['class'] .= ' disabled';
1250                     $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1251                 }
1253                 $settingsurl = $plugin->get_settings_url();
1254                 if (!is_null($settingsurl)) {
1255                     $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1256                 } else {
1257                     $settings = '';
1258                 }
1259                 $settings = new html_table_cell($settings);
1261                 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1262                     $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1263                 } else {
1264                     $uninstall = '';
1265                 }
1266                 $uninstall = new html_table_cell($uninstall);
1268                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1269                 if ($requriedby) {
1270                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1271                         array('class' => 'requiredby'));
1272                 } else {
1273                     $requiredby = '';
1274                 }
1276                 $updateinfo = '';
1277                 if (empty($CFG->disableupdatenotifications) and is_array($plugin->available_updates())) {
1278                     foreach ($plugin->available_updates() as $availableupdate) {
1279                         $updateinfo .= $this->plugin_available_update_info($availableupdate);
1280                     }
1281                 }
1283                 $notes = new html_table_cell($requiredby.$updateinfo);
1285                 $row->cells = array(
1286                     $pluginname, $source, $version, $availability, $settings, $uninstall, $notes
1287                 );
1288                 $table->data[] = $row;
1289             }
1290         }
1292         return html_writer::table($table);
1293     }
1295     /**
1296      * Helper method to render the information about the available plugin update
1297      *
1298      * The passed objects always provides at least the 'version' property containing
1299      * the (higher) version of the plugin available.
1300      *
1301      * @param \core\update\info $updateinfo information about the available update for the plugin
1302      */
1303     protected function plugin_available_update_info(\core\update\info $updateinfo) {
1305         $boxclasses = 'pluginupdateinfo';
1306         $info = array();
1308         if (isset($updateinfo->release)) {
1309             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1310                 array('class' => 'info release'));
1311         }
1313         if (isset($updateinfo->maturity)) {
1314             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1315                 array('class' => 'info maturity'));
1316             $boxclasses .= ' maturity'.$updateinfo->maturity;
1317         }
1319         if (isset($updateinfo->download)) {
1320             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
1321         }
1323         if (isset($updateinfo->url)) {
1324             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
1325                 array('class' => 'info more'));
1326         }
1328         $box  = $this->output->box_start($boxclasses);
1329         $box .= html_writer::tag('div', get_string('updateavailable', 'core_plugin', $updateinfo->version), array('class' => 'version'));
1330         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
1332         $deployer = \core\update\deployer::instance();
1333         if ($deployer->initialized()) {
1334             $impediments = $deployer->deployment_impediments($updateinfo);
1335             if (empty($impediments)) {
1336                 $widget = $deployer->make_confirm_widget($updateinfo);
1337                 $box .= $this->output->render($widget);
1338             } else {
1339                 if (isset($impediments['notwritable'])) {
1340                     $box .= $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1341                 }
1342                 if (isset($impediments['notdownloadable'])) {
1343                     $box .= $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1344                 }
1345             }
1346         }
1348         $box .= $this->output->box_end();
1350         return $box;
1351     }
1353     /**
1354      * This function will render one beautiful table with all the environmental
1355      * configuration and how it suits Moodle needs.
1356      *
1357      * @param boolean $result final result of the check (true/false)
1358      * @param array $environment_results array of results gathered
1359      * @return string HTML to output.
1360      */
1361     public function environment_check_table($result, $environment_results) {
1362         global $CFG;
1364         // Table headers
1365         $servertable = new html_table();//table for server checks
1366         $servertable->head  = array(
1367             get_string('name'),
1368             get_string('info'),
1369             get_string('report'),
1370             get_string('status'),
1371         );
1372         $servertable->colclasses = array('centeralign name', 'centeralign status', 'leftalign report', 'centeralign info');
1373         $servertable->attributes['class'] = 'admintable environmenttable generaltable';
1374         $servertable->id = 'serverstatus';
1376         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1378         $othertable = new html_table();//table for custom checks
1379         $othertable->head  = array(
1380             get_string('info'),
1381             get_string('report'),
1382             get_string('status'),
1383         );
1384         $othertable->colclasses = array('aligncenter info', 'alignleft report', 'aligncenter status');
1385         $othertable->attributes['class'] = 'admintable environmenttable generaltable';
1386         $othertable->id = 'otherserverstatus';
1388         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1390         // Iterate over each environment_result
1391         $continue = true;
1392         foreach ($environment_results as $environment_result) {
1393             $errorline   = false;
1394             $warningline = false;
1395             $stringtouse = '';
1396             if ($continue) {
1397                 $type = $environment_result->getPart();
1398                 $info = $environment_result->getInfo();
1399                 $status = $environment_result->getStatus();
1400                 $error_code = $environment_result->getErrorCode();
1401                 // Process Report field
1402                 $rec = new stdClass();
1403                 // Something has gone wrong at parsing time
1404                 if ($error_code) {
1405                     $stringtouse = 'environmentxmlerror';
1406                     $rec->error_code = $error_code;
1407                     $status = get_string('error');
1408                     $errorline = true;
1409                     $continue = false;
1410                 }
1412                 if ($continue) {
1413                     if ($rec->needed = $environment_result->getNeededVersion()) {
1414                         // We are comparing versions
1415                         $rec->current = $environment_result->getCurrentVersion();
1416                         if ($environment_result->getLevel() == 'required') {
1417                             $stringtouse = 'environmentrequireversion';
1418                         } else {
1419                             $stringtouse = 'environmentrecommendversion';
1420                         }
1422                     } else if ($environment_result->getPart() == 'custom_check') {
1423                         // We are checking installed & enabled things
1424                         if ($environment_result->getLevel() == 'required') {
1425                             $stringtouse = 'environmentrequirecustomcheck';
1426                         } else {
1427                             $stringtouse = 'environmentrecommendcustomcheck';
1428                         }
1430                     } else if ($environment_result->getPart() == 'php_setting') {
1431                         if ($status) {
1432                             $stringtouse = 'environmentsettingok';
1433                         } else if ($environment_result->getLevel() == 'required') {
1434                             $stringtouse = 'environmentmustfixsetting';
1435                         } else {
1436                             $stringtouse = 'environmentshouldfixsetting';
1437                         }
1439                     } else {
1440                         if ($environment_result->getLevel() == 'required') {
1441                             $stringtouse = 'environmentrequireinstall';
1442                         } else {
1443                             $stringtouse = 'environmentrecommendinstall';
1444                         }
1445                     }
1447                     // Calculate the status value
1448                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1449                         $status = get_string('bypassed');
1450                         $warningline = true;
1451                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1452                         $status = get_string('restricted');
1453                         $errorline = true;
1454                     } else {
1455                         if ($status) {                                          //Handle ok result (ok)
1456                             $status = get_string('ok');
1457                         } else {
1458                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1459                                 $status = get_string('check');
1460                                 $warningline = true;
1461                             } else {                                            //Handle error result (error)
1462                                 $status = get_string('check');
1463                                 $errorline = true;
1464                             }
1465                         }
1466                     }
1467                 }
1469                 // Build the text
1470                 $linkparts = array();
1471                 $linkparts[] = 'admin/environment';
1472                 $linkparts[] = $type;
1473                 if (!empty($info)){
1474                    $linkparts[] = $info;
1475                 }
1476                 if (empty($CFG->docroot)) {
1477                     $report = get_string($stringtouse, 'admin', $rec);
1478                 } else {
1479                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec));
1480                 }
1482                 // Format error or warning line
1483                 if ($errorline || $warningline) {
1484                     $messagetype = $errorline? 'error':'warn';
1485                 } else {
1486                     $messagetype = 'ok';
1487                 }
1488                 $status = '<span class="'.$messagetype.'">'.$status.'</span>';
1489                 // Here we'll store all the feedback found
1490                 $feedbacktext = '';
1491                 // Append the feedback if there is some
1492                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
1493                 //Append the bypass if there is some
1494                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
1495                 //Append the restrict if there is some
1496                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
1498                 $report .= $feedbacktext;
1500                 // Add the row to the table
1501                 if ($environment_result->getPart() == 'custom_check'){
1502                     $otherdata[$messagetype][] = array ($info, $report, $status);
1503                 } else {
1504                     $serverdata[$messagetype][] = array ($type, $info, $report, $status);
1505                 }
1506             }
1507         }
1509         //put errors first in
1510         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
1511         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
1513         // Print table
1514         $output = '';
1515         $output .= $this->heading(get_string('serverchecks', 'admin'));
1516         $output .= html_writer::table($servertable);
1517         if (count($othertable->data)){
1518             $output .= $this->heading(get_string('customcheck', 'admin'));
1519             $output .= html_writer::table($othertable);
1520         }
1522         // Finally, if any error has happened, print the summary box
1523         if (!$result) {
1524             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
1525         }
1527         return $output;
1528     }