Merge branch 'MDL-68631' of https://github.com/jonof/moodle
[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                     'alert alert-warning mt-2');
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 mb-4');
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),
372                     'lasttimefetched small text-muted mt-1');
373             }
374             $output .= $this->container_end();
375         }
377         return $output;
378     }
380     /**
381      * Display a page to confirm the plugin uninstallation.
382      *
383      * @param core_plugin_manager $pluginman
384      * @param \core\plugininfo\base $pluginfo
385      * @param moodle_url $continueurl URL to continue after confirmation
386      * @param moodle_url $cancelurl URL to to go if cancelled
387      * @return string
388      */
389     public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
390         $output = '';
392         $pluginname = $pluginman->plugin_name($pluginfo->component);
394         $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
395         if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
396             $confirm .= $extraconfirm;
397         }
399         $output .= $this->output->header();
400         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
401         $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
402         $output .= $this->output->footer();
404         return $output;
405     }
407     /**
408      * Display a page with results of plugin uninstallation and offer removal of plugin files.
409      *
410      * @param core_plugin_manager $pluginman
411      * @param \core\plugininfo\base $pluginfo
412      * @param progress_trace_buffer $progress
413      * @param moodle_url $continueurl URL to continue to remove the plugin folder
414      * @return string
415      */
416     public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
417                                                             progress_trace_buffer $progress, moodle_url $continueurl) {
418         $output = '';
420         $pluginname = $pluginman->plugin_name($pluginfo->component);
422         // Do not show navigation here, they must click one of the buttons.
423         $this->page->set_pagelayout('maintenance');
424         $this->page->set_cacheable(false);
426         $output .= $this->output->header();
427         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
429         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
431         $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
432             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
434         if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
435             $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
436                 'alert alert-warning mt-2');
437         }
439         // After any uninstall we must execute full upgrade to finish the cleanup!
440         $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
441         $output .= $this->output->footer();
443         return $output;
444     }
446     /**
447      * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
448      *
449      * @param core_plugin_manager $pluginman
450      * @param \core\plugininfo\base $pluginfo
451      * @param progress_trace_buffer $progress
452      * @return string
453      */
454     public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
455         $output = '';
457         $pluginname = $pluginfo->component;
459         $output .= $this->output->header();
460         $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
462         $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
464         $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
465             array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
466         $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
467         $output .= $this->output->footer();
469         return $output;
470     }
472     /**
473      * Display the plugin management page (admin/environment.php).
474      * @param array $versions
475      * @param string $version
476      * @param boolean $envstatus final result of env check (true/false)
477      * @param array $environment_results array of results gathered
478      * @return string HTML to output.
479      */
480     public function environment_check_page($versions, $version, $envstatus, $environment_results) {
481         $output = '';
482         $output .= $this->header();
484         // Print the component download link
485         $output .= html_writer::tag('div', html_writer::link(
486                     new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
487                     get_string('updatecomponent', 'admin')),
488                 array('class' => 'reportlink'));
490         // Heading.
491         $output .= $this->heading(get_string('environment', 'admin'));
493         // Box with info and a menu to choose the version.
494         $output .= $this->box_start();
495         $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
496         $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
497         $select->label = get_string('moodleversion');
498         $output .= $this->render($select);
499         $output .= $this->box_end();
501         // The results
502         $output .= $this->environment_check_table($envstatus, $environment_results);
504         $output .= $this->footer();
505         return $output;
506     }
508     /**
509      * Output a warning message, of the type that appears on the admin notifications page.
510      * @param string $message the message to display.
511      * @param string $type type class
512      * @return string HTML to output.
513      */
514     protected function warning($message, $type = 'warning') {
515         return $this->box($message, 'generalbox alert alert-' . $type);
516     }
518     /**
519      * Render an appropriate message if dataroot is insecure.
520      * @param bool $insecuredataroot
521      * @return string HTML to output.
522      */
523     protected function insecure_dataroot_warning($insecuredataroot) {
524         global $CFG;
526         if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
527             return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
529         } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
530             return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'danger');
532         } else {
533             return '';
534         }
535     }
537     /**
538      * Render a warning that a directory with development libs is present.
539      *
540      * @param bool $devlibdir True if the warning should be displayed.
541      * @return string
542      */
543     protected function development_libs_directories_warning($devlibdir) {
545         if ($devlibdir) {
546             $moreinfo = new moodle_url('/report/security/index.php');
547             $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
548             return $this->warning($warning, 'danger');
550         } else {
551             return '';
552         }
553     }
555     /**
556      * Render an appropriate message if dataroot is insecure.
557      * @param bool $errorsdisplayed
558      * @return string HTML to output.
559      */
560     protected function display_errors_warning($errorsdisplayed) {
561         if (!$errorsdisplayed) {
562             return '';
563         }
565         return $this->warning(get_string('displayerrorswarning', 'admin'));
566     }
568     /**
569      * Render an appropriate message if themdesignermode is enabled.
570      * @param bool $themedesignermode true if enabled
571      * @return string HTML to output.
572      */
573     protected function themedesignermode_warning($themedesignermode) {
574         if (!$themedesignermode) {
575             return '';
576         }
578         return $this->warning(get_string('themedesignermodewarning', 'admin'));
579     }
581     /**
582      * Render an appropriate message if iconv is buggy and mbstring missing.
583      * @param bool $buggyiconvnomb
584      * @return string HTML to output.
585      */
586     protected function buggy_iconv_warning($buggyiconvnomb) {
587         if (!$buggyiconvnomb) {
588             return '';
589         }
591         return $this->warning(get_string('warningiconvbuggy', 'admin'));
592     }
594     /**
595      * Render an appropriate message if cron has not been run recently.
596      * @param bool $cronoverdue
597      * @return string HTML to output.
598      */
599     public function cron_overdue_warning($cronoverdue) {
600         global $CFG;
601         if (!$cronoverdue) {
602             return '';
603         }
605         $check = new \tool_task\check\cronrunning();
606         $result = $check->get_result();
607         return $this->warning($result->get_summary() . '&nbsp;' . $this->help_icon('cron', 'admin'));
608     }
610     /**
611      * Render an appropriate message if cron is not being run frequently (recommended every minute).
612      *
613      * @param bool $croninfrequent
614      * @return string HTML to output.
615      */
616     public function cron_infrequent_warning(bool $croninfrequent) : string {
617         global $CFG;
619         if (!$croninfrequent) {
620             return '';
621         }
623         $check = new \tool_task\check\cronrunning();
624         $result = $check->get_result();
625         return $this->warning($result->get_summary() . '&nbsp;' . $this->help_icon('cron', 'admin'));
626     }
628     /**
629      * Render an appropriate message if there are any problems with the DB set-up.
630      * @param bool $dbproblems
631      * @return string HTML to output.
632      */
633     public function db_problems($dbproblems) {
634         if (!$dbproblems) {
635             return '';
636         }
638         return $this->warning($dbproblems);
639     }
641     /**
642      * Renders cache warnings if there are any.
643      *
644      * @param string[] $cachewarnings
645      * @return string
646      */
647     public function cache_warnings(array $cachewarnings) {
648         if (!count($cachewarnings)) {
649             return '';
650         }
651         return join("\n", array_map(array($this, 'warning'), $cachewarnings));
652     }
654     /**
655      * Renders events 1 API handlers warning.
656      *
657      * @param array $eventshandlers
658      * @return string
659      */
660     public function events_handlers($eventshandlers) {
661         if ($eventshandlers) {
662             $components = '';
663             foreach ($eventshandlers as $eventhandler) {
664                 $components .= $eventhandler->component . ', ';
665             }
666             $components = rtrim($components, ', ');
667             return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
668         }
669     }
671     /**
672      * Render an appropriate message if the site in in maintenance mode.
673      * @param bool $maintenancemode
674      * @return string HTML to output.
675      */
676     public function maintenance_mode_warning($maintenancemode) {
677         if (!$maintenancemode) {
678             return '';
679         }
681         $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
682         $url = $url->out(); // get_string() does not support objects in params
684         return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
685     }
687     /**
688      * Render a warning that ssl is forced because the site was on loginhttps.
689      *
690      * @param bool $overridetossl Whether or not ssl is being forced.
691      * @return string
692      */
693     protected function overridetossl_warning($overridetossl) {
694         if (!$overridetossl) {
695             return '';
696         }
697         $warning = get_string('overridetossl', 'core_admin');
698         return $this->warning($warning, 'warning');
699     }
701     /**
702      * Display a warning about installing development code if necesary.
703      * @param int $maturity
704      * @return string HTML to output.
705      */
706     protected function maturity_warning($maturity) {
707         if ($maturity == MATURITY_STABLE) {
708             return ''; // No worries.
709         }
711         $maturitylevel = get_string('maturity' . $maturity, 'admin');
712         return $this->warning(
713                     $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
714                     $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
715                 'danger');
716     }
718     /*
719      * If necessary, displays a warning about upgrading a test site.
720      *
721      * @param string $testsite
722      * @return string HTML
723      */
724     protected function test_site_warning($testsite) {
726         if (!$testsite) {
727             return '';
728         }
730         $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
731         return $this->warning($warning, 'danger');
732     }
734     /**
735      * Output the copyright notice.
736      * @return string HTML to output.
737      */
738     protected function moodle_copyright() {
739         global $CFG;
741         //////////////////////////////////////////////////////////////////////////////////////////////////
742         ////  IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
743         $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
744                          '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
745                          'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
746                          'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
747                          '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
748         //////////////////////////////////////////////////////////////////////////////////////////////////
750         return $this->box($copyrighttext, 'copyright');
751     }
753     /**
754      * Display a warning about installing development code if necesary.
755      * @param int $maturity
756      * @return string HTML to output.
757      */
758     protected function maturity_info($maturity) {
759         if ($maturity == MATURITY_STABLE) {
760             return ''; // No worries.
761         }
763         $level = 'warning';
765         if ($maturity == MATURITY_ALPHA) {
766             $level = 'danger';
767         }
769         $maturitylevel = get_string('maturity' . $maturity, 'admin');
770         $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
771         $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
772         return $this->warning($warningtext, $level);
773     }
775     /**
776      * Displays the info about available Moodle core and plugin updates
777      *
778      * The structure of the $updates param has changed since 2.4. It contains not only updates
779      * for the core itself, but also for all other installed plugins.
780      *
781      * @param array|null $updates array of (string)component => array of \core\update\info objects or null
782      * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
783      * @return string
784      */
785     protected function available_updates($updates, $fetch) {
787         $updateinfo = '';
788         $someupdateavailable = false;
789         if (is_array($updates)) {
790             if (is_array($updates['core'])) {
791                 $someupdateavailable = true;
792                 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
793                 foreach ($updates['core'] as $update) {
794                     $updateinfo .= $this->moodle_available_update_info($update);
795                 }
796                 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
797                     array('class' => 'updateavailablerecommendation'));
798             }
799             unset($updates['core']);
800             // If something has left in the $updates array now, it is updates for plugins.
801             if (!empty($updates)) {
802                 $someupdateavailable = true;
803                 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
804                 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
805                 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
806                     array('url' => $pluginsoverviewurl->out())));
807             }
808         }
810         if (!$someupdateavailable) {
811             $now = time();
812             if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
813                 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
814             }
815         }
817         $updateinfo .= $this->container_start('checkforupdates mt-1');
818         $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
819         $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
820         if ($fetch) {
821             $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
822                 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
823         }
824         $updateinfo .= $this->container_end();
826         return $this->warning($updateinfo);
827     }
829     /**
830      * Display a warning about not being registered on Moodle.org if necesary.
831      *
832      * @param boolean $registered true if the site is registered on Moodle.org
833      * @return string HTML to output.
834      */
835     protected function registration_warning($registered) {
837         if (!$registered && site_is_public()) {
838             if (has_capability('moodle/site:config', context_system::instance())) {
839                 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
840                     get_string('register', 'admin'));
841                 $str = 'registrationwarning';
842             } else {
843                 $registerbutton = '';
844                 $str = 'registrationwarningcontactadmin';
845             }
847             return $this->warning( get_string($str, 'admin')
848                     . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
849                 'error alert alert-danger');
850         }
852         return '';
853     }
855     /**
856      * Return an admin page warning if site is not registered with moodle.org
857      *
858      * @return string
859      */
860     public function warn_if_not_registered() {
861         return $this->registration_warning(\core\hub\registration::is_registered());
862     }
864     /**
865      * Display a warning about the Mobile Web Services being disabled.
866      *
867      * @param boolean $mobileconfigured true if mobile web services are enabled
868      * @return string HTML to output.
869      */
870     protected function mobile_configuration_warning($mobileconfigured) {
871         $output = '';
872         if (!$mobileconfigured) {
873             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
874             $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
875             $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
876         }
878         return $output;
879     }
881     /**
882      * Display a warning about the forgotten password URL not linking to a valid URL.
883      *
884      * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
885      * @return string HTML to output.
886      */
887     protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
888         $output = '';
889         if ($invalidforgottenpasswordurl) {
890             $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
891             $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
892             $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
893                 'error alert alert-danger');
894         }
896         return $output;
897     }
899     /**
900      * Helper method to render the information about the available Moodle update
901      *
902      * @param \core\update\info $updateinfo information about the available Moodle core update
903      */
904     protected function moodle_available_update_info(\core\update\info $updateinfo) {
906         $boxclasses = 'moodleupdateinfo mb-2';
907         $info = array();
909         if (isset($updateinfo->release)) {
910             $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
911                 array('class' => 'info release'));
912         }
914         if (isset($updateinfo->version)) {
915             $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
916                 array('class' => 'info version'));
917         }
919         if (isset($updateinfo->maturity)) {
920             $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
921                 array('class' => 'info maturity'));
922             $boxclasses .= ' maturity'.$updateinfo->maturity;
923         }
925         if (isset($updateinfo->download)) {
926             $info[] = html_writer::link($updateinfo->download, get_string('download'),
927                 array('class' => 'info download btn btn-secondary'));
928         }
930         if (isset($updateinfo->url)) {
931             $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
932                 array('class' => 'info more'));
933         }
935         $box  = $this->output->container_start($boxclasses);
936         $box .= $this->output->container(implode(html_writer::tag('span', ' | ', array('class' => 'separator')), $info), '');
937         $box .= $this->output->container_end();
939         return $box;
940     }
942     /**
943      * Display a link to the release notes.
944      * @return string HTML to output.
945      */
946     protected function release_notes_link() {
947         $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
948         $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
949         return $this->box($releasenoteslink, 'generalbox alert alert-info');
950     }
952     /**
953      * Display the reload link that appears on several upgrade/install pages.
954      * @return string HTML to output.
955      */
956     function upgrade_reload($url) {
957         return html_writer::empty_tag('br') .
958                 html_writer::tag('div',
959                     html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
960                             get_string('reload'), array('title' => get_string('reload'))),
961                 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
962     }
964     /**
965      * Displays all known plugins and information about their installation or upgrade
966      *
967      * This default implementation renders all plugins into one big table. The rendering
968      * options support:
969      *     (bool)full = false: whether to display up-to-date plugins, too
970      *     (bool)xdep = false: display the plugins with unsatisified dependecies only
971      *
972      * @param core_plugin_manager $pluginman provides information about the plugins.
973      * @param int $version the version of the Moodle code from version.php.
974      * @param array $options rendering options
975      * @return string HTML code
976      */
977     public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
978         global $CFG;
979         $plugininfo = $pluginman->get_plugins();
981         if (empty($plugininfo)) {
982             return '';
983         }
985         $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
986         $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
988         $table = new html_table();
989         $table->id = 'plugins-check';
990         $table->head = array(
991             get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
992             get_string('versiondb', 'core_plugin'),
993             get_string('versiondisk', 'core_plugin'),
994             get_string('requires', 'core_plugin'),
995             get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
996         );
997         $table->colclasses = array(
998             'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
999         );
1000         $table->data = array();
1002         // Number of displayed plugins per type.
1003         $numdisplayed = array();
1004         // Number of plugins known to the plugin manager.
1005         $sumtotal = 0;
1006         // Number of plugins requiring attention.
1007         $sumattention = 0;
1008         // List of all components we can cancel installation of.
1009         $installabortable = $pluginman->list_cancellable_installations();
1010         // List of all components we can cancel upgrade of.
1011         $upgradeabortable = $pluginman->list_restorable_archives();
1013         foreach ($plugininfo as $type => $plugins) {
1015             $header = new html_table_cell($pluginman->plugintype_name_plural($type));
1016             $header->header = true;
1017             $header->colspan = count($table->head);
1018             $header = new html_table_row(array($header));
1019             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1021             $numdisplayed[$type] = 0;
1023             if (empty($plugins) and $options['full']) {
1024                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1025                 $msg->colspan = count($table->head);
1026                 $row = new html_table_row(array($msg));
1027                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1028                 $table->data[] = $header;
1029                 $table->data[] = $row;
1030                 continue;
1031             }
1033             $plugintyperows = array();
1035             foreach ($plugins as $name => $plugin) {
1036                 $sumtotal++;
1037                 $row = new html_table_row();
1038                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1040                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1041                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
1042                 } else {
1043                     $icon = '';
1044                 }
1046                 $displayname = new html_table_cell(
1047                     $icon.
1048                     html_writer::span($plugin->displayname, 'pluginname').
1049                     html_writer::div($plugin->get_dir(), 'plugindir text-muted small')
1050                 );
1052                 $versiondb = new html_table_cell($plugin->versiondb);
1053                 $versiondisk = new html_table_cell($plugin->versiondisk);
1055                 if ($isstandard = $plugin->is_standard()) {
1056                     $row->attributes['class'] .= ' standard';
1057                     $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext badge badge-secondary');
1058                 } else {
1059                     $row->attributes['class'] .= ' extension';
1060                     $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
1061                 }
1063                 $coredependency = $plugin->is_core_dependency_satisfied($version);
1064                 $incompatibledependency = $plugin->is_core_compatible_satisfied($CFG->branch);
1066                 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1067                 $dependenciesok = $coredependency && $otherpluginsdependencies && $incompatibledependency;
1069                 $statuscode = $plugin->get_status();
1070                 $row->attributes['class'] .= ' status-' . $statuscode;
1071                 $statusclass = 'statustext badge ';
1072                 switch ($statuscode) {
1073                     case core_plugin_manager::PLUGIN_STATUS_NEW:
1074                         $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
1075                         break;
1076                     case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
1077                         $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
1078                         break;
1079                     case core_plugin_manager::PLUGIN_STATUS_MISSING:
1080                     case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1081                     case core_plugin_manager::PLUGIN_STATUS_DELETE:
1082                         $statusclass .= 'badge-danger';
1083                         break;
1084                     case core_plugin_manager::PLUGIN_STATUS_NODB:
1085                     case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
1086                         $statusclass .= $dependenciesok ? 'badge-light' : 'badge-warning';
1087                         break;
1088                 }
1089                 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1091                 if (!empty($installabortable[$plugin->component])) {
1092                     $status .= $this->output->single_button(
1093                         new moodle_url($this->page->url, array('abortinstall' => $plugin->component)),
1094                         get_string('cancelinstallone', 'core_plugin'),
1095                         'post',
1096                         array('class' => 'actionbutton cancelinstallone d-block mt-1')
1097                     );
1098                 }
1100                 if (!empty($upgradeabortable[$plugin->component])) {
1101                     $status .= $this->output->single_button(
1102                         new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
1103                         get_string('cancelupgradeone', 'core_plugin'),
1104                         'post',
1105                         array('class' => 'actionbutton cancelupgradeone d-block mt-1')
1106                     );
1107                 }
1109                 $availableupdates = $plugin->available_updates();
1110                 if (!empty($availableupdates)) {
1111                     foreach ($availableupdates as $availableupdate) {
1112                         $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1113                     }
1114                 }
1116                 $status = new html_table_cell($sourcelabel.' '.$status);
1117                 if ($plugin->pluginsupported != null) {
1118                     $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version, $CFG->branch));
1119                 } else {
1120                     $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1121                 }
1123                 $statusisboring = in_array($statuscode, array(
1124                         core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
1126                 if ($options['xdep']) {
1127                     // we want to see only plugins with failed dependencies
1128                     if ($dependenciesok) {
1129                         continue;
1130                     }
1132                 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1133                     // no change is going to happen to the plugin - display it only
1134                     // if the user wants to see the full list
1135                     if (empty($options['full'])) {
1136                         continue;
1137                     }
1139                 } else {
1140                     $sumattention++;
1141                 }
1143                 // The plugin should be displayed.
1144                 $numdisplayed[$type]++;
1145                 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1146                 $plugintyperows[] = $row;
1147             }
1149             if (empty($numdisplayed[$type]) and empty($options['full'])) {
1150                 continue;
1151             }
1153             $table->data[] = $header;
1154             $table->data = array_merge($table->data, $plugintyperows);
1155         }
1157         // Total number of displayed plugins.
1158         $sumdisplayed = array_sum($numdisplayed);
1160         if ($options['xdep']) {
1161             // At the plugins dependencies check page, display the table only.
1162             return html_writer::table($table);
1163         }
1165         $out = $this->output->container_start('', 'plugins-check-info');
1167         if ($sumdisplayed == 0) {
1168             $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1170         } else {
1171             if (empty($options['full'])) {
1172                 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1173             } else {
1174                 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1175             }
1176         }
1178         $out .= $this->output->container_start('actions mb-2');
1180         $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1181         if ($installableupdates) {
1182             $out .= $this->output->single_button(
1183                 new moodle_url($this->page->url, array('installupdatex' => 1)),
1184                 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1185                 'post',
1186                 array('class' => 'singlebutton updateavailableinstallall mr-1')
1187             );
1188         }
1190         if ($installabortable) {
1191             $out .= $this->output->single_button(
1192                 new moodle_url($this->page->url, array('abortinstallx' => 1)),
1193                 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1194                 'post',
1195                 array('class' => 'singlebutton cancelinstallall mr-1')
1196             );
1197         }
1199         if ($upgradeabortable) {
1200             $out .= $this->output->single_button(
1201                 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1202                 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1203                 'post',
1204                 array('class' => 'singlebutton cancelupgradeall mr-1')
1205             );
1206         }
1208         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1209             get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge badge-light'),
1210             'btn btn-link mr-1');
1212         $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1213             get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge badge-light'),
1214             'btn btn-link mr-1');
1216         $out .= $this->output->container_end(); // End of .actions container.
1217         $out .= $this->output->container_end(); // End of #plugins-check-info container.
1219         if ($sumdisplayed > 0 or $options['full']) {
1220             $out .= html_writer::table($table);
1221         }
1223         return $out;
1224     }
1226     /**
1227      * Display the continue / cancel widgets for the plugins management pages.
1228      *
1229      * @param null|moodle_url $continue URL for the continue button, should it be displayed
1230      * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1231      * @return string HTML
1232      */
1233     public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
1235         $out = html_writer::start_div('plugins-management-confirm-buttons');
1237         if (!empty($continue)) {
1238             $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1239         }
1241         if (empty($cancel)) {
1242             $cancel = $this->page->url;
1243         }
1244         $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1246         return $out;
1247     }
1249     /**
1250      * Displays the information about missing dependencies
1251      *
1252      * @param core_plugin_manager $pluginman
1253      * @return string
1254      */
1255     protected function missing_dependencies(core_plugin_manager $pluginman) {
1257         $dependencies = $pluginman->missing_dependencies();
1259         if (empty($dependencies)) {
1260             return '';
1261         }
1263         $available = array();
1264         $unavailable = array();
1265         $unknown = array();
1267         foreach ($dependencies as $component => $remoteinfo) {
1268             if ($remoteinfo === false) {
1269                 // The required version is not available. Let us check if there
1270                 // is at least some version in the plugins directory.
1271                 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1272                 if ($remoteinfoanyversion === false) {
1273                     $unknown[$component] = $component;
1274                 } else {
1275                     $unavailable[$component] = $remoteinfoanyversion;
1276                 }
1277             } else {
1278                 $available[$component] = $remoteinfo;
1279             }
1280         }
1282         $out  = $this->output->container_start('plugins-check-dependencies mb-4');
1284         if ($unavailable or $unknown) {
1285             $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1286             if ($unknown) {
1287                 $out .= $this->output->render((new \core\output\notification(get_string('misdepsunknownlist', 'core_plugin',
1288                     implode(', ', $unknown))))->set_show_closebutton(false));
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->render((new \core\output\notification(get_string('misdepsunavaillist', 'core_plugin',
1303                     implode(', ', $unavailablelist))))->set_show_closebutton(false));
1304             }
1305             $out .= $this->output->container_start('plugins-check-dependencies-actions mb-4');
1306             $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1307                 get_string('dependencyuploadmissing', 'core_plugin'), array('class' => 'btn btn-secondary'));
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 mb-2');
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 d-inline-block mr-1')
1322                 );
1323             }
1325             $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1326                 get_string('dependencyuploadmissing', 'core_plugin'), array('class' => 'btn btn-link')),
1327                 'dependencyuploadmissing d-inline-block mr-1');
1329             $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1331             $out .= $this->available_missing_dependencies_list($pluginman, $available);
1332         }
1334         $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
1336         return $out;
1337     }
1339     /**
1340      * Displays the list if available missing dependencies.
1341      *
1342      * @param core_plugin_manager $pluginman
1343      * @param array $dependencies
1344      * @return string
1345      */
1346     protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1347         global $CFG;
1349         $table = new html_table();
1350         $table->id = 'plugins-check-available-dependencies';
1351         $table->head = array(
1352             get_string('displayname', 'core_plugin'),
1353             get_string('release', 'core_plugin'),
1354             get_string('version', 'core_plugin'),
1355             get_string('supportedmoodleversions', 'core_plugin'),
1356             get_string('info', 'core'),
1357         );
1358         $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1359         $table->data = array();
1361         foreach ($dependencies as $plugin) {
1363             $supportedmoodles = array();
1364             foreach ($plugin->version->supportedmoodles as $moodle) {
1365                 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1366                     $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-success');
1367                 } else {
1368                     $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-light');
1369                 }
1370             }
1372             $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1373             if ($requriedby) {
1374                 foreach ($requriedby as $ix => $val) {
1375                     $inf = $pluginman->get_plugin_info($val);
1376                     if ($inf) {
1377                         $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1378                     }
1379                 }
1380                 $info = html_writer::div(
1381                     get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1382                     'requiredby mb-1'
1383                 );
1384             } else {
1385                 $info = '';
1386             }
1388             $info .= $this->output->container_start('actions');
1390             $info .= html_writer::div(
1391                 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1392                     get_string('misdepinfoplugin', 'core_plugin')),
1393                 'misdepinfoplugin d-inline-block mr-3 mb-1'
1394             );
1396             $info .= html_writer::div(
1397                 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1398                     get_string('misdepinfoversion', 'core_plugin')),
1399                 'misdepinfoversion d-inline-block mr-3 mb-1'
1400             );
1402             $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')),
1403                 'misdepdownload d-inline-block mr-3 mb-1');
1405             if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1406                 $info .= $this->output->single_button(
1407                     new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1408                     get_string('dependencyinstall', 'core_plugin'),
1409                     'post',
1410                     array('class' => 'singlebutton dependencyinstall mr-3 mb-1')
1411                 );
1412             } else {
1413                 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1414                 if ($reasonhelp) {
1415                     $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall d-inline-block mr-3 mb-1');
1416                 }
1417             }
1419             $info .= $this->output->container_end(); // End of .actions container.
1421             $table->data[] = array(
1422                 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component text-muted small'),
1423                 $plugin->version->release,
1424                 $plugin->version->version,
1425                 implode(' ', $supportedmoodles),
1426                 $info
1427             );
1428         }
1430         return html_writer::table($table);
1431     }
1433     /**
1434      * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1435      *
1436      * @param string $reason the reason code as returned by the plugin manager
1437      * @return string
1438      */
1439     protected function info_remote_plugin_not_installable($reason) {
1441         if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1442             return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1443         }
1445         if ($reason === 'remoteunavailable') {
1446             return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1447         }
1449         return false;
1450     }
1452     /**
1453      * Formats the information that needs to go in the 'Requires' column.
1454      * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1455      * @param core_plugin_manager $pluginman provides data on all the plugins.
1456      * @param string $version
1457      * @param int $branch the current Moodle branch
1458      * @return string HTML code
1459      */
1460     protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version, $branch = null) {
1462         $requires = array();
1463         $displayuploadlink = false;
1464         $displayupdateslink = false;
1466         $requirements = $pluginman->resolve_requirements($plugin, $version, $branch);
1467         foreach ($requirements as $reqname => $reqinfo) {
1468             if ($reqname === 'core') {
1469                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1470                     $class = 'requires-ok text-muted';
1471                     $label = '';
1472                 } else {
1473                     $class = 'requires-failed';
1474                     $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1475                 }
1477                 if ($branch != null && !$plugin->is_core_compatible_satisfied($branch)) {
1478                     $requires[] = html_writer::tag('li',
1479                     html_writer::span(get_string('incompatibleversion', 'core_plugin', $branch), 'dep dep-core').
1480                     ' '.$label, array('class' => $class));
1482                 } else if ($branch != null && $plugin->pluginsupported != null) {
1483                     $requires[] = html_writer::tag('li',
1484                         html_writer::span(get_string('moodlebranch', 'core_plugin',
1485                         array('min' => $plugin->pluginsupported[0], 'max' => $plugin->pluginsupported[1])), 'dep dep-core').
1486                         ' '.$label, array('class' => $class));
1488                 } else if ($reqinfo->reqver != ANY_VERSION) {
1489                     $requires[] = html_writer::tag('li',
1490                         html_writer::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires), 'dep dep-core').
1491                         ' '.$label, array('class' => $class));
1492                 }
1494             } else {
1495                 $actions = array();
1497                 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1498                     $label = '';
1499                     $class = 'requires-ok text-muted';
1501                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1502                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1503                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-warning');
1504                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1505                         $class = 'requires-failed requires-missing requires-available';
1506                         $actions[] = html_writer::link(
1507                             new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1508                             get_string('misdepinfoplugin', 'core_plugin')
1509                         );
1511                     } else {
1512                         $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
1513                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1514                             'badge badge-danger');
1515                         $class = 'requires-failed requires-missing requires-unavailable';
1516                     }
1517                     $displayuploadlink = true;
1519                 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1520                     if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1521                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-warning');
1522                         $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1523                         $class = 'requires-failed requires-outdated requires-available';
1524                         $displayupdateslink = true;
1526                     } else {
1527                         $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1528                         $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1529                             'badge badge-danger');
1530                         $class = 'requires-failed requires-outdated requires-unavailable';
1531                     }
1532                     $displayuploadlink = true;
1533                 }
1535                 if ($reqinfo->reqver != ANY_VERSION) {
1536                     $str = 'otherpluginversion';
1537                 } else {
1538                     $str = 'otherplugin';
1539                 }
1541                 $requires[] = html_writer::tag('li', html_writer::span(
1542                     get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1543                     'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1544                     array('class' => $class)
1545                 );
1546             }
1547         }
1549         if (!$requires) {
1550             return '';
1551         }
1553         $out = html_writer::tag('ul', implode("\n", $requires), array('class' => 'm-0'));
1555         if ($displayuploadlink) {
1556             $out .= html_writer::div(
1557                 html_writer::link(
1558                     new moodle_url('/admin/tool/installaddon/'),
1559                     get_string('dependencyuploadmissing', 'core_plugin'),
1560                     array('class' => 'btn btn-secondary btn-sm m-1')
1561                 ),
1562                 'dependencyuploadmissing'
1563             );
1564         }
1566         if ($displayupdateslink) {
1567             $out .= html_writer::div(
1568                 html_writer::link(
1569                     new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1570                     get_string('checkforupdates', 'core_plugin'),
1571                     array('class' => 'btn btn-secondary btn-sm m-1')
1572                 ),
1573                 'checkforupdates'
1574             );
1575         }
1577         // Check if supports is present, and $branch is not in, only if $incompatible check was ok.
1578         if ($plugin->pluginsupported != null && $class == 'requires-ok' && $branch != null) {
1579             if ($pluginman->check_explicitly_supported($plugin, $branch) == $pluginman::VERSION_NOT_SUPPORTED) {
1580                 $out .= html_writer::div(get_string('notsupported', 'core_plugin', $branch));
1581             }
1582         }
1584         return $out;
1586     }
1588     /**
1589      * Prints an overview about the plugins - number of installed, number of extensions etc.
1590      *
1591      * @param core_plugin_manager $pluginman provides information about the plugins
1592      * @param array $options filtering options
1593      * @return string as usually
1594      */
1595     public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1597         $plugininfo = $pluginman->get_plugins();
1599         $numtotal = $numextension = $numupdatable = 0;
1601         foreach ($plugininfo as $type => $plugins) {
1602             foreach ($plugins as $name => $plugin) {
1603                 if ($plugin->available_updates()) {
1604                     $numupdatable++;
1605                 }
1606                 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1607                     continue;
1608                 }
1609                 $numtotal++;
1610                 if (!$plugin->is_standard()) {
1611                     $numextension++;
1612                 }
1613             }
1614         }
1616         $infoall = html_writer::link(
1617             new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 0)),
1618             get_string('overviewall', 'core_plugin'),
1619             array('title' => get_string('filterall', 'core_plugin'))
1620         ).' '.html_writer::span($numtotal, 'badge number number-all');
1622         $infoext = html_writer::link(
1623             new moodle_url($this->page->url, array('contribonly' => 1, 'updatesonly' => 0)),
1624             get_string('overviewext', 'core_plugin'),
1625             array('title' => get_string('filtercontribonly', 'core_plugin'))
1626         ).' '.html_writer::span($numextension, 'badge number number-additional');
1628         if ($numupdatable) {
1629             $infoupdatable = html_writer::link(
1630                 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 1)),
1631                 get_string('overviewupdatable', 'core_plugin'),
1632                 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1633             ).' '.html_writer::span($numupdatable, 'badge badge-info number number-updatable');
1634         } else {
1635             // No updates, or the notifications disabled.
1636             $infoupdatable = '';
1637         }
1639         $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
1641         if (!empty($options['updatesonly'])) {
1642             $out .= $this->output->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1643         } else if (!empty($options['contribonly'])) {
1644             $out .= $this->output->heading(get_string('overviewext', 'core_plugin'), 3);
1645         }
1647         if ($numupdatable) {
1648             $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1649             if ($installableupdates) {
1650                 $out .= $this->output->single_button(
1651                     new moodle_url($this->page->url, array('installupdatex' => 1)),
1652                     get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1653                     'post',
1654                     array('class' => 'singlebutton updateavailableinstallall')
1655                 );
1656             }
1657         }
1659         $out .= html_writer::div($infoall, 'info info-all').
1660             html_writer::div($infoext, 'info info-ext').
1661             html_writer::div($infoupdatable, 'info info-updatable');
1663         $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
1665         return $out;
1666     }
1668     /**
1669      * Displays all known plugins and links to manage them
1670      *
1671      * This default implementation renders all plugins into one big table.
1672      *
1673      * @param core_plugin_manager $pluginman provides information about the plugins.
1674      * @param array $options filtering options
1675      * @return string HTML code
1676      */
1677     public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1679         $plugininfo = $pluginman->get_plugins();
1681         // Filter the list of plugins according the options.
1682         if (!empty($options['updatesonly'])) {
1683             $updateable = array();
1684             foreach ($plugininfo as $plugintype => $pluginnames) {
1685                 foreach ($pluginnames as $pluginname => $pluginfo) {
1686                     $pluginavailableupdates = $pluginfo->available_updates();
1687                     if (!empty($pluginavailableupdates)) {
1688                         foreach ($pluginavailableupdates as $pluginavailableupdate) {
1689                             $updateable[$plugintype][$pluginname] = $pluginfo;
1690                         }
1691                     }
1692                 }
1693             }
1694             $plugininfo = $updateable;
1695         }
1697         if (!empty($options['contribonly'])) {
1698             $contribs = array();
1699             foreach ($plugininfo as $plugintype => $pluginnames) {
1700                 foreach ($pluginnames as $pluginname => $pluginfo) {
1701                     if (!$pluginfo->is_standard()) {
1702                         $contribs[$plugintype][$pluginname] = $pluginfo;
1703                     }
1704                 }
1705             }
1706             $plugininfo = $contribs;
1707         }
1709         if (empty($plugininfo)) {
1710             return '';
1711         }
1713         $table = new html_table();
1714         $table->id = 'plugins-control-panel';
1715         $table->head = array(
1716             get_string('displayname', 'core_plugin'),
1717             get_string('version', 'core_plugin'),
1718             get_string('availability', 'core_plugin'),
1719             get_string('actions', 'core_plugin'),
1720             get_string('notes','core_plugin'),
1721         );
1722         $table->headspan = array(1, 1, 1, 2, 1);
1723         $table->colclasses = array(
1724             'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1725         );
1727         foreach ($plugininfo as $type => $plugins) {
1728             $heading = $pluginman->plugintype_name_plural($type);
1729             $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1730             if ($manageurl = $pluginclass::get_manage_url()) {
1731                 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1732                     get_string('settings', 'core_plugin')));
1733             }
1734             $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1735             $header->header = true;
1736             $header->colspan = array_sum($table->headspan);
1737             $header = new html_table_row(array($header));
1738             $header->attributes['class'] = 'plugintypeheader type-' . $type;
1739             $table->data[] = $header;
1741             if (empty($plugins)) {
1742                 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1743                 $msg->colspan = array_sum($table->headspan);
1744                 $row = new html_table_row(array($msg));
1745                 $row->attributes['class'] .= 'msg msg-noneinstalled';
1746                 $table->data[] = $row;
1747                 continue;
1748             }
1750             foreach ($plugins as $name => $plugin) {
1751                 $row = new html_table_row();
1752                 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1754                 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1755                     $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1756                 } else {
1757                     $icon = $this->output->spacer();
1758                 }
1759                 $status = $plugin->get_status();
1760                 $row->attributes['class'] .= ' status-'.$status;
1761                 $pluginname  = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
1762                                html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1763                 $pluginname  = new html_table_cell($pluginname);
1765                 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1766                 if ((string)$plugin->release !== '') {
1767                     $version = html_writer::div($plugin->release, 'release').$version;
1768                 }
1769                 $version = new html_table_cell($version);
1771                 $isenabled = $plugin->is_enabled();
1772                 if (is_null($isenabled)) {
1773                     $availability = new html_table_cell('');
1774                 } else if ($isenabled) {
1775                     $row->attributes['class'] .= ' enabled';
1776                     $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1777                 } else {
1778                     $row->attributes['class'] .= ' disabled';
1779                     $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1780                 }
1782                 $settingsurl = $plugin->get_settings_url();
1783                 if (!is_null($settingsurl)) {
1784                     $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1785                 } else {
1786                     $settings = '';
1787                 }
1788                 $settings = new html_table_cell($settings);
1790                 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1791                     $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1792                 } else {
1793                     $uninstall = '';
1794                 }
1795                 $uninstall = new html_table_cell($uninstall);
1797                 if ($plugin->is_standard()) {
1798                     $row->attributes['class'] .= ' standard';
1799                     $source = '';
1800                 } else {
1801                     $row->attributes['class'] .= ' extension';
1802                     $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
1803                 }
1805                 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1806                     $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
1807                 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1808                     $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
1809                 } else {
1810                     $msg = '';
1811                 }
1813                 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1814                 if ($requriedby) {
1815                     $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1816                         array('class' => 'requiredby'));
1817                 } else {
1818                     $requiredby = '';
1819                 }
1821                 $updateinfo = '';
1822                 if (is_array($plugin->available_updates())) {
1823                     foreach ($plugin->available_updates() as $availableupdate) {
1824                         $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1825                     }
1826                 }
1828                 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1830                 $row->cells = array(
1831                     $pluginname, $version, $availability, $settings, $uninstall, $notes
1832                 );
1833                 $table->data[] = $row;
1834             }
1835         }
1837         return html_writer::table($table);
1838     }
1840     /**
1841      * Helper method to render the information about the available plugin update
1842      *
1843      * @param core_plugin_manager $pluginman plugin manager instance
1844      * @param \core\update\info $updateinfo information about the available update for the plugin
1845      */
1846     protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
1848         $boxclasses = 'pluginupdateinfo';
1849         $info = array();
1851         if (isset($updateinfo->release)) {
1852             $info[] = html_writer::div(
1853                 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1854                 'info release'
1855             );
1856         }
1858         if (isset($updateinfo->maturity)) {
1859             $info[] = html_writer::div(
1860                 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1861                 'info maturity'
1862             );
1863             $boxclasses .= ' maturity'.$updateinfo->maturity;
1864         }
1866         if (isset($updateinfo->download)) {
1867             $info[] = html_writer::div(
1868                 html_writer::link($updateinfo->download, get_string('download')),
1869                 'info download'
1870             );
1871         }
1873         if (isset($updateinfo->url)) {
1874             $info[] = html_writer::div(
1875                 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1876                 'info more'
1877             );
1878         }
1880         $box = html_writer::start_div($boxclasses);
1881         $box .= html_writer::div(
1882             get_string('updateavailable', 'core_plugin', $updateinfo->version),
1883             'version'
1884         );
1885         $box .= html_writer::div(
1886             implode(html_writer::span(' ', 'separator'), $info),
1887             'infos'
1888         );
1890         if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason)) {
1891             $box .= $this->output->single_button(
1892                 new moodle_url($this->page->url, array('installupdate' => $updateinfo->component,
1893                     'installupdateversion' => $updateinfo->version)),
1894                 get_string('updateavailableinstall', 'core_admin'),
1895                 'post',
1896                 array('class' => 'singlebutton updateavailableinstall')
1897             );
1898         } else {
1899             $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1900             if ($reasonhelp) {
1901                 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
1902             }
1903         }
1904         $box .= html_writer::end_div();
1906         return $box;
1907     }
1909     /**
1910      * This function will render one beautiful table with all the environmental
1911      * configuration and how it suits Moodle needs.
1912      *
1913      * @param boolean $result final result of the check (true/false)
1914      * @param environment_results[] $environment_results array of results gathered
1915      * @return string HTML to output.
1916      */
1917     public function environment_check_table($result, $environment_results) {
1918         global $CFG;
1920         // Table headers
1921         $servertable = new html_table();//table for server checks
1922         $servertable->head  = array(
1923             get_string('name'),
1924             get_string('info'),
1925             get_string('report'),
1926             get_string('plugin'),
1927             get_string('status'),
1928         );
1929         $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1930         $servertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
1931         $servertable->id = 'serverstatus';
1933         $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1935         $othertable = new html_table();//table for custom checks
1936         $othertable->head  = array(
1937             get_string('info'),
1938             get_string('report'),
1939             get_string('plugin'),
1940             get_string('status'),
1941         );
1942         $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1943         $othertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
1944         $othertable->id = 'otherserverstatus';
1946         $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1948         // Iterate over each environment_result
1949         $continue = true;
1950         foreach ($environment_results as $environment_result) {
1951             $errorline   = false;
1952             $warningline = false;
1953             $stringtouse = '';
1954             if ($continue) {
1955                 $type = $environment_result->getPart();
1956                 $info = $environment_result->getInfo();
1957                 $status = $environment_result->getStatus();
1958                 $plugin = $environment_result->getPluginName();
1959                 $error_code = $environment_result->getErrorCode();
1960                 // Process Report field
1961                 $rec = new stdClass();
1962                 // Something has gone wrong at parsing time
1963                 if ($error_code) {
1964                     $stringtouse = 'environmentxmlerror';
1965                     $rec->error_code = $error_code;
1966                     $status = get_string('error');
1967                     $errorline = true;
1968                     $continue = false;
1969                 }
1971                 if ($continue) {
1972                     if ($rec->needed = $environment_result->getNeededVersion()) {
1973                         // We are comparing versions
1974                         $rec->current = $environment_result->getCurrentVersion();
1975                         if ($environment_result->getLevel() == 'required') {
1976                             $stringtouse = 'environmentrequireversion';
1977                         } else {
1978                             $stringtouse = 'environmentrecommendversion';
1979                         }
1981                     } else if ($environment_result->getPart() == 'custom_check') {
1982                         // We are checking installed & enabled things
1983                         if ($environment_result->getLevel() == 'required') {
1984                             $stringtouse = 'environmentrequirecustomcheck';
1985                         } else {
1986                             $stringtouse = 'environmentrecommendcustomcheck';
1987                         }
1989                     } else if ($environment_result->getPart() == 'php_setting') {
1990                         if ($status) {
1991                             $stringtouse = 'environmentsettingok';
1992                         } else if ($environment_result->getLevel() == 'required') {
1993                             $stringtouse = 'environmentmustfixsetting';
1994                         } else {
1995                             $stringtouse = 'environmentshouldfixsetting';
1996                         }
1998                     } else {
1999                         if ($environment_result->getLevel() == 'required') {
2000                             $stringtouse = 'environmentrequireinstall';
2001                         } else {
2002                             $stringtouse = 'environmentrecommendinstall';
2003                         }
2004                     }
2006                     // Calculate the status value
2007                     if ($environment_result->getBypassStr() != '') {            //Handle bypassed result (warning)
2008                         $status = get_string('bypassed');
2009                         $warningline = true;
2010                     } else if ($environment_result->getRestrictStr() != '') {   //Handle restricted result (error)
2011                         $status = get_string('restricted');
2012                         $errorline = true;
2013                     } else {
2014                         if ($status) {                                          //Handle ok result (ok)
2015                             $status = get_string('ok');
2016                         } else {
2017                             if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
2018                                 $status = get_string('check');
2019                                 $warningline = true;
2020                             } else {                                            //Handle error result (error)
2021                                 $status = get_string('check');
2022                                 $errorline = true;
2023                             }
2024                         }
2025                     }
2026                 }
2028                 // Build the text
2029                 $linkparts = array();
2030                 $linkparts[] = 'admin/environment';
2031                 $linkparts[] = $type;
2032                 if (!empty($info)){
2033                    $linkparts[] = $info;
2034                 }
2035                 // Plugin environments do not have docs pages yet.
2036                 if (empty($CFG->docroot) or $environment_result->plugin) {
2037                     $report = get_string($stringtouse, 'admin', $rec);
2038                 } else {
2039                     $report = $this->doc_link(join('/', $linkparts), get_string($stringtouse, 'admin', $rec), true);
2040                 }
2041                 // Enclose report text in div so feedback text will be displayed underneath it.
2042                 $report = html_writer::div($report);
2044                 // Format error or warning line
2045                 if ($errorline) {
2046                     $messagetype = 'error';
2047                     $statusclass = 'badge-danger';
2048                 } else if ($warningline) {
2049                     $messagetype = 'warn';
2050                     $statusclass = 'badge-warning';
2051                 } else {
2052                     $messagetype = 'ok';
2053                     $statusclass = 'badge-success';
2054                 }
2055                 $status = html_writer::span($status, 'badge ' . $statusclass);
2056                 // Here we'll store all the feedback found
2057                 $feedbacktext = '';
2058                 // Append the feedback if there is some
2059                 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2060                 //Append the bypass if there is some
2061                 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2062                 //Append the restrict if there is some
2063                 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2065                 $report .= $feedbacktext;
2067                 // Add the row to the table
2068                 if ($environment_result->getPart() == 'custom_check'){
2069                     $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2070                 } else {
2071                     $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2072                 }
2073             }
2074         }
2076         //put errors first in
2077         $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2078         $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2080         // Print table
2081         $output = '';
2082         $output .= $this->heading(get_string('serverchecks', 'admin'));
2083         $output .= html_writer::table($servertable);
2084         if (count($othertable->data)){
2085             $output .= $this->heading(get_string('customcheck', 'admin'));
2086             $output .= html_writer::table($othertable);
2087         }
2089         // Finally, if any error has happened, print the summary box
2090         if (!$result) {
2091             $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2092         }
2094         return $output;
2095     }
2097     /**
2098      * Render a simple page for providing the upgrade key.
2099      *
2100      * @param moodle_url|string $url
2101      * @return string
2102      */
2103     public function upgradekey_form_page($url) {
2105         $output = '';
2106         $output .= $this->header();
2107         $output .= $this->container_start('upgradekeyreq');
2108         $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2109         $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
2110         $output .= html_writer::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
2111         $output .= html_writer::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
2112         $output .= html_writer::end_tag('form');
2113         $output .= $this->container_end();
2114         $output .= $this->footer();
2116         return $output;
2117     }
2119     /**
2120      * Check to see if writing to the deprecated legacy log store is enabled.
2121      *
2122      * @return string An error message if writing to the legacy log store is enabled.
2123      */
2124     protected function legacy_log_store_writing_error() {
2125         $enabled = get_config('logstore_legacy', 'loglegacy');
2126         $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2127         $enabled = $enabled && in_array('logstore_legacy', $plugins);
2129         if ($enabled) {
2130             return $this->warning(get_string('legacylogginginuse'));
2131         }
2132     }
2134     /**
2135      * Display message about the benefits of registering on Moodle.org
2136      *
2137      * @return string
2138      */
2139     public function moodleorg_registration_message() {
2141         $out = format_text(get_string('registerwithmoodleorginfo', 'core_hub'), FORMAT_MARKDOWN);
2143         $out .= html_writer::link(
2144             new moodle_url('/admin/settings.php', ['section' => 'moodleservices']),
2145             $this->output->pix_icon('i/info', '').' '.get_string('registerwithmoodleorginfoapp', 'core_hub'),
2146             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2147         );
2149         $out .= html_writer::link(
2150             HUB_MOODLEORGHUBURL,
2151             $this->output->pix_icon('i/stats', '').' '.get_string('registerwithmoodleorginfostats', 'core_hub'),
2152             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2153         );
2155         $out .= html_writer::link(
2156             HUB_MOODLEORGHUBURL.'/sites',
2157             $this->output->pix_icon('i/location', '').' '.get_string('registerwithmoodleorginfosites', 'core_hub'),
2158             ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2159         );
2161         return $this->output->box($out);
2162     }