MDL-65382 admin: Fix appearance of status labels
[moodle.git] / admin / renderer.php
CommitLineData
b9934a17
DM
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Renderer for core_admin subsystem
19 *
20 * @package core
21 * @subpackage admin
22 * @copyright 2011 David Mudrak <david@moodle.com>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26defined('MOODLE_INTERNAL') || die();
27
b9934a17
DM
28
29/**
30 * Standard HTML output renderer for core_admin subsystem
31 */
32class core_admin_renderer extends plugin_renderer_base {
33
cc359566
TH
34 /**
35 * Display the 'Do you acknowledge the terms of the GPL' page. The first page
36 * during install.
37 * @return string HTML to output.
38 */
39 public function install_licence_page() {
40 global $CFG;
41 $output = '';
42
43 $copyrightnotice = text_to_html(get_string('gpl3'));
44 $copyrightnotice = str_replace('target="_blank"', 'onclick="this.target=\'_blank\'"', $copyrightnotice); // extremely ugly validation hack
45
98b32c9e
DM
46 $continue = new single_button(new moodle_url($this->page->url, array(
47 'lang' => $CFG->lang, 'agreelicense' => 1)), get_string('continue'), 'get');
cc359566
TH
48
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();
56
57 return $output;
58 }
59
9008ec16
PS
60 /**
61 * Display page explaining proper upgrade process,
62 * there can not be any PHP file leftovers...
63 *
64 * @return string HTML to output.
65 */
66 public function upgrade_stale_php_files_page() {
67 $output = '';
68 $output .= $this->header();
69 $output .= $this->heading(get_string('upgradestalefiles', 'admin'));
70 $output .= $this->box_start('generalbox', 'notice');
774c42a8 71 $output .= format_text(get_string('upgradestalefilesinfo', 'admin', get_docs_url('Upgrading')), FORMAT_MARKDOWN);
9008ec16
PS
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();
cc359566
TH
76
77 return $output;
78 }
79
80 /**
81 * Display the 'environment check' page that is displayed during install.
8d1da748
PS
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
cc359566
TH
86 * @return string HTML to output.
87 */
8d1da748 88 public function install_environment_page($maturity, $envstatus, $environment_results, $release) {
cc359566
TH
89 global $CFG;
90 $output = '';
91
92 $output .= $this->header();
93 $output .= $this->maturity_warning($maturity);
94 $output .= $this->heading("Moodle $release");
95 $output .= $this->release_notes_link();
96
97 $output .= $this->environment_check_table($envstatus, $environment_results);
98
99 if (!$envstatus) {
98b32c9e 100 $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('agreelicense' => 1, 'lang' => $CFG->lang)));
cc359566
TH
101 } else {
102 $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
98b32c9e
DM
103 $output .= $this->continue_button(new moodle_url($this->page->url, array(
104 'agreelicense' => 1, 'confirmrelease' => 1, 'lang' => $CFG->lang)));
cc359566
TH
105 }
106
107 $output .= $this->footer();
108 return $output;
109 }
110
39f15cc7
DM
111 /**
112 * Displays the list of plugins with unsatisfied dependencies
113 *
114 * @param double|string|int $version Moodle on-disk version
115 * @param array $failed list of plugins with unsatisfied dependecies
e937c545 116 * @param moodle_url $reloadurl URL of the page to recheck the dependencies
39f15cc7
DM
117 * @return string HTML
118 */
119 public function unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) {
120 $output = '';
121
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)))));
e87214bd 125 $output .= $this->plugins_check_table(core_plugin_manager::instance(), $version, array('xdep' => true));
39f15cc7
DM
126 $output .= $this->warning(get_string('pluginschecktodo', 'admin'));
127 $output .= $this->continue_button($reloadurl);
128
129 $output .= $this->footer();
130
131 return $output;
132 }
133
cc359566
TH
134 /**
135 * Display the 'You are about to upgrade Moodle' page. The first page
136 * during upgrade.
8d1da748
PS
137 * @param string $strnewversion
138 * @param int $maturity
6e09cf98 139 * @param string $testsite
cc359566
TH
140 * @return string HTML to output.
141 */
6e09cf98 142 public function upgrade_confirm_page($strnewversion, $maturity, $testsite) {
cc359566
TH
143 $output = '';
144
98b32c9e 145 $continueurl = new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0));
82b1cf00
PS
146 $continue = new single_button($continueurl, get_string('continue'), 'get');
147 $cancelurl = new moodle_url('/admin/index.php');
cc359566
TH
148
149 $output .= $this->header();
150 $output .= $this->maturity_warning($maturity);
6e09cf98 151 $output .= $this->test_site_warning($testsite);
82b1cf00 152 $output .= $this->confirm(get_string('upgradesure', 'admin', $strnewversion), $continue, $cancelurl);
cc359566
TH
153 $output .= $this->footer();
154
155 return $output;
156 }
157
158 /**
159 * Display the environment page during the upgrade process.
8d1da748
PS
160 * @param string $release
161 * @param boolean $envstatus final result of env check (true/false)
162 * @param array $environment_results array of results gathered
cc359566
TH
163 * @return string HTML to output.
164 */
165 public function upgrade_environment_page($release, $envstatus, $environment_results) {
166 global $CFG;
167 $output = '';
168
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);
173
174 if (!$envstatus) {
98b32c9e 175 $output .= $this->upgrade_reload(new moodle_url($this->page->url, array('confirmupgrade' => 1, 'cache' => 0)));
cc359566
TH
176
177 } else {
faadd326 178 $output .= $this->notification(get_string('environmentok', 'admin'), 'notifysuccess');
cc359566
TH
179
180 if (empty($CFG->skiplangupgrade) and current_language() !== 'en') {
181 $output .= $this->box(get_string('langpackwillbeupdated', 'admin'), 'generalbox', 'notice');
182 }
183
98b32c9e
DM
184 $output .= $this->continue_button(new moodle_url($this->page->url, array(
185 'confirmupgrade' => 1, 'confirmrelease' => 1, 'cache' => 0)));
cc359566
TH
186 }
187
188 $output .= $this->footer();
189
190 return $output;
191 }
192
193 /**
194 * Display the upgrade page that lists all the plugins that require attention.
e87214bd
PS
195 * @param core_plugin_manager $pluginman provides information about the plugins.
196 * @param \core\update\checker $checker provides information about available updates.
8d1da748
PS
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
cc359566
TH
201 * @return string HTML to output.
202 */
e87214bd 203 public function upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,
96dd9237
DM
204 $version, $showallplugins, $reloadurl, $continueurl) {
205
cc359566
TH
206 $output = '';
207
208 $output .= $this->header();
2f29cf6e
DM
209 $output .= $this->box_start('generalbox', 'plugins-check-page');
210 $output .= html_writer::tag('p', get_string('pluginchecknotice', 'core_plugin'), array('class' => 'page-description'));
44371554 211 $output .= $this->check_for_updates_button($checker, $reloadurl);
5a92cd0b 212 $output .= $this->missing_dependencies($pluginman);
faadd326 213 $output .= $this->plugins_check_table($pluginman, $version, array('full' => $showallplugins));
cc359566
TH
214 $output .= $this->box_end();
215 $output .= $this->upgrade_reload($reloadurl);
216
ead8ba3b
DM
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();
faadd326 221 }
cc359566 222
ead8ba3b
DM
223 $button = new single_button($continueurl, get_string('upgradestart', 'admin'), 'get');
224 $button->class = 'continuebutton';
225 $output .= $this->render($button);
cc359566
TH
226 $output .= $this->footer();
227
228 return $output;
229 }
230
4d7528f9
DM
231 /**
232 * Display a page to confirm plugin installation cancelation.
233 *
c20e9ae8 234 * @param array $abortable list of \core\update\plugininfo
4d7528f9
DM
235 * @param moodle_url $continue
236 * @return string
237 */
c20e9ae8 238 public function upgrade_confirm_abort_install_page(array $abortable, moodle_url $continue) {
4d7528f9
DM
239
240 $pluginman = core_plugin_manager::instance();
4d7528f9
DM
241
242 if (empty($abortable)) {
243 // The UI should not allow this.
244 throw new moodle_exception('err_no_plugin_install_abortable', 'core_plugin');
245 }
246
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');
250
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');
257 }
258 }
259
260 $out .= $this->plugins_management_confirm_buttons($continue, $this->page->url);
261 $out .= $this->output->footer();
262
263 return $out;
264 }
265
cc359566
TH
266 /**
267 * Display the admin notifications page.
8d1da748
PS
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
0aff15c2 274 * @param bool $buggyiconvnomb warn iconv problems
e87214bd 275 * @param array|null $availableupdates array of \core\update\info objects or null
55585f3a 276 * @param int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
915140c9 277 * @param string[] $cachewarnings An array containing warnings from the Cache API.
356e2354 278 * @param array $eventshandlers Events 1 API handlers.
911fcae8
DM
279 * @param bool $themedesignermode Warn about the theme designer mode.
280 * @param bool $devlibdir Warn about development libs directory presence.
9693821d 281 * @param bool $mobileconfigured Whether the mobile web services have been enabled
cd1eb7ce 282 * @param bool $overridetossl Whether or not ssl is being forced.
6078d420 283 * @param bool $invalidforgottenpasswordurl Whether the forgotten password URL does not link to a valid URL.
b18034ed 284 * @param bool $croninfrequent If true, warn that cron hasn't run in the past few minutes
55585f3a 285 *
cc359566
TH
286 * @return string HTML to output.
287 */
288 public function admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,
b3245b75 289 $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,
911fcae8 290 $buggyiconvnomb, $registered, array $cachewarnings = array(), $eventshandlers = 0,
cd1eb7ce 291 $themedesignermode = false, $devlibdir = false, $mobileconfigured = false,
b18034ed 292 $overridetossl = false, $invalidforgottenpasswordurl = false, $croninfrequent = false) {
4db58f5f 293 global $CFG;
cc359566
TH
294 $output = '';
295
296 $output .= $this->header();
297 $output .= $this->maturity_info($maturity);
3f195ab7 298 $output .= $this->legacy_log_store_writing_error();
4db58f5f 299 $output .= empty($CFG->disableupdatenotifications) ? $this->available_updates($availableupdates, $availableupdatesfetch) : '';
cc359566 300 $output .= $this->insecure_dataroot_warning($insecuredataroot);
911fcae8 301 $output .= $this->development_libs_directories_warning($devlibdir);
586cf929 302 $output .= $this->themedesignermode_warning($themedesignermode);
cc359566 303 $output .= $this->display_errors_warning($errorsdisplayed);
0aff15c2 304 $output .= $this->buggy_iconv_warning($buggyiconvnomb);
e3258164 305 $output .= $this->cron_overdue_warning($cronoverdue);
b18034ed 306 $output .= $this->cron_infrequent_warning($croninfrequent);
cc359566
TH
307 $output .= $this->db_problems($dbproblems);
308 $output .= $this->maintenance_mode_warning($maintenancemode);
cd1eb7ce 309 $output .= $this->overridetossl_warning($overridetossl);
915140c9 310 $output .= $this->cache_warnings($cachewarnings);
356e2354 311 $output .= $this->events_handlers($eventshandlers);
b3245b75 312 $output .= $this->registration_warning($registered);
9693821d 313 $output .= $this->mobile_configuration_warning($mobileconfigured);
6078d420 314 $output .= $this->forgotten_password_url_warning($invalidforgottenpasswordurl);
cc359566
TH
315
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 //////////////////////////////////////////////////////////////////////////////////////////////////
320
321 $output .= $this->footer();
322
323 return $output;
324 }
325
8342171b
DM
326 /**
327 * Display the plugin management page (admin/plugins.php).
328 *
4df8bced
DM
329 * The filtering options array may contain following items:
330 * bool contribonly - show only contributed extensions
331 * bool updatesonly - show only plugins with an available update
332 *
e87214bd
PS
333 * @param core_plugin_manager $pluginman
334 * @param \core\update\checker $checker
4df8bced 335 * @param array $options filtering options
8342171b
DM
336 * @return string HTML to output.
337 */
e87214bd 338 public function plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array()) {
7716057f 339
8342171b
DM
340 $output = '';
341
342 $output .= $this->header();
343 $output .= $this->heading(get_string('pluginsoverview', 'core_admin'));
44371554 344 $output .= $this->check_for_updates_button($checker, $this->page->url);
8726c07c 345 $output .= $this->plugins_overview_panel($pluginman, $options);
44371554
DM
346 $output .= $this->plugins_control_panel($pluginman, $options);
347 $output .= $this->footer();
348
349 return $output;
350 }
351
352 /**
353 * Renders a button to fetch for available updates.
354 *
355 * @param \core\update\checker $checker
356 * @param moodle_url $reloadurl
357 * @return string HTML
358 */
359 public function check_for_updates_button(\core\update\checker $checker, $reloadurl) {
360
361 $output = '';
8342171b 362
e9d3c212 363 if ($checker->enabled()) {
7716057f 364 $output .= $this->container_start('checkforupdates');
4df8bced 365 $output .= $this->single_button(
aa1d100c 366 new moodle_url($reloadurl, array('fetchupdates' => 1)),
4df8bced
DM
367 get_string('checkforupdates', 'core_plugin')
368 );
7716057f 369 if ($timefetched = $checker->get_last_timefetched()) {
44371554
DM
370 $timefetched = userdate($timefetched, get_string('strftimedatetime', 'core_langconfig'));
371 $output .= $this->container(get_string('checkforupdateslast', 'core_plugin', $timefetched), 'lasttimefetched');
7716057f
DM
372 }
373 $output .= $this->container_end();
8342171b 374 }
8342171b 375
8342171b
DM
376 return $output;
377 }
378
436d9447
DM
379 /**
380 * Display a page to confirm the plugin uninstallation.
381 *
e87214bd
PS
382 * @param core_plugin_manager $pluginman
383 * @param \core\plugininfo\base $pluginfo
436d9447 384 * @param moodle_url $continueurl URL to continue after confirmation
e87214bd 385 * @param moodle_url $cancelurl URL to to go if cancelled
436d9447
DM
386 * @return string
387 */
e87214bd 388 public function plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) {
436d9447
DM
389 $output = '';
390
391 $pluginname = $pluginman->plugin_name($pluginfo->component);
392
2f87bb03
PS
393 $confirm = '<p>' . get_string('uninstallconfirm', 'core_plugin', array('name' => $pluginname)) . '</p>';
394 if ($extraconfirm = $pluginfo->get_uninstall_extra_warning()) {
395 $confirm .= $extraconfirm;
396 }
397
436d9447
DM
398 $output .= $this->output->header();
399 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
e87214bd 400 $output .= $this->output->confirm($confirm, $continueurl, $cancelurl);
436d9447
DM
401 $output .= $this->output->footer();
402
403 return $output;
404 }
405
406 /**
407 * Display a page with results of plugin uninstallation and offer removal of plugin files.
408 *
e87214bd
PS
409 * @param core_plugin_manager $pluginman
410 * @param \core\plugininfo\base $pluginfo
3ca1b546 411 * @param progress_trace_buffer $progress
436d9447
DM
412 * @param moodle_url $continueurl URL to continue to remove the plugin folder
413 * @return string
414 */
e87214bd 415 public function plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,
3ca1b546 416 progress_trace_buffer $progress, moodle_url $continueurl) {
436d9447
DM
417 $output = '';
418
419 $pluginname = $pluginman->plugin_name($pluginfo->component);
420
82b1cf00
PS
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);
424
436d9447
DM
425 $output .= $this->output->header();
426 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
427
3ca1b546 428 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
436d9447
DM
429
430 $confirm = $this->output->container(get_string('uninstalldeleteconfirm', 'core_plugin',
431 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'uninstalldeleteconfirm');
432
433 if ($repotype = $pluginman->plugin_external_source($pluginfo->component)) {
434 $confirm .= $this->output->container(get_string('uninstalldeleteconfirmexternal', 'core_plugin', $repotype),
435 'uninstalldeleteconfirmexternal');
436 }
437
82b1cf00
PS
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'));
436d9447
DM
440 $output .= $this->output->footer();
441
442 return $output;
443 }
444
445 /**
446 * Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
447 *
e87214bd
PS
448 * @param core_plugin_manager $pluginman
449 * @param \core\plugininfo\base $pluginfo
3ca1b546 450 * @param progress_trace_buffer $progress
436d9447
DM
451 * @return string
452 */
e87214bd 453 public function plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) {
436d9447
DM
454 $output = '';
455
2612e75e 456 $pluginname = $pluginfo->component;
436d9447 457
436d9447
DM
458 $output .= $this->output->header();
459 $output .= $this->output->heading(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
460
3ca1b546 461 $output .= $this->output->box($progress->get_buffer(), 'generalbox uninstallresultmessage');
436d9447
DM
462
463 $output .= $this->output->box(get_string('uninstalldelete', 'core_plugin',
464 array('name' => $pluginname, 'rootdir' => $pluginfo->rootdir)), 'generalbox uninstalldelete');
2612e75e 465 $output .= $this->output->continue_button(new moodle_url('/admin/index.php'));
436d9447
DM
466 $output .= $this->output->footer();
467
468 return $output;
469 }
470
cc359566
TH
471 /**
472 * Display the plugin management page (admin/environment.php).
8d1da748
PS
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
cc359566
TH
477 * @return string HTML to output.
478 */
479 public function environment_check_page($versions, $version, $envstatus, $environment_results) {
480 $output = '';
481 $output .= $this->header();
482
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'));
488
489 // Heading.
490 $output .= $this->heading(get_string('environment', 'admin'));
491
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();
499
500 // The results
501 $output .= $this->environment_check_table($envstatus, $environment_results);
502
503 $output .= $this->footer();
504 return $output;
505 }
506
507 /**
508 * Output a warning message, of the type that appears on the admin notifications page.
509 * @param string $message the message to display.
8d1da748 510 * @param string $type type class
cc359566
TH
511 * @return string HTML to output.
512 */
513 protected function warning($message, $type = 'warning') {
514 return $this->box($message, 'generalbox admin' . $type);
515 }
516
517 /**
518 * Render an appropriate message if dataroot is insecure.
8d1da748 519 * @param bool $insecuredataroot
cc359566
TH
520 * @return string HTML to output.
521 */
522 protected function insecure_dataroot_warning($insecuredataroot) {
523 global $CFG;
524
525 if ($insecuredataroot == INSECURE_DATAROOT_WARNING) {
526 return $this->warning(get_string('datarootsecuritywarning', 'admin', $CFG->dataroot));
527
528 } else if ($insecuredataroot == INSECURE_DATAROOT_ERROR) {
529 return $this->warning(get_string('datarootsecurityerror', 'admin', $CFG->dataroot), 'error');
530
531 } else {
532 return '';
533 }
534 }
535
911fcae8
DM
536 /**
537 * Render a warning that a directory with development libs is present.
538 *
539 * @param bool $devlibdir True if the warning should be displayed.
540 * @return string
541 */
542 protected function development_libs_directories_warning($devlibdir) {
543
544 if ($devlibdir) {
545 $moreinfo = new moodle_url('/report/security/index.php');
546 $warning = get_string('devlibdirpresent', 'core_admin', ['moreinfourl' => $moreinfo->out()]);
547 return $this->warning($warning, 'error');
548
549 } else {
550 return '';
551 }
552 }
553
cc359566
TH
554 /**
555 * Render an appropriate message if dataroot is insecure.
8d1da748 556 * @param bool $errorsdisplayed
cc359566
TH
557 * @return string HTML to output.
558 */
559 protected function display_errors_warning($errorsdisplayed) {
560 if (!$errorsdisplayed) {
561 return '';
562 }
563
564 return $this->warning(get_string('displayerrorswarning', 'admin'));
565 }
566
586cf929
DP
567 /**
568 * Render an appropriate message if themdesignermode is enabled.
569 * @param bool $themedesignermode true if enabled
570 * @return string HTML to output.
571 */
572 protected function themedesignermode_warning($themedesignermode) {
573 if (!$themedesignermode) {
574 return '';
575 }
576
577 return $this->warning(get_string('themedesignermodewarning', 'admin'));
578 }
579
0aff15c2
PS
580 /**
581 * Render an appropriate message if iconv is buggy and mbstring missing.
582 * @param bool $buggyiconvnomb
583 * @return string HTML to output.
584 */
585 protected function buggy_iconv_warning($buggyiconvnomb) {
586 if (!$buggyiconvnomb) {
587 return '';
588 }
589
590 return $this->warning(get_string('warningiconvbuggy', 'admin'));
591 }
592
cc359566
TH
593 /**
594 * Render an appropriate message if cron has not been run recently.
8d1da748 595 * @param bool $cronoverdue
cc359566
TH
596 * @return string HTML to output.
597 */
598 public function cron_overdue_warning($cronoverdue) {
ed25d7c4 599 global $CFG;
cc359566
TH
600 if (!$cronoverdue) {
601 return '';
602 }
603
ed25d7c4
MS
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));
608 }
609
610 return $this->warning(get_string('cronwarning', 'admin', $url->out()) . '&nbsp;' .
611 $this->help_icon('cron', 'admin'));
612 }
613
614 // $CFG->cronclionly is not empty: cron can run only from CLI.
615 return $this->warning(get_string('cronwarningcli', 'admin') . '&nbsp;' .
cc359566
TH
616 $this->help_icon('cron', 'admin'));
617 }
618
b18034ed 619 /**
620 * Render an appropriate message if cron is not being run frequently (recommended every minute).
621 *
622 * @param bool $croninfrequent
623 * @return string HTML to output.
624 */
625 public function cron_infrequent_warning(bool $croninfrequent) : string {
ff13ae59 626 global $CFG;
627
b18034ed 628 if (!$croninfrequent) {
629 return '';
630 }
631
ff13ae59 632 $expectedfrequency = $CFG->expectedcronfrequency ?? 200;
633 return $this->warning(get_string('croninfrequent', 'admin', $expectedfrequency) . '&nbsp;' .
b18034ed 634 $this->help_icon('cron', 'admin'));
635 }
636
cc359566
TH
637 /**
638 * Render an appropriate message if there are any problems with the DB set-up.
8d1da748 639 * @param bool $dbproblems
cc359566
TH
640 * @return string HTML to output.
641 */
642 public function db_problems($dbproblems) {
643 if (!$dbproblems) {
644 return '';
645 }
646
647 return $this->warning($dbproblems);
648 }
649
915140c9
SH
650 /**
651 * Renders cache warnings if there are any.
652 *
653 * @param string[] $cachewarnings
654 * @return string
655 */
656 public function cache_warnings(array $cachewarnings) {
657 if (!count($cachewarnings)) {
658 return '';
659 }
660 return join("\n", array_map(array($this, 'warning'), $cachewarnings));
661 }
662
356e2354
DM
663 /**
664 * Renders events 1 API handlers warning.
665 *
666 * @param array $eventshandlers
667 * @return string
668 */
669 public function events_handlers($eventshandlers) {
670 if ($eventshandlers) {
671 $components = '';
672 foreach ($eventshandlers as $eventhandler) {
673 $components .= $eventhandler->component . ', ';
674 }
675 $components = rtrim($components, ', ');
676 return $this->warning(get_string('eventshandlersinuse', 'admin', $components));
677 }
678 }
679
cc359566
TH
680 /**
681 * Render an appropriate message if the site in in maintenance mode.
8d1da748 682 * @param bool $maintenancemode
cc359566
TH
683 * @return string HTML to output.
684 */
685 public function maintenance_mode_warning($maintenancemode) {
686 if (!$maintenancemode) {
687 return '';
688 }
689
ecc2897c
PS
690 $url = new moodle_url('/admin/settings.php', array('section' => 'maintenancemode'));
691 $url = $url->out(); // get_string() does not support objects in params
692
693 return $this->warning(get_string('sitemaintenancewarning2', 'admin', $url));
cc359566
TH
694 }
695
cd1eb7ce
JO
696 /**
697 * Render a warning that ssl is forced because the site was on loginhttps.
698 *
699 * @param bool $overridetossl Whether or not ssl is being forced.
700 * @return string
701 */
702 protected function overridetossl_warning($overridetossl) {
703 if (!$overridetossl) {
704 return '';
705 }
706 $warning = get_string('overridetossl', 'core_admin');
707 return $this->warning($warning, 'warning');
708 }
709
cc359566
TH
710 /**
711 * Display a warning about installing development code if necesary.
8d1da748 712 * @param int $maturity
cc359566
TH
713 * @return string HTML to output.
714 */
715 protected function maturity_warning($maturity) {
716 if ($maturity == MATURITY_STABLE) {
717 return ''; // No worries.
718 }
719
720 $maturitylevel = get_string('maturity' . $maturity, 'admin');
7f52dbd8 721 return $this->warning(
cc359566
TH
722 $this->container(get_string('maturitycorewarning', 'admin', $maturitylevel)) .
723 $this->container($this->doc_link('admin/versions', get_string('morehelp'))),
7f52dbd8 724 'error');
cc359566
TH
725 }
726
6e09cf98
DM
727 /*
728 * If necessary, displays a warning about upgrading a test site.
729 *
730 * @param string $testsite
731 * @return string HTML
732 */
733 protected function test_site_warning($testsite) {
734
735 if (!$testsite) {
736 return '';
737 }
738
7f52dbd8
DS
739 $warning = (get_string('testsiteupgradewarning', 'admin', $testsite));
740 return $this->warning($warning, 'error');
6e09cf98
DM
741 }
742
cc359566
TH
743 /**
744 * Output the copyright notice.
745 * @return string HTML to output.
746 */
747 protected function moodle_copyright() {
748 global $CFG;
749
750 //////////////////////////////////////////////////////////////////////////////////////////////////
751 //// IT IS ILLEGAL AND A VIOLATION OF THE GPL TO HIDE, REMOVE OR MODIFY THIS COPYRIGHT NOTICE ///
752 $copyrighttext = '<a href="http://moodle.org/">Moodle</a> '.
753 '<a href="http://docs.moodle.org/dev/Releases" title="'.$CFG->version.'">'.$CFG->release.'</a><br />'.
754 'Copyright &copy; 1999 onwards, Martin Dougiamas<br />'.
956082f1 755 'and <a href="http://moodle.org/dev">many other contributors</a>.<br />'.
cc359566
TH
756 '<a href="http://docs.moodle.org/dev/License">GNU Public License</a>';
757 //////////////////////////////////////////////////////////////////////////////////////////////////
758
759 return $this->box($copyrighttext, 'copyright');
760 }
761
762 /**
763 * Display a warning about installing development code if necesary.
8d1da748
PS
764 * @param int $maturity
765 * @return string HTML to output.
cc359566
TH
766 */
767 protected function maturity_info($maturity) {
768 if ($maturity == MATURITY_STABLE) {
769 return ''; // No worries.
770 }
771
7f52dbd8
DS
772 $level = 'warning';
773
774 if ($maturity == MATURITY_ALPHA) {
775 $level = 'error';
776 }
777
cc359566 778 $maturitylevel = get_string('maturity' . $maturity, 'admin');
7f52dbd8
DS
779 $warningtext = get_string('maturitycoreinfo', 'admin', $maturitylevel);
780 $warningtext .= ' ' . $this->doc_link('admin/versions', get_string('morehelp'));
781 return $this->warning($warningtext, $level);
cc359566
TH
782 }
783
55585f3a 784 /**
966bd785 785 * Displays the info about available Moodle core and plugin updates
55585f3a 786 *
966bd785
DM
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.
789 *
e87214bd 790 * @param array|null $updates array of (string)component => array of \core\update\info objects or null
55585f3a
DM
791 * @param int|null $fetch timestamp of the most recent updates fetch or null (unknown)
792 * @return string
793 */
794 protected function available_updates($updates, $fetch) {
795
7f52dbd8 796 $updateinfo = '';
966bd785 797 $someupdateavailable = false;
55585f3a 798 if (is_array($updates)) {
966bd785
DM
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);
804 }
657cb5ab
DM
805 $updateinfo .= html_writer::tag('p', get_string('updateavailablerecommendation', 'core_admin'),
806 array('class' => 'updateavailablerecommendation'));
55585f3a 807 }
966bd785
DM
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())));
816 }
817 }
818
819 if (!$someupdateavailable) {
cb1c3291
DM
820 $now = time();
821 if ($fetch and ($fetch <= $now) and ($now - $fetch < HOURSECS)) {
822 $updateinfo .= $this->heading(get_string('updateavailablenot', 'core_admin'), 3);
823 }
55585f3a
DM
824 }
825
826 $updateinfo .= $this->container_start('checkforupdates');
fc281113 827 $fetchurl = new moodle_url('/admin/index.php', array('fetchupdates' => 1, 'sesskey' => sesskey(), 'cache' => 0));
e2e35e71 828 $updateinfo .= $this->single_button($fetchurl, get_string('checkforupdates', 'core_plugin'));
55585f3a
DM
829 if ($fetch) {
830 $updateinfo .= $this->container(get_string('checkforupdateslast', 'core_plugin',
831 userdate($fetch, get_string('strftimedatetime', 'core_langconfig'))));
832 }
833 $updateinfo .= $this->container_end();
834
7f52dbd8 835 return $this->warning($updateinfo);
55585f3a
DM
836 }
837
b3245b75
DP
838 /**
839 * Display a warning about not being registered on Moodle.org if necesary.
840 *
841 * @param boolean $registered true if the site is registered on Moodle.org
842 * @return string HTML to output.
843 */
844 protected function registration_warning($registered) {
845
0b23fad4 846 if (!$registered && site_is_public()) {
505bbe7c 847 if (has_capability('moodle/site:config', context_system::instance())) {
ef467fff 848 $registerbutton = $this->single_button(new moodle_url('/admin/registration/index.php'),
b3245b75 849 get_string('register', 'admin'));
505bbe7c
MG
850 $str = 'registrationwarning';
851 } else {
852 $registerbutton = '';
853 $str = 'registrationwarningcontactadmin';
854 }
b3245b75 855
505bbe7c
MG
856 return $this->warning( get_string($str, 'admin')
857 . '&nbsp;' . $this->help_icon('registration', 'admin') . $registerbutton ,
858 'error alert alert-danger');
b3245b75
DP
859 }
860
861 return '';
862 }
863
505bbe7c
MG
864 /**
865 * Return an admin page warning if site is not registered with moodle.org
866 *
867 * @return string
868 */
869 public function warn_if_not_registered() {
ef467fff 870 return $this->registration_warning(\core\hub\registration::is_registered());
505bbe7c
MG
871 }
872
9693821d
AN
873 /**
874 * Display a warning about the Mobile Web Services being disabled.
875 *
876 * @param boolean $mobileconfigured true if mobile web services are enabled
877 * @return string HTML to output.
878 */
879 protected function mobile_configuration_warning($mobileconfigured) {
880 $output = '';
881 if (!$mobileconfigured) {
882 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'mobilesettings']);
883 $configurebutton = $this->single_button($settingslink, get_string('enablemobilewebservice', 'admin'));
884 $output .= $this->warning(get_string('mobilenotconfiguredwarning', 'admin') . '&nbsp;' . $configurebutton);
885 }
886
887 return $output;
888 }
889
6078d420
JL
890 /**
891 * Display a warning about the forgotten password URL not linking to a valid URL.
892 *
893 * @param boolean $invalidforgottenpasswordurl true if the forgotten password URL is not valid
894 * @return string HTML to output.
895 */
896 protected function forgotten_password_url_warning($invalidforgottenpasswordurl) {
897 $output = '';
898 if ($invalidforgottenpasswordurl) {
899 $settingslink = new moodle_url('/admin/settings.php', ['section' => 'manageauths']);
900 $configurebutton = $this->single_button($settingslink, get_string('check', 'moodle'));
901 $output .= $this->warning(get_string('invalidforgottenpasswordurl', 'admin') . '&nbsp;' . $configurebutton,
902 'error alert alert-danger');
903 }
904
905 return $output;
906 }
907
55585f3a
DM
908 /**
909 * Helper method to render the information about the available Moodle update
910 *
e87214bd 911 * @param \core\update\info $updateinfo information about the available Moodle core update
55585f3a 912 */
e87214bd 913 protected function moodle_available_update_info(\core\update\info $updateinfo) {
55585f3a
DM
914
915 $boxclasses = 'moodleupdateinfo';
916 $info = array();
917
918 if (isset($updateinfo->release)) {
919 $info[] = html_writer::tag('span', get_string('updateavailable_release', 'core_admin', $updateinfo->release),
920 array('class' => 'info release'));
921 }
922
923 if (isset($updateinfo->version)) {
924 $info[] = html_writer::tag('span', get_string('updateavailable_version', 'core_admin', $updateinfo->version),
925 array('class' => 'info version'));
926 }
927
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;
932 }
933
934 if (isset($updateinfo->download)) {
935 $info[] = html_writer::link($updateinfo->download, get_string('download'), array('class' => 'info download'));
936 }
937
938 if (isset($updateinfo->url)) {
939 $info[] = html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin'),
940 array('class' => 'info more'));
941 }
942
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();
946
947 return $box;
948 }
949
cc359566
TH
950 /**
951 * Display a link to the release notes.
8d1da748 952 * @return string HTML to output.
cc359566
TH
953 */
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');
958 }
959
960 /**
961 * Display the reload link that appears on several upgrade/install pages.
8d1da748 962 * @return string HTML to output.
cc359566
TH
963 */
964 function upgrade_reload($url) {
965 return html_writer::empty_tag('br') .
966 html_writer::tag('div',
c2e10ac0 967 html_writer::link($url, $this->pix_icon('i/reload', '', '', array('class' => 'icon icon-pre')) .
cc359566
TH
968 get_string('reload'), array('title' => get_string('reload'))),
969 array('class' => 'continuebutton')) . html_writer::empty_tag('br');
970 }
971
b9934a17
DM
972 /**
973 * Displays all known plugins and information about their installation or upgrade
974 *
975 * This default implementation renders all plugins into one big table. The rendering
976 * options support:
977 * (bool)full = false: whether to display up-to-date plugins, too
39f15cc7 978 * (bool)xdep = false: display the plugins with unsatisified dependecies only
b9934a17 979 *
e87214bd 980 * @param core_plugin_manager $pluginman provides information about the plugins.
faadd326 981 * @param int $version the version of the Moodle code from version.php.
b9934a17
DM
982 * @param array $options rendering options
983 * @return string HTML code
984 */
e87214bd 985 public function plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array()) {
fa1d403f 986
36ca62ca 987 $plugininfo = $pluginman->get_plugins();
b9934a17
DM
988
989 if (empty($plugininfo)) {
990 return '';
991 }
992
39f15cc7
DM
993 $options['full'] = isset($options['full']) ? (bool)$options['full'] : false;
994 $options['xdep'] = isset($options['xdep']) ? (bool)$options['xdep'] : false;
b9934a17 995
b9934a17
DM
996 $table = new html_table();
997 $table->id = 'plugins-check';
998 $table->head = array(
fd17898c 999 get_string('displayname', 'core_plugin').' / '.get_string('rootdir', 'core_plugin'),
b9934a17
DM
1000 get_string('versiondb', 'core_plugin'),
1001 get_string('versiondisk', 'core_plugin'),
36ca62ca 1002 get_string('requires', 'core_plugin'),
fd17898c 1003 get_string('source', 'core_plugin').' / '.get_string('status', 'core_plugin'),
b9934a17
DM
1004 );
1005 $table->colclasses = array(
fd17898c 1006 'displayname', 'versiondb', 'versiondisk', 'requires', 'status',
b9934a17
DM
1007 );
1008 $table->data = array();
1009
0ec7d101
DM
1010 // Number of displayed plugins per type.
1011 $numdisplayed = array();
1012 // Number of plugins known to the plugin manager.
1013 $sumtotal = 0;
1014 // Number of plugins requiring attention.
1015 $sumattention = 0;
2f29cf6e 1016 // List of all components we can cancel installation of.
c20e9ae8
DM
1017 $installabortable = $pluginman->list_cancellable_installations();
1018 // List of all components we can cancel upgrade of.
1019 $upgradeabortable = $pluginman->list_restorable_archives();
b9934a17
DM
1020
1021 foreach ($plugininfo as $type => $plugins) {
1022
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;
1028
0ec7d101 1029 $numdisplayed[$type] = 0;
b9934a17
DM
1030
1031 if (empty($plugins) and $options['full']) {
1032 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
1033 $msg->colspan = count($table->head);
1034 $row = new html_table_row(array($msg));
1035 $row->attributes['class'] .= 'msg msg-noneinstalled';
1036 $table->data[] = $header;
1037 $table->data[] = $row;
1038 continue;
1039 }
1040
1041 $plugintyperows = array();
1042
1043 foreach ($plugins as $name => $plugin) {
0ec7d101 1044 $sumtotal++;
b9934a17
DM
1045 $row = new html_table_row();
1046 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1047
436dbeec 1048 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
b9934a17
DM
1049 $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'smallicon pluginicon'));
1050 } else {
fd17898c 1051 $icon = '';
b9934a17 1052 }
b9934a17 1053
fd17898c
DM
1054 $displayname = new html_table_cell(
1055 $icon.
1056 html_writer::span($plugin->displayname, 'pluginname').
1057 html_writer::div($plugin->get_dir(), 'plugindir')
1058 );
1059
1060 $versiondb = new html_table_cell($plugin->versiondb);
1061 $versiondisk = new html_table_cell($plugin->versiondisk);
b9934a17
DM
1062
1063 if ($isstandard = $plugin->is_standard()) {
1064 $row->attributes['class'] .= ' standard';
eecb7dc0 1065 $sourcelabel = html_writer::span(get_string('sourcestd', 'core_plugin'), 'sourcetext badge badge-secondary');
b9934a17
DM
1066 } else {
1067 $row->attributes['class'] .= ' extension';
3f2c68f1 1068 $sourcelabel = html_writer::span(get_string('sourceext', 'core_plugin'), 'sourcetext badge badge-info');
b9934a17
DM
1069 }
1070
fd17898c
DM
1071 $coredependency = $plugin->is_core_dependency_satisfied($version);
1072 $otherpluginsdependencies = $pluginman->are_dependencies_satisfied($plugin->get_other_required_plugins());
1073 $dependenciesok = $coredependency && $otherpluginsdependencies;
b9934a17
DM
1074
1075 $statuscode = $plugin->get_status();
1076 $row->attributes['class'] .= ' status-' . $statuscode;
eecb7dc0 1077 $statusclass = 'statustext badge ';
fd17898c
DM
1078 switch ($statuscode) {
1079 case core_plugin_manager::PLUGIN_STATUS_NEW:
3f2c68f1 1080 $statusclass .= $dependenciesok ? 'badge-success' : 'badge-warning';
fd17898c
DM
1081 break;
1082 case core_plugin_manager::PLUGIN_STATUS_UPGRADE:
3f2c68f1 1083 $statusclass .= $dependenciesok ? 'badge-info' : 'badge-warning';
fd17898c
DM
1084 break;
1085 case core_plugin_manager::PLUGIN_STATUS_MISSING:
1086 case core_plugin_manager::PLUGIN_STATUS_DOWNGRADE:
1087 case core_plugin_manager::PLUGIN_STATUS_DELETE:
3f2c68f1 1088 $statusclass .= 'badge-danger';
fd17898c
DM
1089 break;
1090 case core_plugin_manager::PLUGIN_STATUS_NODB:
1091 case core_plugin_manager::PLUGIN_STATUS_UPTODATE:
3f2c68f1 1092 $statusclass .= $dependenciesok ? '' : 'badge-warning';
fd17898c
DM
1093 break;
1094 }
1095 $status = html_writer::span(get_string('status_' . $statuscode, 'core_plugin'), $statusclass);
96dd9237 1096
c20e9ae8
DM
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'),
1101 'post',
1102 array('class' => 'actionbutton cancelinstallone')
1103 );
1104 }
1105
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'),
1110 'post',
1111 array('class' => 'actionbutton cancelupgradeone')
1112 );
2f29cf6e
DM
1113 }
1114
96dd9237 1115 $availableupdates = $plugin->available_updates();
e9d3c212 1116 if (!empty($availableupdates)) {
96dd9237 1117 foreach ($availableupdates as $availableupdate) {
3bca7dbf 1118 $status .= $this->plugin_available_update_info($pluginman, $availableupdate);
96dd9237
DM
1119 }
1120 }
b9934a17 1121
fd17898c 1122 $status = new html_table_cell($sourcelabel.' '.$status);
b9934a17 1123
faadd326 1124 $requires = new html_table_cell($this->required_column($plugin, $pluginman, $version));
36ca62ca
TH
1125
1126 $statusisboring = in_array($statuscode, array(
e87214bd 1127 core_plugin_manager::PLUGIN_STATUS_NODB, core_plugin_manager::PLUGIN_STATUS_UPTODATE));
e937c545 1128
39f15cc7
DM
1129 if ($options['xdep']) {
1130 // we want to see only plugins with failed dependencies
1131 if ($dependenciesok) {
1132 continue;
1133 }
1134
2f838a4e 1135 } else if ($statusisboring and $dependenciesok and empty($availableupdates)) {
39f15cc7
DM
1136 // no change is going to happen to the plugin - display it only
1137 // if the user wants to see the full list
b9934a17
DM
1138 if (empty($options['full'])) {
1139 continue;
1140 }
b9934a17 1141
0ec7d101
DM
1142 } else {
1143 $sumattention++;
1144 }
39f15cc7 1145
0ec7d101
DM
1146 // The plugin should be displayed.
1147 $numdisplayed[$type]++;
fd17898c 1148 $row->cells = array($displayname, $versiondb, $versiondisk, $requires, $status);
b9934a17
DM
1149 $plugintyperows[] = $row;
1150 }
1151
0ec7d101 1152 if (empty($numdisplayed[$type]) and empty($options['full'])) {
b9934a17
DM
1153 continue;
1154 }
1155
1156 $table->data[] = $header;
1157 $table->data = array_merge($table->data, $plugintyperows);
1158 }
1159
0ec7d101
DM
1160 // Total number of displayed plugins.
1161 $sumdisplayed = array_sum($numdisplayed);
b9934a17 1162
39f15cc7 1163 if ($options['xdep']) {
0ec7d101
DM
1164 // At the plugins dependencies check page, display the table only.
1165 return html_writer::table($table);
1166 }
1167
1168 $out = $this->output->container_start('', 'plugins-check-info');
39f15cc7 1169
0ec7d101
DM
1170 if ($sumdisplayed == 0) {
1171 $out .= $this->output->heading(get_string('pluginchecknone', 'core_plugin'));
b9934a17
DM
1172
1173 } else {
b9934a17 1174 if (empty($options['full'])) {
0ec7d101 1175 $out .= $this->output->heading(get_string('plugincheckattention', 'core_plugin'));
a687fcac 1176 } else {
0ec7d101 1177 $out .= $this->output->heading(get_string('plugincheckall', 'core_plugin'));
b9934a17 1178 }
228cbda3 1179 }
2f29cf6e 1180
228cbda3 1181 $out .= $this->output->container_start('actions');
c20e9ae8
DM
1182
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)),
1188 'post',
1189 array('class' => 'singlebutton updateavailableinstallall')
1190 );
1191 }
1192
228cbda3
DM
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)),
1197 'post',
1198 array('class' => 'singlebutton cancelinstallall')
1199 );
1200 }
0ec7d101 1201
c20e9ae8 1202 if ($upgradeabortable) {
c948b813 1203 $out .= $this->output->single_button(
c20e9ae8
DM
1204 new moodle_url($this->page->url, array('abortupgradex' => 1)),
1205 get_string('cancelupgradeall', 'core_plugin', count($upgradeabortable)),
c948b813 1206 'post',
c20e9ae8 1207 array('class' => 'singlebutton cancelupgradeall')
c948b813
DM
1208 );
1209 }
1210
228cbda3
DM
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'));
2f29cf6e 1213
228cbda3
DM
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'));
b9934a17 1216
30c26421
DM
1217 $out .= $this->output->container_end(); // End of .actions container.
1218 $out .= $this->output->container_end(); // End of #plugins-check-info container.
0ec7d101
DM
1219
1220 if ($sumdisplayed > 0 or $options['full']) {
b9934a17
DM
1221 $out .= html_writer::table($table);
1222 }
1223
1224 return $out;
1225 }
1226
c948b813 1227 /**
4d7528f9 1228 * Display the continue / cancel widgets for the plugins management pages.
c948b813
DM
1229 *
1230 * @param null|moodle_url $continue URL for the continue button, should it be displayed
30c26421 1231 * @param null|moodle_url $cancel URL for the cancel link, defaults to the current page
c948b813
DM
1232 * @return string HTML
1233 */
4d7528f9 1234 public function plugins_management_confirm_buttons(moodle_url $continue=null, moodle_url $cancel=null) {
c948b813 1235
4d7528f9 1236 $out = html_writer::start_div('plugins-management-confirm-buttons');
c948b813
DM
1237
1238 if (!empty($continue)) {
4d7528f9 1239 $out .= $this->output->single_button($continue, get_string('continue'), 'post', array('class' => 'continue'));
c948b813
DM
1240 }
1241
1242 if (empty($cancel)) {
1243 $cancel = $this->page->url;
1244 }
1245 $out .= html_writer::div(html_writer::link($cancel, get_string('cancel')), 'cancel');
1246
1247 return $out;
1248 }
1249
5a92cd0b
DM
1250 /**
1251 * Displays the information about missing dependencies
1252 *
1253 * @param core_plugin_manager $pluginman
1254 * @return string
1255 */
1256 protected function missing_dependencies(core_plugin_manager $pluginman) {
1257
1258 $dependencies = $pluginman->missing_dependencies();
1259
1260 if (empty($dependencies)) {
1261 return '';
1262 }
1263
1264 $available = array();
1265 $unavailable = array();
1266 $unknown = array();
1267
1268 foreach ($dependencies as $component => $remoteinfo) {
1269 if ($remoteinfo === false) {
35f2b674 1270 // The required version is not available. Let us check if there
5a92cd0b 1271 // is at least some version in the plugins directory.
35f2b674 1272 $remoteinfoanyversion = $pluginman->get_remote_plugin_info($component, ANY_VERSION, false);
5a92cd0b
DM
1273 if ($remoteinfoanyversion === false) {
1274 $unknown[$component] = $component;
1275 } else {
1276 $unavailable[$component] = $remoteinfoanyversion;
1277 }
1278 } else {
1279 $available[$component] = $remoteinfo;
1280 }
1281 }
1282
1283 $out = $this->output->container_start('plugins-check-dependencies');
1284
1285 if ($unavailable or $unknown) {
1286 $out .= $this->output->heading(get_string('misdepsunavail', 'core_plugin'));
1287 if ($unknown) {
1288 $out .= $this->output->notification(get_string('misdepsunknownlist', 'core_plugin', implode($unknown, ', ')));
1289 }
1290 if ($unavailable) {
1291 $unavailablelist = array();
1292 foreach ($unavailable as $component => $remoteinfoanyversion) {
1293 $unavailablelistitem = html_writer::link('https://moodle.org/plugins/view.php?plugin='.$component,
1294 '<strong>'.$remoteinfoanyversion->name.'</strong>');
1295 if ($remoteinfoanyversion->version) {
1296 $unavailablelistitem .= ' ('.$component.' &gt; '.$remoteinfoanyversion->version->version.')';
1297 } else {
1298 $unavailablelistitem .= ' ('.$component.')';
1299 }
1300 $unavailablelist[] = $unavailablelistitem;
1301 }
1302 $out .= $this->output->notification(get_string('misdepsunavaillist', 'core_plugin',
1303 implode($unavailablelist, ', ')));
1304 }
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'));
30c26421 1308 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
5a92cd0b
DM
1309 }
1310
1311 if ($available) {
1312 $out .= $this->output->heading(get_string('misdepsavail', 'core_plugin'));
5a92cd0b
DM
1313 $out .= $this->output->container_start('plugins-check-dependencies-actions');
1314
c948b813 1315 $installable = $pluginman->filter_installable($available);
9137a89a
DM
1316 if ($installable) {
1317 $out .= $this->output->single_button(
1318 new moodle_url($this->page->url, array('installdepx' => 1)),
1319 get_string('dependencyinstallmissing', 'core_plugin', count($installable)),
1320 'post',
1321 array('class' => 'singlebutton dependencyinstallmissing')
1322 );
1323 }
1324
c20e9ae8 1325 $out .= html_writer::div(html_writer::link(new moodle_url('/admin/tool/installaddon/'),
9137a89a
DM
1326 get_string('dependencyuploadmissing', 'core_plugin')), 'dependencyuploadmissing');
1327
30c26421 1328 $out .= $this->output->container_end(); // End of .plugins-check-dependencies-actions container.
9137a89a
DM
1329
1330 $out .= $this->available_missing_dependencies_list($pluginman, $available);
5a92cd0b
DM
1331 }
1332
30c26421 1333 $out .= $this->output->container_end(); // End of .plugins-check-dependencies container.
5a92cd0b
DM
1334
1335 return $out;
1336 }
1337
1338 /**
1339 * Displays the list if available missing dependencies.
1340 *
1341 * @param core_plugin_manager $pluginman
1342 * @param array $dependencies
1343 * @return string
1344 */
1345 protected function available_missing_dependencies_list(core_plugin_manager $pluginman, array $dependencies) {
1346 global $CFG;
1347
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'),
1356 );
1357 $table->colclasses = array('displayname', 'release', 'version', 'supportedmoodleversions', 'info');
1358 $table->data = array();
1359
1360 foreach ($dependencies as $plugin) {
1361
1362 $supportedmoodles = array();
1363 foreach ($plugin->version->supportedmoodles as $moodle) {
1364 if ($CFG->branch == str_replace('.', '', $moodle->release)) {
3f2c68f1 1365 $supportedmoodles[] = html_writer::span($moodle->release, 'badge badge-success');
5a92cd0b
DM
1366 } else {
1367 $supportedmoodles[] = html_writer::span($moodle->release, 'label');
1368 }
1369 }
1370
1371 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
1372 if ($requriedby) {
1373 foreach ($requriedby as $ix => $val) {
1374 $inf = $pluginman->get_plugin_info($val);
1375 if ($inf) {
1376 $requriedby[$ix] = $inf->displayname.' ('.$inf->component.')';
1377 }
1378 }
1379 $info = html_writer::div(
1380 get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1381 'requiredby'
1382 );
1383 } else {
1384 $info = '';
1385 }
1386
9137a89a
DM
1387 $info .= $this->output->container_start('actions');
1388
1389 $info .= html_writer::div(
5a92cd0b
DM
1390 html_writer::link('https://moodle.org/plugins/view.php?plugin='.$plugin->component,
1391 get_string('misdepinfoplugin', 'core_plugin')),
1392 'misdepinfoplugin'
1393 );
1394
9137a89a 1395 $info .= html_writer::div(
5a92cd0b
DM
1396 html_writer::link('https://moodle.org/plugins/pluginversion.php?id='.$plugin->version->id,
1397 get_string('misdepinfoversion', 'core_plugin')),
1398 'misdepinfoversion'
1399 );
1400
9137a89a
DM
1401 $info .= html_writer::div(html_writer::link($plugin->version->downloadurl, get_string('download')), 'misdepdownload');
1402
36977a6d 1403 if ($pluginman->is_remote_plugin_installable($plugin->component, $plugin->version->version, $reason)) {
9137a89a
DM
1404 $info .= $this->output->single_button(
1405 new moodle_url($this->page->url, array('installdep' => $plugin->component)),
1406 get_string('dependencyinstall', 'core_plugin'),
1407 'post',
1408 array('class' => 'singlebutton dependencyinstall')
1409 );
36977a6d
DM
1410 } else {
1411 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1412 if ($reasonhelp) {
1413 $info .= html_writer::div($reasonhelp, 'reasonhelp dependencyinstall');
1414 }
9137a89a 1415 }
5a92cd0b 1416
30c26421 1417 $info .= $this->output->container_end(); // End of .actions container.
5a92cd0b
DM
1418
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, ' '),
1424 $info
1425 );
1426 }
1427
1428 return html_writer::table($table);
1429 }
1430
36977a6d
DM
1431 /**
1432 * Explain why {@link core_plugin_manager::is_remote_plugin_installable()} returned false.
1433 *
1434 * @param string $reason the reason code as returned by the plugin manager
1435 * @return string
1436 */
1437 protected function info_remote_plugin_not_installable($reason) {
1438
1439 if ($reason === 'notwritableplugintype' or $reason === 'notwritableplugin') {
1440 return $this->output->help_icon('notwritable', 'core_plugin', get_string('notwritable', 'core_plugin'));
1441 }
1442
1443 if ($reason === 'remoteunavailable') {
1444 return $this->output->help_icon('notdownloadable', 'core_plugin', get_string('notdownloadable', 'core_plugin'));
1445 }
1446
1447 return false;
1448 }
1449
36ca62ca
TH
1450 /**
1451 * Formats the information that needs to go in the 'Requires' column.
e87214bd
PS
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.
8d1da748
PS
1454 * @param string $version
1455 * @return string HTML code
36ca62ca 1456 */
e87214bd 1457 protected function required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) {
7eb87eff 1458
36ca62ca 1459 $requires = array();
5a92cd0b
DM
1460 $displayuploadlink = false;
1461 $displayupdateslink = false;
36ca62ca 1462
7eb87eff
DM
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';
1467 $label = '';
1468 } else {
1469 $class = 'requires-failed';
3f2c68f1 1470 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
7eb87eff
DM
1471 }
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));
36ca62ca 1475
7eb87eff
DM
1476 } else {
1477 $actions = array();
1478
1479 if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OK) {
1480 $label = '';
1481 $class = 'requires-ok';
1482
1483 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_MISSING) {
5a92cd0b 1484 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
3f2c68f1
MM
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');
5a92cd0b
DM
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')
1491 );
1492
1493 } else {
3f2c68f1 1494 $label = html_writer::span(get_string('dependencymissing', 'core_plugin'), 'badge badge-danger');
5a92cd0b 1495 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
3f2c68f1 1496 'badge badge-danger');
5a92cd0b
DM
1497 $class = 'requires-failed requires-missing requires-unavailable';
1498 }
1499 $displayuploadlink = true;
7eb87eff
DM
1500
1501 } else if ($reqinfo->status == $pluginman::REQUIREMENT_STATUS_OUTDATED) {
5a92cd0b 1502 if ($reqinfo->availability == $pluginman::REQUIREMENT_AVAILABLE) {
3f2c68f1
MM
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');
5a92cd0b
DM
1505 $class = 'requires-failed requires-outdated requires-available';
1506 $displayupdateslink = true;
1507
1508 } else {
3f2c68f1 1509 $label = html_writer::span(get_string('dependencyfails', 'core_plugin'), 'badge badge-danger');
5a92cd0b 1510 $label .= ' '.html_writer::span(get_string('dependencyunavailable', 'core_plugin'),
3f2c68f1 1511 'badge badge-danger');
5a92cd0b
DM
1512 $class = 'requires-failed requires-outdated requires-unavailable';
1513 }
1514 $displayuploadlink = true;
2cdea9c7 1515 }
36ca62ca 1516
7eb87eff
DM
1517 if ($reqinfo->reqver != ANY_VERSION) {
1518 $str = 'otherpluginversion';
1519 } else {
1520 $str = 'otherplugin';
1521 }
36ca62ca 1522
7eb87eff
DM
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)
1527 );
36ca62ca 1528 }
36ca62ca
TH
1529 }
1530
1531 if (!$requires) {
1532 return '';
1533 }
5a92cd0b
DM
1534
1535 $out = html_writer::tag('ul', implode("\n", $requires));
1536
1537 if ($displayuploadlink) {
1538 $out .= html_writer::div(
1539 html_writer::link(
1540 new moodle_url('/admin/tool/installaddon/'),
1541 get_string('dependencyuploadmissing', 'core_plugin')
1542 ),
1543 'dependencyuploadmissing'
1544 );
1545 }
1546
1547 if ($displayupdateslink) {
1548 $out .= html_writer::div(
1549 html_writer::link(
1550 new moodle_url($this->page->url, array('sesskey' => sesskey(), 'fetchupdates' => 1)),
1551 get_string('checkforupdates', 'core_plugin')
1552 ),
1553 'checkforupdates'
1554 );
1555 }
1556
1557 return $out;
1558
36ca62ca
TH
1559 }
1560
d26f3ddd
DM
1561 /**
1562 * Prints an overview about the plugins - number of installed, number of extensions etc.
1563 *
e87214bd 1564 * @param core_plugin_manager $pluginman provides information about the plugins
4df8bced 1565 * @param array $options filtering options
d26f3ddd
DM
1566 * @return string as usually
1567 */
e87214bd 1568 public function plugins_overview_panel(core_plugin_manager $pluginman, array $options = array()) {
7716057f 1569
d26f3ddd
DM
1570 $plugininfo = $pluginman->get_plugins();
1571
44371554 1572 $numtotal = $numextension = $numupdatable = 0;
d26f3ddd
DM
1573
1574 foreach ($plugininfo as $type => $plugins) {
1575 foreach ($plugins as $name => $plugin) {
44371554
DM
1576 if ($plugin->available_updates()) {
1577 $numupdatable++;
1578 }
e87214bd 1579 if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
d26f3ddd
DM
1580 continue;
1581 }
1582 $numtotal++;
d26f3ddd
DM
1583 if (!$plugin->is_standard()) {
1584 $numextension++;
1585 }
d26f3ddd
DM
1586 }
1587 }
1588
44371554
DM
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');
1594
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');
1600
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');
1607 } else {
1608 // No updates, or the notifications disabled.
1609 $infoupdatable = '';
4df8bced
DM
1610 }
1611
44371554 1612 $out = html_writer::start_div('', array('id' => 'plugins-overview-panel'));
d26f3ddd 1613
44371554
DM
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);
4df8bced
DM
1618 }
1619
8726c07c
DM
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)),
1626 'post',
1627 array('class' => 'singlebutton updateavailableinstallall')
1628 );
1629 }
1630 }
1631
44371554
DM
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');
1635
30c26421 1636 $out .= html_writer::end_div(); // End of #plugins-overview-panel block.
44371554
DM
1637
1638 return $out;
d26f3ddd
DM
1639 }
1640
b9934a17
DM
1641 /**
1642 * Displays all known plugins and links to manage them
1643 *
1644 * This default implementation renders all plugins into one big table.
1645 *
e87214bd 1646 * @param core_plugin_manager $pluginman provides information about the plugins.
4df8bced 1647 * @param array $options filtering options
b9934a17
DM
1648 * @return string HTML code
1649 */
e87214bd 1650 public function plugins_control_panel(core_plugin_manager $pluginman, array $options = array()) {
7716057f 1651
36ca62ca 1652 $plugininfo = $pluginman->get_plugins();
b9934a17 1653
4df8bced
DM
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) {
30d8bc5f
DM
1659 $pluginavailableupdates = $pluginfo->available_updates();
1660 if (!empty($pluginavailableupdates)) {
1661 foreach ($pluginavailableupdates as $pluginavailableupdate) {
1662 $updateable[$plugintype][$pluginname] = $pluginfo;
4df8bced
DM
1663 }
1664 }
1665 }
1666 }
1667 $plugininfo = $updateable;
1668 }
1669
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;
1676 }
1677 }
1678 }
1679 $plugininfo = $contribs;
1680 }
1681
b9934a17
DM
1682 if (empty($plugininfo)) {
1683 return '';
1684 }
1685
b9934a17
DM
1686 $table = new html_table();
1687 $table->id = 'plugins-control-panel';
1688 $table->head = array(
1689 get_string('displayname', 'core_plugin'),
b9934a17
DM
1690 get_string('version', 'core_plugin'),
1691 get_string('availability', 'core_plugin'),
2b135b05
DM
1692 get_string('actions', 'core_plugin'),
1693 get_string('notes','core_plugin'),
b9934a17 1694 );
44371554 1695 $table->headspan = array(1, 1, 1, 2, 1);
b9934a17 1696 $table->colclasses = array(
44371554 1697 'pluginname', 'version', 'availability', 'settings', 'uninstall', 'notes'
b9934a17
DM
1698 );
1699
1700 foreach ($plugininfo as $type => $plugins) {
e87214bd
PS
1701 $heading = $pluginman->plugintype_name_plural($type);
1702 $pluginclass = core_plugin_manager::resolve_plugininfo_class($type);
1703 if ($manageurl = $pluginclass::get_manage_url()) {
44371554
DM
1704 $heading .= $this->output->action_icon($manageurl, new pix_icon('i/settings',
1705 get_string('settings', 'core_plugin')));
e87214bd
PS
1706 }
1707 $header = new html_table_cell(html_writer::tag('span', $heading, array('id'=>'plugin_type_cell_'.$type)));
b9934a17 1708 $header->header = true;
54d75893 1709 $header->colspan = array_sum($table->headspan);
b9934a17
DM
1710 $header = new html_table_row(array($header));
1711 $header->attributes['class'] = 'plugintypeheader type-' . $type;
1712 $table->data[] = $header;
1713
1714 if (empty($plugins)) {
1715 $msg = new html_table_cell(get_string('noneinstalled', 'core_plugin'));
54d75893 1716 $msg->colspan = array_sum($table->headspan);
b9934a17
DM
1717 $row = new html_table_row(array($msg));
1718 $row->attributes['class'] .= 'msg msg-noneinstalled';
1719 $table->data[] = $row;
1720 continue;
1721 }
1722
1723 foreach ($plugins as $name => $plugin) {
1724 $row = new html_table_row();
1725 $row->attributes['class'] = 'type-' . $plugin->type . ' name-' . $plugin->type . '_' . $plugin->name;
1726
6abce1e1 1727 if ($this->page->theme->resolve_image_location('icon', $plugin->type . '_' . $plugin->name, null)) {
fa9c0aab 1728 $icon = $this->output->pix_icon('icon', '', $plugin->type . '_' . $plugin->name, array('class' => 'icon pluginicon'));
b9934a17 1729 } else {
b4ef04e7 1730 $icon = $this->output->spacer();
b9934a17 1731 }
9074e478
DM
1732 $status = $plugin->get_status();
1733 $row->attributes['class'] .= ' status-'.$status;
44371554 1734 $pluginname = html_writer::tag('div', $icon.$plugin->displayname, array('class' => 'displayname')).
2b135b05
DM
1735 html_writer::tag('div', $plugin->component, array('class' => 'componentname'));
1736 $pluginname = new html_table_cell($pluginname);
b9934a17 1737
44371554
DM
1738 $version = html_writer::div($plugin->versiondb, 'versionnumber');
1739 if ((string)$plugin->release !== '') {
1740 $version = html_writer::div($plugin->release, 'release').$version;
b9934a17 1741 }
44371554 1742 $version = new html_table_cell($version);
b9934a17
DM
1743
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';
7bc759bd 1749 $availability = new html_table_cell(get_string('pluginenabled', 'core_plugin'));
b9934a17
DM
1750 } else {
1751 $row->attributes['class'] .= ' disabled';
7bc759bd 1752 $availability = new html_table_cell(get_string('plugindisabled', 'core_plugin'));
b9934a17
DM
1753 }
1754
1755 $settingsurl = $plugin->get_settings_url();
2b135b05 1756 if (!is_null($settingsurl)) {
54d75893
DM
1757 $settings = html_writer::link($settingsurl, get_string('settings', 'core_plugin'), array('class' => 'settings'));
1758 } else {
1759 $settings = '';
b9934a17 1760 }
54d75893 1761 $settings = new html_table_cell($settings);
b9934a17 1762
e87214bd 1763 if ($uninstallurl = $pluginman->get_uninstall_url($plugin->component, 'overview')) {
54d75893
DM
1764 $uninstall = html_writer::link($uninstallurl, get_string('uninstall', 'core_plugin'));
1765 } else {
1766 $uninstall = '';
2b135b05 1767 }
54d75893 1768 $uninstall = new html_table_cell($uninstall);
2b135b05 1769
44371554
DM
1770 if ($plugin->is_standard()) {
1771 $row->attributes['class'] .= ' standard';
44371554
DM
1772 $source = '';
1773 } else {
1774 $row->attributes['class'] .= ' extension';
3f2c68f1 1775 $source = html_writer::div(get_string('sourceext', 'core_plugin'), 'source badge badge-info');
44371554
DM
1776 }
1777
1778 if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
3f2c68f1 1779 $msg = html_writer::div(get_string('status_missing', 'core_plugin'), 'statusmsg badge badge-danger');
44371554 1780 } else if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
3f2c68f1 1781 $msg = html_writer::div(get_string('status_new', 'core_plugin'), 'statusmsg badge badge-success');
44371554
DM
1782 } else {
1783 $msg = '';
1784 }
1785
828788f0 1786 $requriedby = $pluginman->other_plugins_that_require($plugin->component);
2b135b05
DM
1787 if ($requriedby) {
1788 $requiredby = html_writer::tag('div', get_string('requiredby', 'core_plugin', implode(', ', $requriedby)),
1789 array('class' => 'requiredby'));
b9934a17 1790 } else {
2b135b05 1791 $requiredby = '';
b9934a17
DM
1792 }
1793
7d8de6d8 1794 $updateinfo = '';
e9d3c212 1795 if (is_array($plugin->available_updates())) {
7d8de6d8 1796 foreach ($plugin->available_updates() as $availableupdate) {
3bca7dbf 1797 $updateinfo .= $this->plugin_available_update_info($pluginman, $availableupdate);
7d8de6d8 1798 }
3204daea
DM
1799 }
1800
44371554 1801 $notes = new html_table_cell($source.$msg.$requiredby.$updateinfo);
2b135b05 1802
b9934a17 1803 $row->cells = array(
44371554 1804 $pluginname, $version, $availability, $settings, $uninstall, $notes
b9934a17
DM
1805 );
1806 $table->data[] = $row;
1807 }
1808 }
1809
1810 return html_writer::table($table);
1811 }
da2fdc3f 1812
3204daea 1813 /**
e7611389 1814 * Helper method to render the information about the available plugin update
3204daea 1815 *
3bca7dbf 1816 * @param core_plugin_manager $pluginman plugin manager instance
e87214bd 1817 * @param \core\update\info $updateinfo information about the available update for the plugin
3204daea 1818 */
3bca7dbf 1819 protected function plugin_available_update_info(core_plugin_manager $pluginman, \core\update\info $updateinfo) {
3204daea 1820
e7611389 1821 $boxclasses = 'pluginupdateinfo';
3204daea
DM
1822 $info = array();
1823
1824 if (isset($updateinfo->release)) {
44371554
DM
1825 $info[] = html_writer::div(
1826 get_string('updateavailable_release', 'core_plugin', $updateinfo->release),
1827 'info release'
1828 );
3204daea
DM
1829 }
1830
1831 if (isset($updateinfo->maturity)) {
44371554
DM
1832 $info[] = html_writer::div(
1833 get_string('maturity'.$updateinfo->maturity, 'core_admin'),
1834 'info maturity'
1835 );
e7611389 1836 $boxclasses .= ' maturity'.$updateinfo->maturity;
3204daea
DM
1837 }
1838
1839 if (isset($updateinfo->download)) {
44371554
DM
1840 $info[] = html_writer::div(
1841 html_writer::link($updateinfo->download, get_string('download')),
1842 'info download'
1843 );
3204daea
DM
1844 }
1845
1846 if (isset($updateinfo->url)) {
44371554
DM
1847 $info[] = html_writer::div(
1848 html_writer::link($updateinfo->url, get_string('updateavailable_moreinfo', 'core_plugin')),
1849 'info more'
1850 );
3204daea
DM
1851 }
1852
44371554
DM
1853 $box = html_writer::start_div($boxclasses);
1854 $box .= html_writer::div(
1855 get_string('updateavailable', 'core_plugin', $updateinfo->version),
1856 'version'
1857 );
1858 $box .= html_writer::div(
1859 implode(html_writer::span(' ', 'separator'), $info),
1860 'infos'
1861 );
fa3feafb 1862
3bca7dbf
DM
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'),
1868 'post',
1869 array('class' => 'singlebutton updateavailableinstall')
1870 );
1871 } else {
1872 $reasonhelp = $this->info_remote_plugin_not_installable($reason);
1873 if ($reasonhelp) {
1874 $box .= html_writer::div($reasonhelp, 'reasonhelp updateavailableinstall');
0daa6428 1875 }
fa3feafb 1876 }
44371554 1877 $box .= html_writer::end_div();
3204daea
DM
1878
1879 return $box;
1880 }
1881
da2fdc3f 1882 /**
cc359566
TH
1883 * This function will render one beautiful table with all the environmental
1884 * configuration and how it suits Moodle needs.
1885 *
1886 * @param boolean $result final result of the check (true/false)
40cba608 1887 * @param environment_results[] $environment_results array of results gathered
cc359566 1888 * @return string HTML to output.
da2fdc3f 1889 */
cc359566
TH
1890 public function environment_check_table($result, $environment_results) {
1891 global $CFG;
1892
1893 // Table headers
1894 $servertable = new html_table();//table for server checks
1895 $servertable->head = array(
1896 get_string('name'),
1897 get_string('info'),
1898 get_string('report'),
40cba608 1899 get_string('plugin'),
cc359566
TH
1900 get_string('status'),
1901 );
40cba608 1902 $servertable->colclasses = array('centeralign name', 'centeralign info', 'leftalign report', 'leftalign plugin', 'centeralign status');
6fc61f2d
RW
1903 $servertable->attributes['class'] = 'admintable environmenttable generaltable';
1904 $servertable->id = 'serverstatus';
cc359566
TH
1905
1906 $serverdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1907
1908 $othertable = new html_table();//table for custom checks
1909 $othertable->head = array(
1910 get_string('info'),
1911 get_string('report'),
40cba608 1912 get_string('plugin'),
cc359566
TH
1913 get_string('status'),
1914 );
40cba608 1915 $othertable->colclasses = array('aligncenter info', 'alignleft report', 'alignleft plugin', 'aligncenter status');
6fc61f2d
RW
1916 $othertable->attributes['class'] = 'admintable environmenttable generaltable';
1917 $othertable->id = 'otherserverstatus';
cc359566
TH
1918
1919 $otherdata = array('ok'=>array(), 'warn'=>array(), 'error'=>array());
1920
1921 // Iterate over each environment_result
1922 $continue = true;
1923 foreach ($environment_results as $environment_result) {
1924 $errorline = false;
1925 $warningline = false;
1926 $stringtouse = '';
1927 if ($continue) {
1928 $type = $environment_result->getPart();
1929 $info = $environment_result->getInfo();
1930 $status = $environment_result->getStatus();
40cba608 1931 $plugin = $environment_result->getPluginName();
cc359566
TH
1932 $error_code = $environment_result->getErrorCode();
1933 // Process Report field
1934 $rec = new stdClass();
1935 // Something has gone wrong at parsing time
1936 if ($error_code) {
1937 $stringtouse = 'environmentxmlerror';
1938 $rec->error_code = $error_code;
1939 $status = get_string('error');
1940 $errorline = true;
1941 $continue = false;
1942 }
1943
1944 if ($continue) {
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';
1950 } else {
1951 $stringtouse = 'environmentrecommendversion';
1952 }
1953
1954 } else if ($environment_result->getPart() == 'custom_check') {
1955 // We are checking installed & enabled things
1956 if ($environment_result->getLevel() == 'required') {
1957 $stringtouse = 'environmentrequirecustomcheck';
1958 } else {
1959 $stringtouse = 'environmentrecommendcustomcheck';
1960 }
1961
1962 } else if ($environment_result->getPart() == 'php_setting') {
1963 if ($status) {
1964 $stringtouse = 'environmentsettingok';
1965 } else if ($environment_result->getLevel() == 'required') {
1966 $stringtouse = 'environmentmustfixsetting';
1967 } else {
1968 $stringtouse = 'environmentshouldfixsetting';
1969 }
1970
1971 } else {
1972 if ($environment_result->getLevel() == 'required') {
1973 $stringtouse = 'environmentrequireinstall';
1974 } else {
1975 $stringtouse = 'environmentrecommendinstall';
1976 }
1977 }
1978
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');
1985 $errorline = true;
1986 } else {
1987 if ($status) { //Handle ok result (ok)
1988 $status = get_string('ok');
1989 } else {
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');
1995 $errorline = true;
1996 }
1997 }
1998 }
1999 }
2000
2001 // Build the text
2002 $linkparts = array();
2003 $linkparts[] = 'admin/environment';
2004 $linkparts[] = $type;
2005 if (!empty($info)){
2006 $linkparts[] = $info;
2007 }
40cba608
PS
2008 // Plugin environments do not have docs pages yet.
2009 if (empty($CFG->docroot) or $environment_result->plugin) {
cc359566
TH
2010 $report = get_string($stringtouse, 'admin', $rec);
2011 } else {
b1a8a505 2012 $report = $this->doc_link(join($linkparts, '/'), get_string($stringtouse, 'admin', $rec), true);
cc359566 2013 }
5920f633
JP
2014 // Enclose report text in div so feedback text will be displayed underneath it.
2015 $report = html_writer::div($report);
cc359566
TH
2016
2017 // Format error or warning line
5920f633
JP
2018 if ($errorline) {
2019 $messagetype = 'error';
3f2c68f1 2020 $statusclass = 'badge-danger';
5920f633
JP
2021 } else if ($warningline) {
2022 $messagetype = 'warn';
3f2c68f1 2023 $statusclass = 'badge-warning';
cc359566
TH
2024 } else {
2025 $messagetype = 'ok';
3f2c68f1 2026 $statusclass = 'badge-success';
cc359566 2027 }
eecb7dc0 2028 $status = html_writer::span($status, 'badge ' . $statusclass);
cc359566
TH
2029 // Here we'll store all the feedback found
2030 $feedbacktext = '';
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');
2037
2038 $report .= $feedbacktext;
2039
2040 // Add the row to the table
2041 if ($environment_result->getPart() == 'custom_check'){
40cba608 2042 $otherdata[$messagetype][] = array ($info, $report, $plugin, $status);
cc359566 2043 } else {
40cba608 2044 $serverdata[$messagetype][] = array ($type, $info, $report, $plugin, $status);
cc359566
TH
2045 }
2046 }
2047 }
2048
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']);
2052
2053 // Print table
2054 $output = '';
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);
2060 }
2061
2062 // Finally, if any error has happened, print the summary box
2063 if (!$result) {
2064 $output .= $this->box(get_string('environmenterrortodo', 'admin'), 'environmentbox errorbox');
2065 }
2066
2067 return $output;
da2fdc3f 2068 }
98b32c9e
DM
2069
2070 /**
2071 * Render a simple page for providing the upgrade key.
2072 *
2073 * @param moodle_url|string $url
2074 * @return string
2075 */
2076 public function upgradekey_form_page($url) {
2077
2078 $output = '';
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();
2088
2089 return $output;
2090 }
61f7b10b
AG
2091
2092 /**
2093 * Check to see if writing to the deprecated legacy log store is enabled.
2094 *
2095 * @return string An error message if writing to the legacy log store is enabled.
2096 */
3f195ab7 2097 protected function legacy_log_store_writing_error() {
61f7b10b 2098 $enabled = get_config('logstore_legacy', 'loglegacy');
a285d561
JO
2099 $plugins = explode(',', get_config('tool_log', 'enabled_stores'));
2100 $enabled = $enabled && in_array('logstore_legacy', $plugins);
2101
61f7b10b 2102 if ($enabled) {
e8d90872 2103 return $this->warning(get_string('legacylogginginuse'));
61f7b10b
AG
2104 }
2105 }
3cfbce12
JP
2106
2107 /**
2108 * Display message about the benefits of registering on Moodle.org
2109 *
2110 * @return string
2111 */
2112 public function moodleorg_registration_message() {
2113 return format_text(get_string('registermoodlenet', 'admin'), FORMAT_HTML, ['noclean' => true]);
2114 }
b9934a17 2115}