Merge branch 'MDL-67442' of https://github.com/jonof/moodle
[moodle.git] / admin / renderer.php
blob4ab7754a13b0de66796f06bb2a28e08d38e82814
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.
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
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
26 defined('MOODLE_INTERNAL') || die();
29 /**
30 * Standard HTML output renderer for core_admin subsystem
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.
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;
60 /**
61 * Display page explaining proper upgrade process,
62 * there can not be any PHP file leftovers...
64 * @return string HTML to output.
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;
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.
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)));
107 $output .= $this->footer();
108 return $output;
112 * Displays the list of plugins with unsatisfied dependencies
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
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;
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.
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;
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.
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');
184 $output .= $this->continue_button(new moodle_url($this->page->url, array(
185 'confirmupgrade' => 1, 'confirmrelease' => 1, 'cache' => 0)));
188 $output .= $this->footer();
190 return $output;
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.
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();
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;
232 * Display a page to confirm plugin installation cancelation.
234 * @param array $abortable list of \core\update\plugininfo
235 * @param moodle_url $continue
236 * @return string
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');
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');
260 $out .= $this->plugins_management_confirm_buttons($continue, $this->page->url);
261 $out .= $this->output->footer();
263 return $out;
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
286 * @return string HTML to output.
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;
327 * Display the plugin management page (admin/plugins.php).
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
333 * @param core_plugin_manager $pluginman
334 * @param \core\update\checker $checker
335 * @param array $options filtering options
336 * @return string HTML to output.
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;
353 * Renders a button to fetch for available updates.
355 * @param \core\update\checker $checker
356 * @param moodle_url $reloadurl
357 * @return string HTML
359 public function check_for_updates_button(\core\update\checker $checker, $reloadurl) {
361 $output = '';
363 if ($checker->enabled()) {
364 $output .= $this->container_start('checkforupdates');
365 $output .= $this->single_button(
366 new moodle_url($reloadurl, array('fetchupdates' => 1)),
367 get_string('checkforupdates', 'core_plugin')
369 if ($timefetched = $checker->get_last_timefetched()) {
370 $timefetched = userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'));
371 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin', $timefetched), 'lasttimefetched');
373 $output .= $this->container_end();
376 return $output;
380 * Display a page to confirm the plugin uninstallation.
382 * @param core_plugin_manager $pluginman
383 * @param \core\plugininfo\base $pluginfo
384 * @param moodle_url $continueurl URL to continue after confirmation
385 * @param moodle_url $cancelurl URL to to go if cancelled
386 * @return string
388 public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
389 $output = '';
391 $pluginname = $pluginman->plugin_name($pluginfo->component);
393 $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
394 if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
395 $confirm .= $extraconfirm;
398 $output .= $this->output->header();
399 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
400 $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
401 $output .= $this->output->footer();
403 return $output;
407 * Display a page with results of plugin uninstallation and offer removal of plugin files.
409 * @param core_plugin_manager $pluginman
410 * @param \core\plugininfo\base $pluginfo
411 * @param progress_trace_buffer $progress
412 * @param moodle_url $continueurl URL to continue to remove the plugin folder
413 * @return string
415 public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
416 progress_trace_buffer $progress, moodle_url $continueurl) {
417 $output = '';
419 $pluginname = $pluginman->plugin_name($pluginfo->component);
421 // Do not show navigation here, they must click one of the buttons.
422 $this->page->set_pagelayout('maintenance');
423 $this->page->set_cacheable(false);
425 $output .= $this->output->header();
426 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
428 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
430 $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
431 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
433 if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
434 $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
435 'alert alert-warning mt-2');
438 // After any uninstall we must execute full upgrade to finish the cleanup!
439 $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
440 $output .= $this->output->footer();
442 return $output;
446 * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
448 * @param core_plugin_manager $pluginman
449 * @param \core\plugininfo\base $pluginfo
450 * @param progress_trace_buffer $progress
451 * @return string
453 public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
454 $output = '';
456 $pluginname = $pluginfo->component;
458 $output .= $this->output->header();
459 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
461 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
463 $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
464 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
465 $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
466 $output .= $this->output->footer();
468 return $output;
472 * Display the plugin management page (admin/environment.php).
473 * @param array $versions
474 * @param string $version
475 * @param boolean $envstatus final result of env check (true/false)
476 * @param array $environment_results array of results gathered
477 * @return string HTML to output.
479 public function environment_check_page($versions, $version, $envstatus, $environment_results) {
480 $output = '';
481 $output .= $this->header();
483 // Print the component download link
484 $output .= html_writer::tag('div', html_writer::link(
485 new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
486 get_string('updatecomponent', 'admin')),
487 array('class' => 'reportlink'));
489 // Heading.
490 $output .= $this->heading(get_string('environment', 'admin'));
492 // Box with info and a menu to choose the version.
493 $output .= $this->box_start();
494 $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
495 $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
496 $select->label = get_string('moodleversion');
497 $output .= $this->render($select);
498 $output .= $this->box_end();
500 // The results
501 $output .= $this->environment_check_table($envstatus, $environment_results);
503 $output .= $this->footer();
504 return $output;
508 * Output a warning message, of the type that appears on the admin notifications page.
509 * @param string $message the message to display.
510 * @param string $type type class
511 * @return string HTML to output.
513 protected function warning($message, $type = 'warning') {
514 return $this->box($message, 'generalbox alert alert-' . $type);
518 * Render an appropriate message if dataroot is insecure.
519 * @param bool $insecuredataroot
520 * @return string HTML to output.
522 protected function insecure_dataroot_warning($insecuredataroot) {
523 global $CFG;
525 if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
526 return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
528 } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
529 return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'danger');
531 } else {
532 return '';
537 * Render a warning that a directory with development libs is present.
539 * @param bool $devlibdir True if the warning should be displayed.
540 * @return string
542 protected function development_libs_directories_warning($devlibdir) {
544 if ($devlibdir) {
545 $moreinfo = new moodle_url('/report/security/index.php');
546 $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
547 return $this->warning($warning, 'danger');
549 } else {
550 return '';
555 * Render an appropriate message if dataroot is insecure.
556 * @param bool $errorsdisplayed
557 * @return string HTML to output.
559 protected function display_errors_warning($errorsdisplayed) {
560 if (!$errorsdisplayed) {
561 return '';
564 return $this->warning(get_string('displayerrorswarning', 'admin'));
568 * Render an appropriate message if themdesignermode is enabled.
569 * @param bool $themedesignermode true if enabled
570 * @return string HTML to output.
572 protected function themedesignermode_warning($themedesignermode) {
573 if (!$themedesignermode) {
574 return '';
577 return $this->warning(get_string('themedesignermodewarning', 'admin'));
581 * Render an appropriate message if iconv is buggy and mbstring missing.
582 * @param bool $buggyiconvnomb
583 * @return string HTML to output.
585 protected function buggy_iconv_warning($buggyiconvnomb) {
586 if (!$buggyiconvnomb) {
587 return '';
590 return $this->warning(get_string('warningiconvbuggy', 'admin'));
594 * Render an appropriate message if cron has not been run recently.
595 * @param bool $cronoverdue
596 * @return string HTML to output.
598 public function cron_overdue_warning($cronoverdue) {
599 global $CFG;
600 if (!$cronoverdue) {
601 return '';
604 if (empty($CFG->cronclionly)) {
605 $url = new moodle_url('/admin/cron.php');
606 if (!empty($CFG->cronremotepassword)) {
607 $url = new moodle_url('/admin/cron.php', array('password' => $CFG->cronremotepassword));
610 return $this->warning(get_string('cronwarning', 'admin', $url->out()) . '&nbsp;' .
611 $this->help_icon('cron', 'admin'));
614 // $CFG->cronclionly is not empty: cron can run only from CLI.
615 return $this->warning(get_string('cronwarningcli', 'admin') . '&nbsp;' .
616 $this->help_icon('cron', 'admin'));
620 * Render an appropriate message if cron is not being run frequently (recommended every minute).
622 * @param bool $croninfrequent
623 * @return string HTML to output.
625 public function cron_infrequent_warning(bool $croninfrequent) : string {
626 global $CFG;
628 if (!$croninfrequent) {
629 return '';
632 $expectedfrequency = $CFG->expectedcronfrequency ?? 200;
633 return $this->warning(get_string('croninfrequent', 'admin', $expectedfrequency) . '&nbsp;' .
634 $this->help_icon('cron', 'admin'));
638 * Render an appropriate message if there are any problems with the DB set-up.
639 * @param bool $dbproblems
640 * @return string HTML to output.
642 public function db_problems($dbproblems) {
643 if (!$dbproblems) {
644 return '';
647 return $this->warning($dbproblems);
651 * Renders cache warnings if there are any.
653 * @param string[] $cachewarnings
654 * @return string
656 public function cache_warnings(array $cachewarnings) {
657 if (!count($cachewarnings)) {
658 return '';
660 return join("\n", array_map(array($this, 'warning'), $cachewarnings));
664 * Renders events 1 API handlers warning.
666 * @param array $eventshandlers
667 * @return string
669 public function events_handlers($eventshandlers) {
670 if ($eventshandlers) {
671 $components = '';
672 foreach ($eventshandlers as $eventhandler) {
673 $components .= $eventhandler->component . ', ';
675 $components = rtrim($components, ', ');
676 return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
681 * Render an appropriate message if the site in in maintenance mode.
682 * @param bool $maintenancemode
683 * @return string HTML to output.
685 public function maintenance_mode_warning($maintenancemode) {
686 if (!$maintenancemode) {
687 return '';
690 $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
691 $url = $url->out(); // get_string() does not support objects in params
693 return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
697 * Render a warning that ssl is forced because the site was on loginhttps.
699 * @param bool $overridetossl Whether or not ssl is being forced.
700 * @return string
702 protected function overridetossl_warning($overridetossl) {
703 if (!$overridetossl) {
704 return '';
706 $warning = get_string('overridetossl', 'core_admin');
707 return $this->warning($warning, 'warning');
711 * Display a warning about installing development code if necesary.
712 * @param int $maturity
713 * @return string HTML to output.
715 protected function maturity_warning($maturity) {
716 if ($maturity == MATURITY_STABLE) {
717 return ''; // No worries.
720 $maturitylevel = get_string('maturity' . $maturity, 'admin');
721 return $this->warning(
722 $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
723 $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
724 'danger');
728 * If necessary, displays a warning about upgrading a test site.
730 * @param string $testsite
731 * @return string HTML
733 protected function test_site_warning($testsite) {
735 if (!$testsite) {
736 return '';
739 $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
740 return $this->warning($warning, 'danger');
744 * Output the copyright notice.
745 * @return string HTML to output.
747 protected function moodle_copyright() {
748 global $CFG;
750 //////////////////////////////////////////////////////////////////////////////////////////////////
751 //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
752 $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
753 '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
754 'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
755 'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
756 '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
757 //////////////////////////////////////////////////////////////////////////////////////////////////
759 return $this->box($copyrighttext, 'copyright');
763 * Display a warning about installing development code if necesary.
764 * @param int $maturity
765 * @return string HTML to output.
767 protected function maturity_info($maturity) {
768 if ($maturity == MATURITY_STABLE) {
769 return ''; // No worries.
772 $level = 'warning';
774 if ($maturity == MATURITY_ALPHA) {
775 $level = 'danger';
778 $maturitylevel = get_string('maturity' . $maturity, 'admin');
779 $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
780 $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
781 return $this->warning($warningtext, $level);
785 * Displays the info about available Moodle core and plugin updates
787 * The structure of the $updates param has changed since 2.4. It contains not only updates
788 * for the core itself, but also for all other installed plugins.
790 * @param array|null $updates array of (string)component => array of \core\update\info objects or null
791 * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
792 * @return string
794 protected function available_updates($updates, $fetch) {
796 $updateinfo = '';
797 $someupdateavailable = false;
798 if (is_array($updates)) {
799 if (is_array($updates['core'])) {
800 $someupdateavailable = true;
801 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
802 foreach ($updates['core'] as $update) {
803 $updateinfo .= $this->moodle_available_update_info($update);
805 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
806 array('class' => 'updateavailablerecommendation'));
808 unset($updates['core']);
809 // If something has left in the $updates array now, it is updates for plugins.
810 if (!empty($updates)) {
811 $someupdateavailable = true;
812 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
813 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
814 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
815 array('url' => $pluginsoverviewurl->out())));
819 if (!$someupdateavailable) {
820 $now = time();
821 if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
822 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
826 $updateinfo .= $this->container_start('checkforupdates');
827 $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
828 $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
829 if ($fetch) {
830 $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
831 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
833 $updateinfo .= $this->container_end();
835 return $this->warning($updateinfo);
839 * Display a warning about not being registered on Moodle.org if necesary.
841 * @param boolean $registered true if the site is registered on Moodle.org
842 * @return string HTML to output.
844 protected function registration_warning($registered) {
846 if (!$registered && site_is_public()) {
847 if (has_capability('moodle/site:config', context_system::instance())) {
848 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
849 get_string('register', 'admin'));
850 $str = 'registrationwarning';
851 } else {
852 $registerbutton = '';
853 $str = 'registrationwarningcontactadmin';
856 return $this->warning( get_string($str, 'admin')
857 . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
858 'error alert alert-danger');
861 return '';
865 * Return an admin page warning if site is not registered with moodle.org
867 * @return string
869 public function warn_if_not_registered() {
870 return $this->registration_warning(\core\hub\registration::is_registered());
874 * Display a warning about the Mobile Web Services being disabled.
876 * @param boolean $mobileconfigured true if mobile web services are enabled
877 * @return string HTML to output.
879 protected function mobile_configuration_warning($mobileconfigured) {
880 $output = '';
881 if (!$mobileconfigured) {
882 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
883 $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
884 $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
887 return $output;
891 * Display a warning about the forgotten password URL not linking to a valid URL.
893 * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
894 * @return string HTML to output.
896 protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
897 $output = '';
898 if ($invalidforgottenpasswordurl) {
899 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
900 $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
901 $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
902 'error alert alert-danger');
905 return $output;
909 * Helper method to render the information about the available Moodle update
911 * @param \core\update\info $updateinfo information about the available Moodle core update
913 protected function moodle_available_update_info(\core\update\info $updateinfo) {
915 $boxclasses = 'moodleupdateinfo';
916 $info = array();
918 if (isset($updateinfo->release)) {
919 $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
920 array('class' => 'info release'));
923 if (isset($updateinfo->version)) {
924 $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
925 array('class' => 'info version'));
928 if (isset($updateinfo->maturity)) {
929 $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
930 array('class' => 'info maturity'));
931 $boxclasses .= ' maturity'.$updateinfo->maturity;
934 if (isset($updateinfo->download)) {
935 $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
938 if (isset($updateinfo->url)) {
939 $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
940 array('class' => 'info more'));
943 $box = $this->output->box_start($boxclasses);
944 $box .= $this->output->box(implode(html_writer::tag('span', ' ', array('class' => 'separator')), $info), '');
945 $box .= $this->output->box_end();
947 return $box;
951 * Display a link to the release notes.
952 * @return string HTML to output.
954 protected function release_notes_link() {
955 $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
956 $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
957 return $this->box($releasenoteslink, 'generalbox alert alert-info');
961 * Display the reload link that appears on several upgrade/install pages.
962 * @return string HTML to output.
964 function upgrade_reload($url) {
965 return html_writer::empty_tag('br') .
966 html_writer::tag('div',
967 html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
968 get_string('reload'), array('title' => get_string('reload'))),
969 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
973 * Displays all known plugins and information about their installation or upgrade
975 * This default implementation renders all plugins into one big table. The rendering
976 * options support:
977 * (bool)full = false: whether to display up-to-date plugins, too
978 * (bool)xdep = false: display the plugins with unsatisified dependecies only
980 * @param core_plugin_manager $pluginman provides information about the plugins.
981 * @param int $version the version of the Moodle code from version.php.
982 * @param array $options rendering options
983 * @return string HTML code
985 public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
986 global $CFG;
987 $plugininfo = $pluginman->get_plugins();
989 if (empty($plugininfo)) {
990 return '';
993 $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
994 $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
996 $table = new html_table();
997 $table->id = 'plugins-check';
998 $table->head = array(
999 get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
1000 get_string('versiondb', 'core_plugin'),
1001 get_string('versiondisk', 'core_plugin'),
1002 get_string('requires', 'core_plugin'),
1003 get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
1005 $table->colclasses = array(
1006 'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
1008 $table->data = array();
1010 // Number of displayed plugins per type.
1011 $numdisplayed = array();
1012 // Number of plugins known to the plugin manager.
1013 $sumtotal = 0;
1014 // Number of plugins requiring attention.
1015 $sumattention = 0;
1016 // List of all components we can cancel installation of.
1017 $installabortable = $pluginman->list_cancellable_installations();
1018 // List of all components we can cancel upgrade of.
1019 $upgradeabortable = $pluginman->list_restorable_archives();
1021 foreach ($plugininfo as $type => $plugins) {
1023 $header = new html_table_cell($pluginman->plugintype_name_plural($type));
1024 $header->header = true;
1025 $header->colspan = count($table->head);
1026 $header = new html_table_row(array($header));
1027 $header->attributes['class'] = 'plugintypeheader type-' . $type;
1029 $numdisplayed[$type] = 0;
1031 if (empty($plugins) and $options['full']) {
1032 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1033 $msg->colspan = count($table->head);
1034 $row = new html_table_row(array($msg));
1035 $row->attributes['class'] .= 'msg msg-noneinstalled';
1036 $table->data[] = $header;
1037 $table->data[] = $row;
1038 continue;
1041 $plugintyperows = array();
1043 foreach ($plugins as $name => $plugin) {
1044 $sumtotal++;
1045 $row = new html_table_row();
1046 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1048 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1049 $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
1050 } else {
1051 $icon = '';
1054 $displayname = new html_table_cell(
1055 $icon.
1056 html_writer::span($plugin->displayname, 'pluginname').
1057 html_writer::div($plugin->get_dir(), 'plugindir')
1060 $versiondb = new html_table_cell($plugin->versiondb);
1061 $versiondisk = new html_table_cell($plugin->versiondisk);
1063 if ($isstandard = $plugin->is_standard()) {
1064 $row->attributes['class'] .= ' standard';
1065 $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext badge badge-secondary');
1066 } else {
1067 $row->attributes['class'] .= ' extension';
1068 $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
1071 $coredependency = $plugin->is_core_dependency_satisfied($version);
1072 $incompatibledependency = $plugin->is_core_compatible_satisfied($CFG->branch);
1074 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1075 $dependenciesok = $coredependency && $otherpluginsdependencies && $incompatibledependency;
1077 $statuscode = $plugin->get_status();
1078 $row->attributes['class'] .= ' status-' . $statuscode;
1079 $statusclass = 'statustext badge ';
1080 switch ($statuscode) {
1081 case core_plugin_manager::PLUGIN_STATUS_NEW:
1082 $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
1083 break;
1084 case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
1085 $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
1086 break;
1087 case core_plugin_manager::PLUGIN_STATUS_MISSING:
1088 case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1089 case core_plugin_manager::PLUGIN_STATUS_DELETE:
1090 $statusclass .= 'badge-danger';
1091 break;
1092 case core_plugin_manager::PLUGIN_STATUS_NODB:
1093 case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
1094 $statusclass .= $dependenciesok ? '' : 'badge-warning';
1095 break;
1097 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1099 if (!empty($installabortable[$plugin->component])) {
1100 $status .= $this->output->single_button(
1101 new moodle_url($this->page->url, array('abortinstall' => $plugin->component)),
1102 get_string('cancelinstallone', 'core_plugin'),
1103 'post',
1104 array('class' => 'actionbutton cancelinstallone')
1108 if (!empty($upgradeabortable[$plugin->component])) {
1109 $status .= $this->output->single_button(
1110 new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
1111 get_string('cancelupgradeone', 'core_plugin'),
1112 'post',
1113 array('class' => 'actionbutton cancelupgradeone')
1117 $availableupdates = $plugin->available_updates();
1118 if (!empty($availableupdates)) {
1119 foreach ($availableupdates as $availableupdate) {
1120 $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1124 $status = new html_table_cell($sourcelabel.' '.$status);
1125 if ($plugin->pluginsupported != null) {
1126 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version, $CFG->branch));
1127 } else {
1128 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1131 $statusisboring = in_array($statuscode, array(
1132 core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
1134 if ($options['xdep']) {
1135 // we want to see only plugins with failed dependencies
1136 if ($dependenciesok) {
1137 continue;
1140 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1141 // no change is going to happen to the plugin - display it only
1142 // if the user wants to see the full list
1143 if (empty($options['full'])) {
1144 continue;
1147 } else {
1148 $sumattention++;
1151 // The plugin should be displayed.
1152 $numdisplayed[$type]++;
1153 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1154 $plugintyperows[] = $row;
1157 if (empty($numdisplayed[$type]) and empty($options['full'])) {
1158 continue;
1161 $table->data[] = $header;
1162 $table->data = array_merge($table->data, $plugintyperows);
1165 // Total number of displayed plugins.
1166 $sumdisplayed = array_sum($numdisplayed);
1168 if ($options['xdep']) {
1169 // At the plugins dependencies check page, display the table only.
1170 return html_writer::table($table);
1173 $out = $this->output->container_start('', 'plugins-check-info');
1175 if ($sumdisplayed == 0) {
1176 $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1178 } else {
1179 if (empty($options['full'])) {
1180 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1181 } else {
1182 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1186 $out .= $this->output->container_start('actions');
1188 $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1189 if ($installableupdates) {
1190 $out .= $this->output->single_button(
1191 new moodle_url($this->page->url, array('installupdatex' => 1)),
1192 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1193 'post',
1194 array('class' => 'singlebutton updateavailableinstallall')
1198 if ($installabortable) {
1199 $out .= $this->output->single_button(
1200 new moodle_url($this->page->url, array('abortinstallx' => 1)),
1201 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1202 'post',
1203 array('class' => 'singlebutton cancelinstallall')
1207 if ($upgradeabortable) {
1208 $out .= $this->output->single_button(
1209 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1210 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1211 'post',
1212 array('class' => 'singlebutton cancelupgradeall')
1216 $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1217 get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge'));
1219 $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1220 get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge'));
1222 $out .= $this->output->container_end(); // End of .actions container.
1223 $out .= $this->output->container_end(); // End of #plugins-check-info container.
1225 if ($sumdisplayed > 0 or $options['full']) {
1226 $out .= html_writer::table($table);
1229 return $out;
1233 * Display the continue / cancel widgets for the plugins management pages.
1235 * @param null|moodle_url $continue URL for the continue button, should it be displayed
1236 * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1237 * @return string HTML
1239 public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
1241 $out = html_writer::start_div('plugins-management-confirm-buttons');
1243 if (!empty($continue)) {
1244 $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1247 if (empty($cancel)) {
1248 $cancel = $this->page->url;
1250 $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1252 return $out;
1256 * Displays the information about missing dependencies
1258 * @param core_plugin_manager $pluginman
1259 * @return string
1261 protected function missing_dependencies(core_plugin_manager $pluginman) {
1263 $dependencies = $pluginman->missing_dependencies();
1265 if (empty($dependencies)) {
1266 return '';
1269 $available = array();
1270 $unavailable = array();
1271 $unknown = array();
1273 foreach ($dependencies as $component => $remoteinfo) {
1274 if ($remoteinfo === false) {
1275 // The required version is not available. Let us check if there
1276 // is at least some version in the plugins directory.
1277 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1278 if ($remoteinfoanyversion === false) {
1279 $unknown[$component] = $component;
1280 } else {
1281 $unavailable[$component] = $remoteinfoanyversion;
1283 } else {
1284 $available[$component] = $remoteinfo;
1288 $out = $this->output->container_start('plugins-check-dependencies');
1290 if ($unavailable or $unknown) {
1291 $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1292 if ($unknown) {
1293 $out .= $this->output->notification(get_string('misdepsunknownlist', 'core_plugin', implode(', ', $unknown)));
1295 if ($unavailable) {
1296 $unavailablelist = array();
1297 foreach ($unavailable as $component => $remoteinfoanyversion) {
1298 $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1299 '<strong>'.$remoteinfoanyversion->name.'</strong>');
1300 if ($remoteinfoanyversion->version) {
1301 $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1302 } else {
1303 $unavailablelistitem .= ' ('.$component.')';
1305 $unavailablelist[] = $unavailablelistitem;
1307 $out .= $this->output->notification(get_string('misdepsunavaillist', 'core_plugin',
1308 implode(', ', $unavailablelist)));
1310 $out .= $this->output->container_start('plugins-check-dependencies-actions');
1311 $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1312 get_string('dependencyuploadmissing', 'core_plugin'));
1313 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1316 if ($available) {
1317 $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
1318 $out .= $this->output->container_start('plugins-check-dependencies-actions');
1320 $installable = $pluginman->filter_installable($available);
1321 if ($installable) {
1322 $out .= $this->output->single_button(
1323 new moodle_url($this->page->url, array('installdepx' => 1)),
1324 get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1325 'post',
1326 array('class' => 'singlebutton dependencyinstallmissing')
1330 $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1331 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1333 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1335 $out .= $this->available_missing_dependencies_list($pluginman, $available);
1338 $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
1340 return $out;
1344 * Displays the list if available missing dependencies.
1346 * @param core_plugin_manager $pluginman
1347 * @param array $dependencies
1348 * @return string
1350 protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1351 global $CFG;
1353 $table = new html_table();
1354 $table->id = 'plugins-check-available-dependencies';
1355 $table->head = array(
1356 get_string('displayname', 'core_plugin'),
1357 get_string('release', 'core_plugin'),
1358 get_string('version', 'core_plugin'),
1359 get_string('supportedmoodleversions', 'core_plugin'),
1360 get_string('info', 'core'),
1362 $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1363 $table->data = array();
1365 foreach ($dependencies as $plugin) {
1367 $supportedmoodles = array();
1368 foreach ($plugin->version->supportedmoodles as $moodle) {
1369 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1370 $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-success');
1371 } else {
1372 $supportedmoodles[] = html_writer::span($moodle->release, 'label');
1376 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1377 if ($requriedby) {
1378 foreach ($requriedby as $ix => $val) {
1379 $inf = $pluginman->get_plugin_info($val);
1380 if ($inf) {
1381 $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1384 $info = html_writer::div(
1385 get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1386 'requiredby'
1388 } else {
1389 $info = '';
1392 $info .= $this->output->container_start('actions');
1394 $info .= html_writer::div(
1395 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1396 get_string('misdepinfoplugin', 'core_plugin')),
1397 'misdepinfoplugin'
1400 $info .= html_writer::div(
1401 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1402 get_string('misdepinfoversion', 'core_plugin')),
1403 'misdepinfoversion'
1406 $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')), 'misdepdownload');
1408 if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1409 $info .= $this->output->single_button(
1410 new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1411 get_string('dependencyinstall', 'core_plugin'),
1412 'post',
1413 array('class' => 'singlebutton dependencyinstall')
1415 } else {
1416 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1417 if ($reasonhelp) {
1418 $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall');
1422 $info .= $this->output->container_end(); // End of .actions container.
1424 $table->data[] = array(
1425 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component'),
1426 $plugin->version->release,
1427 $plugin->version->version,
1428 implode(' ', $supportedmoodles),
1429 $info
1433 return html_writer::table($table);
1437 * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1439 * @param string $reason the reason code as returned by the plugin manager
1440 * @return string
1442 protected function info_remote_plugin_not_installable($reason) {
1444 if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1445 return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1448 if ($reason === 'remoteunavailable') {
1449 return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1452 return false;
1456 * Formats the information that needs to go in the 'Requires' column.
1457 * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1458 * @param core_plugin_manager $pluginman provides data on all the plugins.
1459 * @param string $version
1460 * @param int $branch the current Moodle branch
1461 * @return string HTML code
1463 protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version, $branch = null) {
1465 $requires = array();
1466 $displayuploadlink = false;
1467 $displayupdateslink = false;
1469 $requirements = $pluginman->resolve_requirements($plugin, $version, $branch);
1470 foreach ($requirements as $reqname => $reqinfo) {
1471 if ($reqname === 'core') {
1472 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1473 $class = 'requires-ok';
1474 $label = '';
1475 } else {
1476 $class = 'requires-failed';
1477 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1480 if ($branch != null && !$plugin->is_core_compatible_satisfied($branch)) {
1481 $requires[] = html_writer::tag('li',
1482 html_writer::span(get_string('incompatibleversion', 'core_plugin', $branch), 'dep dep-core').
1483 ' '.$label, array('class' => $class));
1485 } else if ($branch != null && $plugin->pluginsupported != null) {
1486 $requires[] = html_writer::tag('li',
1487 html_writer::span(get_string('moodlebranch', 'core_plugin',
1488 array('min' => $plugin->pluginsupported[0], 'max' => $plugin->pluginsupported[1])), 'dep dep-core').
1489 ' '.$label, array('class' => $class));
1491 } else if ($reqinfo->reqver != ANY_VERSION) {
1492 $requires[] = html_writer::tag('li',
1493 html_writer::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires), 'dep dep-core').
1494 ' '.$label, array('class' => $class));
1497 } else {
1498 $actions = array();
1500 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1501 $label = '';
1502 $class = 'requires-ok';
1504 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1505 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1506 $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-warning');
1507 $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1508 $class = 'requires-failed requires-missing requires-available';
1509 $actions[] = html_writer::link(
1510 new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1511 get_string('misdepinfoplugin', 'core_plugin')
1514 } else {
1515 $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
1516 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1517 'badge badge-danger');
1518 $class = 'requires-failed requires-missing requires-unavailable';
1520 $displayuploadlink = true;
1522 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1523 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1524 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-warning');
1525 $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1526 $class = 'requires-failed requires-outdated requires-available';
1527 $displayupdateslink = true;
1529 } else {
1530 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1531 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1532 'badge badge-danger');
1533 $class = 'requires-failed requires-outdated requires-unavailable';
1535 $displayuploadlink = true;
1538 if ($reqinfo->reqver != ANY_VERSION) {
1539 $str = 'otherpluginversion';
1540 } else {
1541 $str = 'otherplugin';
1544 $requires[] = html_writer::tag('li', html_writer::span(
1545 get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1546 'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1547 array('class' => $class)
1552 if (!$requires) {
1553 return '';
1556 $out = html_writer::tag('ul', implode("\n", $requires));
1558 if ($displayuploadlink) {
1559 $out .= html_writer::div(
1560 html_writer::link(
1561 new moodle_url('/admin/tool/installaddon/'),
1562 get_string('dependencyuploadmissing', 'core_plugin')
1564 'dependencyuploadmissing'
1568 if ($displayupdateslink) {
1569 $out .= html_writer::div(
1570 html_writer::link(
1571 new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1572 get_string('checkforupdates', 'core_plugin')
1574 'checkforupdates'
1578 // Check if supports is present, and $branch is not in, only if $incompatible check was ok.
1579 if ($plugin->pluginsupported != null && $class == 'requires-ok' && $branch != null) {
1580 if ($pluginman->check_explicitly_supported($plugin, $branch) == $pluginman::VERSION_NOT_SUPPORTED) {
1581 $out .= html_writer::div(get_string('notsupported', 'core_plugin', $branch));
1585 return $out;
1590 * Prints an overview about the plugins - number of installed, number of extensions etc.
1592 * @param core_plugin_manager $pluginman provides information about the plugins
1593 * @param array $options filtering options
1594 * @return string as usually
1596 public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1598 $plugininfo = $pluginman->get_plugins();
1600 $numtotal = $numextension = $numupdatable = 0;
1602 foreach ($plugininfo as $type => $plugins) {
1603 foreach ($plugins as $name => $plugin) {
1604 if ($plugin->available_updates()) {
1605 $numupdatable++;
1607 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1608 continue;
1610 $numtotal++;
1611 if (!$plugin->is_standard()) {
1612 $numextension++;
1617 $infoall = html_writer::link(
1618 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 0)),
1619 get_string('overviewall', 'core_plugin'),
1620 array('title' => get_string('filterall', 'core_plugin'))
1621 ).' '.html_writer::span($numtotal, 'badge number number-all');
1623 $infoext = html_writer::link(
1624 new moodle_url($this->page->url, array('contribonly' => 1, 'updatesonly' => 0)),
1625 get_string('overviewext', 'core_plugin'),
1626 array('title' => get_string('filtercontribonly', 'core_plugin'))
1627 ).' '.html_writer::span($numextension, 'badge number number-additional');
1629 if ($numupdatable) {
1630 $infoupdatable = html_writer::link(
1631 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 1)),
1632 get_string('overviewupdatable', 'core_plugin'),
1633 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1634 ).' '.html_writer::span($numupdatable, 'badge badge-info number number-updatable');
1635 } else {
1636 // No updates, or the notifications disabled.
1637 $infoupdatable = '';
1640 $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
1642 if (!empty($options['updatesonly'])) {
1643 $out .= $this->output->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1644 } else if (!empty($options['contribonly'])) {
1645 $out .= $this->output->heading(get_string('overviewext', 'core_plugin'), 3);
1648 if ($numupdatable) {
1649 $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1650 if ($installableupdates) {
1651 $out .= $this->output->single_button(
1652 new moodle_url($this->page->url, array('installupdatex' => 1)),
1653 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1654 'post',
1655 array('class' => 'singlebutton updateavailableinstallall')
1660 $out .= html_writer::div($infoall, 'info info-all').
1661 html_writer::div($infoext, 'info info-ext').
1662 html_writer::div($infoupdatable, 'info info-updatable');
1664 $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
1666 return $out;
1670 * Displays all known plugins and links to manage them
1672 * This default implementation renders all plugins into one big table.
1674 * @param core_plugin_manager $pluginman provides information about the plugins.
1675 * @param array $options filtering options
1676 * @return string HTML code
1678 public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1680 $plugininfo = $pluginman->get_plugins();
1682 // Filter the list of plugins according the options.
1683 if (!empty($options['updatesonly'])) {
1684 $updateable = array();
1685 foreach ($plugininfo as $plugintype => $pluginnames) {
1686 foreach ($pluginnames as $pluginname => $pluginfo) {
1687 $pluginavailableupdates = $pluginfo->available_updates();
1688 if (!empty($pluginavailableupdates)) {
1689 foreach ($pluginavailableupdates as $pluginavailableupdate) {
1690 $updateable[$plugintype][$pluginname] = $pluginfo;
1695 $plugininfo = $updateable;
1698 if (!empty($options['contribonly'])) {
1699 $contribs = array();
1700 foreach ($plugininfo as $plugintype => $pluginnames) {
1701 foreach ($pluginnames as $pluginname => $pluginfo) {
1702 if (!$pluginfo->is_standard()) {
1703 $contribs[$plugintype][$pluginname] = $pluginfo;
1707 $plugininfo = $contribs;
1710 if (empty($plugininfo)) {
1711 return '';
1714 $table = new html_table();
1715 $table->id = 'plugins-control-panel';
1716 $table->head = array(
1717 get_string('displayname', 'core_plugin'),
1718 get_string('version', 'core_plugin'),
1719 get_string('availability', 'core_plugin'),
1720 get_string('actions', 'core_plugin'),
1721 get_string('notes','core_plugin'),
1723 $table->headspan = array(1, 1, 1, 2, 1);
1724 $table->colclasses = array(
1725 'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1728 foreach ($plugininfo as $type => $plugins) {
1729 $heading = $pluginman->plugintype_name_plural($type);
1730 $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1731 if ($manageurl = $pluginclass::get_manage_url()) {
1732 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1733 get_string('settings', 'core_plugin')));
1735 $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1736 $header->header = true;
1737 $header->colspan = array_sum($table->headspan);
1738 $header = new html_table_row(array($header));
1739 $header->attributes['class'] = 'plugintypeheader type-' . $type;
1740 $table->data[] = $header;
1742 if (empty($plugins)) {
1743 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1744 $msg->colspan = array_sum($table->headspan);
1745 $row = new html_table_row(array($msg));
1746 $row->attributes['class'] .= 'msg msg-noneinstalled';
1747 $table->data[] = $row;
1748 continue;
1751 foreach ($plugins as $name => $plugin) {
1752 $row = new html_table_row();
1753 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1755 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
1756 $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
1757 } else {
1758 $icon = $this->output->spacer();
1760 $status = $plugin->get_status();
1761 $row->attributes['class'] .= ' status-'.$status;
1762 $pluginname = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
1763 html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1764 $pluginname = new html_table_cell($pluginname);
1766 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1767 if ((string)$plugin->release !== '') {
1768 $version = html_writer::div($plugin->release, 'release').$version;
1770 $version = new html_table_cell($version);
1772 $isenabled = $plugin->is_enabled();
1773 if (is_null($isenabled)) {
1774 $availability = new html_table_cell('');
1775 } else if ($isenabled) {
1776 $row->attributes['class'] .= ' enabled';
1777 $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1778 } else {
1779 $row->attributes['class'] .= ' disabled';
1780 $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1783 $settingsurl = $plugin->get_settings_url();
1784 if (!is_null($settingsurl)) {
1785 $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1786 } else {
1787 $settings = '';
1789 $settings = new html_table_cell($settings);
1791 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1792 $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1793 } else {
1794 $uninstall = '';
1796 $uninstall = new html_table_cell($uninstall);
1798 if ($plugin->is_standard()) {
1799 $row->attributes['class'] .= ' standard';
1800 $source = '';
1801 } else {
1802 $row->attributes['class'] .= ' extension';
1803 $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
1806 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1807 $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
1808 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1809 $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
1810 } else {
1811 $msg = '';
1814 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1815 if ($requriedby) {
1816 $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1817 array('class' => 'requiredby'));
1818 } else {
1819 $requiredby = '';
1822 $updateinfo = '';
1823 if (is_array($plugin->available_updates())) {
1824 foreach ($plugin->available_updates() as $availableupdate) {
1825 $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1829 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1831 $row->cells = array(
1832 $pluginname, $version, $availability, $settings, $uninstall, $notes
1834 $table->data[] = $row;
1838 return html_writer::table($table);
1842 * Helper method to render the information about the available plugin update
1844 * @param core_plugin_manager $pluginman plugin manager instance
1845 * @param \core\update\info $updateinfo information about the available update for the plugin
1847 protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
1849 $boxclasses = 'pluginupdateinfo';
1850 $info = array();
1852 if (isset($updateinfo->release)) {
1853 $info[] = html_writer::div(
1854 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1855 'info release'
1859 if (isset($updateinfo->maturity)) {
1860 $info[] = html_writer::div(
1861 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1862 'info maturity'
1864 $boxclasses .= ' maturity'.$updateinfo->maturity;
1867 if (isset($updateinfo->download)) {
1868 $info[] = html_writer::div(
1869 html_writer::link($updateinfo->download, get_string('download')),
1870 'info download'
1874 if (isset($updateinfo->url)) {
1875 $info[] = html_writer::div(
1876 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1877 'info more'
1881 $box = html_writer::start_div($boxclasses);
1882 $box .= html_writer::div(
1883 get_string('updateavailable', 'core_plugin', $updateinfo->version),
1884 'version'
1886 $box .= html_writer::div(
1887 implode(html_writer::span(' ', 'separator'), $info),
1888 'infos'
1891 if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason)) {
1892 $box .= $this->output->single_button(
1893 new moodle_url($this->page->url, array('installupdate' => $updateinfo->component,
1894 'installupdateversion' => $updateinfo->version)),
1895 get_string('updateavailableinstall', 'core_admin'),
1896 'post',
1897 array('class' => 'singlebutton updateavailableinstall')
1899 } else {
1900 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1901 if ($reasonhelp) {
1902 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
1905 $box .= html_writer::end_div();
1907 return $box;
1911 * This function will render one beautiful table with all the environmental
1912 * configuration and how it suits Moodle needs.
1914 * @param boolean $result final result of the check (true/false)
1915 * @param environment_results[] $environment_results array of results gathered
1916 * @return string HTML to output.
1918 public function environment_check_table($result, $environment_results) {
1919 global $CFG;
1921 // Table headers
1922 $servertable = new html_table();//table for server checks
1923 $servertable->head = array(
1924 get_string('name'),
1925 get_string('info'),
1926 get_string('report'),
1927 get_string('plugin'),
1928 get_string('status'),
1930 $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1931 $servertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
1932 $servertable->id = 'serverstatus';
1934 $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1936 $othertable = new html_table();//table for custom checks
1937 $othertable->head = array(
1938 get_string('info'),
1939 get_string('report'),
1940 get_string('plugin'),
1941 get_string('status'),
1943 $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1944 $othertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
1945 $othertable->id = 'otherserverstatus';
1947 $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1949 // Iterate over each environment_result
1950 $continue = true;
1951 foreach ($environment_results as $environment_result) {
1952 $errorline = false;
1953 $warningline = false;
1954 $stringtouse = '';
1955 if ($continue) {
1956 $type = $environment_result->getPart();
1957 $info = $environment_result->getInfo();
1958 $status = $environment_result->getStatus();
1959 $plugin = $environment_result->getPluginName();
1960 $error_code = $environment_result->getErrorCode();
1961 // Process Report field
1962 $rec = new stdClass();
1963 // Something has gone wrong at parsing time
1964 if ($error_code) {
1965 $stringtouse = 'environmentxmlerror';
1966 $rec->error_code = $error_code;
1967 $status = get_string('error');
1968 $errorline = true;
1969 $continue = false;
1972 if ($continue) {
1973 if ($rec->needed = $environment_result->getNeededVersion()) {
1974 // We are comparing versions
1975 $rec->current = $environment_result->getCurrentVersion();
1976 if ($environment_result->getLevel() == 'required') {
1977 $stringtouse = 'environmentrequireversion';
1978 } else {
1979 $stringtouse = 'environmentrecommendversion';
1982 } else if ($environment_result->getPart() == 'custom_check') {
1983 // We are checking installed & enabled things
1984 if ($environment_result->getLevel() == 'required') {
1985 $stringtouse = 'environmentrequirecustomcheck';
1986 } else {
1987 $stringtouse = 'environmentrecommendcustomcheck';
1990 } else if ($environment_result->getPart() == 'php_setting') {
1991 if ($status) {
1992 $stringtouse = 'environmentsettingok';
1993 } else if ($environment_result->getLevel() == 'required') {
1994 $stringtouse = 'environmentmustfixsetting';
1995 } else {
1996 $stringtouse = 'environmentshouldfixsetting';
1999 } else {
2000 if ($environment_result->getLevel() == 'required') {
2001 $stringtouse = 'environmentrequireinstall';
2002 } else {
2003 $stringtouse = 'environmentrecommendinstall';
2007 // Calculate the status value
2008 if ($environment_result->getBypassStr() != '') { //Handle bypassed result (warning)
2009 $status = get_string('bypassed');
2010 $warningline = true;
2011 } else if ($environment_result->getRestrictStr() != '') { //Handle restricted result (error)
2012 $status = get_string('restricted');
2013 $errorline = true;
2014 } else {
2015 if ($status) { //Handle ok result (ok)
2016 $status = get_string('ok');
2017 } else {
2018 if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
2019 $status = get_string('check');
2020 $warningline = true;
2021 } else { //Handle error result (error)
2022 $status = get_string('check');
2023 $errorline = true;
2029 // Build the text
2030 $linkparts = array();
2031 $linkparts[] = 'admin/environment';
2032 $linkparts[] = $type;
2033 if (!empty($info)){
2034 $linkparts[] = $info;
2036 // Plugin environments do not have docs pages yet.
2037 if (empty($CFG->docroot) or $environment_result->plugin) {
2038 $report = get_string($stringtouse, 'admin', $rec);
2039 } else {
2040 $report = $this->doc_link(join('/', $linkparts), get_string($stringtouse, 'admin', $rec), true);
2042 // Enclose report text in div so feedback text will be displayed underneath it.
2043 $report = html_writer::div($report);
2045 // Format error or warning line
2046 if ($errorline) {
2047 $messagetype = 'error';
2048 $statusclass = 'badge-danger';
2049 } else if ($warningline) {
2050 $messagetype = 'warn';
2051 $statusclass = 'badge-warning';
2052 } else {
2053 $messagetype = 'ok';
2054 $statusclass = 'badge-success';
2056 $status = html_writer::span($status, 'badge ' . $statusclass);
2057 // Here we'll store all the feedback found
2058 $feedbacktext = '';
2059 // Append the feedback if there is some
2060 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2061 //Append the bypass if there is some
2062 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2063 //Append the restrict if there is some
2064 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2066 $report .= $feedbacktext;
2068 // Add the row to the table
2069 if ($environment_result->getPart() == 'custom_check'){
2070 $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2071 } else {
2072 $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2077 //put errors first in
2078 $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2079 $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2081 // Print table
2082 $output = '';
2083 $output .= $this->heading(get_string('serverchecks', 'admin'));
2084 $output .= html_writer::table($servertable);
2085 if (count($othertable->data)){
2086 $output .= $this->heading(get_string('customcheck', 'admin'));
2087 $output .= html_writer::table($othertable);
2090 // Finally, if any error has happened, print the summary box
2091 if (!$result) {
2092 $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2095 return $output;
2099 * Render a simple page for providing the upgrade key.
2101 * @param moodle_url|string $url
2102 * @return string
2104 public function upgradekey_form_page($url) {
2106 $output = '';
2107 $output .= $this->header();
2108 $output .= $this->container_start('upgradekeyreq');
2109 $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2110 $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
2111 $output .= html_writer::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
2112 $output .= html_writer::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
2113 $output .= html_writer::end_tag('form');
2114 $output .= $this->container_end();
2115 $output .= $this->footer();
2117 return $output;
2121 * Check to see if writing to the deprecated legacy log store is enabled.
2123 * @return string An error message if writing to the legacy log store is enabled.
2125 protected function legacy_log_store_writing_error() {
2126 $enabled = get_config('logstore_legacy', 'loglegacy');
2127 $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2128 $enabled = $enabled && in_array('logstore_legacy', $plugins);
2130 if ($enabled) {
2131 return $this->warning(get_string('legacylogginginuse'));
2136 * Display message about the benefits of registering on Moodle.org
2138 * @return string
2140 public function moodleorg_registration_message() {
2142 $out = format_text(get_string('registerwithmoodleorginfo', 'core_hub'), FORMAT_MARKDOWN);
2144 $out .= html_writer::link(
2145 new moodle_url('/admin/settings.php', ['section' => 'moodleservices']),
2146 $this->output->pix_icon('i/info', '').' '.get_string('registerwithmoodleorginfoapp', 'core_hub'),
2147 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2150 $out .= html_writer::link(
2151 HUB_MOODLEORGHUBURL,
2152 $this->output->pix_icon('i/stats', '').' '.get_string('registerwithmoodleorginfostats', 'core_hub'),
2153 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2156 $out .= html_writer::link(
2157 HUB_MOODLEORGHUBURL.'/sites',
2158 $this->output->pix_icon('i/location', '').' '.get_string('registerwithmoodleorginfosites', 'core_hub'),
2159 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2162 return $this->output->box($out);