/admin/renderer.php
PHP | 2211 lines | 1432 code | 327 blank | 452 comment | 252 complexity | 7ce1caab791c92ea7c24e8b8bf3d9544 MD5 | raw file
Possible License(s): BSD-3-Clause, MIT, GPL-3.0, Apache-2.0, LGPL-2.1
Large files files are truncated, but you can click here to view the full file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * Renderer for core_admin subsystem
- *
- * @package core
- * @subpackage admin
- * @copyright 2011 David Mudrak <david@moodle.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- /**
- * Standard HTML output renderer for core_admin subsystem
- */
- class core_admin_renderer extends plugin_renderer_base {
- /**
- * Display the 'Do you acknowledge the terms of the GPL' page. The first page
- * during install.
- * @return string HTML to output.
- */
- public function install_licence_page() {
- global $CFG;
- $output = '';
- $copyrightnotice = text_to_html(get_string('gpl3'));
- $copyrightnotice = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $copyrightnotice); // extremely ugly validation hack
- $continue = new single_button(new moodle_url($this->page->url, array(
- 'lang' => $CFG->lang, 'agreelicense' => 1)), get_string('continue'), 'get');
- $output .= $this->header();
- $output .= $this->heading('<a href="http://moodle.org">Moodle</a> - Modular Object-Oriented Dynamic Learning Environment');
- $output .= $this->heading(get_string('copyrightnotice'));
- $output .= $this->box($copyrightnotice, 'copyrightnotice');
- $output .= html_writer::empty_tag('br');
- $output .= $this->confirm(get_string('doyouagree'), $continue, "http://docs.moodle.org/dev/License");
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display page explaining proper upgrade process,
- * there can not be any PHP file leftovers...
- *
- * @return string HTML to output.
- */
- public function upgrade_stale_php_files_page() {
- $output = '';
- $output .= $this->header();
- $output .= $this->heading(get_string('upgradestalefiles', 'admin'));
- $output .= $this->box_start('generalbox', 'notice');
- $output .= format_text(get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading')), FORMAT_MARKDOWN);
- $output .= html_writer::empty_tag('br');
- $output .= html_writer::tag('div', $this->single_button($this->page->url, get_string('reload'), 'get'), array('class' => 'buttons'));
- $output .= $this->box_end();
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display the 'environment check' page that is displayed during install.
- * @param int $maturity
- * @param boolean $envstatus final result of the check (true/false)
- * @param array $environment_results array of results gathered
- * @param string $release moodle release
- * @return string HTML to output.
- */
- public function install_environment_page($maturity, $envstatus, $environment_results, $release) {
- global $CFG;
- $output = '';
- $output .= $this->header();
- $output .= $this->maturity_warning($maturity);
- $output .= $this->heading("Moodle $release");
- $output .= $this->release_notes_link();
- $output .= $this->environment_check_table($envstatus, $environment_results);
- if (!$envstatus) {
- $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('agreelicense' => 1, 'lang' => $CFG->lang)));
- } else {
- $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
- $output .= $this->continue_button(new moodle_url($this->page->url, array(
- 'agreelicense' => 1, 'confirmrelease' => 1, 'lang' => $CFG->lang)));
- }
- $output .= $this->footer();
- return $output;
- }
- /**
- * Displays the list of plugins with unsatisfied dependencies
- *
- * @param double|string|int $version Moodle on-disk version
- * @param array $failed list of plugins with unsatisfied dependecies
- * @param moodle_url $reloadurl URL of the page to recheck the dependencies
- * @return string HTML
- */
- public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
- $output = '';
- $output .= $this->header();
- $output .= $this->heading(get_string('pluginscheck', 'admin'));
- $output .= $this->warning(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
- $output .= $this->plugins_check_table(core_plugin_manager::instance(), $version, array('xdep' => true));
- $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
- $output .= $this->continue_button($reloadurl);
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display the 'You are about to upgrade Moodle' page. The first page
- * during upgrade.
- * @param string $strnewversion
- * @param int $maturity
- * @param string $testsite
- * @return string HTML to output.
- */
- public function upgrade_confirm_page($strnewversion, $maturity, $testsite) {
- $output = '';
- $continueurl = new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0));
- $continue = new single_button($continueurl, get_string('continue'), 'get');
- $cancelurl = new moodle_url('/admin/index.php');
- $output .= $this->header();
- $output .= $this->maturity_warning($maturity);
- $output .= $this->test_site_warning($testsite);
- $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continue, $cancelurl);
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display the environment page during the upgrade process.
- * @param string $release
- * @param boolean $envstatus final result of env check (true/false)
- * @param array $environment_results array of results gathered
- * @return string HTML to output.
- */
- public function upgrade_environment_page($release, $envstatus, $environment_results) {
- global $CFG;
- $output = '';
- $output .= $this->header();
- $output .= $this->heading("Moodle $release");
- $output .= $this->release_notes_link();
- $output .= $this->environment_check_table($envstatus, $environment_results);
- if (!$envstatus) {
- $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0)));
- } else {
- $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
- if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
- $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
- }
- $output .= $this->continue_button(new moodle_url($this->page->url, array(
- 'confirmupgrade' => 1, 'confirmrelease' => 1, 'cache' => 0)));
- }
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display the upgrade page that lists all the plugins that require attention.
- * @param core_plugin_manager $pluginman provides information about the plugins.
- * @param \core\update\checker $checker provides information about available updates.
- * @param int $version the version of the Moodle code from version.php.
- * @param bool $showallplugins
- * @param moodle_url $reloadurl
- * @param moodle_url $continueurl
- * @return string HTML to output.
- */
- public function upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,
- $version, $showallplugins, $reloadurl, $continueurl) {
- $output = '';
- $output .= $this->header();
- $output .= $this->box_start('generalbox', 'plugins-check-page');
- $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'), array('class' => 'page-description'));
- $output .= $this->check_for_updates_button($checker, $reloadurl);
- $output .= $this->missing_dependencies($pluginman);
- $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
- $output .= $this->box_end();
- $output .= $this->upgrade_reload($reloadurl);
- if ($pluginman->some_plugins_updatable()) {
- $output .= $this->container_start('upgradepluginsinfo');
- $output .= $this->help_icon('upgradepluginsinfo', 'core_admin', get_string('upgradepluginsfirst', 'core_admin'));
- $output .= $this->container_end();
- }
- $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get', true);
- $button->class = 'continuebutton';
- $output .= $this->render($button);
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display a page to confirm plugin installation cancelation.
- *
- * @param array $abortable list of \core\update\plugininfo
- * @param moodle_url $continue
- * @return string
- */
- public function upgrade_confirm_abort_install_page(array $abortable, moodle_url $continue) {
- $pluginman = core_plugin_manager::instance();
- if (empty($abortable)) {
- // The UI should not allow this.
- throw new moodle_exception('err_no_plugin_install_abortable', 'core_plugin');
- }
- $out = $this->output->header();
- $out .= $this->output->heading(get_string('cancelinstallhead', 'core_plugin'), 3);
- $out .= $this->output->container(get_string('cancelinstallinfo', 'core_plugin'), 'cancelinstallinfo');
- foreach ($abortable as $pluginfo) {
- $out .= $this->output->heading($pluginfo->displayname.' ('.$pluginfo->component.')', 4);
- $out .= $this->output->container(get_string('cancelinstallinfodir', 'core_plugin', $pluginfo->rootdir));
- if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
- $out .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
- 'alert alert-warning mt-2');
- }
- }
- $out .= $this->plugins_management_confirm_buttons($continue, $this->page->url);
- $out .= $this->output->footer();
- return $out;
- }
- /**
- * Display the admin notifications page.
- * @param int $maturity
- * @param bool $insecuredataroot warn dataroot is invalid
- * @param bool $errorsdisplayed warn invalid dispaly error setting
- * @param bool $cronoverdue warn cron not running
- * @param bool $dbproblems warn db has problems
- * @param bool $maintenancemode warn in maintenance mode
- * @param bool $buggyiconvnomb warn iconv problems
- * @param array|null $availableupdates array of \core\update\info objects or null
- * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
- * @param string[] $cachewarnings An array containing warnings from the Cache API.
- * @param array $eventshandlers Events 1 API handlers.
- * @param bool $themedesignermode Warn about the theme designer mode.
- * @param bool $devlibdir Warn about development libs directory presence.
- * @param bool $mobileconfigured Whether the mobile web services have been enabled
- * @param bool $overridetossl Whether or not ssl is being forced.
- * @param bool $invalidforgottenpasswordurl Whether the forgotten password URL does not link to a valid URL.
- * @param bool $croninfrequent If true, warn that cron hasn't run in the past few minutes
- * @param bool $showcampaigncontent Whether the campaign content should be visible or not.
- * @param bool $showfeedbackencouragement Whether the feedback encouragement content should be displayed or not.
- *
- * @return string HTML to output.
- */
- public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
- $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
- $buggyiconvnomb, $registered, array $cachewarnings = array(), $eventshandlers = 0,
- $themedesignermode = false, $devlibdir = false, $mobileconfigured = false,
- $overridetossl = false, $invalidforgottenpasswordurl = false, $croninfrequent = false,
- $showcampaigncontent = false, bool $showfeedbackencouragement = false) {
- global $CFG;
- $output = '';
- $output .= $this->header();
- $output .= $this->maturity_info($maturity);
- $output .= $this->legacy_log_store_writing_error();
- $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
- $output .= $this->insecure_dataroot_warning($insecuredataroot);
- $output .= $this->development_libs_directories_warning($devlibdir);
- $output .= $this->themedesignermode_warning($themedesignermode);
- $output .= $this->display_errors_warning($errorsdisplayed);
- $output .= $this->buggy_iconv_warning($buggyiconvnomb);
- $output .= $this->cron_overdue_warning($cronoverdue);
- $output .= $this->cron_infrequent_warning($croninfrequent);
- $output .= $this->db_problems($dbproblems);
- $output .= $this->maintenance_mode_warning($maintenancemode);
- $output .= $this->overridetossl_warning($overridetossl);
- $output .= $this->cache_warnings($cachewarnings);
- $output .= $this->events_handlers($eventshandlers);
- $output .= $this->registration_warning($registered);
- $output .= $this->mobile_configuration_warning($mobileconfigured);
- $output .= $this->forgotten_password_url_warning($invalidforgottenpasswordurl);
- $output .= $this->userfeedback_encouragement($showfeedbackencouragement);
- $output .= $this->campaign_content($showcampaigncontent);
- //////////////////////////////////////////////////////////////////////////////////////////////////
- //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
- $output .= $this->moodle_copyright();
- //////////////////////////////////////////////////////////////////////////////////////////////////
- $output .= $this->footer();
- return $output;
- }
- /**
- * Display the plugin management page (admin/plugins.php).
- *
- * The filtering options array may contain following items:
- * bool contribonly - show only contributed extensions
- * bool updatesonly - show only plugins with an available update
- *
- * @param core_plugin_manager $pluginman
- * @param \core\update\checker $checker
- * @param array $options filtering options
- * @return string HTML to output.
- */
- public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
- $output = '';
- $output .= $this->header();
- $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
- $output .= $this->check_for_updates_button($checker, $this->page->url);
- $output .= $this->plugins_overview_panel($pluginman, $options);
- $output .= $this->plugins_control_panel($pluginman, $options);
- $output .= $this->footer();
- return $output;
- }
- /**
- * Renders a button to fetch for available updates.
- *
- * @param \core\update\checker $checker
- * @param moodle_url $reloadurl
- * @return string HTML
- */
- public function check_for_updates_button(\core\update\checker $checker, $reloadurl) {
- $output = '';
- if ($checker->enabled()) {
- $output .= $this->container_start('checkforupdates mb-4');
- $output .= $this->single_button(
- new moodle_url($reloadurl, array('fetchupdates' => 1)),
- get_string('checkforupdates', 'core_plugin')
- );
- if ($timefetched = $checker->get_last_timefetched()) {
- $timefetched = userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'));
- $output .= $this->container(get_string('checkforupdateslast', 'core_plugin', $timefetched),
- 'lasttimefetched small text-muted mt-1');
- }
- $output .= $this->container_end();
- }
- return $output;
- }
- /**
- * Display a page to confirm the plugin uninstallation.
- *
- * @param core_plugin_manager $pluginman
- * @param \core\plugininfo\base $pluginfo
- * @param moodle_url $continueurl URL to continue after confirmation
- * @param moodle_url $cancelurl URL to to go if cancelled
- * @return string
- */
- public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
- $output = '';
- $pluginname = $pluginman->plugin_name($pluginfo->component);
- $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
- if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
- $confirm .= $extraconfirm;
- }
- $output .= $this->output->header();
- $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
- $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
- $output .= $this->output->footer();
- return $output;
- }
- /**
- * Display a page with results of plugin uninstallation and offer removal of plugin files.
- *
- * @param core_plugin_manager $pluginman
- * @param \core\plugininfo\base $pluginfo
- * @param progress_trace_buffer $progress
- * @param moodle_url $continueurl URL to continue to remove the plugin folder
- * @return string
- */
- public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
- progress_trace_buffer $progress, moodle_url $continueurl) {
- $output = '';
- $pluginname = $pluginman->plugin_name($pluginfo->component);
- // Do not show navigation here, they must click one of the buttons.
- $this->page->set_pagelayout('maintenance');
- $this->page->set_cacheable(false);
- $output .= $this->output->header();
- $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
- $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
- $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
- array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
- if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
- $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
- 'alert alert-warning mt-2');
- }
- // After any uninstall we must execute full upgrade to finish the cleanup!
- $output .= $this->output->confirm($confirm, $continueurl, new moodle_url('/admin/index.php'));
- $output .= $this->output->footer();
- return $output;
- }
- /**
- * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
- *
- * @param core_plugin_manager $pluginman
- * @param \core\plugininfo\base $pluginfo
- * @param progress_trace_buffer $progress
- * @return string
- */
- public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
- $output = '';
- $pluginname = $pluginfo->component;
- $output .= $this->output->header();
- $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
- $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
- $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
- array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
- $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
- $output .= $this->output->footer();
- return $output;
- }
- /**
- * Display the plugin management page (admin/environment.php).
- * @param array $versions
- * @param string $version
- * @param boolean $envstatus final result of env check (true/false)
- * @param array $environment_results array of results gathered
- * @return string HTML to output.
- */
- public function environment_check_page($versions, $version, $envstatus, $environment_results) {
- $output = '';
- $output .= $this->header();
- // Print the component download link
- $output .= html_writer::tag('div', html_writer::link(
- new moodle_url('/admin/environment.php', array('action' => 'updatecomponent', 'sesskey' => sesskey())),
- get_string('updatecomponent', 'admin')),
- array('class' => 'reportlink'));
- // Heading.
- $output .= $this->heading(get_string('environment', 'admin'));
- // Box with info and a menu to choose the version.
- $output .= $this->box_start();
- $output .= html_writer::tag('div', get_string('adminhelpenvironment'));
- $select = new single_select(new moodle_url('/admin/environment.php'), 'version', $versions, $version, null);
- $select->label = get_string('moodleversion');
- $output .= $this->render($select);
- $output .= $this->box_end();
- // The results
- $output .= $this->environment_check_table($envstatus, $environment_results);
- $output .= $this->footer();
- return $output;
- }
- /**
- * Output a warning message, of the type that appears on the admin notifications page.
- * @param string $message the message to display.
- * @param string $type type class
- * @return string HTML to output.
- */
- protected function warning($message, $type = 'warning') {
- return $this->box($message, 'generalbox alert alert-' . $type);
- }
- /**
- * Render an appropriate message if dataroot is insecure.
- * @param bool $insecuredataroot
- * @return string HTML to output.
- */
- protected function insecure_dataroot_warning($insecuredataroot) {
- global $CFG;
- if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
- return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
- } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
- return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'danger');
- } else {
- return '';
- }
- }
- /**
- * Render a warning that a directory with development libs is present.
- *
- * @param bool $devlibdir True if the warning should be displayed.
- * @return string
- */
- protected function development_libs_directories_warning($devlibdir) {
- if ($devlibdir) {
- $moreinfo = new moodle_url('/report/security/index.php');
- $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
- return $this->warning($warning, 'danger');
- } else {
- return '';
- }
- }
- /**
- * Render an appropriate message if dataroot is insecure.
- * @param bool $errorsdisplayed
- * @return string HTML to output.
- */
- protected function display_errors_warning($errorsdisplayed) {
- if (!$errorsdisplayed) {
- return '';
- }
- return $this->warning(get_string('displayerrorswarning', 'admin'));
- }
- /**
- * Render an appropriate message if themdesignermode is enabled.
- * @param bool $themedesignermode true if enabled
- * @return string HTML to output.
- */
- protected function themedesignermode_warning($themedesignermode) {
- if (!$themedesignermode) {
- return '';
- }
- return $this->warning(get_string('themedesignermodewarning', 'admin'));
- }
- /**
- * Render an appropriate message if iconv is buggy and mbstring missing.
- * @param bool $buggyiconvnomb
- * @return string HTML to output.
- */
- protected function buggy_iconv_warning($buggyiconvnomb) {
- if (!$buggyiconvnomb) {
- return '';
- }
- return $this->warning(get_string('warningiconvbuggy', 'admin'));
- }
- /**
- * Render an appropriate message if cron has not been run recently.
- * @param bool $cronoverdue
- * @return string HTML to output.
- */
- public function cron_overdue_warning($cronoverdue) {
- global $CFG;
- if (!$cronoverdue) {
- return '';
- }
- $check = new \tool_task\check\cronrunning();
- $result = $check->get_result();
- return $this->warning($result->get_summary() . ' ' . $this->help_icon('cron', 'admin'));
- }
- /**
- * Render an appropriate message if cron is not being run frequently (recommended every minute).
- *
- * @param bool $croninfrequent
- * @return string HTML to output.
- */
- public function cron_infrequent_warning(bool $croninfrequent) : string {
- global $CFG;
- if (!$croninfrequent) {
- return '';
- }
- $check = new \tool_task\check\cronrunning();
- $result = $check->get_result();
- return $this->warning($result->get_summary() . ' ' . $this->help_icon('cron', 'admin'));
- }
- /**
- * Render an appropriate message if there are any problems with the DB set-up.
- * @param bool $dbproblems
- * @return string HTML to output.
- */
- public function db_problems($dbproblems) {
- if (!$dbproblems) {
- return '';
- }
- return $this->warning($dbproblems);
- }
- /**
- * Renders cache warnings if there are any.
- *
- * @param string[] $cachewarnings
- * @return string
- */
- public function cache_warnings(array $cachewarnings) {
- if (!count($cachewarnings)) {
- return '';
- }
- return join("\n", array_map(array($this, 'warning'), $cachewarnings));
- }
- /**
- * Renders events 1 API handlers warning.
- *
- * @param array $eventshandlers
- * @return string
- */
- public function events_handlers($eventshandlers) {
- if ($eventshandlers) {
- $components = '';
- foreach ($eventshandlers as $eventhandler) {
- $components .= $eventhandler->component . ', ';
- }
- $components = rtrim($components, ', ');
- return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
- }
- }
- /**
- * Render an appropriate message if the site in in maintenance mode.
- * @param bool $maintenancemode
- * @return string HTML to output.
- */
- public function maintenance_mode_warning($maintenancemode) {
- if (!$maintenancemode) {
- return '';
- }
- $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
- $url = $url->out(); // get_string() does not support objects in params
- return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
- }
- /**
- * Render a warning that ssl is forced because the site was on loginhttps.
- *
- * @param bool $overridetossl Whether or not ssl is being forced.
- * @return string
- */
- protected function overridetossl_warning($overridetossl) {
- if (!$overridetossl) {
- return '';
- }
- $warning = get_string('overridetossl', 'core_admin');
- return $this->warning($warning, 'warning');
- }
- /**
- * Display a warning about installing development code if necesary.
- * @param int $maturity
- * @return string HTML to output.
- */
- protected function maturity_warning($maturity) {
- if ($maturity == MATURITY_STABLE) {
- return ''; // No worries.
- }
- $maturitylevel = get_string('maturity' . $maturity, 'admin');
- return $this->warning(
- $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
- $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
- 'danger');
- }
- /*
- * If necessary, displays a warning about upgrading a test site.
- *
- * @param string $testsite
- * @return string HTML
- */
- protected function test_site_warning($testsite) {
- if (!$testsite) {
- return '';
- }
- $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
- return $this->warning($warning, 'danger');
- }
- /**
- * Output the copyright notice.
- * @return string HTML to output.
- */
- protected function moodle_copyright() {
- global $CFG;
- //////////////////////////////////////////////////////////////////////////////////////////////////
- //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
- $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
- '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
- 'Copyright © 1999 onwards, Martin Dougiamas<br />'.
- 'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
- '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
- //////////////////////////////////////////////////////////////////////////////////////////////////
- return $this->box($copyrighttext, 'copyright');
- }
- /**
- * Display a warning about installing development code if necesary.
- * @param int $maturity
- * @return string HTML to output.
- */
- protected function maturity_info($maturity) {
- if ($maturity == MATURITY_STABLE) {
- return ''; // No worries.
- }
- $level = 'warning';
- if ($maturity == MATURITY_ALPHA) {
- $level = 'danger';
- }
- $maturitylevel = get_string('maturity' . $maturity, 'admin');
- $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
- $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
- return $this->warning($warningtext, $level);
- }
- /**
- * Displays the info about available Moodle core and plugin updates
- *
- * The structure of the $updates param has changed since 2.4. It contains not only updates
- * for the core itself, but also for all other installed plugins.
- *
- * @param array|null $updates array of (string)component => array of \core\update\info objects or null
- * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
- * @return string
- */
- protected function available_updates($updates, $fetch) {
- $updateinfo = '';
- $someupdateavailable = false;
- if (is_array($updates)) {
- if (is_array($updates['core'])) {
- $someupdateavailable = true;
- $updateinfo .= $this->heading(get_string('updateavailable', 'core_admin'), 3);
- foreach ($updates['core'] as $update) {
- $updateinfo .= $this->moodle_available_update_info($update);
- }
- $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
- array('class' => 'updateavailablerecommendation'));
- }
- unset($updates['core']);
- // If something has left in the $updates array now, it is updates for plugins.
- if (!empty($updates)) {
- $someupdateavailable = true;
- $updateinfo .= $this->heading(get_string('updateavailableforplugin', 'core_admin'), 3);
- $pluginsoverviewurl = new moodle_url('/admin/plugins.php', array('updatesonly' => 1));
- $updateinfo .= $this->container(get_string('pluginsoverviewsee', 'core_admin',
- array('url' => $pluginsoverviewurl->out())));
- }
- }
- if (!$someupdateavailable) {
- $now = time();
- if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
- $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
- }
- }
- $updateinfo .= $this->container_start('checkforupdates mt-1');
- $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
- $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
- if ($fetch) {
- $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
- userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
- }
- $updateinfo .= $this->container_end();
- return $this->warning($updateinfo);
- }
- /**
- * Display a warning about not being registered on Moodle.org if necesary.
- *
- * @param boolean $registered true if the site is registered on Moodle.org
- * @return string HTML to output.
- */
- protected function registration_warning($registered) {
- if (!$registered && site_is_public()) {
- if (has_capability('moodle/site:config', context_system::instance())) {
- $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
- get_string('register', 'admin'));
- $str = 'registrationwarning';
- } else {
- $registerbutton = '';
- $str = 'registrationwarningcontactadmin';
- }
- return $this->warning( get_string($str, 'admin')
- . ' ' . $this->help_icon('registration', 'admin') . $registerbutton ,
- 'error alert alert-danger');
- }
- return '';
- }
- /**
- * Return an admin page warning if site is not registered with moodle.org
- *
- * @return string
- */
- public function warn_if_not_registered() {
- return $this->registration_warning(\core\hub\registration::is_registered());
- }
- /**
- * Display a warning about the Mobile Web Services being disabled.
- *
- * @param boolean $mobileconfigured true if mobile web services are enabled
- * @return string HTML to output.
- */
- protected function mobile_configuration_warning($mobileconfigured) {
- $output = '';
- if (!$mobileconfigured) {
- $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
- $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
- $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . ' ' . $configurebutton);
- }
- return $output;
- }
- /**
- * Display campaign content.
- *
- * @param bool $showcampaigncontent Whether the campaign content should be visible or not.
- * @return string the campaign content raw html.
- */
- protected function campaign_content(bool $showcampaigncontent): string {
- if (!$showcampaigncontent) {
- return '';
- }
- return $this->render_from_template('core/campaign_content', ['lang' => current_language()]);
- }
- /**
- * Display a warning about the forgotten password URL not linking to a valid URL.
- *
- * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
- * @return string HTML to output.
- */
- protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
- $output = '';
- if ($invalidforgottenpasswordurl) {
- $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
- $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
- $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . ' ' . $configurebutton,
- 'error alert alert-danger');
- }
- return $output;
- }
- /**
- * Helper method to render the information about the available Moodle update
- *
- * @param \core\update\info $updateinfo information about the available Moodle core update
- */
- protected function moodle_available_update_info(\core\update\info $updateinfo) {
- $boxclasses = 'moodleupdateinfo mb-2';
- $info = array();
- if (isset($updateinfo->release)) {
- $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
- array('class' => 'info release'));
- }
- if (isset($updateinfo->version)) {
- $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
- array('class' => 'info version'));
- }
- if (isset($updateinfo->maturity)) {
- $info[] = html_writer::tag('span', get_string('maturity'.$updateinfo->maturity, 'core_admin'),
- array('class' => 'info maturity'));
- $boxclasses .= ' maturity'.$updateinfo->maturity;
- }
- if (isset($updateinfo->download)) {
- $info[] = html_writer::link($updateinfo->download, get_string('download'),
- array('class' => 'info download btn btn-secondary'));
- }
- if (isset($updateinfo->url)) {
- $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
- array('class' => 'info more'));
- }
- $box = $this->output->container_start($boxclasses);
- $box .= $this->output->container(implode(html_writer::tag('span', ' | ', array('class' => 'separator')), $info), '');
- $box .= $this->output->container_end();
- return $box;
- }
- /**
- * Display a link to the release notes.
- * @return string HTML to output.
- */
- protected function release_notes_link() {
- $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/dev/Releases');
- $releasenoteslink = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $releasenoteslink); // extremely ugly validation hack
- return $this->box($releasenoteslink, 'generalbox alert alert-info');
- }
- /**
- * Display the reload link that appears on several upgrade/install pages.
- * @return string HTML to output.
- */
- function upgrade_reload($url) {
- return html_writer::empty_tag('br') .
- html_writer::tag('div',
- html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
- get_string('reload'), array('title' => get_string('reload'))),
- array('class' => 'continuebutton')) . html_writer::empty_tag('br');
- }
- /**
- * Displays all known plugins and information about their installation or upgrade
- *
- * This default implementation renders all plugins into one big table. The rendering
- * options support:
- * (bool)full = false: whether to display up-to-date plugins, too
- * (bool)xdep = false: display the plugins with unsatisified dependecies only
- *
- * @param core_plugin_manager $pluginman provides information about the plugins.
- * @param int $version the version of the Moodle code from version.php.
- * @param array $options rendering options
- * @return string HTML code
- */
- public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
- global $CFG;
- $plugininfo = $pluginman->get_plugins();
- if (empty($plugininfo)) {
- return '';
- }
- $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
- $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
- $table = new html_table();
- $table->id = 'plugins-check';
- $table->head = array(
- get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
- get_string('versiondb', 'core_plugin'),
- get_string('versiondisk', 'core_plugin'),
- get_string('requires', 'core_plugin'),
- get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
- );
- $table->colclasses = array(
- 'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
- );
- $table->data = array();
- // Number of displayed plugins per type.
- $numdisplayed = array();
- // Number of plugins known to the plugin manager.
- $sumtotal = 0;
- // Number of plugins requiring attention.
- $sumattention = 0;
- // List of all components we can cancel installation of.
- $installabortable = $pluginman->list_cancellable_installations();
- // List of all components we can cancel upgrade of.
- $upgradeabortable = $pluginman->list_restorable_archives();
- foreach ($plugininfo as $type => $plugins) {
- $header = new html_table_cell($pluginman->plugintype_name_plural($type));
- $header->header = true;
- $header->colspan = count($table->head);
- $header = new html_table_row(array($header));
- $header->attributes['class'] = 'plugintypeheader type-' . $type;
- $numdisplayed[$type] = 0;
- if (empty($plugins) and $options['full']) {
- $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
- $msg->colspan = count($table->head);
- $row = new html_table_row(array($msg));
- $row->attributes['class'] .= 'msg msg-noneinstalled';
- $table->data[] = $header;
- $table->data[] = $row;
- continue;
- }
- $plugintyperows = array();
- foreach ($plugins as $name => $plugin) {
- $sumtotal++;
- $row = new html_table_row();
- $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
- if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
- $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
- } else {
- $icon = '';
- }
- $displayname = new html_table_cell(
- $icon.
- html_writer::span($plugin->displayname, 'pluginname').
- html_writer::div($plugin->get_dir(), 'plugindir text-muted small')
- );
- $versiondb = new html_table_cell($plugin->versiondb);
- $versiondisk = new html_table_cell($plugin->versiondisk);
- if ($isstandard = $plugin->is_standard()) {
- $row->attributes['class'] .= ' standard';
- $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext badge badge-secondary');
- } else {
- $row->attributes['class'] .= ' extension';
- $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
- }
- $coredependency = $plugin->is_core_dependency_satisfied($version);
- $incompatibledependency = $plugin->is_core_compatible_satisfied($CFG->branch);
- $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
- $dependenciesok = $coredependency && $otherpluginsdependencies && $incompatibledependency;
- $statuscode = $plugin->get_status();
- $row->attributes['class'] .= ' status-' . $statuscode;
- $statusclass = 'statustext badge ';
- switch ($statuscode) {
- case core_plugin_manager::PLUGIN_STATUS_NEW:
- $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
- break;
- case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
- $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
- break;
- case core_plugin_manager::PLUGIN_STATUS_MISSING:
- case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
- case core_plugin_manager::PLUGIN_STATUS_DELETE:
- $statusclass .= 'badge-danger';
- break;
- case core_plugin_manager::PLUGIN_STATUS_NODB:
- case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
- $statusclass .= $dependenciesok ? 'badge-light' : 'badge-warning';
- break;
- }
- $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
- if (!empty($installabortable[$plugin->component])) {
- $status .= $this->output->single_button(
- new moodle_url($this->page->url, array('abortinstall' => $plugin->component, 'confirmplugincheck' => 0)),
- get_string('cancelinstallone', 'core_plugin'),
- 'post',
- array('class' => 'actionbutton cancelinstallone d-block mt-1')
- );
- }
- if (!empty($upgradeabortable[$plugin->component])) {
- $status .= $this->output->single_button(
- new moodle_url($this->page->url, array('abortupgrade' => $plugin->component)),
- get_string('cancelupgradeone', 'core_plugin'),
- 'post',
- array('class' => 'actionbutton cancelupgradeone d-block mt-1')
- );
- }
- $availableupdates = $plugin->available_updates();
- if (!empty($availableupdates)) {
- foreach ($availableupdates as $availableupdate) {
- $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
- }
- }
- $status = new html_table_cell($sourcelabel.' '.$status);
- if ($plugin->pluginsupported != null) {
- $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version, $CFG->branch));
- } else {
- $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
- }
- $statusisboring = in_array($statuscode, array(
- core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
- if ($options['xdep']) {
- // we want to see only plugins with failed dependencies
- if ($dependenciesok) {
- continue;
- }
- } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
- // no change is going to happen to the plugin - display it only
- // if the user wants to see the full list
- if (empty($options['full'])) {
- continue;
- }
- } else {
- $sumattention++;
- }
- // The plugin should be displayed.
- $numdisplayed[$type]++;
- $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
- $plugintyperows[] = $row;
- }
- if (empty($numdisplayed[$type]) and empty($options['full'])) {
- continue;
- }
- $table->data[] = $header;
- $table->data = array_merge($table->data, $plugintyperows);
- }
- // Total number of displayed plugins.
- $sumdisplayed = array_sum($numdisplayed);
- if ($options['xdep']) {
- // At the plugins dependencies check page, display the table only.
- return html_writer::table($table);
- }
- $out = $this->output->container_start('', 'plugins-check-info');
- if ($sumdisplayed == 0) {
- $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
- } else {
- if (empty($options['full'])) {
- $out .= $this->output->heading(get_string('plugincheck…
Large files files are truncated, but you can click here to view the full file