940c33f16d673354f6d40004414b72e4935c7503
[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 alert alert-' . $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), 'danger');
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, 'danger');
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                 'danger');
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, 'danger');
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 = 'danger';
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 && site_is_public()) {
847             if (has_capability('moodle/site:config', context_system::instance())) {
848                 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
849                     get_string('register', 'admin'));
850                 $str = 'registrationwarning';
851             } else {
852                 $registerbutton = '';
853                 $str = 'registrationwarningcontactadmin';
854             }
856             return $this->warning( get_string($str, 'admin')
857                     . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
858                 'error alert alert-danger');
859         }
861         return '';
862     }
864     /**
865      * Return an admin page warning if site is not registered with moodle.org
866      *
867      * @return string
868      */
869     public function warn_if_not_registered() {
870         return $this->registration_warning(\core\hub\registration::is_registered());
871     }
873     /**
874      * Display a warning about the Mobile Web Services being disabled.
875      *
876      * @param boolean $mobileconfigured true if mobile web services are enabled
877      * @return string HTML to output.
878      */
879     protected function mobile_configuration_warning($mobileconfigured) {
880         $output = '';
881         if (!$mobileconfigured) {
882             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
883             $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
884             $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
885         }
887         return $output;
888     }
890     /**
891      * Display a warning about the forgotten password URL not linking to a valid URL.
892      *
893      * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
894      * @return string HTML to output.
895      */
896     protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
897         $output = '';
898         if ($invalidforgottenpasswordurl) {
899             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
900             $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
901             $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
902                 'error alert alert-danger');
903         }
905         return $output;
906     }
908     /**
909      * Helper method to render the information about the available Moodle update
910      *
911      * @param \core\update\info $updateinfo information about the available Moodle core update
912      */
913     protected function moodle_available_update_info(\core\update\info $updateinfo) {
915         $boxclasses = 'moodleupdateinfo';
916         $info = array();
918         if (isset($updateinfo->release)) {
919             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
920                 array('class' => 'info release'));
921         }
923         if (isset($updateinfo->version)) {
924             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
925                 array('class' => 'info version'));
926         }
928         if (isset($updateinfo->maturity)) {
929             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
930                 array('class' => 'info maturity'));
931             $boxclasses .= ' maturity'.$updateinfo->maturity;
932         }
934         if (isset($updateinfo->download)) {
935             $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
936         }
938         if (isset($updateinfo->url)) {
939             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
940                 array('class' => 'info more'));
941         }
943         $box  = $this->output->box_start($boxclasses);
944         $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
945         $box .= $this->output->box_end();
947         return $box;
948     }
950     /**
951      * Display a link to the release notes.
952      * @return string HTML to output.
953      */
954     protected function release_notes_link() {
955         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
956         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
957         return $this->box($releasenoteslink, 'generalbox alert alert-info');
958     }
960     /**
961      * Display the reload link that appears on several upgrade/install pages.
962      * @return string HTML to output.
963      */
964     function upgrade_reload($url) {
965         return html_writer::empty_tag('br') .
966                 html_writer::tag('div',
967                     html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
968                             get_string('reload'), array('title' => get_string('reload'))),
969                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
970     }
972     /**
973      * Displays all known plugins and information about their installation or upgrade
974      *
975      * This default implementation renders all plugins into one big table. The rendering
976      * options support:
977      *     (bool)full = false: whether to display up-to-date plugins, too
978      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
979      *
980      * @param core_plugin_manager $pluginman provides information about the plugins.
981      * @param int $version the version of the Moodle code from version.php.
982      * @param array $options rendering options
983      * @return string HTML code
984      */
985     public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
987         $plugininfo = $pluginman->get_plugins();
989         if (empty($plugininfo)) {
990             return '';
991         }
993         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
994         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
996         $table = new html_table();
997         $table->id = 'plugins-check';
998         $table->head = array(
999             get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
1000             get_string('versiondb', 'core_plugin'),
1001             get_string('versiondisk', 'core_plugin'),
1002             get_string('requires', 'core_plugin'),
1003             get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
1004         );
1005         $table->colclasses = array(
1006             'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
1007         );
1008         $table->data = array();
1010         // Number of displayed plugins per type.
1011         $numdisplayed = array();
1012         // Number of plugins known to the plugin manager.
1013         $sumtotal = 0;
1014         // Number of plugins requiring attention.
1015         $sumattention = 0;
1016         // List of all components we can cancel installation of.
1017         $installabortable = $pluginman->list_cancellable_installations();
1018         // List of all components we can cancel upgrade of.
1019         $upgradeabortable = $pluginman->list_restorable_archives();
1021         foreach ($plugininfo as $type => $plugins) {
1023             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
1024             $header->header = true;
1025             $header->colspan = count($table->head);
1026             $header = new html_table_row(array($header));
1027             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1029             $numdisplayed[$type] = 0;
1031             if (empty($plugins) and $options['full']) {
1032                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1033                 $msg->colspan = count($table->head);
1034                 $row = new html_table_row(array($msg));
1035                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1036                 $table->data[] = $header;
1037                 $table->data[] = $row;
1038                 continue;
1039             }
1041             $plugintyperows = array();
1043             foreach ($plugins as $name => $plugin) {
1044                 $sumtotal++;
1045                 $row = new html_table_row();
1046                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1048                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1049                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
1050                 } else {
1051                     $icon = '';
1052                 }
1054                 $displayname = new html_table_cell(
1055                     $icon.
1056                     html_writer::span($plugin->displayname, 'pluginname').
1057                     html_writer::div($plugin->get_dir(), 'plugindir')
1058                 );
1060                 $versiondb = new html_table_cell($plugin->versiondb);
1061                 $versiondisk = new html_table_cell($plugin->versiondisk);
1063                 if ($isstandard = $plugin->is_standard()) {
1064                     $row->attributes['class'] .= ' standard';
1065                     $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext badge badge-secondary');
1066                 } else {
1067                     $row->attributes['class'] .= ' extension';
1068                     $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
1069                 }
1071                 $coredependency = $plugin->is_core_dependency_satisfied($version);
1072                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1073                 $dependenciesok = $coredependency && $otherpluginsdependencies;
1075                 $statuscode = $plugin->get_status();
1076                 $row->attributes['class'] .= ' status-' . $statuscode;
1077                 $statusclass = 'statustext badge ';
1078                 switch ($statuscode) {
1079                     case core_plugin_manager::PLUGIN_STATUS_NEW:
1080                         $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
1081                         break;
1082                     case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
1083                         $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
1084                         break;
1085                     case core_plugin_manager::PLUGIN_STATUS_MISSING:
1086                     case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1087                     case core_plugin_manager::PLUGIN_STATUS_DELETE:
1088                         $statusclass .= 'badge-danger';
1089                         break;
1090                     case core_plugin_manager::PLUGIN_STATUS_NODB:
1091                     case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
1092                         $statusclass .= $dependenciesok ? '' : 'badge-warning';
1093                         break;
1094                 }
1095                 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1097                 if (!empty($installabortable[$plugin->component])) {
1098                     $status .= $this->output->single_button(
1099                         new moodle_url($this->page->url, array('abortinstall' => $plugin->component)),
1100                         get_string('cancelinstallone', 'core_plugin'),
1101                         'post',
1102                         array('class' => 'actionbutton cancelinstallone')
1103                     );
1104                 }
1106                 if (!empty($upgradeabortable[$plugin->component])) {
1107                     $status .= $this->output->single_button(
1108                         new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
1109                         get_string('cancelupgradeone', 'core_plugin'),
1110                         'post',
1111                         array('class' => 'actionbutton cancelupgradeone')
1112                     );
1113                 }
1115                 $availableupdates = $plugin->available_updates();
1116                 if (!empty($availableupdates)) {
1117                     foreach ($availableupdates as $availableupdate) {
1118                         $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1119                     }
1120                 }
1122                 $status = new html_table_cell($sourcelabel.' '.$status);
1124                 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1126                 $statusisboring = in_array($statuscode, array(
1127                         core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
1129                 if ($options['xdep']) {
1130                     // we want to see only plugins with failed dependencies
1131                     if ($dependenciesok) {
1132                         continue;
1133                     }
1135                 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1136                     // no change is going to happen to the plugin - display it only
1137                     // if the user wants to see the full list
1138                     if (empty($options['full'])) {
1139                         continue;
1140                     }
1142                 } else {
1143                     $sumattention++;
1144                 }
1146                 // The plugin should be displayed.
1147                 $numdisplayed[$type]++;
1148                 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1149                 $plugintyperows[] = $row;
1150             }
1152             if (empty($numdisplayed[$type]) and empty($options['full'])) {
1153                 continue;
1154             }
1156             $table->data[] = $header;
1157             $table->data = array_merge($table->data, $plugintyperows);
1158         }
1160         // Total number of displayed plugins.
1161         $sumdisplayed = array_sum($numdisplayed);
1163         if ($options['xdep']) {
1164             // At the plugins dependencies check page, display the table only.
1165             return html_writer::table($table);
1166         }
1168         $out = $this->output->container_start('', 'plugins-check-info');
1170         if ($sumdisplayed == 0) {
1171             $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1173         } else {
1174             if (empty($options['full'])) {
1175                 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1176             } else {
1177                 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1178             }
1179         }
1181         $out .= $this->output->container_start('actions');
1183         $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1184         if ($installableupdates) {
1185             $out .= $this->output->single_button(
1186                 new moodle_url($this->page->url, array('installupdatex' => 1)),
1187                 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1188                 'post',
1189                 array('class' => 'singlebutton updateavailableinstallall')
1190             );
1191         }
1193         if ($installabortable) {
1194             $out .= $this->output->single_button(
1195                 new moodle_url($this->page->url, array('abortinstallx' => 1)),
1196                 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1197                 'post',
1198                 array('class' => 'singlebutton cancelinstallall')
1199             );
1200         }
1202         if ($upgradeabortable) {
1203             $out .= $this->output->single_button(
1204                 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1205                 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1206                 'post',
1207                 array('class' => 'singlebutton cancelupgradeall')
1208             );
1209         }
1211         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1212             get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge'));
1214         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1215             get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge'));
1217         $out .= $this->output->container_end(); // End of .actions container.
1218         $out .= $this->output->container_end(); // End of #plugins-check-info container.
1220         if ($sumdisplayed > 0 or $options['full']) {
1221             $out .= html_writer::table($table);
1222         }
1224         return $out;
1225     }
1227     /**
1228      * Display the continue / cancel widgets for the plugins management pages.
1229      *
1230      * @param null|moodle_url $continue URL for the continue button, should it be displayed
1231      * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1232      * @return string HTML
1233      */
1234     public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
1236         $out = html_writer::start_div('plugins-management-confirm-buttons');
1238         if (!empty($continue)) {
1239             $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1240         }
1242         if (empty($cancel)) {
1243             $cancel = $this->page->url;
1244         }
1245         $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1247         return $out;
1248     }
1250     /**
1251      * Displays the information about missing dependencies
1252      *
1253      * @param core_plugin_manager $pluginman
1254      * @return string
1255      */
1256     protected function missing_dependencies(core_plugin_manager $pluginman) {
1258         $dependencies = $pluginman->missing_dependencies();
1260         if (empty($dependencies)) {
1261             return '';
1262         }
1264         $available = array();
1265         $unavailable = array();
1266         $unknown = array();
1268         foreach ($dependencies as $component => $remoteinfo) {
1269             if ($remoteinfo === false) {
1270                 // The required version is not available. Let us check if there
1271                 // is at least some version in the plugins directory.
1272                 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1273                 if ($remoteinfoanyversion === false) {
1274                     $unknown[$component] = $component;
1275                 } else {
1276                     $unavailable[$component] = $remoteinfoanyversion;
1277                 }
1278             } else {
1279                 $available[$component] = $remoteinfo;
1280             }
1281         }
1283         $out  = $this->output->container_start('plugins-check-dependencies');
1285         if ($unavailable or $unknown) {
1286             $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1287             if ($unknown) {
1288                 $out .= $this->output->notification(get_string('misdepsunknownlist', 'core_plugin', implode($unknown, ', ')));
1289             }
1290             if ($unavailable) {
1291                 $unavailablelist = array();
1292                 foreach ($unavailable as $component => $remoteinfoanyversion) {
1293                     $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1294                         '<strong>'.$remoteinfoanyversion->name.'</strong>');
1295                     if ($remoteinfoanyversion->version) {
1296                         $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1297                     } else {
1298                         $unavailablelistitem .= ' ('.$component.')';
1299                     }
1300                     $unavailablelist[] = $unavailablelistitem;
1301                 }
1302                 $out .= $this->output->notification(get_string('misdepsunavaillist', 'core_plugin',
1303                     implode($unavailablelist, ', ')));
1304             }
1305             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1306             $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1307                 get_string('dependencyuploadmissing', 'core_plugin'));
1308             $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1309         }
1311         if ($available) {
1312             $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
1313             $out .= $this->output->container_start('plugins-check-dependencies-actions');
1315             $installable = $pluginman->filter_installable($available);
1316             if ($installable) {
1317                 $out .= $this->output->single_button(
1318                     new moodle_url($this->page->url, array('installdepx' => 1)),
1319                     get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1320                     'post',
1321                     array('class' => 'singlebutton dependencyinstallmissing')
1322                 );
1323             }
1325             $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1326                 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1328             $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1330             $out .= $this->available_missing_dependencies_list($pluginman, $available);
1331         }
1333         $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
1335         return $out;
1336     }
1338     /**
1339      * Displays the list if available missing dependencies.
1340      *
1341      * @param core_plugin_manager $pluginman
1342      * @param array $dependencies
1343      * @return string
1344      */
1345     protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1346         global $CFG;
1348         $table = new html_table();
1349         $table->id = 'plugins-check-available-dependencies';
1350         $table->head = array(
1351             get_string('displayname', 'core_plugin'),
1352             get_string('release', 'core_plugin'),
1353             get_string('version', 'core_plugin'),
1354             get_string('supportedmoodleversions', 'core_plugin'),
1355             get_string('info', 'core'),
1356         );
1357         $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1358         $table->data = array();
1360         foreach ($dependencies as $plugin) {
1362             $supportedmoodles = array();
1363             foreach ($plugin->version->supportedmoodles as $moodle) {
1364                 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1365                     $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-success');
1366                 } else {
1367                     $supportedmoodles[] = html_writer::span($moodle->release, 'label');
1368                 }
1369             }
1371             $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1372             if ($requriedby) {
1373                 foreach ($requriedby as $ix => $val) {
1374                     $inf = $pluginman->get_plugin_info($val);
1375                     if ($inf) {
1376                         $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1377                     }
1378                 }
1379                 $info = html_writer::div(
1380                     get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1381                     'requiredby'
1382                 );
1383             } else {
1384                 $info = '';
1385             }
1387             $info .= $this->output->container_start('actions');
1389             $info .= html_writer::div(
1390                 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1391                     get_string('misdepinfoplugin', 'core_plugin')),
1392                 'misdepinfoplugin'
1393             );
1395             $info .= html_writer::div(
1396                 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1397                     get_string('misdepinfoversion', 'core_plugin')),
1398                 'misdepinfoversion'
1399             );
1401             $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')), 'misdepdownload');
1403             if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1404                 $info .= $this->output->single_button(
1405                     new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1406                     get_string('dependencyinstall', 'core_plugin'),
1407                     'post',
1408                     array('class' => 'singlebutton dependencyinstall')
1409                 );
1410             } else {
1411                 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1412                 if ($reasonhelp) {
1413                     $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall');
1414                 }
1415             }
1417             $info .= $this->output->container_end(); // End of .actions container.
1419             $table->data[] = array(
1420                 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component'),
1421                 $plugin->version->release,
1422                 $plugin->version->version,
1423                 implode($supportedmoodles, ' '),
1424                 $info
1425             );
1426         }
1428         return html_writer::table($table);
1429     }
1431     /**
1432      * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1433      *
1434      * @param string $reason the reason code as returned by the plugin manager
1435      * @return string
1436      */
1437     protected function info_remote_plugin_not_installable($reason) {
1439         if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1440             return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1441         }
1443         if ($reason === 'remoteunavailable') {
1444             return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1445         }
1447         return false;
1448     }
1450     /**
1451      * Formats the information that needs to go in the 'Requires' column.
1452      * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1453      * @param core_plugin_manager $pluginman provides data on all the plugins.
1454      * @param string $version
1455      * @return string HTML code
1456      */
1457     protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) {
1459         $requires = array();
1460         $displayuploadlink = false;
1461         $displayupdateslink = false;
1463         foreach ($pluginman->resolve_requirements($plugin, $version) as $reqname => $reqinfo) {
1464             if ($reqname === 'core') {
1465                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1466                     $class = 'requires-ok';
1467                     $label = '';
1468                 } else {
1469                     $class = 'requires-failed';
1470                     $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1471                 }
1472                 if ($reqinfo->reqver != ANY_VERSION) {
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));
1476                 }
1478             } else {
1479                 $actions = array();
1481                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1482                     $label = '';
1483                     $class = 'requires-ok';
1485                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1486                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1487                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-warning');
1488                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1489                         $class = 'requires-failed requires-missing requires-available';
1490                         $actions[] = html_writer::link(
1491                             new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1492                             get_string('misdepinfoplugin', 'core_plugin')
1493                         );
1495                     } else {
1496                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
1497                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1498                             'badge badge-danger');
1499                         $class = 'requires-failed requires-missing requires-unavailable';
1500                     }
1501                     $displayuploadlink = true;
1503                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1504                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1505                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-warning');
1506                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1507                         $class = 'requires-failed requires-outdated requires-available';
1508                         $displayupdateslink = true;
1510                     } else {
1511                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1512                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1513                             'badge badge-danger');
1514                         $class = 'requires-failed requires-outdated requires-unavailable';
1515                     }
1516                     $displayuploadlink = true;
1517                 }
1519                 if ($reqinfo->reqver != ANY_VERSION) {
1520                     $str = 'otherpluginversion';
1521                 } else {
1522                     $str = 'otherplugin';
1523                 }
1525                 $requires[] = html_writer::tag('li', html_writer::span(
1526                     get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1527                     'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1528                     array('class' => $class)
1529                 );
1530             }
1531         }
1533         if (!$requires) {
1534             return '';
1535         }
1537         $out = html_writer::tag('ul', implode("\n", $requires));
1539         if ($displayuploadlink) {
1540             $out .= html_writer::div(
1541                 html_writer::link(
1542                     new moodle_url('/admin/tool/installaddon/'),
1543                     get_string('dependencyuploadmissing', 'core_plugin')
1544                 ),
1545                 'dependencyuploadmissing'
1546             );
1547         }
1549         if ($displayupdateslink) {
1550             $out .= html_writer::div(
1551                 html_writer::link(
1552                     new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1553                     get_string('checkforupdates', 'core_plugin')
1554                 ),
1555                 'checkforupdates'
1556             );
1557         }
1559         return $out;
1561     }
1563     /**
1564      * Prints an overview about the plugins - number of installed, number of extensions etc.
1565      *
1566      * @param core_plugin_manager $pluginman provides information about the plugins
1567      * @param array $options filtering options
1568      * @return string as usually
1569      */
1570     public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1572         $plugininfo = $pluginman->get_plugins();
1574         $numtotal = $numextension = $numupdatable = 0;
1576         foreach ($plugininfo as $type => $plugins) {
1577             foreach ($plugins as $name => $plugin) {
1578                 if ($plugin->available_updates()) {
1579                     $numupdatable++;
1580                 }
1581                 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1582                     continue;
1583                 }
1584                 $numtotal++;
1585                 if (!$plugin->is_standard()) {
1586                     $numextension++;
1587                 }
1588             }
1589         }
1591         $infoall = html_writer::link(
1592             new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 0)),
1593             get_string('overviewall', 'core_plugin'),
1594             array('title' => get_string('filterall', 'core_plugin'))
1595         ).' '.html_writer::span($numtotal, 'badge number number-all');
1597         $infoext = html_writer::link(
1598             new moodle_url($this->page->url, array('contribonly' => 1, 'updatesonly' => 0)),
1599             get_string('overviewext', 'core_plugin'),
1600             array('title' => get_string('filtercontribonly', 'core_plugin'))
1601         ).' '.html_writer::span($numextension, 'badge number number-additional');
1603         if ($numupdatable) {
1604             $infoupdatable = html_writer::link(
1605                 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 1)),
1606                 get_string('overviewupdatable', 'core_plugin'),
1607                 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1608             ).' '.html_writer::span($numupdatable, 'badge badge-info number number-updatable');
1609         } else {
1610             // No updates, or the notifications disabled.
1611             $infoupdatable = '';
1612         }
1614         $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
1616         if (!empty($options['updatesonly'])) {
1617             $out .= $this->output->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1618         } else if (!empty($options['contribonly'])) {
1619             $out .= $this->output->heading(get_string('overviewext', 'core_plugin'), 3);
1620         }
1622         if ($numupdatable) {
1623             $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1624             if ($installableupdates) {
1625                 $out .= $this->output->single_button(
1626                     new moodle_url($this->page->url, array('installupdatex' => 1)),
1627                     get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1628                     'post',
1629                     array('class' => 'singlebutton updateavailableinstallall')
1630                 );
1631             }
1632         }
1634         $out .= html_writer::div($infoall, 'info info-all').
1635             html_writer::div($infoext, 'info info-ext').
1636             html_writer::div($infoupdatable, 'info info-updatable');
1638         $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
1640         return $out;
1641     }
1643     /**
1644      * Displays all known plugins and links to manage them
1645      *
1646      * This default implementation renders all plugins into one big table.
1647      *
1648      * @param core_plugin_manager $pluginman provides information about the plugins.
1649      * @param array $options filtering options
1650      * @return string HTML code
1651      */
1652     public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1654         $plugininfo = $pluginman->get_plugins();
1656         // Filter the list of plugins according the options.
1657         if (!empty($options['updatesonly'])) {
1658             $updateable = array();
1659             foreach ($plugininfo as $plugintype => $pluginnames) {
1660                 foreach ($pluginnames as $pluginname => $pluginfo) {
1661                     $pluginavailableupdates = $pluginfo->available_updates();
1662                     if (!empty($pluginavailableupdates)) {
1663                         foreach ($pluginavailableupdates as $pluginavailableupdate) {
1664                             $updateable[$plugintype][$pluginname] = $pluginfo;
1665                         }
1666                     }
1667                 }
1668             }
1669             $plugininfo = $updateable;
1670         }
1672         if (!empty($options['contribonly'])) {
1673             $contribs = array();
1674             foreach ($plugininfo as $plugintype => $pluginnames) {
1675                 foreach ($pluginnames as $pluginname => $pluginfo) {
1676                     if (!$pluginfo->is_standard()) {
1677                         $contribs[$plugintype][$pluginname] = $pluginfo;
1678                     }
1679                 }
1680             }
1681             $plugininfo = $contribs;
1682         }
1684         if (empty($plugininfo)) {
1685             return '';
1686         }
1688         $table = new html_table();
1689         $table->id = 'plugins-control-panel';
1690         $table->head = array(
1691             get_string('displayname', 'core_plugin'),
1692             get_string('version', 'core_plugin'),
1693             get_string('availability', 'core_plugin'),
1694             get_string('actions', 'core_plugin'),
1695             get_string('notes','core_plugin'),
1696         );
1697         $table->headspan = array(1, 1, 1, 2, 1);
1698         $table->colclasses = array(
1699             'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1700         );
1702         foreach ($plugininfo as $type => $plugins) {
1703             $heading = $pluginman->plugintype_name_plural($type);
1704             $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1705             if ($manageurl = $pluginclass::get_manage_url()) {
1706                 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1707                     get_string('settings', 'core_plugin')));
1708             }
1709             $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1710             $header->header = true;
1711             $header->colspan = array_sum($table->headspan);
1712             $header = new html_table_row(array($header));
1713             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1714             $table->data[] = $header;
1716             if (empty($plugins)) {
1717                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1718                 $msg->colspan = array_sum($table->headspan);
1719                 $row = new html_table_row(array($msg));
1720                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1721                 $table->data[] = $row;
1722                 continue;
1723             }
1725             foreach ($plugins as $name => $plugin) {
1726                 $row = new html_table_row();
1727                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1729                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1730                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1731                 } else {
1732                     $icon = $this->output->spacer();
1733                 }
1734                 $status = $plugin->get_status();
1735                 $row->attributes['class'] .= ' status-'.$status;
1736                 $pluginname  = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
1737                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1738                 $pluginname  = new html_table_cell($pluginname);
1740                 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1741                 if ((string)$plugin->release !== '') {
1742                     $version = html_writer::div($plugin->release, 'release').$version;
1743                 }
1744                 $version = new html_table_cell($version);
1746                 $isenabled = $plugin->is_enabled();
1747                 if (is_null($isenabled)) {
1748                     $availability = new html_table_cell('');
1749                 } else if ($isenabled) {
1750                     $row->attributes['class'] .= ' enabled';
1751                     $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1752                 } else {
1753                     $row->attributes['class'] .= ' disabled';
1754                     $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1755                 }
1757                 $settingsurl = $plugin->get_settings_url();
1758                 if (!is_null($settingsurl)) {
1759                     $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1760                 } else {
1761                     $settings = '';
1762                 }
1763                 $settings = new html_table_cell($settings);
1765                 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1766                     $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1767                 } else {
1768                     $uninstall = '';
1769                 }
1770                 $uninstall = new html_table_cell($uninstall);
1772                 if ($plugin->is_standard()) {
1773                     $row->attributes['class'] .= ' standard';
1774                     $source = '';
1775                 } else {
1776                     $row->attributes['class'] .= ' extension';
1777                     $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
1778                 }
1780                 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1781                     $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
1782                 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1783                     $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
1784                 } else {
1785                     $msg = '';
1786                 }
1788                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1789                 if ($requriedby) {
1790                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1791                         array('class' => 'requiredby'));
1792                 } else {
1793                     $requiredby = '';
1794                 }
1796                 $updateinfo = '';
1797                 if (is_array($plugin->available_updates())) {
1798                     foreach ($plugin->available_updates() as $availableupdate) {
1799                         $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1800                     }
1801                 }
1803                 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1805                 $row->cells = array(
1806                     $pluginname, $version, $availability, $settings, $uninstall, $notes
1807                 );
1808                 $table->data[] = $row;
1809             }
1810         }
1812         return html_writer::table($table);
1813     }
1815     /**
1816      * Helper method to render the information about the available plugin update
1817      *
1818      * @param core_plugin_manager $pluginman plugin manager instance
1819      * @param \core\update\info $updateinfo information about the available update for the plugin
1820      */
1821     protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
1823         $boxclasses = 'pluginupdateinfo';
1824         $info = array();
1826         if (isset($updateinfo->release)) {
1827             $info[] = html_writer::div(
1828                 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1829                 'info release'
1830             );
1831         }
1833         if (isset($updateinfo->maturity)) {
1834             $info[] = html_writer::div(
1835                 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1836                 'info maturity'
1837             );
1838             $boxclasses .= ' maturity'.$updateinfo->maturity;
1839         }
1841         if (isset($updateinfo->download)) {
1842             $info[] = html_writer::div(
1843                 html_writer::link($updateinfo->download, get_string('download')),
1844                 'info download'
1845             );
1846         }
1848         if (isset($updateinfo->url)) {
1849             $info[] = html_writer::div(
1850                 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1851                 'info more'
1852             );
1853         }
1855         $box = html_writer::start_div($boxclasses);
1856         $box .= html_writer::div(
1857             get_string('updateavailable', 'core_plugin', $updateinfo->version),
1858             'version'
1859         );
1860         $box .= html_writer::div(
1861             implode(html_writer::span(' ', 'separator'), $info),
1862             'infos'
1863         );
1865         if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason)) {
1866             $box .= $this->output->single_button(
1867                 new moodle_url($this->page->url, array('installupdate' => $updateinfo->component,
1868                     'installupdateversion' => $updateinfo->version)),
1869                 get_string('updateavailableinstall', 'core_admin'),
1870                 'post',
1871                 array('class' => 'singlebutton updateavailableinstall')
1872             );
1873         } else {
1874             $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1875             if ($reasonhelp) {
1876                 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
1877             }
1878         }
1879         $box .= html_writer::end_div();
1881         return $box;
1882     }
1884     /**
1885      * This function will render one beautiful table with all the environmental
1886      * configuration and how it suits Moodle needs.
1887      *
1888      * @param boolean $result final result of the check (true/false)
1889      * @param environment_results[] $environment_results array of results gathered
1890      * @return string HTML to output.
1891      */
1892     public function environment_check_table($result, $environment_results) {
1893         global $CFG;
1895         // Table headers
1896         $servertable = new html_table();//table for server checks
1897         $servertable->head  = array(
1898             get_string('name'),
1899             get_string('info'),
1900             get_string('report'),
1901             get_string('plugin'),
1902             get_string('status'),
1903         );
1904         $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1905         $servertable->attributes['class'] = 'admintable environmenttable generaltable';
1906         $servertable->id = 'serverstatus';
1908         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1910         $othertable = new html_table();//table for custom checks
1911         $othertable->head  = array(
1912             get_string('info'),
1913             get_string('report'),
1914             get_string('plugin'),
1915             get_string('status'),
1916         );
1917         $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1918         $othertable->attributes['class'] = 'admintable environmenttable generaltable';
1919         $othertable->id = 'otherserverstatus';
1921         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1923         // Iterate over each environment_result
1924         $continue = true;
1925         foreach ($environment_results as $environment_result) {
1926             $errorline   = false;
1927             $warningline = false;
1928             $stringtouse = '';
1929             if ($continue) {
1930                 $type = $environment_result->getPart();
1931                 $info = $environment_result->getInfo();
1932                 $status = $environment_result->getStatus();
1933                 $plugin = $environment_result->getPluginName();
1934                 $error_code = $environment_result->getErrorCode();
1935                 // Process Report field
1936                 $rec = new stdClass();
1937                 // Something has gone wrong at parsing time
1938                 if ($error_code) {
1939                     $stringtouse = 'environmentxmlerror';
1940                     $rec->error_code = $error_code;
1941                     $status = get_string('error');
1942                     $errorline = true;
1943                     $continue = false;
1944                 }
1946                 if ($continue) {
1947                     if ($rec->needed = $environment_result->getNeededVersion()) {
1948                         // We are comparing versions
1949                         $rec->current = $environment_result->getCurrentVersion();
1950                         if ($environment_result->getLevel() == 'required') {
1951                             $stringtouse = 'environmentrequireversion';
1952                         } else {
1953                             $stringtouse = 'environmentrecommendversion';
1954                         }
1956                     } else if ($environment_result->getPart() == 'custom_check') {
1957                         // We are checking installed & enabled things
1958                         if ($environment_result->getLevel() == 'required') {
1959                             $stringtouse = 'environmentrequirecustomcheck';
1960                         } else {
1961                             $stringtouse = 'environmentrecommendcustomcheck';
1962                         }
1964                     } else if ($environment_result->getPart() == 'php_setting') {
1965                         if ($status) {
1966                             $stringtouse = 'environmentsettingok';
1967                         } else if ($environment_result->getLevel() == 'required') {
1968                             $stringtouse = 'environmentmustfixsetting';
1969                         } else {
1970                             $stringtouse = 'environmentshouldfixsetting';
1971                         }
1973                     } else {
1974                         if ($environment_result->getLevel() == 'required') {
1975                             $stringtouse = 'environmentrequireinstall';
1976                         } else {
1977                             $stringtouse = 'environmentrecommendinstall';
1978                         }
1979                     }
1981                     // Calculate the status value
1982                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
1983                         $status = get_string('bypassed');
1984                         $warningline = true;
1985                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
1986                         $status = get_string('restricted');
1987                         $errorline = true;
1988                     } else {
1989                         if ($status) {                                          //Handle ok result (ok)
1990                             $status = get_string('ok');
1991                         } else {
1992                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1993                                 $status = get_string('check');
1994                                 $warningline = true;
1995                             } else {                                            //Handle error result (error)
1996                                 $status = get_string('check');
1997                                 $errorline = true;
1998                             }
1999                         }
2000                     }
2001                 }
2003                 // Build the text
2004                 $linkparts = array();
2005                 $linkparts[] = 'admin/environment';
2006                 $linkparts[] = $type;
2007                 if (!empty($info)){
2008                    $linkparts[] = $info;
2009                 }
2010                 // Plugin environments do not have docs pages yet.
2011                 if (empty($CFG->docroot) or $environment_result->plugin) {
2012                     $report = get_string($stringtouse, 'admin', $rec);
2013                 } else {
2014                     $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec), true);
2015                 }
2016                 // Enclose report text in div so feedback text will be displayed underneath it.
2017                 $report = html_writer::div($report);
2019                 // Format error or warning line
2020                 if ($errorline) {
2021                     $messagetype = 'error';
2022                     $statusclass = 'badge-danger';
2023                 } else if ($warningline) {
2024                     $messagetype = 'warn';
2025                     $statusclass = 'badge-warning';
2026                 } else {
2027                     $messagetype = 'ok';
2028                     $statusclass = 'badge-success';
2029                 }
2030                 $status = html_writer::span($status, 'badge ' . $statusclass);
2031                 // Here we'll store all the feedback found
2032                 $feedbacktext = '';
2033                 // Append the feedback if there is some
2034                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2035                 //Append the bypass if there is some
2036                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2037                 //Append the restrict if there is some
2038                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2040                 $report .= $feedbacktext;
2042                 // Add the row to the table
2043                 if ($environment_result->getPart() == 'custom_check'){
2044                     $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2045                 } else {
2046                     $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2047                 }
2048             }
2049         }
2051         //put errors first in
2052         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2053         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2055         // Print table
2056         $output = '';
2057         $output .= $this->heading(get_string('serverchecks', 'admin'));
2058         $output .= html_writer::table($servertable);
2059         if (count($othertable->data)){
2060             $output .= $this->heading(get_string('customcheck', 'admin'));
2061             $output .= html_writer::table($othertable);
2062         }
2064         // Finally, if any error has happened, print the summary box
2065         if (!$result) {
2066             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2067         }
2069         return $output;
2070     }
2072     /**
2073      * Render a simple page for providing the upgrade key.
2074      *
2075      * @param moodle_url|string $url
2076      * @return string
2077      */
2078     public function upgradekey_form_page($url) {
2080         $output = '';
2081         $output .= $this->header();
2082         $output .= $this->container_start('upgradekeyreq');
2083         $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2084         $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
2085         $output .= html_writer::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
2086         $output .= html_writer::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
2087         $output .= html_writer::end_tag('form');
2088         $output .= $this->container_end();
2089         $output .= $this->footer();
2091         return $output;
2092     }
2094     /**
2095      * Check to see if writing to the deprecated legacy log store is enabled.
2096      *
2097      * @return string An error message if writing to the legacy log store is enabled.
2098      */
2099     protected function legacy_log_store_writing_error() {
2100         $enabled = get_config('logstore_legacy', 'loglegacy');
2101         $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2102         $enabled = $enabled && in_array('logstore_legacy', $plugins);
2104         if ($enabled) {
2105             return $this->warning(get_string('legacylogginginuse'));
2106         }
2107     }
2109     /**
2110      * Display message about the benefits of registering on Moodle.org
2111      *
2112      * @return string
2113      */
2114     public function moodleorg_registration_message() {
2116         $out = format_text(get_string('registerwithmoodleorginfo', 'core_hub'), FORMAT_MARKDOWN);
2118         $out .= html_writer::link(
2119             new moodle_url('/admin/settings.php', ['section' => 'moodleservices']),
2120             $this->output->pix_icon('i/info', '').' '.get_string('registerwithmoodleorginfoapp', 'core_hub'),
2121             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2122         );
2124         $out .= html_writer::link(
2125             HUB_MOODLEORGHUBURL,
2126             $this->output->pix_icon('i/stats', '').' '.get_string('registerwithmoodleorginfostats', 'core_hub'),
2127             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2128         );
2130         $out .= html_writer::link(
2131             HUB_MOODLEORGHUBURL.'/sites',
2132             $this->output->pix_icon('i/location', '').' '.get_string('registerwithmoodleorginfosites', 'core_hub'),
2133             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2134         );
2136         return $this->output->box($out);
2137     }