257f82556bb20953d103e59eeed26c9484d8f5d5
[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'));
211         $output .= $this->check_for_updates_button($checker, $reloadurl);
212         $output .= $this->missing_dependencies($pluginman);
213         $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
214         $output .= $this->box_end();
215         $output .= $this->upgrade_reload($reloadurl);
217         if ($pluginman->some_plugins_updatable()) {
218             $output .= $this->container_start('upgradepluginsinfo');
219             $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
220             $output .= $this->container_end();
221         }
223         $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
224         $button->class = 'continuebutton';
225         $output .= $this->render($button);
226         $output .= $this->footer();
228         return $output;
229     }
231     /**
232      * Display a page to confirm plugin installation cancelation.
233      *
234      * @param array $abortable list of \core\update\plugininfo
235      * @param moodle_url $continue
236      * @return string
237      */
238     public function upgrade_confirm_abort_install_page(array $abortable, moodle_url $continue) {
240         $pluginman = core_plugin_manager::instance();
242         if (empty($abortable)) {
243             // The UI should not allow this.
244             throw new moodle_exception('err_no_plugin_install_abortable', 'core_plugin');
245         }
247         $out = $this->output->header();
248         $out .= $this->output->heading(get_string('cancelinstallhead', 'core_plugin'), 3);
249         $out .= $this->output->container(get_string('cancelinstallinfo', 'core_plugin'), 'cancelinstallinfo');
251         foreach ($abortable as $pluginfo) {
252             $out .= $this->output->heading($pluginfo->displayname.' ('.$pluginfo->component.')', 4);
253             $out .= $this->output->container(get_string('cancelinstallinfodir', 'core_plugin', $pluginfo->rootdir));
254             if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
255                 $out .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
256                     'uninstalldeleteconfirmexternal');
257             }
258         }
260         $out .= $this->plugins_management_confirm_buttons($continue, $this->page->url);
261         $out .= $this->output->footer();
263         return $out;
264     }
266     /**
267      * Display the admin notifications page.
268      * @param int $maturity
269      * @param bool $insecuredataroot warn dataroot is invalid
270      * @param bool $errorsdisplayed warn invalid dispaly error setting
271      * @param bool $cronoverdue warn cron not running
272      * @param bool $dbproblems warn db has problems
273      * @param bool $maintenancemode warn in maintenance mode
274      * @param bool $buggyiconvnomb warn iconv problems
275      * @param array|null $availableupdates array of \core\update\info objects or null
276      * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
277      * @param string[] $cachewarnings An array containing warnings from the Cache API.
278      * @param array $eventshandlers Events 1 API handlers.
279      * @param bool $themedesignermode Warn about the theme designer mode.
280      * @param bool $devlibdir Warn about development libs directory presence.
281      * @param bool $mobileconfigured Whether the mobile web services have been enabled
282      * @param bool $overridetossl Whether or not ssl is being forced.
283      * @param bool $invalidforgottenpasswordurl Whether the forgotten password URL does not link to a valid URL.
284      * @param bool $croninfrequent If true, warn that cron hasn't run in the past few minutes
285      *
286      * @return string HTML to output.
287      */
288     public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
289             $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
290             $buggyiconvnomb, $registered, array $cachewarnings = array(), $eventshandlers = 0,
291             $themedesignermode = false, $devlibdir = false, $mobileconfigured = false,
292             $overridetossl = false, $invalidforgottenpasswordurl = false, $croninfrequent = false) {
293         global $CFG;
294         $output = '';
296         $output .= $this->header();
297         $output .= $this->maturity_info($maturity);
298         $output .= $this->legacy_log_store_writing_error();
299         $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
300         $output .= $this->insecure_dataroot_warning($insecuredataroot);
301         $output .= $this->development_libs_directories_warning($devlibdir);
302         $output .= $this->themedesignermode_warning($themedesignermode);
303         $output .= $this->display_errors_warning($errorsdisplayed);
304         $output .= $this->buggy_iconv_warning($buggyiconvnomb);
305         $output .= $this->cron_overdue_warning($cronoverdue);
306         $output .= $this->cron_infrequent_warning($croninfrequent);
307         $output .= $this->db_problems($dbproblems);
308         $output .= $this->maintenance_mode_warning($maintenancemode);
309         $output .= $this->overridetossl_warning($overridetossl);
310         $output .= $this->cache_warnings($cachewarnings);
311         $output .= $this->events_handlers($eventshandlers);
312         $output .= $this->registration_warning($registered);
313         $output .= $this->mobile_configuration_warning($mobileconfigured);
314         $output .= $this->forgotten_password_url_warning($invalidforgottenpasswordurl);
316         //////////////////////////////////////////////////////////////////////////////////////////////////
317         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
318         $output .= $this->moodle_copyright();
319         //////////////////////////////////////////////////////////////////////////////////////////////////
321         $output .= $this->footer();
323         return $output;
324     }
326     /**
327      * Display the plugin management page (admin/plugins.php).
328      *
329      * The filtering options array may contain following items:
330      *  bool contribonly - show only contributed extensions
331      *  bool updatesonly - show only plugins with an available update
332      *
333      * @param core_plugin_manager $pluginman
334      * @param \core\update\checker $checker
335      * @param array $options filtering options
336      * @return string HTML to output.
337      */
338     public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
340         $output = '';
342         $output .= $this->header();
343         $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
344         $output .= $this->check_for_updates_button($checker, $this->page->url);
345         $output .= $this->plugins_overview_panel($pluginman, $options);
346         $output .= $this->plugins_control_panel($pluginman, $options);
347         $output .= $this->footer();
349         return $output;
350     }
352     /**
353      * Renders a button to fetch for available updates.
354      *
355      * @param \core\update\checker $checker
356      * @param moodle_url $reloadurl
357      * @return string HTML
358      */
359     public function check_for_updates_button(\core\update\checker $checker, $reloadurl) {
361         $output = '';
363         if ($checker->enabled()) {
364             $output .= $this->container_start('checkforupdates');
365             $output .= $this->single_button(
366                 new moodle_url($reloadurl, array('fetchupdates' => 1)),
367                 get_string('checkforupdates', 'core_plugin')
368             );
369             if ($timefetched = $checker->get_last_timefetched()) {
370                 $timefetched = userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'));
371                 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin', $timefetched), 'lasttimefetched');
372             }
373             $output .= $this->container_end();
374         }
376         return $output;
377     }
379     /**
380      * Display a page to confirm the plugin uninstallation.
381      *
382      * @param core_plugin_manager $pluginman
383      * @param \core\plugininfo\base $pluginfo
384      * @param moodle_url $continueurl URL to continue after confirmation
385      * @param moodle_url $cancelurl URL to to go if cancelled
386      * @return string
387      */
388     public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
389         $output = '';
391         $pluginname = $pluginman->plugin_name($pluginfo->component);
393         $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
394         if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
395             $confirm .= $extraconfirm;
396         }
398         $output .= $this->output->header();
399         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
400         $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
401         $output .= $this->output->footer();
403         return $output;
404     }
406     /**
407      * Display a page with results of plugin uninstallation and offer removal of plugin files.
408      *
409      * @param core_plugin_manager $pluginman
410      * @param \core\plugininfo\base $pluginfo
411      * @param progress_trace_buffer $progress
412      * @param moodle_url $continueurl URL to continue to remove the plugin folder
413      * @return string
414      */
415     public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
416                                                             progress_trace_buffer $progress, moodle_url $continueurl) {
417         $output = '';
419         $pluginname = $pluginman->plugin_name($pluginfo->component);
421         // Do not show navigation here, they must click one of the buttons.
422         $this->page->set_pagelayout('maintenance');
423         $this->page->set_cacheable(false);
425         $output .= $this->output->header();
426         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
428         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
430         $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
431             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
433         if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
434             $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
435                 'uninstalldeleteconfirmexternal');
436         }
438         // After any uninstall we must execute full upgrade to finish the cleanup!
439         $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
440         $output .= $this->output->footer();
442         return $output;
443     }
445     /**
446      * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
447      *
448      * @param core_plugin_manager $pluginman
449      * @param \core\plugininfo\base $pluginfo
450      * @param progress_trace_buffer $progress
451      * @return string
452      */
453     public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
454         $output = '';
456         $pluginname = $pluginfo->component;
458         $output .= $this->output->header();
459         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
461         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
463         $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
464             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
465         $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
466         $output .= $this->output->footer();
468         return $output;
469     }
471     /**
472      * Display the plugin management page (admin/environment.php).
473      * @param array $versions
474      * @param string $version
475      * @param boolean $envstatus final result of env check (true/false)
476      * @param array $environment_results array of results gathered
477      * @return string HTML to output.
478      */
479     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
480         $output = '';
481         $output .= $this->header();
483         // Print the component download link
484         $output .= html_writer::tag('div', html_writer::link(
485                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
486                     get_string('updatecomponent', 'admin')),
487                 array('class' => 'reportlink'));
489         // Heading.
490         $output .= $this->heading(get_string('environment', 'admin'));
492         // Box with info and a menu to choose the version.
493         $output .= $this->box_start();
494         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
495         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
496         $select->label = get_string('moodleversion');
497         $output .= $this->render($select);
498         $output .= $this->box_end();
500         // The results
501         $output .= $this->environment_check_table($envstatus, $environment_results);
503         $output .= $this->footer();
504         return $output;
505     }
507     /**
508      * Output a warning message, of the type that appears on the admin notifications page.
509      * @param string $message the message to display.
510      * @param string $type type class
511      * @return string HTML to output.
512      */
513     protected function warning($message, $type = 'warning') {
514         return $this->box($message, 'generalbox admin' . $type);
515     }
517     /**
518      * Render an appropriate message if dataroot is insecure.
519      * @param bool $insecuredataroot
520      * @return string HTML to output.
521      */
522     protected function insecure_dataroot_warning($insecuredataroot) {
523         global $CFG;
525         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
526             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
528         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
529             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
531         } else {
532             return '';
533         }
534     }
536     /**
537      * Render a warning that a directory with development libs is present.
538      *
539      * @param bool $devlibdir True if the warning should be displayed.
540      * @return string
541      */
542     protected function development_libs_directories_warning($devlibdir) {
544         if ($devlibdir) {
545             $moreinfo = new moodle_url('/report/security/index.php');
546             $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
547             return $this->warning($warning, 'error');
549         } else {
550             return '';
551         }
552     }
554     /**
555      * Render an appropriate message if dataroot is insecure.
556      * @param bool $errorsdisplayed
557      * @return string HTML to output.
558      */
559     protected function display_errors_warning($errorsdisplayed) {
560         if (!$errorsdisplayed) {
561             return '';
562         }
564         return $this->warning(get_string('displayerrorswarning', 'admin'));
565     }
567     /**
568      * Render an appropriate message if themdesignermode is enabled.
569      * @param bool $themedesignermode true if enabled
570      * @return string HTML to output.
571      */
572     protected function themedesignermode_warning($themedesignermode) {
573         if (!$themedesignermode) {
574             return '';
575         }
577         return $this->warning(get_string('themedesignermodewarning', 'admin'));
578     }
580     /**
581      * Render an appropriate message if iconv is buggy and mbstring missing.
582      * @param bool $buggyiconvnomb
583      * @return string HTML to output.
584      */
585     protected function buggy_iconv_warning($buggyiconvnomb) {
586         if (!$buggyiconvnomb) {
587             return '';
588         }
590         return $this->warning(get_string('warningiconvbuggy', 'admin'));
591     }
593     /**
594      * Render an appropriate message if cron has not been run recently.
595      * @param bool $cronoverdue
596      * @return string HTML to output.
597      */
598     public function cron_overdue_warning($cronoverdue) {
599         global $CFG;
600         if (!$cronoverdue) {
601             return '';
602         }
604         if (empty($CFG->cronclionly)) {
605             $url = new moodle_url('/admin/cron.php');
606             if (!empty($CFG->cronremotepassword)) {
607                 $url = new moodle_url('/admin/cron.php', array('password' => $CFG->cronremotepassword));
608             }
610             return $this->warning(get_string('cronwarning', 'admin', $url->out()) . '&nbsp;' .
611                     $this->help_icon('cron', 'admin'));
612         }
614         // $CFG->cronclionly is not empty: cron can run only from CLI.
615         return $this->warning(get_string('cronwarningcli', 'admin') . '&nbsp;' .
616                 $this->help_icon('cron', 'admin'));
617     }
619     /**
620      * Render an appropriate message if cron is not being run frequently (recommended every minute).
621      *
622      * @param bool $croninfrequent
623      * @return string HTML to output.
624      */
625     public function cron_infrequent_warning(bool $croninfrequent) : string {
626         global $CFG;
628         if (!$croninfrequent) {
629             return '';
630         }
632         $expectedfrequency = $CFG->expectedcronfrequency ?? 200;
633         return $this->warning(get_string('croninfrequent', 'admin', $expectedfrequency) . '&nbsp;' .
634                 $this->help_icon('cron', 'admin'));
635     }
637     /**
638      * Render an appropriate message if there are any problems with the DB set-up.
639      * @param bool $dbproblems
640      * @return string HTML to output.
641      */
642     public function db_problems($dbproblems) {
643         if (!$dbproblems) {
644             return '';
645         }
647         return $this->warning($dbproblems);
648     }
650     /**
651      * Renders cache warnings if there are any.
652      *
653      * @param string[] $cachewarnings
654      * @return string
655      */
656     public function cache_warnings(array $cachewarnings) {
657         if (!count($cachewarnings)) {
658             return '';
659         }
660         return join("\n", array_map(array($this, 'warning'), $cachewarnings));
661     }
663     /**
664      * Renders events 1 API handlers warning.
665      *
666      * @param array $eventshandlers
667      * @return string
668      */
669     public function events_handlers($eventshandlers) {
670         if ($eventshandlers) {
671             $components = '';
672             foreach ($eventshandlers as $eventhandler) {
673                 $components .= $eventhandler->component . ', ';
674             }
675             $components = rtrim($components, ', ');
676             return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
677         }
678     }
680     /**
681      * Render an appropriate message if the site in in maintenance mode.
682      * @param bool $maintenancemode
683      * @return string HTML to output.
684      */
685     public function maintenance_mode_warning($maintenancemode) {
686         if (!$maintenancemode) {
687             return '';
688         }
690         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
691         $url = $url->out(); // get_string() does not support objects in params
693         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
694     }
696     /**
697      * Render a warning that ssl is forced because the site was on loginhttps.
698      *
699      * @param bool $overridetossl Whether or not ssl is being forced.
700      * @return string
701      */
702     protected function overridetossl_warning($overridetossl) {
703         if (!$overridetossl) {
704             return '';
705         }
706         $warning = get_string('overridetossl', 'core_admin');
707         return $this->warning($warning, 'warning');
708     }
710     /**
711      * Display a warning about installing development code if necesary.
712      * @param int $maturity
713      * @return string HTML to output.
714      */
715     protected function maturity_warning($maturity) {
716         if ($maturity == MATURITY_STABLE) {
717             return ''; // No worries.
718         }
720         $maturitylevel = get_string('maturity' . $maturity, 'admin');
721         return $this->warning(
722                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
723                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
724                 'error');
725     }
727     /*
728      * If necessary, displays a warning about upgrading a test site.
729      *
730      * @param string $testsite
731      * @return string HTML
732      */
733     protected function test_site_warning($testsite) {
735         if (!$testsite) {
736             return '';
737         }
739         $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
740         return $this->warning($warning, 'error');
741     }
743     /**
744      * Output the copyright notice.
745      * @return string HTML to output.
746      */
747     protected function moodle_copyright() {
748         global $CFG;
750         //////////////////////////////////////////////////////////////////////////////////////////////////
751         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
752         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
753                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
754                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
755                          'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
756                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
757         //////////////////////////////////////////////////////////////////////////////////////////////////
759         return $this->box($copyrighttext, 'copyright');
760     }
762     /**
763      * Display a warning about installing development code if necesary.
764      * @param int $maturity
765      * @return string HTML to output.
766      */
767     protected function maturity_info($maturity) {
768         if ($maturity == MATURITY_STABLE) {
769             return ''; // No worries.
770         }
772         $level = 'warning';
774         if ($maturity == MATURITY_ALPHA) {
775             $level = 'error';
776         }
778         $maturitylevel = get_string('maturity' . $maturity, 'admin');
779         $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
780         $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
781         return $this->warning($warningtext, $level);
782     }
784     /**
785      * Displays the info about available Moodle core and plugin updates
786      *
787      * The structure of the $updates param has changed since 2.4. It contains not only updates
788      * for the core itself, but also for all other installed plugins.
789      *
790      * @param array|null $updates array of (string)component => array of \core\update\info objects or null
791      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
792      * @return string
793      */
794     protected function available_updates($updates, $fetch) {
796         $updateinfo = '';
797         $someupdateavailable = false;
798         if (is_array($updates)) {
799             if (is_array($updates['core'])) {
800                 $someupdateavailable = true;
801                 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
802                 foreach ($updates['core'] as $update) {
803                     $updateinfo .= $this->moodle_available_update_info($update);
804                 }
805                 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
806                     array('class' => 'updateavailablerecommendation'));
807             }
808             unset($updates['core']);
809             // If something has left in the $updates array now, it is updates for plugins.
810             if (!empty($updates)) {
811                 $someupdateavailable = true;
812                 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
813                 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
814                 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
815                     array('url' => $pluginsoverviewurl->out())));
816             }
817         }
819         if (!$someupdateavailable) {
820             $now = time();
821             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
822                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
823             }
824         }
826         $updateinfo .= $this->container_start('checkforupdates');
827         $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
828         $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
829         if ($fetch) {
830             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
831                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
832         }
833         $updateinfo .= $this->container_end();
835         return $this->warning($updateinfo);
836     }
838     /**
839      * Display a warning about not being registered on Moodle.org if necesary.
840      *
841      * @param boolean $registered true if the site is registered on Moodle.org
842      * @return string HTML to output.
843      */
844     protected function registration_warning($registered) {
846         if (!$registered) {
848             if (has_capability('moodle/site:config', context_system::instance())) {
849                 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
850                     get_string('register', 'admin'));
851                 $str = 'registrationwarning';
852             } else {
853                 $registerbutton = '';
854                 $str = 'registrationwarningcontactadmin';
855             }
857             return $this->warning( get_string($str, 'admin')
858                     . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
859                 'error alert alert-danger');
860         }
862         return '';
863     }
865     /**
866      * Return an admin page warning if site is not registered with moodle.org
867      *
868      * @return string
869      */
870     public function warn_if_not_registered() {
871         return $this->registration_warning(\core\hub\registration::is_registered());
872     }
874     /**
875      * Display a warning about the Mobile Web Services being disabled.
876      *
877      * @param boolean $mobileconfigured true if mobile web services are enabled
878      * @return string HTML to output.
879      */
880     protected function mobile_configuration_warning($mobileconfigured) {
881         $output = '';
882         if (!$mobileconfigured) {
883             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
884             $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
885             $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
886         }
888         return $output;
889     }
891     /**
892      * Display a warning about the forgotten password URL not linking to a valid URL.
893      *
894      * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
895      * @return string HTML to output.
896      */
897     protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
898         $output = '';
899         if ($invalidforgottenpasswordurl) {
900             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
901             $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
902             $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
903                 'error alert alert-danger');
904         }
906         return $output;
907     }
909     /**
910      * Helper method to render the information about the available Moodle update
911      *
912      * @param \core\update\info $updateinfo information about the available Moodle core update
913      */
914     protected function moodle_available_update_info(\core\update\info $updateinfo) {
916         $boxclasses = 'moodleupdateinfo';
917         $info = array();
919         if (isset($updateinfo->release)) {
920             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
921                 array('class' => 'info release'));
922         }
924         if (isset($updateinfo->version)) {
925             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
926                 array('class' => 'info version'));
927         }
929         if (isset($updateinfo->maturity)) {
930             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
931                 array('class' => 'info maturity'));
932             $boxclasses .= ' maturity'.$updateinfo->maturity;
933         }
935         if (isset($updateinfo->download)) {
936             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
937         }
939         if (isset($updateinfo->url)) {
940             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
941                 array('class' => 'info more'));
942         }
944         $box  = $this->output->box_start($boxclasses);
945         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
946         $box .= $this->output->box_end();
948         return $box;
949     }
951     /**
952      * Display a link to the release notes.
953      * @return string HTML to output.
954      */
955     protected function release_notes_link() {
956         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
957         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
958         return $this->box($releasenoteslink, 'generalbox releasenoteslink');
959     }
961     /**
962      * Display the reload link that appears on several upgrade/install pages.
963      * @return string HTML to output.
964      */
965     function upgrade_reload($url) {
966         return html_writer::empty_tag('br') .
967                 html_writer::tag('div',
968                     html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
969                             get_string('reload'), array('title' => get_string('reload'))),
970                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
971     }
973     /**
974      * Displays all known plugins and information about their installation or upgrade
975      *
976      * This default implementation renders all plugins into one big table. The rendering
977      * options support:
978      *     (bool)full = false: whether to display up-to-date plugins, too
979      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
980      *
981      * @param core_plugin_manager $pluginman provides information about the plugins.
982      * @param int $version the version of the Moodle code from version.php.
983      * @param array $options rendering options
984      * @return string HTML code
985      */
986     public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
988         $plugininfo = $pluginman->get_plugins();
990         if (empty($plugininfo)) {
991             return '';
992         }
994         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
995         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
997         $table = new html_table();
998         $table->id = 'plugins-check';
999         $table->head = array(
1000             get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
1001             get_string('versiondb', 'core_plugin'),
1002             get_string('versiondisk', 'core_plugin'),
1003             get_string('requires', 'core_plugin'),
1004             get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
1005         );
1006         $table->colclasses = array(
1007             'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
1008         );
1009         $table->data = array();
1011         // Number of displayed plugins per type.
1012         $numdisplayed = array();
1013         // Number of plugins known to the plugin manager.
1014         $sumtotal = 0;
1015         // Number of plugins requiring attention.
1016         $sumattention = 0;
1017         // List of all components we can cancel installation of.
1018         $installabortable = $pluginman->list_cancellable_installations();
1019         // List of all components we can cancel upgrade of.
1020         $upgradeabortable = $pluginman->list_restorable_archives();
1022         foreach ($plugininfo as $type => $plugins) {
1024             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
1025             $header->header = true;
1026             $header->colspan = count($table->head);
1027             $header = new html_table_row(array($header));
1028             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1030             $numdisplayed[$type] = 0;
1032             if (empty($plugins) and $options['full']) {
1033                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1034                 $msg->colspan = count($table->head);
1035                 $row = new html_table_row(array($msg));
1036                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1037                 $table->data[] = $header;
1038                 $table->data[] = $row;
1039                 continue;
1040             }
1042             $plugintyperows = array();
1044             foreach ($plugins as $name => $plugin) {
1045                 $sumtotal++;
1046                 $row = new html_table_row();
1047                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1049                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1050                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
1051                 } else {
1052                     $icon = '';
1053                 }
1055                 $displayname = new html_table_cell(
1056                     $icon.
1057                     html_writer::span($plugin->displayname, 'pluginname').
1058                     html_writer::div($plugin->get_dir(), 'plugindir')
1059                 );
1061                 $versiondb = new html_table_cell($plugin->versiondb);
1062                 $versiondisk = new html_table_cell($plugin->versiondisk);
1064                 if ($isstandard = $plugin->is_standard()) {
1065                     $row->attributes['class'] .= ' standard';
1066                     $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext label');
1067                 } else {
1068                     $row->attributes['class'] .= ' extension';
1069                     $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
1070                 }
1072                 $coredependency = $plugin->is_core_dependency_satisfied($version);
1073                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1074                 $dependenciesok = $coredependency && $otherpluginsdependencies;
1076                 $statuscode = $plugin->get_status();
1077                 $row->attributes['class'] .= ' status-' . $statuscode;
1078                 $statusclass = 'statustext label ';
1079                 switch ($statuscode) {
1080                     case core_plugin_manager::PLUGIN_STATUS_NEW:
1081                         $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
1082                         break;
1083                     case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
1084                         $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
1085                         break;
1086                     case core_plugin_manager::PLUGIN_STATUS_MISSING:
1087                     case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1088                     case core_plugin_manager::PLUGIN_STATUS_DELETE:
1089                         $statusclass .= 'badge-danger';
1090                         break;
1091                     case core_plugin_manager::PLUGIN_STATUS_NODB:
1092                     case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
1093                         $statusclass .= $dependenciesok ? '' : 'badge-warning';
1094                         break;
1095                 }
1096                 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1098                 if (!empty($installabortable[$plugin->component])) {
1099                     $status .= $this->output->single_button(
1100                         new moodle_url($this->page->url, array('abortinstall' => $plugin->component)),
1101                         get_string('cancelinstallone', 'core_plugin'),
1102                         'post',
1103                         array('class' => 'actionbutton cancelinstallone')
1104                     );
1105                 }
1107                 if (!empty($upgradeabortable[$plugin->component])) {
1108                     $status .= $this->output->single_button(
1109                         new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
1110                         get_string('cancelupgradeone', 'core_plugin'),
1111                         'post',
1112                         array('class' => 'actionbutton cancelupgradeone')
1113                     );
1114                 }
1116                 $availableupdates = $plugin->available_updates();
1117                 if (!empty($availableupdates)) {
1118                     foreach ($availableupdates as $availableupdate) {
1119                         $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1120                     }
1121                 }
1123                 $status = new html_table_cell($sourcelabel.' '.$status);
1125                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1127                 $statusisboring = in_array($statuscode, array(
1128                         core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
1130                 if ($options['xdep']) {
1131                     // we want to see only plugins with failed dependencies
1132                     if ($dependenciesok) {
1133                         continue;
1134                     }
1136                 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1137                     // no change is going to happen to the plugin - display it only
1138                     // if the user wants to see the full list
1139                     if (empty($options['full'])) {
1140                         continue;
1141                     }
1143                 } else {
1144                     $sumattention++;
1145                 }
1147                 // The plugin should be displayed.
1148                 $numdisplayed[$type]++;
1149                 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1150                 $plugintyperows[] = $row;
1151             }
1153             if (empty($numdisplayed[$type]) and empty($options['full'])) {
1154                 continue;
1155             }
1157             $table->data[] = $header;
1158             $table->data = array_merge($table->data, $plugintyperows);
1159         }
1161         // Total number of displayed plugins.
1162         $sumdisplayed = array_sum($numdisplayed);
1164         if ($options['xdep']) {
1165             // At the plugins dependencies check page, display the table only.
1166             return html_writer::table($table);
1167         }
1169         $out = $this->output->container_start('', 'plugins-check-info');
1171         if ($sumdisplayed == 0) {
1172             $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1174         } else {
1175             if (empty($options['full'])) {
1176                 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1177             } else {
1178                 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1179             }
1180         }
1182         $out .= $this->output->container_start('actions');
1184         $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1185         if ($installableupdates) {
1186             $out .= $this->output->single_button(
1187                 new moodle_url($this->page->url, array('installupdatex' => 1)),
1188                 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1189                 'post',
1190                 array('class' => 'singlebutton updateavailableinstallall')
1191             );
1192         }
1194         if ($installabortable) {
1195             $out .= $this->output->single_button(
1196                 new moodle_url($this->page->url, array('abortinstallx' => 1)),
1197                 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1198                 'post',
1199                 array('class' => 'singlebutton cancelinstallall')
1200             );
1201         }
1203         if ($upgradeabortable) {
1204             $out .= $this->output->single_button(
1205                 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1206                 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1207                 'post',
1208                 array('class' => 'singlebutton cancelupgradeall')
1209             );
1210         }
1212         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1213             get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge'));
1215         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1216             get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge'));
1218         $out .= $this->output->container_end(); // End of .actions container.
1219         $out .= $this->output->container_end(); // End of #plugins-check-info container.
1221         if ($sumdisplayed > 0 or $options['full']) {
1222             $out .= html_writer::table($table);
1223         }
1225         return $out;
1226     }
1228     /**
1229      * Display the continue / cancel widgets for the plugins management pages.
1230      *
1231      * @param null|moodle_url $continue URL for the continue button, should it be displayed
1232      * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1233      * @return string HTML
1234      */
1235     public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
1237         $out = html_writer::start_div('plugins-management-confirm-buttons');
1239         if (!empty($continue)) {
1240             $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1241         }
1243         if (empty($cancel)) {
1244             $cancel = $this->page->url;
1245         }
1246         $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1248         return $out;
1249     }
1251     /**
1252      * Displays the information about missing dependencies
1253      *
1254      * @param core_plugin_manager $pluginman
1255      * @return string
1256      */
1257     protected function missing_dependencies(core_plugin_manager $pluginman) {
1259         $dependencies = $pluginman->missing_dependencies();
1261         if (empty($dependencies)) {
1262             return '';
1263         }
1265         $available = array();
1266         $unavailable = array();
1267         $unknown = array();
1269         foreach ($dependencies as $component => $remoteinfo) {
1270             if ($remoteinfo === false) {
1271                 // The required version is not available. Let us check if there
1272                 // is at least some version in the plugins directory.
1273                 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1274                 if ($remoteinfoanyversion === false) {
1275                     $unknown[$component] = $component;
1276                 } else {
1277                     $unavailable[$component] = $remoteinfoanyversion;
1278                 }
1279             } else {
1280                 $available[$component] = $remoteinfo;
1281             }
1282         }
1284         $out  = $this->output->container_start('plugins-check-dependencies');
1286         if ($unavailable or $unknown) {
1287             $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1288             if ($unknown) {
1289                 $out .= $this->output->notification(get_string('misdepsunknownlist', 'core_plugin', implode($unknown, ', ')));
1290             }
1291             if ($unavailable) {
1292                 $unavailablelist = array();
1293                 foreach ($unavailable as $component => $remoteinfoanyversion) {
1294                     $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1295                         '<strong>'.$remoteinfoanyversion->name.'</strong>');
1296                     if ($remoteinfoanyversion->version) {
1297                         $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1298                     } else {
1299                         $unavailablelistitem .= ' ('.$component.')';
1300                     }
1301                     $unavailablelist[] = $unavailablelistitem;
1302                 }
1303                 $out .= $this->output->notification(get_string('misdepsunavaillist', 'core_plugin',
1304                     implode($unavailablelist, ', ')));
1305             }
1306             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1307             $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1308                 get_string('dependencyuploadmissing', 'core_plugin'));
1309             $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1310         }
1312         if ($available) {
1313             $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
1314             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1316             $installable = $pluginman->filter_installable($available);
1317             if ($installable) {
1318                 $out .= $this->output->single_button(
1319                     new moodle_url($this->page->url, array('installdepx' => 1)),
1320                     get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1321                     'post',
1322                     array('class' => 'singlebutton dependencyinstallmissing')
1323                 );
1324             }
1326             $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1327                 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1329             $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1331             $out .= $this->available_missing_dependencies_list($pluginman, $available);
1332         }
1334         $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
1336         return $out;
1337     }
1339     /**
1340      * Displays the list if available missing dependencies.
1341      *
1342      * @param core_plugin_manager $pluginman
1343      * @param array $dependencies
1344      * @return string
1345      */
1346     protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1347         global $CFG;
1349         $table = new html_table();
1350         $table->id = 'plugins-check-available-dependencies';
1351         $table->head = array(
1352             get_string('displayname', 'core_plugin'),
1353             get_string('release', 'core_plugin'),
1354             get_string('version', 'core_plugin'),
1355             get_string('supportedmoodleversions', 'core_plugin'),
1356             get_string('info', 'core'),
1357         );
1358         $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1359         $table->data = array();
1361         foreach ($dependencies as $plugin) {
1363             $supportedmoodles = array();
1364             foreach ($plugin->version->supportedmoodles as $moodle) {
1365                 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1366                     $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-success');
1367                 } else {
1368                     $supportedmoodles[] = html_writer::span($moodle->release, 'label');
1369                 }
1370             }
1372             $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1373             if ($requriedby) {
1374                 foreach ($requriedby as $ix => $val) {
1375                     $inf = $pluginman->get_plugin_info($val);
1376                     if ($inf) {
1377                         $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1378                     }
1379                 }
1380                 $info = html_writer::div(
1381                     get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1382                     'requiredby'
1383                 );
1384             } else {
1385                 $info = '';
1386             }
1388             $info .= $this->output->container_start('actions');
1390             $info .= html_writer::div(
1391                 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1392                     get_string('misdepinfoplugin', 'core_plugin')),
1393                 'misdepinfoplugin'
1394             );
1396             $info .= html_writer::div(
1397                 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1398                     get_string('misdepinfoversion', 'core_plugin')),
1399                 'misdepinfoversion'
1400             );
1402             $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')), 'misdepdownload');
1404             if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1405                 $info .= $this->output->single_button(
1406                     new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1407                     get_string('dependencyinstall', 'core_plugin'),
1408                     'post',
1409                     array('class' => 'singlebutton dependencyinstall')
1410                 );
1411             } else {
1412                 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1413                 if ($reasonhelp) {
1414                     $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall');
1415                 }
1416             }
1418             $info .= $this->output->container_end(); // End of .actions container.
1420             $table->data[] = array(
1421                 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component'),
1422                 $plugin->version->release,
1423                 $plugin->version->version,
1424                 implode($supportedmoodles, ' '),
1425                 $info
1426             );
1427         }
1429         return html_writer::table($table);
1430     }
1432     /**
1433      * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1434      *
1435      * @param string $reason the reason code as returned by the plugin manager
1436      * @return string
1437      */
1438     protected function info_remote_plugin_not_installable($reason) {
1440         if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1441             return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1442         }
1444         if ($reason === 'remoteunavailable') {
1445             return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1446         }
1448         return false;
1449     }
1451     /**
1452      * Formats the information that needs to go in the 'Requires' column.
1453      * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1454      * @param core_plugin_manager $pluginman provides data on all the plugins.
1455      * @param string $version
1456      * @return string HTML code
1457      */
1458     protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) {
1460         $requires = array();
1461         $displayuploadlink = false;
1462         $displayupdateslink = false;
1464         foreach ($pluginman->resolve_requirements($plugin, $version) as $reqname => $reqinfo) {
1465             if ($reqname === 'core') {
1466                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1467                     $class = 'requires-ok';
1468                     $label = '';
1469                 } else {
1470                     $class = 'requires-failed';
1471                     $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1472                 }
1473                 $requires[] = html_writer::tag('li',
1474                     html_writer::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires), 'dep dep-core').
1475                     ' '.$label, array('class' => $class));
1477             } else {
1478                 $actions = array();
1480                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1481                     $label = '';
1482                     $class = 'requires-ok';
1484                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1485                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1486                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-warning');
1487                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1488                         $class = 'requires-failed requires-missing requires-available';
1489                         $actions[] = html_writer::link(
1490                             new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1491                             get_string('misdepinfoplugin', 'core_plugin')
1492                         );
1494                     } else {
1495                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
1496                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1497                             'badge badge-danger');
1498                         $class = 'requires-failed requires-missing requires-unavailable';
1499                     }
1500                     $displayuploadlink = true;
1502                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1503                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1504                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-warning');
1505                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1506                         $class = 'requires-failed requires-outdated requires-available';
1507                         $displayupdateslink = true;
1509                     } else {
1510                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1511                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1512                             'badge badge-danger');
1513                         $class = 'requires-failed requires-outdated requires-unavailable';
1514                     }
1515                     $displayuploadlink = true;
1516                 }
1518                 if ($reqinfo->reqver != ANY_VERSION) {
1519                     $str = 'otherpluginversion';
1520                 } else {
1521                     $str = 'otherplugin';
1522                 }
1524                 $requires[] = html_writer::tag('li', html_writer::span(
1525                     get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1526                     'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1527                     array('class' => $class)
1528                 );
1529             }
1530         }
1532         if (!$requires) {
1533             return '';
1534         }
1536         $out = html_writer::tag('ul', implode("\n", $requires));
1538         if ($displayuploadlink) {
1539             $out .= html_writer::div(
1540                 html_writer::link(
1541                     new moodle_url('/admin/tool/installaddon/'),
1542                     get_string('dependencyuploadmissing', 'core_plugin')
1543                 ),
1544                 'dependencyuploadmissing'
1545             );
1546         }
1548         if ($displayupdateslink) {
1549             $out .= html_writer::div(
1550                 html_writer::link(
1551                     new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1552                     get_string('checkforupdates', 'core_plugin')
1553                 ),
1554                 'checkforupdates'
1555             );
1556         }
1558         return $out;
1560     }
1562     /**
1563      * Prints an overview about the plugins - number of installed, number of extensions etc.
1564      *
1565      * @param core_plugin_manager $pluginman provides information about the plugins
1566      * @param array $options filtering options
1567      * @return string as usually
1568      */
1569     public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1571         $plugininfo = $pluginman->get_plugins();
1573         $numtotal = $numextension = $numupdatable = 0;
1575         foreach ($plugininfo as $type => $plugins) {
1576             foreach ($plugins as $name => $plugin) {
1577                 if ($plugin->available_updates()) {
1578                     $numupdatable++;
1579                 }
1580                 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1581                     continue;
1582                 }
1583                 $numtotal++;
1584                 if (!$plugin->is_standard()) {
1585                     $numextension++;
1586                 }
1587             }
1588         }
1590         $infoall = html_writer::link(
1591             new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 0)),
1592             get_string('overviewall', 'core_plugin'),
1593             array('title' => get_string('filterall', 'core_plugin'))
1594         ).' '.html_writer::span($numtotal, 'badge number number-all');
1596         $infoext = html_writer::link(
1597             new moodle_url($this->page->url, array('contribonly' => 1, 'updatesonly' => 0)),
1598             get_string('overviewext', 'core_plugin'),
1599             array('title' => get_string('filtercontribonly', 'core_plugin'))
1600         ).' '.html_writer::span($numextension, 'badge number number-additional');
1602         if ($numupdatable) {
1603             $infoupdatable = html_writer::link(
1604                 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 1)),
1605                 get_string('overviewupdatable', 'core_plugin'),
1606                 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1607             ).' '.html_writer::span($numupdatable, 'badge badge-info number number-updatable');
1608         } else {
1609             // No updates, or the notifications disabled.
1610             $infoupdatable = '';
1611         }
1613         $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
1615         if (!empty($options['updatesonly'])) {
1616             $out .= $this->output->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1617         } else if (!empty($options['contribonly'])) {
1618             $out .= $this->output->heading(get_string('overviewext', 'core_plugin'), 3);
1619         }
1621         if ($numupdatable) {
1622             $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1623             if ($installableupdates) {
1624                 $out .= $this->output->single_button(
1625                     new moodle_url($this->page->url, array('installupdatex' => 1)),
1626                     get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1627                     'post',
1628                     array('class' => 'singlebutton updateavailableinstallall')
1629                 );
1630             }
1631         }
1633         $out .= html_writer::div($infoall, 'info info-all').
1634             html_writer::div($infoext, 'info info-ext').
1635             html_writer::div($infoupdatable, 'info info-updatable');
1637         $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
1639         return $out;
1640     }
1642     /**
1643      * Displays all known plugins and links to manage them
1644      *
1645      * This default implementation renders all plugins into one big table.
1646      *
1647      * @param core_plugin_manager $pluginman provides information about the plugins.
1648      * @param array $options filtering options
1649      * @return string HTML code
1650      */
1651     public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1653         $plugininfo = $pluginman->get_plugins();
1655         // Filter the list of plugins according the options.
1656         if (!empty($options['updatesonly'])) {
1657             $updateable = array();
1658             foreach ($plugininfo as $plugintype => $pluginnames) {
1659                 foreach ($pluginnames as $pluginname => $pluginfo) {
1660                     $pluginavailableupdates = $pluginfo->available_updates();
1661                     if (!empty($pluginavailableupdates)) {
1662                         foreach ($pluginavailableupdates as $pluginavailableupdate) {
1663                             $updateable[$plugintype][$pluginname] = $pluginfo;
1664                         }
1665                     }
1666                 }
1667             }
1668             $plugininfo = $updateable;
1669         }
1671         if (!empty($options['contribonly'])) {
1672             $contribs = array();
1673             foreach ($plugininfo as $plugintype => $pluginnames) {
1674                 foreach ($pluginnames as $pluginname => $pluginfo) {
1675                     if (!$pluginfo->is_standard()) {
1676                         $contribs[$plugintype][$pluginname] = $pluginfo;
1677                     }
1678                 }
1679             }
1680             $plugininfo = $contribs;
1681         }
1683         if (empty($plugininfo)) {
1684             return '';
1685         }
1687         $table = new html_table();
1688         $table->id = 'plugins-control-panel';
1689         $table->head = array(
1690             get_string('displayname', 'core_plugin'),
1691             get_string('version', 'core_plugin'),
1692             get_string('availability', 'core_plugin'),
1693             get_string('actions', 'core_plugin'),
1694             get_string('notes','core_plugin'),
1695         );
1696         $table->headspan = array(1, 1, 1, 2, 1);
1697         $table->colclasses = array(
1698             'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1699         );
1701         foreach ($plugininfo as $type => $plugins) {
1702             $heading = $pluginman->plugintype_name_plural($type);
1703             $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1704             if ($manageurl = $pluginclass::get_manage_url()) {
1705                 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1706                     get_string('settings', 'core_plugin')));
1707             }
1708             $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1709             $header->header = true;
1710             $header->colspan = array_sum($table->headspan);
1711             $header = new html_table_row(array($header));
1712             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1713             $table->data[] = $header;
1715             if (empty($plugins)) {
1716                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1717                 $msg->colspan = array_sum($table->headspan);
1718                 $row = new html_table_row(array($msg));
1719                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1720                 $table->data[] = $row;
1721                 continue;
1722             }
1724             foreach ($plugins as $name => $plugin) {
1725                 $row = new html_table_row();
1726                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1728                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1729                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1730                 } else {
1731                     $icon = $this->output->spacer();
1732                 }
1733                 $status = $plugin->get_status();
1734                 $row->attributes['class'] .= ' status-'.$status;
1735                 $pluginname  = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
1736                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1737                 $pluginname  = new html_table_cell($pluginname);
1739                 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1740                 if ((string)$plugin->release !== '') {
1741                     $version = html_writer::div($plugin->release, 'release').$version;
1742                 }
1743                 $version = new html_table_cell($version);
1745                 $isenabled = $plugin->is_enabled();
1746                 if (is_null($isenabled)) {
1747                     $availability = new html_table_cell('');
1748                 } else if ($isenabled) {
1749                     $row->attributes['class'] .= ' enabled';
1750                     $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1751                 } else {
1752                     $row->attributes['class'] .= ' disabled';
1753                     $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1754                 }
1756                 $settingsurl = $plugin->get_settings_url();
1757                 if (!is_null($settingsurl)) {
1758                     $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1759                 } else {
1760                     $settings = '';
1761                 }
1762                 $settings = new html_table_cell($settings);
1764                 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1765                     $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1766                 } else {
1767                     $uninstall = '';
1768                 }
1769                 $uninstall = new html_table_cell($uninstall);
1771                 if ($plugin->is_standard()) {
1772                     $row->attributes['class'] .= ' standard';
1773                     $source = '';
1774                 } else {
1775                     $row->attributes['class'] .= ' extension';
1776                     $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
1777                 }
1779                 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1780                     $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
1781                 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1782                     $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
1783                 } else {
1784                     $msg = '';
1785                 }
1787                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1788                 if ($requriedby) {
1789                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1790                         array('class' => 'requiredby'));
1791                 } else {
1792                     $requiredby = '';
1793                 }
1795                 $updateinfo = '';
1796                 if (is_array($plugin->available_updates())) {
1797                     foreach ($plugin->available_updates() as $availableupdate) {
1798                         $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1799                     }
1800                 }
1802                 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1804                 $row->cells = array(
1805                     $pluginname, $version, $availability, $settings, $uninstall, $notes
1806                 );
1807                 $table->data[] = $row;
1808             }
1809         }
1811         return html_writer::table($table);
1812     }
1814     /**
1815      * Helper method to render the information about the available plugin update
1816      *
1817      * @param core_plugin_manager $pluginman plugin manager instance
1818      * @param \core\update\info $updateinfo information about the available update for the plugin
1819      */
1820     protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
1822         $boxclasses = 'pluginupdateinfo';
1823         $info = array();
1825         if (isset($updateinfo->release)) {
1826             $info[] = html_writer::div(
1827                 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1828                 'info release'
1829             );
1830         }
1832         if (isset($updateinfo->maturity)) {
1833             $info[] = html_writer::div(
1834                 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1835                 'info maturity'
1836             );
1837             $boxclasses .= ' maturity'.$updateinfo->maturity;
1838         }
1840         if (isset($updateinfo->download)) {
1841             $info[] = html_writer::div(
1842                 html_writer::link($updateinfo->download, get_string('download')),
1843                 'info download'
1844             );
1845         }
1847         if (isset($updateinfo->url)) {
1848             $info[] = html_writer::div(
1849                 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1850                 'info more'
1851             );
1852         }
1854         $box = html_writer::start_div($boxclasses);
1855         $box .= html_writer::div(
1856             get_string('updateavailable', 'core_plugin', $updateinfo->version),
1857             'version'
1858         );
1859         $box .= html_writer::div(
1860             implode(html_writer::span(' ', 'separator'), $info),
1861             'infos'
1862         );
1864         if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason)) {
1865             $box .= $this->output->single_button(
1866                 new moodle_url($this->page->url, array('installupdate' => $updateinfo->component,
1867                     'installupdateversion' => $updateinfo->version)),
1868                 get_string('updateavailableinstall', 'core_admin'),
1869                 'post',
1870                 array('class' => 'singlebutton updateavailableinstall')
1871             );
1872         } else {
1873             $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1874             if ($reasonhelp) {
1875                 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
1876             }
1877         }
1878         $box .= html_writer::end_div();
1880         return $box;
1881     }
1883     /**
1884      * This function will render one beautiful table with all the environmental
1885      * configuration and how it suits Moodle needs.
1886      *
1887      * @param boolean $result final result of the check (true/false)
1888      * @param environment_results[] $environment_results array of results gathered
1889      * @return string HTML to output.
1890      */
1891     public function environment_check_table($result, $environment_results) {
1892         global $CFG;
1894         // Table headers
1895         $servertable = new html_table();//table for server checks
1896         $servertable->head  = array(
1897             get_string('name'),
1898             get_string('info'),
1899             get_string('report'),
1900             get_string('plugin'),
1901             get_string('status'),
1902         );
1903         $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1904         $servertable->attributes['class'] = 'admintable environmenttable generaltable';
1905         $servertable->id = 'serverstatus';
1907         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1909         $othertable = new html_table();//table for custom checks
1910         $othertable->head  = array(
1911             get_string('info'),
1912             get_string('report'),
1913             get_string('plugin'),
1914             get_string('status'),
1915         );
1916         $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1917         $othertable->attributes['class'] = 'admintable environmenttable generaltable';
1918         $othertable->id = 'otherserverstatus';
1920         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1922         // Iterate over each environment_result
1923         $continue = true;
1924         foreach ($environment_results as $environment_result) {
1925             $errorline   = false;
1926             $warningline = false;
1927             $stringtouse = '';
1928             if ($continue) {
1929                 $type = $environment_result->getPart();
1930                 $info = $environment_result->getInfo();
1931                 $status = $environment_result->getStatus();
1932                 $plugin = $environment_result->getPluginName();
1933                 $error_code = $environment_result->getErrorCode();
1934                 // Process Report field
1935                 $rec = new stdClass();
1936                 // Something has gone wrong at parsing time
1937                 if ($error_code) {
1938                     $stringtouse = 'environmentxmlerror';
1939                     $rec->error_code = $error_code;
1940                     $status = get_string('error');
1941                     $errorline = true;
1942                     $continue = false;
1943                 }
1945                 if ($continue) {
1946                     if ($rec->needed = $environment_result->getNeededVersion()) {
1947                         // We are comparing versions
1948                         $rec->current = $environment_result->getCurrentVersion();
1949                         if ($environment_result->getLevel() == 'required') {
1950                             $stringtouse = 'environmentrequireversion';
1951                         } else {
1952                             $stringtouse = 'environmentrecommendversion';
1953                         }
1955                     } else if ($environment_result->getPart() == 'custom_check') {
1956                         // We are checking installed & enabled things
1957                         if ($environment_result->getLevel() == 'required') {
1958                             $stringtouse = 'environmentrequirecustomcheck';
1959                         } else {
1960                             $stringtouse = 'environmentrecommendcustomcheck';
1961                         }
1963                     } else if ($environment_result->getPart() == 'php_setting') {
1964                         if ($status) {
1965                             $stringtouse = 'environmentsettingok';
1966                         } else if ($environment_result->getLevel() == 'required') {
1967                             $stringtouse = 'environmentmustfixsetting';
1968                         } else {
1969                             $stringtouse = 'environmentshouldfixsetting';
1970                         }
1972                     } else {
1973                         if ($environment_result->getLevel() == 'required') {
1974                             $stringtouse = 'environmentrequireinstall';
1975                         } else {
1976                             $stringtouse = 'environmentrecommendinstall';
1977                         }
1978                     }
1980                     // Calculate the status value
1981                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1982                         $status = get_string('bypassed');
1983                         $warningline = true;
1984                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1985                         $status = get_string('restricted');
1986                         $errorline = true;
1987                     } else {
1988                         if ($status) {                                          //Handle ok result (ok)
1989                             $status = get_string('ok');
1990                         } else {
1991                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1992                                 $status = get_string('check');
1993                                 $warningline = true;
1994                             } else {                                            //Handle error result (error)
1995                                 $status = get_string('check');
1996                                 $errorline = true;
1997                             }
1998                         }
1999                     }
2000                 }
2002                 // Build the text
2003                 $linkparts = array();
2004                 $linkparts[] = 'admin/environment';
2005                 $linkparts[] = $type;
2006                 if (!empty($info)){
2007                    $linkparts[] = $info;
2008                 }
2009                 // Plugin environments do not have docs pages yet.
2010                 if (empty($CFG->docroot) or $environment_result->plugin) {
2011                     $report = get_string($stringtouse, 'admin', $rec);
2012                 } else {
2013                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec), true);
2014                 }
2015                 // Enclose report text in div so feedback text will be displayed underneath it.
2016                 $report = html_writer::div($report);
2018                 // Format error or warning line
2019                 if ($errorline) {
2020                     $messagetype = 'error';
2021                     $statusclass = 'badge-danger';
2022                 } else if ($warningline) {
2023                     $messagetype = 'warn';
2024                     $statusclass = 'badge-warning';
2025                 } else {
2026                     $messagetype = 'ok';
2027                     $statusclass = 'badge-success';
2028                 }
2029                 $status = html_writer::span($status, 'label ' . $statusclass);
2030                 // Here we'll store all the feedback found
2031                 $feedbacktext = '';
2032                 // Append the feedback if there is some
2033                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2034                 //Append the bypass if there is some
2035                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2036                 //Append the restrict if there is some
2037                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2039                 $report .= $feedbacktext;
2041                 // Add the row to the table
2042                 if ($environment_result->getPart() == 'custom_check'){
2043                     $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2044                 } else {
2045                     $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2046                 }
2047             }
2048         }
2050         //put errors first in
2051         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2052         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2054         // Print table
2055         $output = '';
2056         $output .= $this->heading(get_string('serverchecks', 'admin'));
2057         $output .= html_writer::table($servertable);
2058         if (count($othertable->data)){
2059             $output .= $this->heading(get_string('customcheck', 'admin'));
2060             $output .= html_writer::table($othertable);
2061         }
2063         // Finally, if any error has happened, print the summary box
2064         if (!$result) {
2065             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2066         }
2068         return $output;
2069     }
2071     /**
2072      * Render a simple page for providing the upgrade key.
2073      *
2074      * @param moodle_url|string $url
2075      * @return string
2076      */
2077     public function upgradekey_form_page($url) {
2079         $output = '';
2080         $output .= $this->header();
2081         $output .= $this->container_start('upgradekeyreq');
2082         $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2083         $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
2084         $output .= html_writer::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
2085         $output .= html_writer::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
2086         $output .= html_writer::end_tag('form');
2087         $output .= $this->container_end();
2088         $output .= $this->footer();
2090         return $output;
2091     }
2093     /**
2094      * Check to see if writing to the deprecated legacy log store is enabled.
2095      *
2096      * @return string An error message if writing to the legacy log store is enabled.
2097      */
2098     protected function legacy_log_store_writing_error() {
2099         $enabled = get_config('logstore_legacy', 'loglegacy');
2100         $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2101         $enabled = $enabled && in_array('logstore_legacy', $plugins);
2103         if ($enabled) {
2104             return $this->warning(get_string('legacylogginginuse'));
2105         }
2106     }
2108     /**
2109      * Display message about the benefits of registering on Moodle.org
2110      *
2111      * @return string
2112      */
2113     public function moodleorg_registration_message() {
2114         return format_text(get_string('registermoodlenet', 'admin'), FORMAT_HTML, ['noclean' => true]);
2115     }