dc6172517cb8b4bcbfbab02338df020734387269
[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($this->page->url, array(
47             '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 .= format_text(get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading')), FORMAT_MARKDOWN);
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($this->page->url, 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($this->page->url, array(
104                 'agreelicense' => 1, 'confirmrelease' => 1, 'lang' => $CFG->lang)));
105         }
107         $output .= $this->footer();
108         return $output;
109     }
111     /**
112      * Displays the list of plugins with unsatisfied dependencies
113      *
114      * @param double|string|int $version Moodle on-disk version
115      * @param array $failed list of plugins with unsatisfied dependecies
116      * @param moodle_url $reloadurl URL of the page to recheck the dependencies
117      * @return string HTML
118      */
119     public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
120         $output = '';
122         $output .= $this->header();
123         $output .= $this->heading(get_string('pluginscheck', 'admin'));
124         $output .= $this->warning(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
125         $output .= $this->plugins_check_table(core_plugin_manager::instance(), $version, array('xdep' => true));
126         $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
127         $output .= $this->continue_button($reloadurl);
129         $output .= $this->footer();
131         return $output;
132     }
134     /**
135      * Display the 'You are about to upgrade Moodle' page. The first page
136      * during upgrade.
137      * @param string $strnewversion
138      * @param int $maturity
139      * @param string $testsite
140      * @return string HTML to output.
141      */
142     public function upgrade_confirm_page($strnewversion, $maturity, $testsite) {
143         $output = '';
145         $continueurl = new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0));
146         $continue = new single_button($continueurl, get_string('continue'), 'get');
147         $cancelurl = new moodle_url('/admin/index.php');
149         $output .= $this->header();
150         $output .= $this->maturity_warning($maturity);
151         $output .= $this->test_site_warning($testsite);
152         $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continue, $cancelurl);
153         $output .= $this->footer();
155         return $output;
156     }
158     /**
159      * Display the environment page during the upgrade process.
160      * @param string $release
161      * @param boolean $envstatus final result of env check (true/false)
162      * @param array $environment_results array of results gathered
163      * @return string HTML to output.
164      */
165     public function upgrade_environment_page($release, $envstatus, $environment_results) {
166         global $CFG;
167         $output = '';
169         $output .= $this->header();
170         $output .= $this->heading("Moodle $release");
171         $output .= $this->release_notes_link();
172         $output .= $this->environment_check_table($envstatus, $environment_results);
174         if (!$envstatus) {
175             $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0)));
177         } else {
178             $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
180             if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
181                 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
182             }
184             $output .= $this->continue_button(new moodle_url($this->page->url, array(
185                 'confirmupgrade' => 1, 'confirmrelease' => 1, 'cache' => 0)));
186         }
188         $output .= $this->footer();
190         return $output;
191     }
193     /**
194      * Display the upgrade page that lists all the plugins that require attention.
195      * @param core_plugin_manager $pluginman provides information about the plugins.
196      * @param \core\update\checker $checker provides information about available updates.
197      * @param int $version the version of the Moodle code from version.php.
198      * @param bool $showallplugins
199      * @param moodle_url $reloadurl
200      * @param moodle_url $continueurl
201      * @return string HTML to output.
202      */
203     public function upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,
204             $version, $showallplugins, $reloadurl, $continueurl) {
206         $output = '';
208         $output .= $this->header();
209         $output .= $this->box_start('generalbox', 'plugins-check-page');
210         $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'), array('class' => 'page-description'));
212         if ($checker->enabled()) {
213             $output .= $this->container_start('checkforupdates');
214             $output .= $this->single_button(
215                 new moodle_url($reloadurl, array('fetchupdates' => 1)),
216                 get_string('checkforupdates', 'core_plugin')
217             );
218             if ($timefetched = $checker->get_last_timefetched()) {
219                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
220                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
221             }
222             $output .= $this->container_end();
223         }
225         $output .= $this->missing_dependencies($pluginman);
226         $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
227         $output .= $this->box_end();
228         $output .= $this->upgrade_reload($reloadurl);
230         if ($pluginman->some_plugins_updatable()) {
231             $output .= $this->container_start('upgradepluginsinfo');
232             $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
233             $output .= $this->container_end();
234         }
236         $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
237         $button->class = 'continuebutton';
238         $output .= $this->render($button);
239         $output .= $this->footer();
241         return $output;
242     }
244     /**
245      * Prints a page with a summary of plugin deployment to be confirmed.
246      *
247      * @param \core\update\deployer $deployer
248      * @param array $data deployer's data package as returned by {@link \core\update\deployer::submitted_data()}
249      * @return string
250      */
251     public function upgrade_plugin_confirm_deploy_page(\core\update\deployer $deployer, array $data) {
253         if (!$deployer->initialized()) {
254             throw new coding_exception('Unable to render a page for non-initialized deployer.');
255         }
257         if (empty($data['updateinfo'])) {
258             throw new coding_exception('Missing required data component.');
259         }
261         $updateinfo = $data['updateinfo'];
263         $output  = '';
264         $output .= $this->header();
265         $output .= $this->container_start('generalbox updateplugin', 'notice');
267         $a = new stdClass();
268         if (get_string_manager()->string_exists('pluginname', $updateinfo->component)) {
269             $a->name = get_string('pluginname', $updateinfo->component);
270         } else {
271             $a->name = $updateinfo->component;
272         }
274         if (isset($updateinfo->release)) {
275             $a->version = $updateinfo->release . ' (' . $updateinfo->version . ')';
276         } else {
277             $a->version = $updateinfo->version;
278         }
279         $a->url = $updateinfo->download;
281         $output .= $this->output->heading(get_string('updatepluginconfirm', 'core_plugin'));
282         $output .= $this->output->container(format_text(get_string('updatepluginconfirminfo', 'core_plugin', $a)), 'updatepluginconfirminfo');
283         $output .= $this->output->container(get_string('updatepluginconfirmwarning', 'core_plugin', 'updatepluginconfirmwarning'));
285         if ($repotype = $deployer->plugin_external_source($data['updateinfo'])) {
286             $output .= $this->output->container(get_string('updatepluginconfirmexternal', 'core_plugin', $repotype), 'updatepluginconfirmexternal');
287         }
289         $widget = $deployer->make_execution_widget($data['updateinfo'], $data['returnurl']);
290         $output .= $this->output->render($widget);
292         $output .= $this->output->single_button($data['callerurl'], get_string('cancel', 'core'), 'get');
294         $output .= $this->container_end();
295         $output .= $this->footer();
297         return $output;
298     }
300     /**
301      * Display the admin notifications page.
302      * @param int $maturity
303      * @param bool $insecuredataroot warn dataroot is invalid
304      * @param bool $errorsdisplayed warn invalid dispaly error setting
305      * @param bool $cronoverdue warn cron not running
306      * @param bool $dbproblems warn db has problems
307      * @param bool $maintenancemode warn in maintenance mode
308      * @param bool $buggyiconvnomb warn iconv problems
309      * @param array|null $availableupdates array of \core\update\info objects or null
310      * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
311      * @param string[] $cachewarnings An array containing warnings from the Cache API.
312      *
313      * @return string HTML to output.
314      */
315     public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
316             $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
317             $buggyiconvnomb, $registered, array $cachewarnings = array()) {
318         global $CFG;
319         $output = '';
321         $output .= $this->header();
322         $output .= $this->maturity_info($maturity);
323         $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
324         $output .= $this->insecure_dataroot_warning($insecuredataroot);
325         $output .= $this->display_errors_warning($errorsdisplayed);
326         $output .= $this->buggy_iconv_warning($buggyiconvnomb);
327         $output .= $this->cron_overdue_warning($cronoverdue);
328         $output .= $this->db_problems($dbproblems);
329         $output .= $this->maintenance_mode_warning($maintenancemode);
330         $output .= $this->cache_warnings($cachewarnings);
331         $output .= $this->registration_warning($registered);
333         //////////////////////////////////////////////////////////////////////////////////////////////////
334         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
335         $output .= $this->moodle_copyright();
336         //////////////////////////////////////////////////////////////////////////////////////////////////
338         $output .= $this->footer();
340         return $output;
341     }
343     /**
344      * Display the plugin management page (admin/plugins.php).
345      *
346      * The filtering options array may contain following items:
347      *  bool contribonly - show only contributed extensions
348      *  bool updatesonly - show only plugins with an available update
349      *
350      * @param core_plugin_manager $pluginman
351      * @param \core\update\checker $checker
352      * @param array $options filtering options
353      * @return string HTML to output.
354      */
355     public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
357         $output = '';
359         $output .= $this->header();
360         $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
361         $output .= $this->plugins_overview_panel($pluginman, $options);
363         if ($checker->enabled()) {
364             $output .= $this->container_start('checkforupdates');
365             $output .= $this->single_button(
366                 new moodle_url($this->page->url, array_merge($options, array('fetchremote' => 1))),
367                 get_string('checkforupdates', 'core_plugin')
368             );
369             if ($timefetched = $checker->get_last_timefetched()) {
370                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin',
371                     userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'))));
372             }
373             $output .= $this->container_end();
374         }
376         $output .= $this->box($this->plugins_control_panel($pluginman, $options), 'generalbox');
377         $output .= $this->footer();
379         return $output;
380     }
382     /**
383      * Display a page to confirm the plugin uninstallation.
384      *
385      * @param core_plugin_manager $pluginman
386      * @param \core\plugininfo\base $pluginfo
387      * @param moodle_url $continueurl URL to continue after confirmation
388      * @param moodle_url $cancelurl URL to to go if cancelled
389      * @return string
390      */
391     public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
392         $output = '';
394         $pluginname = $pluginman->plugin_name($pluginfo->component);
396         $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
397         if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
398             $confirm .= $extraconfirm;
399         }
401         $output .= $this->output->header();
402         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
403         $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
404         $output .= $this->output->footer();
406         return $output;
407     }
409     /**
410      * Display a page with results of plugin uninstallation and offer removal of plugin files.
411      *
412      * @param core_plugin_manager $pluginman
413      * @param \core\plugininfo\base $pluginfo
414      * @param progress_trace_buffer $progress
415      * @param moodle_url $continueurl URL to continue to remove the plugin folder
416      * @return string
417      */
418     public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
419                                                             progress_trace_buffer $progress, moodle_url $continueurl) {
420         $output = '';
422         $pluginname = $pluginman->plugin_name($pluginfo->component);
424         // Do not show navigation here, they must click one of the buttons.
425         $this->page->set_pagelayout('maintenance');
426         $this->page->set_cacheable(false);
428         $output .= $this->output->header();
429         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
431         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
433         $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
434             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
436         if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
437             $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
438                 'uninstalldeleteconfirmexternal');
439         }
441         // After any uninstall we must execute full upgrade to finish the cleanup!
442         $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
443         $output .= $this->output->footer();
445         return $output;
446     }
448     /**
449      * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
450      *
451      * @param core_plugin_manager $pluginman
452      * @param \core\plugininfo\base $pluginfo
453      * @param progress_trace_buffer $progress
454      * @return string
455      */
456     public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
457         $output = '';
459         $pluginname = $pluginfo->component;
461         $output .= $this->output->header();
462         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
464         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
466         $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
467             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
468         $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
469         $output .= $this->output->footer();
471         return $output;
472     }
474     /**
475      * Display the plugin management page (admin/environment.php).
476      * @param array $versions
477      * @param string $version
478      * @param boolean $envstatus final result of env check (true/false)
479      * @param array $environment_results array of results gathered
480      * @return string HTML to output.
481      */
482     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
483         $output = '';
484         $output .= $this->header();
486         // Print the component download link
487         $output .= html_writer::tag('div', html_writer::link(
488                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
489                     get_string('updatecomponent', 'admin')),
490                 array('class' => 'reportlink'));
492         // Heading.
493         $output .= $this->heading(get_string('environment', 'admin'));
495         // Box with info and a menu to choose the version.
496         $output .= $this->box_start();
497         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
498         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
499         $select->label = get_string('moodleversion');
500         $output .= $this->render($select);
501         $output .= $this->box_end();
503         // The results
504         $output .= $this->environment_check_table($envstatus, $environment_results);
506         $output .= $this->footer();
507         return $output;
508     }
510     /**
511      * Output a warning message, of the type that appears on the admin notifications page.
512      * @param string $message the message to display.
513      * @param string $type type class
514      * @return string HTML to output.
515      */
516     protected function warning($message, $type = 'warning') {
517         return $this->box($message, 'generalbox admin' . $type);
518     }
520     /**
521      * Render an appropriate message if dataroot is insecure.
522      * @param bool $insecuredataroot
523      * @return string HTML to output.
524      */
525     protected function insecure_dataroot_warning($insecuredataroot) {
526         global $CFG;
528         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
529             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
531         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
532             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
534         } else {
535             return '';
536         }
537     }
539     /**
540      * Render an appropriate message if dataroot is insecure.
541      * @param bool $errorsdisplayed
542      * @return string HTML to output.
543      */
544     protected function display_errors_warning($errorsdisplayed) {
545         if (!$errorsdisplayed) {
546             return '';
547         }
549         return $this->warning(get_string('displayerrorswarning', 'admin'));
550     }
552     /**
553      * Render an appropriate message if iconv is buggy and mbstring missing.
554      * @param bool $buggyiconvnomb
555      * @return string HTML to output.
556      */
557     protected function buggy_iconv_warning($buggyiconvnomb) {
558         if (!$buggyiconvnomb) {
559             return '';
560         }
562         return $this->warning(get_string('warningiconvbuggy', 'admin'));
563     }
565     /**
566      * Render an appropriate message if cron has not been run recently.
567      * @param bool $cronoverdue
568      * @return string HTML to output.
569      */
570     public function cron_overdue_warning($cronoverdue) {
571         global $CFG;
572         if (!$cronoverdue) {
573             return '';
574         }
576         if (empty($CFG->cronclionly)) {
577             $url = new moodle_url('/admin/cron.php');
578             if (!empty($CFG->cronremotepassword)) {
579                 $url = new moodle_url('/admin/cron.php', array('password' => $CFG->cronremotepassword));
580             }
582             return $this->warning(get_string('cronwarning', 'admin', $url->out()) . '&nbsp;' .
583                     $this->help_icon('cron', 'admin'));
584         }
586         // $CFG->cronclionly is not empty: cron can run only from CLI.
587         return $this->warning(get_string('cronwarningcli', 'admin') . '&nbsp;' .
588                 $this->help_icon('cron', 'admin'));
589     }
591     /**
592      * Render an appropriate message if there are any problems with the DB set-up.
593      * @param bool $dbproblems
594      * @return string HTML to output.
595      */
596     public function db_problems($dbproblems) {
597         if (!$dbproblems) {
598             return '';
599         }
601         return $this->warning($dbproblems);
602     }
604     /**
605      * Renders cache warnings if there are any.
606      *
607      * @param string[] $cachewarnings
608      * @return string
609      */
610     public function cache_warnings(array $cachewarnings) {
611         if (!count($cachewarnings)) {
612             return '';
613         }
614         return join("\n", array_map(array($this, 'warning'), $cachewarnings));
615     }
617     /**
618      * Render an appropriate message if the site in in maintenance mode.
619      * @param bool $maintenancemode
620      * @return string HTML to output.
621      */
622     public function maintenance_mode_warning($maintenancemode) {
623         if (!$maintenancemode) {
624             return '';
625         }
627         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
628         $url = $url->out(); // get_string() does not support objects in params
630         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
631     }
633     /**
634      * Display a warning about installing development code if necesary.
635      * @param int $maturity
636      * @return string HTML to output.
637      */
638     protected function maturity_warning($maturity) {
639         if ($maturity == MATURITY_STABLE) {
640             return ''; // No worries.
641         }
643         $maturitylevel = get_string('maturity' . $maturity, 'admin');
644         return $this->warning(
645                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
646                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
647                 'error');
648     }
650     /*
651      * If necessary, displays a warning about upgrading a test site.
652      *
653      * @param string $testsite
654      * @return string HTML
655      */
656     protected function test_site_warning($testsite) {
658         if (!$testsite) {
659             return '';
660         }
662         $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
663         return $this->warning($warning, 'error');
664     }
666     /**
667      * Output the copyright notice.
668      * @return string HTML to output.
669      */
670     protected function moodle_copyright() {
671         global $CFG;
673         //////////////////////////////////////////////////////////////////////////////////////////////////
674         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
675         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
676                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
677                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
678                          'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
679                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
680         //////////////////////////////////////////////////////////////////////////////////////////////////
682         return $this->box($copyrighttext, 'copyright');
683     }
685     /**
686      * Display a warning about installing development code if necesary.
687      * @param int $maturity
688      * @return string HTML to output.
689      */
690     protected function maturity_info($maturity) {
691         if ($maturity == MATURITY_STABLE) {
692             return ''; // No worries.
693         }
695         $level = 'warning';
697         if ($maturity == MATURITY_ALPHA) {
698             $level = 'error';
699         }
701         $maturitylevel = get_string('maturity' . $maturity, 'admin');
702         $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
703         $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
704         return $this->warning($warningtext, $level);
705     }
707     /**
708      * Displays the info about available Moodle core and plugin updates
709      *
710      * The structure of the $updates param has changed since 2.4. It contains not only updates
711      * for the core itself, but also for all other installed plugins.
712      *
713      * @param array|null $updates array of (string)component => array of \core\update\info objects or null
714      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
715      * @return string
716      */
717     protected function available_updates($updates, $fetch) {
719         $updateinfo = '';
720         $someupdateavailable = false;
721         if (is_array($updates)) {
722             if (is_array($updates['core'])) {
723                 $someupdateavailable = true;
724                 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
725                 foreach ($updates['core'] as $update) {
726                     $updateinfo .= $this->moodle_available_update_info($update);
727                 }
728                 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
729                     array('class' => 'updateavailablerecommendation'));
730             }
731             unset($updates['core']);
732             // If something has left in the $updates array now, it is updates for plugins.
733             if (!empty($updates)) {
734                 $someupdateavailable = true;
735                 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
736                 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
737                 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
738                     array('url' => $pluginsoverviewurl->out())));
739             }
740         }
742         if (!$someupdateavailable) {
743             $now = time();
744             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
745                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
746             }
747         }
749         $updateinfo .= $this->container_start('checkforupdates');
750         $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
751         $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
752         if ($fetch) {
753             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
754                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
755         }
756         $updateinfo .= $this->container_end();
758         return $this->warning($updateinfo);
759     }
761     /**
762      * Display a warning about not being registered on Moodle.org if necesary.
763      *
764      * @param boolean $registered true if the site is registered on Moodle.org
765      * @return string HTML to output.
766      */
767     protected function registration_warning($registered) {
769         if (!$registered) {
771             $registerbutton = $this->single_button(new moodle_url('/admin/registration/register.php',
772                     array('huburl' =>  HUB_MOODLEORGHUBURL, 'hubname' => 'Moodle.org')),
773                     get_string('register', 'admin'));
775             return $this->warning( get_string('registrationwarning', 'admin')
776                     . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton );
777         }
779         return '';
780     }
782     /**
783      * Helper method to render the information about the available Moodle update
784      *
785      * @param \core\update\info $updateinfo information about the available Moodle core update
786      */
787     protected function moodle_available_update_info(\core\update\info $updateinfo) {
789         $boxclasses = 'moodleupdateinfo';
790         $info = array();
792         if (isset($updateinfo->release)) {
793             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
794                 array('class' => 'info release'));
795         }
797         if (isset($updateinfo->version)) {
798             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
799                 array('class' => 'info version'));
800         }
802         if (isset($updateinfo->maturity)) {
803             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
804                 array('class' => 'info maturity'));
805             $boxclasses .= ' maturity'.$updateinfo->maturity;
806         }
808         if (isset($updateinfo->download)) {
809             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
810         }
812         if (isset($updateinfo->url)) {
813             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
814                 array('class' => 'info more'));
815         }
817         $box  = $this->output->box_start($boxclasses);
818         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
819         $box .= $this->output->box_end();
821         return $box;
822     }
824     /**
825      * Display a link to the release notes.
826      * @return string HTML to output.
827      */
828     protected function release_notes_link() {
829         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
830         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
831         return $this->box($releasenoteslink, 'generalbox releasenoteslink');
832     }
834     /**
835      * Display the reload link that appears on several upgrade/install pages.
836      * @return string HTML to output.
837      */
838     function upgrade_reload($url) {
839         return html_writer::empty_tag('br') .
840                 html_writer::tag('div',
841                     html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
842                             get_string('reload'), array('title' => get_string('reload'))),
843                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
844     }
846     /**
847      * Displays all known plugins and information about their installation or upgrade
848      *
849      * This default implementation renders all plugins into one big table. The rendering
850      * options support:
851      *     (bool)full = false: whether to display up-to-date plugins, too
852      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
853      *
854      * @param core_plugin_manager $pluginman provides information about the plugins.
855      * @param int $version the version of the Moodle code from version.php.
856      * @param array $options rendering options
857      * @return string HTML code
858      */
859     public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
861         $plugininfo = $pluginman->get_plugins();
863         if (empty($plugininfo)) {
864             return '';
865         }
867         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
868         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
870         $table = new html_table();
871         $table->id = 'plugins-check';
872         $table->head = array(
873             get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
874             get_string('versiondb', 'core_plugin'),
875             get_string('versiondisk', 'core_plugin'),
876             get_string('requires', 'core_plugin'),
877             get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
878         );
879         $table->colclasses = array(
880             'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
881         );
882         $table->data = array();
884         // Number of displayed plugins per type.
885         $numdisplayed = array();
886         // Number of plugins known to the plugin manager.
887         $sumtotal = 0;
888         // Number of plugins requiring attention.
889         $sumattention = 0;
890         // List of all components we can cancel installation of.
891         $installabortable = array();
893         foreach ($plugininfo as $type => $plugins) {
895             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
896             $header->header = true;
897             $header->colspan = count($table->head);
898             $header = new html_table_row(array($header));
899             $header->attributes['class'] = 'plugintypeheader type-' . $type;
901             $numdisplayed[$type] = 0;
903             if (empty($plugins) and $options['full']) {
904                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
905                 $msg->colspan = count($table->head);
906                 $row = new html_table_row(array($msg));
907                 $row->attributes['class'] .= 'msg msg-noneinstalled';
908                 $table->data[] = $header;
909                 $table->data[] = $row;
910                 continue;
911             }
913             $plugintyperows = array();
915             foreach ($plugins as $name => $plugin) {
916                 $sumtotal++;
917                 $row = new html_table_row();
918                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
920                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
921                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
922                 } else {
923                     $icon = '';
924                 }
926                 $displayname = new html_table_cell(
927                     $icon.
928                     html_writer::span($plugin->displayname, 'pluginname').
929                     html_writer::div($plugin->get_dir(), 'plugindir')
930                 );
932                 $versiondb = new html_table_cell($plugin->versiondb);
933                 $versiondisk = new html_table_cell($plugin->versiondisk);
935                 if ($isstandard = $plugin->is_standard()) {
936                     $row->attributes['class'] .= ' standard';
937                     $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext label');
938                 } else {
939                     $row->attributes['class'] .= ' extension';
940                     $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext label label-info');
941                 }
943                 $coredependency = $plugin->is_core_dependency_satisfied($version);
944                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
945                 $dependenciesok = $coredependency && $otherpluginsdependencies;
947                 $statuscode = $plugin->get_status();
948                 $row->attributes['class'] .= ' status-' . $statuscode;
949                 $statusclass = 'statustext label ';
950                 switch ($statuscode) {
951                     case core_plugin_manager::PLUGIN_STATUS_NEW:
952                         $statusclass .= $dependenciesok ? 'label-success' : 'label-warning';
953                         break;
954                     case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
955                         $statusclass .= $dependenciesok ? 'label-info' : 'label-warning';
956                         break;
957                     case core_plugin_manager::PLUGIN_STATUS_MISSING:
958                     case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
959                     case core_plugin_manager::PLUGIN_STATUS_DELETE:
960                         $statusclass .= 'label-important';
961                         break;
962                     case core_plugin_manager::PLUGIN_STATUS_NODB:
963                     case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
964                         $statusclass .= $dependenciesok ? '' : 'label-warning';
965                         break;
966                 }
967                 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
969                 if ($statuscode == core_plugin_manager::PLUGIN_STATUS_NEW and !$plugin->is_standard()) {
970                     if ($pluginman->is_plugin_folder_removable($plugin->component)) {
971                         $installabortable[] = $plugin->component;
972                         $status .= $this->output->single_button(
973                             new moodle_url($this->page->url, array('abortinstall' => $plugin->component)),
974                             get_string('cancelinstallone', 'core_plugin'),
975                             'post',
976                             array('class' => 'actionbutton')
977                         );
978                     }
979                 }
981                 $availableupdates = $plugin->available_updates();
982                 if (!empty($availableupdates)) {
983                     foreach ($availableupdates as $availableupdate) {
984                         $status .= $this->plugin_available_update_info($availableupdate);
985                     }
986                 }
988                 $status = new html_table_cell($sourcelabel.' '.$status);
990                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
992                 $statusisboring = in_array($statuscode, array(
993                         core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
995                 if ($options['xdep']) {
996                     // we want to see only plugins with failed dependencies
997                     if ($dependenciesok) {
998                         continue;
999                     }
1001                 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1002                     // no change is going to happen to the plugin - display it only
1003                     // if the user wants to see the full list
1004                     if (empty($options['full'])) {
1005                         continue;
1006                     }
1008                 } else {
1009                     $sumattention++;
1010                 }
1012                 // The plugin should be displayed.
1013                 $numdisplayed[$type]++;
1014                 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1015                 $plugintyperows[] = $row;
1016             }
1018             if (empty($numdisplayed[$type]) and empty($options['full'])) {
1019                 continue;
1020             }
1022             $table->data[] = $header;
1023             $table->data = array_merge($table->data, $plugintyperows);
1024         }
1026         // Total number of displayed plugins.
1027         $sumdisplayed = array_sum($numdisplayed);
1029         if ($options['xdep']) {
1030             // At the plugins dependencies check page, display the table only.
1031             return html_writer::table($table);
1032         }
1034         $out = $this->output->container_start('', 'plugins-check-info');
1036         if ($sumdisplayed == 0) {
1037             $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1039         } else {
1040             if (empty($options['full'])) {
1041                 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1042             } else {
1043                 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1044             }
1045         }
1047         $out .= $this->output->container_start('actions');
1048         if ($installabortable) {
1049             $out .= $this->output->single_button(
1050                 new moodle_url($this->page->url, array('abortinstallx' => 1)),
1051                 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1052                 'post',
1053                 array('class' => 'singlebutton cancelinstallall')
1054             );
1055         }
1057         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1058             get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge'));
1060         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1061             get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge'));
1063         $out .= $this->output->container_end(); // .actions
1064         $out .= $this->output->container_end(); // #plugins-check-info
1066         if ($sumdisplayed > 0 or $options['full']) {
1067             $out .= html_writer::table($table);
1068         }
1070         return $out;
1071     }
1073     /**
1074      * Displays the information about missing dependencies
1075      *
1076      * @param core_plugin_manager $pluginman
1077      * @return string
1078      */
1079     protected function missing_dependencies(core_plugin_manager $pluginman) {
1081         $dependencies = $pluginman->missing_dependencies();
1083         if (empty($dependencies)) {
1084             return '';
1085         }
1087         $available = array();
1088         $unavailable = array();
1089         $unknown = array();
1091         foreach ($dependencies as $component => $remoteinfo) {
1092             if ($remoteinfo === false) {
1093                 // The required version is not available. Let us check if there
1094                 // is at least some version in the plugins directory.
1095                 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1096                 if ($remoteinfoanyversion === false) {
1097                     $unknown[$component] = $component;
1098                 } else {
1099                     $unavailable[$component] = $remoteinfoanyversion;
1100                 }
1101             } else {
1102                 $available[$component] = $remoteinfo;
1103             }
1104         }
1106         $out  = $this->output->container_start('plugins-check-dependencies');
1108         if ($unavailable or $unknown) {
1109             $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1110             if ($unknown) {
1111                 $out .= $this->output->notification(get_string('misdepsunknownlist', 'core_plugin', implode($unknown, ', ')));
1112             }
1113             if ($unavailable) {
1114                 $unavailablelist = array();
1115                 foreach ($unavailable as $component => $remoteinfoanyversion) {
1116                     $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1117                         '<strong>'.$remoteinfoanyversion->name.'</strong>');
1118                     if ($remoteinfoanyversion->version) {
1119                         $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1120                     } else {
1121                         $unavailablelistitem .= ' ('.$component.')';
1122                     }
1123                     $unavailablelist[] = $unavailablelistitem;
1124                 }
1125                 $out .= $this->output->notification(get_string('misdepsunavaillist', 'core_plugin',
1126                     implode($unavailablelist, ', ')));
1127             }
1128             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1129             $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1130                 get_string('dependencyuploadmissing', 'core_plugin'));
1131             $out .= $this->output->container_end(); // .plugins-check-dependencies-actions
1132         }
1134         if ($available) {
1135             $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
1136             $installable = array();
1137             foreach ($available as $component => $remoteinfo) {
1138                 if ($pluginman->is_remote_plugin_installable($component, $remoteinfo->version->version)) {
1139                     $installable[$component] = $remoteinfo;
1140                 }
1141             }
1143             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1145             if ($installable) {
1146                 $out .= $this->output->single_button(
1147                     new moodle_url($this->page->url, array('installdepx' => 1)),
1148                     get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1149                     'post',
1150                     array('class' => 'singlebutton dependencyinstallmissing')
1151                 );
1152             }
1154             $out.= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1155                 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1157             $out .= $this->output->container_end(); // .plugins-check-dependencies-actions
1159             $out .= $this->available_missing_dependencies_list($pluginman, $available);
1160         }
1162         $out .= $this->output->container_end(); // .plugins-check-dependencies
1164         return $out;
1165     }
1167     /**
1168      * Displays the list if available missing dependencies.
1169      *
1170      * @param core_plugin_manager $pluginman
1171      * @param array $dependencies
1172      * @return string
1173      */
1174     protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1175         global $CFG;
1177         $table = new html_table();
1178         $table->id = 'plugins-check-available-dependencies';
1179         $table->head = array(
1180             get_string('displayname', 'core_plugin'),
1181             get_string('release', 'core_plugin'),
1182             get_string('version', 'core_plugin'),
1183             get_string('supportedmoodleversions', 'core_plugin'),
1184             get_string('info', 'core'),
1185         );
1186         $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1187         $table->data = array();
1189         foreach ($dependencies as $plugin) {
1191             $supportedmoodles = array();
1192             foreach ($plugin->version->supportedmoodles as $moodle) {
1193                 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1194                     $supportedmoodles[] = html_writer::span($moodle->release, 'label label-success');
1195                 } else {
1196                     $supportedmoodles[] = html_writer::span($moodle->release, 'label');
1197                 }
1198             }
1200             $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1201             if ($requriedby) {
1202                 foreach ($requriedby as $ix => $val) {
1203                     $inf = $pluginman->get_plugin_info($val);
1204                     if ($inf) {
1205                         $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1206                     }
1207                 }
1208                 $info = html_writer::div(
1209                     get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1210                     'requiredby'
1211                 );
1212             } else {
1213                 $info = '';
1214             }
1216             $info .= $this->output->container_start('actions');
1218             $info .= html_writer::div(
1219                 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1220                     get_string('misdepinfoplugin', 'core_plugin')),
1221                 'misdepinfoplugin'
1222             );
1224             $info .= html_writer::div(
1225                 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1226                     get_string('misdepinfoversion', 'core_plugin')),
1227                 'misdepinfoversion'
1228             );
1230             $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')), 'misdepdownload');
1232             if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1233                 $info .= $this->output->single_button(
1234                     new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1235                     get_string('dependencyinstall', 'core_plugin'),
1236                     'post',
1237                     array('class' => 'singlebutton dependencyinstall')
1238                 );
1239             } else {
1240                 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1241                 if ($reasonhelp) {
1242                     $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall');
1243                 }
1244             }
1246             $info .= $this->output->container_end(); // .actions
1248             $table->data[] = array(
1249                 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component'),
1250                 $plugin->version->release,
1251                 $plugin->version->version,
1252                 implode($supportedmoodles, ' '),
1253                 $info
1254             );
1255         }
1257         return html_writer::table($table);
1258     }
1260     /**
1261      * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1262      *
1263      * @param string $reason the reason code as returned by the plugin manager
1264      * @return string
1265      */
1266     protected function info_remote_plugin_not_installable($reason) {
1268         if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1269             return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1270         }
1272         if ($reason === 'remoteunavailable') {
1273             return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1274         }
1276         return false;
1277     }
1279     /**
1280      * Formats the information that needs to go in the 'Requires' column.
1281      * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1282      * @param core_plugin_manager $pluginman provides data on all the plugins.
1283      * @param string $version
1284      * @return string HTML code
1285      */
1286     protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) {
1288         $requires = array();
1289         $displayuploadlink = false;
1290         $displayupdateslink = false;
1292         foreach ($pluginman->resolve_requirements($plugin, $version) as $reqname => $reqinfo) {
1293             if ($reqname === 'core') {
1294                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1295                     $class = 'requires-ok';
1296                     $label = '';
1297                 } else {
1298                     $class = 'requires-failed';
1299                     $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'label label-important');
1300                 }
1301                 $requires[] = html_writer::tag('li',
1302                     html_writer::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires), 'dep dep-core').
1303                     ' '.$label, array('class' => $class));
1305             } else {
1306                 $actions = array();
1308                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1309                     $label = '';
1310                     $class = 'requires-ok';
1312                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1313                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1314                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'label label-warning');
1315                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'label label-warning');
1316                         $class = 'requires-failed requires-missing requires-available';
1317                         $actions[] = html_writer::link(
1318                             new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1319                             get_string('misdepinfoplugin', 'core_plugin')
1320                         );
1322                     } else {
1323                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'label label-important');
1324                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1325                             'label label-important');
1326                         $class = 'requires-failed requires-missing requires-unavailable';
1327                     }
1328                     $displayuploadlink = true;
1330                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1331                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1332                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'label label-warning');
1333                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'label label-warning');
1334                         $class = 'requires-failed requires-outdated requires-available';
1335                         $displayupdateslink = true;
1337                     } else {
1338                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'label label-important');
1339                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1340                             'label label-important');
1341                         $class = 'requires-failed requires-outdated requires-unavailable';
1342                     }
1343                     $displayuploadlink = true;
1344                 }
1346                 if ($reqinfo->reqver != ANY_VERSION) {
1347                     $str = 'otherpluginversion';
1348                 } else {
1349                     $str = 'otherplugin';
1350                 }
1352                 $requires[] = html_writer::tag('li', html_writer::span(
1353                     get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1354                     'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1355                     array('class' => $class)
1356                 );
1357             }
1358         }
1360         if (!$requires) {
1361             return '';
1362         }
1364         $out = html_writer::tag('ul', implode("\n", $requires));
1366         if ($displayuploadlink) {
1367             $out .= html_writer::div(
1368                 html_writer::link(
1369                     new moodle_url('/admin/tool/installaddon/'),
1370                     get_string('dependencyuploadmissing', 'core_plugin')
1371                 ),
1372                 'dependencyuploadmissing'
1373             );
1374         }
1376         if ($displayupdateslink) {
1377             $out .= html_writer::div(
1378                 html_writer::link(
1379                     new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1380                     get_string('checkforupdates', 'core_plugin')
1381                 ),
1382                 'checkforupdates'
1383             );
1384         }
1386         return $out;
1388     }
1390     /**
1391      * Prints an overview about the plugins - number of installed, number of extensions etc.
1392      *
1393      * @param core_plugin_manager $pluginman provides information about the plugins
1394      * @param array $options filtering options
1395      * @return string as usually
1396      */
1397     public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1399         $plugininfo = $pluginman->get_plugins();
1401         $numtotal = $numdisabled = $numextension = $numupdatable = 0;
1403         foreach ($plugininfo as $type => $plugins) {
1404             foreach ($plugins as $name => $plugin) {
1405                 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1406                     continue;
1407                 }
1408                 $numtotal++;
1409                 if ($plugin->is_enabled() === false) {
1410                     $numdisabled++;
1411                 }
1412                 if (!$plugin->is_standard()) {
1413                     $numextension++;
1414                 }
1415                 if ($plugin->available_updates()) {
1416                     $numupdatable++;
1417                 }
1418             }
1419         }
1421         $info = array();
1422         $filter = array();
1423         $somefilteractive = false;
1424         $info[] = html_writer::tag('span', get_string('numtotal', 'core_plugin', $numtotal), array('class' => 'info total'));
1425         $info[] = html_writer::tag('span', get_string('numdisabled', 'core_plugin', $numdisabled), array('class' => 'info disabled'));
1426         $info[] = html_writer::tag('span', get_string('numextension', 'core_plugin', $numextension), array('class' => 'info extension'));
1427         if ($numextension > 0) {
1428             if (empty($options['contribonly'])) {
1429                 $filter[] = html_writer::link(
1430                     new moodle_url($this->page->url, array('contribonly' => 1)),
1431                     get_string('filtercontribonly', 'core_plugin'),
1432                     array('class' => 'filter-item show-contribonly')
1433                 );
1434             } else {
1435                 $filter[] = html_writer::tag('span', get_string('filtercontribonlyactive', 'core_plugin'),
1436                     array('class' => 'filter-item active show-contribonly'));
1437                 $somefilteractive = true;
1438             }
1439         }
1440         if ($numupdatable > 0) {
1441             $info[] = html_writer::tag('span', get_string('numupdatable', 'core_plugin', $numupdatable), array('class' => 'info updatable'));
1442             if (empty($options['updatesonly'])) {
1443                 $filter[] = html_writer::link(
1444                     new moodle_url($this->page->url, array('updatesonly' => 1)),
1445                     get_string('filterupdatesonly', 'core_plugin'),
1446                     array('class' => 'filter-item show-updatesonly')
1447                 );
1448             } else {
1449                 $filter[] = html_writer::tag('span', get_string('filterupdatesonlyactive', 'core_plugin'),
1450                     array('class' => 'filter-item active show-updatesonly'));
1451                 $somefilteractive = true;
1452             }
1453         }
1454         if ($somefilteractive) {
1455             $filter[] = html_writer::link($this->page->url, get_string('filterall', 'core_plugin'), array('class' => 'filter-item show-all'));
1456         }
1458         $output  = $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '', 'plugins-overview-panel');
1460         if (!empty($filter)) {
1461             $output .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $filter), '', 'plugins-overview-filter');
1462         }
1464         return $output;
1465     }
1467     /**
1468      * Displays all known plugins and links to manage them
1469      *
1470      * This default implementation renders all plugins into one big table.
1471      *
1472      * @param core_plugin_manager $pluginman provides information about the plugins.
1473      * @param array $options filtering options
1474      * @return string HTML code
1475      */
1476     public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1478         $plugininfo = $pluginman->get_plugins();
1480         // Filter the list of plugins according the options.
1481         if (!empty($options['updatesonly'])) {
1482             $updateable = array();
1483             foreach ($plugininfo as $plugintype => $pluginnames) {
1484                 foreach ($pluginnames as $pluginname => $pluginfo) {
1485                     $pluginavailableupdates = $pluginfo->available_updates();
1486                     if (!empty($pluginavailableupdates)) {
1487                         foreach ($pluginavailableupdates as $pluginavailableupdate) {
1488                             $updateable[$plugintype][$pluginname] = $pluginfo;
1489                         }
1490                     }
1491                 }
1492             }
1493             $plugininfo = $updateable;
1494         }
1496         if (!empty($options['contribonly'])) {
1497             $contribs = array();
1498             foreach ($plugininfo as $plugintype => $pluginnames) {
1499                 foreach ($pluginnames as $pluginname => $pluginfo) {
1500                     if (!$pluginfo->is_standard()) {
1501                         $contribs[$plugintype][$pluginname] = $pluginfo;
1502                     }
1503                 }
1504             }
1505             $plugininfo = $contribs;
1506         }
1508         if (empty($plugininfo)) {
1509             return '';
1510         }
1512         $table = new html_table();
1513         $table->id = 'plugins-control-panel';
1514         $table->head = array(
1515             get_string('displayname', 'core_plugin'),
1516             get_string('source', 'core_plugin'),
1517             get_string('version', 'core_plugin'),
1518             get_string('release', 'core_plugin'),
1519             get_string('availability', 'core_plugin'),
1520             get_string('actions', 'core_plugin'),
1521             get_string('notes','core_plugin'),
1522         );
1523         $table->headspan = array(1, 1, 1, 1, 1, 2, 1);
1524         $table->colclasses = array(
1525             'pluginname', 'source', 'version', 'release', 'availability', 'settings', 'uninstall', 'notes'
1526         );
1528         foreach ($plugininfo as $type => $plugins) {
1529             $heading = $pluginman->plugintype_name_plural($type);
1530             $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1531             if ($manageurl = $pluginclass::get_manage_url()) {
1532                 $heading = html_writer::link($manageurl, $heading);
1533             }
1534             $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1535             $header->header = true;
1536             $header->colspan = array_sum($table->headspan);
1537             $header = new html_table_row(array($header));
1538             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1539             $table->data[] = $header;
1541             if (empty($plugins)) {
1542                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1543                 $msg->colspan = array_sum($table->headspan);
1544                 $row = new html_table_row(array($msg));
1545                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1546                 $table->data[] = $row;
1547                 continue;
1548             }
1550             foreach ($plugins as $name => $plugin) {
1551                 $row = new html_table_row();
1552                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1554                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name)) {
1555                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1556                 } else {
1557                     $icon = $this->output->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
1558                 }
1559                 $status = $plugin->get_status();
1560                 $row->attributes['class'] .= ' status-'.$status;
1561                 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1562                     $msg = html_writer::tag('span', get_string('status_missing', 'core_plugin'), array('class' => 'statusmsg'));
1563                 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1564                     $msg = html_writer::tag('span', get_string('status_new', 'core_plugin'), array('class' => 'statusmsg'));
1565                 } else {
1566                     $msg = '';
1567                 }
1568                 $pluginname  = html_writer::tag('div', $icon . '' . $plugin->displayname . ' ' . $msg, array('class' => 'displayname')).
1569                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1570                 $pluginname  = new html_table_cell($pluginname);
1572                 if ($plugin->is_standard()) {
1573                     $row->attributes['class'] .= ' standard';
1574                     $source = new html_table_cell(get_string('sourcestd', 'core_plugin'));
1575                 } else {
1576                     $row->attributes['class'] .= ' extension';
1577                     $source = new html_table_cell(get_string('sourceext', 'core_plugin'));
1578                 }
1580                 $version = new html_table_cell($plugin->versiondb);
1581                 $release = new html_table_cell($plugin->release);
1583                 $isenabled = $plugin->is_enabled();
1584                 if (is_null($isenabled)) {
1585                     $availability = new html_table_cell('');
1586                 } else if ($isenabled) {
1587                     $row->attributes['class'] .= ' enabled';
1588                     $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1589                 } else {
1590                     $row->attributes['class'] .= ' disabled';
1591                     $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1592                 }
1594                 $settingsurl = $plugin->get_settings_url();
1595                 if (!is_null($settingsurl)) {
1596                     $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1597                 } else {
1598                     $settings = '';
1599                 }
1600                 $settings = new html_table_cell($settings);
1602                 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1603                     $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1604                 } else {
1605                     $uninstall = '';
1606                 }
1607                 $uninstall = new html_table_cell($uninstall);
1609                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1610                 if ($requriedby) {
1611                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1612                         array('class' => 'requiredby'));
1613                 } else {
1614                     $requiredby = '';
1615                 }
1617                 $updateinfo = '';
1618                 if (is_array($plugin->available_updates())) {
1619                     foreach ($plugin->available_updates() as $availableupdate) {
1620                         $updateinfo .= $this->plugin_available_update_info($availableupdate);
1621                     }
1622                 }
1624                 $notes = new html_table_cell($requiredby.$updateinfo);
1626                 $row->cells = array(
1627                     $pluginname, $source, $version, $release, $availability, $settings, $uninstall, $notes
1628                 );
1629                 $table->data[] = $row;
1630             }
1631         }
1633         return html_writer::table($table);
1634     }
1636     /**
1637      * Helper method to render the information about the available plugin update
1638      *
1639      * The passed objects always provides at least the 'version' property containing
1640      * the (higher) version of the plugin available.
1641      *
1642      * @param \core\update\info $updateinfo information about the available update for the plugin
1643      */
1644     protected function plugin_available_update_info(\core\update\info $updateinfo) {
1646         $boxclasses = 'pluginupdateinfo';
1647         $info = array();
1649         if (isset($updateinfo->release)) {
1650             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1651                 array('class' => 'info release'));
1652         }
1654         if (isset($updateinfo->maturity)) {
1655             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1656                 array('class' => 'info maturity'));
1657             $boxclasses .= ' maturity'.$updateinfo->maturity;
1658         }
1660         if (isset($updateinfo->download)) {
1661             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
1662         }
1664         if (isset($updateinfo->url)) {
1665             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
1666                 array('class' => 'info more'));
1667         }
1669         $box  = $this->output->box_start($boxclasses);
1670         $box .= html_writer::tag('div', get_string('updateavailable', 'core_plugin', $updateinfo->version), array('class' => 'version'));
1671         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
1673         $deployer = \core\update\deployer::instance();
1674         if ($deployer->initialized()) {
1675             $impediments = $deployer->deployment_impediments($updateinfo);
1676             if (empty($impediments)) {
1677                 $widget = $deployer->make_confirm_widget($updateinfo);
1678                 $box .= $this->output->render($widget);
1679             } else {
1680                 if (isset($impediments['notwritable'])) {
1681                     $box .= $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1682                 }
1683                 if (isset($impediments['notdownloadable'])) {
1684                     $box .= $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1685                 }
1686             }
1687         }
1689         $box .= $this->output->box_end();
1691         return $box;
1692     }
1694     /**
1695      * This function will render one beautiful table with all the environmental
1696      * configuration and how it suits Moodle needs.
1697      *
1698      * @param boolean $result final result of the check (true/false)
1699      * @param environment_results[] $environment_results array of results gathered
1700      * @return string HTML to output.
1701      */
1702     public function environment_check_table($result, $environment_results) {
1703         global $CFG;
1705         // Table headers
1706         $servertable = new html_table();//table for server checks
1707         $servertable->head  = array(
1708             get_string('name'),
1709             get_string('info'),
1710             get_string('report'),
1711             get_string('plugin'),
1712             get_string('status'),
1713         );
1714         $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1715         $servertable->attributes['class'] = 'admintable environmenttable generaltable';
1716         $servertable->id = 'serverstatus';
1718         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1720         $othertable = new html_table();//table for custom checks
1721         $othertable->head  = array(
1722             get_string('info'),
1723             get_string('report'),
1724             get_string('plugin'),
1725             get_string('status'),
1726         );
1727         $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1728         $othertable->attributes['class'] = 'admintable environmenttable generaltable';
1729         $othertable->id = 'otherserverstatus';
1731         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1733         // Iterate over each environment_result
1734         $continue = true;
1735         foreach ($environment_results as $environment_result) {
1736             $errorline   = false;
1737             $warningline = false;
1738             $stringtouse = '';
1739             if ($continue) {
1740                 $type = $environment_result->getPart();
1741                 $info = $environment_result->getInfo();
1742                 $status = $environment_result->getStatus();
1743                 $plugin = $environment_result->getPluginName();
1744                 $error_code = $environment_result->getErrorCode();
1745                 // Process Report field
1746                 $rec = new stdClass();
1747                 // Something has gone wrong at parsing time
1748                 if ($error_code) {
1749                     $stringtouse = 'environmentxmlerror';
1750                     $rec->error_code = $error_code;
1751                     $status = get_string('error');
1752                     $errorline = true;
1753                     $continue = false;
1754                 }
1756                 if ($continue) {
1757                     if ($rec->needed = $environment_result->getNeededVersion()) {
1758                         // We are comparing versions
1759                         $rec->current = $environment_result->getCurrentVersion();
1760                         if ($environment_result->getLevel() == 'required') {
1761                             $stringtouse = 'environmentrequireversion';
1762                         } else {
1763                             $stringtouse = 'environmentrecommendversion';
1764                         }
1766                     } else if ($environment_result->getPart() == 'custom_check') {
1767                         // We are checking installed & enabled things
1768                         if ($environment_result->getLevel() == 'required') {
1769                             $stringtouse = 'environmentrequirecustomcheck';
1770                         } else {
1771                             $stringtouse = 'environmentrecommendcustomcheck';
1772                         }
1774                     } else if ($environment_result->getPart() == 'php_setting') {
1775                         if ($status) {
1776                             $stringtouse = 'environmentsettingok';
1777                         } else if ($environment_result->getLevel() == 'required') {
1778                             $stringtouse = 'environmentmustfixsetting';
1779                         } else {
1780                             $stringtouse = 'environmentshouldfixsetting';
1781                         }
1783                     } else {
1784                         if ($environment_result->getLevel() == 'required') {
1785                             $stringtouse = 'environmentrequireinstall';
1786                         } else {
1787                             $stringtouse = 'environmentrecommendinstall';
1788                         }
1789                     }
1791                     // Calculate the status value
1792                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1793                         $status = get_string('bypassed');
1794                         $warningline = true;
1795                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1796                         $status = get_string('restricted');
1797                         $errorline = true;
1798                     } else {
1799                         if ($status) {                                          //Handle ok result (ok)
1800                             $status = get_string('ok');
1801                         } else {
1802                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1803                                 $status = get_string('check');
1804                                 $warningline = true;
1805                             } else {                                            //Handle error result (error)
1806                                 $status = get_string('check');
1807                                 $errorline = true;
1808                             }
1809                         }
1810                     }
1811                 }
1813                 // Build the text
1814                 $linkparts = array();
1815                 $linkparts[] = 'admin/environment';
1816                 $linkparts[] = $type;
1817                 if (!empty($info)){
1818                    $linkparts[] = $info;
1819                 }
1820                 // Plugin environments do not have docs pages yet.
1821                 if (empty($CFG->docroot) or $environment_result->plugin) {
1822                     $report = get_string($stringtouse, 'admin', $rec);
1823                 } else {
1824                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec));
1825                 }
1827                 // Format error or warning line
1828                 if ($errorline || $warningline) {
1829                     $messagetype = $errorline? 'error':'warn';
1830                 } else {
1831                     $messagetype = 'ok';
1832                 }
1833                 $status = '<span class="'.$messagetype.'">'.$status.'</span>';
1834                 // Here we'll store all the feedback found
1835                 $feedbacktext = '';
1836                 // Append the feedback if there is some
1837                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
1838                 //Append the bypass if there is some
1839                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
1840                 //Append the restrict if there is some
1841                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
1843                 $report .= $feedbacktext;
1845                 // Add the row to the table
1846                 if ($environment_result->getPart() == 'custom_check'){
1847                     $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
1848                 } else {
1849                     $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
1850                 }
1851             }
1852         }
1854         //put errors first in
1855         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
1856         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
1858         // Print table
1859         $output = '';
1860         $output .= $this->heading(get_string('serverchecks', 'admin'));
1861         $output .= html_writer::table($servertable);
1862         if (count($othertable->data)){
1863             $output .= $this->heading(get_string('customcheck', 'admin'));
1864             $output .= html_writer::table($othertable);
1865         }
1867         // Finally, if any error has happened, print the summary box
1868         if (!$result) {
1869             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
1870         }
1872         return $output;
1873     }
1875     /**
1876      * Render a simple page for providing the upgrade key.
1877      *
1878      * @param moodle_url|string $url
1879      * @return string
1880      */
1881     public function upgradekey_form_page($url) {
1883         $output = '';
1884         $output .= $this->header();
1885         $output .= $this->container_start('upgradekeyreq');
1886         $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
1887         $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
1888         $output .= html_writer::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
1889         $output .= html_writer::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
1890         $output .= html_writer::end_tag('form');
1891         $output .= $this->container_end();
1892         $output .= $this->footer();
1894         return $output;
1895     }