MDL-12793 PARAM_HOST incorrect cleaning; merged from MOODLE_19_STABLE
[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 */
587c7040 1569 function output_html($data, $query='') {
220a90c5 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 }
587c7040 1597 $current = $this->get_setting();
1598 if (!is_null($current)) {
1599 if (is_string($current)) {
1600 if (strpos($textlib->strtolower($current), $query) !== false) {
1601 return true;
1602 }
1603 }
1604 }
1605 $default = $this->get_defaultsetting();
1606 if (!is_null($default)) {
1607 if (is_string($default)) {
1608 if (strpos($textlib->strtolower($default), $query) !== false) {
1609 return true;
1610 }
1611 }
1612 }
220a90c5 1613 return false;
6e4dc10f 1614 }
220a90c5 1615}
eef868d1 1616
220a90c5 1617/**
1618 * No setting - just heading and text.
1619 */
1620class admin_setting_heading extends admin_setting {
1621 /**
1622 * not a setting, just text
1623 * @param string $name of setting
1624 * @param string $heading heading
1625 * @param string $information text in box
1626 */
1627 function admin_setting_heading($name, $heading, $information) {
1628 parent::admin_setting($name, $heading, $information, '');
1629 }
1630
1631 function get_setting() {
1632 return true;
1633 }
1634
1635 function get_defaultsetting() {
1636 return true;
1637 }
1638
1639 function write_setting($data) {
1640 // do not write any setting
1641 return '';
1642 }
1643
587c7040 1644 function output_html($data, $query='') {
220a90c5 1645 $return = '';
1646 if ($this->visiblename != '') {
587c7040 1647 $return .= print_heading('<a name="'.$this->name.'">'.highlightfast($query, $this->visiblename).'</a>', '', 3, 'main', true);
220a90c5 1648 }
1649 if ($this->description != '') {
587c7040 1650 $return .= print_box(highlight($query, $this->description), 'generalbox formsettingheading', '', true);
220a90c5 1651 }
1652 return $return;
1653 }
1654}
6e4dc10f 1655
220a90c5 1656/**
1657 * The most flexibly setting, user is typing text
1658 */
6e4dc10f 1659class admin_setting_configtext extends admin_setting {
1660
1661 var $paramtype;
1662
220a90c5 1663 /**
1664 * config text contructor
1665 * @param string $name of setting
1666 * @param string $visiblename localised
1667 * @param string $description long localised info
1668 * @param string $defaultsetting
1669 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
1670 */
50999a0b 1671 function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW) {
6e4dc10f 1672 $this->paramtype = $paramtype;
1673 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
1674 }
1675
1676 function get_setting() {
220a90c5 1677 return $this->config_read($this->name);
6e4dc10f 1678 }
eef868d1 1679
6e4dc10f 1680 function write_setting($data) {
8cad6cca 1681 if ($this->paramtype === PARAM_INT and $data === '') {
1682 // do not complain if '' used instead of 0
1683 $data = 0;
1684 }
220a90c5 1685 // $data is a string
e33fbf87 1686 $validated = $this->validate($data);
1687 if ($validated !== true) {
1688 return $validated;
c235598d 1689 }
220a90c5 1690 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 1691 }
1692
e33fbf87 1693 /**
1694 * Validate data before storage
1695 * @param string data
1696 * @return mixed true if ok string if error found
1697 */
c235598d 1698 function validate($data) {
9e24fbd1 1699 if (is_string($this->paramtype)) {
e33fbf87 1700 if (preg_match($this->paramtype, $data)) {
1701 return true;
1702 } else {
1703 return get_string('validateerror', 'admin');
1704 }
1705
9e24fbd1 1706 } else if ($this->paramtype === PARAM_RAW) {
1707 return true;
e33fbf87 1708
9e24fbd1 1709 } else {
e33fbf87 1710 $cleaned = stripslashes(clean_param(addslashes($data), $this->paramtype));
1711 if ("$data" == "$cleaned") { // implicit conversion to string is needed to do exact comparison
1712 return true;
1713 } else {
1714 return get_string('validateerror', 'admin');
1715 }
9e24fbd1 1716 }
c235598d 1717 }
1718
587c7040 1719 function output_html($data, $query='') {
220a90c5 1720 $default = $this->get_defaultsetting();
1721
220a90c5 1722 if ($this->paramtype === PARAM_INT) {
1723 $paramclass = 'class="number"';
c8218a42 1724 } else {
220a90c5 1725 $paramclass = '';
c8218a42 1726 }
220a90c5 1727
1728 return format_admin_setting($this, $this->visiblename,
587c7040 1729 '<div class="form-text defaultsnext"><input type="text" '.$paramclass.' id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>',
1730 $this->description, true, '', $default, $query);
6e4dc10f 1731 }
6e4dc10f 1732}
1733
220a90c5 1734/**
1735 * General text area without html editor.
1736 */
1737class admin_setting_configtextarea extends admin_setting_configtext {
1738 var $rows;
1739 var $cols;
eba8cd63 1740
28764710 1741 function admin_setting_configtextarea($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
220a90c5 1742 $this->rows = $rows;
1743 $this->cols = $cols;
eba8cd63 1744 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype);
1745 }
1746
587c7040 1747 function output_html($data, $query='') {
220a90c5 1748 $default = $this->get_defaultsetting();
1749
587c7040 1750 $defaultinfo = $default;
1751 if (!is_null($default) and $default !== '') {
1752 $defaultinfo = "\n".$default;
1753 }
220a90c5 1754
1755 return format_admin_setting($this, $this->visiblename,
587c7040 1756 '<div class="form-textarea" ><textarea rows="'.$this->rows.'" cols="'.$this->cols.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'">'.s($data).'</textarea></div>',
1757 $this->description, true, '', $defaultinfo, $query);
220a90c5 1758 }
1759}
1760
1761/**
1762 * Password field, allows unmasking of password
1763 */
1764class admin_setting_configpasswordunmask extends admin_setting_configtext {
1765 /**
1766 * Constructor
1767 * @param string $name of setting
1768 * @param string $visiblename localised
1769 * @param string $description long localised info
1770 * @param string $defaultsetting default password
1771 */
1772 function admin_setting_configpasswordunmask($name, $visiblename, $description, $defaultsetting) {
1773 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, PARAM_RAW);
1774 }
1775
587c7040 1776 function output_html($data, $query='') {
220a90c5 1777 $id = $this->get_id();
1778 $unmask = get_string('unmaskpassword', 'form');
1779 $unmaskjs = '<script type="text/javascript">
eba8cd63 1780//<![CDATA[
220a90c5 1781document.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 1782//]]>
1783</script>';
220a90c5 1784 return format_admin_setting($this, $this->visiblename,
1785 '<div class="form-password"><input type="password" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$unmaskjs.'</div>',
587c7040 1786 $this->description, true, '', NULL, $query);
220a90c5 1787 }
1788}
1789
1790/**
1791 * Path to executable file
1792 */
1793class admin_setting_configexecutable extends admin_setting_configtext {
1794 /**
1795 * Constructor
1796 * @param string $name of setting
1797 * @param string $visiblename localised
1798 * @param string $description long localised info
1799 * @param string $defautpath default path
1800 */
1801 function admin_setting_configexecutable($name, $visiblename, $description, $defaultpath) {
1802 parent::admin_setting_configtext($name, $visiblename, $description, $defaultpath, PARAM_RAW);
1803 }
1804
587c7040 1805 function output_html($data, $query='') {
220a90c5 1806 $default = $this->get_defaultsetting();
1807
220a90c5 1808 if ($data) {
1809 if (file_exists($data) and is_executable($data)) {
1810 $executable = '<span class="pathok">&#x2714;</span>';
1811 } else {
1812 $executable = '<span class="patherror">&#x2718;</span>';
1813 }
1814 } else {
1815 $executable = '';
1816 }
1817
1818 return format_admin_setting($this, $this->visiblename,
587c7040 1819 '<div class="form-executable defaultsnext"><input type="text" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
1820 $this->description, true, '', $default, $query);
eba8cd63 1821 }
220a90c5 1822}
1823
1824/**
1825 * Path to directory
1826 */
1827class admin_setting_configdirectory extends admin_setting_configtext {
1828 /**
1829 * Constructor
1830 * @param string $name of setting
1831 * @param string $visiblename localised
1832 * @param string $description long localised info
1833 * @param string $defaultdirectory default directory location
1834 */
1835 function admin_setting_configdirectory($name, $visiblename, $description, $defaultdirectory) {
1836 parent::admin_setting_configtext($name, $visiblename, $description, $defaultdirectory, PARAM_RAW);
1837 }
1838
587c7040 1839 function output_html($data, $query='') {
220a90c5 1840 $default = $this->get_defaultsetting();
1841
220a90c5 1842 if ($data) {
1843 if (file_exists($data) and is_dir($data)) {
1844 $executable = '<span class="pathok">&#x2714;</span>';
1845 } else {
1846 $executable = '<span class="patherror">&#x2718;</span>';
1847 }
1848 } else {
1849 $executable = '';
1850 }
9ba38673 1851
220a90c5 1852 return format_admin_setting($this, $this->visiblename,
587c7040 1853 '<div class="form-directory defaultsnext"><input type="text" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
1854 $this->description, true, '', $default, $query);
220a90c5 1855 }
eba8cd63 1856}
1857
220a90c5 1858/**
1859 * Checkbox
1860 */
6e4dc10f 1861class admin_setting_configcheckbox extends admin_setting {
220a90c5 1862 var $yes;
1863 var $no;
6e4dc10f 1864
220a90c5 1865 /**
1866 * Constructor
1867 * @param string $name of setting
1868 * @param string $visiblename localised
1869 * @param string $description long localised info
1870 * @param string $defaultsetting
1871 * @param string $yes value used when checked
1872 * @param string $no value used when not checked
1873 */
1874 function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
6e4dc10f 1875 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
220a90c5 1876 $this->yes = (string)$yes;
1877 $this->no = (string)$no;
6e4dc10f 1878 }
1879
1880 function get_setting() {
220a90c5 1881 return $this->config_read($this->name);
6e4dc10f 1882 }
eef868d1 1883
6e4dc10f 1884 function write_setting($data) {
220a90c5 1885 if ((string)$data === $this->yes) { // convert to strings before comparison
1886 $data = $this->yes;
6e4dc10f 1887 } else {
220a90c5 1888 $data = $this->no;
6e4dc10f 1889 }
220a90c5 1890 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 1891 }
1892
587c7040 1893 function output_html($data, $query='') {
220a90c5 1894 $default = $this->get_defaultsetting();
1895
1896 if (!is_null($default)) {
1897 if ((string)$default === $this->yes) {
587c7040 1898 $defaultinfo = get_string('checkboxyes', 'admin');
220a90c5 1899 } else {
587c7040 1900 $defaultinfo = get_string('checkboxno', 'admin');
220a90c5 1901 }
c8218a42 1902 } else {
587c7040 1903 $defaultinfo = NULL;
c8218a42 1904 }
220a90c5 1905
1906 if ((string)$data === $this->yes) { // convert to strings before comparison
1907 $checked = 'checked="checked"';
1908 } else {
1909 $checked = '';
1910 }
1911
1912 return format_admin_setting($this, $this->visiblename,
587c7040 1913 '<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> '
1914 .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' /></div>',
1915 $this->description, true, '', $defaultinfo, $query);
6e4dc10f 1916 }
6e4dc10f 1917}
1918
220a90c5 1919/**
1920 * Multiple checkboxes, each represents different value, stored in csv format
1921 */
1922class admin_setting_configmulticheckbox extends admin_setting {
6e4dc10f 1923 var $choices;
eef868d1 1924
220a90c5 1925 /**
1926 * Constructor
1927 * @param string $name of setting
1928 * @param string $visiblename localised
1929 * @param string $description long localised info
1930 * @param array $defaultsetting array of selected
1931 * @param array $choices array of $value=>$label for each checkbox
1932 */
1933 function admin_setting_configmulticheckbox($name, $visiblename, $description, $defaultsetting, $choices) {
6e4dc10f 1934 $this->choices = $choices;
1935 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
1936 }
1937
0a784551 1938 /**
1939 * This function may be used in ancestors for lazy loading of choices
220a90c5 1940 * @return true if loaded, false if error
0a784551 1941 */
1942 function load_choices() {
1943 /*
220a90c5 1944 if (is_array($this->choices)) {
1945 return true;
0a784551 1946 }
1947 .... load choices here
1948 */
220a90c5 1949 return true;
1950 }
1951
1952 /**
1953 * Is setting related to query text - used when searching
1954 * @param string $query
1955 * @return bool
1956 */
1957 function is_related($query) {
1958 if (!$this->load_choices() or empty($this->choices)) {
1959 return false;
1960 }
1961 if (parent::is_related($query)) {
1962 return true;
1963 }
1964
1965 $textlib = textlib_get_instance();
1966 foreach ($this->choices as $desc) {
1967 if (strpos($textlib->strtolower($desc), $query) !== false) {
1968 return true;
1969 }
1970 }
1971 return false;
0a784551 1972 }
1973
6e4dc10f 1974 function get_setting() {
220a90c5 1975 $result = $this->config_read($this->name);
1976 if (is_null($result)) {
1977 return NULL;
1978 }
1979 if ($result === '') {
1980 return array();
1981 }
1982 return explode(',', $result);
6e4dc10f 1983 }
eef868d1 1984
6e4dc10f 1985 function write_setting($data) {
220a90c5 1986 if (!is_array($data)) {
1987 return ''; // ignore it
1988 }
1989 if (!$this->load_choices() or empty($this->choices)) {
1990 return '';
1991 }
1992 unset($data['xxxxx']);
1993 $result = array();
1994 foreach ($data as $key => $value) {
1995 if ($value and array_key_exists($key, $this->choices)) {
1996 $result[] = $key;
1997 }
1998 }
1999 return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin');
6e4dc10f 2000 }
eef868d1 2001
587c7040 2002 function output_html($data, $query='') {
220a90c5 2003 if (!$this->load_choices() or empty($this->choices)) {
2004 return '';
2005 }
2006 $default = $this->get_defaultsetting();
2007 if (is_null($default)) {
2008 $default = array();
2009 }
2010 if (is_null($data)) {
2011 foreach ($default as $key=>$value) {
2012 if ($value) {
2013 $current[] = $value;
2014 }
2015 }
2016 }
2017
2018 $options = array();
2019 $defaults = array();
2020 foreach($this->choices as $key=>$description) {
2021 if (in_array($key, $data)) {
2022 $checked = 'checked="checked"';
2023 } else {
2024 $checked = '';
2025 }
2026 if (!empty($default[$key])) {
2027 $defaults[] = $description;
2028 }
2029
2030 $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
587c7040 2031 .'<label for="'.$this->get_id().'_'.$key.'">'.highlightfast($query, $description).'</label>';
220a90c5 2032 }
2033
587c7040 2034 if (is_null($default)) {
2035 $defaultinfo = NULL;
2036 } else if (!empty($defaults)) {
2037 $defaultinfo = implode(', ', $defaults);
c8218a42 2038 } else {
587c7040 2039 $defaultinfo = get_string('none');
c8218a42 2040 }
220a90c5 2041
2042 $return = '<div class="form-multicheckbox">';
2043 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2044 if ($options) {
2045 $return .= '<ul>';
2046 foreach ($options as $option) {
2047 $return .= '<li>'.$option.'</li>';
2048 }
2049 $return .= '</ul>';
6e4dc10f 2050 }
587c7040 2051 $return .= '</div>';
6153cf58 2052
587c7040 2053 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
2054
6e4dc10f 2055 }
6e4dc10f 2056}
2057
220a90c5 2058/**
2059 * Multiple checkboxes 2, value stored as string 00101011
2060 */
2061class admin_setting_configmulticheckbox2 extends admin_setting_configmulticheckbox {
2062 function get_setting() {
2063 $result = $this->config_read($this->name);
2064 if (is_null($result)) {
2065 return NULL;
2066 }
2067 if (!$this->load_choices()) {
2068 return NULL;
2069 }
2070 $result = str_pad($result, count($this->choices), '0');
2071 $result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY);
2072 $setting = array();
2073 foreach ($this->choices as $key=>$unused) {
2074 $value = array_shift($result);
2075 if ($value) {
2076 $setting[] = $key;
2077 }
2078 }
2079 return $setting;
2080 }
6e4dc10f 2081
220a90c5 2082 function write_setting($data) {
2083 if (!is_array($data)) {
2084 return ''; // ignore it
2085 }
2086 if (!$this->load_choices() or empty($this->choices)) {
2087 return '';
2088 }
2089 $result = '';
2090 foreach ($this->choices as $key=>$unused) {
2091 if (!empty($data[$key])) {
2092 $result .= '1';
2093 } else {
2094 $result .= '0';
2095 }
2096 }
2097 return $this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin');
2098 }
2099}
2100
2101/**
2102 * Select one value from list
2103 */
2104class admin_setting_configselect extends admin_setting {
6e4dc10f 2105 var $choices;
6e4dc10f 2106
220a90c5 2107 /**
2108 * Constructor
2109 * @param string $name of setting
2110 * @param string $visiblename localised
2111 * @param string $description long localised info
2112 * @param string $defaultsetting
2113 * @param array $choices array of $value=>$label for each selection
2114 */
2115 function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) {
2116 $this->choices = $choices;
2117 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
2118 }
2119
2120 /**
2121 * This function may be used in ancestors for lazy loading of choices
2122 * @return true if loaded, false if error
2123 */
2124 function load_choices() {
2125 /*
2126 if (is_array($this->choices)) {
2127 return true;
6e4dc10f 2128 }
220a90c5 2129 .... load choices here
2130 */
2131 return true;
6e4dc10f 2132 }
2133
407d8134 2134 function is_related($query) {
2135 if (parent::is_related($query)) {
2136 return true;
2137 }
2138 if (!$this->load_choices()) {
2139 return false;
2140 }
2141 $textlib = textlib_get_instance();
2142 foreach ($this->choices as $key=>$value) {
2143 if (strpos($textlib->strtolower($key), $query) !== false) {
2144 return true;
2145 }
2146 if (strpos($textlib->strtolower($value), $query) !== false) {
2147 return true;
2148 }
2149 }
2150 return false;
2151 }
2152
6e4dc10f 2153 function get_setting() {
220a90c5 2154 return $this->config_read($this->name);
6e4dc10f 2155 }
eef868d1 2156
6e4dc10f 2157 function write_setting($data) {
220a90c5 2158 if (!$this->load_choices() or empty($this->choices)) {
2159 return '';
2160 }
2161 if (!array_key_exists($data, $this->choices)) {
2162 return ''; // ignore it
2163 }
eef868d1 2164
220a90c5 2165 return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2166 }
eef868d1 2167
587c7040 2168 function output_html($data, $query='') {
220a90c5 2169 if (!$this->load_choices() or empty($this->choices)) {
2170 return '';
2171 }
2172 $default = $this->get_defaultsetting();
2173
2174 if (!is_null($default) and array_key_exists($default, $this->choices)) {
587c7040 2175 $defaultinfo = $this->choices[$default];
cc73de71 2176 } else {
587c7040 2177 $defaultinfo = NULL;
6e4dc10f 2178 }
220a90c5 2179
9c305ba1 2180 $current = $this->get_setting();
2181 $warning = '';
2182 if (is_null($current)) {
2183 //first run
2184 } else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) {
2185 // no warning
2186 } else if (!array_key_exists($current, $this->choices)) {
2187 $warning = get_string('warningcurrentsetting', 'admin', s($current));
2188 if (!is_null($default) and $data==$current) {
2189 $data = $default; // use default instead of first value when showing the form
2190 }
2191 }
2192
587c7040 2193 $return = '<div class="form-select defaultsnext"><select id="'.$this->get_id().'" name="'.$this->get_full_name().'">';
6e4dc10f 2194 foreach ($this->choices as $key => $value) {
220a90c5 2195 // the string cast is needed because key may be integer - 0 is equal to most strings!
2196 $return .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>';
eef868d1 2197 }
587c7040 2198 $return .= '</select></div>';
220a90c5 2199
587c7040 2200 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning, $defaultinfo, $query);
6e4dc10f 2201 }
2202
2203}
2204
220a90c5 2205/**
2206 * Select multiple items from list
2207 */
6e4dc10f 2208class admin_setting_configmultiselect extends admin_setting_configselect {
220a90c5 2209 /**
2210 * Constructor
2211 * @param string $name of setting
2212 * @param string $visiblename localised
2213 * @param string $description long localised info
2214 * @param array $defaultsetting array of selected items
2215 * @param array $choices array of $value=>$label for each list item
2216 */
6e4dc10f 2217 function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) {
2218 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices);
2219 }
2220
2221 function get_setting() {
220a90c5 2222 $result = $this->config_read($this->name);
2223 if (is_null($result)) {
d7933a55 2224 return NULL;
2225 }
220a90c5 2226 if ($result === '') {
2227 return array();
2228 }
2229 return explode(',', $result);
6e4dc10f 2230 }
eef868d1 2231
6e4dc10f 2232 function write_setting($data) {
220a90c5 2233 if (!is_array($data)) {
2234 return ''; //ignore it
2235 }
2236 if (!$this->load_choices() or empty($this->choices)) {
2237 return '';
2238 }
2239
a7ad48fd 2240 unset($data['xxxxx']);
2241
220a90c5 2242 $save = array();
2243 foreach ($data as $value) {
2244 if (!array_key_exists($value, $this->choices)) {
2245 continue; // ignore it
2246 }
2247 $save[] = $value;
2248 }
2249
2250 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2251 }
2252
2253 /**
2254 * Is setting related to query text - used when searching
2255 * @param string $query
2256 * @return bool
2257 */
2258 function is_related($query) {
2259 if (!$this->load_choices() or empty($this->choices)) {
2260 return false;
2261 }
2262 if (parent::is_related($query)) {
2263 return true;
2264 }
2265
2266 $textlib = textlib_get_instance();
2267 foreach ($this->choices as $desc) {
2268 if (strpos($textlib->strtolower($desc), $query) !== false) {
2269 return true;
2270 }
2271 }
2272 return false;
2273 }
2274
587c7040 2275 function output_html($data, $query='') {
220a90c5 2276 if (!$this->load_choices() or empty($this->choices)) {
2277 return '';
2278 }
2279 $choices = $this->choices;
2280 $default = $this->get_defaultsetting();
2281 if (is_null($default)) {
2282 $default = array();
2283 }
2284 if (is_null($data)) {
d7933a55 2285 $data = array();
2286 }
220a90c5 2287
2288 $defaults = array();
a7ad48fd 2289 $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2290 $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="10" multiple="multiple">';
220a90c5 2291 foreach ($this->choices as $key => $description) {
2292 if (in_array($key, $data)) {
2293 $selected = 'selected="selected"';
2294 } else {
2295 $selected = '';
2296 }
2297 if (in_array($key, $default)) {
2298 $defaults[] = $description;
6e4dc10f 2299 }
220a90c5 2300
2301 $return .= '<option value="'.s($key).'" '.$selected.'>'.$description.'</option>';
2302 }
2303
587c7040 2304 if (is_null($default)) {
2305 $defaultinfo = NULL;
2306 } if (!empty($defaults)) {
2307 $defaultinfo = implode(', ', $defaults);
220a90c5 2308 } else {
587c7040 2309 $defaultinfo = get_string('none');
6e4dc10f 2310 }
eef868d1 2311
587c7040 2312 $return .= '</select></div>';
2313 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
6e4dc10f 2314 }
220a90c5 2315}
eef868d1 2316
220a90c5 2317/**
2318 * Time selector
2319 * this is a liiitle bit messy. we're using two selects, but we're returning
2320 * them as an array named after $name (so we only use $name2 internally for the setting)
2321 */
2322class admin_setting_configtime extends admin_setting {
2323 var $name2;
2324
2325 /**
2326 * Constructor
2327 * @param string $hoursname setting for hours
2328 * @param string $minutesname setting for hours
2329 * @param string $visiblename localised
2330 * @param string $description long localised info
2331 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
2332 */
2333 function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
2334 $this->name2 = $minutesname;
2335 parent::admin_setting($hoursname, $visiblename, $description, $defaultsetting);
2336 }
2337
2338 function get_setting() {
2339 $result1 = $this->config_read($this->name);
2340 $result2 = $this->config_read($this->name2);
2341 if (is_null($result1) or is_null($result2)) {
2342 return NULL;
2343 }
2344
2345 return array('h' => $result1, 'm' => $result2);
2346 }
2347
2348 function write_setting($data) {
2349 if (!is_array($data)) {
2350 return '';
2351 }
2352
2353 $result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']);
2354 return ($result ? '' : get_string('errorsetting', 'admin'));
2355 }
2356
587c7040 2357 function output_html($data, $query='') {
220a90c5 2358 $default = $this->get_defaultsetting();
2359
2360 if (is_array($default)) {
587c7040 2361 $defaultinfo = $default['h'].':'.$default['m'];
cc73de71 2362 } else {
587c7040 2363 $defaultinfo = NULL;
6e4dc10f 2364 }
220a90c5 2365
587c7040 2366 $return = '<div class="form-time defaultsnext">'.
220a90c5 2367 '<select id="'.$this->get_id().'h" name="'.$this->get_full_name().'[h]">';
2368 for ($i = 0; $i < 24; $i++) {
2369 $return .= '<option value="'.$i.'"'.($i == $data['h'] ? ' selected="selected"' : '').'>'.$i.'</option>';
6e4dc10f 2370 }
220a90c5 2371 $return .= '</select>:<select id="'.$this->get_id().'m" name="'.$this->get_full_name().'[m]">';
2372 for ($i = 0; $i < 60; $i += 5) {
2373 $return .= '<option value="'.$i.'"'.($i == $data['m'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2374 }
587c7040 2375 $return .= '</select></div>';
2376 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
6e4dc10f 2377 }
2378
2379}
2380
220a90c5 2381/**
2382 * Special checkbox for calendar - resets SESSION vars.
2383 */
6e4dc10f 2384class admin_setting_special_adminseesall extends admin_setting_configcheckbox {
6e4dc10f 2385 function admin_setting_special_adminseesall() {
220a90c5 2386 parent::admin_setting_configcheckbox('calendar_adminseesall', get_string('adminseesall', 'admin'),
2387 get_string('helpadminseesall', 'admin'), '0');
6e4dc10f 2388 }
2389
2390 function write_setting($data) {
2391 global $SESSION;
2392 unset($SESSION->cal_courses_shown);
220a90c5 2393 return parent::write_setting($data);
6e4dc10f 2394 }
2395}
2396
392e7363 2397/**
2398 * Special select for settings that are altered in setup.php and can not be altered on the fly
2399 */
2400class admin_setting_special_selectsetup extends admin_setting_configselect {
2401 function get_setting() {
2402 // read directly from db!
2403 return get_config(NULL, $this->name);
2404 }
2405
2406 function write_setting($data) {
2407 global $CFG;
2408 // do not change active CFG setting!
2409 $current = $CFG->{$this->name};
2410 $result = parent::write_setting($data);
2411 $CFG->{$this->name} = $current;
2412 return $result;
2413 }
2414}
2415
220a90c5 2416/**
2417 * Special select for frontpage - stores data in course table
2418 */
6e4dc10f 2419class admin_setting_sitesetselect extends admin_setting_configselect {
6e4dc10f 2420 function get_setting() {
2421 $site = get_site();
220a90c5 2422 return $site->{$this->name};
6e4dc10f 2423 }
eef868d1 2424
6e4dc10f 2425 function write_setting($data) {
2426 if (!in_array($data, array_keys($this->choices))) {
220a90c5 2427 return get_string('errorsetting', 'admin');
6e4dc10f 2428 }
2429 $record = new stdClass();
220a90c5 2430 $record->id = SITEID;
2431 $temp = $this->name;
2432 $record->$temp = $data;
6e4dc10f 2433 $record->timemodified = time();
220a90c5 2434 return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2435 }
6e4dc10f 2436}
2437
220a90c5 2438/**
2439 * Special select - lists on the frontpage - hacky
2440 */
2441class admin_setting_courselist_frontpage extends admin_setting {
2442 var $choices;
6e4dc10f 2443
e0f6e995 2444 function admin_setting_courselist_frontpage($loggedin) {
6e4dc10f 2445 global $CFG;
220a90c5 2446 require_once($CFG->dirroot.'/course/lib.php');
2447 $name = 'frontpage'.($loggedin ? 'loggedin' : '');
2448 $visiblename = get_string('frontpage'.($loggedin ? 'loggedin' : ''),'admin');
2449 $description = get_string('configfrontpage'.($loggedin ? 'loggedin' : ''),'admin');
2450 $defaults = array(FRONTPAGECOURSELIST);
2451 parent::admin_setting($name, $visiblename, $description, $defaults);
6e4dc10f 2452 }
eef868d1 2453
220a90c5 2454 function load_choices() {
2455 if (is_array($this->choices)) {
2456 return true;
2457 }
2458 $this->choices = array(FRONTPAGENEWS => get_string('frontpagenews'),
2459 FRONTPAGECOURSELIST => get_string('frontpagecourselist'),
2460 FRONTPAGECATEGORYNAMES => get_string('frontpagecategorynames'),
2461 FRONTPAGECATEGORYCOMBO => get_string('frontpagecategorycombo'),
2462 'none' => get_string('none'));
2463 if ($this->name == 'frontpage' and count_records('course') > FRONTPAGECOURSELIMIT) {
2464 unset($this->choices[FRONTPAGECOURSELIST]);
2465 }
2466 return true;
2467 }
6e4dc10f 2468 function get_setting() {
220a90c5 2469 $result = $this->config_read($this->name);
2470 if (is_null($result)) {
2471 return NULL;
2472 }
2473 if ($result === '') {
2474 return array();
2475 }
2476 return explode(',', $result);
6e4dc10f 2477 }
eef868d1 2478
6e4dc10f 2479 function write_setting($data) {
220a90c5 2480 if (!is_array($data)) {
2481 return '';
6e4dc10f 2482 }
220a90c5 2483 $this->load_choices();
2484 $save = array();
6e4dc10f 2485 foreach($data as $datum) {
220a90c5 2486 if ($datum == 'none' or !array_key_exists($datum, $this->choices)) {
2487 continue;
6e4dc10f 2488 }
220a90c5 2489 $save[$datum] = $datum; // no duplicates
6e4dc10f 2490 }
220a90c5 2491 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2492 }
eef868d1 2493
587c7040 2494 function output_html($data, $query='') {
220a90c5 2495 $this->load_choices();
2496 $currentsetting = array();
2497 foreach ($data as $key) {
2498 if ($key != 'none' and array_key_exists($key, $this->choices)) {
2499 $currentsetting[] = $key; // already selected first
6e4dc10f 2500 }
2501 }
220a90c5 2502
0a7e84c3 2503 $return = '<div class="form-group">';
6e4dc10f 2504 for ($i = 0; $i < count($this->choices) - 1; $i++) {
220a90c5 2505 if (!array_key_exists($i, $currentsetting)) {
2506 $currentsetting[$i] = 'none'; //none
2507 }
2508 $return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
6e4dc10f 2509 foreach ($this->choices as $key => $value) {
220a90c5 2510 $return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ? ' selected="selected"' : '').'>'.$value.'</option>';
6e4dc10f 2511 }
2512 $return .= '</select>';
2513 if ($i !== count($this->choices) - 2) {
975211bb 2514 $return .= '<br />';
6e4dc10f 2515 }
2516 }
0a7e84c3 2517 $return .= '</div>';
2518
587c7040 2519 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
6e4dc10f 2520 }
2521}
2522
220a90c5 2523/**
2524 * Special checkbox for frontpage - stores data in course table
2525 */
6e4dc10f 2526class admin_setting_sitesetcheckbox extends admin_setting_configcheckbox {
6e4dc10f 2527 function get_setting() {
2528 $site = get_site();
8e5da17a 2529 return $site->{$this->name};
6e4dc10f 2530 }
eef868d1 2531
6e4dc10f 2532 function write_setting($data) {
220a90c5 2533 $record = new object();
2534 $record->id = SITEID;
2535 $record->{$this->name} = ($data == '1' ? 1 : 0);
2536 $record->timemodified = time();
2537 return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2538 }
6e4dc10f 2539}
2540
220a90c5 2541/**
2542 * Special text for frontpage - stores data in course table.
2543 * Empty string means not set here. Manual setting is required.
2544 */
6e4dc10f 2545class admin_setting_sitesettext extends admin_setting_configtext {
6e4dc10f 2546 function get_setting() {
2547 $site = get_site();
8e5da17a 2548 return $site->{$this->name} != '' ? $site->{$this->name} : NULL;
6e4dc10f 2549 }
90cfbd0a 2550
b89639f9 2551 function validate($data) {
e33fbf87 2552 $cleaned = stripslashes(clean_param(addslashes($data), PARAM_MULTILANG));
2553 if ($cleaned === '') {
2554 return get_string('required');
2555 }
2556 if ("$data" == "$cleaned") { // implicit conversion to string is needed to do exact comparison
2557 return true;
2558 } else {
2559 return get_string('validateerror', 'admin');
b89639f9 2560 }
b89639f9 2561 }
2562
6e4dc10f 2563 function write_setting($data) {
b89639f9 2564 $data = trim($data);
e33fbf87 2565 $validated = $this->validate($data);
2566 if ($validated !== true) {
2567 return $validated;
90cfbd0a 2568 }
eef868d1 2569
220a90c5 2570 $record = new object();
2571 $record->id = SITEID;
87fa8a17 2572 $record->{$this->name} = addslashes($data);
220a90c5 2573 $record->timemodified = time();
2574 return (update_record('course', $record) ? '' : get_string('dbupdatefailed', 'error'));
6e4dc10f 2575 }
6e4dc10f 2576}
2577
220a90c5 2578/**
2579 * Special text editor for site description.
2580 */
6e4dc10f 2581class admin_setting_special_frontpagedesc extends admin_setting {
6e4dc10f 2582 function admin_setting_special_frontpagedesc() {
220a90c5 2583 parent::admin_setting('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
6e4dc10f 2584 }
eef868d1 2585
6e4dc10f 2586 function get_setting() {
6e4dc10f 2587 $site = get_site();
c626c2f4 2588 return $site->{$this->name};
2589 }
eef868d1 2590
6e4dc10f 2591 function write_setting($data) {
c626c2f4 2592 $record = new object();
220a90c5 2593 $record->id = SITEID;
c626c2f4 2594 $record->{$this->name} = addslashes($data);
2595 $record->timemodified = time();
220a90c5 2596 return(update_record('course', $record) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2597 }
2598
587c7040 2599 function output_html($data, $query='') {
220a90c5 2600 global $CFG;
6e4dc10f 2601
220a90c5 2602 $CFG->adminusehtmleditor = can_use_html_editor();
2603 $return = '<div class="form-htmlarea">'.print_textarea($CFG->adminusehtmleditor, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true).'</div>';
2604
587c7040 2605 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
220a90c5 2606 }
2607}
6e4dc10f 2608
2609class admin_setting_special_editorfontlist extends admin_setting {
2610
2611 var $items;
2612
2613 function admin_setting_special_editorfontlist() {
2614 global $CFG;
2615 $name = 'editorfontlist';
2616 $visiblename = get_string('editorfontlist', 'admin');
2617 $description = get_string('configeditorfontlist', 'admin');
6e4dc10f 2618 $defaults = array('k0' => 'Trebuchet',
2619 'v0' => 'Trebuchet MS,Verdana,Arial,Helvetica,sans-serif',
2620 'k1' => 'Arial',
2621 'v1' => 'arial,helvetica,sans-serif',
2622 'k2' => 'Courier New',
2623 'v2' => 'courier new,courier,monospace',
2624 'k3' => 'Georgia',
2625 'v3' => 'georgia,times new roman,times,serif',
2626 'k4' => 'Tahoma',
2627 'v4' => 'tahoma,arial,helvetica,sans-serif',
2628 'k5' => 'Times New Roman',
2629 'v5' => 'times new roman,times,serif',
2630 'k6' => 'Verdana',
2631 'v6' => 'verdana,arial,helvetica,sans-serif',
2632 'k7' => 'Impact',
2633 'v7' => 'impact',
2634 'k8' => 'Wingdings',
2635 'v8' => 'wingdings');
2636 parent::admin_setting($name, $visiblename, $description, $defaults);
2637 }
eef868d1 2638
6e4dc10f 2639 function get_setting() {
cc73de71 2640 global $CFG;
220a90c5 2641 $result = $this->config_read($this->name);
2642 if (is_null($result)) {
cc73de71 2643 return NULL;
2644 }
220a90c5 2645 $i = 0;
2646 $currentsetting = array();
2647 $items = explode(';', $result);
2648 foreach ($items as $item) {
2649 $item = explode(':', $item);
2650 $currentsetting['k'.$i] = $item[0];
2651 $currentsetting['v'.$i] = $item[1];
2652 $i++;
2653 }
2654 return $currentsetting;
6e4dc10f 2655 }
eef868d1 2656
6e4dc10f 2657 function write_setting($data) {
eef868d1 2658
6e4dc10f 2659 // there miiight be an easier way to do this :)
2660 // if this is changed, make sure the $defaults array above is modified so that this
2661 // function processes it correctly
eef868d1 2662
6e4dc10f 2663 $keys = array();
2664 $values = array();
eef868d1 2665
6e4dc10f 2666 foreach ($data as $key => $value) {
2667 if (substr($key,0,1) == 'k') {
2668 $keys[substr($key,1)] = $value;
2669 } elseif (substr($key,0,1) == 'v') {
2670 $values[substr($key,1)] = $value;
2671 }
2672 }
eef868d1 2673
220a90c5 2674 $result = array();
6e4dc10f 2675 for ($i = 0; $i < count($keys); $i++) {
2676 if (($keys[$i] !== '') && ($values[$i] !== '')) {
220a90c5 2677 $result[] = clean_param($keys[$i],PARAM_NOTAGS).':'.clean_param($values[$i], PARAM_NOTAGS);
6e4dc10f 2678 }
2679 }
eef868d1 2680
220a90c5 2681 return ($this->config_write($this->name, implode(';', $result)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2682 }
eef868d1 2683
587c7040 2684 function output_html($data, $query='') {
220a90c5 2685 $fullname = $this->get_full_name();
1beed35f 2686 $return = '<div class="form-group">';
220a90c5 2687 for ($i = 0; $i < count($data) / 2; $i++) {
2688 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
6e4dc10f 2689 $return .= '&nbsp;&nbsp;';
220a90c5 2690 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
6e4dc10f 2691 }
220a90c5 2692 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="" />';
6e4dc10f 2693 $return .= '&nbsp;&nbsp;';
220a90c5 2694 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2695 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
6e4dc10f 2696 $return .= '&nbsp;&nbsp;';
220a90c5 2697 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
1beed35f 2698 $return .= '</div>';
6153cf58 2699
587c7040 2700 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
6e4dc10f 2701 }
eef868d1 2702
6e4dc10f 2703}
2704
93c61c18 2705class admin_setting_emoticons extends admin_setting {
2706
2707 var $items;
2708
2709 function admin_setting_emoticons() {
2710 global $CFG;
2711 $name = 'emoticons';
2712 $visiblename = get_string('emoticons', 'admin');
2713 $description = get_string('configemoticons', 'admin');
2714 $defaults = array('k0' => ':-)',
2715 'v0' => 'smiley',
2716 'k1' => ':)',
2717 'v1' => 'smiley',
2718 'k2' => ':-D',
2719 'v2' => 'biggrin',
2720 'k3' => ';-)',
2721 'v3' => 'wink',
2722 'k4' => ':-/',
2723 'v4' => 'mixed',
2724 'k5' => 'V-.',
2725 'v5' => 'thoughtful',
2726 'k6' => ':-P',
2727 'v6' => 'tongueout',
2728 'k7' => 'B-)',
2729 'v7' => 'cool',
2730 'k8' => '^-)',
2731 'v8' => 'approve',
2732 'k9' => '8-)',
2733 'v9' => 'wideeyes',
2734 'k10' => ':o)',
2735 'v10' => 'clown',
2736 'k11' => ':-(',
2737 'v11' => 'sad',
2738 'k12' => ':(',
2739 'v12' => 'sad',
2740 'k13' => '8-.',
2741 'v13' => 'shy',
2742 'k14' => ':-I',
2743 'v14' => 'blush',
2744 'k15' => ':-X',
2745 'v15' => 'kiss',
2746 'k16' => '8-o',
2747 'v16' => 'surprise',
2748 'k17' => 'P-|',
2749 'v17' => 'blackeye',
2750 'k18' => '8-[',
2751 'v18' => 'angry',
2752 'k19' => 'xx-P',
2753 'v19' => 'dead',
2754 'k20' => '|-.',
2755 'v20' => 'sleepy',
2756 'k21' => '}-]',
2757 'v21' => 'evil',
2758 'k22' => '(h)',
2759 'v22' => 'heart',
2760 'k23' => '(heart)',
2761 'v23' => 'heart',
2762 'k24' => '(y)',
2763 'v24' => 'yes',
2764 'k25' => '(n)',
2765 'v25' => 'no',
2766 'k26' => '(martin)',
2767 'v26' => 'martin',
2768 'k27' => '( )',
2769 'v27' => 'egg');
2770 parent::admin_setting($name, $visiblename, $description, $defaults);
2771 }
2772
2773 function get_setting() {
2774 global $CFG;
220a90c5 2775 $result = $this->config_read($this->name);
2776 if (is_null($result)) {
93c61c18 2777 return NULL;
2778 }
220a90c5 2779 $i = 0;
2780 $currentsetting = array();
2781 $items = explode('{;}', $result);
2782 foreach ($items as $item) {
2783 $item = explode('{:}', $item);
2784 $currentsetting['k'.$i] = $item[0];
2785 $currentsetting['v'.$i] = $item[1];
2786 $i++;
2787 }
2788 return $currentsetting;
93c61c18 2789 }
2790
2791 function write_setting($data) {
2792
2793 // there miiight be an easier way to do this :)
2794 // if this is changed, make sure the $defaults array above is modified so that this
2795 // function processes it correctly
2796
2797 $keys = array();
2798 $values = array();
2799
2800 foreach ($data as $key => $value) {
2801 if (substr($key,0,1) == 'k') {
2802 $keys[substr($key,1)] = $value;
2803 } elseif (substr($key,0,1) == 'v') {
2804 $values[substr($key,1)] = $value;
2805 }
2806 }
2807
220a90c5 2808 $result = array();
93c61c18 2809 for ($i = 0; $i < count($keys); $i++) {
2810 if (($keys[$i] !== '') && ($values[$i] !== '')) {
220a90c5 2811 $result[] = clean_param($keys[$i],PARAM_NOTAGS).'{:}'.clean_param($values[$i], PARAM_NOTAGS);
93c61c18 2812 }
2813 }
2814
220a90c5 2815 return ($this->config_write($this->name, implode('{;}', $result)) ? '' : get_string('errorsetting', 'admin').$this->visiblename.'<br />');
93c61c18 2816 }
2817
587c7040 2818 function output_html($data, $query='') {
220a90c5 2819 $fullname = $this->get_full_name();
93c61c18 2820 $return = '<div class="form-group">';
220a90c5 2821 for ($i = 0; $i < count($data) / 2; $i++) {
2822 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
93c61c18 2823 $return .= '&nbsp;&nbsp;';
220a90c5 2824 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
93c61c18 2825 }
220a90c5 2826 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="" />';
93c61c18 2827 $return .= '&nbsp;&nbsp;';
220a90c5 2828 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2829 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
93c61c18 2830 $return .= '&nbsp;&nbsp;';
220a90c5 2831 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
93c61c18 2832 $return .= '</div>';
2833
587c7040 2834 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
93c61c18 2835 }
2836
2837}
2838
220a90c5 2839/**
2840 * Setting for spellchecker language selection.
2841 */
6e4dc10f 2842class admin_setting_special_editordictionary extends admin_setting_configselect {
2843
2844 function admin_setting_special_editordictionary() {
2845 $name = 'editordictionary';
2846 $visiblename = get_string('editordictionary','admin');
2847 $description = get_string('configeditordictionary', 'admin');
220a90c5 2848 parent::admin_setting_configselect($name, $visiblename, $description, '', NULL);
6e4dc10f 2849 }
2850
220a90c5 2851 function load_choices() {
2852 // function borrowed from the old moodle/admin/editor.php, slightly modified
2853 // Get all installed dictionaries in the system
2854 if (is_array($this->choices)) {
2855 return true;
2856 }
2857
2858 $this->choices = array();
6e4dc10f 2859
2860 global $CFG;
eef868d1 2861
6e4dc10f 2862 clearstatcache();
2863
2864 // If aspellpath isn't set don't even bother ;-)
2865 if (empty($CFG->aspellpath)) {
220a90c5 2866 $this->choices['error'] = 'Empty aspell path!';
2867 return true;
6e4dc10f 2868 }
2869
2870 // Do we have access to popen function?
2871 if (!function_exists('popen')) {
220a90c5 2872 $this->choices['error'] = 'Popen function disabled!';
2873 return true;
6e4dc10f 2874 }
eef868d1 2875
6e4dc10f 2876 $cmd = $CFG->aspellpath;
2877 $output = '';
2878 $dictionaries = array();
6e4dc10f 2879
220a90c5 2880 if(!($handle = @popen(escapeshellarg($cmd).' dump dicts', 'r'))) {
2881 $this->choices['error'] = 'Couldn\'t create handle!';
6e4dc10f 2882 }
2883
2884 while(!feof($handle)) {
2885 $output .= fread($handle, 1024);
2886 }
2887 @pclose($handle);
2888
2889 $dictionaries = explode(chr(10), $output);
220a90c5 2890 foreach ($dictionaries as $dict) {
2891 if (empty($dict)) {
2892 continue;
6e4dc10f 2893 }
220a90c5 2894 $this->choices[$dict] = $dict;
6e4dc10f 2895 }
2896
220a90c5 2897 if (empty($this->choices)) {
2898 $this->choices['error'] = 'Error! Check your aspell installation!';
6e4dc10f 2899 }
220a90c5 2900 return true;
6e4dc10f 2901 }
6e4dc10f 2902}
2903
2904
2905class admin_setting_special_editorhidebuttons extends admin_setting {
6e4dc10f 2906 var $items;
2907
2908 function admin_setting_special_editorhidebuttons() {
220a90c5 2909 parent::admin_setting('editorhidebuttons', get_string('editorhidebuttons', 'admin'),
2910 get_string('confeditorhidebuttons', 'admin'), array());
6e4dc10f 2911 // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead
2912 $this->items = array('fontname' => '',
2913 'fontsize' => '',
2914 'formatblock' => '',
2915 'bold' => 'ed_format_bold.gif',
2916 'italic' => 'ed_format_italic.gif',
2917 'underline' => 'ed_format_underline.gif',
2918 'strikethrough' => 'ed_format_strike.gif',
2919 'subscript' => 'ed_format_sub.gif',
2920 'superscript' => 'ed_format_sup.gif',
2921 'copy' => 'ed_copy.gif',
2922 'cut' => 'ed_cut.gif',
2923 'paste' => 'ed_paste.gif',
2924 'clean' => 'ed_wordclean.gif',
2925 'undo' => 'ed_undo.gif',
2926 'redo' => 'ed_redo.gif',
2927 'justifyleft' => 'ed_align_left.gif',
2928 'justifycenter' => 'ed_align_center.gif',
2929 'justifyright' => 'ed_align_right.gif',
2930 'justifyfull' => 'ed_align_justify.gif',
2931 'lefttoright' => 'ed_left_to_right.gif',
2932 'righttoleft' => 'ed_right_to_left.gif',
2933 'insertorderedlist' => 'ed_list_num.gif',
2934 'insertunorderedlist' => 'ed_list_bullet.gif',
2935 'outdent' => 'ed_indent_less.gif',
2936 'indent' => 'ed_indent_more.gif',
2937 'forecolor' => 'ed_color_fg.gif',
2938 'hilitecolor' => 'ed_color_bg.gif',
2939 'inserthorizontalrule' => 'ed_hr.gif',
2940 'createanchor' => 'ed_anchor.gif',
2941 'createlink' => 'ed_link.gif',
2942 'unlink' => 'ed_unlink.gif',
2943 'insertimage' => 'ed_image.gif',
2944 'inserttable' => 'insert_table.gif',
2945 'insertsmile' => 'em.icon.smile.gif',
2946 'insertchar' => 'icon_ins_char.gif',
2947 'spellcheck' => 'spell-check.gif',
2948 'htmlmode' => 'ed_html.gif',
2949 'popupeditor' => 'fullscreen_maximize.gif',
2950 'search_replace' => 'ed_replace.gif');
2951 }
2952
2953 function get_setting() {
220a90c5 2954 $result = $this->config_read($this->name);
2955 if (is_null($result)) {
2956 return NULL;
2957 }
2958 if ($result === '') {
2959 return array();
2960 }
2961 return explode(',', $result);
6e4dc10f 2962 }
2963
2964 function write_setting($data) {
220a90c5 2965 if (!is_array($data)) {
2966 return ''; // ignore it
2967 }
2968 unset($data['xxxxx']);
6e4dc10f 2969 $result = array();
220a90c5 2970
6e4dc10f 2971 foreach ($data as $key => $value) {
2972 if (!in_array($key, array_keys($this->items))) {
220a90c5 2973 return get_string('errorsetting', 'admin');
6e4dc10f 2974 }
2975 if ($value == '1') {
2976 $result[] = $key;
2977 }
2978 }
220a90c5 2979 return ($this->config_write($this->name, implode(' ', $result)) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 2980 }
2981
587c7040 2982 function output_html($data, $query='') {
eef868d1 2983
6e4dc10f 2984 global $CFG;
eef868d1 2985
6e4dc10f 2986 // checkboxes with input name="$this->name[$key]" value="1"
2987 // we do 15 fields per column
eef868d1 2988
1beed35f 2989 $return = '<div class="form-group">';
2990 $return .= '<table><tr><td valign="top" align="right">';
220a90c5 2991 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
eef868d1 2992
6e4dc10f 2993 $count = 0;
eef868d1 2994
6e4dc10f 2995 foreach($this->items as $key => $value) {
8ddbd7a6 2996 if ($count % 15 == 0 and $count != 0) {
2997 $return .= '</td><td valign="top" align="right">';
6e4dc10f 2998 }
eef868d1 2999
220a90c5 3000 $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;';
3001 $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 3002 $count++;
3003 if ($count % 15 != 0) {
3004 $return .= '<br /><br />';
3005 }
3006 }
eef868d1 3007
3008 $return .= '</td></tr>';
6e4dc10f 3009 $return .= '</table>';
1beed35f 3010 $return .= '</div>';
6e4dc10f 3011
587c7040 3012 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
6e4dc10f 3013 }
6e4dc10f 3014}
3015
220a90c5 3016/**
3017 * Special setting for limiting of the list of available languages.
3018 */
4642650f 3019class admin_setting_langlist extends admin_setting_configtext {
3020 function admin_setting_langlist() {
3021 parent::admin_setting_configtext('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS);
3022 }
3023
3024 function write_setting($data) {
3025 $return = parent::write_setting($data);
3026 get_list_of_languages(true);//refresh the list
3027 return $return;
3028 }
3029}
3030
220a90c5 3031/**
3032 * Course category selection
3033 */
3034class admin_settings_coursecat_select extends admin_setting_configselect {
3035 function admin_settings_coursecat_select($name, $visiblename, $description, $defaultsetting) {
3036 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, NULL);
3037 }
6153cf58 3038
220a90c5 3039 function load_choices() {
3040 global $CFG;
3041 require_once($CFG->dirroot.'/course/lib.php');
3042 if (is_array($this->choices)) {
3043 return true;
3044 }
3045 $this->choices = make_categories_options();
3046 return true;
3047 }
3048}
eef868d1 3049
220a90c5 3050class admin_setting_special_backupdays extends admin_setting_configmulticheckbox2 {
3051 function admin_setting_special_backupdays() {
3052 parent::admin_setting_configmulticheckbox2('backup_sche_weekdays', get_string('schedule'), get_string('backupschedulehelp'), array(), NULL);
3053 $this->plugin = 'backup';
6e4dc10f 3054 }
eef868d1 3055
220a90c5 3056 function load_choices() {
3057 if (is_array($this->choices)) {
3058 return true;
3059 }
3060 $this->choices = array();
3061 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
3062 foreach ($days as $day) {
3063 $this->choices[$day] = get_string($day, 'calendar');
6e4dc10f 3064 }
220a90c5 3065 return true;
6e4dc10f 3066 }
3067}
3068
220a90c5 3069/**
3070 * Special debug setting
3071 */
ee437bbc 3072class admin_setting_special_debug extends admin_setting_configselect {
6e4dc10f 3073 function admin_setting_special_debug() {
220a90c5 3074 parent::admin_setting_configselect('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE, NULL);
6e4dc10f 3075 }
3076
220a90c5 3077 function load_choices() {
3078 if (is_array($this->choices)) {
3079 return true;
ee437bbc 3080 }
220a90c5 3081 $this->choices = array(DEBUG_NONE => get_string('debugnone', 'admin'),
3082 DEBUG_MINIMAL => get_string('debugminimal', 'admin'),
3083 DEBUG_NORMAL => get_string('debugnormal', 'admin'),
3084 DEBUG_ALL => get_string('debugall', 'admin'),
3085 DEBUG_DEVELOPER => get_string('debugdeveloper', 'admin'));
3086 return true;
6e4dc10f 3087 }
6e4dc10f 3088}
3089
3090
3091class admin_setting_special_calendar_weekend extends admin_setting {
6e4dc10f 3092 function admin_setting_special_calendar_weekend() {
3093 $name = 'calendar_weekend';
3094 $visiblename = get_string('calendar_weekend', 'admin');
3095 $description = get_string('helpweekenddays', 'admin');
5eaa6aa0 3096 $default = array ('0', '6'); // Saturdays and Sundays
b91b1f92 3097 parent::admin_setting($name, $visiblename, $description, $default);
6e4dc10f 3098 }
3099
3100 function get_setting() {
220a90c5 3101 $result = $this->config_read($this->name);
3102 if (is_null($result)) {
3103 return NULL;
3104 }
3105 if ($result === '') {
3106 return array();
3107 }
3108 $settings = array();
3109 for ($i=0; $i<7; $i++) {
3110 if ($result & (1 << $i)) {
3111 $setting[] = $i;
3112 }
3113 }
3114 return $setting;
6e4dc10f 3115 }
eef868d1 3116
6e4dc10f 3117 function write_setting($data) {
220a90c5 3118 if (!is_array($data)) {
3119 return '';
3120 }
3121 unset($data['xxxxx']);
4af8d5d3 3122 $result = 0;
220a90c5 3123 foreach($data as $index) {
3124 $result |= 1 << $index;
6e4dc10f 3125 }
220a90c5 3126 return ($this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin'));
6e4dc10f 3127 }
eef868d1 3128
587c7040 3129 function output_html($data, $query='') {
4af8d5d3 3130 // The order matters very much because of the implied numeric keys
3131 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
3132 $return = '<table><thead><tr>';
220a90c5 3133 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
4af8d5d3 3134 foreach($days as $index => $day) {
220a90c5 3135 $return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
4af8d5d3 3136 }
3137 $return .= '</tr></thead><tbody><tr>';
3138 foreach($days as $index => $day) {
220a90c5 3139 $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 3140 }
3141 $return .= '</tr></tbody></table>';
6153cf58 3142
587c7040 3143 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
eef868d1 3144
6e4dc10f 3145 }
6e4dc10f 3146}
3147
220a90c5 3148
3d5c00b3 3149/**
220a90c5 3150 * Graded roles in gradebook
5a412dbf 3151 */
220a90c5 3152class admin_setting_special_gradebookroles extends admin_setting_configmulticheckbox {
0909d44e 3153 function admin_setting_special_gradebookroles() {
220a90c5 3154 parent::admin_setting_configmulticheckbox('gradebookroles', get_string('gradebookroles', 'admin'),
3155 get_string('configgradebookroles', 'admin'), NULL, NULL);
5a412dbf 3156 }
3157
220a90c5 3158 function load_choices() {
5a412dbf 3159 global $CFG;
220a90c5 3160 if (empty($CFG->rolesactive)) {
3161 return false;
3162 }
3163 if (is_array($this->choices)) {
3164 return true;
3165 }
3166 if ($roles = get_records('role')) {
3167 $this->choices = array();
3168 foreach($roles as $role) {
3169 $this->choices[$role->id] = format_string($role->name);
60f7d402 3170 }
220a90c5 3171 return true;
5a412dbf 3172 } else {
220a90c5 3173 return false;
5a412dbf 3174 }
3175 }
3176
220a90c5 3177 function get_defaultsetting() {
3178 global $CFG;
3179 if (empty($CFG->rolesactive)) {
3180 return NULL;
3181 }
3182 $result = array();
3183 if ($studentroles = get_roles_with_capability('moodle/legacy:student', CAP_ALLOW)) {
3184 foreach ($studentroles as $studentrole) {
3185 $result[$studentrole->id] = '1';
5a412dbf 3186 }
73afaf5b 3187 }
220a90c5 3188 return $result;
5a412dbf 3189 }
220a90c5 3190}
5a412dbf 3191
220a90c5 3192/**
3193 * Which roles to show on course decription page
3194 */
3195class admin_setting_special_coursemanager extends admin_setting_configmulticheckbox {
3196 function admin_setting_special_coursemanager() {
3197 parent::admin_setting_configmulticheckbox('coursemanager', get_string('coursemanager', 'admin'),
3198 get_string('configcoursemanager', 'admin'), NULL, NULL);
3199 }
5a412dbf 3200
220a90c5 3201 function load_choices() {
3202 if (is_array($this->choices)) {
3203 return true;
5a412dbf 3204 }
5a412dbf 3205 if ($roles = get_records('role')) {
220a90c5 3206 $this->choices = array();
3207 foreach($roles as $role) {
3208 $this->choices[$role->id] = format_string($role->name);
5a412dbf 3209 }
220a90c5 3210 return true;
5a412dbf 3211 }
220a90c5 3212 return false;
3213 }
73afaf5b 3214
220a90c5 3215 function get_defaultsetting() {
3216 global $CFG;
3217 if (empty($CFG->rolesactive)) {
3218 return NULL;
3219 }
3220 $result = array();
3221 if ($teacherroles = get_roles_with_capability('moodle/legacy:editingteacher', CAP_ALLOW)) {
3222 foreach ($teacherroles as $teacherrole) {
3223 $result[$teacherrole->id] = '1';
3224 }
3225 }
3226 return $result;
3227 }
3228}
5a412dbf 3229
220a90c5 3230/**
3231 * Primary grade export plugin - has state tracking.
3232 */
3233class admin_setting_special_gradeexport extends admin_setting_configmulticheckbox {
3234 function admin_setting_special_gradeexport() {
3235 parent::admin_setting_configmulticheckbox('gradeexport', get_string('gradeexport', 'admin'),
3236 get_string('configgradeexport', 'admin'), array(), NULL);
5a412dbf 3237 }
3238
220a90c5 3239 function load_choices() {
3240 if (is_array($this->choices)) {
3241 return true;
3242 }
3243 $this->choices = array();
3244
3245 if ($plugins = get_list_of_plugins('grade/export')) {
3246 foreach($plugins as $plugin) {
3247 $this->choices[$plugin] = get_string('modulename', 'gradeexport_'.$plugin);
3248 }
3249 }
3250 return true;
3251 }
5a412dbf 3252}
6e4dc10f 3253
220a90c5 3254/**
3255 * Grade category settings
d42c64ba 3256 */
220a90c5 3257class admin_setting_gradecat_combo extends admin_setting {
d42c64ba 3258
220a90c5 3259 var $choices;
3260
3261 function admin_setting_gradecat_combo($name, $visiblename, $description, $defaultsetting, $choices) {
3262 $this->choices = $choices;
3263 parent::admin_setting($name, $visiblename, $description, $defaultsetting);
d42c64ba 3264 }
3265
3266 function get_setting() {
d42c64ba 3267 global $CFG;
220a90c5 3268
3269 $value = $this->config_read($this->name);
3270 $flag = $this->config_read($this->name.'_flag');
3271
3272 if (is_null($value) or is_null($flag)) {
3273 return NULL;
d42c64ba 3274 }
220a90c5 3275
3276 $flag = (int)$flag;
3277 $forced = (boolean)(1 & $flag); // first bit
3278 $adv = (boolean)(2 & $flag); // second bit
3279
3280 return array('value' => $value, 'forced' => $forced, 'adv' => $adv);
d42c64ba 3281 }
3282
3283 function write_setting($data) {
220a90c5 3284 global $CFG;
d42c64ba 3285
220a90c5 3286 $value = $data['value'];
3287 $forced = empty($data['forced']) ? 0 : 1;
3288 $adv = empty($data['adv']) ? 0 : 2;
3289 $flag = ($forced | $adv); //bitwise or
3290
3291 if (!in_array($value, array_keys($this->choices))) {
3292 return 'Error setting ';
3293 }
3294
3295 $oldvalue = $this->config_read($this->name);
3296 $oldflag = (int)$this->config_read($this->name.'_flag');
3297 $oldforced = (1 & $oldflag); // first bit
3298
3299 $result1 = $this->config_write($this->name, $value);
3300 $result2 = $this->config_write($this->name.'_flag', $flag);
3301
3302 // force regrade if needed
3303 if ($oldforced != $forced or ($forced and $value != $oldvalue)) {
3304 require_once($CFG->libdir.'/gradelib.php');
3305 grade_category::updated_forced_settings();
3306 }
3307
3308 if ($result1 and $result2) {
3309 return '';
d42c64ba 3310 } else {
220a90c5 3311 return get_string('errorsetting', 'admin');
d42c64ba 3312 }
3313 }
3314
587c7040 3315 function output_html($data, $query='') {
220a90c5 3316 $value = $data['value'];
3317 $forced = !empty($data['forced']);
3318 $adv = !empty($data['adv']);
d42c64ba 3319
220a90c5 3320 $return = '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
3321 foreach ($this->choices as $key => $val) {
3322 // the string cast is needed because key may be integer - 0 is equal to most strings!
3323 $return .= '<option value="'.$key.'"'.((string)$key==$value ? ' selected="selected"' : '').'>'.$val.'</option>';
3324 }
3325 $return .= '</select>';
587c7040 3326 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ? 'checked="checked"' : '').' />'
3327 .'<label for="'.$this->get_id().'force">'.get_string('force').'</label>';
3328 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ? 'checked="checked"' : '').' />'
3329 .'<label for="'.$this->get_id().'adv">'.get_string('advanced').'</label>';
220a90c5 3330
587c7040 3331 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', NULL, $query);
220a90c5 3332 }
3333}
3334
3335
3336/**
3337 * Selection of grade report in user profiles
3338 */
3339class admin_setting_grade_profilereport extends admin_setting_configselect {
3340 function admin_setting_grade_profilereport() {
3341 parent::admin_setting_configselect('grade_profilereport', get_string('profilereport', 'grades'), get_string('configprofilereport', 'grades'), 'user', null);
3342 }
3343
3344 function load_choices() {
3345 if (is_array($this->choices)) {
3346 return true;
3347 }
3348 $this->choices = array();
3349
3350 global $CFG;
3351 require_once($CFG->libdir.'/gradelib.php');
3352
3353 foreach (get_list_of_plugins('grade/report') as $plugin) {
3354 if (file_exists($CFG->dirroot.'/grade/report/'.$plugin.'/lib.php')) {
3355 require_once($CFG->dirroot.'/grade/report/'.$plugin.'/lib.php');
3356 $functionname = 'grade_report_'.$plugin.'_profilereport';
3357 if (function_exists($functionname)) {
3358 $this->choices[$plugin] = get_string('modulename', 'gradereport_'.$plugin, NULL, $CFG->dirroot.'/grade/report/'.$plugin.'/lang/');
d42c64ba 3359 }
d42c64ba 3360 }
d42c64ba 3361 }
220a90c5 3362 return true;
d42c64ba 3363 }
3364}
3365
220a90c5 3366/**
3367 * Special class for register auth selection
76127f37 3368 */
220a90c5 3369class admin_setting_special_registerauth extends admin_setting_configselect {
3370 function admin_setting_special_registerauth() {
3371 parent::admin_setting_configselect('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), 'email', null);
76127f37 3372 }
3373
220a90c5 3374 function get_defaultsettings() {
3375 $this->load_choices();
3376 if (array_key_exists($this->defaultsetting, $this->choices)) {
3377 return $this->defaultsetting;
3378 } else {
3379 return '';
3380 }
3381 }
76127f37 3382
220a90c5 3383 function load_choices() {
76127f37 3384 global $CFG;
220a90c5 3385
3386 if (is_array($this->choices)) {
3387 return true;
3388 }
3389 $this->choices = array();
3390 $this->choices[''] = get_string('disable');
3391
3392 $authsenabled = get_enabled_auth_plugins(true);
3393
3394 foreach ($authsenabled as $auth) {
3395 $authplugin = get_auth_plugin($auth);
3396 if (!$authplugin->can_signup()) {
3397 continue;
76127f37 3398 }
220a90c5 3399 // Get the auth title (from core or own auth lang files)
3400 $authtitle = get_string("auth_{$auth}title", "auth");
3401 if ($authtitle == "[[auth_{$auth}title]]") {
3402 $authtitle = get_string("auth_{$auth}title", "auth_{$auth}");
3403 }
3404 $this->choices[$auth] = $authtitle;
76127f37 3405 }
220a90c5 3406 return true;
76127f37 3407 }
220a90c5 3408}
76127f37 3409