weekly release 4.5dev
[moodle.git] / admin / renderer.php
blob0f9333f78e589e61a97d13295713b05a74535386
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 * Standard HTML output 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
25 class core_admin_renderer extends plugin_renderer_base {
27 /**
28 * Display the 'Do you acknowledge the terms of the GPL' page. The first page
29 * during install.
30 * @return string HTML to output.
32 public function install_licence_page() {
33 global $CFG;
34 $output = '';
36 $copyrightnotice = text_to_html(get_string('gpl3'));
37 $copyrightnotice = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $copyrightnotice); // extremely ugly validation hack
39 $continue = new single_button(new moodle_url($this->page->url, array(
40 'lang' => $CFG->lang, 'agreelicense' => 1)), get_string('continue'), 'get');
42 $output .= $this->header();
43 $output .= $this->heading('<a href="http://moodle.org">Moodle</a> - Modular Object-Oriented Dynamic Learning Environment');
44 $output .= $this->heading(get_string('copyrightnotice'));
45 $output .= $this->box($copyrightnotice, 'copyrightnotice');
46 $output .= html_writer::empty_tag('br');
47 $output .= $this->confirm(get_string('doyouagree'), $continue, "https://moodledev.io/general/license");
48 $output .= $this->footer();
50 return $output;
53 /**
54 * Display page explaining proper upgrade process,
55 * there can not be any PHP file leftovers...
57 * @return string HTML to output.
59 public function upgrade_stale_php_files_page() {
60 $output = '';
61 $output .= $this->header();
62 $output .= $this->heading(get_string('upgradestalefiles', 'admin'));
63 $output .= $this->box_start('generalbox', 'notice');
64 $output .= format_text(get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading')), FORMAT_MARKDOWN);
65 $output .= html_writer::empty_tag('br');
66 $output .= html_writer::tag('div', $this->single_button($this->page->url, get_string('reload'), 'get'), array('class' => 'buttons'));
67 $output .= $this->box_end();
68 $output .= $this->footer();
70 return $output;
73 /**
74 * Display the 'environment check' page that is displayed during install.
75 * @param int $maturity
76 * @param boolean $envstatus final result of the check (true/false)
77 * @param array $environment_results array of results gathered
78 * @param string $release moodle release
79 * @return string HTML to output.
81 public function install_environment_page($maturity, $envstatus, $environment_results, $release) {
82 global $CFG;
83 $output = '';
85 $output .= $this->header();
86 $output .= $this->maturity_warning($maturity);
87 $output .= $this->heading("Moodle $release");
88 $output .= $this->release_notes_link();
90 $output .= $this->environment_check_table($envstatus, $environment_results);
92 if (!$envstatus) {
93 $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('agreelicense' => 1, 'lang' => $CFG->lang)));
94 } else {
95 $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
96 $output .= $this->continue_button(new moodle_url($this->page->url, array(
97 'agreelicense' => 1, 'confirmrelease' => 1, 'lang' => $CFG->lang)));
100 $output .= $this->footer();
101 return $output;
105 * Displays the list of plugins with unsatisfied dependencies
107 * @param double|string|int $version Moodle on-disk version
108 * @param array $failed list of plugins with unsatisfied dependecies
109 * @param moodle_url $reloadurl URL of the page to recheck the dependencies
110 * @return string HTML
112 public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
113 $output = '';
115 $output .= $this->header();
116 $output .= $this->heading(get_string('pluginscheck', 'admin'));
117 $output .= $this->warning(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
118 $output .= $this->plugins_check_table(core_plugin_manager::instance(), $version, array('xdep' => true));
119 $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
120 $output .= $this->continue_button($reloadurl);
122 $output .= $this->footer();
124 return $output;
128 * Display the 'You are about to upgrade Moodle' page. The first page
129 * during upgrade.
130 * @param string $strnewversion
131 * @param int $maturity
132 * @param string $testsite
133 * @return string HTML to output.
135 public function upgrade_confirm_page($strnewversion, $maturity, $testsite) {
136 $output = '';
138 $continueurl = new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0));
139 $continue = new single_button($continueurl, get_string('continue'), 'get');
140 $cancelurl = new moodle_url('/admin/index.php');
142 $output .= $this->header();
143 $output .= $this->maturity_warning($maturity);
144 $output .= $this->test_site_warning($testsite);
145 $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continue, $cancelurl);
146 $output .= $this->footer();
148 return $output;
152 * Display the environment page during the upgrade process.
153 * @param string $release
154 * @param boolean $envstatus final result of env check (true/false)
155 * @param array $environment_results array of results gathered
156 * @return string HTML to output.
158 public function upgrade_environment_page($release, $envstatus, $environment_results) {
159 global $CFG;
160 $output = '';
162 $output .= $this->header();
163 $output .= $this->heading("Moodle $release");
164 $output .= $this->release_notes_link();
165 $output .= $this->environment_check_table($envstatus, $environment_results);
167 if (!$envstatus) {
168 $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0)));
170 } else {
171 $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
173 if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
174 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
177 $output .= $this->continue_button(new moodle_url($this->page->url, array(
178 'confirmupgrade' => 1, 'confirmrelease' => 1, 'cache' => 0)));
181 $output .= $this->footer();
183 return $output;
187 * Display the upgrade page that lists all the plugins that require attention.
188 * @param core_plugin_manager $pluginman provides information about the plugins.
189 * @param \core\update\checker $checker provides information about available updates.
190 * @param int $version the version of the Moodle code from version.php.
191 * @param bool $showallplugins
192 * @param moodle_url $reloadurl
193 * @param moodle_url $continueurl
194 * @return string HTML to output.
196 public function upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,
197 $version, $showallplugins, $reloadurl, $continueurl) {
199 $output = '';
201 $output .= $this->header();
202 $output .= $this->box_start('generalbox', 'plugins-check-page');
203 $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'), array('class' => 'page-description'));
204 $output .= $this->check_for_updates_button($checker, $reloadurl);
205 $output .= $this->missing_dependencies($pluginman);
206 $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
207 $output .= $this->box_end();
208 $output .= $this->upgrade_reload($reloadurl);
210 if ($pluginman->some_plugins_updatable()) {
211 $output .= $this->container_start('upgradepluginsinfo');
212 $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
213 $output .= $this->container_end();
216 $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get', single_button::BUTTON_PRIMARY);
217 $button->class = 'continuebutton';
218 $output .= $this->render($button);
219 $output .= $this->footer();
221 return $output;
225 * Display a page to confirm plugin installation cancelation.
227 * @param array $abortable list of \core\update\plugininfo
228 * @param moodle_url $continue
229 * @return string
231 public function upgrade_confirm_abort_install_page(array $abortable, moodle_url $continue) {
233 $pluginman = core_plugin_manager::instance();
235 if (empty($abortable)) {
236 // The UI should not allow this.
237 throw new moodle_exception('err_no_plugin_install_abortable', 'core_plugin');
240 $out = $this->output->header();
241 $out .= $this->output->heading(get_string('cancelinstallhead', 'core_plugin'), 3);
242 $out .= $this->output->container(get_string('cancelinstallinfo', 'core_plugin'), 'cancelinstallinfo');
244 foreach ($abortable as $pluginfo) {
245 $out .= $this->output->heading($pluginfo->displayname.' ('.$pluginfo->component.')', 4);
246 $out .= $this->output->container(get_string('cancelinstallinfodir', 'core_plugin', $pluginfo->rootdir));
247 if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
248 $out .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
249 'alert alert-warning mt-2');
253 $out .= $this->plugins_management_confirm_buttons($continue, $this->page->url);
254 $out .= $this->output->footer();
256 return $out;
260 * Display the admin notifications page.
261 * @param int $maturity
262 * @param bool $insecuredataroot warn dataroot is invalid
263 * @param bool $errorsdisplayed warn invalid dispaly error setting
264 * @param bool $cronoverdue warn cron not running
265 * @param bool $dbproblems warn db has problems
266 * @param bool $maintenancemode warn in maintenance mode
267 * @param bool $buggyiconvnomb warn iconv problems
268 * @param array|null $availableupdates array of \core\update\info objects or null
269 * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
270 * @param string[] $cachewarnings An array containing warnings from the Cache API.
271 * @param array $eventshandlers Events 1 API handlers.
272 * @param bool $themedesignermode Warn about the theme designer mode.
273 * @param bool $devlibdir Warn about development libs directory presence.
274 * @param bool $mobileconfigured Whether the mobile web services have been enabled
275 * @param bool $overridetossl Whether or not ssl is being forced.
276 * @param bool $invalidforgottenpasswordurl Whether the forgotten password URL does not link to a valid URL.
277 * @param bool $croninfrequent If true, warn that cron hasn't run in the past few minutes
278 * @param bool $showcampaigncontent Whether the campaign content should be visible or not.
279 * @param bool $showfeedbackencouragement Whether the feedback encouragement content should be displayed or not.
280 * @param bool $showservicesandsupport Whether the services and support content should be displayed or not.
281 * @param string $xmlrpcwarning XML-RPC deprecation warning message.
283 * @return string HTML to output.
285 public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
286 $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
287 $buggyiconvnomb, $registered, array $cachewarnings = array(), $eventshandlers = 0,
288 $themedesignermode = false, $devlibdir = false, $mobileconfigured = false,
289 $overridetossl = false, $invalidforgottenpasswordurl = false, $croninfrequent = false,
290 $showcampaigncontent = false, bool $showfeedbackencouragement = false, bool $showservicesandsupport = false,
291 $xmlrpcwarning = '') {
293 global $CFG;
294 $output = '';
296 $output .= $this->header();
297 $output .= $this->output->heading(get_string('notifications', 'admin'));
298 $output .= $this->maturity_info($maturity);
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);
315 $output .= $this->mnet_deprecation_warning($xmlrpcwarning);
316 $output .= $this->userfeedback_encouragement($showfeedbackencouragement);
317 $output .= $this->services_and_support_content($showservicesandsupport);
318 $output .= $this->campaign_content($showcampaigncontent);
320 //////////////////////////////////////////////////////////////////////////////////////////////////
321 //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
322 $output .= $this->moodle_copyright();
323 //////////////////////////////////////////////////////////////////////////////////////////////////
325 $output .= $this->footer();
327 return $output;
331 * Display the plugin management page (admin/plugins.php).
333 * The filtering options array may contain following items:
334 * bool contribonly - show only contributed extensions
335 * bool updatesonly - show only plugins with an available update
337 * @param core_plugin_manager $pluginman
338 * @param \core\update\checker $checker
339 * @param array $options filtering options
340 * @return string HTML to output.
342 public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
344 $output = '';
346 $output .= $this->header();
347 $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
348 $output .= $this->check_for_updates_button($checker, $this->page->url);
349 $output .= $this->plugins_overview_panel($pluginman, $options);
350 $output .= $this->plugins_control_panel($pluginman, $options);
351 $output .= $this->footer();
353 return $output;
357 * Renders a button to fetch for available updates.
359 * @param \core\update\checker $checker
360 * @param moodle_url $reloadurl
361 * @return string HTML
363 public function check_for_updates_button(\core\update\checker $checker, $reloadurl) {
365 $output = '';
367 if ($checker->enabled()) {
368 $output .= $this->container_start('checkforupdates mb-4');
369 $output .= $this->single_button(
370 new moodle_url($reloadurl, array('fetchupdates' => 1)),
371 get_string('checkforupdates', 'core_plugin')
373 if ($timefetched = $checker->get_last_timefetched()) {
374 $timefetched = userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'));
375 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin', $timefetched),
376 'lasttimefetched small text-muted mt-1');
378 $output .= $this->container_end();
381 return $output;
385 * Display a page to confirm the plugin uninstallation.
387 * @param core_plugin_manager $pluginman
388 * @param \core\plugininfo\base $pluginfo
389 * @param moodle_url $continueurl URL to continue after confirmation
390 * @param moodle_url $cancelurl URL to to go if cancelled
391 * @return string
393 public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
394 $output = '';
396 $pluginname = $pluginman->plugin_name($pluginfo->component);
398 $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
399 if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
400 $confirm .= $extraconfirm;
403 $output .= $this->output->header();
404 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
405 $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
406 $output .= $this->output->footer();
408 return $output;
412 * Display a page with results of plugin uninstallation and offer removal of plugin files.
414 * @param core_plugin_manager $pluginman
415 * @param \core\plugininfo\base $pluginfo
416 * @param progress_trace_buffer $progress
417 * @param moodle_url $continueurl URL to continue to remove the plugin folder
418 * @return string
420 public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
421 progress_trace_buffer $progress, moodle_url $continueurl) {
422 $output = '';
424 $pluginname = $pluginman->plugin_name($pluginfo->component);
426 // Do not show navigation here, they must click one of the buttons.
427 $this->page->set_pagelayout('maintenance');
428 $this->page->set_cacheable(false);
430 $output .= $this->output->header();
431 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
433 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
435 $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
436 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
438 if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
439 $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
440 'alert alert-warning mt-2');
443 // After any uninstall we must execute full upgrade to finish the cleanup!
444 $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
445 $output .= $this->output->footer();
447 return $output;
451 * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
453 * @param core_plugin_manager $pluginman
454 * @param \core\plugininfo\base $pluginfo
455 * @param progress_trace_buffer $progress
456 * @return string
458 public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
459 $output = '';
461 $pluginname = $pluginfo->component;
463 $output .= $this->output->header();
464 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
466 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
468 $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
469 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
470 $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
471 $output .= $this->output->footer();
473 return $output;
477 * Display the plugin management page (admin/environment.php).
478 * @param array $versions
479 * @param string $version
480 * @param boolean $envstatus final result of env check (true/false)
481 * @param array $environment_results array of results gathered
482 * @return string HTML to output.
484 public function environment_check_page($versions, $version, $envstatus, $environment_results) {
485 $output = '';
486 $output .= $this->header();
488 // Print the component download link
489 $output .= html_writer::tag('div', html_writer::link(
490 new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
491 get_string('updatecomponent', 'admin')),
492 array('class' => 'reportlink'));
494 // Heading.
495 $output .= $this->heading(get_string('environment', 'admin'));
497 // Box with info and a menu to choose the version.
498 $output .= $this->box_start();
499 $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
500 $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
501 $select->label = get_string('moodleversion');
502 $output .= $this->render($select);
503 $output .= $this->box_end();
505 // The results
506 $output .= $this->environment_check_table($envstatus, $environment_results);
508 $output .= $this->footer();
509 return $output;
513 * Output a warning message, of the type that appears on the admin notifications page.
514 * @param string $message the message to display.
515 * @param string $type type class
516 * @return string HTML to output.
518 protected function warning($message, $type = 'warning') {
519 return $this->box($message, 'generalbox alert alert-' . $type);
523 * Render an appropriate message if dataroot is insecure.
524 * @param bool $insecuredataroot
525 * @return string HTML to output.
527 protected function insecure_dataroot_warning($insecuredataroot) {
528 global $CFG;
530 if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
531 return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
533 } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
534 return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'danger');
536 } else {
537 return '';
542 * Render a warning that a directory with development libs is present.
544 * @param bool $devlibdir True if the warning should be displayed.
545 * @return string
547 protected function development_libs_directories_warning($devlibdir) {
549 if ($devlibdir) {
550 $moreinfo = new moodle_url('/report/security/index.php');
551 $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
552 return $this->warning($warning, 'danger');
554 } else {
555 return '';
560 * Render an appropriate message if dataroot is insecure.
561 * @param bool $errorsdisplayed
562 * @return string HTML to output.
564 protected function display_errors_warning($errorsdisplayed) {
565 if (!$errorsdisplayed) {
566 return '';
569 return $this->warning(get_string('displayerrorswarning', 'admin'));
573 * Render an appropriate message if themdesignermode is enabled.
574 * @param bool $themedesignermode true if enabled
575 * @return string HTML to output.
577 protected function themedesignermode_warning($themedesignermode) {
578 if (!$themedesignermode) {
579 return '';
582 return $this->warning(get_string('themedesignermodewarning', 'admin'));
586 * Render an appropriate message if iconv is buggy and mbstring missing.
587 * @param bool $buggyiconvnomb
588 * @return string HTML to output.
590 protected function buggy_iconv_warning($buggyiconvnomb) {
591 if (!$buggyiconvnomb) {
592 return '';
595 return $this->warning(get_string('warningiconvbuggy', 'admin'));
599 * Render an appropriate message if cron has not been run recently.
600 * @param bool $cronoverdue
601 * @return string HTML to output.
603 public function cron_overdue_warning($cronoverdue) {
604 global $CFG;
605 if (!$cronoverdue) {
606 return '';
609 $check = new \tool_task\check\cronrunning();
610 $result = $check->get_result();
611 return $this->warning($result->get_summary() . '&nbsp;' . $this->help_icon('cron', 'admin'));
615 * Render an appropriate message if cron is not being run frequently (recommended every minute).
617 * @param bool $croninfrequent
618 * @return string HTML to output.
620 public function cron_infrequent_warning(bool $croninfrequent): string {
621 global $CFG;
623 if (!$croninfrequent) {
624 return '';
627 $check = new \tool_task\check\cronrunning();
628 $result = $check->get_result();
629 return $this->warning($result->get_summary() . '&nbsp;' . $this->help_icon('cron', 'admin'));
633 * Render an appropriate message if there are any problems with the DB set-up.
634 * @param bool $dbproblems
635 * @return string HTML to output.
637 public function db_problems($dbproblems) {
638 if (!$dbproblems) {
639 return '';
642 return $this->warning($dbproblems);
646 * Renders cache warnings if there are any.
648 * @param string[] $cachewarnings
649 * @return string
651 public function cache_warnings(array $cachewarnings) {
652 if (!count($cachewarnings)) {
653 return '';
655 return join("\n", array_map(array($this, 'warning'), $cachewarnings));
659 * Renders events 1 API handlers warning.
661 * @param array $eventshandlers
662 * @return string
664 public function events_handlers($eventshandlers) {
665 if ($eventshandlers) {
666 $components = '';
667 foreach ($eventshandlers as $eventhandler) {
668 $components .= $eventhandler->component . ', ';
670 $components = rtrim($components, ', ');
671 return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
676 * Render an appropriate message if the site in in maintenance mode.
677 * @param bool $maintenancemode
678 * @return string HTML to output.
680 public function maintenance_mode_warning($maintenancemode) {
681 if (!$maintenancemode) {
682 return '';
685 $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
686 $url = $url->out(); // get_string() does not support objects in params
688 return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
692 * Render a warning that ssl is forced because the site was on loginhttps.
694 * @param bool $overridetossl Whether or not ssl is being forced.
695 * @return string
697 protected function overridetossl_warning($overridetossl) {
698 if (!$overridetossl) {
699 return '';
701 $warning = get_string('overridetossl', 'core_admin');
702 return $this->warning($warning, 'warning');
706 * Display a warning about installing development code if necesary.
707 * @param int $maturity
708 * @return string HTML to output.
710 protected function maturity_warning($maturity) {
711 if ($maturity == MATURITY_STABLE) {
712 return ''; // No worries.
715 $maturitylevel = get_string('maturity' . $maturity, 'admin');
716 return $this->warning(
717 $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
718 $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
719 'danger');
723 * If necessary, displays a warning about upgrading a test site.
725 * @param string $testsite
726 * @return string HTML
728 protected function test_site_warning($testsite) {
730 if (!$testsite) {
731 return '';
734 $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
735 return $this->warning($warning, 'danger');
739 * Output the copyright notice.
740 * @return string HTML to output.
742 protected function moodle_copyright() {
743 global $CFG;
745 //////////////////////////////////////////////////////////////////////////////////////////////////
746 //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
747 $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
748 '<a href="https://moodledev.io/general/releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
749 'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
750 'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
751 '<a href="https://moodledev.io/general/license">GNU Public License</a>';
752 //////////////////////////////////////////////////////////////////////////////////////////////////
754 return $this->box($copyrighttext, 'copyright');
758 * Display a warning about installing development code if necesary.
759 * @param int $maturity
760 * @return string HTML to output.
762 protected function maturity_info($maturity) {
763 if ($maturity == MATURITY_STABLE) {
764 return ''; // No worries.
767 $level = 'warning';
769 if ($maturity == MATURITY_ALPHA) {
770 $level = 'danger';
773 $maturitylevel = get_string('maturity' . $maturity, 'admin');
774 $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
775 $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
776 return $this->warning($warningtext, $level);
780 * Displays the info about available Moodle core and plugin updates
782 * The structure of the $updates param has changed since 2.4. It contains not only updates
783 * for the core itself, but also for all other installed plugins.
785 * @param array|null $updates array of (string)component => array of \core\update\info objects or null
786 * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
787 * @return string
789 protected function available_updates($updates, $fetch) {
791 $updateinfo = '';
792 $someupdateavailable = false;
793 if (is_array($updates)) {
794 if (is_array($updates['core'])) {
795 $someupdateavailable = true;
796 $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
797 foreach ($updates['core'] as $update) {
798 $updateinfo .= $this->moodle_available_update_info($update);
800 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
801 array('class' => 'updateavailablerecommendation'));
803 unset($updates['core']);
804 // If something has left in the $updates array now, it is updates for plugins.
805 if (!empty($updates)) {
806 $someupdateavailable = true;
807 $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
808 $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
809 $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
810 array('url' => $pluginsoverviewurl->out())));
814 if (!$someupdateavailable) {
815 $now = time();
816 if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
817 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
821 $updateinfo .= $this->container_start('checkforupdates mt-1');
822 $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
823 $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
824 if ($fetch) {
825 $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
826 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
828 $updateinfo .= $this->container_end();
830 return $this->warning($updateinfo);
834 * Display a warning about not being registered on Moodle.org if necesary.
836 * @param boolean $registered true if the site is registered on Moodle.org
837 * @return string HTML to output.
839 protected function registration_warning($registered) {
841 if (!$registered && site_is_public()) {
842 if (has_capability('moodle/site:config', context_system::instance())) {
843 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
844 get_string('register', 'admin'));
845 $str = 'registrationwarning';
846 } else {
847 $registerbutton = '';
848 $str = 'registrationwarningcontactadmin';
851 return $this->warning( get_string($str, 'admin')
852 . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
853 'error alert alert-danger');
856 return '';
860 * Return an admin page warning if site is not registered with moodle.org
862 * @return string
864 public function warn_if_not_registered() {
865 return $this->registration_warning(\core\hub\registration::is_registered());
869 * Display a warning about the Mobile Web Services being disabled.
871 * @param boolean $mobileconfigured true if mobile web services are enabled
872 * @return string HTML to output.
874 protected function mobile_configuration_warning($mobileconfigured) {
875 $output = '';
876 if (!$mobileconfigured) {
877 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
878 $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
879 $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
882 return $output;
886 * Display campaign content.
888 * @param bool $showcampaigncontent Whether the campaign content should be visible or not.
889 * @return string the campaign content raw html.
891 protected function campaign_content(bool $showcampaigncontent): string {
892 if (!$showcampaigncontent) {
893 return '';
896 $lang = current_language();
897 $url = "https://campaign.moodle.org/current/lms/{$lang}/install/";
898 $params = [
899 'url' => $url,
900 'iframeid' => 'campaign-content',
901 'title' => get_string('campaign', 'admin'),
904 return $this->render_from_template('core/external_content_banner', $params);
908 * Display services and support content.
910 * @param bool $showservicesandsupport Whether the services and support content should be visible or not.
911 * @return string the campaign content raw html.
913 protected function services_and_support_content(bool $showservicesandsupport): string {
914 if (!$showservicesandsupport) {
915 return '';
918 $lang = current_language();
919 $url = "https://campaign.moodle.org/current/lms/{$lang}/servicesandsupport/";
920 $params = [
921 'url' => $url,
922 'iframeid' => 'services-support-content',
923 'title' => get_string('supportandservices', 'admin'),
926 return $this->render_from_template('core/external_content_banner', $params);
930 * Display a warning about the forgotten password URL not linking to a valid URL.
932 * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
933 * @return string HTML to output.
935 protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
936 $output = '';
937 if ($invalidforgottenpasswordurl) {
938 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
939 $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
940 $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
941 'error alert alert-danger');
944 return $output;
948 * Helper method to render the information about the available Moodle update
950 * @param \core\update\info $updateinfo information about the available Moodle core update
952 protected function moodle_available_update_info(\core\update\info $updateinfo) {
954 $boxclasses = 'moodleupdateinfo mb-2';
955 $info = array();
957 if (isset($updateinfo->release)) {
958 $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
959 array('class' => 'info release'));
962 if (isset($updateinfo->version)) {
963 $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
964 array('class' => 'info version'));
967 if (isset($updateinfo->maturity)) {
968 $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
969 array('class' => 'info maturity'));
970 $boxclasses .= ' maturity'.$updateinfo->maturity;
973 if (isset($updateinfo->download)) {
974 $info[] = html_writer::link($updateinfo->download, get_string('download'),
975 array('class' => 'info download btn btn-secondary'));
978 if (isset($updateinfo->url)) {
979 $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
980 array('class' => 'info more'));
983 $box = $this->output->container_start($boxclasses);
984 $box .= $this->output->container(implode(html_writer::tag('span', ' | ', array('class' => 'separator')), $info), '');
985 $box .= $this->output->container_end();
987 return $box;
991 * Display a link to the release notes.
992 * @return string HTML to output.
994 protected function release_notes_link() {
995 $releasenoteslink = get_string('releasenoteslink', 'admin', 'https://moodledev.io/general/releases');
996 $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
997 return $this->box($releasenoteslink, 'generalbox alert alert-info');
1001 * Display the reload link that appears on several upgrade/install pages.
1002 * @return string HTML to output.
1004 function upgrade_reload($url) {
1005 return html_writer::empty_tag('br') .
1006 html_writer::tag('div',
1007 html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
1008 get_string('reload'), array('title' => get_string('reload'))),
1009 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
1013 * Displays all known plugins and information about their installation or upgrade
1015 * This default implementation renders all plugins into one big table. The rendering
1016 * options support:
1017 * (bool)full = false: whether to display up-to-date plugins, too
1018 * (bool)xdep = false: display the plugins with unsatisified dependecies only
1020 * @param core_plugin_manager $pluginman provides information about the plugins.
1021 * @param int $version the version of the Moodle code from version.php.
1022 * @param array $options rendering options
1023 * @return string HTML code
1025 public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
1026 global $CFG;
1027 $plugininfo = $pluginman->get_plugins();
1029 if (empty($plugininfo)) {
1030 return '';
1033 $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
1034 $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
1036 $table = new html_table();
1037 $table->id = 'plugins-check';
1038 $table->head = array(
1039 get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
1040 get_string('versiondb', 'core_plugin'),
1041 get_string('versiondisk', 'core_plugin'),
1042 get_string('requires', 'core_plugin'),
1043 get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
1045 $table->colclasses = array(
1046 'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
1048 $table->data = array();
1050 // Number of displayed plugins per type.
1051 $numdisplayed = array();
1052 // Number of plugins known to the plugin manager.
1053 $sumtotal = 0;
1054 // Number of plugins requiring attention.
1055 $sumattention = 0;
1056 // List of all components we can cancel installation of.
1057 $installabortable = $pluginman->list_cancellable_installations();
1058 // List of all components we can cancel upgrade of.
1059 $upgradeabortable = $pluginman->list_restorable_archives();
1061 foreach ($plugininfo as $type => $plugins) {
1063 $header = new html_table_cell($pluginman->plugintype_name_plural($type));
1064 $header->header = true;
1065 $header->colspan = count($table->head);
1066 $header = new html_table_row(array($header));
1067 $header->attributes['class'] = 'plugintypeheader type-' . $type;
1069 $numdisplayed[$type] = 0;
1071 if (empty($plugins) and $options['full']) {
1072 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1073 $msg->colspan = count($table->head);
1074 $row = new html_table_row(array($msg));
1075 $row->attributes['class'] .= 'msg msg-noneinstalled';
1076 $table->data[] = $header;
1077 $table->data[] = $row;
1078 continue;
1081 $plugintyperows = array();
1083 foreach ($plugins as $name => $plugin) {
1084 $component = "{$plugin->type}_{$plugin->name}";
1086 $sumtotal++;
1087 $row = new html_table_row();
1088 $row->attributes['class'] = "type-{$plugin->type} name-{$component}";
1090 $iconidentifier = 'icon';
1091 if ($plugin->type === 'mod') {
1092 $iconidentifier = 'monologo';
1095 if ($this->page->theme->resolve_image_location($iconidentifier, $component, null)) {
1096 $icon = $this->output->pix_icon($iconidentifier, '', $component, [
1097 'class' => 'smallicon pluginicon',
1099 } else {
1100 $icon = '';
1103 $displayname = new html_table_cell(
1104 $icon.
1105 html_writer::span($plugin->displayname, 'pluginname').
1106 html_writer::div($plugin->get_dir(), 'plugindir text-muted small')
1109 $versiondb = new html_table_cell($plugin->versiondb);
1110 $versiondisk = new html_table_cell($plugin->versiondisk);
1112 if ($isstandard = $plugin->is_standard()) {
1113 $row->attributes['class'] .= ' standard';
1114 $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'),
1115 'sourcetext badge bg-secondary text-dark');
1116 } else {
1117 $row->attributes['class'] .= ' extension';
1118 $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge bg-info text-white');
1121 $coredependency = $plugin->is_core_dependency_satisfied($version);
1122 $incompatibledependency = $plugin->is_core_compatible_satisfied($CFG->branch);
1124 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1125 $dependenciesok = $coredependency && $otherpluginsdependencies && $incompatibledependency;
1127 $statuscode = $plugin->get_status();
1128 $row->attributes['class'] .= ' status-' . $statuscode;
1129 $statusclass = 'statustext badge ';
1130 switch ($statuscode) {
1131 case core_plugin_manager::PLUGIN_STATUS_NEW:
1132 $statusclass .= $dependenciesok ? 'bg-success text-white' : 'bg-warning text-dark';
1133 break;
1134 case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
1135 $statusclass .= $dependenciesok ? 'bg-info text-white' : 'bg-warning text-dark';
1136 break;
1137 case core_plugin_manager::PLUGIN_STATUS_MISSING:
1138 case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1139 case core_plugin_manager::PLUGIN_STATUS_DELETE:
1140 $statusclass .= 'bg-danger text-white';
1141 break;
1142 case core_plugin_manager::PLUGIN_STATUS_NODB:
1143 case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
1144 $statusclass .= $dependenciesok ? 'bg-light text-dark' : 'bg-warning text-dark';
1145 break;
1147 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1149 if (!empty($installabortable[$plugin->component])) {
1150 $status .= $this->output->single_button(
1151 new moodle_url($this->page->url, array('abortinstall' => $plugin->component, 'confirmplugincheck' => 0)),
1152 get_string('cancelinstallone', 'core_plugin'),
1153 'post',
1154 array('class' => 'actionbutton cancelinstallone d-block mt-1')
1158 if (!empty($upgradeabortable[$plugin->component])) {
1159 $status .= $this->output->single_button(
1160 new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
1161 get_string('cancelupgradeone', 'core_plugin'),
1162 'post',
1163 array('class' => 'actionbutton cancelupgradeone d-block mt-1')
1167 $availableupdates = $plugin->available_updates();
1168 if (!empty($availableupdates)) {
1169 foreach ($availableupdates as $availableupdate) {
1170 $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1174 $status = new html_table_cell($sourcelabel.' '.$status);
1175 if ($plugin->pluginsupported != null) {
1176 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version, $CFG->branch));
1177 } else {
1178 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1181 $statusisboring = in_array($statuscode, array(
1182 core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
1184 if ($options['xdep']) {
1185 // we want to see only plugins with failed dependencies
1186 if ($dependenciesok) {
1187 continue;
1190 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1191 // no change is going to happen to the plugin - display it only
1192 // if the user wants to see the full list
1193 if (empty($options['full'])) {
1194 continue;
1197 } else {
1198 $sumattention++;
1201 // The plugin should be displayed.
1202 $numdisplayed[$type]++;
1203 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
1204 $plugintyperows[] = $row;
1207 if (empty($numdisplayed[$type]) and empty($options['full'])) {
1208 continue;
1211 $table->data[] = $header;
1212 $table->data = array_merge($table->data, $plugintyperows);
1215 // Total number of displayed plugins.
1216 $sumdisplayed = array_sum($numdisplayed);
1218 if ($options['xdep']) {
1219 // At the plugins dependencies check page, display the table only.
1220 return html_writer::table($table);
1223 $out = $this->output->container_start('', 'plugins-check-info');
1225 if ($sumdisplayed == 0) {
1226 $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
1228 } else {
1229 if (empty($options['full'])) {
1230 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
1231 } else {
1232 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
1236 $out .= $this->output->container_start('actions mb-2');
1238 $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1239 if ($installableupdates) {
1240 $out .= $this->output->single_button(
1241 new moodle_url($this->page->url, array('installupdatex' => 1)),
1242 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1243 'post',
1244 array('class' => 'singlebutton updateavailableinstallall mr-1')
1248 if ($installabortable) {
1249 $out .= $this->output->single_button(
1250 new moodle_url($this->page->url, array('abortinstallx' => 1, 'confirmplugincheck' => 0)),
1251 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1252 'post',
1253 array('class' => 'singlebutton cancelinstallall mr-1')
1257 if ($upgradeabortable) {
1258 $out .= $this->output->single_button(
1259 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1260 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1261 'post',
1262 array('class' => 'singlebutton cancelupgradeall mr-1')
1266 $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 0)),
1267 get_string('plugincheckattention', 'core_plugin')).' '.html_writer::span($sumattention, 'badge bg-light text-dark'),
1268 'btn btn-link mr-1');
1270 $out .= html_writer::div(html_writer::link(new moodle_url($this->page->url, array('showallplugins' => 1)),
1271 get_string('plugincheckall', 'core_plugin')).' '.html_writer::span($sumtotal, 'badge bg-light text-dark'),
1272 'btn btn-link mr-1');
1274 $out .= $this->output->container_end(); // End of .actions container.
1275 $out .= $this->output->container_end(); // End of #plugins-check-info container.
1277 if ($sumdisplayed > 0 or $options['full']) {
1278 $out .= html_writer::table($table);
1281 return $out;
1285 * Display the continue / cancel widgets for the plugins management pages.
1287 * @param null|moodle_url $continue URL for the continue button, should it be displayed
1288 * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1289 * @return string HTML
1291 public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
1293 $out = html_writer::start_div('plugins-management-confirm-buttons');
1295 if (!empty($continue)) {
1296 $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1299 if (empty($cancel)) {
1300 $cancel = $this->page->url;
1302 $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1304 return $out;
1308 * Displays the information about missing dependencies
1310 * @param core_plugin_manager $pluginman
1311 * @return string
1313 protected function missing_dependencies(core_plugin_manager $pluginman) {
1315 $dependencies = $pluginman->missing_dependencies();
1317 if (empty($dependencies)) {
1318 return '';
1321 $available = array();
1322 $unavailable = array();
1323 $unknown = array();
1325 foreach ($dependencies as $component => $remoteinfo) {
1326 if ($remoteinfo === false) {
1327 // The required version is not available. Let us check if there
1328 // is at least some version in the plugins directory.
1329 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
1330 if ($remoteinfoanyversion === false) {
1331 $unknown[$component] = $component;
1332 } else {
1333 $unavailable[$component] = $remoteinfoanyversion;
1335 } else {
1336 $available[$component] = $remoteinfo;
1340 $out = $this->output->container_start('plugins-check-dependencies mb-4');
1342 if ($unavailable or $unknown) {
1343 $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1344 if ($unknown) {
1345 $out .= $this->output->render((new \core\output\notification(get_string('misdepsunknownlist', 'core_plugin',
1346 implode(', ', $unknown))))->set_show_closebutton(false));
1348 if ($unavailable) {
1349 $unavailablelist = array();
1350 foreach ($unavailable as $component => $remoteinfoanyversion) {
1351 $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1352 '<strong>'.$remoteinfoanyversion->name.'</strong>');
1353 if ($remoteinfoanyversion->version) {
1354 $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1355 } else {
1356 $unavailablelistitem .= ' ('.$component.')';
1358 $unavailablelist[] = $unavailablelistitem;
1360 $out .= $this->output->render((new \core\output\notification(get_string('misdepsunavaillist', 'core_plugin',
1361 implode(', ', $unavailablelist))))->set_show_closebutton(false));
1363 $out .= $this->output->container_start('plugins-check-dependencies-actions mb-4');
1364 $out .= ' '.html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1365 get_string('dependencyuploadmissing', 'core_plugin'), array('class' => 'btn btn-secondary'));
1366 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1369 if ($available) {
1370 $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
1371 $out .= $this->output->container_start('plugins-check-dependencies-actions mb-2');
1373 $installable = $pluginman->filter_installable($available);
1374 if ($installable) {
1375 $out .= $this->output->single_button(
1376 new moodle_url($this->page->url, array('installdepx' => 1)),
1377 get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1378 'post',
1379 array('class' => 'singlebutton dependencyinstallmissing d-inline-block mr-1')
1383 $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
1384 get_string('dependencyuploadmissing', 'core_plugin'), array('class' => 'btn btn-link')),
1385 'dependencyuploadmissing d-inline-block mr-1');
1387 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
1389 $out .= $this->available_missing_dependencies_list($pluginman, $available);
1392 $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
1394 return $out;
1398 * Displays the list if available missing dependencies.
1400 * @param core_plugin_manager $pluginman
1401 * @param array $dependencies
1402 * @return string
1404 protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1405 global $CFG;
1407 $table = new html_table();
1408 $table->id = 'plugins-check-available-dependencies';
1409 $table->head = array(
1410 get_string('displayname', 'core_plugin'),
1411 get_string('release', 'core_plugin'),
1412 get_string('version', 'core_plugin'),
1413 get_string('supportedmoodleversions', 'core_plugin'),
1414 get_string('info', 'core'),
1416 $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1417 $table->data = array();
1419 foreach ($dependencies as $plugin) {
1421 $supportedmoodles = array();
1422 foreach ($plugin->version->supportedmoodles as $moodle) {
1423 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
1424 $supportedmoodles[] = html_writer::span($moodle->release, 'badge bg-success text-white');
1425 } else {
1426 $supportedmoodles[] = html_writer::span($moodle->release, 'badge bg-light text-dark');
1430 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1431 if ($requriedby) {
1432 foreach ($requriedby as $ix => $val) {
1433 $inf = $pluginman->get_plugin_info($val);
1434 if ($inf) {
1435 $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1438 $info = html_writer::div(
1439 get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1440 'requiredby mb-1'
1442 } else {
1443 $info = '';
1446 $info .= $this->output->container_start('actions');
1448 $info .= html_writer::div(
1449 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1450 get_string('misdepinfoplugin', 'core_plugin')),
1451 'misdepinfoplugin d-inline-block mr-3 mb-1'
1454 $info .= html_writer::div(
1455 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1456 get_string('misdepinfoversion', 'core_plugin')),
1457 'misdepinfoversion d-inline-block mr-3 mb-1'
1460 $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')),
1461 'misdepdownload d-inline-block mr-3 mb-1');
1463 if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
1464 $info .= $this->output->single_button(
1465 new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1466 get_string('dependencyinstall', 'core_plugin'),
1467 'post',
1468 array('class' => 'singlebutton dependencyinstall mr-3 mb-1')
1470 } else {
1471 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1472 if ($reasonhelp) {
1473 $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall d-inline-block mr-3 mb-1');
1477 $info .= $this->output->container_end(); // End of .actions container.
1479 $table->data[] = array(
1480 html_writer::div($plugin->name, 'name').' '.html_writer::div($plugin->component, 'component text-muted small'),
1481 $plugin->version->release,
1482 $plugin->version->version,
1483 implode(' ', $supportedmoodles),
1484 $info
1488 return html_writer::table($table);
1492 * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1494 * @param string $reason the reason code as returned by the plugin manager
1495 * @return string
1497 protected function info_remote_plugin_not_installable($reason) {
1499 if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1500 return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1503 if ($reason === 'remoteunavailable') {
1504 return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1507 return false;
1511 * Formats the information that needs to go in the 'Requires' column.
1512 * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1513 * @param core_plugin_manager $pluginman provides data on all the plugins.
1514 * @param string $version
1515 * @param int $branch the current Moodle branch
1516 * @return string HTML code
1518 protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version, $branch = null) {
1520 $requires = array();
1521 $displayuploadlink = false;
1522 $displayupdateslink = false;
1524 $requirements = $pluginman->resolve_requirements($plugin, $version, $branch);
1525 foreach ($requirements as $reqname => $reqinfo) {
1526 if ($reqname === 'core') {
1527 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1528 $class = 'requires-ok text-muted';
1529 $label = '';
1530 } else {
1531 $class = 'requires-failed';
1532 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge bg-danger text-white');
1535 if ($branch != null && !$plugin->is_core_compatible_satisfied($branch)) {
1536 $requires[] = html_writer::tag('li',
1537 html_writer::span(get_string('incompatibleversion', 'core_plugin', $branch), 'dep dep-core').
1538 ' '.$label, array('class' => $class));
1540 } else if ($branch != null && $plugin->pluginsupported != null) {
1541 $requires[] = html_writer::tag('li',
1542 html_writer::span(get_string('moodlebranch', 'core_plugin',
1543 array('min' => $plugin->pluginsupported[0], 'max' => $plugin->pluginsupported[1])), 'dep dep-core').
1544 ' '.$label, array('class' => $class));
1546 } else if ($reqinfo->reqver != ANY_VERSION) {
1547 $requires[] = html_writer::tag('li',
1548 html_writer::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires), 'dep dep-core').
1549 ' '.$label, array('class' => $class));
1552 } else {
1553 $actions = array();
1555 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1556 $label = '';
1557 $class = 'requires-ok text-muted';
1559 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
1560 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1561 $label = html_writer::span(get_string('dependencymissing', 'core_plugin'),
1562 'badge bg-warning text-dark');
1563 $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'),
1564 'badge bg-warning text-dark');
1565 $class = 'requires-failed requires-missing requires-available';
1566 $actions[] = html_writer::link(
1567 new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1568 get_string('misdepinfoplugin', 'core_plugin')
1571 } else {
1572 $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge bg-danger text-white');
1573 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1574 'badge bg-danger text-white');
1575 $class = 'requires-failed requires-missing requires-unavailable';
1577 $displayuploadlink = true;
1579 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
1580 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
1581 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge bg-warning text-dark');
1582 $label .= ' '.html_writer::span(get_string('dependencyavailable', 'core_plugin'),
1583 'badge bg-warning text-dark');
1584 $class = 'requires-failed requires-outdated requires-available';
1585 $displayupdateslink = true;
1587 } else {
1588 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge bg-danger text-white');
1589 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
1590 'badge bg-danger text-white');
1591 $class = 'requires-failed requires-outdated requires-unavailable';
1593 $displayuploadlink = true;
1596 if ($reqinfo->reqver != ANY_VERSION) {
1597 $str = 'otherpluginversion';
1598 } else {
1599 $str = 'otherplugin';
1602 $requires[] = html_writer::tag('li', html_writer::span(
1603 get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver)),
1604 'dep dep-plugin').' '.$label.' '.html_writer::span(implode(' | ', $actions), 'actions'),
1605 array('class' => $class)
1610 if (!$requires) {
1611 return '';
1614 $out = html_writer::tag('ul', implode("\n", $requires), array('class' => 'm-0'));
1616 if ($displayuploadlink) {
1617 $out .= html_writer::div(
1618 html_writer::link(
1619 new moodle_url('/admin/tool/installaddon/'),
1620 get_string('dependencyuploadmissing', 'core_plugin'),
1621 array('class' => 'btn btn-secondary btn-sm m-1')
1623 'dependencyuploadmissing'
1627 if ($displayupdateslink) {
1628 $out .= html_writer::div(
1629 html_writer::link(
1630 new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1631 get_string('checkforupdates', 'core_plugin'),
1632 array('class' => 'btn btn-secondary btn-sm m-1')
1634 'checkforupdates'
1638 // Check if supports is present, and $branch is not in, only if $incompatible check was ok.
1639 if ($plugin->pluginsupported != null && $class == 'requires-ok' && $branch != null) {
1640 if ($pluginman->check_explicitly_supported($plugin, $branch) == $pluginman::VERSION_NOT_SUPPORTED) {
1641 $out .= html_writer::div(get_string('notsupported', 'core_plugin', $branch));
1645 return $out;
1650 * Prints an overview about the plugins - number of installed, number of extensions etc.
1652 * @param core_plugin_manager $pluginman provides information about the plugins
1653 * @param array $options filtering options
1654 * @return string as usually
1656 public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
1658 $plugininfo = $pluginman->get_plugins();
1660 $numtotal = $numextension = $numupdatable = $numinstallable = 0;
1662 foreach ($plugininfo as $type => $plugins) {
1663 foreach ($plugins as $name => $plugin) {
1664 if ($res = $plugin->available_updates()) {
1665 $numupdatable++;
1666 foreach ($res as $updateinfo) {
1667 if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason, false)) {
1668 $numinstallable++;
1669 break;
1673 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1674 continue;
1676 $numtotal++;
1677 if (!$plugin->is_standard()) {
1678 $numextension++;
1683 $infoall = html_writer::link(
1684 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 0)),
1685 get_string('overviewall', 'core_plugin'),
1686 array('title' => get_string('filterall', 'core_plugin'))
1687 ).' '.html_writer::span($numtotal, 'badge number number-all');
1689 $infoext = html_writer::link(
1690 new moodle_url($this->page->url, array('contribonly' => 1, 'updatesonly' => 0)),
1691 get_string('overviewext', 'core_plugin'),
1692 array('title' => get_string('filtercontribonly', 'core_plugin'))
1693 ).' '.html_writer::span($numextension, 'badge number number-additional');
1695 if ($numupdatable) {
1696 $infoupdatable = html_writer::link(
1697 new moodle_url($this->page->url, array('contribonly' => 0, 'updatesonly' => 1)),
1698 get_string('overviewupdatable', 'core_plugin'),
1699 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1700 ).' '.html_writer::span($numupdatable, 'badge bg-info text-white number number-updatable');
1701 } else {
1702 // No updates, or the notifications disabled.
1703 $infoupdatable = '';
1706 $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
1708 if (!empty($options['updatesonly'])) {
1709 $out .= $this->output->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1710 } else if (!empty($options['contribonly'])) {
1711 $out .= $this->output->heading(get_string('overviewext', 'core_plugin'), 3);
1714 if ($numinstallable) {
1715 $out .= $this->output->single_button(
1716 new moodle_url($this->page->url, array('installupdatex' => 1)),
1717 get_string('updateavailableinstallall', 'core_admin', $numinstallable),
1718 'post',
1719 array('class' => 'singlebutton updateavailableinstallall')
1723 $out .= html_writer::div($infoall, 'info info-all').
1724 html_writer::div($infoext, 'info info-ext').
1725 html_writer::div($infoupdatable, 'info info-updatable');
1727 $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
1729 return $out;
1733 * Displays all known plugins and links to manage them
1735 * This default implementation renders all plugins into one big table.
1737 * @param core_plugin_manager $pluginman provides information about the plugins.
1738 * @param array $options filtering options
1739 * @return string HTML code
1741 public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
1743 $plugininfo = $pluginman->get_plugins();
1745 // Filter the list of plugins according the options.
1746 if (!empty($options['updatesonly'])) {
1747 $updateable = array();
1748 foreach ($plugininfo as $plugintype => $pluginnames) {
1749 foreach ($pluginnames as $pluginname => $pluginfo) {
1750 $pluginavailableupdates = $pluginfo->available_updates();
1751 if (!empty($pluginavailableupdates)) {
1752 foreach ($pluginavailableupdates as $pluginavailableupdate) {
1753 $updateable[$plugintype][$pluginname] = $pluginfo;
1758 $plugininfo = $updateable;
1761 if (!empty($options['contribonly'])) {
1762 $contribs = array();
1763 foreach ($plugininfo as $plugintype => $pluginnames) {
1764 foreach ($pluginnames as $pluginname => $pluginfo) {
1765 if (!$pluginfo->is_standard()) {
1766 $contribs[$plugintype][$pluginname] = $pluginfo;
1770 $plugininfo = $contribs;
1773 if (empty($plugininfo)) {
1774 return '';
1777 $table = new html_table();
1778 $table->id = 'plugins-control-panel';
1779 $table->head = array(
1780 get_string('displayname', 'core_plugin'),
1781 get_string('version', 'core_plugin'),
1782 get_string('availability', 'core_plugin'),
1783 get_string('actions', 'core_plugin'),
1784 get_string('notes','core_plugin'),
1786 $table->headspan = array(1, 1, 1, 2, 1);
1787 $table->colclasses = array(
1788 'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1791 foreach ($plugininfo as $type => $plugins) {
1792 $heading = $pluginman->plugintype_name_plural($type);
1793 $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1794 if ($manageurl = $pluginclass::get_manage_url()) {
1795 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1796 get_string('settings', 'core_plugin')));
1798 $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1799 $header->header = true;
1800 $header->colspan = array_sum($table->headspan);
1801 $header = new html_table_row(array($header));
1802 $header->attributes['class'] = 'plugintypeheader type-' . $type;
1803 $table->data[] = $header;
1805 if (empty($plugins)) {
1806 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1807 $msg->colspan = array_sum($table->headspan);
1808 $row = new html_table_row(array($msg));
1809 $row->attributes['class'] .= 'msg msg-noneinstalled';
1810 $table->data[] = $row;
1811 continue;
1814 foreach ($plugins as $name => $plugin) {
1815 $component = "{$plugin->type}_{$plugin->name}";
1817 $row = new html_table_row();
1818 $row->attributes['class'] = "type-{$plugin->type} name-{$component}";
1820 $iconidentifier = 'icon';
1821 if ($plugin->type === 'mod') {
1822 $iconidentifier = 'monologo';
1825 if ($this->page->theme->resolve_image_location($iconidentifier, $component, null)) {
1826 $icon = $this->output->pix_icon($iconidentifier, '', $component, [
1827 'class' => 'icon pluginicon',
1829 } else {
1830 $icon = $this->output->spacer();
1832 $status = $plugin->get_status();
1833 $row->attributes['class'] .= ' status-'.$status;
1834 $pluginname = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
1835 html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1836 $pluginname = new html_table_cell($pluginname);
1838 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1839 if ((string)$plugin->release !== '') {
1840 $version = html_writer::div($plugin->release, 'release').$version;
1842 $version = new html_table_cell($version);
1844 $isenabled = $plugin->is_enabled();
1845 if (is_null($isenabled)) {
1846 $availability = new html_table_cell('');
1847 } else if ($isenabled) {
1848 $row->attributes['class'] .= ' enabled';
1849 $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1850 } else {
1851 $row->attributes['class'] .= ' disabled';
1852 $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1855 $settingsurl = $plugin->get_settings_url();
1856 if (!is_null($settingsurl)) {
1857 $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1858 } else {
1859 $settings = '';
1861 $settings = new html_table_cell($settings);
1863 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
1864 $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1865 } else {
1866 $uninstall = '';
1868 $uninstall = new html_table_cell($uninstall);
1870 if ($plugin->is_standard()) {
1871 $row->attributes['class'] .= ' standard';
1872 $source = '';
1873 } else {
1874 $row->attributes['class'] .= ' extension';
1875 $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge bg-info text-white');
1878 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1879 $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge bg-danger text-white');
1880 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
1881 $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge bg-success text-white');
1882 } else {
1883 $msg = '';
1886 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1887 if ($requriedby) {
1888 $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1889 array('class' => 'requiredby'));
1890 } else {
1891 $requiredby = '';
1894 $updateinfo = '';
1895 if (is_array($plugin->available_updates())) {
1896 foreach ($plugin->available_updates() as $availableupdate) {
1897 $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1901 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1903 $row->cells = array(
1904 $pluginname, $version, $availability, $settings, $uninstall, $notes
1906 $table->data[] = $row;
1910 return html_writer::table($table);
1914 * Helper method to render the information about the available plugin update
1916 * @param core_plugin_manager $pluginman plugin manager instance
1917 * @param \core\update\info $updateinfo information about the available update for the plugin
1919 protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
1921 $boxclasses = 'pluginupdateinfo';
1922 $info = array();
1924 if (isset($updateinfo->release)) {
1925 $info[] = html_writer::div(
1926 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1927 'info release'
1931 if (isset($updateinfo->maturity)) {
1932 $info[] = html_writer::div(
1933 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1934 'info maturity'
1936 $boxclasses .= ' maturity'.$updateinfo->maturity;
1939 if (isset($updateinfo->download)) {
1940 $info[] = html_writer::div(
1941 html_writer::link($updateinfo->download, get_string('download')),
1942 'info download'
1946 if (isset($updateinfo->url)) {
1947 $info[] = html_writer::div(
1948 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1949 'info more'
1953 $box = html_writer::start_div($boxclasses);
1954 $box .= html_writer::div(
1955 get_string('updateavailable', 'core_plugin', $updateinfo->version),
1956 'version'
1958 $box .= html_writer::div(
1959 implode(html_writer::span(' ', 'separator'), $info),
1960 'infos'
1963 if ($pluginman->is_remote_plugin_installable($updateinfo->component, $updateinfo->version, $reason, false)) {
1964 $box .= $this->output->single_button(
1965 new moodle_url($this->page->url, array('installupdate' => $updateinfo->component,
1966 'installupdateversion' => $updateinfo->version)),
1967 get_string('updateavailableinstall', 'core_admin'),
1968 'post',
1969 array('class' => 'singlebutton updateavailableinstall')
1971 } else {
1972 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1973 if ($reasonhelp) {
1974 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
1977 $box .= html_writer::end_div();
1979 return $box;
1983 * This function will render one beautiful table with all the environmental
1984 * configuration and how it suits Moodle needs.
1986 * @param boolean $result final result of the check (true/false)
1987 * @param environment_results[] $environment_results array of results gathered
1988 * @return string HTML to output.
1990 public function environment_check_table($result, $environment_results) {
1991 global $CFG;
1993 // Table headers
1994 $servertable = new html_table();//table for server checks
1995 $servertable->head = array(
1996 get_string('name'),
1997 get_string('info'),
1998 get_string('report'),
1999 get_string('plugin'),
2000 get_string('status'),
2002 $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
2003 $servertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
2004 $servertable->id = 'serverstatus';
2006 $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
2008 $othertable = new html_table();//table for custom checks
2009 $othertable->head = array(
2010 get_string('info'),
2011 get_string('report'),
2012 get_string('plugin'),
2013 get_string('status'),
2015 $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
2016 $othertable->attributes['class'] = 'admintable environmenttable generaltable table-sm';
2017 $othertable->id = 'otherserverstatus';
2019 $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
2021 // Iterate over each environment_result
2022 $continue = true;
2023 foreach ($environment_results as $environment_result) {
2024 $errorline = false;
2025 $warningline = false;
2026 $stringtouse = '';
2027 if ($continue) {
2028 $type = $environment_result->getPart();
2029 $info = $environment_result->getInfo();
2030 $status = $environment_result->getStatus();
2031 $plugin = $environment_result->getPluginName();
2032 $error_code = $environment_result->getErrorCode();
2033 // Process Report field
2034 $rec = new stdClass();
2035 // Something has gone wrong at parsing time
2036 if ($error_code) {
2037 $stringtouse = 'environmentxmlerror';
2038 $rec->error_code = $error_code;
2039 $status = get_string('error');
2040 $errorline = true;
2041 $continue = false;
2044 if ($continue) {
2045 if ($rec->needed = $environment_result->getNeededVersion()) {
2046 // We are comparing versions
2047 $rec->current = $environment_result->getCurrentVersion();
2048 if ($environment_result->getLevel() == 'required') {
2049 $stringtouse = 'environmentrequireversion';
2050 } else {
2051 $stringtouse = 'environmentrecommendversion';
2054 } else if ($environment_result->getPart() == 'custom_check') {
2055 // We are checking installed & enabled things
2056 if ($environment_result->getLevel() == 'required') {
2057 $stringtouse = 'environmentrequirecustomcheck';
2058 } else if ($environment_result->getLevel() == 'optional') {
2059 $stringtouse = 'environmentrecommendcustomcheck';
2060 } else {
2061 $stringtouse = 'environmentshouldfixcustomcheck';
2064 } else if ($environment_result->getPart() == 'php_setting') {
2065 if ($status) {
2066 $stringtouse = 'environmentsettingok';
2067 } else if ($environment_result->getLevel() == 'required') {
2068 $stringtouse = 'environmentmustfixsetting';
2069 } else {
2070 $stringtouse = 'environmentshouldfixsetting';
2073 } else {
2074 if ($environment_result->getLevel() == 'required') {
2075 $stringtouse = 'environmentrequireinstall';
2076 } else {
2077 $stringtouse = 'environmentrecommendinstall';
2081 // Calculate the status value
2082 if ($environment_result->getBypassStr() != '') { //Handle bypassed result (warning)
2083 $status = get_string('bypassed');
2084 $warningline = true;
2085 } else if ($environment_result->getRestrictStr() != '') { //Handle restricted result (error)
2086 $status = get_string('restricted');
2087 $errorline = true;
2088 } else {
2089 if ($status) { //Handle ok result (ok)
2090 $status = get_string('statusok');
2091 } else {
2092 // Handle check result (warning).
2093 if (in_array($environment_result->getLevel(), ['optional', 'recommended'])) {
2094 $status = get_string('check');
2095 $warningline = true;
2096 } else { //Handle error result (error)
2097 $status = get_string('check');
2098 $errorline = true;
2104 // Build the text
2105 $linkparts = array();
2106 $linkparts[] = 'admin/environment';
2107 $linkparts[] = $type;
2108 if (!empty($info)){
2109 $linkparts[] = $info;
2111 // Plugin environments do not have docs pages yet.
2112 if (empty($CFG->docroot) or $environment_result->plugin) {
2113 $report = get_string($stringtouse, 'admin', $rec);
2114 } else {
2115 $report = $this->doc_link(join('/', $linkparts), get_string($stringtouse, 'admin', $rec), true);
2117 // Enclose report text in div so feedback text will be displayed underneath it.
2118 $report = html_writer::div($report);
2120 // Format error or warning line
2121 if ($errorline) {
2122 $messagetype = 'error';
2123 $statusclass = 'bg-danger text-white';
2124 } else if ($warningline) {
2125 $messagetype = 'warn';
2126 $statusclass = 'bg-warning text-dark';
2127 } else {
2128 $messagetype = 'ok';
2129 $statusclass = 'bg-success text-white';
2131 $status = html_writer::span($status, 'badge ' . $statusclass);
2132 // Here we'll store all the feedback found
2133 $feedbacktext = '';
2134 // Append the feedback if there is some
2135 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2136 //Append the bypass if there is some
2137 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2138 //Append the restrict if there is some
2139 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2141 $report .= $feedbacktext;
2143 // Add the row to the table
2144 if ($environment_result->getPart() == 'custom_check'){
2145 $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2146 } else {
2147 $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2152 //put errors first in
2153 $servertable->data = array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2154 $othertable->data = array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2156 // Print table
2157 $output = '';
2158 $output .= $this->heading(get_string('serverchecks', 'admin'));
2159 $output .= html_writer::table($servertable);
2160 if (count($othertable->data)){
2161 $output .= $this->heading(get_string('customcheck', 'admin'));
2162 $output .= html_writer::table($othertable);
2165 // Finally, if any error has happened, print the summary box
2166 if (!$result) {
2167 $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2170 return $output;
2174 * Render a simple page for providing the upgrade key.
2176 * @param moodle_url|string $url
2177 * @return string
2179 public function upgradekey_form_page($url) {
2181 $output = '';
2182 $output .= $this->header();
2183 $output .= $this->container_start('upgradekeyreq');
2184 $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2185 $output .= html_writer::start_tag('form', array('method' => 'POST', 'action' => $url));
2186 $output .= html_writer::empty_tag('input', [
2187 'name' => 'upgradekey',
2188 'type' => 'password',
2189 'class' => 'form-control w-auto',
2191 $output .= html_writer::empty_tag('input', [
2192 'type' => 'submit',
2193 'value' => get_string('submit'),
2194 'class' => 'btn btn-primary mt-3',
2196 $output .= html_writer::end_tag('form');
2197 $output .= $this->container_end();
2198 $output .= $this->footer();
2200 return $output;
2204 * Display message about the benefits of registering on Moodle.org
2206 * @return string
2208 public function moodleorg_registration_message() {
2210 $out = format_text(get_string('registerwithmoodleorginfo', 'core_hub'), FORMAT_MARKDOWN);
2212 $out .= html_writer::link(
2213 MOODLE_PRODUCTURL.'/solutions/moodle-app/',
2214 $this->output->pix_icon('i/info', '').' '.get_string('registerwithmoodleorginfoapp', 'core_hub'),
2215 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2218 $out .= html_writer::link(
2219 HUB_MOODLEORGHUBURL,
2220 $this->output->pix_icon('i/stats', '').' '.get_string('registerwithmoodleorginfostats', 'core_hub'),
2221 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2224 $out .= html_writer::link(
2225 HUB_MOODLEORGHUBURL.'/sites',
2226 $this->output->pix_icon('i/location', '').' '.get_string('registerwithmoodleorginfosites', 'core_hub'),
2227 ['class' => 'btn btn-link', 'role' => 'opener', 'target' => '_href']
2230 return $this->output->box($out);
2234 * Display message about benefits of enabling the user feedback feature.
2236 * @param bool $showfeedbackencouragement Whether the encouragement content should be displayed or not
2237 * @return string
2239 protected function userfeedback_encouragement(bool $showfeedbackencouragement): string {
2240 $output = '';
2242 if ($showfeedbackencouragement) {
2243 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'userfeedback']);
2244 $output .= $this->warning(get_string('userfeedbackencouragement', 'admin', $settingslink->out()), 'info');
2247 return $output;
2251 * Display a warning about the deprecation of Mnet.
2253 * @param string $xmlrpcwarning The warning message
2254 * @return string HTML to output.
2256 protected function mnet_deprecation_warning($xmlrpcwarning) {
2257 if (empty($xmlrpcwarning)) {
2258 return '';
2261 return $this->warning($xmlrpcwarning);
2265 * Renders the theme selector list.
2267 * @param core_admin\output\theme_selector $themeselector
2268 * @return string HTML
2270 public function theme_selector_list(core_admin\output\theme_selector $themeselector): string {
2271 $renderable = $themeselector->export_for_template($this);
2272 return $this->render_from_template('core_admin/themeselector/theme_selector', $renderable);