MDL-12717 use apply_default_exception_settings before other admin defaults; merged...
[moodle.git] / lib / adminlib.php
CommitLineData
a4e10845 1<?php
88a7228a 2
3/**
4 * adminlib.php - Contains functions that only administrators will ever need to use
5 *
a4e10845 6 * @author Martin Dougiamas and many others
88a7228a 7 * @version $Id$
8 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
9 * @package moodlecore
10 */
11
8ddcdd86 12function upgrade_main_savepoint($result, $version) {
13 global $CFG;
14
15 if ($result) {
16 if ($CFG->version >= $version) {
17 // something really wrong is going on in main upgrade script
220a90c5 18 error("Upgrade savepoint: Can not upgrade main version from $CFG->version to $version.");
8ddcdd86 19 }
20 set_config('version', $version);
21 } else {
22 notify ("Upgrade savepoint: Error during main upgrade to version $version");
23 }
24}
25
26function upgrade_mod_savepoint($result, $version, $type) {
27 //TODO
28}
29
30function upgrade_plugin_savepoint($result, $version, $type, $dir) {
31 //TODO
32}
33
34function upgrade_backup_savepoint($result, $version) {
35 //TODO
36}
37
38function upgrade_blocks_savepoint($result, $version, $type) {
39 //TODO
40}
41
88a7228a 42/**
ead29342 43 * Upgrade plugins
88a7228a 44 *
45 * @uses $db
46 * @uses $CFG
ead29342 47 * @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
48 * @param string $dir The directory where the plugins are located (e.g. 'question/questiontypes')
49 * @param string $return The url to prompt the user to continue to
eef868d1 50 */
ead29342 51function upgrade_plugins($type, $dir, $return) {
e69ef14b 52 global $CFG, $db;
173cc1c3 53
15999a93 54/// Let's know if the header has been printed, so the funcion is being called embedded in an outer page
55 $embedded = defined('HEADER_PRINTED');
56
bb7053f3 57 $plugs = get_list_of_plugins($dir);
583fad99 58 $updated_plugins = false;
59 $strpluginsetup = get_string('pluginsetup');
60
ead29342 61 foreach ($plugs as $plug) {
173cc1c3 62
ead29342 63 $fullplug = $CFG->dirroot .'/'.$dir.'/'. $plug;
173cc1c3 64
ead29342 65 unset($plugin);
173cc1c3 66
bbbf2d40 67 if (is_readable($fullplug .'/version.php')) {
ead29342 68 include_once($fullplug .'/version.php'); // defines $plugin with version etc
173cc1c3 69 } else {
70 continue; // Nothing to do.
71 }
72
e79a09a2 73 $oldupgrade = false;
74 $newupgrade = false;
7c006e34 75 if (is_readable($fullplug . '/db/'. $CFG->dbtype . '.php')) {
76 include_once($fullplug . '/db/'. $CFG->dbtype . '.php'); // defines old upgrading function
e79a09a2 77 $oldupgrade = true;
78 }
db8bd7a6 79 if (is_readable($fullplug . '/db/upgrade.php')) {
7c006e34 80 include_once($fullplug . '/db/upgrade.php'); // defines new upgrading function
e79a09a2 81 $newupgrade = true;
82 }
83
ead29342 84 if (!isset($plugin)) {
173cc1c3 85 continue;
86 }
87
ead29342 88 if (!empty($plugin->requires)) {
89 if ($plugin->requires > $CFG->version) {
acdd790f 90 $info = new object();
ead29342 91 $info->pluginname = $plug;
92 $info->pluginversion = $plugin->version;
173cc1c3 93 $info->currentmoodle = $CFG->version;
ead29342 94 $info->requiremoodle = $plugin->requires;
15999a93 95 if (!$updated_plugins && !$embedded) {
0be6f678 96 print_header($strpluginsetup, $strpluginsetup,
97 build_navigation(array(array('name' => $strpluginsetup, 'link' => null, 'type' => 'misc'))), '',
371a32e3 98 upgrade_get_javascript(), false, '&nbsp;', '&nbsp;');
583fad99 99 }
100 upgrade_log_start();
ead29342 101 notify(get_string('pluginrequirementsnotmet', 'error', $info));
583fad99 102 $updated_plugins = true;
173cc1c3 103 continue;
104 }
105 }
106
ead29342 107 $plugin->name = $plug; // The name MUST match the directory
173cc1c3 108
ead29342 109 $pluginversion = $type.'_'.$plug.'_version';
173cc1c3 110
ead29342 111 if (!isset($CFG->$pluginversion)) {
112 set_config($pluginversion, 0);
173cc1c3 113 }
eef868d1 114
ead29342 115 if ($CFG->$pluginversion == $plugin->version) {
173cc1c3 116 // do nothing
ead29342 117 } else if ($CFG->$pluginversion < $plugin->version) {
15999a93 118 if (!$updated_plugins && !$embedded) {
0be6f678 119 print_header($strpluginsetup, $strpluginsetup,
120 build_navigation(array(array('name' => $strpluginsetup, 'link' => null, 'type' => 'misc'))), '',
371a32e3 121 upgrade_get_javascript(), false, '&nbsp;', '&nbsp;');
173cc1c3 122 }
e79a09a2 123 $updated_plugins = true;
583fad99 124 upgrade_log_start();
05b42119 125 print_heading($dir.'/'. $plugin->name .' plugin needs upgrading');
e79a09a2 126 $db->debug = true;
127 @set_time_limit(0); // To allow slow databases to complete the long SQL
128
d87a9d73 129 if ($CFG->$pluginversion == 0) { // It's a new install of this plugin
e79a09a2 130 /// Both old .sql files and new install.xml are supported
131 /// but we priorize install.xml (XMLDB) if present
132 $status = false;
db8bd7a6 133 if (file_exists($fullplug . '/db/install.xml')) {
450cf307 134 $status = install_from_xmldb_file($fullplug . '/db/install.xml'); //New method
e79a09a2 135 } else if (file_exists($fullplug .'/db/'. $CFG->dbtype .'.sql')) {
136 $status = modify_database($fullplug .'/db/'. $CFG->dbtype .'.sql'); //Old method
eef868d1 137 } else {
7c006e34 138 $status = true;
d87a9d73 139 }
e79a09a2 140
141 $db->debug = false;
eef868d1 142 /// Continue with the instalation, roles and other stuff
e79a09a2 143 if ($status) {
3f59a54e 144 /// OK so far, now update the plugins record
e79a09a2 145 set_config($pluginversion, $plugin->version);
3f59a54e 146
147 /// Install capabilities
ae628043 148 if (!update_capabilities($type.'/'.$plug)) {
3f59a54e 149 error('Could not set up the capabilities for '.$plugin->name.'!');
e79a09a2 150 }
3f59a54e 151 /// Install events
0856223c 152 events_update_definition($type.'/'.$plug);
3f59a54e 153
154 /// Run local install function if there is one
155 if (is_readable($fullplug .'/lib.php')) {
9ba38673 156 include_once($fullplug .'/lib.php');
3f59a54e 157 $installfunction = $plugin->name.'_install';
158 if (function_exists($installfunction)) {
159 if (! $installfunction() ) {
160 notify('Encountered a problem running install function for '.$module->name.'!');
161 }
162 }
163 }
9ba38673 164
e79a09a2 165 notify(get_string('modulesuccess', '', $plugin->name), 'notifysuccess');
166 } else {
167 notify('Installing '. $plugin->name .' FAILED!');
168 }
d87a9d73 169 } else { // Upgrade existing install
e79a09a2 170 /// Run de old and new upgrade functions for the module
171 $oldupgrade_function = $type.'_'.$plugin->name .'_upgrade';
172 $newupgrade_function = 'xmldb_' . $type.'_'.$plugin->name .'_upgrade';
173
174 /// First, the old function if exists
175 $oldupgrade_status = true;
176 if ($oldupgrade && function_exists($oldupgrade_function)) {
177 $db->debug = true;
178 $oldupgrade_status = $oldupgrade_function($CFG->$pluginversion);
179 } else if ($oldupgrade) {
180 notify ('Upgrade function ' . $oldupgrade_function . ' was not available in ' .
181 $fullplug . '/db/' . $CFG->dbtype . '.php');
182 }
183
184 /// Then, the new function if exists and the old one was ok
185 $newupgrade_status = true;
186 if ($newupgrade && function_exists($newupgrade_function) && $oldupgrade_status) {
187 $db->debug = true;
188 $newupgrade_status = $newupgrade_function($CFG->$pluginversion);
189 } else if ($newupgrade) {
190 notify ('Upgrade function ' . $newupgrade_function . ' was not available in ' .
191 $fullplug . '/db/upgrade.php');
192 }
193
194 $db->debug=false;
195 /// Now analyze upgrade results
196 if ($oldupgrade_status && $newupgrade_status) { // No upgrading failed
197 // OK so far, now update the plugins record
198 set_config($pluginversion, $plugin->version);
ae628043 199 if (!update_capabilities($type.'/'.$plug)) {
e79a09a2 200 error('Could not update '.$plugin->name.' capabilities!');
d87a9d73 201 }
0856223c 202 events_update_definition($type.'/'.$plug);
e79a09a2 203 notify(get_string('modulesuccess', '', $plugin->name), 'notifysuccess');
204 } else {
205 notify('Upgrading '. $plugin->name .' from '. $CFG->$pluginversion .' to '. $plugin->version .' FAILED!');
173cc1c3 206 }
207 }
d87a9d73 208 echo '<hr />';
173cc1c3 209 } else {
583fad99 210 upgrade_log_start();
ead29342 211 error('Version mismatch: '. $plugin->name .' can\'t downgrade '. $CFG->$pluginversion .' -> '. $plugin->version .' !');
173cc1c3 212 }
213 }
214
583fad99 215 upgrade_log_finish();
216
15999a93 217 if ($updated_plugins && !$embedded) {
173cc1c3 218 print_continue($return);
acdd790f 219 print_footer('none');
173cc1c3 220 die;
221 }
222}
223
88a7228a 224/**
225 * Find and check all modules and load them up or upgrade them if necessary
226 *
227 * @uses $db
228 * @uses $CFG
229 * @param string $return The url to prompt the user to continue to
230 * @todo Finish documenting this function
eef868d1 231 */
173cc1c3 232function upgrade_activity_modules($return) {
173cc1c3 233
e69ef14b 234 global $CFG, $db;
173cc1c3 235
88a7228a 236 if (!$mods = get_list_of_plugins('mod') ) {
237 error('No modules installed!');
173cc1c3 238 }
239
583fad99 240 $updated_modules = false;
241 $strmodulesetup = get_string('modulesetup');
242
173cc1c3 243 foreach ($mods as $mod) {
244
88a7228a 245 if ($mod == 'NEWMODULE') { // Someone has unzipped the template, ignore it
173cc1c3 246 continue;
247 }
248
88a7228a 249 $fullmod = $CFG->dirroot .'/mod/'. $mod;
173cc1c3 250
251 unset($module);
252
88a7228a 253 if ( is_readable($fullmod .'/version.php')) {
254 include_once($fullmod .'/version.php'); // defines $module with version etc
173cc1c3 255 } else {
88a7228a 256 notify('Module '. $mod .': '. $fullmod .'/version.php was not readable');
173cc1c3 257 continue;
258 }
259
d6eb06b6 260 $oldupgrade = false;
261 $newupgrade = false;
7c006e34 262 if ( is_readable($fullmod .'/db/' . $CFG->dbtype . '.php')) {
263 include_once($fullmod .'/db/' . $CFG->dbtype . '.php'); // defines old upgrading function
d6eb06b6 264 $oldupgrade = true;
265 }
db8bd7a6 266 if ( is_readable($fullmod . '/db/upgrade.php')) {
7c006e34 267 include_once($fullmod . '/db/upgrade.php'); // defines new upgrading function
d6eb06b6 268 $newupgrade = true;
173cc1c3 269 }
270
271 if (!isset($module)) {
272 continue;
273 }
274
275 if (!empty($module->requires)) {
276 if ($module->requires > $CFG->version) {
acdd790f 277 $info = new object();
173cc1c3 278 $info->modulename = $mod;
279 $info->moduleversion = $module->version;
280 $info->currentmoodle = $CFG->version;
281 $info->requiremoodle = $module->requires;
583fad99 282 if (!$updated_modules) {
0be6f678 283 print_header($strmodulesetup, $strmodulesetup,
284 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
371a32e3 285 upgrade_get_javascript(), false, '&nbsp;', '&nbsp;');
583fad99 286 }
287 upgrade_log_start();
173cc1c3 288 notify(get_string('modulerequirementsnotmet', 'error', $info));
583fad99 289 $updated_modules = true;
173cc1c3 290 continue;
291 }
292 }
293
294 $module->name = $mod; // The name MUST match the directory
eef868d1 295
11e4a24b 296 include_once($fullmod.'/lib.php'); // defines upgrading and/or installing functions
297
88a7228a 298 if ($currmodule = get_record('modules', 'name', $module->name)) {
173cc1c3 299 if ($currmodule->version == $module->version) {
300 // do nothing
301 } else if ($currmodule->version < $module->version) {
d6eb06b6 302 /// If versions say that we need to upgrade but no upgrade files are available, notify and continue
303 if (!$oldupgrade && !$newupgrade) {
304 notify('Upgrade files ' . $mod . ': ' . $fullmod . '/db/' . $CFG->dbtype . '.php or ' .
305 $fullmod . '/db/upgrade.php were not readable');
306 continue;
307 }
583fad99 308 if (!$updated_modules) {
0be6f678 309 print_header($strmodulesetup, $strmodulesetup,
310 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
371a32e3 311 upgrade_get_javascript(), false, '&nbsp;', '&nbsp;');
173cc1c3 312 }
583fad99 313 upgrade_log_start();
88a7228a 314 print_heading($module->name .' module needs upgrading');
d6eb06b6 315
316 /// Run de old and new upgrade functions for the module
317 $oldupgrade_function = $module->name . '_upgrade';
318 $newupgrade_function = 'xmldb_' . $module->name . '_upgrade';
319
320 /// First, the old function if exists
321 $oldupgrade_status = true;
322 if ($oldupgrade && function_exists($oldupgrade_function)) {
323 $db->debug = true;
324 $oldupgrade_status = $oldupgrade_function($currmodule->version, $module);
8bc9ebc4 325 if (!$oldupgrade_status) {
326 notify ('Upgrade function ' . $oldupgrade_function .
220a90c5 327 ' did not complete successfully.');
8bc9ebc4 328 }
ba05965e 329 } else if ($oldupgrade) {
d6eb06b6 330 notify ('Upgrade function ' . $oldupgrade_function . ' was not available in ' .
331 $mod . ': ' . $fullmod . '/db/' . $CFG->dbtype . '.php');
d6eb06b6 332 }
333
334 /// Then, the new function if exists and the old one was ok
335 $newupgrade_status = true;
ba05965e 336 if ($newupgrade && function_exists($newupgrade_function) && $oldupgrade_status) {
d6eb06b6 337 $db->debug = true;
338 $newupgrade_status = $newupgrade_function($currmodule->version, $module);
8bc9ebc4 339 } else if ($newupgrade && $oldupgrade_status) {
d6eb06b6 340 notify ('Upgrade function ' . $newupgrade_function . ' was not available in ' .
341 $mod . ': ' . $fullmod . '/db/upgrade.php');
d6eb06b6 342 }
343
e79a09a2 344 $db->debug=false;
d6eb06b6 345 /// Now analyze upgrade results
668896e5 346 if ($oldupgrade_status && $newupgrade_status) { // No upgrading failed
d6eb06b6 347 // OK so far, now update the modules record
348 $module->id = $currmodule->id;
349 if (! update_record('modules', $module)) {
350 error('Could not update '. $module->name .' record in modules table!');
173cc1c3 351 }
d6eb06b6 352 remove_dir($CFG->dataroot . '/cache', true); // flush cache
353 notify(get_string('modulesuccess', '', $module->name), 'notifysuccess');
354 echo '<hr />';
355 } else {
d6eb06b6 356 notify('Upgrading '. $module->name .' from '. $currmodule->version .' to '. $module->version .' FAILED!');
173cc1c3 357 }
bbbf2d40 358
d6eb06b6 359 /// Update the capabilities table?
bbbf2d40 360 if (!update_capabilities('mod/'.$module->name)) {
361 error('Could not update '.$module->name.' capabilities!');
362 }
0856223c 363 events_update_definition('mod/'.$module->name);
bbbf2d40 364
173cc1c3 365 $updated_modules = true;
eef868d1 366
173cc1c3 367 } else {
583fad99 368 upgrade_log_start();
88a7228a 369 error('Version mismatch: '. $module->name .' can\'t downgrade '. $currmodule->version .' -> '. $module->version .' !');
173cc1c3 370 }
eef868d1 371
173cc1c3 372 } else { // module not installed yet, so install it
583fad99 373 if (!$updated_modules) {
0be6f678 374 print_header($strmodulesetup, $strmodulesetup,
375 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
371a32e3 376 upgrade_get_javascript(), false, '&nbsp;', '&nbsp;');
173cc1c3 377 }
583fad99 378 upgrade_log_start();
173cc1c3 379 print_heading($module->name);
380 $updated_modules = true;
381 $db->debug = true;
382 @set_time_limit(0); // To allow slow databases to complete the long SQL
d6eb06b6 383
384 /// Both old .sql files and new install.xml are supported
385 /// but we priorize install.xml (XMLDB) if present
db8bd7a6 386 if (file_exists($fullmod . '/db/install.xml')) {
d6eb06b6 387 $status = install_from_xmldb_file($fullmod . '/db/install.xml'); //New method
388 } else {
389 $status = modify_database($fullmod .'/db/'. $CFG->dbtype .'.sql'); //Old method
390 }
391
e79a09a2 392 $db->debug = false;
11e4a24b 393
394 /// Continue with the installation, roles and other stuff
d6eb06b6 395 if ($status) {
88a7228a 396 if ($module->id = insert_record('modules', $module)) {
11e4a24b 397
9ba38673 398 /// Capabilities
bbbf2d40 399 if (!update_capabilities('mod/'.$module->name)) {
400 error('Could not set up the capabilities for '.$module->name.'!');
401 }
9ba38673 402
11e4a24b 403 /// Events
0856223c 404 events_update_definition('mod/'.$module->name);
11e4a24b 405
406 /// Run local install function if there is one
407 $installfunction = $module->name.'_install';
408 if (function_exists($installfunction)) {
409 if (! $installfunction() ) {
410 notify('Encountered a problem running install function for '.$module->name.'!');
411 }
412 }
413
a8f68426 414 notify(get_string('modulesuccess', '', $module->name), 'notifysuccess');
88a7228a 415 echo '<hr />';
173cc1c3 416 } else {
88a7228a 417 error($module->name .' module could not be added to the module list!');
173cc1c3 418 }
eef868d1 419 } else {
88a7228a 420 error($module->name .' tables could NOT be set up successfully!');
173cc1c3 421 }
422 }
e5bd4e58 423
424 /// Check submodules of this module if necessary
425
e5bd4e58 426 $submoduleupgrade = $module->name.'_upgrade_submodules';
427 if (function_exists($submoduleupgrade)) {
428 $submoduleupgrade();
429 }
430
431
432 /// Run any defaults or final code that is necessary for this module
433
a5c0990e 434 if ( is_readable($fullmod .'/defaults.php')) {
435 // Insert default values for any important configuration variables
9e6e7502 436 unset($defaults);
220a90c5 437 include($fullmod .'/defaults.php'); // include here means execute, not library include
f9a2e515 438 if (!empty($defaults)) {
439 foreach ($defaults as $name => $value) {
440 if (!isset($CFG->$name)) {
441 set_config($name, $value);
442 }
a5c0990e 443 }
444 }
445 }
173cc1c3 446 }
447
583fad99 448 upgrade_log_finish(); // finish logging if started
449
450 if ($updated_modules) {
173cc1c3 451 print_continue($return);
acdd790f 452 print_footer('none');
173cc1c3 453 die;
454 }
455}
456
eef868d1 457/**
f3221af9 458 * This function will return FALSE if the lock fails to be set (ie, if it's already locked)
80be7ee3 459 *
460 * @param string $name ?
461 * @param bool $value ?
462 * @param int $staleafter ?
463 * @param bool $clobberstale ?
464 * @todo Finish documenting this function
f3221af9 465 */
466function set_cron_lock($name,$value=true,$staleafter=7200,$clobberstale=false) {
467
468 if (empty($name)) {
469 mtrace("Tried to get a cron lock for a null fieldname");
470 return false;
471 }
472
473 if (empty($value)) {
474 set_config($name,0);
475 return true;
476 }
477
478 if ($config = get_record('config','name',$name)) {
479 if (empty($config->value)) {
480 set_config($name,time());
481 } else {
482 // check for stale.
483 if ((time() - $staleafter) > $config->value) {
484 mtrace("STALE LOCKFILE FOR $name - was $config->value");
485 if (!empty($clobberstale)) {
486 set_config($name,time());
487 return true;
488 }
489 } else {
490 return false; // was not stale - ie, we're ok to still be running.
491 }
492 }
493 }
494 else {
495 set_config($name,time());
496 }
497 return true;
498}
a597f8a8 499
fb06b255 500function print_progress($done, $total, $updatetime=5, $sleeptime=1, $donetext='') {
a597f8a8 501 static $starttime;
502 static $lasttime;
503
26ea4888 504 if ($total < 2) { // No need to show anything
505 return;
506 }
507
a597f8a8 508 if (empty($starttime)) {
509 $starttime = $lasttime = time();
510 $lasttime = $starttime - $updatetime;
511 echo '<table width="500" cellpadding="0" cellspacing="0" align="center"><tr><td width="500">';
72da5046 512 echo '<div id="bar'.$total.'" style="border-style:solid;border-width:1px;width:500px;height:50px;">';
513 echo '<div id="slider'.$total.'" style="border-style:solid;border-width:1px;height:48px;width:10px;background-color:green;"></div>';
a597f8a8 514 echo '</div>';
72da5046 515 echo '<div id="text'.$total.'" align="center" style="width:500px;"></div>';
a597f8a8 516 echo '</td></tr></table>';
517 echo '</div>';
518 }
519
a597f8a8 520 $now = time();
521
522 if ($done && (($now - $lasttime) >= $updatetime)) {
523 $elapsedtime = $now - $starttime;
524 $projectedtime = (int)(((float)$total / (float)$done) * $elapsedtime) - $elapsedtime;
76317c73 525 $percentage = round((float)$done / (float)$total, 2);
a597f8a8 526 $width = (int)(500 * $percentage);
527
fb06b255 528 if ($projectedtime > 10) {
529 $projectedtext = ' Ending: '.format_time($projectedtime);
530 } else {
531 $projectedtext = '';
532 }
533
a597f8a8 534 echo '<script>';
aae37b63 535 echo 'document.getElementById("text'.$total.'").innerHTML = "'.addslashes($donetext).' ('.$done.'/'.$total.') '.$projectedtext.'";'."\n";
536 echo 'document.getElementById("slider'.$total.'").style.width = \''.$width.'px\';'."\n";
a597f8a8 537 echo '</script>';
538
539 $lasttime = $now;
540 sleep($sleeptime);
541 }
542}
583fad99 543
371a32e3 544function upgrade_get_javascript() {
545 global $CFG;
546
547 if (!empty($_SESSION['installautopilot'])) {
548 $linktoscrolltoerrors = '<script type="text/javascript">var installautopilot = true;</script>'."\n";
549 } else {
550 $linktoscrolltoerrors = '<script type="text/javascript">var installautopilot = false;</script>'."\n";
551 }
552 $linktoscrolltoerrors .= '<script type="text/javascript" src="' . $CFG->wwwroot . '/lib/scroll_to_errors.js"></script>';
553
554 return $linktoscrolltoerrors;
555}
ad6226fb 556
557function create_admin_user() {
558 global $CFG, $USER;
559
560 if (empty($CFG->rolesactive)) { // No admin user yet.
561
562 $user = new object();
563 $user->auth = 'manual';
564 $user->firstname = get_string('admin');
565 $user->lastname = get_string('user');
566 $user->username = 'admin';
567 $user->password = hash_internal_user_password('admin');
568 $user->email = 'root@localhost';
569 $user->confirmed = 1;
570 $user->mnethostid = $CFG->mnet_localhost_id;
571 $user->lang = $CFG->lang;
572 $user->maildisplay = 1;
573 $user->timemodified = time();
574
575 if (!$user->id = insert_record('user', $user)) {
576 error('SERIOUS ERROR: Could not create admin user record !!!');
577 }
578
579 if (!$user = get_record('user', 'id', $user->id)) { // Double check.
580 error('User ID was incorrect (can\'t find it)');
581 }
582
583 // Assign the default admin roles to the new user.
584 if (!$adminroles = get_roles_with_capability('moodle/legacy:admin', CAP_ALLOW)) {
585 error('No admin role could be found');
586 }
84c8ede0 587 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
ad6226fb 588 foreach ($adminroles as $adminrole) {
589 role_assign($adminrole->id, $user->id, 0, $sitecontext->id);
590 }
591
592 set_config('rolesactive', 1);
593
594 // Log the user in.
595 $USER = get_complete_user_data('username', 'admin');
596 $USER->newadminuser = 1;
597 load_all_capabilities();
598
599 redirect("$CFG->wwwroot/user/editadvanced.php?id=$user->id"); // Edit thyself
600 } else {
601 error('Can not create admin!');
602 }
603}
604
583fad99 605////////////////////////////////////////////////
606/// upgrade logging functions
607////////////////////////////////////////////////
608
609$upgradeloghandle = false;
26c91c73 610$upgradelogbuffer = '';
611// I did not find out how to use static variable in callback function,
612// the problem was that I could not flush the static buffer :-(
613global $upgradeloghandle, $upgradelogbuffer;
583fad99 614
615/**
616 * Check if upgrade is already running.
617 *
618 * If anything goes wrong due to missing call to upgrade_log_finish()
619 * just restart the browser.
620 *
621 * @param string warning message indicating upgrade is already running
622 * @param int page reload timeout
623 */
624function upgrade_check_running($message, $timeout) {
625 if (!empty($_SESSION['upgraderunning'])) {
626 print_header();
627 redirect(me(), $message, $timeout);
628 }
629}
630
631/**
632 * Start logging of output into file (if not disabled) and
633 * prevent aborting and concurrent execution of upgrade script.
634 *
635 * Please note that you can not write into session variables after calling this function!
636 *
637 * This function may be called repeatedly.
638 */
639function upgrade_log_start() {
426a369b 640 global $CFG, $upgradeloghandle;
583fad99 641
642 if (!empty($_SESSION['upgraderunning'])) {
643 return; // logging already started
644 }
645
646 @ignore_user_abort(true); // ignore if user stops or otherwise aborts page loading
647 $_SESSION['upgraderunning'] = 1; // set upgrade indicator
426a369b 648 if (empty($CFG->dbsessions)) { // workaround for bug in adodb, db session can not be restarted
649 session_write_close(); // from now on user can reload page - will be displayed warning
650 }
583fad99 651 make_upload_directory('upgradelogs');
652 ob_start('upgrade_log_callback', 2); // function for logging to disk; flush each line of text ASAP
dedb2304 653 register_shutdown_function('upgrade_log_finish'); // in case somebody forgets to stop logging
583fad99 654}
655
656/**
657 * Terminate logging of output, flush all data, allow script aborting
658 * and reopen session for writing. Function error() does terminate the logging too.
659 *
660 * Please make sure that each upgrade_log_start() is properly terminated by
661 * this function or error().
662 *
663 * This function may be called repeatedly.
664 */
665function upgrade_log_finish() {
426a369b 666 global $CFG, $upgradeloghandle, $upgradelogbuffer;
583fad99 667
668 if (empty($_SESSION['upgraderunning'])) {
669 return; // logging already terminated
670 }
671
672 @ob_end_flush();
26c91c73 673 if ($upgradelogbuffer !== '') {
674 @fwrite($upgradeloghandle, $upgradelogbuffer);
40896537 675 $upgradelogbuffer = '';
26c91c73 676 }
677 if ($upgradeloghandle and ($upgradeloghandle !== 'error')) {
678 @fclose($upgradeloghandle);
40896537 679 $upgradeloghandle = false;
26c91c73 680 }
426a369b 681 if (empty($CFG->dbsessions)) {
682 @session_start(); // ignore header errors, we only need to reopen session
683 }
583fad99 684 $_SESSION['upgraderunning'] = 0; // clear upgrade indicator
685 if (connection_aborted()) {
686 die;
687 }
688 @ignore_user_abort(false);
689}
690
691/**
692 * Callback function for logging into files. Not more than one file is created per minute,
693 * upgrade session (terminated by upgrade_log_finish()) is always stored in one file.
694 *
695 * This function must not output any characters or throw warnigns and errors!
696 */
697function upgrade_log_callback($string) {
26c91c73 698 global $CFG, $upgradeloghandle, $upgradelogbuffer;
583fad99 699
700 if (empty($CFG->disableupgradelogging) and ($string != '') and ($upgradeloghandle !== 'error')) {
701 if ($upgradeloghandle or ($upgradeloghandle = @fopen($CFG->dataroot.'/upgradelogs/upg_'.date('Ymd-Hi').'.html', 'a'))) {
26c91c73 702 $upgradelogbuffer .= $string;
703 if (strlen($upgradelogbuffer) > 2048) { // 2kB write buffer
704 @fwrite($upgradeloghandle, $upgradelogbuffer);
705 $upgradelogbuffer = '';
706 }
583fad99 707 } else {
708 $upgradeloghandle = 'error';
709 }
710 }
711 return $string;
712}
713
57e35f32 714/**
715 * Try to verify that dataroot is not accessible from web.
716 * It is not 100% correct but might help to reduce number of vulnerable sites.
717 *
718 * Protection from httpd.conf and .htaccess is not detected properly.
719 */
720function is_dataroot_insecure() {
721 global $CFG;
722
723 $siteroot = str_replace('\\', '/', strrev($CFG->dirroot.'/')); // win32 backslash workaround
724
725 $rp = preg_replace('|https?://[^/]+|i', '', $CFG->wwwroot, 1);
726 $rp = strrev(trim($rp, '/'));
727 $rp = explode('/', $rp);
728 foreach($rp as $r) {
729 if (strpos($siteroot, '/'.$r.'/') === 0) {
730 $siteroot = substr($siteroot, strlen($r)+1); // moodle web in subdirectory
731 } else {
732 break; // probably alias root
733 }
734 }
735
736 $siteroot = strrev($siteroot);
737 $dataroot = str_replace('\\', '/', $CFG->dataroot.'/');
738
739 if (strpos($dataroot, $siteroot) === 0) {
740 return true;
741 }
742 return false;
743}
6e4dc10f 744
745/// =============================================================================================================
746/// administration tree classes and functions
747
748
749// n.b. documentation is still in progress for this code
750
751/// INTRODUCTION
752
753/// This file performs the following tasks:
754/// -it defines the necessary objects and interfaces to build the Moodle
755/// admin hierarchy
eef868d1 756/// -it defines the admin_externalpage_setup(), admin_externalpage_print_header(),
6e4dc10f 757/// and admin_externalpage_print_footer() functions used on admin pages
758
759/// ADMIN_SETTING OBJECTS
760
eef868d1 761/// Moodle settings are represented by objects that inherit from the admin_setting
6e4dc10f 762/// class. These objects encapsulate how to read a setting, how to write a new value
763/// to a setting, and how to appropriately display the HTML to modify the setting.
764
765/// ADMIN_SETTINGPAGE OBJECTS
766
767/// The admin_setting objects are then grouped into admin_settingpages. The latter
768/// appear in the Moodle admin tree block. All interaction with admin_settingpage
769/// objects is handled by the admin/settings.php file.
770
771/// ADMIN_EXTERNALPAGE OBJECTS
772
773/// There are some settings in Moodle that are too complex to (efficiently) handle
774/// with admin_settingpages. (Consider, for example, user management and displaying
775/// lists of users.) In this case, we use the admin_externalpage object. This object
776/// places a link to an external PHP file in the admin tree block.
777
778/// If you're using an admin_externalpage object for some settings, you can take
779/// advantage of the admin_externalpage_* functions. For example, suppose you wanted
780/// to add a foo.php file into admin. First off, you add the following line to
781/// admin/settings/first.php (at the end of the file) or to some other file in
782/// admin/settings:
783
eef868d1 784/// $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
6e4dc10f 785/// $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
786
787/// Next, in foo.php, your file structure would resemble the following:
788
789/// require_once('.../config.php');
790/// require_once($CFG->libdir.'/adminlib.php');
1ae083e4 791/// admin_externalpage_setup('foo');
6e4dc10f 792/// // functionality like processing form submissions goes here
1ae083e4 793/// admin_externalpage_print_header();
6e4dc10f 794/// // your HTML goes here
1ae083e4 795/// admin_externalpage_print_footer();
6e4dc10f 796
797/// The admin_externalpage_setup() function call ensures the user is logged in,
798/// and makes sure that they have the proper role permission to access the page.
799
800/// The admin_externalpage_print_header() function prints the header (it figures
801/// out what category and subcategories the page is classified under) and ensures
802/// that you're using the admin pagelib (which provides the admin tree block and
803/// the admin bookmarks block).
804
805/// The admin_externalpage_print_footer() function properly closes the tables
806/// opened up by the admin_externalpage_print_header() function and prints the
807/// standard Moodle footer.
808
809/// ADMIN_CATEGORY OBJECTS
810
811/// Above and beyond all this, we have admin_category objects. These objects
812/// appear as folders in the admin tree block. They contain admin_settingpage's,
813/// admin_externalpage's, and other admin_category's.
814
815/// OTHER NOTES
816
817/// admin_settingpage's, admin_externalpage's, and admin_category's all inherit
818/// from part_of_admin_tree (a pseudointerface). This interface insists that
819/// a class has a check_access method for access permissions, a locate method
220a90c5 820/// used to find a specific node in the admin tree and find parent path.
6e4dc10f 821
822/// admin_category's inherit from parentable_part_of_admin_tree. This pseudo-
823/// interface ensures that the class implements a recursive add function which
824/// accepts a part_of_admin_tree object and searches for the proper place to
825/// put it. parentable_part_of_admin_tree implies part_of_admin_tree.
826
827/// Please note that the $this->name field of any part_of_admin_tree must be
828/// UNIQUE throughout the ENTIRE admin tree.
829
830/// The $this->name field of an admin_setting object (which is *not* part_of_
831/// admin_tree) must be unique on the respective admin_settingpage where it is
832/// used.
833
834
6e4dc10f 835/// CLASS DEFINITIONS /////////////////////////////////////////////////////////
836
837/**
838 * Pseudointerface for anything appearing in the admin tree
839 *
840 * The pseudointerface that is implemented by anything that appears in the admin tree
841 * block. It forces inheriting classes to define a method for checking user permissions
842 * and methods for finding something in the admin tree.
843 *
844 * @author Vincenzo K. Marcovecchio
845 * @package admin
846 */
847class part_of_admin_tree {
848
849 /**
850 * Finds a named part_of_admin_tree.
851 *
852 * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
853 * and not parentable_part_of_admin_tree, then this function should only check if
854 * $this->name matches $name. If it does, it should return a reference to $this,
855 * otherwise, it should return a reference to NULL.
856 *
857 * If a class inherits parentable_part_of_admin_tree, this method should be called
858 * recursively on all child objects (assuming, of course, the parent object's name
859 * doesn't match the search criterion).
860 *
861 * @param string $name The internal name of the part_of_admin_tree we're searching for.
862 * @return mixed An object reference or a NULL reference.
863 */
eef868d1 864 function &locate($name) {
865 trigger_error('Admin class does not implement method <strong>locate()</strong>', E_USER_WARNING);
866 return;
6e4dc10f 867 }
4672d955 868
869 /**
870 * Removes named part_of_admin_tree.
871 *
872 * @param string $name The internal name of the part_of_admin_tree we want to remove.
a8a66c96 873 * @return bool success.
4672d955 874 */
875 function prune($name) {
eef868d1 876 trigger_error('Admin class does not implement method <strong>prune()</strong>', E_USER_WARNING);
4672d955 877 return;
eef868d1 878 }
4672d955 879
220a90c5 880 /**
881 * Search using query
882 * @param strin query
883 * @return mixed array-object structure of found settings and pages
884 */
885 function search($query) {
886 trigger_error('Admin class does not implement method <strong>search()</strong>', E_USER_WARNING);
887 return;
888 }
889
6e4dc10f 890 /**
891 * Verifies current user's access to this part_of_admin_tree.
892 *
893 * Used to check if the current user has access to this part of the admin tree or
894 * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
895 * then this method is usually just a call to has_capability() in the site context.
896 *
897 * If a class inherits parentable_part_of_admin_tree, this method should return the
898 * logical OR of the return of check_access() on all child objects.
899 *
900 * @return bool True if the user has access, false if she doesn't.
901 */
eef868d1 902 function check_access() {
903 trigger_error('Admin class does not implement method <strong>check_access()</strong>', E_USER_WARNING);
904 return;
6e4dc10f 905 }
eef868d1 906
a8a66c96 907 /**
908 * Mostly usefull for removing of some parts of the tree in admin tree block.
909 *
910 * @return True is hidden from normal list view
911 */
912 function is_hidden() {
913 trigger_error('Admin class does not implement method <strong>is_hidden()</strong>', E_USER_WARNING);
914 return;
915 }
6e4dc10f 916}
917
918/**
919 * Pseudointerface implemented by any part_of_admin_tree that has children.
920 *
921 * The pseudointerface implemented by any part_of_admin_tree that can be a parent
922 * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
eef868d1 923 * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
6e4dc10f 924 * include an add method for adding other part_of_admin_tree objects as children.
925 *
926 * @author Vincenzo K. Marcovecchio
927 * @package admin
928 */
929class parentable_part_of_admin_tree extends part_of_admin_tree {
eef868d1 930
6e4dc10f 931 /**
932 * Adds a part_of_admin_tree object to the admin tree.
933 *
934 * Used to add a part_of_admin_tree object to this object or a child of this
935 * object. $something should only be added if $destinationname matches
936 * $this->name. If it doesn't, add should be called on child objects that are
937 * also parentable_part_of_admin_tree's.
938 *
939 * @param string $destinationname The internal name of the new parent for $something.
940 * @param part_of_admin_tree &$something The object to be added.
941 * @return bool True on success, false on failure.
942 */
220a90c5 943 function add($destinationname, $something) {
eef868d1 944 trigger_error('Admin class does not implement method <strong>add()</strong>', E_USER_WARNING);
945 return;
6e4dc10f 946 }
eef868d1 947
6e4dc10f 948}
949
950/**
951 * The object used to represent folders (a.k.a. categories) in the admin tree block.
eef868d1 952 *
6e4dc10f 953 * Each admin_category object contains a number of part_of_admin_tree objects.
954 *
955 * @author Vincenzo K. Marcovecchio
956 * @package admin
957 */
958class admin_category extends parentable_part_of_admin_tree {
959
960 /**
961 * @var mixed An array of part_of_admin_tree objects that are this object's children
962 */
963 var $children;
eef868d1 964
6e4dc10f 965 /**
966 * @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
967 */
968 var $name;
eef868d1 969
6e4dc10f 970 /**
971 * @var string The displayed name for this category. Usually obtained through get_string()
972 */
973 var $visiblename;
eef868d1 974
a8a66c96 975 /**
976 * @var bool Should this category be hidden in admin tree block?
977 */
978 var $hidden;
979
220a90c5 980 /**
981 * paths
982 */
983 var $path;
984 var $visiblepath;
6e4dc10f 985
986 /**
987 * Constructor for an empty admin category
988 *
989 * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
990 * @param string $visiblename The displayed named for this category. Usually obtained through get_string()
a8a66c96 991 * @param bool $hidden hide category in admin tree block
6e4dc10f 992 */
220a90c5 993 function admin_category($name, $visiblename, $hidden=false) {
994 $this->children = array();
995 $this->name = $name;
6e4dc10f 996 $this->visiblename = $visiblename;
220a90c5 997 $this->hidden = $hidden;
6e4dc10f 998 }
eef868d1 999
6e4dc10f 1000 /**
220a90c5 1001 * Returns a reference to the part_of_admin_tree object with internal name $name.
6e4dc10f 1002 *
220a90c5 1003 * @param string $name The internal name of the object we want.
1004 * @param bool $findpath initialize path and visiblepath arrays
1005 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
6e4dc10f 1006 */
220a90c5 1007 function &locate($name, $findpath=false) {
6e4dc10f 1008 if ($this->name == $name) {
220a90c5 1009 if ($findpath) {
1010 $this->visiblepath[] = $this->visiblename;
1011 $this->path[] = $this->name;
1012 }
1013 return $this;
6e4dc10f 1014 }
eef868d1 1015
220a90c5 1016 $return = NULL;
1017 foreach($this->children as $childid=>$unused) {
1018 if ($return =& $this->children[$childid]->locate($name, $findpath)) {
1019 break;
6e4dc10f 1020 }
1021 }
eef868d1 1022
220a90c5 1023 if (!is_null($return) and $findpath) {
1024 $return->visiblepath[] = $this->visiblename;
1025 $return->path[] = $this->name;
1026 }
eef868d1 1027
220a90c5 1028 return $return;
6e4dc10f 1029 }
1030
1031 /**
220a90c5 1032 * Search using query
1033 * @param strin query
1034 * @return mixed array-object structure of found settings and pages
6e4dc10f 1035 */
220a90c5 1036 function search($query) {
1037 $result = array();
1038 foreach ($this->children as $child) {
3cea9c55 1039 $subsearch = $child->search($query);
1040 if (!is_array($subsearch)) {
1041 debugging('Incorrect search result from '.$child->name);
1042 continue;
1043 }
1044 $result = array_merge($result, $subsearch);
6e4dc10f 1045 }
220a90c5 1046 return $result;
6e4dc10f 1047 }
1048
4672d955 1049 /**
1050 * Removes part_of_admin_tree object with internal name $name.
1051 *
1052 * @param string $name The internal name of the object we want to remove.
a8a66c96 1053 * @return bool success
4672d955 1054 */
1055 function prune($name) {
1056
1057 if ($this->name == $name) {
1058 return false; //can not remove itself
1059 }
1060
1061 foreach($this->children as $precedence => $child) {
1062 if ($child->name == $name) {
1063 // found it!
eef868d1 1064 unset($this->children[$precedence]);
4672d955 1065 return true;
1066 }
1067 if ($this->children[$precedence]->prune($name)) {
1068 return true;
1069 }
1070 }
1071 return false;
1072 }
1073
6e4dc10f 1074 /**
1075 * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
1076 *
220a90c5 1077 * @param string $destinationame The internal name of the immediate parent that we want for $something.
1078 * @param mixed $something A part_of_admin_tree or setting instanceto be added.
1079 * @return bool True if successfully added, false if $something can not be added.
6e4dc10f 1080 */
220a90c5 1081 function add($parentname, $something) {
1082 $parent =& $this->locate($parentname);
1083 if (is_null($parent)) {
1084 debugging('parent does not exist!');
6e4dc10f 1085 return false;
1086 }
1087
220a90c5 1088 if (is_a($something, 'part_of_admin_tree')) {
1089 if (!is_a($parent, 'parentable_part_of_admin_tree')) {
1090 debugging('error - parts of tree can be inserted only into parentable parts');
1091 return false;
6e4dc10f 1092 }
220a90c5 1093 $parent->children[] = $something;
6e4dc10f 1094 return true;
eef868d1 1095
220a90c5 1096 } else {
1097 debugging('error - can not add this element');
1098 return false;
6e4dc10f 1099 }
eef868d1 1100
6e4dc10f 1101 }
eef868d1 1102
6e4dc10f 1103 /**
1104 * Checks if the user has access to anything in this category.
1105 *
1106 * @return bool True if the user has access to atleast one child in this category, false otherwise.
1107 */
1108 function check_access() {
6e4dc10f 1109 foreach ($this->children as $child) {
220a90c5 1110 if ($child->check_access()) {
1111 return true;
1112 }
6e4dc10f 1113 }
220a90c5 1114 return false;
6e4dc10f 1115 }
eef868d1 1116
a8a66c96 1117 /**
1118 * Is this category hidden in admin tree block?
1119 *
1120 * @return bool True if hidden
1121 */
1122 function is_hidden() {
1123 return $this->hidden;
1124 }
6e4dc10f 1125}
1126
220a90c5 1127class admin_root extends admin_category {
1128 /**
1129 * list of errors
1130 */
1131 var $errors;
1132
1133 /**
1134 * search query
1135 */
1136 var $search;
1137
1138 /**
1139 * full tree flag - true means all settings required, false onlypages required
1140 */
1141 var $fulltree;
1142
1143
1144 function admin_root() {
1145 parent::admin_category('root', get_string('administration'), false);
1146 $this->errors = array();
1147 $this->search = '';
1148 $this->fulltree = true;
1149 }
1150}
1151
6e4dc10f 1152/**
1153 * Links external PHP pages into the admin tree.
1154 *
1155 * See detailed usage example at the top of this document (adminlib.php)
1156 *
1157 * @author Vincenzo K. Marcovecchio
1158 * @package admin
1159 */
1160class admin_externalpage extends part_of_admin_tree {
1161
eef868d1 1162 /**
6e4dc10f 1163 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1164 */
1165 var $name;
eef868d1 1166
6e4dc10f 1167 /**
1168 * @var string The displayed name for this external page. Usually obtained through get_string().
1169 */
1170 var $visiblename;
eef868d1 1171
6e4dc10f 1172 /**
1173 * @var string The external URL that we should link to when someone requests this external page.
1174 */
1175 var $url;
eef868d1 1176
6e4dc10f 1177 /**
1178 * @var string The role capability/permission a user must have to access this external page.
1179 */
2ce38b70 1180 var $req_capability;
eef868d1 1181
84c8ede0 1182 /**
1183 * @var object The context in which capability/permission should be checked, default is site context.
1184 */
1185 var $context;
1186
a8a66c96 1187 /**
1188 * @var bool hidden in admin tree block.
1189 */
1190 var $hidden;
1191
220a90c5 1192 /**
1193 * visible path
1194 */
1195 var $path;
1196 var $visiblepath;
1197
6e4dc10f 1198 /**
1199 * Constructor for adding an external page into the admin tree.
1200 *
1201 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1202 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1203 * @param string $url The external URL that we should link to when someone requests this external page.
38d2d43b 1204 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
6e4dc10f 1205 */
220a90c5 1206 function admin_externalpage($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1207 $this->name = $name;
6e4dc10f 1208 $this->visiblename = $visiblename;
220a90c5 1209 $this->url = $url;
38d2d43b 1210 if (is_array($req_capability)) {
1211 $this->req_capability = $req_capability;
1212 } else {
1213 $this->req_capability = array($req_capability);
1214 }
220a90c5 1215 $this->hidden = $hidden;
84c8ede0 1216 $this->context = $context;
6e4dc10f 1217 }
eef868d1 1218
6e4dc10f 1219 /**
1220 * Returns a reference to the part_of_admin_tree object with internal name $name.
1221 *
1222 * @param string $name The internal name of the object we want.
1223 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1224 */
220a90c5 1225 function &locate($name, $findpath=false) {
1226 if ($this->name == $name) {
1227 if ($findpath) {
1228 $this->visiblepath = array($this->visiblename);
1229 $this->path = array($this->name);
1230 }
1231 return $this;
1232 } else {
1233 $return = NULL;
1234 return $return;
1235 }
6e4dc10f 1236 }
4672d955 1237
1238 function prune($name) {
1239 return false;
1240 }
1241
220a90c5 1242 /**
1243 * Search using query
1244 * @param strin query
1245 * @return mixed array-object structure of found settings and pages
1246 */
1247 function search($query) {
1248 $textlib = textlib_get_instance();
1249
1250 $found = false;
1251 if (strpos(strtolower($this->name), $query) !== false) {
1252 $found = true;
1253 } else if (strpos($textlib->strtolower($this->visiblename), $query) !== false) {
1254 $found = true;
1255 }
1256 if ($found) {
1257 $result = new object();
1258 $result->page = $this;
1259 $result->settings = array();
1260 return array($this->name => $result);
1261 } else {
1262 return array();
1263 }
1264 }
1265
6e4dc10f 1266 /**
2ce38b70 1267 * Determines if the current user has access to this external page based on $this->req_capability.
6e4dc10f 1268 * @return bool True if user has access, false otherwise.
1269 */
1270 function check_access() {
1271 if (!get_site()) {
1272 return true; // no access check before site is fully set up
1273 }
84c8ede0 1274 $context = empty($this->context) ? get_context_instance(CONTEXT_SYSTEM) : $this->context;
38d2d43b 1275 foreach($this->req_capability as $cap) {
1276 if (has_capability($cap, $context)) {
1277 return true;
1278 }
1279 }
1280 return false;
6e4dc10f 1281 }
1282
a8a66c96 1283 /**
1284 * Is this external page hidden in admin tree block?
1285 *
1286 * @return bool True if hidden
1287 */
1288 function is_hidden() {
1289 return $this->hidden;
1290 }
1291
6e4dc10f 1292}
1293
1294/**
1295 * Used to group a number of admin_setting objects into a page and add them to the admin tree.
1296 *
1297 * @author Vincenzo K. Marcovecchio
1298 * @package admin
1299 */
1300class admin_settingpage extends part_of_admin_tree {
1301
eef868d1 1302 /**
6e4dc10f 1303 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1304 */
1305 var $name;
eef868d1 1306
6e4dc10f 1307 /**
1308 * @var string The displayed name for this external page. Usually obtained through get_string().
1309 */
1310 var $visiblename;
1311 /**
1312 * @var mixed An array of admin_setting objects that are part of this setting page.
1313 */
1314 var $settings;
eef868d1 1315
6e4dc10f 1316 /**
1317 * @var string The role capability/permission a user must have to access this external page.
1318 */
2ce38b70 1319 var $req_capability;
eef868d1 1320
84c8ede0 1321 /**
1322 * @var object The context in which capability/permission should be checked, default is site context.
1323 */
1324 var $context;
1325
a8a66c96 1326 /**
1327 * @var bool hidden in admin tree block.
1328 */
1329 var $hidden;
1330
220a90c5 1331 /**
1332 * paths
1333 */
1334 var $path;
1335 var $visiblepath;
1336
1337 // see admin_externalpage
1338 function admin_settingpage($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1339 $this->settings = new object();
1340 $this->name = $name;
1341 $this->visiblename = $visiblename;
1342 if (is_array($req_capability)) {
1343 $this->req_capability = $req_capability;
6e4dc10f 1344 } else {
220a90c5 1345 $this->req_capability = array($req_capability);
6e4dc10f 1346 }
220a90c5 1347 $this->hidden = $hidden;
1348 $this->context = $context;
6e4dc10f 1349 }
eef868d1 1350
6e4dc10f 1351 // see admin_category
220a90c5 1352 function &locate($name, $findpath=false) {
1353 if ($this->name == $name) {
1354 if ($findpath) {
1355 $this->visiblepath = array($this->visiblename);
1356 $this->path = array($this->name);
1357 }
1358 return $this;
1359 } else {
1360 $return = NULL;
1361 return $return;
1362 }
6e4dc10f 1363 }
4672d955 1364
220a90c5 1365 function search($query) {
1366 $found = array();
4672d955 1367
220a90c5 1368 foreach ($this->settings as $setting) {
1369 if ($setting->is_related($query)) {
1370 $found[] = $setting;
1371 }
1372 }
1373
1374 if ($found) {
1375 $result = new object();
1376 $result->page = $this;
1377 $result->settings = $found;
1378 return array($this->name => $result);
1379 }
1380
1381 $textlib = textlib_get_instance();
1382
1383 $found = false;
1384 if (strpos(strtolower($this->name), $query) !== false) {
1385 $found = true;
1386 } else if (strpos($textlib->strtolower($this->visiblename), $query) !== false) {
1387 $found = true;
1388 }
1389 if ($found) {
1390 $result = new object();
1391 $result->page = $this;
1392 $result->settings = array();
1393 return array($this->name => $result);
38d2d43b 1394 } else {
220a90c5 1395 return array();
38d2d43b 1396 }
6e4dc10f 1397 }
eef868d1 1398
220a90c5 1399 function prune($name) {
6e4dc10f 1400 return false;
1401 }
eef868d1 1402
220a90c5 1403 /**
1404 * not the same as add for admin_category. adds an admin_setting to this admin_settingpage. settings appear (on the settingpage) in the order in which they're added
1405 * n.b. each admin_setting in an admin_settingpage must have a unique internal name
1406 * @param object $setting is the admin_setting object you want to add
1407 * @return true if successful, false if not
1408 */
1409 function add($setting) {
1410 if (!is_a($setting, 'admin_setting')) {
1411 debugging('error - not a setting instance');
1412 return false;
1413 }
1414
1415 $this->settings->{$setting->name} = $setting;
1416 return true;
1417 }
1418
6e4dc10f 1419 // see admin_externalpage
1420 function check_access() {
1421 if (!get_site()) {
1422 return true; // no access check before site is fully set up
1423 }
84c8ede0 1424 $context = empty($this->context) ? get_context_instance(CONTEXT_SYSTEM) : $this->context;
38d2d43b 1425 foreach($this->req_capability as $cap) {
1426 if (has_capability($cap, $context)) {
1427 return true;
1428 }
1429 }
1430 return false;
6e4dc10f 1431 }
eef868d1 1432
220a90c5 1433 /**
1434 * outputs this page as html in a table (suitable for inclusion in an admin pagetype)
1435 * returns a string of the html
1436 */
6e4dc10f 1437 function output_html() {
220a90c5 1438 $adminroot =& admin_get_root();
1439 $return = '<fieldset>'."\n".'<div class="clearer"><!-- --></div>'."\n";
6e4dc10f 1440 foreach($this->settings as $setting) {
220a90c5 1441 $fullname = $setting->get_full_name();
1442 if (array_key_exists($fullname, $adminroot->errors)) {
1443 $data = $adminroot->errors[$fullname]->data;
6e4dc10f 1444 } else {
220a90c5 1445 $data = $setting->get_setting();
1446 if (is_null($data)) {
1447 $data = $setting->get_defaultsetting();
1448 }
6e4dc10f 1449 }
220a90c5 1450 $return .= $setting->output_html($data);
6e4dc10f 1451 }
220a90c5 1452 $return .= '</fieldset>';
6e4dc10f 1453 return $return;
1454 }
1455
a8a66c96 1456 /**
1457 * Is this settigns page hidden in admin tree block?
1458 *
1459 * @return bool True if hidden
1460 */
1461 function is_hidden() {
1462 return $this->hidden;
1463 }
1464
6e4dc10f 1465}
1466
1467
220a90c5 1468/**
1469 * Admin settings class. Only exists on setting pages.
1470 * Read & write happens at this level; no authentication.
1471 */
6e4dc10f 1472class admin_setting {
1473
1474 var $name;
1475 var $visiblename;
1476 var $description;
1477 var $defaultsetting;
220a90c5 1478 var $updatedcallback;
1479 var $plugin; // null means main config table
6e4dc10f 1480
220a90c5 1481 /**
1482 * Constructor
1483 * @param $name string unique ascii name
1484 * @param $visiblename string localised name
1485 * @param strin $description localised long description
1486 * @param mixed $defaultsetting string or array depending on implementation
1487 */
6e4dc10f 1488 function admin_setting($name, $visiblename, $description, $defaultsetting) {
220a90c5 1489 $this->name = $name;
1490 $this->visiblename = $visiblename;
1491 $this->description = $description;
6e4dc10f 1492 $this->defaultsetting = $defaultsetting;
1493 }
eef868d1 1494
220a90c5 1495 function get_full_name() {
1496 return 's_'.$this->plugin.'_'.$this->name;
1497 }
1498
1499 function get_id() {
1500 return 'id_s_'.$this->plugin.'_'.$this->name;
1501 }
1502
1503 function config_read($name) {
1504 global $CFG;
1505 if ($this->plugin === 'backup') {
1506 require_once($CFG->dirroot.'/backup/lib.php');
1507 $backupconfig = backup_get_config();
1508 if (isset($backupconfig->$name)) {
1509 return $backupconfig->$name;
1510 } else {
1511 return NULL;
1512 }
1513
1514 } else if (!empty($this->plugin)) {
1515 $value = get_config($this->plugin, $name);
1516 return $value === false ? NULL : $value;
1517
1518 } else {
1519 if (isset($CFG->$name)) {
1520 return $CFG->$name;
1521 } else {
1522 return NULL;
1523 }
1524 }
1525 }
1526
1527 function config_write($name, $value) {
1528 global $CFG;
1529 if ($this->plugin === 'backup') {
1530 require_once($CFG->dirroot.'/backup/lib.php');
1531 return (boolean)backup_set_config($name, $value);
1532 } else {
1533 return (boolean)set_config($name, $value, $this->plugin);
1534 }
1535 }
1536
1537 /**
1538 * Returns current value of this setting
1539 * @return mixed array or string depending on instance, NULL means not set yet
1540 */
6e4dc10f 1541 function get_setting() {
220a90c5 1542 // has to be overridden
1543 return NULL;
6e4dc10f 1544 }
eef868d1 1545
220a90c5 1546 /**
1547 * Returns default setting if exists
1548 * @return mixed array or string depending on instance; NULL means no default, user must supply
1549 */
8e5da17a 1550 function get_defaultsetting() {
1551 return $this->defaultsetting;
1552 }
1553
220a90c5 1554 /**
1555 * Store new setting
1556 * @param mixed string or array, must not be NULL
1557 * @return '' if ok, string error message otherwise
1558 */
6e4dc10f 1559 function write_setting($data) {
220a90c5 1560 // should be overridden
1561 return '';
6e4dc10f 1562 }
eef868d1 1563
220a90c5 1564 /**
1565 * Return part of form with setting
1566 * @param mixed data array or string depending on setting
1567 * @return string
1568 */
1569 function output_html($data) {
1570 // should be overridden
1571 return;
1572 }
1573
1574 /**
1575 * function called if setting updated - cleanup, cache reset, etc.
1576 */
1577 function set_updatedcallback($functionname) {
1578 $this->updatedcallback = $functionname;
1579 }
1580
1581 /**
1582 * Is setting related to query text - used when searching
1583 * @param string $query
1584 * @return bool
1585 */
1586 function is_related($query) {
1587 if (strpos(strtolower($this->name), $query) !== false) {
1588 return true;
1589 }
1590 $textlib = textlib_get_instance();
1591 if (strpos($textlib->strtolower($this->visiblename), $query) !== false) {
1592 return true;
1593 }
1594 if (strpos($textlib->strtolower($this->description), $query) !== false) {
1595 return true;
1596 }
1597 return false;
6e4dc10f 1598 }
220a90c5 1599}
eef868d1 1600
220a90c5 1601/**
1602 * Dummy settings class - workaround for keeping empty categories visible
1603 */
1604class admin_setting_dummy extends admin_setting {
1605 function admin_setting_dummy() {
1606 parent::admin_setting('dummy', 'dummy', 'dummy', NULL);
1607 }
6e4dc10f 1608}
1609
220a90c5 1610/**
1611 * No setting - just heading and text.
1612 */
1613class admin_setting_heading extends admin_setting {
1614 /**
1615 * not a setting, just text
1616 * @param string $name of setting
1617 * @param string $heading heading
1618 * @param string $information text in box
1619 */
1620 function admin_setting_heading($name, $heading, $information) {
1621 parent::admin_setting($name, $heading, $information, '');
1622 }
1623
1624 function get_setting() {
1625 return true;
1626 }
1627
1628 function get_defaultsetting() {
1629 return true;
1630 }
1631
1632 function write_setting($data) {
1633 // do not write any setting
1634 return '';
1635 }
1636
1637 function output_html($data) {
1638 $return = '';
1639 if ($this->visiblename != '') {
1640 $return .= print_heading('<a name="'.$this->name.'">'.$this->visiblename.'</a>', '', 3, 'main', true);
1641 }
1642 if ($this->description != '') {
1643 $return .= print_box($this->description, 'generalbox formsettingheading', '', true);
1644 }
1645 return $return;
1646 }
1647}
6e4dc10f 1648
220a90c5 1649/**
1650 * The most flexibly setting, user is typing text
1651 */
6e4dc10f 1652class admin_setting_configtext extends admin_setting {
1653
1654 var $paramtype;
1655
220a90c5 1656 /**
1657 * config text contructor
1658 * @param string $name of setting
1659 * @param string $visiblename localised
1660 * @param string $description long localised info
1661 * @param string $defaultsetting
1662 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
1663 */
50999a0b 1664 function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW) {
6e4dc10f 1665 $this->paramtype = $paramtype;
1666 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
1667 }
1668
1669 function get_setting() {
220a90c5 1670 return $this->config_read($this->name);
6e4dc10f 1671 }
eef868d1 1672
6e4dc10f 1673 function write_setting($data) {
220a90c5 1674 // $data is a string
9e24fbd1 1675 if (!$this->validate($data)) {
220a90c5 1676 return get_string('validateerror', 'admin');
c235598d 1677 }
220a90c5 1678 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 1679 }
1680
c235598d 1681 function validate($data) {
9e24fbd1 1682 if (is_string($this->paramtype)) {
1683 return preg_match($this->paramtype, $data);
1684 } else if ($this->paramtype === PARAM_RAW) {
1685 return true;
1686 } else {
1687 $cleaned = clean_param($data, $this->paramtype);
1688 return ("$data" == "$cleaned"); // implicit conversion to string is needed to do exact comparison
1689 }
c235598d 1690 }
1691
220a90c5 1692 function output_html($data) {
1693 $default = $this->get_defaultsetting();
1694
1695 if (!is_null($default)) {
1696 if ($default === '') {
1697 $default = get_string('emptysettingvalue', 'admin');
1698 }
1699 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', s($default)).'</span>';
1700 } else {
1701 $defaultinfo = '';
1702 }
1703
1704 if ($this->paramtype === PARAM_INT) {
1705 $paramclass = 'class="number"';
c8218a42 1706 } else {
220a90c5 1707 $paramclass = '';
c8218a42 1708 }
220a90c5 1709
1710 return format_admin_setting($this, $this->visiblename,
1711 '<div class="form-text">'
1712 .'<input type="text" '.$paramclass.' id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'
1713 .$defaultinfo.'</div>',
6153cf58 1714 $this->description);
6e4dc10f 1715 }
6e4dc10f 1716}
1717
220a90c5 1718/**
1719 * General text area without html editor.
1720 */
1721class admin_setting_configtextarea extends admin_setting_configtext {
1722 var $rows;
1723 var $cols;
eba8cd63 1724
28764710 1725 function admin_setting_configtextarea($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
220a90c5 1726 $this->rows = $rows;
1727 $this->cols = $cols;
eba8cd63 1728 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype);
1729 }
1730
220a90c5 1731 function output_html($data) {
1732 $default = $this->get_defaultsetting();
1733
1734 if (!is_null($default)) {
1735 if ($default === '') {
1736 $default = get_string('emptysettingvalue', 'admin');
1737 }
1738 $defaultinfo = '<div class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', '<br />'.format_text($default, FORMAT_PLAIN)).'</div>';
eba8cd63 1739 } else {
220a90c5 1740 $defaultinfo = '';
eba8cd63 1741 }
220a90c5 1742
1743 return format_admin_setting($this, $this->visiblename,
1744 '<div class="form-textarea" ><textarea rows="'.$this->rows.'" cols="'.$this->cols.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'">'.s($data).'</textarea>'.$defaultinfo.'</div>',
1745 $this->description);
1746 }
1747}
1748
1749/**
1750 * Password field, allows unmasking of password
1751 */
1752class admin_setting_configpasswordunmask extends admin_setting_configtext {
1753 /**
1754 * Constructor
1755 * @param string $name of setting
1756 * @param string $visiblename localised
1757 * @param string $description long localised info
1758 * @param string $defaultsetting default password
1759 */
1760 function admin_setting_configpasswordunmask($name, $visiblename, $description, $defaultsetting) {
1761 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, PARAM_RAW);
1762 }
1763
1764 function output_html($data) {
1765 $id = $this->get_id();
1766 $unmask = get_string('unmaskpassword', 'form');
1767 $unmaskjs = '<script type="text/javascript">
eba8cd63 1768//<![CDATA[
220a90c5 1769document.write(\'<span class="unmask"><input id="'.$id.'unmask" value="1" type="checkbox" onclick="unmaskPassword(\\\''.$id.'\\\')"/><label for="'.$id.'unmask">'.addslashes_js($unmask).'<\/label><\/span>\');
eba8cd63 1770//]]>
1771</script>';
220a90c5 1772 return format_admin_setting($this, $this->visiblename,
1773 '<div class="form-password"><input type="password" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$unmaskjs.'</div>',
1774 $this->description);
1775 }
1776}
1777
1778/**
1779 * Path to executable file
1780 */
1781class admin_setting_configexecutable extends admin_setting_configtext {
1782 /**
1783 * Constructor
1784 * @param string $name of setting
1785 * @param string $visiblename localised
1786 * @param string $description long localised info
1787 * @param string $defautpath default path
1788 */
1789 function admin_setting_configexecutable($name, $visiblename, $description, $defaultpath) {
1790 parent::admin_setting_configtext($name, $visiblename, $description, $defaultpath, PARAM_RAW);
1791 }
1792
1793 function output_html($data) {
1794 $default = $this->get_defaultsetting();
1795
1796 if (!is_null($default)) {
1797 if ($default === '') {
1798 $default = get_string('emptysettingvalue', 'admin');
1799 }
1800 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', s($default)).'</span>';
1801 } else {
1802 $defaultinfo = '';
1803 }
1804
1805 if ($data) {
1806 if (file_exists($data) and is_executable($data)) {
1807 $executable = '<span class="pathok">&#x2714;</span>';
1808 } else {
1809 $executable = '<span class="patherror">&#x2718;</span>';
1810 }
1811 } else {
1812 $executable = '';
1813 }
1814
1815 return format_admin_setting($this, $this->visiblename,
1816 '<div class="form-executable">'
1817 .'<input type="text" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable
1818 .$defaultinfo.'</div>',
eba8cd63 1819 $this->description);
1820 }
220a90c5 1821}
1822
1823/**
1824 * Path to directory
1825 */
1826class admin_setting_configdirectory extends admin_setting_configtext {
1827 /**
1828 * Constructor
1829 * @param string $name of setting
1830 * @param string $visiblename localised
1831 * @param string $description long localised info
1832 * @param string $defaultdirectory default directory location
1833 */
1834 function admin_setting_configdirectory($name, $visiblename, $description, $defaultdirectory) {
1835 parent::admin_setting_configtext($name, $visiblename, $description, $defaultdirectory, PARAM_RAW);
1836 }
1837
1838 function output_html($data) {
1839 $default = $this->get_defaultsetting();
1840
1841 if (!is_null($default)) {
1842 if ($default === '') {
1843 $default = get_string('emptysettingvalue', 'admin');
1844 }
1845 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', s($default)).'</span>';
1846 } else {
1847 $defaultinfo = '';
1848 }
1849
1850 if ($data) {
1851 if (file_exists($data) and is_dir($data)) {
1852 $executable = '<span class="pathok">&#x2714;</span>';
1853 } else {
1854 $executable = '<span class="patherror">&#x2718;</span>';
1855 }
1856 } else {
1857 $executable = '';
1858 }
9ba38673 1859
220a90c5 1860 return format_admin_setting($this, $this->visiblename,
1861 '<div class="form-directory">'
1862 .'<input type="text" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable
1863 .$defaultinfo.'</div>',
1864 $this->description);
1865 }
eba8cd63 1866}
1867
220a90c5 1868/**
1869 * Checkbox
1870 */
6e4dc10f 1871class admin_setting_configcheckbox extends admin_setting {
220a90c5 1872 var $yes;
1873 var $no;
6e4dc10f 1874
220a90c5 1875 /**
1876 * Constructor
1877 * @param string $name of setting
1878 * @param string $visiblename localised
1879 * @param string $description long localised info
1880 * @param string $defaultsetting
1881 * @param string $yes value used when checked
1882 * @param string $no value used when not checked
1883 */
1884 function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
6e4dc10f 1885 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
220a90c5 1886 $this->yes = (string)$yes;
1887 $this->no = (string)$no;
6e4dc10f 1888 }
1889
1890 function get_setting() {
220a90c5 1891 return $this->config_read($this->name);
6e4dc10f 1892 }
eef868d1 1893
6e4dc10f 1894 function write_setting($data) {
220a90c5 1895 if ((string)$data === $this->yes) { // convert to strings before comparison
1896 $data = $this->yes;
6e4dc10f 1897 } else {
220a90c5 1898 $data = $this->no;
6e4dc10f 1899 }
220a90c5 1900 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 1901 }
1902
220a90c5 1903 function output_html($data) {
1904 $default = $this->get_defaultsetting();
1905
1906 if (!is_null($default)) {
1907 if ((string)$default === $this->yes) {
1908 $str = get_string('checkboxyes', 'admin');
1909 } else {
1910 $str = get_string('checkboxno', 'admin');
1911 }
1912 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', $str).'</span>';
c8218a42 1913 } else {
220a90c5 1914 $defaultinfo = '';
c8218a42 1915 }
220a90c5 1916
1917 if ((string)$data === $this->yes) { // convert to strings before comparison
1918 $checked = 'checked="checked"';
1919 } else {
1920 $checked = '';
1921 }
1922
1923 return format_admin_setting($this, $this->visiblename,
1924 '<div class="form-checkbox" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> '
1925 .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' />'
1926 .$defaultinfo.'</div>',
6153cf58 1927 $this->description);
6e4dc10f 1928 }
6e4dc10f 1929}
1930
220a90c5 1931/**
1932 * Multiple checkboxes, each represents different value, stored in csv format
1933 */
1934class admin_setting_configmulticheckbox extends admin_setting {
6e4dc10f 1935 var $choices;
eef868d1 1936
220a90c5 1937 /**
1938 * Constructor
1939 * @param string $name of setting
1940 * @param string $visiblename localised
1941 * @param string $description long localised info
1942 * @param array $defaultsetting array of selected
1943 * @param array $choices array of $value=>$label for each checkbox
1944 */
1945 function admin_setting_configmulticheckbox($name, $visiblename, $description, $defaultsetting, $choices) {
6e4dc10f 1946 $this->choices = $choices;
1947 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
1948 }
1949
0a784551 1950 /**
1951 * This function may be used in ancestors for lazy loading of choices
220a90c5 1952 * @return true if loaded, false if error
0a784551 1953 */
1954 function load_choices() {
1955 /*
220a90c5 1956 if (is_array($this->choices)) {
1957 return true;
0a784551 1958 }
1959 .... load choices here
1960 */
220a90c5 1961 return true;
1962 }
1963
1964 /**
1965 * Is setting related to query text - used when searching
1966 * @param string $query
1967 * @return bool
1968 */
1969 function is_related($query) {
1970 if (!$this->load_choices() or empty($this->choices)) {
1971 return false;
1972 }
1973 if (parent::is_related($query)) {
1974 return true;
1975 }
1976
1977 $textlib = textlib_get_instance();
1978 foreach ($this->choices as $desc) {
1979 if (strpos($textlib->strtolower($desc), $query) !== false) {
1980 return true;
1981 }
1982 }
1983 return false;
0a784551 1984 }
1985
6e4dc10f 1986 function get_setting() {
220a90c5 1987 $result = $this->config_read($this->name);
1988 if (is_null($result)) {
1989 return NULL;
1990 }
1991 if ($result === '') {
1992 return array();
1993 }
1994 return explode(',', $result);
6e4dc10f 1995 }
eef868d1 1996
6e4dc10f 1997 function write_setting($data) {
220a90c5 1998 if (!is_array($data)) {
1999 return ''; // ignore it
2000 }
2001 if (!$this->load_choices() or empty($this->choices)) {
2002 return '';
2003 }
2004 unset($data['xxxxx']);
2005 $result = array();
2006 foreach ($data as $key => $value) {
2007 if ($value and array_key_exists($key, $this->choices)) {
2008 $result[] = $key;
2009 }
2010 }
2011 return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin');
6e4dc10f 2012 }
eef868d1 2013
220a90c5 2014 function output_html($data) {
2015 if (!$this->load_choices() or empty($this->choices)) {
2016 return '';
2017 }
2018 $default = $this->get_defaultsetting();
2019 if (is_null($default)) {
2020 $default = array();
2021 }
2022 if (is_null($data)) {
2023 foreach ($default as $key=>$value) {
2024 if ($value) {
2025 $current[] = $value;
2026 }
2027 }
2028 }
2029
2030 $options = array();
2031 $defaults = array();
2032 foreach($this->choices as $key=>$description) {
2033 if (in_array($key, $data)) {
2034 $checked = 'checked="checked"';
2035 } else {
2036 $checked = '';
2037 }
2038 if (!empty($default[$key])) {
2039 $defaults[] = $description;
2040 }
2041
2042 $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
2043 .'<label for="'.$this->get_id().'_'.$key.'">'.$description.'</label>';
2044 }
2045
2046 if (!empty($defaults)) {
2047 $defaultinfo = '<div class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', implode(', ', $defaults)).'</div>';
c8218a42 2048 } else {
220a90c5 2049 $defaultinfo = '';
c8218a42 2050 }
220a90c5 2051
2052 $return = '<div class="form-multicheckbox">';
2053 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2054 if ($options) {
2055 $return .= '<ul>';
2056 foreach ($options as $option) {
2057 $return .= '<li>'.$option.'</li>';
2058 }
2059 $return .= '</ul>';
6e4dc10f 2060 }
220a90c5 2061 $return .= $defaultinfo.'</div>';
6153cf58 2062
220a90c5 2063 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
6e4dc10f 2064 }
6e4dc10f 2065}
2066
220a90c5 2067/**
2068 * Multiple checkboxes 2, value stored as string 00101011
2069 */
2070class admin_setting_configmulticheckbox2 extends admin_setting_configmulticheckbox {
2071 function get_setting() {
2072 $result = $this->config_read($this->name);
2073 if (is_null($result)) {
2074 return NULL;
2075 }
2076 if (!$this->load_choices()) {
2077 return NULL;
2078 }
2079 $result = str_pad($result, count($this->choices), '0');
2080 $result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY);
2081 $setting = array();
2082 foreach ($this->choices as $key=>$unused) {
2083 $value = array_shift($result);
2084 if ($value) {
2085 $setting[] = $key;
2086 }
2087 }
2088 return $setting;
2089 }
6e4dc10f 2090
220a90c5 2091 function write_setting($data) {
2092 if (!is_array($data)) {
2093 return ''; // ignore it
2094 }
2095 if (!$this->load_choices() or empty($this->choices)) {
2096 return '';
2097 }
2098 $result = '';
2099 foreach ($this->choices as $key=>$unused) {
2100 if (!empty($data[$key])) {
2101 $result .= '1';
2102 } else {
2103 $result .= '0';
2104 }
2105 }
2106 return $this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin');
2107 }
2108}
2109
2110/**
2111 * Select one value from list
2112 */
2113class admin_setting_configselect extends admin_setting {
6e4dc10f 2114 var $choices;
6e4dc10f 2115
220a90c5 2116 /**
2117 * Constructor
2118 * @param string $name of setting
2119 * @param string $visiblename localised
2120 * @param string $description long localised info
2121 * @param string $defaultsetting
2122 * @param array $choices array of $value=>$label for each selection
2123 */
2124 function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) {
2125 $this->choices = $choices;
2126 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
2127 }
2128
2129 /**
2130 * This function may be used in ancestors for lazy loading of choices
2131 * @return true if loaded, false if error
2132 */
2133 function load_choices() {
2134 /*
2135 if (is_array($this->choices)) {
2136 return true;
6e4dc10f 2137 }
220a90c5 2138 .... load choices here
2139 */
2140 return true;
6e4dc10f 2141 }
2142
2143 function get_setting() {
220a90c5 2144 return $this->config_read($this->name);
6e4dc10f 2145 }
eef868d1 2146
6e4dc10f 2147 function write_setting($data) {
220a90c5 2148 if (!$this->load_choices() or empty($this->choices)) {
2149 return '';
2150 }
2151 if (!array_key_exists($data, $this->choices)) {
2152 return ''; // ignore it
2153 }
eef868d1 2154
220a90c5 2155 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2156 }
eef868d1 2157
220a90c5 2158 function output_html($data) {
2159 if (!$this->load_choices() or empty($this->choices)) {
2160 return '';
2161 }
2162 $default = $this->get_defaultsetting();
2163
2164 if (!is_null($default) and array_key_exists($default, $this->choices)) {
2165 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', s($this->choices[$default])).'</span>';
cc73de71 2166 } else {
220a90c5 2167 $defaultinfo = '';
6e4dc10f 2168 }
220a90c5 2169
9c305ba1 2170 $current = $this->get_setting();
2171 $warning = '';
2172 if (is_null($current)) {
2173 //first run
2174 } else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) {
2175 // no warning
2176 } else if (!array_key_exists($current, $this->choices)) {
2177 $warning = get_string('warningcurrentsetting', 'admin', s($current));
2178 if (!is_null($default) and $data==$current) {
2179 $data = $default; // use default instead of first value when showing the form
2180 }
2181 }
2182
220a90c5 2183 $return = '<div class="form-select"><select id="'.$this->get_id().'" name="'.$this->get_full_name().'">';
6e4dc10f 2184 foreach ($this->choices as $key => $value) {
220a90c5 2185 // the string cast is needed because key may be integer - 0 is equal to most strings!
2186 $return .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>';
eef868d1 2187 }
220a90c5 2188 $return .= '</select>'.$defaultinfo.'</div>';
2189
9c305ba1 2190 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning);
6e4dc10f 2191 }
2192
2193}
2194
220a90c5 2195/**
2196 * Select multiple items from list
2197 */
6e4dc10f 2198class admin_setting_configmultiselect extends admin_setting_configselect {
220a90c5 2199 /**
2200 * Constructor
2201 * @param string $name of setting
2202 * @param string $visiblename localised
2203 * @param string $description long localised info
2204 * @param array $defaultsetting array of selected items
2205 * @param array $choices array of $value=>$label for each list item
2206 */
6e4dc10f 2207 function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) {
2208 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices);
2209 }
2210
2211 function get_setting() {
220a90c5 2212 $result = $this->config_read($this->name);
2213 if (is_null($result)) {
d7933a55 2214 return NULL;
2215 }
220a90c5 2216 if ($result === '') {
2217 return array();
2218 }
2219 return explode(',', $result);
6e4dc10f 2220 }
eef868d1 2221
6e4dc10f 2222 function write_setting($data) {
220a90c5 2223 if (!is_array($data)) {
2224 return ''; //ignore it
2225 }
2226 if (!$this->load_choices() or empty($this->choices)) {
2227 return '';
2228 }
2229
a7ad48fd 2230 unset($data['xxxxx']);
2231
220a90c5 2232 $save = array();
2233 foreach ($data as $value) {
2234 if (!array_key_exists($value, $this->choices)) {
2235 continue; // ignore it
2236 }
2237 $save[] = $value;
2238 }
2239
2240 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2241 }
2242
2243 /**
2244 * Is setting related to query text - used when searching
2245 * @param string $query
2246 * @return bool
2247 */
2248 function is_related($query) {
2249 if (!$this->load_choices() or empty($this->choices)) {
2250 return false;
2251 }
2252 if (parent::is_related($query)) {
2253 return true;
2254 }
2255
2256 $textlib = textlib_get_instance();
2257 foreach ($this->choices as $desc) {
2258 if (strpos($textlib->strtolower($desc), $query) !== false) {
2259 return true;
2260 }
2261 }
2262 return false;
2263 }
2264
2265 function output_html($data) {
2266 if (!$this->load_choices() or empty($this->choices)) {
2267 return '';
2268 }
2269 $choices = $this->choices;
2270 $default = $this->get_defaultsetting();
2271 if (is_null($default)) {
2272 $default = array();
2273 }
2274 if (is_null($data)) {
d7933a55 2275 $data = array();
2276 }
220a90c5 2277
2278 $defaults = array();
a7ad48fd 2279 $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2280 $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="10" multiple="multiple">';
220a90c5 2281 foreach ($this->choices as $key => $description) {
2282 if (in_array($key, $data)) {
2283 $selected = 'selected="selected"';
2284 } else {
2285 $selected = '';
2286 }
2287 if (in_array($key, $default)) {
2288 $defaults[] = $description;
6e4dc10f 2289 }
220a90c5 2290
2291 $return .= '<option value="'.s($key).'" '.$selected.'>'.$description.'</option>';
2292 }
2293
2294 if (!empty($defaults)) {
2295 $defaultinfo = '<div class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', implode(', ', $defaults)).'</div>';
2296 } else {
2297 $defaultinfo = '';
6e4dc10f 2298 }
eef868d1 2299
220a90c5 2300 $return .= '</select>'.$defaultinfo.'</div>';
2301 return format_admin_setting($this, $this->visiblename, $return, $this->description);
6e4dc10f 2302 }
220a90c5 2303}
eef868d1 2304
220a90c5 2305/**
2306 * Time selector
2307 * this is a liiitle bit messy. we're using two selects, but we're returning
2308 * them as an array named after $name (so we only use $name2 internally for the setting)
2309 */
2310class admin_setting_configtime extends admin_setting {
2311 var $name2;
2312
2313 /**
2314 * Constructor
2315 * @param string $hoursname setting for hours
2316 * @param string $minutesname setting for hours
2317 * @param string $visiblename localised
2318 * @param string $description long localised info
2319 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
2320 */
2321 function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
2322 $this->name2 = $minutesname;
2323 parent::admin_setting($hoursname, $visiblename, $description, $defaultsetting);
2324 }
2325
2326 function get_setting() {
2327 $result1 = $this->config_read($this->name);
2328 $result2 = $this->config_read($this->name2);
2329 if (is_null($result1) or is_null($result2)) {
2330 return NULL;
2331 }
2332
2333 return array('h' => $result1, 'm' => $result2);
2334 }
2335
2336 function write_setting($data) {
2337 if (!is_array($data)) {
2338 return '';
2339 }
2340
2341 $result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']);
2342 return ($result ? '' : get_string('errorsetting', 'admin'));
2343 }
2344
2345 function output_html($data) {
2346 $default = $this->get_defaultsetting();
2347
2348 if (is_array($default)) {
2349 $defaultinfo = '<span class="defaultinfo">'.get_string('defaultsettinginfo', 'admin', $default['h'].':'.$default['m']).'</span>';
cc73de71 2350 } else {
220a90c5 2351 $defaultinfo = '';
6e4dc10f 2352 }
220a90c5 2353
2354 $return = '<div class="form-time">'.
2355 '<select id="'.$this->get_id().'h" name="'.$this->get_full_name().'[h]">';
2356 for ($i = 0; $i < 24; $i++) {
2357 $return .= '<option value="'.$i.'"'.($i == $data['h'] ? ' selected="selected"' : '').'>'.$i.'</option>';
6e4dc10f 2358 }
220a90c5 2359 $return .= '</select>:<select id="'.$this->get_id().'m" name="'.$this->get_full_name().'[m]">';
2360 for ($i = 0; $i < 60; $i += 5) {
2361 $return .= '<option value="'.$i.'"'.($i == $data['m'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2362 }
2363 $return .= '</select>'.$defaultinfo.'</div>';
2364 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
6e4dc10f 2365 }
2366
2367}
2368
220a90c5 2369/**
2370 * Special checkbox for calendar - resets SESSION vars.
2371 */
6e4dc10f 2372class admin_setting_special_adminseesall extends admin_setting_configcheckbox {
6e4dc10f 2373 function admin_setting_special_adminseesall() {
220a90c5 2374 parent::admin_setting_configcheckbox('calendar_adminseesall', get_string('adminseesall', 'admin'),
2375 get_string('helpadminseesall', 'admin'), '0');
6e4dc10f 2376 }
2377
2378 function write_setting($data) {
2379 global $SESSION;
2380 unset($SESSION->cal_courses_shown);
220a90c5 2381 return parent::write_setting($data);
6e4dc10f 2382 }
2383}
2384
220a90c5 2385/**
2386 * Special select for frontpage - stores data in course table
2387 */
6e4dc10f 2388class admin_setting_sitesetselect extends admin_setting_configselect {
6e4dc10f 2389 function get_setting() {
2390 $site = get_site();
220a90c5 2391 return $site->{$this->name};
6e4dc10f 2392 }
eef868d1 2393
6e4dc10f 2394 function write_setting($data) {
2395 if (!in_array($data, array_keys($this->choices))) {
220a90c5 2396 return get_string('errorsetting', 'admin');
6e4dc10f 2397 }
2398 $record = new stdClass();
220a90c5 2399 $record->id = SITEID;
2400 $temp = $this->name;
2401 $record->$temp = $data;
6e4dc10f 2402 $record->timemodified = time();
220a90c5 2403 return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2404 }
eef868d1 2405
6e4dc10f 2406}
2407
220a90c5 2408/**
2409 * Special select - lists on the frontpage - hacky
2410 */
2411class admin_setting_courselist_frontpage extends admin_setting {
2412 var $choices;
6e4dc10f 2413
e0f6e995 2414 function admin_setting_courselist_frontpage($loggedin) {
6e4dc10f 2415 global $CFG;
220a90c5 2416 require_once($CFG->dirroot.'/course/lib.php');
2417 $name = 'frontpage'.($loggedin ? 'loggedin' : '');
2418 $visiblename = get_string('frontpage'.($loggedin ? 'loggedin' : ''),'admin');
2419 $description = get_string('configfrontpage'.($loggedin ? 'loggedin' : ''),'admin');
2420 $defaults = array(FRONTPAGECOURSELIST);
2421 parent::admin_setting($name, $visiblename, $description, $defaults);
6e4dc10f 2422 }
eef868d1 2423
220a90c5 2424 function load_choices() {
2425 if (is_array($this->choices)) {
2426 return true;
2427 }
2428 $this->choices = array(FRONTPAGENEWS => get_string('frontpagenews'),
2429 FRONTPAGECOURSELIST => get_string('frontpagecourselist'),
2430 FRONTPAGECATEGORYNAMES => get_string('frontpagecategorynames'),
2431 FRONTPAGECATEGORYCOMBO => get_string('frontpagecategorycombo'),
2432 'none' => get_string('none'));
2433 if ($this->name == 'frontpage' and count_records('course') > FRONTPAGECOURSELIMIT) {
2434 unset($this->choices[FRONTPAGECOURSELIST]);
2435 }
2436 return true;
2437 }
6e4dc10f 2438 function get_setting() {
220a90c5 2439 $result = $this->config_read($this->name);
2440 if (is_null($result)) {
2441 return NULL;
2442 }
2443 if ($result === '') {
2444 return array();
2445 }
2446 return explode(',', $result);
6e4dc10f 2447 }
eef868d1 2448
6e4dc10f 2449 function write_setting($data) {
220a90c5 2450 if (!is_array($data)) {
2451 return '';
6e4dc10f 2452 }
220a90c5 2453 $this->load_choices();
2454 $save = array();
6e4dc10f 2455 foreach($data as $datum) {
220a90c5 2456 if ($datum == 'none' or !array_key_exists($datum, $this->choices)) {
2457 continue;
6e4dc10f 2458 }
220a90c5 2459 $save[$datum] = $datum; // no duplicates
6e4dc10f 2460 }
220a90c5 2461 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2462 }
eef868d1 2463
220a90c5 2464 function output_html($data) {
2465 $this->load_choices();
2466 $currentsetting = array();
2467 foreach ($data as $key) {
2468 if ($key != 'none' and array_key_exists($key, $this->choices)) {
2469 $currentsetting[] = $key; // already selected first
6e4dc10f 2470 }
2471 }
220a90c5 2472
0a7e84c3 2473 $return = '<div class="form-group">';
6e4dc10f 2474 for ($i = 0; $i < count($this->choices) - 1; $i++) {
220a90c5 2475 if (!array_key_exists($i, $currentsetting)) {
2476 $currentsetting[$i] = 'none'; //none
2477 }
2478 $return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
6e4dc10f 2479 foreach ($this->choices as $key => $value) {
220a90c5 2480 $return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ? ' selected="selected"' : '').'>'.$value.'</option>';
6e4dc10f 2481 }
2482 $return .= '</select>';
2483 if ($i !== count($this->choices) - 2) {
975211bb 2484 $return .= '<br />';
6e4dc10f 2485 }
2486 }
0a7e84c3 2487 $return .= '</div>';
2488
220a90c5 2489 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
6e4dc10f 2490 }
2491}
2492
220a90c5 2493/**
2494 * Special checkbox for frontpage - stores data in course table
2495 */
6e4dc10f 2496class admin_setting_sitesetcheckbox extends admin_setting_configcheckbox {
6e4dc10f 2497 function get_setting() {
2498 $site = get_site();
8e5da17a 2499 return $site->{$this->name};
6e4dc10f 2500 }
eef868d1 2501
6e4dc10f 2502 function write_setting($data) {
220a90c5 2503 $record = new object();
2504 $record->id = SITEID;
2505 $record->{$this->name} = ($data == '1' ? 1 : 0);
2506 $record->timemodified = time();
2507 return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2508 }
6e4dc10f 2509}
2510
220a90c5 2511/**
2512 * Special text for frontpage - stores data in course table.
2513 * Empty string means not set here. Manual setting is required.
2514 */
6e4dc10f 2515class admin_setting_sitesettext extends admin_setting_configtext {
6e4dc10f 2516 function get_setting() {
2517 $site = get_site();
8e5da17a 2518 return $site->{$this->name} != '' ? $site->{$this->name} : NULL;
6e4dc10f 2519 }
90cfbd0a 2520
b89639f9 2521 function validate($data) {
b0abd282 2522 $cleaned = stripslashes(clean_param($data, PARAM_MULTILANG));
b89639f9 2523 if ($cleaned == '') {
2524 return false; // can not be empty
2525 }
220a90c5 2526 return ($data == $cleaned);
b89639f9 2527 }
2528
6e4dc10f 2529 function write_setting($data) {
b89639f9 2530 $data = trim($data);
9e24fbd1 2531 if (!$this->validate($data)) {
220a90c5 2532 return get_string('required');
90cfbd0a 2533 }
eef868d1 2534
220a90c5 2535 $record = new object();
2536 $record->id = SITEID;
87fa8a17 2537 $record->{$this->name} = addslashes($data);
220a90c5 2538 $record->timemodified = time();
2539 return (update_record('course', $record) ? '' : get_string('dbupdatefailed', 'error'));
6e4dc10f 2540 }
6e4dc10f 2541}
2542
220a90c5 2543/**
2544 * Special text editor for site description.
2545 */
6e4dc10f 2546class admin_setting_special_frontpagedesc extends admin_setting {
6e4dc10f 2547 function admin_setting_special_frontpagedesc() {
220a90c5 2548 parent::admin_setting('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
6e4dc10f 2549 }
eef868d1 2550
6e4dc10f 2551 function get_setting() {
6e4dc10f 2552 $site = get_site();
c626c2f4 2553 return $site->{$this->name};
2554 }
eef868d1 2555
6e4dc10f 2556 function write_setting($data) {
c626c2f4 2557 $record = new object();
220a90c5 2558 $record->id = SITEID;
c626c2f4 2559 $record->{$this->name} = addslashes($data);
2560 $record->timemodified = time();
220a90c5 2561 return(update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2562 }
2563
220a90c5 2564 function output_html($data) {
2565 global $CFG;
6e4dc10f 2566
220a90c5 2567 $CFG->adminusehtmleditor = can_use_html_editor();
2568 $return = '<div class="form-htmlarea">'.print_textarea($CFG->adminusehtmleditor, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true).'</div>';
2569
2570 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
2571 }
2572}
6e4dc10f 2573
2574class admin_setting_special_editorfontlist extends admin_setting {
2575
2576 var $items;
2577
2578 function admin_setting_special_editorfontlist() {
2579 global $CFG;
2580 $name = 'editorfontlist';
2581 $visiblename = get_string('editorfontlist', 'admin');
2582 $description = get_string('configeditorfontlist', 'admin');
6e4dc10f 2583 $defaults = array('k0' => 'Trebuchet',
2584 'v0' => 'Trebuchet MS,Verdana,Arial,Helvetica,sans-serif',
2585 'k1' => 'Arial',
2586 'v1' => 'arial,helvetica,sans-serif',
2587 'k2' => 'Courier New',
2588 'v2' => 'courier new,courier,monospace',
2589 'k3' => 'Georgia',
2590 'v3' => 'georgia,times new roman,times,serif',
2591 'k4' => 'Tahoma',
2592 'v4' => 'tahoma,arial,helvetica,sans-serif',
2593 'k5' => 'Times New Roman',
2594 'v5' => 'times new roman,times,serif',
2595 'k6' => 'Verdana',
2596 'v6' => 'verdana,arial,helvetica,sans-serif',
2597 'k7' => 'Impact',
2598 'v7' => 'impact',
2599 'k8' => 'Wingdings',
2600 'v8' => 'wingdings');
2601 parent::admin_setting($name, $visiblename, $description, $defaults);
2602 }
eef868d1 2603
6e4dc10f 2604 function get_setting() {
cc73de71 2605 global $CFG;
220a90c5 2606 $result = $this->config_read($this->name);
2607 if (is_null($result)) {
cc73de71 2608 return NULL;
2609 }
220a90c5 2610 $i = 0;
2611 $currentsetting = array();
2612 $items = explode(';', $result);
2613 foreach ($items as $item) {
2614 $item = explode(':', $item);
2615 $currentsetting['k'.$i] = $item[0];
2616 $currentsetting['v'.$i] = $item[1];
2617 $i++;
2618 }
2619 return $currentsetting;
6e4dc10f 2620 }
eef868d1 2621
6e4dc10f 2622 function write_setting($data) {
eef868d1 2623
6e4dc10f 2624 // there miiight be an easier way to do this :)
2625 // if this is changed, make sure the $defaults array above is modified so that this
2626 // function processes it correctly
eef868d1 2627
6e4dc10f 2628 $keys = array();
2629 $values = array();
eef868d1 2630
6e4dc10f 2631 foreach ($data as $key => $value) {
2632 if (substr($key,0,1) == 'k') {
2633 $keys[substr($key,1)] = $value;
2634 } elseif (substr($key,0,1) == 'v') {
2635 $values[substr($key,1)] = $value;
2636 }
2637 }
eef868d1 2638
220a90c5 2639 $result = array();
6e4dc10f 2640 for ($i = 0; $i < count($keys); $i++) {
2641 if (($keys[$i] !== '') && ($values[$i] !== '')) {
220a90c5 2642 $result[] = clean_param($keys[$i],PARAM_NOTAGS).':'.clean_param($values[$i], PARAM_NOTAGS);
6e4dc10f 2643 }
2644 }
eef868d1 2645
220a90c5 2646 return ($this->config_write($this->name, implode(';', $result)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2647 }
eef868d1 2648
220a90c5 2649 function output_html($data) {
2650 $fullname = $this->get_full_name();
1beed35f 2651 $return = '<div class="form-group">';
220a90c5 2652 for ($i = 0; $i < count($data) / 2; $i++) {
2653 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
6e4dc10f 2654 $return .= '&nbsp;&nbsp;';
220a90c5 2655 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
6e4dc10f 2656 }
220a90c5 2657 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="" />';
6e4dc10f 2658 $return .= '&nbsp;&nbsp;';
220a90c5 2659 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2660 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
6e4dc10f 2661 $return .= '&nbsp;&nbsp;';
220a90c5 2662 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
1beed35f 2663 $return .= '</div>';
6153cf58 2664
220a90c5 2665 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
6e4dc10f 2666 }
eef868d1 2667
6e4dc10f 2668}
2669
93c61c18 2670class admin_setting_emoticons extends admin_setting {
2671
2672 var $items;
2673
2674 function admin_setting_emoticons() {
2675 global $CFG;
2676 $name = 'emoticons';
2677 $visiblename = get_string('emoticons', 'admin');
2678 $description = get_string('configemoticons', 'admin');
2679 $defaults = array('k0' => ':-)',
2680 'v0' => 'smiley',
2681 'k1' => ':)',
2682 'v1' => 'smiley',
2683 'k2' => ':-D',
2684 'v2' => 'biggrin',
2685 'k3' => ';-)',
2686 'v3' => 'wink',
2687 'k4' => ':-/',
2688 'v4' => 'mixed',
2689 'k5' => 'V-.',
2690 'v5' => 'thoughtful',
2691 'k6' => ':-P',
2692 'v6' => 'tongueout',
2693 'k7' => 'B-)',
2694 'v7' => 'cool',
2695 'k8' => '^-)',
2696 'v8' => 'approve',
2697 'k9' => '8-)',
2698 'v9' => 'wideeyes',
2699 'k10' => ':o)',
2700 'v10' => 'clown',
2701 'k11' => ':-(',
2702 'v11' => 'sad',
2703 'k12' => ':(',
2704 'v12' => 'sad',
2705 'k13' => '8-.',
2706 'v13' => 'shy',
2707 'k14' => ':-I',
2708 'v14' => 'blush',
2709 'k15' => ':-X',
2710 'v15' => 'kiss',
2711 'k16' => '8-o',
2712 'v16' => 'surprise',
2713 'k17' => 'P-|',
2714 'v17' => 'blackeye',
2715 'k18' => '8-[',
2716 'v18' => 'angry',
2717 'k19' => 'xx-P',
2718 'v19' => 'dead',
2719 'k20' => '|-.',
2720 'v20' => 'sleepy',
2721 'k21' => '}-]',
2722 'v21' => 'evil',
2723 'k22' => '(h)',
2724 'v22' => 'heart',
2725 'k23' => '(heart)',
2726 'v23' => 'heart',
2727 'k24' => '(y)',
2728 'v24' => 'yes',
2729 'k25' => '(n)',
2730 'v25' => 'no',
2731 'k26' => '(martin)',
2732 'v26' => 'martin',
2733 'k27' => '( )',
2734 'v27' => 'egg');
2735 parent::admin_setting($name, $visiblename, $description, $defaults);
2736 }
2737
2738 function get_setting() {
2739 global $CFG;
220a90c5 2740 $result = $this->config_read($this->name);
2741 if (is_null($result)) {
93c61c18 2742 return NULL;
2743 }
220a90c5 2744 $i = 0;
2745 $currentsetting = array();
2746 $items = explode('{;}', $result);
2747 foreach ($items as $item) {
2748 $item = explode('{:}', $item);
2749 $currentsetting['k'.$i] = $item[0];
2750 $currentsetting['v'.$i] = $item[1];
2751 $i++;
2752 }
2753 return $currentsetting;
93c61c18 2754 }
2755
2756 function write_setting($data) {
2757
2758 // there miiight be an easier way to do this :)
2759 // if this is changed, make sure the $defaults array above is modified so that this
2760 // function processes it correctly
2761
2762 $keys = array();
2763 $values = array();
2764
2765 foreach ($data as $key => $value) {
2766 if (substr($key,0,1) == 'k') {
2767 $keys[substr($key,1)] = $value;
2768 } elseif (substr($key,0,1) == 'v') {
2769 $values[substr($key,1)] = $value;
2770 }
2771 }
2772
220a90c5 2773 $result = array();
93c61c18 2774 for ($i = 0; $i < count($keys); $i++) {
2775 if (($keys[$i] !== '') && ($values[$i] !== '')) {
220a90c5 2776 $result[] = clean_param($keys[$i],PARAM_NOTAGS).'{:}'.clean_param($values[$i], PARAM_NOTAGS);
93c61c18 2777 }
2778 }
2779
220a90c5 2780 return ($this->config_write($this->name, implode('{;}', $result)) ? '' : get_string('errorsetting', 'admin').$this->visiblename.'<br />');
93c61c18 2781 }
2782
220a90c5 2783 function output_html($data) {
2784 $fullname = $this->get_full_name();
93c61c18 2785 $return = '<div class="form-group">';
220a90c5 2786 for ($i = 0; $i < count($data) / 2; $i++) {
2787 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
93c61c18 2788 $return .= '&nbsp;&nbsp;';
220a90c5 2789 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
93c61c18 2790 }
220a90c5 2791 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="" />';
93c61c18 2792 $return .= '&nbsp;&nbsp;';
220a90c5 2793 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2794 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
93c61c18 2795 $return .= '&nbsp;&nbsp;';
220a90c5 2796 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
93c61c18 2797 $return .= '</div>';
2798
220a90c5 2799 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
93c61c18 2800 }
2801
2802}
2803
220a90c5 2804/**
2805 * Setting for spellchecker language selection.
2806 */
6e4dc10f 2807class admin_setting_special_editordictionary extends admin_setting_configselect {
2808
2809 function admin_setting_special_editordictionary() {
2810 $name = 'editordictionary';
2811 $visiblename = get_string('editordictionary','admin');
2812 $description = get_string('configeditordictionary', 'admin');
220a90c5 2813 parent::admin_setting_configselect($name, $visiblename, $description, '', NULL);
6e4dc10f 2814 }
2815
220a90c5 2816 function load_choices() {
2817 // function borrowed from the old moodle/admin/editor.php, slightly modified
2818 // Get all installed dictionaries in the system
2819 if (is_array($this->choices)) {
2820 return true;
2821 }
2822
2823 $this->choices = array();
6e4dc10f 2824
2825 global $CFG;
eef868d1 2826
6e4dc10f 2827 clearstatcache();
2828
2829 // If aspellpath isn't set don't even bother ;-)
2830 if (empty($CFG->aspellpath)) {
220a90c5 2831 $this->choices['error'] = 'Empty aspell path!';
2832 return true;
6e4dc10f 2833 }
2834
2835 // Do we have access to popen function?
2836 if (!function_exists('popen')) {
220a90c5 2837 $this->choices['error'] = 'Popen function disabled!';
2838 return true;
6e4dc10f 2839 }
eef868d1 2840
6e4dc10f 2841 $cmd = $CFG->aspellpath;
2842 $output = '';
2843 $dictionaries = array();
6e4dc10f 2844
220a90c5 2845 if(!($handle = @popen(escapeshellarg($cmd).' dump dicts', 'r'))) {
2846 $this->choices['error'] = 'Couldn\'t create handle!';
6e4dc10f 2847 }
2848
2849 while(!feof($handle)) {
2850 $output .= fread($handle, 1024);
2851 }
2852 @pclose($handle);
2853
2854 $dictionaries = explode(chr(10), $output);
220a90c5 2855 foreach ($dictionaries as $dict) {
2856 if (empty($dict)) {
2857 continue;
6e4dc10f 2858 }
220a90c5 2859 $this->choices[$dict] = $dict;
6e4dc10f 2860 }
2861
220a90c5 2862 if (empty($this->choices)) {
2863 $this->choices['error'] = 'Error! Check your aspell installation!';
6e4dc10f 2864 }
220a90c5 2865 return true;
6e4dc10f 2866 }
6e4dc10f 2867}
2868
2869
2870class admin_setting_special_editorhidebuttons extends admin_setting {
6e4dc10f 2871 var $items;
2872
2873 function admin_setting_special_editorhidebuttons() {
220a90c5 2874 parent::admin_setting('editorhidebuttons', get_string('editorhidebuttons', 'admin'),
2875 get_string('confeditorhidebuttons', 'admin'), array());
6e4dc10f 2876 // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead
2877 $this->items = array('fontname' => '',
2878 'fontsize' => '',
2879 'formatblock' => '',
2880 'bold' => 'ed_format_bold.gif',
2881 'italic' => 'ed_format_italic.gif',
2882 'underline' => 'ed_format_underline.gif',
2883 'strikethrough' => 'ed_format_strike.gif',
2884 'subscript' => 'ed_format_sub.gif',
2885 'superscript' => 'ed_format_sup.gif',
2886 'copy' => 'ed_copy.gif',
2887 'cut' => 'ed_cut.gif',
2888 'paste' => 'ed_paste.gif',
2889 'clean' => 'ed_wordclean.gif',
2890 'undo' => 'ed_undo.gif',
2891 'redo' => 'ed_redo.gif',
2892 'justifyleft' => 'ed_align_left.gif',
2893 'justifycenter' => 'ed_align_center.gif',
2894 'justifyright' => 'ed_align_right.gif',
2895 'justifyfull' => 'ed_align_justify.gif',
2896 'lefttoright' => 'ed_left_to_right.gif',
2897 'righttoleft' => 'ed_right_to_left.gif',
2898 'insertorderedlist' => 'ed_list_num.gif',
2899 'insertunorderedlist' => 'ed_list_bullet.gif',
2900 'outdent' => 'ed_indent_less.gif',
2901 'indent' => 'ed_indent_more.gif',
2902 'forecolor' => 'ed_color_fg.gif',
2903 'hilitecolor' => 'ed_color_bg.gif',
2904 'inserthorizontalrule' => 'ed_hr.gif',
2905 'createanchor' => 'ed_anchor.gif',
2906 'createlink' => 'ed_link.gif',
2907 'unlink' => 'ed_unlink.gif',
2908 'insertimage' => 'ed_image.gif',
2909 'inserttable' => 'insert_table.gif',
2910 'insertsmile' => 'em.icon.smile.gif',
2911 'insertchar' => 'icon_ins_char.gif',
2912 'spellcheck' => 'spell-check.gif',
2913 'htmlmode' => 'ed_html.gif',
2914 'popupeditor' => 'fullscreen_maximize.gif',
2915 'search_replace' => 'ed_replace.gif');
2916 }
2917
2918 function get_setting() {
220a90c5 2919 $result = $this->config_read($this->name);
2920 if (is_null($result)) {
2921 return NULL;
2922 }
2923 if ($result === '') {
2924 return array();
2925 }
2926 return explode(',', $result);
6e4dc10f 2927 }
2928
2929 function write_setting($data) {
220a90c5 2930 if (!is_array($data)) {
2931 return ''; // ignore it
2932 }
2933 unset($data['xxxxx']);
6e4dc10f 2934 $result = array();
220a90c5 2935
6e4dc10f 2936 foreach ($data as $key => $value) {
2937 if (!in_array($key, array_keys($this->items))) {
220a90c5 2938 return get_string('errorsetting', 'admin');
6e4dc10f 2939 }
2940 if ($value == '1') {
2941 $result[] = $key;
2942 }
2943 }
220a90c5 2944 return ($this->config_write($this->name, implode(' ', $result)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2945 }
2946
220a90c5 2947 function output_html($data) {
eef868d1 2948
6e4dc10f 2949 global $CFG;
eef868d1 2950
6e4dc10f 2951 // checkboxes with input name="$this->name[$key]" value="1"
2952 // we do 15 fields per column
eef868d1 2953
1beed35f 2954 $return = '<div class="form-group">';
2955 $return .= '<table><tr><td valign="top" align="right">';
220a90c5 2956 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
eef868d1 2957
6e4dc10f 2958 $count = 0;
eef868d1 2959
6e4dc10f 2960 foreach($this->items as $key => $value) {
8ddbd7a6 2961 if ($count % 15 == 0 and $count != 0) {
2962 $return .= '</td><td valign="top" align="right">';
6e4dc10f 2963 }
eef868d1 2964
220a90c5 2965 $return .= ($value == '' ? get_string($key,'editor') : '<img width="18" height="18" src="'.$CFG->wwwroot.'/lib/editor/htmlarea/images/'.$value.'" alt="'.get_string($key,'editor').'" title="'.get_string($key,'editor').'" />').'&nbsp;';
2966 $return .= '<input type="checkbox" class="form-checkbox" value="1" id="'.$this->get_id().$key.'" name="'.$this->get_full_name().'['.$key.']"'.(in_array($key,$data) ? ' checked="checked"' : '').' />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
6e4dc10f 2967 $count++;
2968 if ($count % 15 != 0) {
2969 $return .= '<br /><br />';
2970 }
2971 }
eef868d1 2972
2973 $return .= '</td></tr>';
6e4dc10f 2974 $return .= '</table>';
1beed35f 2975 $return .= '</div>';
6e4dc10f 2976
220a90c5 2977 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
6e4dc10f 2978 }
6e4dc10f 2979}
2980
220a90c5 2981/**
2982 * Special setting for limiting of the list of available languages.
2983 */
4642650f 2984class admin_setting_langlist extends admin_setting_configtext {
2985 function admin_setting_langlist() {
2986 parent::admin_setting_configtext('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS);
2987 }
2988
2989 function write_setting($data) {
2990 $return = parent::write_setting($data);
2991 get_list_of_languages(true);//refresh the list
2992 return $return;
2993 }
2994}
2995
220a90c5 2996/**
2997 * Course category selection
2998 */
2999class admin_settings_coursecat_select extends admin_setting_configselect {
3000 function admin_settings_coursecat_select($name, $visiblename, $description, $defaultsetting) {
3001 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, NULL);
3002 }
6153cf58 3003
220a90c5 3004 function load_choices() {
3005 global $CFG;
3006 require_once($CFG->dirroot.'/course/lib.php');
3007 if (is_array($this->choices)) {
3008 return true;
3009 }
3010 $this->choices = make_categories_options();
3011 return true;
3012 }
3013}
eef868d1 3014
220a90c5 3015class admin_setting_special_backupdays extends admin_setting_configmulticheckbox2 {
3016 function admin_setting_special_backupdays() {
3017 parent::admin_setting_configmulticheckbox2('backup_sche_weekdays', get_string('schedule'), get_string('backupschedulehelp'), array(), NULL);
3018 $this->plugin = 'backup';
6e4dc10f 3019 }
eef868d1 3020
220a90c5 3021 function load_choices() {
3022 if (is_array($this->choices)) {
3023 return true;
3024 }
3025 $this->choices = array();
3026 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
3027 foreach ($days as $day) {
3028 $this->choices[$day] = get_string($day, 'calendar');
6e4dc10f 3029 }
220a90c5 3030 return true;
6e4dc10f 3031 }
3032}
3033
220a90c5 3034/**
3035 * Special debug setting
3036 */
ee437bbc 3037class admin_setting_special_debug extends admin_setting_configselect {
6e4dc10f 3038 function admin_setting_special_debug() {
220a90c5 3039 parent::admin_setting_configselect('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE, NULL);
6e4dc10f 3040 }
3041
220a90c5 3042 function load_choices() {
3043 if (is_array($this->choices)) {
3044 return true;
ee437bbc 3045 }
220a90c5 3046 $this->choices = array(DEBUG_NONE => get_string('debugnone', 'admin'),
3047 DEBUG_MINIMAL => get_string('debugminimal', 'admin'),
3048 DEBUG_NORMAL => get_string('debugnormal', 'admin'),
3049 DEBUG_ALL => get_string('debugall', 'admin'),
3050 DEBUG_DEVELOPER => get_string('debugdeveloper', 'admin'));
3051 return true;
6e4dc10f 3052 }
6e4dc10f 3053}
3054
3055
3056class admin_setting_special_calendar_weekend extends admin_setting {
6e4dc10f 3057 function admin_setting_special_calendar_weekend() {
3058 $name = 'calendar_weekend';
3059 $visiblename = get_string('calendar_weekend', 'admin');
3060 $description = get_string('helpweekenddays', 'admin');
5eaa6aa0 3061 $default = array ('0', '6'); // Saturdays and Sundays
b91b1f92 3062 parent::admin_setting($name, $visiblename, $description, $default);
6e4dc10f 3063 }
3064
3065 function get_setting() {
220a90c5 3066 $result = $this->config_read($this->name);
3067 if (is_null($result)) {
3068 return NULL;
3069 }
3070 if ($result === '') {
3071 return array();
3072 }
3073 $settings = array();
3074 for ($i=0; $i<7; $i++) {
3075 if ($result & (1 << $i)) {
3076 $setting[] = $i;
3077 }
3078 }
3079 return $setting;
6e4dc10f 3080 }
eef868d1 3081
6e4dc10f 3082 function write_setting($data) {
220a90c5 3083 if (!is_array($data)) {
3084 return '';
3085 }
3086 unset($data['xxxxx']);
4af8d5d3 3087 $result = 0;
220a90c5 3088 foreach($data as $index) {
3089 $result |= 1 << $index;
6e4dc10f 3090 }
220a90c5 3091 return ($this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 3092 }
eef868d1 3093
220a90c5 3094 function output_html($data) {
4af8d5d3 3095 // The order matters very much because of the implied numeric keys
3096 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
3097 $return = '<table><thead><tr>';
220a90c5 3098 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
4af8d5d3 3099 foreach($days as $index => $day) {
220a90c5 3100 $return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
4af8d5d3 3101 }
3102 $return .= '</tr></thead><tbody><tr>';
3103 foreach($days as $index => $day) {
220a90c5 3104 $return .= '<td><input type="checkbox" class="form-checkbox" id="'.$this->get_id().$index.'" name="'.$this->get_full_name().'[]" value="'.$index.'" '.(in_array("$index", $data) ? 'checked="checked"' : '').' /></td>';
4af8d5d3 3105 }
3106 $return .= '</tr></tbody></table>';
6153cf58 3107
220a90c5 3108 return format_admin_setting($this, $this->visiblename, $return, $this->description, false);
eef868d1 3109
6e4dc10f 3110 }
6e4dc10f 3111}
3112
220a90c5 3113
3d5c00b3 3114/**
220a90c5 3115 * Graded roles in gradebook
5a412dbf 3116 */
220a90c5 3117class admin_setting_special_gradebookroles extends admin_setting_configmulticheckbox {
0909d44e 3118 function admin_setting_special_gradebookroles() {
220a90c5 3119 parent::admin_setting_configmulticheckbox('gradebookroles', get_string('gradebookroles', 'admin'),
3120 get_string('configgradebookroles', 'admin'), NULL, NULL);
5a412dbf 3121 }
3122
220a90c5 3123 function load_choices() {
5a412dbf 3124 global $CFG;
220a90c5 3125 if (empty($CFG->rolesactive)) {
3126 return false;
3127 }
3128 if (is_array($this->choices)) {
3129 return true;
3130 }
3131 if ($roles = get_records('role')) {
3132 $this->choices = array();
3133 foreach($roles as $role) {
3134 $this->choices[$role->id] = format_string($role->name);
60f7d402 3135 }
220a90c5 3136 return true;
5a412dbf 3137 } else {
220a90c5 3138 return false;
5a412dbf 3139 }
3140 }
3141
220a90c5 3142 function get_defaultsetting() {
3143 global $CFG;
3144 if (empty($CFG->rolesactive)) {
3145 return NULL;
3146 }
3147 $result = array();
3148 if ($studentroles = get_roles_with_capability('moodle/legacy:student', CAP_ALLOW)) {
3149 foreach ($studentroles as $studentrole) {
3150 $result[$studentrole->id] = '1';
5a412dbf 3151 }
73afaf5b 3152 }
220a90c5 3153 return $result;
5a412dbf 3154 }
220a90c5 3155}
5a412dbf 3156
220a90c5 3157/**
3158 * Which roles to show on course decription page
3159 */
3160class admin_setting_special_coursemanager extends admin_setting_configmulticheckbox {
3161 function admin_setting_special_coursemanager() {
3162 parent::admin_setting_configmulticheckbox('coursemanager', get_string('coursemanager', 'admin'),
3163 get_string('configcoursemanager', 'admin'), NULL, NULL);
3164 }
5a412dbf 3165
220a90c5 3166 function load_choices() {
3167 if (is_array($this->choices)) {
3168 return true;
5a412dbf 3169 }
5a412dbf 3170 if ($roles = get_records('role')) {
220a90c5 3171 $this->choices = array();
3172 foreach($roles as $role) {
3173 $this->choices[$role->id] = format_string($role->name);
5a412dbf 3174 }
220a90c5 3175 return true;
5a412dbf 3176 }
220a90c5 3177 return false;
3178 }
73afaf5b 3179
220a90c5 3180 function get_defaultsetting() {
3181 global $CFG;
3182 if (empty($CFG->rolesactive)) {
3183 return NULL;
3184 }
3185 $result = array();
3186 if ($teacherroles = get_roles_with_capability('moodle/legacy:editingteacher', CAP_ALLOW)) {
3187 foreach ($teacherroles as $teacherrole) {
3188 $result[$teacherrole->id] = '1';
3189 }
3190 }
3191 return $result;
3192 }
3193}
5a412dbf 3194
220a90c5 3195/**
3196 * Primary grade export plugin - has state tracking.
3197 */
3198class admin_setting_special_gradeexport extends admin_setting_configmulticheckbox {
3199 function admin_setting_special_gradeexport() {
3200 parent::admin_setting_configmulticheckbox('gradeexport', get_string('gradeexport', 'admin'),
3201 get_string('configgradeexport', 'admin'), array(), NULL);
5a412dbf 3202 }
3203
220a90c5 3204 function load_choices() {
3205 if (is_array($this->choices)) {
3206 return true;
3207 }
3208 $this->choices = array();
3209
3210 if ($plugins = get_list_of_plugins('grade/export')) {
3211 foreach($plugins as $plugin) {
3212 $this->choices[$plugin] = get_string('modulename', 'gradeexport_'.$plugin);
3213 }
3214 }
3215 return true;
3216 }
5a412dbf 3217}
6e4dc10f 3218
220a90c5 3219/**
3220 * Grade category settings
d42c64ba 3221 */
220a90c5 3222class admin_setting_gradecat_combo extends admin_setting {
d42c64ba 3223
220a90c5 3224 var $choices;
3225
3226 function admin_setting_gradecat_combo($name, $visiblename, $description, $defaultsetting, $choices) {
3227 $this->choices = $choices;
3228 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
d42c64ba 3229 }
3230
3231 function get_setting() {
d42c64ba 3232 global $CFG;
220a90c5 3233
3234 $value = $this->config_read($this->name);
3235 $flag = $this->config_read($this->name.'_flag');
3236
3237 if (is_null($value) or is_null($flag)) {
3238 return NULL;
d42c64ba 3239 }
220a90c5 3240
3241 $flag = (int)$flag;
3242 $forced = (boolean)(1 & $flag); // first bit
3243 $adv = (boolean)(2 & $flag); // second bit
3244
3245 return array('value' => $value, 'forced' => $forced, 'adv' => $adv);
d42c64ba 3246 }
3247
3248 function write_setting($data) {
220a90c5 3249 global $CFG;
d42c64ba 3250
220a90c5 3251 $value = $data['value'];
3252 $forced = empty($data['forced']) ? 0 : 1;
3253 $adv = empty($data['adv']) ? 0 : 2;
3254 $flag = ($forced | $adv); //bitwise or
3255
3256 if (!in_array($value, array_keys($this->choices))) {
3257 return 'Error setting ';
3258 }
3259
3260 $oldvalue = $this->config_read($this->name);
3261 $oldflag = (int)$this->config_read($this->name.'_flag');
3262 $oldforced = (1 & $oldflag); // first bit
3263
3264 $result1 = $this->config_write($this->name, $value);
3265 $result2 = $this->config_write($this->name.'_flag', $flag);
3266
3267 // force regrade if needed
3268 if ($oldforced != $forced or ($forced and $value != $oldvalue)) {
3269 require_once($CFG->libdir.'/gradelib.php');
3270 grade_category::updated_forced_settings();
3271 }
3272
3273 if ($result1 and $result2) {
3274 return '';
d42c64ba 3275 } else {
220a90c5 3276 return get_string('errorsetting', 'admin');
d42c64ba 3277 }
3278 }
3279
220a90c5 3280 function output_html($data) {
3281 $value = $data['value'];
3282 $forced = !empty($data['forced']);
3283 $adv = !empty($data['adv']);
d42c64ba 3284
220a90c5 3285 $return = '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
3286 foreach ($this->choices as $key => $val) {
3287 // the string cast is needed because key may be integer - 0 is equal to most strings!
3288 $return .= '<option value="'.$key.'"'.((string)$key==$value ? ' selected="selected"' : '').'>'.$val.'</option>';
3289 }
3290 $return .= '</select>';
3291 $return .= '</label><input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ? 'checked="checked"' : '').' />'
3292 .'<label for="'.$this->get_id().'force">'.get_string('force');
3293 $return .= '</label><input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ? 'checked="checked"' : '').' />'
3294 .'<label for="'.$this->get_id().'adv">'.get_string('advanced');
3295
3296 return format_admin_setting($this, $this->visiblename, $return, $this->description);
3297 }
3298}
3299
3300
3301/**
3302 * Selection of grade report in user profiles
3303 */
3304class admin_setting_grade_profilereport extends admin_setting_configselect {
3305 function admin_setting_grade_profilereport() {
3306 parent::admin_setting_configselect('grade_profilereport', get_string('profilereport', 'grades'), get_string('configprofilereport', 'grades'), 'user', null);
3307 }
3308
3309 function load_choices() {
3310 if (is_array($this->choices)) {
3311 return true;
3312 }
3313 $this->choices = array();
3314
3315 global $CFG;
3316 require_once($CFG->libdir.'/gradelib.php');
3317
3318 foreach (get_list_of_plugins('grade/report') as $plugin) {
3319 if (file_exists($CFG->dirroot.'/grade/report/'.$plugin.'/lib.php')) {
3320 require_once($CFG->dirroot.'/grade/report/'.$plugin.'/lib.php');
3321 $functionname = 'grade_report_'.$plugin.'_profilereport';
3322 if (function_exists($functionname)) {
3323 $this->choices[$plugin] = get_string('modulename', 'gradereport_'.$plugin, NULL, $CFG->dirroot.'/grade/report/'.$plugin.'/lang/');
d42c64ba 3324 }
d42c64ba 3325 }
d42c64ba 3326 }
220a90c5 3327 return true;
d42c64ba 3328 }
3329}
3330
220a90c5 3331/**
3332 * Special class for register auth selection
76127f37 3333 */
220a90c5 3334class admin_setting_special_registerauth extends admin_setting_configselect {
3335 function admin_setting_special_registerauth() {
3336 parent::admin_setting_configselect('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), 'email', null);
76127f37 3337 }
3338
220a90c5 3339 function get_defaultsettings() {
3340 $this->load_choices();
3341 if (array_key_exists($this->defaultsetting, $this->choices)) {
3342 return $this->defaultsetting;
3343 } else {
3344 return '';
3345 }
3346 }
76127f37 3347
220a90c5 3348 function load_choices() {
76127f37 3349 global $CFG;
220a90c5 3350
3351 if (is_array($this->choices)) {
3352 return true;
3353 }
3354 $this->choices = array();
3355 $this->choices[''] = get_string('disable');
3356
3357 $authsenabled = get_enabled_auth_plugins(true);
3358
3359 foreach ($authsenabled as $auth) {
3360 $authplugin = get_auth_plugin($auth);
3361 if (!$authplugin->can_signup()) {
3362 continue;
76127f37 3363 }
220a90c5 3364 // Get the auth title (from core or own auth lang files)
3365 $authtitle = get_string("auth_{$auth}title", "auth");
3366 if ($authtitle == "[[auth_{$auth}title]]") {
3367 $authtitle = get_string("auth_{$auth}title", "auth_{$auth}");
3368 }
3369 $this->choices[$auth] = $authtitle;
76127f37 3370 }
220a90c5 3371 return true;
76127f37 3372 }
220a90c5 3373}
76127f37 3374
220a90c5 3375/**
3376 * Module manage page
3377 */
3378class admin_page_managemods extends admin_externalpage {
3379 function admin_page_managemods() {
3380 global $CFG;
3381 parent::admin_externalpage('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
3382 }
76127f37 3383
220a90c5 3384 function search($query) {
3cea9c55 3385 if ($result = parent::search($query)) {
3386 return $result;
220a90c5 3387 }
3388
3389 $found = false;
3390 if ($modules = get_records('modules')) {
3391 $textlib = textlib_get_instance();
3392 foreach ($modules as $module) {
3393 if (strpos($module->name, $query) !== false) {
3394 $found = true;
3395 break;
3396 }
3397 $strmodulename = get_string('modulename', $module->name);
3398 if (strpos($textlib->strtolower($strmodulename), $query) !== false) {
3399 $found = true;
3400 break;
76127f37 3401 }
3402 }
220a90c5 3403 }
3404 if ($found) {
3405 $result = new object();
3406 $result->page = $this;
3407 $result->settings = array();
3408 return array($this->name => $result);
76127f37 3409 } else {
220a90c5 3410 return array();
76127f37 3411 }
3412 }
220a90c5 3413}
76127f37 3414
220a90c5 3415/**
3416 * Blocks manage page
3417 */
3418class admin_page_manageblocks extends admin_externalpage {
3419 function admin_page_manageblocks() {
3420 global $CFG;
3421 parent::admin_externalpage('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
3422 }
76127f37 3423
220a90c5 3424 function search($query) {
3425 global $CFG;
3cea9c55 3426 if ($result = parent::search($query)) {
3427 return $result;
220a90c5 3428 }
3429
3430 $found = false;
3431 if (!empty($CFG->blocks_version) and $blocks = get_records('block')) {
3432 $textlib = textlib_get_instance();
3433 foreach ($blocks as $block) {
3434 if (strpos($block->name, $query) !== false) {
3435 $found = true;
3436 break;
76127f37 3437 }
220a90c5 3438 $strblockname = get_string('blockname', 'block_'.$block->name);
3439 if (strpos($textlib->strtolower($strblockname), $query) !== false) {
3440 $found = true;
3441 break;