2 // This file is part of Moodle - http://moodle.org/
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.
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/>.
18 * Renderer for core_admin subsystem
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();
30 * Standard HTML output renderer for core_admin subsystem
32 class core_admin_renderer
extends plugin_renderer_base
{
35 * Display the 'Do you acknowledge the terms of the GPL' page. The first page
37 * @return string HTML to output.
39 public function install_licence_page() {
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();
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() {
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();
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) {
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);
100 $output .= $this->upgrade_reload(new moodle_url($this->page
->url
, array('agreelicense' => 1, 'lang' => $CFG->lang
)));
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();
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) {
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();
135 * Display the 'You are about to upgrade Moodle' page. The first page
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) {
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();
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) {
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);
175 $output .= $this->upgrade_reload(new moodle_url($this->page
->url
, array('confirmupgrade' => 1, 'cache' => 0)));
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();
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) {
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();
232 * Display a page to confirm plugin installation cancelation.
234 * @param array $abortable list of \core\update\plugininfo
235 * @param moodle_url $continue
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 'uninstalldeleteconfirmexternal');
260 $out .= $this->plugins_management_confirm_buttons($continue, $this->page
->url
);
261 $out .= $this->output
->footer();
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) {
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();
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()) {
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();
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) {
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();
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
388 public function plugin_uninstall_confirm_page(core_plugin_manager
$pluginman, \core\plugininfo\base
$pluginfo, moodle_url
$continueurl, moodle_url
$cancelurl) {
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();
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
415 public function plugin_uninstall_results_removable_page(core_plugin_manager
$pluginman, \core\plugininfo\base
$pluginfo,
416 progress_trace_buffer
$progress, moodle_url
$continueurl) {
419 $pluginname = $pluginman->plugin_name($pluginfo->component
);
421 // Do not show navigation here, they must click one of the buttons.
422 $this->page
->set_pagelayout('maintenance');
423 $this->page
->set_cacheable(false);
425 $output .= $this->output
->header();
426 $output .= $this->output
->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
428 $output .= $this->output
->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
430 $confirm = $this->output
->container(get_string('uninstalldeleteconfirm', 'core_plugin',
431 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir
)), 'uninstalldeleteconfirm');
433 if ($repotype = $pluginman->plugin_external_source($pluginfo->component
)) {
434 $confirm .= $this->output
->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
435 'uninstalldeleteconfirmexternal');
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();
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
453 public function plugin_uninstall_results_page(core_plugin_manager
$pluginman, \core\plugininfo\base
$pluginfo, progress_trace_buffer
$progress) {
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();
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) {
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'));
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();
501 $output .= $this->environment_check_table($envstatus, $environment_results);
503 $output .= $this->footer();
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 admin' . $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) {
525 if ($insecuredataroot == INSECURE_DATAROOT_WARNING
) {
526 return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot
));
528 } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR
) {
529 return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot
), 'error');
537 * Render a warning that a directory with development libs is present.
539 * @param bool $devlibdir True if the warning should be displayed.
542 protected function development_libs_directories_warning($devlibdir) {
545 $moreinfo = new moodle_url('/report/security/index.php');
546 $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
547 return $this->warning($warning, 'error');
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) {
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) {
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) {
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) {
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()) . ' ' .
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') . ' ' .
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 {
628 if (!$croninfrequent) {
632 $expectedfrequency = $CFG->expectedcronfrequency ??
200;
633 return $this->warning(get_string('croninfrequent', 'admin', $expectedfrequency) . ' ' .
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) {
647 return $this->warning($dbproblems);
651 * Renders cache warnings if there are any.
653 * @param string[] $cachewarnings
656 public function cache_warnings(array $cachewarnings) {
657 if (!count($cachewarnings)) {
660 return join("\n", array_map(array($this, 'warning'), $cachewarnings));
664 * Renders events 1 API handlers warning.
666 * @param array $eventshandlers
669 public function events_handlers($eventshandlers) {
670 if ($eventshandlers) {
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) {
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.
702 protected function overridetossl_warning($overridetossl) {
703 if (!$overridetossl) {
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'))),
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) {
739 $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
740 return $this->warning($warning, 'error');
744 * Output the copyright notice.
745 * @return string HTML to output.
747 protected function moodle_copyright() {
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 © 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.
774 if ($maturity == MATURITY_ALPHA
) {
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)
794 protected function available_updates($updates, $fetch) {
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) {
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'));
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';
852 $registerbutton = '';
853 $str = 'registrationwarningcontactadmin';
856 return $this->warning( get_string($str, 'admin')
857 . ' ' . $this->help_icon('registration', 'admin') . $registerbutton ,
858 'error alert alert-danger');
865 * Return an admin page warning if site is not registered with moodle.org
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) {
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') . ' ' . $configurebutton);
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) {
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') . ' ' . $configurebutton,
902 'error alert alert-danger');
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';
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();
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 releasenoteslink');
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
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()) {
987 $plugininfo = $pluginman->get_plugins();
989 if (empty($plugininfo)) {
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.
1014 // Number of plugins requiring attention.
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;
1041 $plugintyperows = array();
1043 foreach ($plugins as $name => $plugin) {
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'));
1054 $displayname = new html_table_cell(
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');
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 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1073 $dependenciesok = $coredependency && $otherpluginsdependencies;
1075 $statuscode = $plugin->get_status();
1076 $row->attributes
['class'] .= ' status-' . $statuscode;
1077 $statusclass = 'statustext badge ';
1078 switch ($statuscode) {
1079 case core_plugin_manager
::PLUGIN_STATUS_NEW
:
1080 $statusclass .= $dependenciesok ?
'badge-success' : 'badge-warning';
1082 case core_plugin_manager
::PLUGIN_STATUS_UPGRADE
:
1083 $statusclass .= $dependenciesok ?
'badge-info' : 'badge-warning';
1085 case core_plugin_manager
::PLUGIN_STATUS_MISSING
:
1086 case core_plugin_manager
::PLUGIN_STATUS_DOWNGRADE
:
1087 case core_plugin_manager
::PLUGIN_STATUS_DELETE
:
1088 $statusclass .= 'badge-danger';
1090 case core_plugin_manager
::PLUGIN_STATUS_NODB
:
1091 case core_plugin_manager
::PLUGIN_STATUS_UPTODATE
:
1092 $statusclass .= $dependenciesok ?
'' : 'badge-warning';
1095 $status = html_writer
::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
1097 if (!empty($installabortable[$plugin->component
])) {
1098 $status .= $this->output
->single_button(
1099 new moodle_url($this->page
->url
, array('abortinstall' => $plugin->component
)),
1100 get_string('cancelinstallone', 'core_plugin'),
1102 array('class' => 'actionbutton cancelinstallone')
1106 if (!empty($upgradeabortable[$plugin->component
])) {
1107 $status .= $this->output
->single_button(
1108 new moodle_url($this->page
->url
, array('abortupgrade' => $plugin->component
)),
1109 get_string('cancelupgradeone', 'core_plugin'),
1111 array('class' => 'actionbutton cancelupgradeone')
1115 $availableupdates = $plugin->available_updates();
1116 if (!empty($availableupdates)) {
1117 foreach ($availableupdates as $availableupdate) {
1118 $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
1122 $status = new html_table_cell($sourcelabel.' '.$status);
1124 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
1126 $statusisboring = in_array($statuscode, array(
1127 core_plugin_manager
::PLUGIN_STATUS_NODB
, core_plugin_manager
::PLUGIN_STATUS_UPTODATE
));
1129 if ($options['xdep']) {
1130 // we want to see only plugins with failed dependencies
1131 if ($dependenciesok) {
1135 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
1136 // no change is going to happen to the plugin - display it only
1137 // if the user wants to see the full list
1138 if (empty($options['full'])) {
1146 // The plugin should be displayed.
1147 $numdisplayed[$type]++
;
1148 $row->cells
= array($displayname, $versiondb, $versiondisk, $requires, $status);
1149 $plugintyperows[] = $row;
1152 if (empty($numdisplayed[$type]) and empty($options['full'])) {
1156 $table->data
[] = $header;
1157 $table->data
= array_merge($table->data
, $plugintyperows);
1160 // Total number of displayed plugins.
1161 $sumdisplayed = array_sum($numdisplayed);
1163 if ($options['xdep']) {
1164 // At the plugins dependencies check page, display the table only.
1165 return html_writer
::table($table);
1168 $out = $this->output
->container_start('', 'plugins-check-info');
1170 if ($sumdisplayed == 0) {
1171 $out .= $this->output
->heading(get_string('pluginchecknone', 'core_plugin'));
1174 if (empty($options['full'])) {
1175 $out .= $this->output
->heading(get_string('plugincheckattention', 'core_plugin'));
1177 $out .= $this->output
->heading(get_string('plugincheckall', 'core_plugin'));
1181 $out .= $this->output
->container_start('actions');
1183 $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1184 if ($installableupdates) {
1185 $out .= $this->output
->single_button(
1186 new moodle_url($this->page
->url
, array('installupdatex' => 1)),
1187 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1189 array('class' => 'singlebutton updateavailableinstallall')
1193 if ($installabortable) {
1194 $out .= $this->output
->single_button(
1195 new moodle_url($this->page
->url
, array('abortinstallx' => 1)),
1196 get_string('cancelinstallall', 'core_plugin', count($installabortable)),
1198 array('class' => 'singlebutton cancelinstallall')
1202 if ($upgradeabortable) {
1203 $out .= $this->output
->single_button(
1204 new moodle_url($this->page
->url
, array('abortupgradex' => 1)),
1205 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
1207 array('class' => 'singlebutton cancelupgradeall')
1211 $out .= html_writer
::div(html_writer
::link(new moodle_url($this->page
->url
, array('showallplugins' => 0)),
1212 get_string('plugincheckattention', 'core_plugin')).' '.html_writer
::span($sumattention, 'badge'));
1214 $out .= html_writer
::div(html_writer
::link(new moodle_url($this->page
->url
, array('showallplugins' => 1)),
1215 get_string('plugincheckall', 'core_plugin')).' '.html_writer
::span($sumtotal, 'badge'));
1217 $out .= $this->output
->container_end(); // End of .actions container.
1218 $out .= $this->output
->container_end(); // End of #plugins-check-info container.
1220 if ($sumdisplayed > 0 or $options['full']) {
1221 $out .= html_writer
::table($table);
1228 * Display the continue / cancel widgets for the plugins management pages.
1230 * @param null|moodle_url $continue URL for the continue button, should it be displayed
1231 * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
1232 * @return string HTML
1234 public function plugins_management_confirm_buttons(moodle_url
$continue=null, moodle_url
$cancel=null) {
1236 $out = html_writer
::start_div('plugins-management-confirm-buttons');
1238 if (!empty($continue)) {
1239 $out .= $this->output
->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
1242 if (empty($cancel)) {
1243 $cancel = $this->page
->url
;
1245 $out .= html_writer
::div(html_writer
::link($cancel, get_string('cancel')), 'cancel');
1251 * Displays the information about missing dependencies
1253 * @param core_plugin_manager $pluginman
1256 protected function missing_dependencies(core_plugin_manager
$pluginman) {
1258 $dependencies = $pluginman->missing_dependencies();
1260 if (empty($dependencies)) {
1264 $available = array();
1265 $unavailable = array();
1268 foreach ($dependencies as $component => $remoteinfo) {
1269 if ($remoteinfo === false) {
1270 // The required version is not available. Let us check if there
1271 // is at least some version in the plugins directory.
1272 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION
, false);
1273 if ($remoteinfoanyversion === false) {
1274 $unknown[$component] = $component;
1276 $unavailable[$component] = $remoteinfoanyversion;
1279 $available[$component] = $remoteinfo;
1283 $out = $this->output
->container_start('plugins-check-dependencies');
1285 if ($unavailable or $unknown) {
1286 $out .= $this->output
->heading(get_string('misdepsunavail', 'core_plugin'));
1288 $out .= $this->output
->notification(get_string('misdepsunknownlist', 'core_plugin', implode($unknown, ', ')));
1291 $unavailablelist = array();
1292 foreach ($unavailable as $component => $remoteinfoanyversion) {
1293 $unavailablelistitem = html_writer
::link('https://moodle.org/plugins/view.php?plugin='.$component,
1294 '<strong>'.$remoteinfoanyversion->name
.'</strong>');
1295 if ($remoteinfoanyversion->version
) {
1296 $unavailablelistitem .= ' ('.$component.' > '.$remoteinfoanyversion->version
->version
.')';
1298 $unavailablelistitem .= ' ('.$component.')';
1300 $unavailablelist[] = $unavailablelistitem;
1302 $out .= $this->output
->notification(get_string('misdepsunavaillist', 'core_plugin',
1303 implode($unavailablelist, ', ')));
1305 $out .= $this->output
->container_start('plugins-check-dependencies-actions');
1306 $out .= ' '.html_writer
::link(new moodle_url('/admin/tool/installaddon/'),
1307 get_string('dependencyuploadmissing', 'core_plugin'));
1308 $out .= $this->output
->container_end(); // End of .plugins-check-dependencies-actions container.
1312 $out .= $this->output
->heading(get_string('misdepsavail', 'core_plugin'));
1313 $out .= $this->output
->container_start('plugins-check-dependencies-actions');
1315 $installable = $pluginman->filter_installable($available);
1317 $out .= $this->output
->single_button(
1318 new moodle_url($this->page
->url
, array('installdepx' => 1)),
1319 get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1321 array('class' => 'singlebutton dependencyinstallmissing')
1325 $out .= html_writer
::div(html_writer
::link(new moodle_url('/admin/tool/installaddon/'),
1326 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1328 $out .= $this->output
->container_end(); // End of .plugins-check-dependencies-actions container.
1330 $out .= $this->available_missing_dependencies_list($pluginman, $available);
1333 $out .= $this->output
->container_end(); // End of .plugins-check-dependencies container.
1339 * Displays the list if available missing dependencies.
1341 * @param core_plugin_manager $pluginman
1342 * @param array $dependencies
1345 protected function available_missing_dependencies_list(core_plugin_manager
$pluginman, array $dependencies) {
1348 $table = new html_table();
1349 $table->id
= 'plugins-check-available-dependencies';
1350 $table->head
= array(
1351 get_string('displayname', 'core_plugin'),
1352 get_string('release', 'core_plugin'),
1353 get_string('version', 'core_plugin'),
1354 get_string('supportedmoodleversions', 'core_plugin'),
1355 get_string('info', 'core'),
1357 $table->colclasses
= array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1358 $table->data
= array();
1360 foreach ($dependencies as $plugin) {
1362 $supportedmoodles = array();
1363 foreach ($plugin->version
->supportedmoodles
as $moodle) {
1364 if ($CFG->branch
== str_replace('.', '', $moodle->release
)) {
1365 $supportedmoodles[] = html_writer
::span($moodle->release
, 'badge badge-success');
1367 $supportedmoodles[] = html_writer
::span($moodle->release
, 'label');
1371 $requriedby = $pluginman->other_plugins_that_require($plugin->component
);
1373 foreach ($requriedby as $ix => $val) {
1374 $inf = $pluginman->get_plugin_info($val);
1376 $requriedby[$ix] = $inf->displayname
.' ('.$inf->component
.')';
1379 $info = html_writer
::div(
1380 get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1387 $info .= $this->output
->container_start('actions');
1389 $info .= html_writer
::div(
1390 html_writer
::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component
,
1391 get_string('misdepinfoplugin', 'core_plugin')),
1395 $info .= html_writer
::div(
1396 html_writer
::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version
->id
,
1397 get_string('misdepinfoversion', 'core_plugin')),
1401 $info .= html_writer
::div(html_writer
::link($plugin->version
->downloadurl
, get_string('download')), 'misdepdownload');
1403 if ($pluginman->is_remote_plugin_installable($plugin->component
, $plugin->version
->version
, $reason)) {
1404 $info .= $this->output
->single_button(
1405 new moodle_url($this->page
->url
, array('installdep' => $plugin->component
)),
1406 get_string('dependencyinstall', 'core_plugin'),
1408 array('class' => 'singlebutton dependencyinstall')
1411 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1413 $info .= html_writer
::div($reasonhelp, 'reasonhelp dependencyinstall');
1417 $info .= $this->output
->container_end(); // End of .actions container.
1419 $table->data
[] = array(
1420 html_writer
::div($plugin->name
, 'name').' '.html_writer
::div($plugin->component
, 'component'),
1421 $plugin->version
->release
,
1422 $plugin->version
->version
,
1423 implode($supportedmoodles, ' '),
1428 return html_writer
::table($table);
1432 * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1434 * @param string $reason the reason code as returned by the plugin manager
1437 protected function info_remote_plugin_not_installable($reason) {
1439 if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1440 return $this->output
->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1443 if ($reason === 'remoteunavailable') {
1444 return $this->output
->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1451 * Formats the information that needs to go in the 'Requires' column.
1452 * @param \core\plugininfo\base $plugin the plugin we are rendering the row for.
1453 * @param core_plugin_manager $pluginman provides data on all the plugins.
1454 * @param string $version
1455 * @return string HTML code
1457 protected function required_column(\core\plugininfo\base
$plugin, core_plugin_manager
$pluginman, $version) {
1459 $requires = array();
1460 $displayuploadlink = false;
1461 $displayupdateslink = false;
1463 foreach ($pluginman->resolve_requirements($plugin, $version) as $reqname => $reqinfo) {
1464 if ($reqname === 'core') {
1465 if ($reqinfo->status
== $pluginman::REQUIREMENT_STATUS_OK
) {
1466 $class = 'requires-ok';
1469 $class = 'requires-failed';
1470 $label = html_writer
::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1472 $requires[] = html_writer
::tag('li',
1473 html_writer
::span(get_string('moodleversion', 'core_plugin', $plugin->versionrequires
), 'dep dep-core').
1474 ' '.$label, array('class' => $class));
1479 if ($reqinfo->status
== $pluginman::REQUIREMENT_STATUS_OK
) {
1481 $class = 'requires-ok';
1483 } else if ($reqinfo->status
== $pluginman::REQUIREMENT_STATUS_MISSING
) {
1484 if ($reqinfo->availability
== $pluginman::REQUIREMENT_AVAILABLE
) {
1485 $label = html_writer
::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-warning');
1486 $label .= ' '.html_writer
::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1487 $class = 'requires-failed requires-missing requires-available';
1488 $actions[] = html_writer
::link(
1489 new moodle_url('https://moodle.org/plugins/view.php', array('plugin' => $reqname)),
1490 get_string('misdepinfoplugin', 'core_plugin')
1494 $label = html_writer
::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
1495 $label .= ' '.html_writer
::span(get_string('dependencyunavailable', 'core_plugin'),
1496 'badge badge-danger');
1497 $class = 'requires-failed requires-missing requires-unavailable';
1499 $displayuploadlink = true;
1501 } else if ($reqinfo->status
== $pluginman::REQUIREMENT_STATUS_OUTDATED
) {
1502 if ($reqinfo->availability
== $pluginman::REQUIREMENT_AVAILABLE
) {
1503 $label = html_writer
::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-warning');
1504 $label .= ' '.html_writer
::span(get_string('dependencyavailable', 'core_plugin'), 'badge badge-warning');
1505 $class = 'requires-failed requires-outdated requires-available';
1506 $displayupdateslink = true;
1509 $label = html_writer
::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
1510 $label .= ' '.html_writer
::span(get_string('dependencyunavailable', 'core_plugin'),
1511 'badge badge-danger');
1512 $class = 'requires-failed requires-outdated requires-unavailable';
1514 $displayuploadlink = true;
1517 if ($reqinfo->reqver
!= ANY_VERSION
) {
1518 $str = 'otherpluginversion';
1520 $str = 'otherplugin';
1523 $requires[] = html_writer
::tag('li', html_writer
::span(
1524 get_string($str, 'core_plugin', array('component' => $reqname, 'version' => $reqinfo->reqver
)),
1525 'dep dep-plugin').' '.$label.' '.html_writer
::span(implode(' | ', $actions), 'actions'),
1526 array('class' => $class)
1535 $out = html_writer
::tag('ul', implode("\n", $requires));
1537 if ($displayuploadlink) {
1538 $out .= html_writer
::div(
1540 new moodle_url('/admin/tool/installaddon/'),
1541 get_string('dependencyuploadmissing', 'core_plugin')
1543 'dependencyuploadmissing'
1547 if ($displayupdateslink) {
1548 $out .= html_writer
::div(
1550 new moodle_url($this->page
->url
, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1551 get_string('checkforupdates', 'core_plugin')
1562 * Prints an overview about the plugins - number of installed, number of extensions etc.
1564 * @param core_plugin_manager $pluginman provides information about the plugins
1565 * @param array $options filtering options
1566 * @return string as usually
1568 public function plugins_overview_panel(core_plugin_manager
$pluginman, array $options = array()) {
1570 $plugininfo = $pluginman->get_plugins();
1572 $numtotal = $numextension = $numupdatable = 0;
1574 foreach ($plugininfo as $type => $plugins) {
1575 foreach ($plugins as $name => $plugin) {
1576 if ($plugin->available_updates()) {
1579 if ($plugin->get_status() === core_plugin_manager
::PLUGIN_STATUS_MISSING
) {
1583 if (!$plugin->is_standard()) {
1589 $infoall = html_writer
::link(
1590 new moodle_url($this->page
->url
, array('contribonly' => 0, 'updatesonly' => 0)),
1591 get_string('overviewall', 'core_plugin'),
1592 array('title' => get_string('filterall', 'core_plugin'))
1593 ).' '.html_writer
::span($numtotal, 'badge number number-all');
1595 $infoext = html_writer
::link(
1596 new moodle_url($this->page
->url
, array('contribonly' => 1, 'updatesonly' => 0)),
1597 get_string('overviewext', 'core_plugin'),
1598 array('title' => get_string('filtercontribonly', 'core_plugin'))
1599 ).' '.html_writer
::span($numextension, 'badge number number-additional');
1601 if ($numupdatable) {
1602 $infoupdatable = html_writer
::link(
1603 new moodle_url($this->page
->url
, array('contribonly' => 0, 'updatesonly' => 1)),
1604 get_string('overviewupdatable', 'core_plugin'),
1605 array('title' => get_string('filterupdatesonly', 'core_plugin'))
1606 ).' '.html_writer
::span($numupdatable, 'badge badge-info number number-updatable');
1608 // No updates, or the notifications disabled.
1609 $infoupdatable = '';
1612 $out = html_writer
::start_div('', array('id' => 'plugins-overview-panel'));
1614 if (!empty($options['updatesonly'])) {
1615 $out .= $this->output
->heading(get_string('overviewupdatable', 'core_plugin'), 3);
1616 } else if (!empty($options['contribonly'])) {
1617 $out .= $this->output
->heading(get_string('overviewext', 'core_plugin'), 3);
1620 if ($numupdatable) {
1621 $installableupdates = $pluginman->filter_installable($pluginman->available_updates());
1622 if ($installableupdates) {
1623 $out .= $this->output
->single_button(
1624 new moodle_url($this->page
->url
, array('installupdatex' => 1)),
1625 get_string('updateavailableinstallall', 'core_admin', count($installableupdates)),
1627 array('class' => 'singlebutton updateavailableinstallall')
1632 $out .= html_writer
::div($infoall, 'info info-all').
1633 html_writer
::div($infoext, 'info info-ext').
1634 html_writer
::div($infoupdatable, 'info info-updatable');
1636 $out .= html_writer
::end_div(); // End of #plugins-overview-panel block.
1642 * Displays all known plugins and links to manage them
1644 * This default implementation renders all plugins into one big table.
1646 * @param core_plugin_manager $pluginman provides information about the plugins.
1647 * @param array $options filtering options
1648 * @return string HTML code
1650 public function plugins_control_panel(core_plugin_manager
$pluginman, array $options = array()) {
1652 $plugininfo = $pluginman->get_plugins();
1654 // Filter the list of plugins according the options.
1655 if (!empty($options['updatesonly'])) {
1656 $updateable = array();
1657 foreach ($plugininfo as $plugintype => $pluginnames) {
1658 foreach ($pluginnames as $pluginname => $pluginfo) {
1659 $pluginavailableupdates = $pluginfo->available_updates();
1660 if (!empty($pluginavailableupdates)) {
1661 foreach ($pluginavailableupdates as $pluginavailableupdate) {
1662 $updateable[$plugintype][$pluginname] = $pluginfo;
1667 $plugininfo = $updateable;
1670 if (!empty($options['contribonly'])) {
1671 $contribs = array();
1672 foreach ($plugininfo as $plugintype => $pluginnames) {
1673 foreach ($pluginnames as $pluginname => $pluginfo) {
1674 if (!$pluginfo->is_standard()) {
1675 $contribs[$plugintype][$pluginname] = $pluginfo;
1679 $plugininfo = $contribs;
1682 if (empty($plugininfo)) {
1686 $table = new html_table();
1687 $table->id
= 'plugins-control-panel';
1688 $table->head
= array(
1689 get_string('displayname', 'core_plugin'),
1690 get_string('version', 'core_plugin'),
1691 get_string('availability', 'core_plugin'),
1692 get_string('actions', 'core_plugin'),
1693 get_string('notes','core_plugin'),
1695 $table->headspan
= array(1, 1, 1, 2, 1);
1696 $table->colclasses
= array(
1697 'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
1700 foreach ($plugininfo as $type => $plugins) {
1701 $heading = $pluginman->plugintype_name_plural($type);
1702 $pluginclass = core_plugin_manager
::resolve_plugininfo_class($type);
1703 if ($manageurl = $pluginclass::get_manage_url()) {
1704 $heading .= $this->output
->action_icon($manageurl, new pix_icon('i/settings',
1705 get_string('settings', 'core_plugin')));
1707 $header = new html_table_cell(html_writer
::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
1708 $header->header
= true;
1709 $header->colspan
= array_sum($table->headspan
);
1710 $header = new html_table_row(array($header));
1711 $header->attributes
['class'] = 'plugintypeheader type-' . $type;
1712 $table->data
[] = $header;
1714 if (empty($plugins)) {
1715 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1716 $msg->colspan
= array_sum($table->headspan
);
1717 $row = new html_table_row(array($msg));
1718 $row->attributes
['class'] .= 'msg msg-noneinstalled';
1719 $table->data
[] = $row;
1723 foreach ($plugins as $name => $plugin) {
1724 $row = new html_table_row();
1725 $row->attributes
['class'] = 'type-' . $plugin->type
. ' name-' . $plugin->type
. '_' . $plugin->name
;
1727 if ($this->page
->theme
->resolve_image_location('icon', $plugin->type
. '_' . $plugin->name
, null)) {
1728 $icon = $this->output
->pix_icon('icon', '', $plugin->type
. '_' . $plugin->name
, array('class' => 'icon pluginicon'));
1730 $icon = $this->output
->spacer();
1732 $status = $plugin->get_status();
1733 $row->attributes
['class'] .= ' status-'.$status;
1734 $pluginname = html_writer
::tag('div', $icon.$plugin->displayname
, array('class' => 'displayname')).
1735 html_writer
::tag('div', $plugin->component
, array('class' => 'componentname'));
1736 $pluginname = new html_table_cell($pluginname);
1738 $version = html_writer
::div($plugin->versiondb
, 'versionnumber');
1739 if ((string)$plugin->release
!== '') {
1740 $version = html_writer
::div($plugin->release
, 'release').$version;
1742 $version = new html_table_cell($version);
1744 $isenabled = $plugin->is_enabled();
1745 if (is_null($isenabled)) {
1746 $availability = new html_table_cell('');
1747 } else if ($isenabled) {
1748 $row->attributes
['class'] .= ' enabled';
1749 $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
1751 $row->attributes
['class'] .= ' disabled';
1752 $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
1755 $settingsurl = $plugin->get_settings_url();
1756 if (!is_null($settingsurl)) {
1757 $settings = html_writer
::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1761 $settings = new html_table_cell($settings);
1763 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component
, 'overview')) {
1764 $uninstall = html_writer
::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1768 $uninstall = new html_table_cell($uninstall);
1770 if ($plugin->is_standard()) {
1771 $row->attributes
['class'] .= ' standard';
1774 $row->attributes
['class'] .= ' extension';
1775 $source = html_writer
::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
1778 if ($status === core_plugin_manager
::PLUGIN_STATUS_MISSING
) {
1779 $msg = html_writer
::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
1780 } else if ($status === core_plugin_manager
::PLUGIN_STATUS_NEW
) {
1781 $msg = html_writer
::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
1786 $requriedby = $pluginman->other_plugins_that_require($plugin->component
);
1788 $requiredby = html_writer
::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1789 array('class' => 'requiredby'));
1795 if (is_array($plugin->available_updates())) {
1796 foreach ($plugin->available_updates() as $availableupdate) {
1797 $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
1801 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
1803 $row->cells
= array(
1804 $pluginname, $version, $availability, $settings, $uninstall, $notes
1806 $table->data
[] = $row;
1810 return html_writer
::table($table);
1814 * Helper method to render the information about the available plugin update
1816 * @param core_plugin_manager $pluginman plugin manager instance
1817 * @param \core\update\info $updateinfo information about the available update for the plugin
1819 protected function plugin_available_update_info(core_plugin_manager
$pluginman, \core\update\info
$updateinfo) {
1821 $boxclasses = 'pluginupdateinfo';
1824 if (isset($updateinfo->release
)) {
1825 $info[] = html_writer
::div(
1826 get_string('updateavailable_release', 'core_plugin', $updateinfo->release
),
1831 if (isset($updateinfo->maturity
)) {
1832 $info[] = html_writer
::div(
1833 get_string('maturity'.$updateinfo->maturity
, 'core_admin'),
1836 $boxclasses .= ' maturity'.$updateinfo->maturity
;
1839 if (isset($updateinfo->download
)) {
1840 $info[] = html_writer
::div(
1841 html_writer
::link($updateinfo->download
, get_string('download')),
1846 if (isset($updateinfo->url
)) {
1847 $info[] = html_writer
::div(
1848 html_writer
::link($updateinfo->url
, get_string('updateavailable_moreinfo', 'core_plugin')),
1853 $box = html_writer
::start_div($boxclasses);
1854 $box .= html_writer
::div(
1855 get_string('updateavailable', 'core_plugin', $updateinfo->version
),
1858 $box .= html_writer
::div(
1859 implode(html_writer
::span(' ', 'separator'), $info),
1863 if ($pluginman->is_remote_plugin_installable($updateinfo->component
, $updateinfo->version
, $reason)) {
1864 $box .= $this->output
->single_button(
1865 new moodle_url($this->page
->url
, array('installupdate' => $updateinfo->component
,
1866 'installupdateversion' => $updateinfo->version
)),
1867 get_string('updateavailableinstall', 'core_admin'),
1869 array('class' => 'singlebutton updateavailableinstall')
1872 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1874 $box .= html_writer
::div($reasonhelp, 'reasonhelp updateavailableinstall');
1877 $box .= html_writer
::end_div();
1883 * This function will render one beautiful table with all the environmental
1884 * configuration and how it suits Moodle needs.
1886 * @param boolean $result final result of the check (true/false)
1887 * @param environment_results[] $environment_results array of results gathered
1888 * @return string HTML to output.
1890 public function environment_check_table($result, $environment_results) {
1894 $servertable = new html_table();//table for server checks
1895 $servertable->head
= array(
1898 get_string('report'),
1899 get_string('plugin'),
1900 get_string('status'),
1902 $servertable->colclasses
= array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
1903 $servertable->attributes
['class'] = 'admintable environmenttable generaltable';
1904 $servertable->id
= 'serverstatus';
1906 $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1908 $othertable = new html_table();//table for custom checks
1909 $othertable->head
= array(
1911 get_string('report'),
1912 get_string('plugin'),
1913 get_string('status'),
1915 $othertable->colclasses
= array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
1916 $othertable->attributes
['class'] = 'admintable environmenttable generaltable';
1917 $othertable->id
= 'otherserverstatus';
1919 $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1921 // Iterate over each environment_result
1923 foreach ($environment_results as $environment_result) {
1925 $warningline = false;
1928 $type = $environment_result->getPart();
1929 $info = $environment_result->getInfo();
1930 $status = $environment_result->getStatus();
1931 $plugin = $environment_result->getPluginName();
1932 $error_code = $environment_result->getErrorCode();
1933 // Process Report field
1934 $rec = new stdClass();
1935 // Something has gone wrong at parsing time
1937 $stringtouse = 'environmentxmlerror';
1938 $rec->error_code
= $error_code;
1939 $status = get_string('error');
1945 if ($rec->needed
= $environment_result->getNeededVersion()) {
1946 // We are comparing versions
1947 $rec->current
= $environment_result->getCurrentVersion();
1948 if ($environment_result->getLevel() == 'required') {
1949 $stringtouse = 'environmentrequireversion';
1951 $stringtouse = 'environmentrecommendversion';
1954 } else if ($environment_result->getPart() == 'custom_check') {
1955 // We are checking installed & enabled things
1956 if ($environment_result->getLevel() == 'required') {
1957 $stringtouse = 'environmentrequirecustomcheck';
1959 $stringtouse = 'environmentrecommendcustomcheck';
1962 } else if ($environment_result->getPart() == 'php_setting') {
1964 $stringtouse = 'environmentsettingok';
1965 } else if ($environment_result->getLevel() == 'required') {
1966 $stringtouse = 'environmentmustfixsetting';
1968 $stringtouse = 'environmentshouldfixsetting';
1972 if ($environment_result->getLevel() == 'required') {
1973 $stringtouse = 'environmentrequireinstall';
1975 $stringtouse = 'environmentrecommendinstall';
1979 // Calculate the status value
1980 if ($environment_result->getBypassStr() != '') { //Handle bypassed result (warning)
1981 $status = get_string('bypassed');
1982 $warningline = true;
1983 } else if ($environment_result->getRestrictStr() != '') { //Handle restricted result (error)
1984 $status = get_string('restricted');
1987 if ($status) { //Handle ok result (ok)
1988 $status = get_string('ok');
1990 if ($environment_result->getLevel() == 'optional') {//Handle check result (warning)
1991 $status = get_string('check');
1992 $warningline = true;
1993 } else { //Handle error result (error)
1994 $status = get_string('check');
2002 $linkparts = array();
2003 $linkparts[] = 'admin/environment';
2004 $linkparts[] = $type;
2006 $linkparts[] = $info;
2008 // Plugin environments do not have docs pages yet.
2009 if (empty($CFG->docroot
) or $environment_result->plugin
) {
2010 $report = get_string($stringtouse, 'admin', $rec);
2012 $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec), true);
2014 // Enclose report text in div so feedback text will be displayed underneath it.
2015 $report = html_writer
::div($report);
2017 // Format error or warning line
2019 $messagetype = 'error';
2020 $statusclass = 'badge-danger';
2021 } else if ($warningline) {
2022 $messagetype = 'warn';
2023 $statusclass = 'badge-warning';
2025 $messagetype = 'ok';
2026 $statusclass = 'badge-success';
2028 $status = html_writer
::span($status, 'badge ' . $statusclass);
2029 // Here we'll store all the feedback found
2031 // Append the feedback if there is some
2032 $feedbacktext .= $environment_result->strToReport($environment_result->getFeedbackStr(), $messagetype);
2033 //Append the bypass if there is some
2034 $feedbacktext .= $environment_result->strToReport($environment_result->getBypassStr(), 'warn');
2035 //Append the restrict if there is some
2036 $feedbacktext .= $environment_result->strToReport($environment_result->getRestrictStr(), 'error');
2038 $report .= $feedbacktext;
2040 // Add the row to the table
2041 if ($environment_result->getPart() == 'custom_check'){
2042 $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
2044 $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
2049 //put errors first in
2050 $servertable->data
= array_merge($serverdata['error'], $serverdata['warn'], $serverdata['ok']);
2051 $othertable->data
= array_merge($otherdata['error'], $otherdata['warn'], $otherdata['ok']);
2055 $output .= $this->heading(get_string('serverchecks', 'admin'));
2056 $output .= html_writer
::table($servertable);
2057 if (count($othertable->data
)){
2058 $output .= $this->heading(get_string('customcheck', 'admin'));
2059 $output .= html_writer
::table($othertable);
2062 // Finally, if any error has happened, print the summary box
2064 $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2071 * Render a simple page for providing the upgrade key.
2073 * @param moodle_url|string $url
2076 public function upgradekey_form_page($url) {
2079 $output .= $this->header();
2080 $output .= $this->container_start('upgradekeyreq');
2081 $output .= $this->heading(get_string('upgradekeyreq', 'core_admin'));
2082 $output .= html_writer
::start_tag('form', array('method' => 'POST', 'action' => $url));
2083 $output .= html_writer
::empty_tag('input', array('name' => 'upgradekey', 'type' => 'password'));
2084 $output .= html_writer
::empty_tag('input', array('value' => get_string('submit'), 'type' => 'submit'));
2085 $output .= html_writer
::end_tag('form');
2086 $output .= $this->container_end();
2087 $output .= $this->footer();
2093 * Check to see if writing to the deprecated legacy log store is enabled.
2095 * @return string An error message if writing to the legacy log store is enabled.
2097 protected function legacy_log_store_writing_error() {
2098 $enabled = get_config('logstore_legacy', 'loglegacy');
2099 $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2100 $enabled = $enabled && in_array('logstore_legacy', $plugins);
2103 return $this->warning(get_string('legacylogginginuse'));
2108 * Display message about the benefits of registering on Moodle.org
2112 public function moodleorg_registration_message() {
2113 return format_text(get_string('registermoodlenet', 'admin'), FORMAT_HTML
, ['noclean' => true]);