Commit | Line | Data |
---|---|---|
db26acd4 | 1 | <?php |
0c079f19 | 2 | // This file is part of Moodle - http://moodle.org/ |
3 | // | |
db26acd4 | 4 | // Moodle is free software: you can redistribute it and/or modify |
5 | // it under the terms of the GNU General Public License as published by | |
6 | // the Free Software Foundation, either version 3 of the License, or | |
7 | // (at your option) any later version. | |
8 | // | |
9 | // Moodle is distributed in the hope that it will be useful, | |
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | // GNU General Public License for more details. | |
0c079f19 | 13 | // |
db26acd4 | 14 | // You should have received a copy of the GNU General Public License |
15 | // along with Moodle. If not, see <http://www.gnu.org/licenses/>. | |
88a7228a | 16 | |
17 | /** | |
0c079f19 | 18 | * Functions and classes used during installation, upgrades and for admin settings. |
db26acd4 | 19 | * |
0c079f19 | 20 | * ADMIN SETTINGS TREE INTRODUCTION |
db26acd4 | 21 | * |
22 | * This file performs the following tasks: | |
23 | * -it defines the necessary objects and interfaces to build the Moodle | |
24 | * admin hierarchy | |
61ef8f9f | 25 | * -it defines the admin_externalpage_setup() |
db26acd4 | 26 | * |
27 | * ADMIN_SETTING OBJECTS | |
28 | * | |
29 | * Moodle settings are represented by objects that inherit from the admin_setting | |
30 | * class. These objects encapsulate how to read a setting, how to write a new value | |
31 | * to a setting, and how to appropriately display the HTML to modify the setting. | |
32 | * | |
33 | * ADMIN_SETTINGPAGE OBJECTS | |
34 | * | |
35 | * The admin_setting objects are then grouped into admin_settingpages. The latter | |
36 | * appear in the Moodle admin tree block. All interaction with admin_settingpage | |
37 | * objects is handled by the admin/settings.php file. | |
38 | * | |
39 | * ADMIN_EXTERNALPAGE OBJECTS | |
40 | * | |
41 | * There are some settings in Moodle that are too complex to (efficiently) handle | |
42 | * with admin_settingpages. (Consider, for example, user management and displaying | |
43 | * lists of users.) In this case, we use the admin_externalpage object. This object | |
44 | * places a link to an external PHP file in the admin tree block. | |
45 | * | |
46 | * If you're using an admin_externalpage object for some settings, you can take | |
47 | * advantage of the admin_externalpage_* functions. For example, suppose you wanted | |
48 | * to add a foo.php file into admin. First off, you add the following line to | |
49 | * admin/settings/first.php (at the end of the file) or to some other file in | |
50 | * admin/settings: | |
51 | * <code> | |
52 | * $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'), | |
53 | * $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission')); | |
54 | * </code> | |
55 | * | |
56 | * Next, in foo.php, your file structure would resemble the following: | |
57 | * <code> | |
1fcf0ca8 | 58 | * require(__DIR__.'/../../config.php'); |
db26acd4 | 59 | * require_once($CFG->libdir.'/adminlib.php'); |
60 | * admin_externalpage_setup('foo'); | |
61 | * // functionality like processing form submissions goes here | |
4d553cb2 | 62 | * echo $OUTPUT->header(); |
db26acd4 | 63 | * // your HTML goes here |
4d553cb2 | 64 | * echo $OUTPUT->footer(); |
db26acd4 | 65 | * </code> |
66 | * | |
67 | * The admin_externalpage_setup() function call ensures the user is logged in, | |
68 | * and makes sure that they have the proper role permission to access the page. | |
01a2ce80 | 69 | * It also configures all $PAGE properties needed for navigation. |
db26acd4 | 70 | * |
71 | * ADMIN_CATEGORY OBJECTS | |
72 | * | |
73 | * Above and beyond all this, we have admin_category objects. These objects | |
74 | * appear as folders in the admin tree block. They contain admin_settingpage's, | |
75 | * admin_externalpage's, and other admin_category's. | |
76 | * | |
77 | * OTHER NOTES | |
78 | * | |
79 | * admin_settingpage's, admin_externalpage's, and admin_category's all inherit | |
80 | * from part_of_admin_tree (a pseudointerface). This interface insists that | |
81 | * a class has a check_access method for access permissions, a locate method | |
82 | * used to find a specific node in the admin tree and find parent path. | |
83 | * | |
84 | * admin_category's inherit from parentable_part_of_admin_tree. This pseudo- | |
85 | * interface ensures that the class implements a recursive add function which | |
86 | * accepts a part_of_admin_tree object and searches for the proper place to | |
87 | * put it. parentable_part_of_admin_tree implies part_of_admin_tree. | |
88 | * | |
89 | * Please note that the $this->name field of any part_of_admin_tree must be | |
90 | * UNIQUE throughout the ENTIRE admin tree. | |
91 | * | |
92 | * The $this->name field of an admin_setting object (which is *not* part_of_ | |
93 | * admin_tree) must be unique on the respective admin_settingpage where it is | |
94 | * used. | |
95 | * | |
0c079f19 | 96 | * Original author: Vincenzo K. Marcovecchio |
97 | * Maintainer: Petr Skoda | |
db26acd4 | 98 | * |
78bfb562 PS |
99 | * @package core |
100 | * @subpackage admin | |
101 | * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com | |
102 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
88a7228a | 103 | */ |
104 | ||
78bfb562 PS |
105 | defined('MOODLE_INTERNAL') || die(); |
106 | ||
598b38f7 | 107 | /// Add libraries |
108 | require_once($CFG->libdir.'/ddllib.php'); | |
b1f93b15 | 109 | require_once($CFG->libdir.'/xmlize.php'); |
3bcbd80e | 110 | require_once($CFG->libdir.'/messagelib.php'); |
b1f93b15 | 111 | |
bba0beae | 112 | define('INSECURE_DATAROOT_WARNING', 1); |
113 | define('INSECURE_DATAROOT_ERROR', 2); | |
0c079f19 | 114 | |
ed996ede | 115 | /** |
116 | * Automatically clean-up all plugin data and remove the plugin DB tables | |
117 | * | |
2f87bb03 PS |
118 | * NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead! |
119 | * | |
ed996ede | 120 | * @param string $type The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc. |
121 | * @param string $name The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc. | |
122 | * @uses global $OUTPUT to produce notices and other messages | |
123 | * @return void | |
124 | */ | |
125 | function uninstall_plugin($type, $name) { | |
126 | global $CFG, $DB, $OUTPUT; | |
127 | ||
3db309dc | 128 | // This may take a long time. |
3ef7279f | 129 | core_php_time_limit::raise(); |
3db309dc | 130 | |
3601c5f0 PS |
131 | // Recursively uninstall all subplugins first. |
132 | $subplugintypes = core_component::get_plugin_types_with_subplugins(); | |
133 | if (isset($subplugintypes[$type])) { | |
134 | $base = core_component::get_plugin_directory($type, $name); | |
c57fc98b | 135 | if (file_exists("$base/db/subplugins.php")) { |
846e4e17 | 136 | $subplugins = array(); |
c57fc98b | 137 | include("$base/db/subplugins.php"); |
846e4e17 | 138 | foreach ($subplugins as $subplugintype=>$dir) { |
3601c5f0 | 139 | $instances = core_component::get_plugin_list($subplugintype); |
846e4e17 PS |
140 | foreach ($instances as $subpluginname => $notusedpluginpath) { |
141 | uninstall_plugin($subplugintype, $subpluginname); | |
142 | } | |
ed996ede | 143 | } |
144 | } | |
846e4e17 | 145 | |
ed996ede | 146 | } |
147 | ||
2138244c | 148 | $component = $type . '_' . $name; // eg. 'qtype_multichoice' or 'workshopgrading_accumulative' or 'mod_forum' |
149 | ||
150 | if ($type === 'mod') { | |
151 | $pluginname = $name; // eg. 'forum' | |
70d35fe6 PS |
152 | if (get_string_manager()->string_exists('modulename', $component)) { |
153 | $strpluginname = get_string('modulename', $component); | |
154 | } else { | |
155 | $strpluginname = $component; | |
156 | } | |
df997f84 | 157 | |
2138244c | 158 | } else { |
9baf6825 | 159 | $pluginname = $component; |
70d35fe6 PS |
160 | if (get_string_manager()->string_exists('pluginname', $component)) { |
161 | $strpluginname = get_string('pluginname', $component); | |
162 | } else { | |
163 | $strpluginname = $component; | |
164 | } | |
2138244c | 165 | } |
df997f84 | 166 | |
ed996ede | 167 | echo $OUTPUT->heading($pluginname); |
168 | ||
c026a28d MG |
169 | // Delete all tag areas, collections and instances associated with this plugin. |
170 | core_tag_area::uninstall($component); | |
d9994071 | 171 | |
effff2a4 | 172 | // Custom plugin uninstall. |
1c74b260 | 173 | $plugindirectory = core_component::get_plugin_directory($type, $name); |
ed996ede | 174 | $uninstalllib = $plugindirectory . '/db/uninstall.php'; |
175 | if (file_exists($uninstalllib)) { | |
176 | require_once($uninstalllib); | |
2138244c | 177 | $uninstallfunction = 'xmldb_' . $pluginname . '_uninstall'; // eg. 'xmldb_workshop_uninstall()' |
ed996ede | 178 | if (function_exists($uninstallfunction)) { |
effff2a4 PS |
179 | // Do not verify result, let plugin complain if necessary. |
180 | $uninstallfunction(); | |
ed996ede | 181 | } |
182 | } | |
183 | ||
a31e0b40 | 184 | // Specific plugin type cleanup. |
e87214bd | 185 | $plugininfo = core_plugin_manager::instance()->get_plugin_info($component); |
a31e0b40 PS |
186 | if ($plugininfo) { |
187 | $plugininfo->uninstall_cleanup(); | |
e87214bd | 188 | core_plugin_manager::reset_caches(); |
a31e0b40 PS |
189 | } |
190 | $plugininfo = null; | |
191 | ||
70d35fe6 | 192 | // perform clean-up task common for all the plugin/subplugin types |
ed996ede | 193 | |
bc81eadb JM |
194 | //delete the web service functions and pre-built services |
195 | require_once($CFG->dirroot.'/lib/externallib.php'); | |
196 | external_delete_descriptions($component); | |
197 | ||
ed996ede | 198 | // delete calendar events |
2138244c | 199 | $DB->delete_records('event', array('modulename' => $pluginname)); |
ed996ede | 200 | |
309ae892 | 201 | // Delete scheduled tasks. |
c05f3109 | 202 | $DB->delete_records('task_scheduled', array('component' => $component)); |
309ae892 | 203 | |
6c0bfb14 | 204 | // Delete Inbound Message datakeys. |
39048505 | 205 | $DB->delete_records_select('messageinbound_datakeys', |
c05f3109 | 206 | 'handler IN (SELECT id FROM {messageinbound_handlers} WHERE component = ?)', array($component)); |
6c0bfb14 AN |
207 | |
208 | // Delete Inbound Message handlers. | |
c05f3109 | 209 | $DB->delete_records('messageinbound_handlers', array('component' => $component)); |
6c0bfb14 | 210 | |
ed996ede | 211 | // delete all the logs |
2138244c | 212 | $DB->delete_records('log', array('module' => $pluginname)); |
ed996ede | 213 | |
214 | // delete log_display information | |
c6d75bff | 215 | $DB->delete_records('log_display', array('component' => $component)); |
ed996ede | 216 | |
217 | // delete the module configuration records | |
bde002b8 PS |
218 | unset_all_config_for_plugin($component); |
219 | if ($type === 'mod') { | |
220 | unset_all_config_for_plugin($pluginname); | |
221 | } | |
ed996ede | 222 | |
3bcbd80e | 223 | // delete message provider |
8e265315 RK |
224 | message_provider_uninstall($component); |
225 | ||
ed996ede | 226 | // delete the plugin tables |
227 | $xmldbfilepath = $plugindirectory . '/db/install.xml'; | |
54483279 PS |
228 | drop_plugin_tables($component, $xmldbfilepath, false); |
229 | if ($type === 'mod' or $type === 'block') { | |
230 | // non-frankenstyle table prefixes | |
231 | drop_plugin_tables($name, $xmldbfilepath, false); | |
232 | } | |
ed996ede | 233 | |
ed996ede | 234 | // delete the capabilities that were defined by this module |
235 | capabilities_cleanup($component); | |
236 | ||
875e5f07 | 237 | // remove event handlers and dequeue pending events |
ed996ede | 238 | events_uninstall($component); |
239 | ||
546b8864 DM |
240 | // Delete all remaining files in the filepool owned by the component. |
241 | $fs = get_file_storage(); | |
242 | $fs->delete_component_files($component); | |
243 | ||
5718a123 DM |
244 | // Finally purge all caches. |
245 | purge_all_caches(); | |
246 | ||
82b1cf00 PS |
247 | // Invalidate the hash used for upgrade detections. |
248 | set_config('allversionshash', ''); | |
249 | ||
ed996ede | 250 | echo $OUTPUT->notification(get_string('success'), 'notifysuccess'); |
251 | } | |
252 | ||
e243c8c4 DM |
253 | /** |
254 | * Returns the version of installed component | |
255 | * | |
256 | * @param string $component component name | |
257 | * @param string $source either 'disk' or 'installed' - where to get the version information from | |
258 | * @return string|bool version number or false if the component is not found | |
259 | */ | |
260 | function get_component_version($component, $source='installed') { | |
261 | global $CFG, $DB; | |
262 | ||
56da374e | 263 | list($type, $name) = core_component::normalize_component($component); |
e243c8c4 DM |
264 | |
265 | // moodle core or a core subsystem | |
266 | if ($type === 'core') { | |
267 | if ($source === 'installed') { | |
268 | if (empty($CFG->version)) { | |
269 | return false; | |
270 | } else { | |
271 | return $CFG->version; | |
272 | } | |
273 | } else { | |
274 | if (!is_readable($CFG->dirroot.'/version.php')) { | |
275 | return false; | |
276 | } else { | |
9a8abf13 | 277 | $version = null; //initialize variable for IDEs |
e243c8c4 DM |
278 | include($CFG->dirroot.'/version.php'); |
279 | return $version; | |
280 | } | |
281 | } | |
282 | } | |
283 | ||
284 | // activity module | |
285 | if ($type === 'mod') { | |
286 | if ($source === 'installed') { | |
5f8012d4 PS |
287 | if ($CFG->version < 2013092001.02) { |
288 | return $DB->get_field('modules', 'version', array('name'=>$name)); | |
289 | } else { | |
290 | return get_config('mod_'.$name, 'version'); | |
291 | } | |
292 | ||
e243c8c4 | 293 | } else { |
bd3b3bba | 294 | $mods = core_component::get_plugin_list('mod'); |
d361c804 | 295 | if (empty($mods[$name]) or !is_readable($mods[$name].'/version.php')) { |
e243c8c4 DM |
296 | return false; |
297 | } else { | |
bde002b8 PS |
298 | $plugin = new stdClass(); |
299 | $plugin->version = null; | |
300 | $module = $plugin; | |
d361c804 | 301 | include($mods[$name].'/version.php'); |
bde002b8 | 302 | return $plugin->version; |
e243c8c4 DM |
303 | } |
304 | } | |
305 | } | |
306 | ||
307 | // block | |
308 | if ($type === 'block') { | |
309 | if ($source === 'installed') { | |
c66b839a PS |
310 | if ($CFG->version < 2013092001.02) { |
311 | return $DB->get_field('block', 'version', array('name'=>$name)); | |
312 | } else { | |
313 | return get_config('block_'.$name, 'version'); | |
314 | } | |
e243c8c4 | 315 | } else { |
bd3b3bba | 316 | $blocks = core_component::get_plugin_list('block'); |
e243c8c4 DM |
317 | if (empty($blocks[$name]) or !is_readable($blocks[$name].'/version.php')) { |
318 | return false; | |
319 | } else { | |
320 | $plugin = new stdclass(); | |
321 | include($blocks[$name].'/version.php'); | |
322 | return $plugin->version; | |
323 | } | |
324 | } | |
325 | } | |
326 | ||
327 | // all other plugin types | |
328 | if ($source === 'installed') { | |
329 | return get_config($type.'_'.$name, 'version'); | |
330 | } else { | |
bd3b3bba | 331 | $plugins = core_component::get_plugin_list($type); |
e243c8c4 DM |
332 | if (empty($plugins[$name])) { |
333 | return false; | |
334 | } else { | |
335 | $plugin = new stdclass(); | |
336 | include($plugins[$name].'/version.php'); | |
337 | return $plugin->version; | |
338 | } | |
339 | } | |
340 | } | |
341 | ||
b1f93b15 | 342 | /** |
343 | * Delete all plugin tables | |
db26acd4 | 344 | * |
db26acd4 | 345 | * @param string $name Name of plugin, used as table prefix |
346 | * @param string $file Path to install.xml file | |
347 | * @param bool $feedback defaults to true | |
0c079f19 | 348 | * @return bool Always returns true |
b1f93b15 | 349 | */ |
350 | function drop_plugin_tables($name, $file, $feedback=true) { | |
351 | global $CFG, $DB; | |
352 | ||
353 | // first try normal delete | |
8b4ca8f7 | 354 | if (file_exists($file) and $DB->get_manager()->delete_tables_from_xmldb_file($file)) { |
b1f93b15 | 355 | return true; |
356 | } | |
357 | ||
358 | // then try to find all tables that start with name and are not in any xml file | |
359 | $used_tables = get_used_table_names(); | |
360 | ||
361 | $tables = $DB->get_tables(); | |
362 | ||
363 | /// Iterate over, fixing id fields as necessary | |
364 | foreach ($tables as $table) { | |
365 | if (in_array($table, $used_tables)) { | |
366 | continue; | |
367 | } | |
368 | ||
8b4ca8f7 | 369 | if (strpos($table, $name) !== 0) { |
370 | continue; | |
371 | } | |
372 | ||
b1f93b15 | 373 | // found orphan table --> delete it |
374 | if ($DB->get_manager()->table_exists($table)) { | |
375 | $xmldb_table = new xmldb_table($table); | |
eee5d9bb | 376 | $DB->get_manager()->drop_table($xmldb_table); |
b1f93b15 | 377 | } |
378 | } | |
379 | ||
380 | return true; | |
381 | } | |
382 | ||
383 | /** | |
875e5f07 | 384 | * Returns names of all known tables == tables that moodle knows about. |
db26acd4 | 385 | * |
386 | * @return array Array of lowercase table names | |
b1f93b15 | 387 | */ |
388 | function get_used_table_names() { | |
389 | $table_names = array(); | |
390 | $dbdirs = get_db_directories(); | |
391 | ||
392 | foreach ($dbdirs as $dbdir) { | |
393 | $file = $dbdir.'/install.xml'; | |
394 | ||
395 | $xmldb_file = new xmldb_file($file); | |
396 | ||
397 | if (!$xmldb_file->fileExists()) { | |
398 | continue; | |
399 | } | |
400 | ||
401 | $loaded = $xmldb_file->loadXMLStructure(); | |
73fa96d5 | 402 | $structure = $xmldb_file->getStructure(); |
b1f93b15 | 403 | |
404 | if ($loaded and $tables = $structure->getTables()) { | |
405 | foreach($tables as $table) { | |
afe1cf72 | 406 | $table_names[] = strtolower($table->getName()); |
b1f93b15 | 407 | } |
408 | } | |
409 | } | |
410 | ||
411 | return $table_names; | |
412 | } | |
413 | ||
414 | /** | |
415 | * Returns list of all directories where we expect install.xml files | |
db26acd4 | 416 | * @return array Array of paths |
b1f93b15 | 417 | */ |
418 | function get_db_directories() { | |
419 | global $CFG; | |
420 | ||
421 | $dbdirs = array(); | |
422 | ||
9baf6825 | 423 | /// First, the main one (lib/db) |
b1f93b15 | 424 | $dbdirs[] = $CFG->libdir.'/db'; |
425 | ||
46f6f7f2 PS |
426 | /// Then, all the ones defined by core_component::get_plugin_types() |
427 | $plugintypes = core_component::get_plugin_types(); | |
17da2e6f | 428 | foreach ($plugintypes as $plugintype => $pluginbasedir) { |
bd3b3bba | 429 | if ($plugins = core_component::get_plugin_list($plugintype)) { |
17da2e6f | 430 | foreach ($plugins as $plugin => $plugindir) { |
431 | $dbdirs[] = $plugindir.'/db'; | |
76b6c644 | 432 | } |
b91b274b | 433 | } |
7cdd8b22 | 434 | } |
b1f93b15 | 435 | |
b1f93b15 | 436 | return $dbdirs; |
437 | } | |
438 | ||
eef868d1 | 439 | /** |
61460dd6 | 440 | * Try to obtain or release the cron lock. |
61460dd6 | 441 | * @param string $name name of lock |
875e5f07 PS |
442 | * @param int $until timestamp when this lock considered stale, null means remove lock unconditionally |
443 | * @param bool $ignorecurrent ignore current lock state, usually extend previous lock, defaults to false | |
61460dd6 | 444 | * @return bool true if lock obtained |
f3221af9 | 445 | */ |
61460dd6 | 446 | function set_cron_lock($name, $until, $ignorecurrent=false) { |
f33e1ed4 | 447 | global $DB; |
f3221af9 | 448 | if (empty($name)) { |
61460dd6 | 449 | debugging("Tried to get a cron lock for a null fieldname"); |
f3221af9 | 450 | return false; |
451 | } | |
452 | ||
61460dd6 | 453 | // remove lock by force == remove from config table |
454 | if (is_null($until)) { | |
455 | set_config($name, null); | |
f3221af9 | 456 | return true; |
457 | } | |
458 | ||
61460dd6 | 459 | if (!$ignorecurrent) { |
3e7069e7 | 460 | // read value from db - other processes might have changed it |
f33e1ed4 | 461 | $value = $DB->get_field('config', 'value', array('name'=>$name)); |
61460dd6 | 462 | |
463 | if ($value and $value > time()) { | |
3e7069e7 | 464 | //lock active |
61460dd6 | 465 | return false; |
f3221af9 | 466 | } |
467 | } | |
61460dd6 | 468 | |
469 | set_config($name, $until); | |
f3221af9 | 470 | return true; |
471 | } | |
a597f8a8 | 472 | |
bba0beae | 473 | /** |
474 | * Test if and critical warnings are present | |
475 | * @return bool | |
476 | */ | |
477 | function admin_critical_warnings_present() { | |
478 | global $SESSION; | |
479 | ||
b0c6dc1c | 480 | if (!has_capability('moodle/site:config', context_system::instance())) { |
bba0beae | 481 | return 0; |
482 | } | |
483 | ||
484 | if (!isset($SESSION->admin_critical_warning)) { | |
485 | $SESSION->admin_critical_warning = 0; | |
fbf2c91e | 486 | if (is_dataroot_insecure(true) === INSECURE_DATAROOT_ERROR) { |
bba0beae | 487 | $SESSION->admin_critical_warning = 1; |
488 | } | |
489 | } | |
490 | ||
491 | return $SESSION->admin_critical_warning; | |
492 | } | |
493 | ||
61f9c4b4 | 494 | /** |
db26acd4 | 495 | * Detects if float supports at least 10 decimal digits |
496 | * | |
875e5f07 | 497 | * Detects if float supports at least 10 decimal digits |
61f9c4b4 | 498 | * and also if float-->string conversion works as expected. |
db26acd4 | 499 | * |
61f9c4b4 | 500 | * @return bool true if problem found |
501 | */ | |
502 | function is_float_problem() { | |
503 | $num1 = 2009010200.01; | |
504 | $num2 = 2009010200.02; | |
505 | ||
506 | return ((string)$num1 === (string)$num2 or $num1 === $num2 or $num2 <= (string)$num1); | |
507 | } | |
508 | ||
57e35f32 | 509 | /** |
510 | * Try to verify that dataroot is not accessible from web. | |
57e35f32 | 511 | * |
db26acd4 | 512 | * Try to verify that dataroot is not accessible from web. |
513 | * It is not 100% correct but might help to reduce number of vulnerable sites. | |
57e35f32 | 514 | * Protection from httpd.conf and .htaccess is not detected properly. |
0c079f19 | 515 | * |
db26acd4 | 516 | * @uses INSECURE_DATAROOT_WARNING |
517 | * @uses INSECURE_DATAROOT_ERROR | |
518 | * @param bool $fetchtest try to test public access by fetching file, default false | |
875e5f07 | 519 | * @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic |
57e35f32 | 520 | */ |
bba0beae | 521 | function is_dataroot_insecure($fetchtest=false) { |
57e35f32 | 522 | global $CFG; |
523 | ||
524 | $siteroot = str_replace('\\', '/', strrev($CFG->dirroot.'/')); // win32 backslash workaround | |
525 | ||
526 | $rp = preg_replace('|https?://[^/]+|i', '', $CFG->wwwroot, 1); | |
527 | $rp = strrev(trim($rp, '/')); | |
528 | $rp = explode('/', $rp); | |
529 | foreach($rp as $r) { | |
530 | if (strpos($siteroot, '/'.$r.'/') === 0) { | |
531 | $siteroot = substr($siteroot, strlen($r)+1); // moodle web in subdirectory | |
532 | } else { | |
533 | break; // probably alias root | |
534 | } | |
535 | } | |
536 | ||
537 | $siteroot = strrev($siteroot); | |
538 | $dataroot = str_replace('\\', '/', $CFG->dataroot.'/'); | |
539 | ||
bba0beae | 540 | if (strpos($dataroot, $siteroot) !== 0) { |
541 | return false; | |
542 | } | |
543 | ||
544 | if (!$fetchtest) { | |
545 | return INSECURE_DATAROOT_WARNING; | |
546 | } | |
547 | ||
548 | // now try all methods to fetch a test file using http protocol | |
549 | ||
550 | $httpdocroot = str_replace('\\', '/', strrev($CFG->dirroot.'/')); | |
551 | preg_match('|(https?://[^/]+)|i', $CFG->wwwroot, $matches); | |
552 | $httpdocroot = $matches[1]; | |
553 | $datarooturl = $httpdocroot.'/'. substr($dataroot, strlen($siteroot)); | |
71904f4d | 554 | make_upload_directory('diag'); |
bba0beae | 555 | $testfile = $CFG->dataroot.'/diag/public.txt'; |
556 | if (!file_exists($testfile)) { | |
557 | file_put_contents($testfile, 'test file, do not delete'); | |
eb459f71 | 558 | @chmod($testfile, $CFG->filepermissions); |
bba0beae | 559 | } |
560 | $teststr = trim(file_get_contents($testfile)); | |
561 | if (empty($teststr)) { | |
9baf6825 | 562 | // hmm, strange |
bba0beae | 563 | return INSECURE_DATAROOT_WARNING; |
564 | } | |
565 | ||
566 | $testurl = $datarooturl.'/diag/public.txt'; | |
041a4b0f | 567 | if (extension_loaded('curl') and |
568 | !(stripos(ini_get('disable_functions'), 'curl_init') !== FALSE) and | |
569 | !(stripos(ini_get('disable_functions'), 'curl_setop') !== FALSE) and | |
570 | ($ch = @curl_init($testurl)) !== false) { | |
bba0beae | 571 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); |
572 | curl_setopt($ch, CURLOPT_HEADER, false); | |
573 | $data = curl_exec($ch); | |
574 | if (!curl_errno($ch)) { | |
575 | $data = trim($data); | |
576 | if ($data === $teststr) { | |
577 | curl_close($ch); | |
578 | return INSECURE_DATAROOT_ERROR; | |
579 | } | |
580 | } | |
581 | curl_close($ch); | |
582 | } | |
583 | ||
584 | if ($data = @file_get_contents($testurl)) { | |
585 | $data = trim($data); | |
586 | if ($data === $teststr) { | |
587 | return INSECURE_DATAROOT_ERROR; | |
588 | } | |
589 | } | |
590 | ||
591 | preg_match('|https?://([^/]+)|i', $testurl, $matches); | |
592 | $sitename = $matches[1]; | |
593 | $error = 0; | |
594 | if ($fp = @fsockopen($sitename, 80, $error)) { | |
595 | preg_match('|https?://[^/]+(.*)|i', $testurl, $matches); | |
596 | $localurl = $matches[1]; | |
597 | $out = "GET $localurl HTTP/1.1\r\n"; | |
598 | $out .= "Host: $sitename\r\n"; | |
599 | $out .= "Connection: Close\r\n\r\n"; | |
600 | fwrite($fp, $out); | |
601 | $data = ''; | |
602 | $incoming = false; | |
603 | while (!feof($fp)) { | |
604 | if ($incoming) { | |
605 | $data .= fgets($fp, 1024); | |
606 | } else if (@fgets($fp, 1024) === "\r\n") { | |
9baf6825 | 607 | $incoming = true; |
608 | } | |
bba0beae | 609 | } |
610 | fclose($fp); | |
611 | $data = trim($data); | |
612 | if ($data === $teststr) { | |
613 | return INSECURE_DATAROOT_ERROR; | |
614 | } | |
57e35f32 | 615 | } |
bba0beae | 616 | |
617 | return INSECURE_DATAROOT_WARNING; | |
57e35f32 | 618 | } |
6e4dc10f | 619 | |
48e114a5 PS |
620 | /** |
621 | * Enables CLI maintenance mode by creating new dataroot/climaintenance.html file. | |
622 | */ | |
623 | function enable_cli_maintenance_mode() { | |
624 | global $CFG; | |
625 | ||
626 | if (file_exists("$CFG->dataroot/climaintenance.html")) { | |
627 | unlink("$CFG->dataroot/climaintenance.html"); | |
628 | } | |
629 | ||
630 | if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) { | |
631 | $data = $CFG->maintenance_message; | |
632 | $data = bootstrap_renderer::early_error_content($data, null, null, null); | |
633 | $data = bootstrap_renderer::plain_page(get_string('sitemaintenance', 'admin'), $data); | |
634 | ||
635 | } else if (file_exists("$CFG->dataroot/climaintenance.template.html")) { | |
636 | $data = file_get_contents("$CFG->dataroot/climaintenance.template.html"); | |
637 | ||
638 | } else { | |
639 | $data = get_string('sitemaintenance', 'admin'); | |
640 | $data = bootstrap_renderer::early_error_content($data, null, null, null); | |
641 | $data = bootstrap_renderer::plain_page(get_string('sitemaintenance', 'admin'), $data); | |
642 | } | |
643 | ||
644 | file_put_contents("$CFG->dataroot/climaintenance.html", $data); | |
645 | chmod("$CFG->dataroot/climaintenance.html", $CFG->filepermissions); | |
646 | } | |
647 | ||
6e4dc10f | 648 | /// CLASS DEFINITIONS ///////////////////////////////////////////////////////// |
649 | ||
3e7069e7 | 650 | |
6e4dc10f | 651 | /** |
875e5f07 | 652 | * Interface for anything appearing in the admin tree |
6e4dc10f | 653 | * |
875e5f07 | 654 | * The interface that is implemented by anything that appears in the admin tree |
6e4dc10f | 655 | * block. It forces inheriting classes to define a method for checking user permissions |
656 | * and methods for finding something in the admin tree. | |
657 | * | |
db26acd4 | 658 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
6e4dc10f | 659 | */ |
73fa96d5 | 660 | interface part_of_admin_tree { |
6e4dc10f | 661 | |
9baf6825 | 662 | /** |
663 | * Finds a named part_of_admin_tree. | |
664 | * | |
665 | * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree | |
666 | * and not parentable_part_of_admin_tree, then this function should only check if | |
667 | * $this->name matches $name. If it does, it should return a reference to $this, | |
668 | * otherwise, it should return a reference to NULL. | |
669 | * | |
670 | * If a class inherits parentable_part_of_admin_tree, this method should be called | |
671 | * recursively on all child objects (assuming, of course, the parent object's name | |
672 | * doesn't match the search criterion). | |
673 | * | |
674 | * @param string $name The internal name of the part_of_admin_tree we're searching for. | |
675 | * @return mixed An object reference or a NULL reference. | |
676 | */ | |
73fa96d5 | 677 | public function locate($name); |
4672d955 | 678 | |
679 | /** | |
680 | * Removes named part_of_admin_tree. | |
681 | * | |
682 | * @param string $name The internal name of the part_of_admin_tree we want to remove. | |
a8a66c96 | 683 | * @return bool success. |
4672d955 | 684 | */ |
73fa96d5 | 685 | public function prune($name); |
4672d955 | 686 | |
220a90c5 | 687 | /** |
688 | * Search using query | |
db26acd4 | 689 | * @param string $query |
220a90c5 | 690 | * @return mixed array-object structure of found settings and pages |
691 | */ | |
73fa96d5 | 692 | public function search($query); |
220a90c5 | 693 | |
6e4dc10f | 694 | /** |
695 | * Verifies current user's access to this part_of_admin_tree. | |
696 | * | |
697 | * Used to check if the current user has access to this part of the admin tree or | |
698 | * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, | |
699 | * then this method is usually just a call to has_capability() in the site context. | |
700 | * | |
701 | * If a class inherits parentable_part_of_admin_tree, this method should return the | |
702 | * logical OR of the return of check_access() on all child objects. | |
703 | * | |
704 | * @return bool True if the user has access, false if she doesn't. | |
705 | */ | |
73fa96d5 | 706 | public function check_access(); |
eef868d1 | 707 | |
a8a66c96 | 708 | /** |
875e5f07 | 709 | * Mostly useful for removing of some parts of the tree in admin tree block. |
a8a66c96 | 710 | * |
711 | * @return True is hidden from normal list view | |
712 | */ | |
73fa96d5 | 713 | public function is_hidden(); |
427649bf PS |
714 | |
715 | /** | |
716 | * Show we display Save button at the page bottom? | |
717 | * @return bool | |
718 | */ | |
719 | public function show_save(); | |
6e4dc10f | 720 | } |
721 | ||
3e7069e7 | 722 | |
6e4dc10f | 723 | /** |
875e5f07 | 724 | * Interface implemented by any part_of_admin_tree that has children. |
6e4dc10f | 725 | * |
875e5f07 | 726 | * The interface implemented by any part_of_admin_tree that can be a parent |
6e4dc10f | 727 | * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart |
eef868d1 | 728 | * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods |
6e4dc10f | 729 | * include an add method for adding other part_of_admin_tree objects as children. |
730 | * | |
db26acd4 | 731 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
6e4dc10f | 732 | */ |
73fa96d5 | 733 | interface parentable_part_of_admin_tree extends part_of_admin_tree { |
eef868d1 | 734 | |
9baf6825 | 735 | /** |
736 | * Adds a part_of_admin_tree object to the admin tree. | |
737 | * | |
738 | * Used to add a part_of_admin_tree object to this object or a child of this | |
739 | * object. $something should only be added if $destinationname matches | |
740 | * $this->name. If it doesn't, add should be called on child objects that are | |
741 | * also parentable_part_of_admin_tree's. | |
742 | * | |
f6e85ab0 DM |
743 | * $something should be appended as the last child in the $destinationname. If the |
744 | * $beforesibling is specified, $something should be prepended to it. If the given | |
745 | * sibling is not found, $something should be appended to the end of $destinationname | |
746 | * and a developer debugging message should be displayed. | |
747 | * | |
9baf6825 | 748 | * @param string $destinationname The internal name of the new parent for $something. |
749 | * @param part_of_admin_tree $something The object to be added. | |
750 | * @return bool True on success, false on failure. | |
751 | */ | |
f6e85ab0 | 752 | public function add($destinationname, $something, $beforesibling = null); |
eef868d1 | 753 | |
6e4dc10f | 754 | } |
755 | ||
3e7069e7 | 756 | |
6e4dc10f | 757 | /** |
758 | * The object used to represent folders (a.k.a. categories) in the admin tree block. | |
eef868d1 | 759 | * |
6e4dc10f | 760 | * Each admin_category object contains a number of part_of_admin_tree objects. |
761 | * | |
db26acd4 | 762 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
6e4dc10f | 763 | */ |
73fa96d5 | 764 | class admin_category implements parentable_part_of_admin_tree { |
6e4dc10f | 765 | |
cea3b7eb SH |
766 | /** @var part_of_admin_tree[] An array of part_of_admin_tree objects that are this object's children */ |
767 | protected $children; | |
0c079f19 | 768 | /** @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects */ |
73fa96d5 | 769 | public $name; |
0c079f19 | 770 | /** @var string The displayed name for this category. Usually obtained through get_string() */ |
73fa96d5 | 771 | public $visiblename; |
0c079f19 | 772 | /** @var bool Should this category be hidden in admin tree block? */ |
73fa96d5 | 773 | public $hidden; |
0c079f19 | 774 | /** @var mixed Either a string or an array or strings */ |
73fa96d5 | 775 | public $path; |
0c079f19 | 776 | /** @var mixed Either a string or an array or strings */ |
73fa96d5 | 777 | public $visiblepath; |
6e4dc10f | 778 | |
cde44edc PS |
779 | /** @var array fast lookup category cache, all categories of one tree point to one cache */ |
780 | protected $category_cache; | |
781 | ||
cea3b7eb SH |
782 | /** @var bool If set to true children will be sorted when calling {@link admin_category::get_children()} */ |
783 | protected $sort = false; | |
784 | /** @var bool If set to true children will be sorted in ascending order. */ | |
785 | protected $sortasc = true; | |
786 | /** @var bool If set to true sub categories and pages will be split and then sorted.. */ | |
787 | protected $sortsplit = true; | |
788 | /** @var bool $sorted True if the children have been sorted and don't need resorting */ | |
789 | protected $sorted = false; | |
790 | ||
6e4dc10f | 791 | /** |
792 | * Constructor for an empty admin category | |
793 | * | |
794 | * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects | |
795 | * @param string $visiblename The displayed named for this category. Usually obtained through get_string() | |
db26acd4 | 796 | * @param bool $hidden hide category in admin tree block, defaults to false |
6e4dc10f | 797 | */ |
73fa96d5 | 798 | public function __construct($name, $visiblename, $hidden=false) { |
220a90c5 | 799 | $this->children = array(); |
800 | $this->name = $name; | |
6e4dc10f | 801 | $this->visiblename = $visiblename; |
220a90c5 | 802 | $this->hidden = $hidden; |
6e4dc10f | 803 | } |
eef868d1 | 804 | |
6e4dc10f | 805 | /** |
220a90c5 | 806 | * Returns a reference to the part_of_admin_tree object with internal name $name. |
6e4dc10f | 807 | * |
220a90c5 | 808 | * @param string $name The internal name of the object we want. |
809 | * @param bool $findpath initialize path and visiblepath arrays | |
0c079f19 | 810 | * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. |
db26acd4 | 811 | * defaults to false |
6e4dc10f | 812 | */ |
73fa96d5 | 813 | public function locate($name, $findpath=false) { |
42b53d46 | 814 | if (!isset($this->category_cache[$this->name])) { |
cde44edc PS |
815 | // somebody much have purged the cache |
816 | $this->category_cache[$this->name] = $this; | |
817 | } | |
818 | ||
6e4dc10f | 819 | if ($this->name == $name) { |
220a90c5 | 820 | if ($findpath) { |
821 | $this->visiblepath[] = $this->visiblename; | |
822 | $this->path[] = $this->name; | |
823 | } | |
824 | return $this; | |
6e4dc10f | 825 | } |
eef868d1 | 826 | |
cde44edc | 827 | // quick category lookup |
42b53d46 | 828 | if (!$findpath and isset($this->category_cache[$name])) { |
cde44edc PS |
829 | return $this->category_cache[$name]; |
830 | } | |
831 | ||
220a90c5 | 832 | $return = NULL; |
833 | foreach($this->children as $childid=>$unused) { | |
73fa96d5 | 834 | if ($return = $this->children[$childid]->locate($name, $findpath)) { |
220a90c5 | 835 | break; |
6e4dc10f | 836 | } |
837 | } | |
eef868d1 | 838 | |
220a90c5 | 839 | if (!is_null($return) and $findpath) { |
840 | $return->visiblepath[] = $this->visiblename; | |
841 | $return->path[] = $this->name; | |
842 | } | |
eef868d1 | 843 | |
220a90c5 | 844 | return $return; |
6e4dc10f | 845 | } |
846 | ||
847 | /** | |
220a90c5 | 848 | * Search using query |
db26acd4 | 849 | * |
850 | * @param string query | |
220a90c5 | 851 | * @return mixed array-object structure of found settings and pages |
6e4dc10f | 852 | */ |
73fa96d5 | 853 | public function search($query) { |
220a90c5 | 854 | $result = array(); |
cea3b7eb | 855 | foreach ($this->get_children() as $child) { |
3cea9c55 | 856 | $subsearch = $child->search($query); |
857 | if (!is_array($subsearch)) { | |
858 | debugging('Incorrect search result from '.$child->name); | |
859 | continue; | |
860 | } | |
861 | $result = array_merge($result, $subsearch); | |
6e4dc10f | 862 | } |
220a90c5 | 863 | return $result; |
6e4dc10f | 864 | } |
865 | ||
4672d955 | 866 | /** |
867 | * Removes part_of_admin_tree object with internal name $name. | |
868 | * | |
869 | * @param string $name The internal name of the object we want to remove. | |
a8a66c96 | 870 | * @return bool success |
4672d955 | 871 | */ |
73fa96d5 | 872 | public function prune($name) { |
4672d955 | 873 | |
874 | if ($this->name == $name) { | |
875 | return false; //can not remove itself | |
876 | } | |
877 | ||
878 | foreach($this->children as $precedence => $child) { | |
879 | if ($child->name == $name) { | |
cde44edc | 880 | // clear cache and delete self |
42b53d46 AN |
881 | while($this->category_cache) { |
882 | // delete the cache, but keep the original array address | |
883 | array_pop($this->category_cache); | |
cde44edc | 884 | } |
eef868d1 | 885 | unset($this->children[$precedence]); |
4672d955 | 886 | return true; |
cde44edc | 887 | } else if ($this->children[$precedence]->prune($name)) { |
4672d955 | 888 | return true; |
889 | } | |
890 | } | |
891 | return false; | |
892 | } | |
893 | ||
6e4dc10f | 894 | /** |
895 | * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object. | |
896 | * | |
f6e85ab0 DM |
897 | * By default the new part of the tree is appended as the last child of the parent. You |
898 | * can specify a sibling node that the new part should be prepended to. If the given | |
899 | * sibling is not found, the part is appended to the end (as it would be by default) and | |
900 | * a developer debugging message is displayed. | |
901 | * | |
902 | * @throws coding_exception if the $beforesibling is empty string or is not string at all. | |
220a90c5 | 903 | * @param string $destinationame The internal name of the immediate parent that we want for $something. |
875e5f07 | 904 | * @param mixed $something A part_of_admin_tree or setting instance to be added. |
f6e85ab0 | 905 | * @param string $beforesibling The name of the parent's child the $something should be prepended to. |
220a90c5 | 906 | * @return bool True if successfully added, false if $something can not be added. |
6e4dc10f | 907 | */ |
f6e85ab0 | 908 | public function add($parentname, $something, $beforesibling = null) { |
96f81ea3 PS |
909 | global $CFG; |
910 | ||
73fa96d5 | 911 | $parent = $this->locate($parentname); |
220a90c5 | 912 | if (is_null($parent)) { |
913 | debugging('parent does not exist!'); | |
6e4dc10f | 914 | return false; |
915 | } | |
916 | ||
73fa96d5 | 917 | if ($something instanceof part_of_admin_tree) { |
918 | if (!($parent instanceof parentable_part_of_admin_tree)) { | |
220a90c5 | 919 | debugging('error - parts of tree can be inserted only into parentable parts'); |
920 | return false; | |
6e4dc10f | 921 | } |
96f81ea3 | 922 | if ($CFG->debugdeveloper && !is_null($this->locate($something->name))) { |
97a8eddd FM |
923 | // The name of the node is already used, simply warn the developer that this should not happen. |
924 | // It is intentional to check for the debug level before performing the check. | |
925 | debugging('Duplicate admin page name: ' . $something->name, DEBUG_DEVELOPER); | |
926 | } | |
f6e85ab0 DM |
927 | if (is_null($beforesibling)) { |
928 | // Append $something as the parent's last child. | |
929 | $parent->children[] = $something; | |
930 | } else { | |
931 | if (!is_string($beforesibling) or trim($beforesibling) === '') { | |
932 | throw new coding_exception('Unexpected value of the beforesibling parameter'); | |
933 | } | |
934 | // Try to find the position of the sibling. | |
935 | $siblingposition = null; | |
936 | foreach ($parent->children as $childposition => $child) { | |
937 | if ($child->name === $beforesibling) { | |
938 | $siblingposition = $childposition; | |
939 | break; | |
940 | } | |
941 | } | |
942 | if (is_null($siblingposition)) { | |
943 | debugging('Sibling '.$beforesibling.' not found', DEBUG_DEVELOPER); | |
944 | $parent->children[] = $something; | |
945 | } else { | |
946 | $parent->children = array_merge( | |
947 | array_slice($parent->children, 0, $siblingposition), | |
948 | array($something), | |
949 | array_slice($parent->children, $siblingposition) | |
950 | ); | |
951 | } | |
952 | } | |
42b53d46 | 953 | if ($something instanceof admin_category) { |
cde44edc | 954 | if (isset($this->category_cache[$something->name])) { |
3e7069e7 | 955 | debugging('Duplicate admin category name: '.$something->name); |
cde44edc PS |
956 | } else { |
957 | $this->category_cache[$something->name] = $something; | |
958 | $something->category_cache =& $this->category_cache; | |
959 | foreach ($something->children as $child) { | |
960 | // just in case somebody already added subcategories | |
961 | if ($child instanceof admin_category) { | |
962 | if (isset($this->category_cache[$child->name])) { | |
3e7069e7 | 963 | debugging('Duplicate admin category name: '.$child->name); |
cde44edc PS |
964 | } else { |
965 | $this->category_cache[$child->name] = $child; | |
966 | $child->category_cache =& $this->category_cache; | |
967 | } | |
968 | } | |
969 | } | |
970 | } | |
971 | } | |
6e4dc10f | 972 | return true; |
eef868d1 | 973 | |
220a90c5 | 974 | } else { |
975 | debugging('error - can not add this element'); | |
976 | return false; | |
6e4dc10f | 977 | } |
eef868d1 | 978 | |
6e4dc10f | 979 | } |
eef868d1 | 980 | |
6e4dc10f | 981 | /** |
982 | * Checks if the user has access to anything in this category. | |
983 | * | |
875e5f07 | 984 | * @return bool True if the user has access to at least one child in this category, false otherwise. |
6e4dc10f | 985 | */ |
73fa96d5 | 986 | public function check_access() { |
6e4dc10f | 987 | foreach ($this->children as $child) { |
220a90c5 | 988 | if ($child->check_access()) { |
989 | return true; | |
990 | } | |
6e4dc10f | 991 | } |
220a90c5 | 992 | return false; |
6e4dc10f | 993 | } |
eef868d1 | 994 | |
a8a66c96 | 995 | /** |
996 | * Is this category hidden in admin tree block? | |
997 | * | |
998 | * @return bool True if hidden | |
999 | */ | |
73fa96d5 | 1000 | public function is_hidden() { |
a8a66c96 | 1001 | return $this->hidden; |
1002 | } | |
427649bf PS |
1003 | |
1004 | /** | |
1005 | * Show we display Save button at the page bottom? | |
1006 | * @return bool | |
1007 | */ | |
1008 | public function show_save() { | |
1009 | foreach ($this->children as $child) { | |
1010 | if ($child->show_save()) { | |
1011 | return true; | |
1012 | } | |
1013 | } | |
1014 | return false; | |
1015 | } | |
cea3b7eb SH |
1016 | |
1017 | /** | |
1018 | * Sets sorting on this category. | |
1019 | * | |
1020 | * Please note this function doesn't actually do the sorting. | |
1021 | * It can be called anytime. | |
1022 | * Sorting occurs when the user calls get_children. | |
1023 | * Code using the children array directly won't see the sorted results. | |
1024 | * | |
1025 | * @param bool $sort If set to true children will be sorted, if false they won't be. | |
1026 | * @param bool $asc If true sorting will be ascending, otherwise descending. | |
1027 | * @param bool $split If true we sort pages and sub categories separately. | |
1028 | */ | |
1029 | public function set_sorting($sort, $asc = true, $split = true) { | |
1030 | $this->sort = (bool)$sort; | |
1031 | $this->sortasc = (bool)$asc; | |
1032 | $this->sortsplit = (bool)$split; | |
1033 | } | |
1034 | ||
1035 | /** | |
1036 | * Returns the children associated with this category. | |
1037 | * | |
1038 | * @return part_of_admin_tree[] | |
1039 | */ | |
1040 | public function get_children() { | |
1041 | // If we should sort and it hasn't already been sorted. | |
1042 | if ($this->sort && !$this->sorted) { | |
1043 | if ($this->sortsplit) { | |
1044 | $categories = array(); | |
1045 | $pages = array(); | |
1046 | foreach ($this->children as $child) { | |
1047 | if ($child instanceof admin_category) { | |
1048 | $categories[] = $child; | |
1049 | } else { | |
1050 | $pages[] = $child; | |
1051 | } | |
1052 | } | |
1053 | core_collator::asort_objects_by_property($categories, 'visiblename'); | |
1054 | core_collator::asort_objects_by_property($pages, 'visiblename'); | |
1055 | if (!$this->sortasc) { | |
1056 | $categories = array_reverse($categories); | |
1057 | $pages = array_reverse($pages); | |
1058 | } | |
1059 | $this->children = array_merge($pages, $categories); | |
1060 | } else { | |
1061 | core_collator::asort_objects_by_property($this->children, 'visiblename'); | |
1062 | if (!$this->sortasc) { | |
1063 | $this->children = array_reverse($this->children); | |
1064 | } | |
1065 | } | |
1066 | $this->sorted = true; | |
1067 | } | |
1068 | return $this->children; | |
1069 | } | |
1070 | ||
1071 | /** | |
1072 | * Magically gets a property from this object. | |
1073 | * | |
1074 | * @param $property | |
1075 | * @return part_of_admin_tree[] | |
1076 | * @throws coding_exception | |
1077 | */ | |
1078 | public function __get($property) { | |
1079 | if ($property === 'children') { | |
1080 | return $this->get_children(); | |
1081 | } | |
1082 | throw new coding_exception('Invalid property requested.'); | |
1083 | } | |
1084 | ||
1085 | /** | |
1086 | * Magically sets a property against this object. | |
1087 | * | |
1088 | * @param string $property | |
1089 | * @param mixed $value | |
1090 | * @throws coding_exception | |
1091 | */ | |
1092 | public function __set($property, $value) { | |
1093 | if ($property === 'children') { | |
1094 | $this->sorted = false; | |
1095 | $this->children = $value; | |
1096 | } else { | |
1097 | throw new coding_exception('Invalid property requested.'); | |
1098 | } | |
1099 | } | |
1100 | ||
1101 | /** | |
1102 | * Checks if an inaccessible property is set. | |
1103 | * | |
1104 | * @param string $property | |
1105 | * @return bool | |
1106 | * @throws coding_exception | |
1107 | */ | |
1108 | public function __isset($property) { | |
1109 | if ($property === 'children') { | |
1110 | return isset($this->children); | |
1111 | } | |
1112 | throw new coding_exception('Invalid property requested.'); | |
1113 | } | |
6e4dc10f | 1114 | } |
1115 | ||
3e7069e7 | 1116 | |
db26acd4 | 1117 | /** |
0c079f19 | 1118 | * Root of admin settings tree, does not have any parent. |
db26acd4 | 1119 | * |
1120 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
db26acd4 | 1121 | */ |
220a90c5 | 1122 | class admin_root extends admin_category { |
9baf6825 | 1123 | /** @var array List of errors */ |
73fa96d5 | 1124 | public $errors; |
0c079f19 | 1125 | /** @var string search query */ |
73fa96d5 | 1126 | public $search; |
875e5f07 | 1127 | /** @var bool full tree flag - true means all settings required, false only pages required */ |
73fa96d5 | 1128 | public $fulltree; |
0c079f19 | 1129 | /** @var bool flag indicating loaded tree */ |
73fa96d5 | 1130 | public $loaded; |
875e5f07 | 1131 | /** @var mixed site custom defaults overriding defaults in settings files*/ |
cd3acbf2 | 1132 | public $custom_defaults; |
1133 | ||
db26acd4 | 1134 | /** |
0c079f19 | 1135 | * @param bool $fulltree true means all settings required, |
db26acd4 | 1136 | * false only pages required |
1137 | */ | |
73fa96d5 | 1138 | public function __construct($fulltree) { |
cd3acbf2 | 1139 | global $CFG; |
1140 | ||
73fa96d5 | 1141 | parent::__construct('root', get_string('administration'), false); |
220a90c5 | 1142 | $this->errors = array(); |
1143 | $this->search = ''; | |
73fa96d5 | 1144 | $this->fulltree = $fulltree; |
1145 | $this->loaded = false; | |
cd3acbf2 | 1146 | |
cde44edc PS |
1147 | $this->category_cache = array(); |
1148 | ||
cd3acbf2 | 1149 | // load custom defaults if found |
1150 | $this->custom_defaults = null; | |
1151 | $defaultsfile = "$CFG->dirroot/local/defaults.php"; | |
1152 | if (is_readable($defaultsfile)) { | |
1153 | $defaults = array(); | |
1154 | include($defaultsfile); | |
1155 | if (is_array($defaults) and count($defaults)) { | |
1156 | $this->custom_defaults = $defaults; | |
1157 | } | |
1158 | } | |
73fa96d5 | 1159 | } |
1160 | ||
db26acd4 | 1161 | /** |
1162 | * Empties children array, and sets loaded to false | |
1163 | * | |
1164 | * @param bool $requirefulltree | |
1165 | */ | |
73fa96d5 | 1166 | public function purge_children($requirefulltree) { |
1167 | $this->children = array(); | |
1168 | $this->fulltree = ($requirefulltree || $this->fulltree); | |
1169 | $this->loaded = false; | |
cde44edc PS |
1170 | //break circular dependencies - this helps PHP 5.2 |
1171 | while($this->category_cache) { | |
1172 | array_pop($this->category_cache); | |
1173 | } | |
1174 | $this->category_cache = array(); | |
220a90c5 | 1175 | } |
1176 | } | |
1177 | ||
3e7069e7 | 1178 | |
6e4dc10f | 1179 | /** |
1180 | * Links external PHP pages into the admin tree. | |
1181 | * | |
1182 | * See detailed usage example at the top of this document (adminlib.php) | |
1183 | * | |
db26acd4 | 1184 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
6e4dc10f | 1185 | */ |
73fa96d5 | 1186 | class admin_externalpage implements part_of_admin_tree { |
6e4dc10f | 1187 | |
3e7069e7 | 1188 | /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */ |
73fa96d5 | 1189 | public $name; |
eef868d1 | 1190 | |
0c079f19 | 1191 | /** @var string The displayed name for this external page. Usually obtained through get_string(). */ |
73fa96d5 | 1192 | public $visiblename; |
eef868d1 | 1193 | |
0c079f19 | 1194 | /** @var string The external URL that we should link to when someone requests this external page. */ |
73fa96d5 | 1195 | public $url; |
eef868d1 | 1196 | |
0c079f19 | 1197 | /** @var string The role capability/permission a user must have to access this external page. */ |
73fa96d5 | 1198 | public $req_capability; |
eef868d1 | 1199 | |
0c079f19 | 1200 | /** @var object The context in which capability/permission should be checked, default is site context. */ |
73fa96d5 | 1201 | public $context; |
84c8ede0 | 1202 | |
0c079f19 | 1203 | /** @var bool hidden in admin tree block. */ |
73fa96d5 | 1204 | public $hidden; |
a8a66c96 | 1205 | |
0c079f19 | 1206 | /** @var mixed either string or array of string */ |
73fa96d5 | 1207 | public $path; |
3e7069e7 PS |
1208 | |
1209 | /** @var array list of visible names of page parents */ | |
73fa96d5 | 1210 | public $visiblepath; |
220a90c5 | 1211 | |
6e4dc10f | 1212 | /** |
1213 | * Constructor for adding an external page into the admin tree. | |
1214 | * | |
1215 | * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. | |
1216 | * @param string $visiblename The displayed name for this external page. Usually obtained through get_string(). | |
1217 | * @param string $url The external URL that we should link to when someone requests this external page. | |
38d2d43b | 1218 | * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'. |
92f00846 | 1219 | * @param boolean $hidden Is this external page hidden in admin tree block? Default false. |
44d8a940 | 1220 | * @param stdClass $context The context the page relates to. Not sure what happens |
92f00846 | 1221 | * if you specify something other than system or front page. Defaults to system. |
6e4dc10f | 1222 | */ |
73fa96d5 | 1223 | public function __construct($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) { |
220a90c5 | 1224 | $this->name = $name; |
6e4dc10f | 1225 | $this->visiblename = $visiblename; |
220a90c5 | 1226 | $this->url = $url; |
38d2d43b | 1227 | if (is_array($req_capability)) { |
1228 | $this->req_capability = $req_capability; | |
1229 | } else { | |
1230 | $this->req_capability = array($req_capability); | |
1231 | } | |
92f00846 | 1232 | $this->hidden = $hidden; |
84c8ede0 | 1233 | $this->context = $context; |
6e4dc10f | 1234 | } |
eef868d1 | 1235 | |
6e4dc10f | 1236 | /** |
1237 | * Returns a reference to the part_of_admin_tree object with internal name $name. | |
1238 | * | |
1239 | * @param string $name The internal name of the object we want. | |
db26acd4 | 1240 | * @param bool $findpath defaults to false |
6e4dc10f | 1241 | * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. |
1242 | */ | |
73fa96d5 | 1243 | public function locate($name, $findpath=false) { |
220a90c5 | 1244 | if ($this->name == $name) { |
1245 | if ($findpath) { | |
1246 | $this->visiblepath = array($this->visiblename); | |
1247 | $this->path = array($this->name); | |
1248 | } | |
1249 | return $this; | |
1250 | } else { | |
1251 | $return = NULL; | |
1252 | return $return; | |
1253 | } | |
6e4dc10f | 1254 | } |
4672d955 | 1255 | |
db26acd4 | 1256 | /** |
1257 | * This function always returns false, required function by interface | |
1258 | * | |
1259 | * @param string $name | |
1260 | * @return false | |
1261 | */ | |
73fa96d5 | 1262 | public function prune($name) { |
4672d955 | 1263 | return false; |
1264 | } | |
1265 | ||
220a90c5 | 1266 | /** |
1267 | * Search using query | |
db26acd4 | 1268 | * |
1269 | * @param string $query | |
220a90c5 | 1270 | * @return mixed array-object structure of found settings and pages |
1271 | */ | |
73fa96d5 | 1272 | public function search($query) { |
220a90c5 | 1273 | $found = false; |
1274 | if (strpos(strtolower($this->name), $query) !== false) { | |
1275 | $found = true; | |
2f1e464a | 1276 | } else if (strpos(core_text::strtolower($this->visiblename), $query) !== false) { |
9baf6825 | 1277 | $found = true; |
1278 | } | |
220a90c5 | 1279 | if ($found) { |
365a5941 | 1280 | $result = new stdClass(); |
220a90c5 | 1281 | $result->page = $this; |
1282 | $result->settings = array(); | |
1283 | return array($this->name => $result); | |
1284 | } else { | |
1285 | return array(); | |
1286 | } | |
1287 | } | |
1288 | ||
6e4dc10f | 1289 | /** |
2ce38b70 | 1290 | * Determines if the current user has access to this external page based on $this->req_capability. |
db26acd4 | 1291 | * |
6e4dc10f | 1292 | * @return bool True if user has access, false otherwise. |
1293 | */ | |
73fa96d5 | 1294 | public function check_access() { |
1caea91e | 1295 | global $CFG; |
b0c6dc1c | 1296 | $context = empty($this->context) ? context_system::instance() : $this->context; |
38d2d43b | 1297 | foreach($this->req_capability as $cap) { |
4f0c2d00 | 1298 | if (has_capability($cap, $context)) { |
38d2d43b | 1299 | return true; |
1300 | } | |
1301 | } | |
1302 | return false; | |
6e4dc10f | 1303 | } |
1304 | ||
a8a66c96 | 1305 | /** |
1306 | * Is this external page hidden in admin tree block? | |
1307 | * | |
1308 | * @return bool True if hidden | |
1309 | */ | |
73fa96d5 | 1310 | public function is_hidden() { |
a8a66c96 | 1311 | return $this->hidden; |
1312 | } | |
1313 | ||
427649bf PS |
1314 | /** |
1315 | * Show we display Save button at the page bottom? | |
1316 | * @return bool | |
1317 | */ | |
1318 | public function show_save() { | |
1319 | return false; | |
1320 | } | |
6e4dc10f | 1321 | } |
1322 | ||
3e7069e7 | 1323 | |
6e4dc10f | 1324 | /** |
1325 | * Used to group a number of admin_setting objects into a page and add them to the admin tree. | |
1326 | * | |
db26acd4 | 1327 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
6e4dc10f | 1328 | */ |
73fa96d5 | 1329 | class admin_settingpage implements part_of_admin_tree { |
6e4dc10f | 1330 | |
3e7069e7 | 1331 | /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */ |
73fa96d5 | 1332 | public $name; |
eef868d1 | 1333 | |
0c079f19 | 1334 | /** @var string The displayed name for this external page. Usually obtained through get_string(). */ |
73fa96d5 | 1335 | public $visiblename; |
0c079f19 | 1336 | |
1337 | /** @var mixed An array of admin_setting objects that are part of this setting page. */ | |
73fa96d5 | 1338 | public $settings; |
eef868d1 | 1339 | |
0c079f19 | 1340 | /** @var string The role capability/permission a user must have to access this external page. */ |
73fa96d5 | 1341 | public $req_capability; |
eef868d1 | 1342 | |
0c079f19 | 1343 | /** @var object The context in which capability/permission should be checked, default is site context. */ |
73fa96d5 | 1344 | public $context; |
84c8ede0 | 1345 | |
0c079f19 | 1346 | /** @var bool hidden in admin tree block. */ |
73fa96d5 | 1347 | public $hidden; |
a8a66c96 | 1348 | |
0c079f19 | 1349 | /** @var mixed string of paths or array of strings of paths */ |
73fa96d5 | 1350 | public $path; |
3e7069e7 PS |
1351 | |
1352 | /** @var array list of visible names of page parents */ | |
73fa96d5 | 1353 | public $visiblepath; |
220a90c5 | 1354 | |
db26acd4 | 1355 | /** |
1356 | * see admin_settingpage for details of this function | |
0c079f19 | 1357 | * |
db26acd4 | 1358 | * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. |
1359 | * @param string $visiblename The displayed name for this external page. Usually obtained through get_string(). | |
1360 | * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'. | |
1361 | * @param boolean $hidden Is this external page hidden in admin tree block? Default false. | |
44d8a940 | 1362 | * @param stdClass $context The context the page relates to. Not sure what happens |
db26acd4 | 1363 | * if you specify something other than system or front page. Defaults to system. |
1364 | */ | |
73fa96d5 | 1365 | public function __construct($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) { |
365a5941 | 1366 | $this->settings = new stdClass(); |
220a90c5 | 1367 | $this->name = $name; |
1368 | $this->visiblename = $visiblename; | |
1369 | if (is_array($req_capability)) { | |
1370 | $this->req_capability = $req_capability; | |
6e4dc10f | 1371 | } else { |
220a90c5 | 1372 | $this->req_capability = array($req_capability); |
6e4dc10f | 1373 | } |
220a90c5 | 1374 | $this->hidden = $hidden; |
1375 | $this->context = $context; | |
6e4dc10f | 1376 | } |
eef868d1 | 1377 | |
0c079f19 | 1378 | /** |
db26acd4 | 1379 | * see admin_category |
1380 | * | |
1381 | * @param string $name | |
1382 | * @param bool $findpath | |
1383 | * @return mixed Object (this) if name == this->name, else returns null | |
1384 | */ | |
73fa96d5 | 1385 | public function locate($name, $findpath=false) { |
220a90c5 | 1386 | if ($this->name == $name) { |
1387 | if ($findpath) { | |
1388 | $this->visiblepath = array($this->visiblename); | |
1389 | $this->path = array($this->name); | |
1390 | } | |
1391 | return $this; | |
1392 | } else { | |
1393 | $return = NULL; | |
1394 | return $return; | |
1395 | } | |
6e4dc10f | 1396 | } |
4672d955 | 1397 | |
0c079f19 | 1398 | /** |
1399 | * Search string in settings page. | |
1400 | * | |
db26acd4 | 1401 | * @param string $query |
1402 | * @return array | |
1403 | */ | |
73fa96d5 | 1404 | public function search($query) { |
220a90c5 | 1405 | $found = array(); |
4672d955 | 1406 | |
220a90c5 | 1407 | foreach ($this->settings as $setting) { |
1408 | if ($setting->is_related($query)) { | |
1409 | $found[] = $setting; | |
1410 | } | |
1411 | } | |
1412 | ||
1413 | if ($found) { | |
365a5941 | 1414 | $result = new stdClass(); |
220a90c5 | 1415 | $result->page = $this; |
1416 | $result->settings = $found; | |
1417 | return array($this->name => $result); | |
1418 | } | |
1419 | ||
220a90c5 | 1420 | $found = false; |
1421 | if (strpos(strtolower($this->name), $query) !== false) { | |
1422 | $found = true; | |
2f1e464a | 1423 | } else if (strpos(core_text::strtolower($this->visiblename), $query) !== false) { |
9baf6825 | 1424 | $found = true; |
1425 | } | |
220a90c5 | 1426 | if ($found) { |
365a5941 | 1427 | $result = new stdClass(); |
220a90c5 | 1428 | $result->page = $this; |
1429 | $result->settings = array(); | |
1430 | return array($this->name => $result); | |
38d2d43b | 1431 | } else { |
220a90c5 | 1432 | return array(); |
38d2d43b | 1433 | } |
6e4dc10f | 1434 | } |
eef868d1 | 1435 | |
db26acd4 | 1436 | /** |
1437 | * This function always returns false, required by interface | |
1438 | * | |
1439 | * @param string $name | |
1440 | * @return bool Always false | |
1441 | */ | |
73fa96d5 | 1442 | public function prune($name) { |
6e4dc10f | 1443 | return false; |
1444 | } | |
eef868d1 | 1445 | |
220a90c5 | 1446 | /** |
db26acd4 | 1447 | * adds an admin_setting to this admin_settingpage |
1448 | * | |
220a90c5 | 1449 | * 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 |
1450 | * n.b. each admin_setting in an admin_settingpage must have a unique internal name | |
db26acd4 | 1451 | * |
220a90c5 | 1452 | * @param object $setting is the admin_setting object you want to add |
db26acd4 | 1453 | * @return bool true if successful, false if not |
220a90c5 | 1454 | */ |
73fa96d5 | 1455 | public function add($setting) { |
1456 | if (!($setting instanceof admin_setting)) { | |
220a90c5 | 1457 | debugging('error - not a setting instance'); |
1458 | return false; | |
1459 | } | |
1460 | ||
69d66020 DM |
1461 | $name = $setting->name; |
1462 | if ($setting->plugin) { | |
1463 | $name = $setting->plugin . $name; | |
1464 | } | |
1465 | $this->settings->{$name} = $setting; | |
220a90c5 | 1466 | return true; |
1467 | } | |
1468 | ||
db26acd4 | 1469 | /** |
1470 | * see admin_externalpage | |
1471 | * | |
1472 | * @return bool Returns true for yes false for no | |
1473 | */ | |
73fa96d5 | 1474 | public function check_access() { |
1caea91e | 1475 | global $CFG; |
b0c6dc1c | 1476 | $context = empty($this->context) ? context_system::instance() : $this->context; |
38d2d43b | 1477 | foreach($this->req_capability as $cap) { |
4f0c2d00 | 1478 | if (has_capability($cap, $context)) { |
38d2d43b | 1479 | return true; |
1480 | } | |
1481 | } | |
1482 | return false; | |
6e4dc10f | 1483 | } |
eef868d1 | 1484 | |
220a90c5 | 1485 | /** |
1486 | * outputs this page as html in a table (suitable for inclusion in an admin pagetype) | |
db26acd4 | 1487 | * @return string Returns an XHTML string |
220a90c5 | 1488 | */ |
73fa96d5 | 1489 | public function output_html() { |
1490 | $adminroot = admin_get_root(); | |
220a90c5 | 1491 | $return = '<fieldset>'."\n".'<div class="clearer"><!-- --></div>'."\n"; |
6e4dc10f | 1492 | foreach($this->settings as $setting) { |
220a90c5 | 1493 | $fullname = $setting->get_full_name(); |
1494 | if (array_key_exists($fullname, $adminroot->errors)) { | |
1495 | $data = $adminroot->errors[$fullname]->data; | |
6e4dc10f | 1496 | } else { |
220a90c5 | 1497 | $data = $setting->get_setting(); |
79698344 | 1498 | // do not use defaults if settings not available - upgrade settings handles the defaults! |
6e4dc10f | 1499 | } |
220a90c5 | 1500 | $return .= $setting->output_html($data); |
6e4dc10f | 1501 | } |
220a90c5 | 1502 | $return .= '</fieldset>'; |
6e4dc10f | 1503 | return $return; |
1504 | } | |
1505 | ||
a8a66c96 | 1506 | /** |
875e5f07 | 1507 | * Is this settings page hidden in admin tree block? |
a8a66c96 | 1508 | * |
1509 | * @return bool True if hidden | |
1510 | */ | |
73fa96d5 | 1511 | public function is_hidden() { |
a8a66c96 | 1512 | return $this->hidden; |
1513 | } | |
1514 | ||
427649bf PS |
1515 | /** |
1516 | * Show we display Save button at the page bottom? | |
1517 | * @return bool | |
1518 | */ | |
1519 | public function show_save() { | |
1520 | foreach($this->settings as $setting) { | |
1521 | if (empty($setting->nosave)) { | |
1522 | return true; | |
1523 | } | |
1524 | } | |
1525 | return false; | |
1526 | } | |
6e4dc10f | 1527 | } |
1528 | ||
1529 | ||
220a90c5 | 1530 | /** |
1531 | * Admin settings class. Only exists on setting pages. | |
1532 | * Read & write happens at this level; no authentication. | |
db26acd4 | 1533 | * |
1534 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 1535 | */ |
301bf0b2 | 1536 | abstract class admin_setting { |
3e7069e7 | 1537 | /** @var string unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. */ |
73fa96d5 | 1538 | public $name; |
0c079f19 | 1539 | /** @var string localised name */ |
73fa96d5 | 1540 | public $visiblename; |
3fa37159 | 1541 | /** @var string localised long description in Markdown format */ |
73fa96d5 | 1542 | public $description; |
0c079f19 | 1543 | /** @var mixed Can be string or array of string */ |
73fa96d5 | 1544 | public $defaultsetting; |
0c079f19 | 1545 | /** @var string */ |
73fa96d5 | 1546 | public $updatedcallback; |
0c079f19 | 1547 | /** @var mixed can be String or Null. Null means main config table */ |
73fa96d5 | 1548 | public $plugin; // null means main config table |
427649bf PS |
1549 | /** @var bool true indicates this setting does not actually save anything, just information */ |
1550 | public $nosave = false; | |
adaeccb6 | 1551 | /** @var bool if set, indicates that a change to this setting requires rebuild course cache */ |
1552 | public $affectsmodinfo = false; | |
3c88a678 DW |
1553 | /** @var array of admin_setting_flag - These are extra checkboxes attached to a setting. */ |
1554 | private $flags = array(); | |
6e4dc10f | 1555 | |
220a90c5 | 1556 | /** |
1557 | * Constructor | |
0c079f19 | 1558 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, |
db26acd4 | 1559 | * or 'myplugin/mysetting' for ones in config_plugins. |
1a41e806 | 1560 | * @param string $visiblename localised name |
1561 | * @param string $description localised long description | |
220a90c5 | 1562 | * @param mixed $defaultsetting string or array depending on implementation |
1563 | */ | |
73fa96d5 | 1564 | public function __construct($name, $visiblename, $description, $defaultsetting) { |
7fb0303d | 1565 | $this->parse_setting_name($name); |
220a90c5 | 1566 | $this->visiblename = $visiblename; |
8dbe233a | 1567 | $this->description = $description; |
6e4dc10f | 1568 | $this->defaultsetting = $defaultsetting; |
1569 | } | |
eef868d1 | 1570 | |
3c88a678 DW |
1571 | /** |
1572 | * Generic function to add a flag to this admin setting. | |
1573 | * | |
1574 | * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED | |
1575 | * @param bool $default - The default for the flag | |
1576 | * @param string $shortname - The shortname for this flag. Used as a suffix for the setting name. | |
1577 | * @param string $displayname - The display name for this flag. Used as a label next to the checkbox. | |
1578 | */ | |
1579 | protected function set_flag_options($enabled, $default, $shortname, $displayname) { | |
1580 | if (empty($this->flags[$shortname])) { | |
1581 | $this->flags[$shortname] = new admin_setting_flag($enabled, $default, $shortname, $displayname); | |
1582 | } else { | |
1583 | $this->flags[$shortname]->set_options($enabled, $default); | |
1584 | } | |
1585 | } | |
1586 | ||
1587 | /** | |
1588 | * Set the enabled options flag on this admin setting. | |
1589 | * | |
1590 | * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED | |
1591 | * @param bool $default - The default for the flag | |
1592 | */ | |
1593 | public function set_enabled_flag_options($enabled, $default) { | |
1594 | $this->set_flag_options($enabled, $default, 'enabled', new lang_string('enabled', 'core_admin')); | |
1595 | } | |
1596 | ||
1597 | /** | |
1598 | * Set the advanced options flag on this admin setting. | |
1599 | * | |
1600 | * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED | |
1601 | * @param bool $default - The default for the flag | |
1602 | */ | |
1603 | public function set_advanced_flag_options($enabled, $default) { | |
1604 | $this->set_flag_options($enabled, $default, 'adv', new lang_string('advanced')); | |
1605 | } | |
1606 | ||
1607 | ||
1608 | /** | |
1609 | * Set the locked options flag on this admin setting. | |
1610 | * | |
1611 | * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED | |
1612 | * @param bool $default - The default for the flag | |
1613 | */ | |
1614 | public function set_locked_flag_options($enabled, $default) { | |
1615 | $this->set_flag_options($enabled, $default, 'locked', new lang_string('locked', 'core_admin')); | |
1616 | } | |
1617 | ||
1618 | /** | |
1619 | * Get the currently saved value for a setting flag | |
1620 | * | |
1621 | * @param admin_setting_flag $flag - One of the admin_setting_flag for this admin_setting. | |
1622 | * @return bool | |
1623 | */ | |
1624 | public function get_setting_flag_value(admin_setting_flag $flag) { | |
1625 | $value = $this->config_read($this->name . '_' . $flag->get_shortname()); | |
1626 | if (!isset($value)) { | |
1627 | $value = $flag->get_default(); | |
1628 | } | |
1629 | ||
1630 | return !empty($value); | |
1631 | } | |
1632 | ||
1633 | /** | |
1634 | * Get the list of defaults for the flags on this setting. | |
1635 | * | |
1636 | * @param array of strings describing the defaults for this setting. This is appended to by this function. | |
1637 | */ | |
1638 | public function get_setting_flag_defaults(& $defaults) { | |
1639 | foreach ($this->flags as $flag) { | |
1640 | if ($flag->is_enabled() && $flag->get_default()) { | |
1641 | $defaults[] = $flag->get_displayname(); | |
1642 | } | |
1643 | } | |
1644 | } | |
1645 | ||
1646 | /** | |
1647 | * Output the input fields for the advanced and locked flags on this setting. | |
1648 | * | |
1649 | * @param bool $adv - The current value of the advanced flag. | |
1650 | * @param bool $locked - The current value of the locked flag. | |
1651 | * @return string $output - The html for the flags. | |
1652 | */ | |
1653 | public function output_setting_flags() { | |
1654 | $output = ''; | |
1655 | ||
1656 | foreach ($this->flags as $flag) { | |
1657 | if ($flag->is_enabled()) { | |
1658 | $output .= $flag->output_setting_flag($this); | |
1659 | } | |
1660 | } | |
1661 | ||
459e3c88 DW |
1662 | if (!empty($output)) { |
1663 | return html_writer::tag('span', $output, array('class' => 'adminsettingsflags')); | |
1664 | } | |
3c88a678 DW |
1665 | return $output; |
1666 | } | |
1667 | ||
1668 | /** | |
1669 | * Write the values of the flags for this admin setting. | |
1670 | * | |
7e815a6e | 1671 | * @param array $data - The data submitted from the form or null to set the default value for new installs. |
3c88a678 DW |
1672 | * @return bool - true if successful. |
1673 | */ | |
1674 | public function write_setting_flags($data) { | |
1675 | $result = true; | |
1676 | foreach ($this->flags as $flag) { | |
1677 | $result = $result && $flag->write_setting_flag($this, $data); | |
1678 | } | |
1679 | return $result; | |
1680 | } | |
1681 | ||
7fb0303d | 1682 | /** |
db26acd4 | 1683 | * Set up $this->name and potentially $this->plugin |
1684 | * | |
7fb0303d | 1685 | * Set up $this->name and possibly $this->plugin based on whether $name looks |
1686 | * like 'settingname' or 'plugin/settingname'. Also, do some sanity checking | |
1687 | * on the names, that is, output a developer debug warning if the name | |
1688 | * contains anything other than [a-zA-Z0-9_]+. | |
1689 | * | |
1690 | * @param string $name the setting name passed in to the constructor. | |
1691 | */ | |
1692 | private function parse_setting_name($name) { | |
1693 | $bits = explode('/', $name); | |
1694 | if (count($bits) > 2) { | |
1695 | throw new moodle_exception('invalidadminsettingname', '', '', $name); | |
1696 | } | |
1697 | $this->name = array_pop($bits); | |
1698 | if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->name)) { | |
1699 | throw new moodle_exception('invalidadminsettingname', '', '', $name); | |
1700 | } | |
1701 | if (!empty($bits)) { | |
1702 | $this->plugin = array_pop($bits); | |
cd3acbf2 | 1703 | if ($this->plugin === 'moodle') { |
1704 | $this->plugin = null; | |
1705 | } else if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->plugin)) { | |
9baf6825 | 1706 | throw new moodle_exception('invalidadminsettingname', '', '', $name); |
1707 | } | |
7fb0303d | 1708 | } |
1709 | } | |
1710 | ||
db26acd4 | 1711 | /** |
1712 | * Returns the fullname prefixed by the plugin | |
1713 | * @return string | |
1714 | */ | |
73fa96d5 | 1715 | public function get_full_name() { |
220a90c5 | 1716 | return 's_'.$this->plugin.'_'.$this->name; |
1717 | } | |
1718 | ||
db26acd4 | 1719 | /** |
1720 | * Returns the ID string based on plugin and name | |
1721 | * @return string | |
1722 | */ | |
73fa96d5 | 1723 | public function get_id() { |
220a90c5 | 1724 | return 'id_s_'.$this->plugin.'_'.$this->name; |
1725 | } | |
1726 | ||
adaeccb6 | 1727 | /** |
1728 | * @param bool $affectsmodinfo If true, changes to this setting will | |
1729 | * cause the course cache to be rebuilt | |
1730 | */ | |
1731 | public function set_affects_modinfo($affectsmodinfo) { | |
1732 | $this->affectsmodinfo = $affectsmodinfo; | |
1733 | } | |
1734 | ||
db26acd4 | 1735 | /** |
1736 | * Returns the config if possible | |
1737 | * | |
3e7069e7 | 1738 | * @return mixed returns config if successful else null |
db26acd4 | 1739 | */ |
73fa96d5 | 1740 | public function config_read($name) { |
220a90c5 | 1741 | global $CFG; |
eb6a973c | 1742 | if (!empty($this->plugin)) { |
220a90c5 | 1743 | $value = get_config($this->plugin, $name); |
1744 | return $value === false ? NULL : $value; | |
1745 | ||
1746 | } else { | |
1747 | if (isset($CFG->$name)) { | |
1748 | return $CFG->$name; | |
1749 | } else { | |
1750 | return NULL; | |
1751 | } | |
1752 | } | |
1753 | } | |
1754 | ||
301bf0b2 | 1755 | /** |
db26acd4 | 1756 | * Used to set a config pair and log change |
301bf0b2 | 1757 | * |
db26acd4 | 1758 | * @param string $name |
1759 | * @param mixed $value Gets converted to string if not null | |
875e5f07 | 1760 | * @return bool Write setting to config table |
301bf0b2 | 1761 | */ |
73fa96d5 | 1762 | public function config_write($name, $value) { |
301bf0b2 | 1763 | global $DB, $USER, $CFG; |
1764 | ||
427649bf PS |
1765 | if ($this->nosave) { |
1766 | return true; | |
1767 | } | |
1768 | ||
301bf0b2 | 1769 | // make sure it is a real change |
1770 | $oldvalue = get_config($this->plugin, $name); | |
1771 | $oldvalue = ($oldvalue === false) ? null : $oldvalue; // normalise | |
1772 | $value = is_null($value) ? null : (string)$value; | |
1773 | ||
1774 | if ($oldvalue === $value) { | |
1775 | return true; | |
1776 | } | |
1777 | ||
1778 | // store change | |
1779 | set_config($name, $value, $this->plugin); | |
1780 | ||
adaeccb6 | 1781 | // Some admin settings affect course modinfo |
1782 | if ($this->affectsmodinfo) { | |
1783 | // Clear course cache for all courses | |
1784 | rebuild_course_cache(0, true); | |
1785 | } | |
1786 | ||
914499a3 | 1787 | $this->add_to_config_log($name, $oldvalue, $value); |
301bf0b2 | 1788 | |
1789 | return true; // BC only | |
220a90c5 | 1790 | } |
1791 | ||
914499a3 PS |
1792 | /** |
1793 | * Log config changes if necessary. | |
1794 | * @param string $name | |
1795 | * @param string $oldvalue | |
1796 | * @param string $value | |
1797 | */ | |
1798 | protected function add_to_config_log($name, $oldvalue, $value) { | |
1799 | add_to_config_log($name, $oldvalue, $value, $this->plugin); | |
1800 | } | |
1801 | ||
220a90c5 | 1802 | /** |
1803 | * Returns current value of this setting | |
1804 | * @return mixed array or string depending on instance, NULL means not set yet | |
1805 | */ | |
301bf0b2 | 1806 | public abstract function get_setting(); |
eef868d1 | 1807 | |
220a90c5 | 1808 | /** |
1809 | * Returns default setting if exists | |
1810 | * @return mixed array or string depending on instance; NULL means no default, user must supply | |
1811 | */ | |
73fa96d5 | 1812 | public function get_defaultsetting() { |
cd3acbf2 | 1813 | $adminroot = admin_get_root(false, false); |
1814 | if (!empty($adminroot->custom_defaults)) { | |
1815 | $plugin = is_null($this->plugin) ? 'moodle' : $this->plugin; | |
1816 | if (isset($adminroot->custom_defaults[$plugin])) { | |
875e5f07 | 1817 | if (array_key_exists($this->name, $adminroot->custom_defaults[$plugin])) { // null is valid value here ;-) |
cd3acbf2 | 1818 | return $adminroot->custom_defaults[$plugin][$this->name]; |
1819 | } | |
1820 | } | |
1821 | } | |
8e5da17a | 1822 | return $this->defaultsetting; |
1823 | } | |
1824 | ||
220a90c5 | 1825 | /** |
1826 | * Store new setting | |
db26acd4 | 1827 | * |
1828 | * @param mixed $data string or array, must not be NULL | |
1829 | * @return string empty string if ok, string error message otherwise | |
220a90c5 | 1830 | */ |
301bf0b2 | 1831 | public abstract function write_setting($data); |
eef868d1 | 1832 | |
220a90c5 | 1833 | /** |
1834 | * Return part of form with setting | |
db26acd4 | 1835 | * This function should always be overwritten |
1836 | * | |
1837 | * @param mixed $data array or string depending on setting | |
1838 | * @param string $query | |
220a90c5 | 1839 | * @return string |
1840 | */ | |
73fa96d5 | 1841 | public function output_html($data, $query='') { |
9baf6825 | 1842 | // should be overridden |
220a90c5 | 1843 | return; |
1844 | } | |
1845 | ||
1846 | /** | |
db26acd4 | 1847 | * Function called if setting updated - cleanup, cache reset, etc. |
1848 | * @param string $functionname Sets the function name | |
3e7069e7 | 1849 | * @return void |
220a90c5 | 1850 | */ |
73fa96d5 | 1851 | public function set_updatedcallback($functionname) { |
220a90c5 | 1852 | $this->updatedcallback = $functionname; |
1853 | } | |
1854 | ||
6ddc9278 PS |
1855 | /** |
1856 | * Execute postupdatecallback if necessary. | |
1857 | * @param mixed $original original value before write_setting() | |
1858 | * @return bool true if changed, false if not. | |
1859 | */ | |
1860 | public function post_write_settings($original) { | |
1861 | // Comparison must work for arrays too. | |
1862 | if (serialize($original) === serialize($this->get_setting())) { | |
1863 | return false; | |
1864 | } | |
1865 | ||
1866 | $callbackfunction = $this->updatedcallback; | |
1867 | if (!empty($callbackfunction) and function_exists($callbackfunction)) { | |
1868 | $callbackfunction($this->get_full_name()); | |
1869 | } | |
1870 | return true; | |
1871 | } | |
1872 | ||
220a90c5 | 1873 | /** |
1874 | * Is setting related to query text - used when searching | |
1875 | * @param string $query | |
1876 | * @return bool | |
1877 | */ | |
73fa96d5 | 1878 | public function is_related($query) { |
220a90c5 | 1879 | if (strpos(strtolower($this->name), $query) !== false) { |
1880 | return true; | |
1881 | } | |
2f1e464a | 1882 | if (strpos(core_text::strtolower($this->visiblename), $query) !== false) { |
220a90c5 | 1883 | return true; |
1884 | } | |
2f1e464a | 1885 | if (strpos(core_text::strtolower($this->description), $query) !== false) { |
220a90c5 | 1886 | return true; |
1887 | } | |
587c7040 | 1888 | $current = $this->get_setting(); |
1889 | if (!is_null($current)) { | |
1890 | if (is_string($current)) { | |
2f1e464a | 1891 | if (strpos(core_text::strtolower($current), $query) !== false) { |
587c7040 | 1892 | return true; |
1893 | } | |
1894 | } | |
1895 | } | |
1896 | $default = $this->get_defaultsetting(); | |
1897 | if (!is_null($default)) { | |
1898 | if (is_string($default)) { | |
2f1e464a | 1899 | if (strpos(core_text::strtolower($default), $query) !== false) { |
587c7040 | 1900 | return true; |
1901 | } | |
1902 | } | |
1903 | } | |
220a90c5 | 1904 | return false; |
6e4dc10f | 1905 | } |
220a90c5 | 1906 | } |
eef868d1 | 1907 | |
3c88a678 DW |
1908 | /** |
1909 | * An additional option that can be applied to an admin setting. | |
1910 | * The currently supported options are 'ADVANCED' and 'LOCKED'. | |
1911 | * | |
1912 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
1913 | */ | |
1914 | class admin_setting_flag { | |
1915 | /** @var bool Flag to indicate if this option can be toggled for this setting */ | |
1916 | private $enabled = false; | |
1917 | /** @var bool Flag to indicate if this option defaults to true or false */ | |
1918 | private $default = false; | |
1919 | /** @var string Short string used to create setting name - e.g. 'adv' */ | |
1920 | private $shortname = ''; | |
1921 | /** @var string String used as the label for this flag */ | |
1922 | private $displayname = ''; | |
1923 | /** @const Checkbox for this flag is displayed in admin page */ | |
1924 | const ENABLED = true; | |
1925 | /** @const Checkbox for this flag is not displayed in admin page */ | |
1926 | const DISABLED = false; | |
1927 | ||
1928 | /** | |
1929 | * Constructor | |
1930 | * | |
1931 | * @param bool $enabled Can this option can be toggled. | |
1932 | * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED. | |
1933 | * @param bool $default The default checked state for this setting option. | |
1934 | * @param string $shortname The shortname of this flag. Currently supported flags are 'locked' and 'adv' | |
1935 | * @param string $displayname The displayname of this flag. Used as a label for the flag. | |
1936 | */ | |
1937 | public function __construct($enabled, $default, $shortname, $displayname) { | |
1938 | $this->shortname = $shortname; | |
1939 | $this->displayname = $displayname; | |
1940 | $this->set_options($enabled, $default); | |
1941 | } | |
1942 | ||
1943 | /** | |
1944 | * Update the values of this setting options class | |
1945 | * | |
1946 | * @param bool $enabled Can this option can be toggled. | |
1947 | * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED. | |
1948 | * @param bool $default The default checked state for this setting option. | |
1949 | */ | |
1950 | public function set_options($enabled, $default) { | |
1951 | $this->enabled = $enabled; | |
1952 | $this->default = $default; | |
1953 | } | |
1954 | ||
1955 | /** | |
1956 | * Should this option appear in the interface and be toggleable? | |
1957 | * | |
1958 | * @return bool Is it enabled? | |
1959 | */ | |
1960 | public function is_enabled() { | |
1961 | return $this->enabled; | |
1962 | } | |
1963 | ||
1964 | /** | |
1965 | * Should this option be checked by default? | |
1966 | * | |
1967 | * @return bool Is it on by default? | |
1968 | */ | |
1969 | public function get_default() { | |
1970 | return $this->default; | |
1971 | } | |
1972 | ||
1973 | /** | |
1974 | * Return the short name for this flag. e.g. 'adv' or 'locked' | |
1975 | * | |
1976 | * @return string | |
1977 | */ | |
1978 | public function get_shortname() { | |
1979 | return $this->shortname; | |
1980 | } | |
1981 | ||
1982 | /** | |
1983 | * Return the display name for this flag. e.g. 'Advanced' or 'Locked' | |
1984 | * | |
1985 | * @return string | |
1986 | */ | |
1987 | public function get_displayname() { | |
1988 | return $this->displayname; | |
1989 | } | |
1990 | ||
1991 | /** | |
1992 | * Save the submitted data for this flag - or set it to the default if $data is null. | |
1993 | * | |
1994 | * @param admin_setting $setting - The admin setting for this flag | |
7e815a6e | 1995 | * @param array $data - The data submitted from the form or null to set the default value for new installs. |
3c88a678 DW |
1996 | * @return bool |
1997 | */ | |
1998 | public function write_setting_flag(admin_setting $setting, $data) { | |
1999 | $result = true; | |
2000 | if ($this->is_enabled()) { | |
7e815a6e DW |
2001 | if (!isset($data)) { |
2002 | $value = $this->get_default(); | |
2003 | } else { | |
2004 | $value = !empty($data[$setting->get_full_name() . '_' . $this->get_shortname()]); | |
2005 | } | |
3c88a678 DW |
2006 | $result = $setting->config_write($setting->name . '_' . $this->get_shortname(), $value); |
2007 | } | |
2008 | ||
2009 | return $result; | |
2010 | ||
2011 | } | |
2012 | ||
2013 | /** | |
2014 | * Output the checkbox for this setting flag. Should only be called if the flag is enabled. | |
2015 | * | |
2016 | * @param admin_setting $setting - The admin setting for this flag | |
2017 | * @return string - The html for the checkbox. | |
2018 | */ | |
2019 | public function output_setting_flag(admin_setting $setting) { | |
2020 | $value = $setting->get_setting_flag_value($this); | |
2021 | $output = ' <input type="checkbox" class="form-checkbox" ' . | |
2022 | ' id="' . $setting->get_id() . '_' . $this->get_shortname() . '" ' . | |
2023 | ' name="' . $setting->get_full_name() . '_' . $this->get_shortname() . '" ' . | |
2024 | ' value="1" ' . ($value ? 'checked="checked"' : '') . ' />' . | |
2025 | ' <label for="' . $setting->get_id() . '_' . $this->get_shortname() . '">' . | |
2026 | $this->get_displayname() . | |
2027 | ' </label> '; | |
2028 | return $output; | |
2029 | } | |
2030 | } | |
2031 | ||
3e7069e7 | 2032 | |
220a90c5 | 2033 | /** |
2034 | * No setting - just heading and text. | |
db26acd4 | 2035 | * |
2036 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2037 | */ |
2038 | class admin_setting_heading extends admin_setting { | |
3e7069e7 PS |
2039 | |
2040 | /** | |
2041 | * not a setting, just text | |
2042 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. | |
2043 | * @param string $heading heading | |
2044 | * @param string $information text in box | |
2045 | */ | |
73fa96d5 | 2046 | public function __construct($name, $heading, $information) { |
427649bf | 2047 | $this->nosave = true; |
73fa96d5 | 2048 | parent::__construct($name, $heading, $information, ''); |
220a90c5 | 2049 | } |
2050 | ||
db26acd4 | 2051 | /** |
2052 | * Always returns true | |
2053 | * @return bool Always returns true | |
2054 | */ | |
73fa96d5 | 2055 | public function get_setting() { |
220a90c5 | 2056 | return true; |
2057 | } | |
2058 | ||
db26acd4 | 2059 | /** |
2060 | * Always returns true | |
2061 | * @return bool Always returns true | |
2062 | */ | |
73fa96d5 | 2063 | public function get_defaultsetting() { |
220a90c5 | 2064 | return true; |
2065 | } | |
2066 | ||
db26acd4 | 2067 | /** |
2068 | * Never write settings | |
2069 | * @return string Always returns an empty string | |
2070 | */ | |
73fa96d5 | 2071 | public function write_setting($data) { |
9baf6825 | 2072 | // do not write any setting |
220a90c5 | 2073 | return ''; |
2074 | } | |
0c079f19 | 2075 | |
db26acd4 | 2076 | /** |
2077 | * Returns an HTML string | |
2078 | * @return string Returns an HTML string | |
2079 | */ | |
73fa96d5 | 2080 | public function output_html($data, $query='') { |
3c159385 | 2081 | global $OUTPUT; |
220a90c5 | 2082 | $return = ''; |
2083 | if ($this->visiblename != '') { | |
206dd861 | 2084 | $return .= $OUTPUT->heading($this->visiblename, 3, 'main'); |
220a90c5 | 2085 | } |
2086 | if ($this->description != '') { | |
8dbe233a | 2087 | $return .= $OUTPUT->box(highlight($query, markdown_to_html($this->description)), 'generalbox formsettingheading'); |
220a90c5 | 2088 | } |
2089 | return $return; | |
2090 | } | |
2091 | } | |
6e4dc10f | 2092 | |
3e7069e7 | 2093 | |
220a90c5 | 2094 | /** |
2095 | * The most flexibly setting, user is typing text | |
db26acd4 | 2096 | * |
2097 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2098 | */ |
6e4dc10f | 2099 | class admin_setting_configtext extends admin_setting { |
2100 | ||
3e7069e7 | 2101 | /** @var mixed int means PARAM_XXX type, string is a allowed format in regex */ |
73fa96d5 | 2102 | public $paramtype; |
0c079f19 | 2103 | /** @var int default field size */ |
73fa96d5 | 2104 | public $size; |
6e4dc10f | 2105 | |
220a90c5 | 2106 | /** |
875e5f07 | 2107 | * Config text constructor |
db26acd4 | 2108 | * |
1a41e806 | 2109 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. |
220a90c5 | 2110 | * @param string $visiblename localised |
2111 | * @param string $description long localised info | |
2112 | * @param string $defaultsetting | |
2113 | * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex | |
f7633b0f | 2114 | * @param int $size default field size |
220a90c5 | 2115 | */ |
73fa96d5 | 2116 | public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) { |
6e4dc10f | 2117 | $this->paramtype = $paramtype; |
f7633b0f | 2118 | if (!is_null($size)) { |
2119 | $this->size = $size; | |
2120 | } else { | |
40ea93a4 | 2121 | $this->size = ($paramtype === PARAM_INT) ? 5 : 30; |
f7633b0f | 2122 | } |
73fa96d5 | 2123 | parent::__construct($name, $visiblename, $description, $defaultsetting); |
6e4dc10f | 2124 | } |
2125 | ||
db26acd4 | 2126 | /** |
2127 | * Return the setting | |
2128 | * | |
875e5f07 | 2129 | * @return mixed returns config if successful else null |
db26acd4 | 2130 | */ |
73fa96d5 | 2131 | public function get_setting() { |
220a90c5 | 2132 | return $this->config_read($this->name); |
6e4dc10f | 2133 | } |
eef868d1 | 2134 | |
73fa96d5 | 2135 | public function write_setting($data) { |
8cad6cca | 2136 | if ($this->paramtype === PARAM_INT and $data === '') { |
9baf6825 | 2137 | // do not complain if '' used instead of 0 |
8cad6cca | 2138 | $data = 0; |
2139 | } | |
220a90c5 | 2140 | // $data is a string |
c5d2d0dd | 2141 | $validated = $this->validate($data); |
e33fbf87 | 2142 | if ($validated !== true) { |
2143 | return $validated; | |
c235598d | 2144 | } |
220a90c5 | 2145 | return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin')); |
6e4dc10f | 2146 | } |
2147 | ||
e33fbf87 | 2148 | /** |
2149 | * Validate data before storage | |
2150 | * @param string data | |
2151 | * @return mixed true if ok string if error found | |
2152 | */ | |
73fa96d5 | 2153 | public function validate($data) { |
58aaa8e9 | 2154 | // allow paramtype to be a custom regex if it is the form of /pattern/ |
2155 | if (preg_match('#^/.*/$#', $this->paramtype)) { | |
e33fbf87 | 2156 | if (preg_match($this->paramtype, $data)) { |
2157 | return true; | |
2158 | } else { | |
2159 | return get_string('validateerror', 'admin'); | |
2160 | } | |
2161 | ||
9e24fbd1 | 2162 | } else if ($this->paramtype === PARAM_RAW) { |
4ea56b3f | 2163 | return true; |
9baf6825 | 2164 | |
4ea56b3f | 2165 | } else { |
2166 | $cleaned = clean_param($data, $this->paramtype); | |
40ea93a4 | 2167 | if ("$data" === "$cleaned") { // implicit conversion to string is needed to do exact comparison |
4ea56b3f | 2168 | return true; |
e33fbf87 | 2169 | } else { |
4ea56b3f | 2170 | return get_string('validateerror', 'admin'); |
e33fbf87 | 2171 | } |
4ea56b3f | 2172 | } |
c235598d | 2173 | } |
2174 | ||
db26acd4 | 2175 | /** |
2176 | * Return an XHTML string for the setting | |
2177 | * @return string Returns an XHTML string | |
2178 | */ | |
73fa96d5 | 2179 | public function output_html($data, $query='') { |
220a90c5 | 2180 | $default = $this->get_defaultsetting(); |
2181 | ||
220a90c5 | 2182 | return format_admin_setting($this, $this->visiblename, |
9baf6825 | 2183 | '<div class="form-text defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>', |
2184 | $this->description, true, '', $default, $query); | |
6e4dc10f | 2185 | } |
6e4dc10f | 2186 | } |
2187 | ||
2639cdf0 AA |
2188 | /** |
2189 | * Text input with a maximum length constraint. | |
2190 | * | |
2191 | * @copyright 2015 onwards Ankit Agarwal | |
2192 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2193 | */ | |
2194 | class admin_setting_configtext_with_maxlength extends admin_setting_configtext { | |
2195 | ||
2196 | /** @var int maximum number of chars allowed. */ | |
2197 | protected $maxlength; | |
2198 | ||
2199 | /** | |
2200 | * Config text constructor | |
2201 | * | |
2202 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, | |
2203 | * or 'myplugin/mysetting' for ones in config_plugins. | |
2204 | * @param string $visiblename localised | |
2205 | * @param string $description long localised info | |
2206 | * @param string $defaultsetting | |
2207 | * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex | |
2208 | * @param int $size default field size | |
2209 | * @param mixed $maxlength int maxlength allowed, 0 for infinite. | |
2210 | */ | |
2211 | public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, | |
2212 | $size=null, $maxlength = 0) { | |
2213 | $this->maxlength = $maxlength; | |
2214 | parent::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size); | |
2215 | } | |
2216 | ||
2217 | /** | |
2218 | * Validate data before storage | |
2219 | * | |
2220 | * @param string $data data | |
2221 | * @return mixed true if ok string if error found | |
2222 | */ | |
2223 | public function validate($data) { | |
2224 | $parentvalidation = parent::validate($data); | |
2225 | if ($parentvalidation === true) { | |
2226 | if ($this->maxlength > 0) { | |
2227 | // Max length check. | |
2228 | $length = core_text::strlen($data); | |
2229 | if ($length > $this->maxlength) { | |
2230 | return get_string('maximumchars', 'moodle', $this->maxlength); | |
2231 | } | |
2232 | return true; | |
2233 | } else { | |
2234 | return true; // No max length check needed. | |
2235 | } | |
2236 | } else { | |
2237 | return $parentvalidation; | |
2238 | } | |
2239 | } | |
2240 | } | |
3e7069e7 | 2241 | |
220a90c5 | 2242 | /** |
2243 | * General text area without html editor. | |
db26acd4 | 2244 | * |
2245 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2246 | */ |
2247 | class admin_setting_configtextarea extends admin_setting_configtext { | |
4fe2250a | 2248 | private $rows; |
2249 | private $cols; | |
eba8cd63 | 2250 | |
db26acd4 | 2251 | /** |
2252 | * @param string $name | |
2253 | * @param string $visiblename | |
2254 | * @param string $description | |
2255 | * @param mixed $defaultsetting string or array | |
2256 | * @param mixed $paramtype | |
2257 | * @param string $cols The number of columns to make the editor | |
2258 | * @param string $rows The number of rows to make the editor | |
2259 | */ | |
73fa96d5 | 2260 | public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') { |
220a90c5 | 2261 | $this->rows = $rows; |
2262 | $this->cols = $cols; | |
73fa96d5 | 2263 | parent::__construct($name, $visiblename, $description, $defaultsetting, $paramtype); |
eba8cd63 | 2264 | } |
3e7069e7 | 2265 | |
db26acd4 | 2266 | /** |
2267 | * Returns an XHTML string for the editor | |
2268 | * | |
2269 | * @param string $data | |
2270 | * @param string $query | |
2271 | * @return string XHTML string for the editor | |
2272 | */ | |
73fa96d5 | 2273 | public function output_html($data, $query='') { |
220a90c5 | 2274 | $default = $this->get_defaultsetting(); |
2275 | ||
587c7040 | 2276 | $defaultinfo = $default; |
2277 | if (!is_null($default) and $default !== '') { | |
2278 | $defaultinfo = "\n".$default; | |
c5d2d0dd | 2279 | } |
220a90c5 | 2280 | |
2281 | return format_admin_setting($this, $this->visiblename, | |
0ac97084 | 2282 | '<div class="form-textarea" ><textarea rows="'. $this->rows .'" cols="'. $this->cols .'" id="'. $this->get_id() .'" name="'. $this->get_full_name() .'" spellcheck="true">'. s($data) .'</textarea></div>', |
9baf6825 | 2283 | $this->description, true, '', $defaultinfo, $query); |
4fe2250a | 2284 | } |
2285 | } | |
2286 | ||
3e7069e7 | 2287 | |
4fe2250a | 2288 | /** |
2289 | * General text area with html editor. | |
2290 | */ | |
2291 | class admin_setting_confightmleditor extends admin_setting_configtext { | |
2292 | private $rows; | |
2293 | private $cols; | |
0c079f19 | 2294 | |
4fe2250a | 2295 | /** |
2296 | * @param string $name | |
2297 | * @param string $visiblename | |
2298 | * @param string $description | |
2299 | * @param mixed $defaultsetting string or array | |
2300 | * @param mixed $paramtype | |
2301 | */ | |
2302 | public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') { | |
2303 | $this->rows = $rows; | |
2304 | $this->cols = $cols; | |
2305 | parent::__construct($name, $visiblename, $description, $defaultsetting, $paramtype); | |
ff5fe311 | 2306 | editors_head_setup(); |
4fe2250a | 2307 | } |
3e7069e7 | 2308 | |
4fe2250a | 2309 | /** |
2310 | * Returns an XHTML string for the editor | |
2311 | * | |
2312 | * @param string $data | |
2313 | * @param string $query | |
2314 | * @return string XHTML string for the editor | |
2315 | */ | |
2316 | public function output_html($data, $query='') { | |
2317 | $default = $this->get_defaultsetting(); | |
2318 | ||
2319 | $defaultinfo = $default; | |
2320 | if (!is_null($default) and $default !== '') { | |
2321 | $defaultinfo = "\n".$default; | |
2322 | } | |
2323 | ||
20e5da7d | 2324 | $editor = editors_get_preferred_editor(FORMAT_HTML); |
988592c5 | 2325 | $editor->set_text($data); |
69429650 | 2326 | $editor->use_editor($this->get_id(), array('noclean'=>true)); |
4fe2250a | 2327 | |
2328 | return format_admin_setting($this, $this->visiblename, | |
0ac97084 | 2329 | '<div class="form-textarea"><textarea rows="'. $this->rows .'" cols="'. $this->cols .'" id="'. $this->get_id() .'" name="'. $this->get_full_name() .'" spellcheck="true">'. s($data) .'</textarea></div>', |
9baf6825 | 2330 | $this->description, true, '', $defaultinfo, $query); |
220a90c5 | 2331 | } |
2332 | } | |
2333 | ||
3e7069e7 | 2334 | |
220a90c5 | 2335 | /** |
2336 | * Password field, allows unmasking of password | |
db26acd4 | 2337 | * |
2338 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2339 | */ |
2340 | class admin_setting_configpasswordunmask extends admin_setting_configtext { | |
3e7069e7 PS |
2341 | /** |
2342 | * Constructor | |
2343 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. | |
2344 | * @param string $visiblename localised | |
2345 | * @param string $description long localised info | |
2346 | * @param string $defaultsetting default password | |
2347 | */ | |
73fa96d5 | 2348 | public function __construct($name, $visiblename, $description, $defaultsetting) { |
2349 | parent::__construct($name, $visiblename, $description, $defaultsetting, PARAM_RAW, 30); | |
220a90c5 | 2350 | } |
0c079f19 | 2351 | |
914499a3 PS |
2352 | /** |
2353 | * Log config changes if necessary. | |
2354 | * @param string $name | |
2355 | * @param string $oldvalue | |
2356 | * @param string $value | |
2357 | */ | |
2358 | protected function add_to_config_log($name, $oldvalue, $value) { | |
2359 | if ($value !== '') { | |
2360 | $value = '********'; | |
2361 | } | |
2362 | if ($oldvalue !== '' and $oldvalue !== null) { | |
2363 | $oldvalue = '********'; | |
2364 | } | |
2365 | parent::add_to_config_log($name, $oldvalue, $value); | |
2366 | } | |
2367 | ||
db26acd4 | 2368 | /** |
2369 | * Returns XHTML for the field | |
2370 | * Writes Javascript into the HTML below right before the last div | |
2371 | * | |
2372 | * @todo Make javascript available through newer methods if possible | |
2373 | * @param string $data Value for the field | |
2374 | * @param string $query Passed as final argument for format_admin_setting | |
2375 | * @return string XHTML field | |
2376 | */ | |
73fa96d5 | 2377 | public function output_html($data, $query='') { |
220a90c5 | 2378 | $id = $this->get_id(); |
2379 | $unmask = get_string('unmaskpassword', 'form'); | |
2380 | $unmaskjs = '<script type="text/javascript"> | |
eba8cd63 | 2381 | //<![CDATA[ |
633239f6 | 2382 | var is_ie = (navigator.userAgent.toLowerCase().indexOf("msie") != -1); |
2383 | ||
2384 | document.getElementById("'.$id.'").setAttribute("autocomplete", "off"); | |
2385 | ||
2386 | var unmaskdiv = document.getElementById("'.$id.'unmaskdiv"); | |
2387 | ||
2388 | var unmaskchb = document.createElement("input"); | |
2389 | unmaskchb.setAttribute("type", "checkbox"); | |
2390 | unmaskchb.setAttribute("id", "'.$id.'unmask"); | |
2391 | unmaskchb.onchange = function() {unmaskPassword("'.$id.'");}; | |
2392 | unmaskdiv.appendChild(unmaskchb); | |
2393 | ||
2394 | var unmasklbl = document.createElement("label"); | |
2395 | unmasklbl.innerHTML = "'.addslashes_js($unmask).'"; | |
2396 | if (is_ie) { | |
2397 | unmasklbl.setAttribute("htmlFor", "'.$id.'unmask"); | |
2398 | } else { | |
2399 | unmasklbl.setAttribute("for", "'.$id.'unmask"); | |
2400 | } | |
2401 | unmaskdiv.appendChild(unmasklbl); | |
2402 | ||
2403 | if (is_ie) { | |
2404 | // ugly hack to work around the famous onchange IE bug | |
2405 | unmaskchb.onclick = function() {this.blur();}; | |
2406 | unmaskdiv.onclick = function() {this.blur();}; | |
2407 | } | |
eba8cd63 | 2408 | //]]> |
2409 | </script>'; | |
220a90c5 | 2410 | return format_admin_setting($this, $this->visiblename, |
9baf6825 | 2411 | '<div class="form-password"><input type="password" size="'.$this->size.'" id="'.$id.'" name="'.$this->get_full_name().'" value="'.s($data).'" /><div class="unmask" id="'.$id.'unmaskdiv"></div>'.$unmaskjs.'</div>', |
2412 | $this->description, true, '', NULL, $query); | |
220a90c5 | 2413 | } |
2414 | } | |
2415 | ||
c7cd8d9c DW |
2416 | /** |
2417 | * Empty setting used to allow flags (advanced) on settings that can have no sensible default. | |
2418 | * Note: Only advanced makes sense right now - locked does not. | |
2419 | * | |
2420 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
2421 | */ | |
2422 | class admin_setting_configempty extends admin_setting_configtext { | |
2423 | ||
2424 | /** | |
2425 | * @param string $name | |
2426 | * @param string $visiblename | |
2427 | * @param string $description | |
2428 | */ | |
2429 | public function __construct($name, $visiblename, $description) { | |
2430 | parent::__construct($name, $visiblename, $description, '', PARAM_RAW); | |
2431 | } | |
2432 | ||
2433 | /** | |
2434 | * Returns an XHTML string for the hidden field | |
2435 | * | |
2436 | * @param string $data | |
2437 | * @param string $query | |
2438 | * @return string XHTML string for the editor | |
2439 | */ | |
2440 | public function output_html($data, $query='') { | |
2441 | return format_admin_setting($this, | |
2442 | $this->visiblename, | |
2443 | '<div class="form-empty" >' . | |
2444 | '<input type="hidden"' . | |
2445 | ' id="'. $this->get_id() .'"' . | |
2446 | ' name="'. $this->get_full_name() .'"' . | |
2447 | ' value=""/></div>', | |
2448 | $this->description, | |
2449 | true, | |
2450 | '', | |
2451 | get_string('none'), | |
2452 | $query); | |
2453 | } | |
2454 | } | |
2455 | ||
3e7069e7 | 2456 | |
220a90c5 | 2457 | /** |
e9c0fa35 | 2458 | * Path to directory |
db26acd4 | 2459 | * |
2460 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2461 | */ |
e9c0fa35 | 2462 | class admin_setting_configfile extends admin_setting_configtext { |
3e7069e7 PS |
2463 | /** |
2464 | * Constructor | |
2465 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. | |
2466 | * @param string $visiblename localised | |
2467 | * @param string $description long localised info | |
2468 | * @param string $defaultdirectory default directory location | |
2469 | */ | |
73fa96d5 | 2470 | public function __construct($name, $visiblename, $description, $defaultdirectory) { |
2471 | parent::__construct($name, $visiblename, $description, $defaultdirectory, PARAM_RAW, 50); | |
220a90c5 | 2472 | } |
2473 | ||
db26acd4 | 2474 | /** |
2475 | * Returns XHTML for the field | |
0c079f19 | 2476 | * |
db26acd4 | 2477 | * Returns XHTML for the field and also checks whether the file |
2478 | * specified in $data exists using file_exists() | |
2479 | * | |
2480 | * @param string $data File name and path to use in value attr | |
2481 | * @param string $query | |
2482 | * @return string XHTML field | |
2483 | */ | |
73fa96d5 | 2484 | public function output_html($data, $query='') { |
5aaac8b2 | 2485 | global $CFG; |
220a90c5 | 2486 | $default = $this->get_defaultsetting(); |
2487 | ||
220a90c5 | 2488 | if ($data) { |
e9c0fa35 | 2489 | if (file_exists($data)) { |
220a90c5 | 2490 | $executable = '<span class="pathok">✔</span>'; |
2491 | } else { | |
2492 | $executable = '<span class="patherror">✘</span>'; | |
2493 | } | |
2494 | } else { | |
2495 | $executable = ''; | |
2496 | } | |
5aaac8b2 PS |
2497 | $readonly = ''; |
2498 | if (!empty($CFG->preventexecpath)) { | |
2499 | $this->visiblename .= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>'; | |
2500 | $readonly = 'readonly="readonly"'; | |
2501 | } | |
220a90c5 | 2502 | |
2503 | return format_admin_setting($this, $this->visiblename, | |
5aaac8b2 | 2504 | '<div class="form-file defaultsnext"><input '.$readonly.' type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>', |
9baf6825 | 2505 | $this->description, true, '', $default, $query); |
eba8cd63 | 2506 | } |
41186f4f | 2507 | |
9a2b5e0b | 2508 | /** |
41186f4f | 2509 | * Checks if execpatch has been disabled in config.php |
9a2b5e0b HD |
2510 | */ |
2511 | public function write_setting($data) { | |
2512 | global $CFG; | |
2513 | if (!empty($CFG->preventexecpath)) { | |
41186f4f PS |
2514 | if ($this->get_setting() === null) { |
2515 | // Use default during installation. | |
2516 | $data = $this->get_defaultsetting(); | |
2517 | if ($data === null) { | |
2518 | $data = ''; | |
2519 | } | |
2520 | } else { | |
2521 | return ''; | |
2522 | } | |
9a2b5e0b HD |
2523 | } |
2524 | return parent::write_setting($data); | |
2525 | } | |
220a90c5 | 2526 | } |
2527 | ||
3e7069e7 | 2528 | |
220a90c5 | 2529 | /** |
e9c0fa35 | 2530 | * Path to executable file |
db26acd4 | 2531 | * |
2532 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2533 | */ |
e9c0fa35 | 2534 | class admin_setting_configexecutable extends admin_setting_configfile { |
2535 | ||
3e7069e7 PS |
2536 | /** |
2537 | * Returns an XHTML field | |
2538 | * | |
2539 | * @param string $data This is the value for the field | |
2540 | * @param string $query | |
2541 | * @return string XHTML field | |
2542 | */ | |
73fa96d5 | 2543 | public function output_html($data, $query='') { |
9a2b5e0b | 2544 | global $CFG; |
e9c0fa35 | 2545 | $default = $this->get_defaultsetting(); |
bc219382 | 2546 | require_once("$CFG->libdir/filelib.php"); |
e9c0fa35 | 2547 | |
2548 | if ($data) { | |
bc219382 | 2549 | if (file_exists($data) and !is_dir($data) and file_is_executable($data)) { |
e9c0fa35 | 2550 | $executable = '<span class="pathok">✔</span>'; |
2551 | } else { | |
2552 | $executable = '<span class="patherror">✘</span>'; | |
2553 | } | |
2554 | } else { | |
2555 | $executable = ''; | |
2556 | } | |
5aaac8b2 | 2557 | $readonly = ''; |
9a2b5e0b HD |
2558 | if (!empty($CFG->preventexecpath)) { |
2559 | $this->visiblename .= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>'; | |
5aaac8b2 | 2560 | $readonly = 'readonly="readonly"'; |
9a2b5e0b | 2561 | } |
e9c0fa35 | 2562 | |
2563 | return format_admin_setting($this, $this->visiblename, | |
5aaac8b2 | 2564 | '<div class="form-file defaultsnext"><input '.$readonly.' type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>', |
9baf6825 | 2565 | $this->description, true, '', $default, $query); |
220a90c5 | 2566 | } |
e9c0fa35 | 2567 | } |
220a90c5 | 2568 | |
3e7069e7 | 2569 | |
e9c0fa35 | 2570 | /** |
2571 | * Path to directory | |
db26acd4 | 2572 | * |
2573 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
e9c0fa35 | 2574 | */ |
2575 | class admin_setting_configdirectory extends admin_setting_configfile { | |
db26acd4 | 2576 | |
3e7069e7 PS |
2577 | /** |
2578 | * Returns an XHTML field | |
2579 | * | |
2580 | * @param string $data This is the value for the field | |
2581 | * @param string $query | |
2582 | * @return string XHTML | |
2583 | */ | |
73fa96d5 | 2584 | public function output_html($data, $query='') { |
5aaac8b2 | 2585 | global $CFG; |
220a90c5 | 2586 | $default = $this->get_defaultsetting(); |
2587 | ||
220a90c5 | 2588 | if ($data) { |
2589 | if (file_exists($data) and is_dir($data)) { | |
2590 | $executable = '<span class="pathok">✔</span>'; | |
2591 | } else { | |
2592 | $executable = '<span class="patherror">✘</span>'; | |
2593 | } | |
2594 | } else { | |
2595 | $executable = ''; | |
2596 | } | |
5aaac8b2 PS |
2597 | $readonly = ''; |
2598 | if (!empty($CFG->preventexecpath)) { | |
2599 | $this->visiblename .= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>'; | |
2600 | $readonly = 'readonly="readonly"'; | |
2601 | } | |
9ba38673 | 2602 | |
220a90c5 | 2603 | return format_admin_setting($this, $this->visiblename, |
5aaac8b2 | 2604 | '<div class="form-file defaultsnext"><input '.$readonly.' type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>', |
9baf6825 | 2605 | $this->description, true, '', $default, $query); |
220a90c5 | 2606 | } |
eba8cd63 | 2607 | } |
2608 | ||
3e7069e7 | 2609 | |
220a90c5 | 2610 | /** |
2611 | * Checkbox | |
db26acd4 | 2612 | * |
2613 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2614 | */ |
6e4dc10f | 2615 | class admin_setting_configcheckbox extends admin_setting { |
3e7069e7 | 2616 | /** @var string Value used when checked */ |
73fa96d5 | 2617 | public $yes; |
0c079f19 | 2618 | /** @var string Value used when not checked */ |
73fa96d5 | 2619 | public $no; |
6e4dc10f | 2620 | |
220a90c5 | 2621 | /** |
2622 | * Constructor | |
1a41e806 | 2623 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. |
220a90c5 | 2624 | * @param string $visiblename localised |
2625 | * @param string $description long localised info | |
2626 | * @param string $defaultsetting | |
2627 | * @param string $yes value used when checked | |
2628 | * @param string $no value used when not checked | |
2629 | */ | |
73fa96d5 | 2630 | public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') { |
2631 | parent::__construct($name, $visiblename, $description, $defaultsetting); | |
220a90c5 | 2632 | $this->yes = (string)$yes; |
2633 | $this->no = (string)$no; | |
6e4dc10f | 2634 | } |
2635 | ||
db26acd4 | 2636 | /** |
2637 | * Retrieves the current setting using the objects name | |
2638 | * | |
2639 | * @return string | |
2640 | */ | |
73fa96d5 | 2641 | public function get_setting() { |
220a90c5 | 2642 | return $this->config_read($this->name); |
6e4dc10f | 2643 | } |
eef868d1 | 2644 | |
db26acd4 | 2645 | /** |
2646 | * Sets the value for the setting | |
2647 | * | |
2648 | * Sets the value for the setting to either the yes or no values | |
2649 | * of the object by comparing $data to yes | |
2650 | * | |
2651 | * @param mixed $data Gets converted to str for comparison against yes value | |
2652 | * @return string empty string or error | |
2653 | */ | |
73fa96d5 | 2654 | public function write_setting($data) { |
220a90c5 | 2655 | if ((string)$data === $this->yes) { // convert to strings before comparison |
2656 | $data = $this->yes; | |
6e4dc10f | 2657 | } else { |
220a90c5 | 2658 | $data = $this->no; |
6e4dc10f | 2659 | } |
220a90c5 | 2660 | return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin')); |
6e4dc10f | 2661 | } |
2662 | ||
db26acd4 | 2663 | /** |
2664 | * Returns an XHTML checkbox field | |
2665 | * | |
2666 | * @param string $data If $data matches yes then checkbox is checked | |
2667 | * @param string $query | |
2668 | * @return string XHTML field | |
2669 | */ | |
73fa96d5 | 2670 | public function output_html($data, $query='') { |
220a90c5 | 2671 | $default = $this->get_defaultsetting(); |
2672 | ||
2673 | if (!is_null($default)) { | |
2674 | if ((string)$default === $this->yes) { | |
587c7040 | 2675 | $defaultinfo = get_string('checkboxyes', 'admin'); |
220a90c5 | 2676 | } else { |
587c7040 | 2677 | $defaultinfo = get_string('checkboxno', 'admin'); |
220a90c5 | 2678 | } |
c8218a42 | 2679 | } else { |
587c7040 | 2680 | $defaultinfo = NULL; |
c8218a42 | 2681 | } |
220a90c5 | 2682 | |
2683 | if ((string)$data === $this->yes) { // convert to strings before comparison | |
2684 | $checked = 'checked="checked"'; | |
2685 | } else { | |
2686 | $checked = ''; | |
2687 | } | |
2688 | ||
2689 | return format_admin_setting($this, $this->visiblename, | |
9baf6825 | 2690 | '<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> ' |
2691 | .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' /></div>', | |
2692 | $this->description, true, '', $defaultinfo, $query); | |
6e4dc10f | 2693 | } |
6e4dc10f | 2694 | } |
2695 | ||
3e7069e7 | 2696 | |
220a90c5 | 2697 | /** |
2698 | * Multiple checkboxes, each represents different value, stored in csv format | |
db26acd4 | 2699 | * |
2700 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2701 | */ |
2702 | class admin_setting_configmulticheckbox extends admin_setting { | |
3e7069e7 | 2703 | /** @var array Array of choices value=>label */ |
73fa96d5 | 2704 | public $choices; |
eef868d1 | 2705 | |
220a90c5 | 2706 | /** |
db26acd4 | 2707 | * Constructor: uses parent::__construct |
2708 | * | |
1a41e806 | 2709 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. |
220a90c5 | 2710 | * @param string $visiblename localised |
2711 | * @param string $description long localised info | |
2712 | * @param array $defaultsetting array of selected | |
2713 | * @param array $choices array of $value=>$label for each checkbox | |
2714 | */ | |
73fa96d5 | 2715 | public function __construct($name, $visiblename, $description, $defaultsetting, $choices) { |
6e4dc10f | 2716 | $this->choices = $choices; |
73fa96d5 | 2717 | parent::__construct($name, $visiblename, $description, $defaultsetting); |
6e4dc10f | 2718 | } |
2719 | ||
0a784551 | 2720 | /** |
73fa96d5 | 2721 | * This public function may be used in ancestors for lazy loading of choices |
db26acd4 | 2722 | * |
2723 | * @todo Check if this function is still required content commented out only returns true | |
2724 | * @return bool true if loaded, false if error | |
0a784551 | 2725 | */ |
73fa96d5 | 2726 | public function load_choices() { |
0a784551 | 2727 | /* |
220a90c5 | 2728 | if (is_array($this->choices)) { |
2729 | return true; | |
0a784551 | 2730 | } |
2731 | .... load choices here | |
2732 | */ | |
220a90c5 | 2733 | return true; |
2734 | } | |
2735 | ||
2736 | /** | |
2737 | * Is setting related to query text - used when searching | |
db26acd4 | 2738 | * |
220a90c5 | 2739 | * @param string $query |
db26acd4 | 2740 | * @return bool true on related, false on not or failure |
220a90c5 | 2741 | */ |
73fa96d5 | 2742 | public function is_related($query) { |
220a90c5 | 2743 | if (!$this->load_choices() or empty($this->choices)) { |
2744 | return false; | |
2745 | } | |
2746 | if (parent::is_related($query)) { | |
2747 | return true; | |
2748 | } | |
2749 | ||
220a90c5 | 2750 | foreach ($this->choices as $desc) { |
2f1e464a | 2751 | if (strpos(core_text::strtolower($desc), $query) !== false) { |
220a90c5 | 2752 | return true; |
2753 | } | |
2754 | } | |
2755 | return false; | |
0a784551 | 2756 | } |
2757 | ||
db26acd4 | 2758 | /** |
2759 | * Returns the current setting if it is set | |
2760 | * | |
2761 | * @return mixed null if null, else an array | |
2762 | */ | |
73fa96d5 | 2763 | public function get_setting() { |
220a90c5 | 2764 | $result = $this->config_read($this->name); |
10f19c49 | 2765 | |
220a90c5 | 2766 | if (is_null($result)) { |
2767 | return NULL; | |
2768 | } | |
2769 | if ($result === '') { | |
2770 | return array(); | |
2771 | } | |
10f19c49 | 2772 | $enabled = explode(',', $result); |
2773 | $setting = array(); | |
2774 | foreach ($enabled as $option) { | |
2775 | $setting[$option] = 1; | |
2776 | } | |
2777 | return $setting; | |
6e4dc10f | 2778 | } |
eef868d1 | 2779 | |
db26acd4 | 2780 | /** |
2781 | * Saves the setting(s) provided in $data | |
2782 | * | |
2783 | * @param array $data An array of data, if not array returns empty str | |
2784 | * @return mixed empty string on useless data or bool true=success, false=failed | |
2785 | */ | |
73fa96d5 | 2786 | public function write_setting($data) { |
220a90c5 | 2787 | if (!is_array($data)) { |
2788 | return ''; // ignore it | |
2789 | } | |
2790 | if (!$this->load_choices() or empty($this->choices)) { | |
2791 | return ''; | |
2792 | } | |
2793 | unset($data['xxxxx']); | |
2794 | $result = array(); | |
2795 | foreach ($data as $key => $value) { | |
2796 | if ($value and array_key_exists($key, $this->choices)) { | |
2797 | $result[] = $key; | |
2798 | } | |
2799 | } | |
2800 | return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin'); | |
6e4dc10f | 2801 | } |
0c079f19 | 2802 | |
db26acd4 | 2803 | /** |
2804 | * Returns XHTML field(s) as required by choices | |
2805 | * | |
2806 | * Relies on data being an array should data ever be another valid vartype with | |
2807 | * acceptable value this may cause a warning/error | |
2808 | * if (!is_array($data)) would fix the problem | |
2809 | * | |
2810 | * @todo Add vartype handling to ensure $data is an array | |
2811 | * | |
2812 | * @param array $data An array of checked values | |
2813 | * @param string $query | |
2814 | * @return string XHTML field | |
2815 | */ | |
73fa96d5 | 2816 | public function output_html($data, $query='') { |
220a90c5 | 2817 | if (!$this->load_choices() or empty($this->choices)) { |
2818 | return ''; | |
2819 | } | |
2820 | $default = $this->get_defaultsetting(); | |
2821 | if (is_null($default)) { | |
2822 | $default = array(); | |
2823 | } | |
2824 | if (is_null($data)) { | |
775f811a | 2825 | $data = array(); |
220a90c5 | 2826 | } |
220a90c5 | 2827 | $options = array(); |
2828 | $defaults = array(); | |
10f19c49 | 2829 | foreach ($this->choices as $key=>$description) { |
2830 | if (!empty($data[$key])) { | |
220a90c5 | 2831 | $checked = 'checked="checked"'; |
2832 | } else { | |
2833 | $checked = ''; | |
2834 | } | |
10f19c49 | 2835 | if (!empty($default[$key])) { |
220a90c5 | 2836 | $defaults[] = $description; |
2837 | } | |
2838 | ||
2839 | $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />' | |
9baf6825 | 2840 | .'<label for="'.$this->get_id().'_'.$key.'">'.highlightfast($query, $description).'</label>'; |
220a90c5 | 2841 | } |
2842 | ||
587c7040 | 2843 | if (is_null($default)) { |
2844 | $defaultinfo = NULL; | |
2845 | } else if (!empty($defaults)) { | |
9baf6825 | 2846 | $defaultinfo = implode(', ', $defaults); |
2847 | } else { | |
2848 | $defaultinfo = get_string('none'); | |
2849 | } | |
220a90c5 | 2850 | |
2851 | $return = '<div class="form-multicheckbox">'; | |
2852 | $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected | |
2853 | if ($options) { | |
2854 | $return .= '<ul>'; | |
2855 | foreach ($options as $option) { | |
2856 | $return .= '<li>'.$option.'</li>'; | |
2857 | } | |
2858 | $return .= '</ul>'; | |
6e4dc10f | 2859 | } |
587c7040 | 2860 | $return .= '</div>'; |
6153cf58 | 2861 | |
587c7040 | 2862 | return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query); |
c5d2d0dd | 2863 | |
6e4dc10f | 2864 | } |
6e4dc10f | 2865 | } |
2866 | ||
3e7069e7 | 2867 | |
220a90c5 | 2868 | /** |
2869 | * Multiple checkboxes 2, value stored as string 00101011 | |
db26acd4 | 2870 | * |
2871 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2872 | */ |
2873 | class admin_setting_configmulticheckbox2 extends admin_setting_configmulticheckbox { | |
db26acd4 | 2874 | |
3e7069e7 PS |
2875 | /** |
2876 | * Returns the setting if set | |
2877 | * | |
2878 | * @return mixed null if not set, else an array of set settings | |
2879 | */ | |
73fa96d5 | 2880 | public function get_setting() { |
220a90c5 | 2881 | $result = $this->config_read($this->name); |
2882 | if (is_null($result)) { | |
2883 | return NULL; | |
2884 | } | |
2885 | if (!$this->load_choices()) { | |
2886 | return NULL; | |
2887 | } | |
2888 | $result = str_pad($result, count($this->choices), '0'); | |
2889 | $result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY); | |
2890 | $setting = array(); | |
2891 | foreach ($this->choices as $key=>$unused) { | |
2892 | $value = array_shift($result); | |
2893 | if ($value) { | |
10f19c49 | 2894 | $setting[$key] = 1; |
220a90c5 | 2895 | } |
2896 | } | |
2897 | return $setting; | |
2898 | } | |
6e4dc10f | 2899 | |
db26acd4 | 2900 | /** |
2901 | * Save setting(s) provided in $data param | |
2902 | * | |
2903 | * @param array $data An array of settings to save | |
2904 | * @return mixed empty string for bad data or bool true=>success, false=>error | |
2905 | */ | |
73fa96d5 | 2906 | public function write_setting($data) { |
220a90c5 | 2907 | if (!is_array($data)) { |
2908 | return ''; // ignore it | |
2909 | } | |
2910 | if (!$this->load_choices() or empty($this->choices)) { | |
2911 | return ''; | |
2912 | } | |
2913 | $result = ''; | |
2914 | foreach ($this->choices as $key=>$unused) { | |
2915 | if (!empty($data[$key])) { | |
2916 | $result .= '1'; | |
2917 | } else { | |
2918 | $result .= '0'; | |
2919 | } | |
2920 | } | |
2921 | return $this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin'); | |
2922 | } | |
2923 | } | |
2924 | ||
3e7069e7 | 2925 | |
220a90c5 | 2926 | /** |
2927 | * Select one value from list | |
db26acd4 | 2928 | * |
2929 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 2930 | */ |
2931 | class admin_setting_configselect extends admin_setting { | |
3e7069e7 | 2932 | /** @var array Array of choices value=>label */ |
73fa96d5 | 2933 | public $choices; |
6e4dc10f | 2934 | |
220a90c5 | 2935 | /** |
2936 | * Constructor | |
1a41e806 | 2937 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. |
220a90c5 | 2938 | * @param string $visiblename localised |
2939 | * @param string $description long localised info | |
eab8ed9f | 2940 | * @param string|int $defaultsetting |
220a90c5 | 2941 | * @param array $choices array of $value=>$label for each selection |
2942 | */ | |
73fa96d5 | 2943 | public function __construct($name, $visiblename, $description, $defaultsetting, $choices) { |
220a90c5 | 2944 | $this->choices = $choices; |
73fa96d5 | 2945 | parent::__construct($name, $visiblename, $description, $defaultsetting); |
220a90c5 | 2946 | } |
2947 | ||
2948 | /** | |
2949 | * This function may be used in ancestors for lazy loading of choices | |
db26acd4 | 2950 | * |
0c079f19 | 2951 | * Override this method if loading of choices is expensive, such |
2952 | * as when it requires multiple db requests. | |
2953 | * | |
db26acd4 | 2954 | * @return bool true if loaded, false if error |
220a90c5 | 2955 | */ |
73fa96d5 | 2956 | public function load_choices() { |
220a90c5 | 2957 | /* |
2958 | if (is_array($this->choices)) { | |
2959 | return true; | |
6e4dc10f | 2960 | } |
220a90c5 | 2961 | .... load choices here |
2962 | */ | |
2963 | return true; | |
6e4dc10f | 2964 | } |
2965 | ||
db26acd4 | 2966 | /** |
2967 | * Check if this is $query is related to a choice | |
2968 | * | |
2969 | * @param string $query | |
2970 | * @return bool true if related, false if not | |
2971 | */ | |
73fa96d5 | 2972 | public function is_related($query) { |
407d8134 | 2973 | if (parent::is_related($query)) { |
2974 | return true; | |
2975 | } | |
2976 | if (!$this->load_choices()) { | |
2977 | return false; | |
2978 | } | |
407d8134 | 2979 | foreach ($this->choices as $key=>$value) { |
2f1e464a | 2980 | if (strpos(core_text::strtolower($key), $query) !== false) { |
407d8134 | 2981 | return true; |
2982 | } | |
2f1e464a | 2983 | if (strpos(core_text::strtolower($value), $query) !== false) { |
407d8134 | 2984 | return true; |
2985 | } | |
c5d2d0dd | 2986 | } |
407d8134 | 2987 | return false; |
2988 | } | |
2989 | ||
db26acd4 | 2990 | /** |
2991 | * Return the setting | |
0c079f19 | 2992 | * |
875e5f07 | 2993 | * @return mixed returns config if successful else null |
db26acd4 | 2994 | */ |
73fa96d5 | 2995 | public function get_setting() { |
220a90c5 | 2996 | return $this->config_read($this->name); |
6e4dc10f | 2997 | } |
eef868d1 | 2998 | |
db26acd4 | 2999 | /** |
3000 | * Save a setting | |
3001 | * | |
3002 | * @param string $data | |
3003 | * @return string empty of error string | |
3004 | */ | |
73fa96d5 | 3005 | public function write_setting($data) { |
220a90c5 | 3006 | if (!$this->load_choices() or empty($this->choices)) { |
3007 | return ''; | |
3008 | } | |
3009 | if (!array_key_exists($data, $this->choices)) { | |
3010 | return ''; // ignore it | |
3011 | } | |
eef868d1 | 3012 | |
220a90c5 | 3013 | return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin')); |
6e4dc10f | 3014 | } |
eef868d1 | 3015 | |
e2249afe | 3016 | /** |
db26acd4 | 3017 | * Returns XHTML select field |
3018 | * | |
3019 | * Ensure the options are loaded, and generate the XHTML for the select | |
e2249afe | 3020 | * element and any warning message. Separating this out from output_html |
3021 | * makes it easier to subclass this class. | |
3022 | * | |
3023 | * @param string $data the option to show as selected. | |
3024 | * @param string $current the currently selected option in the database, null if none. | |
3025 | * @param string $default the default selected option. | |
3026 | * @return array the HTML for the select element, and a warning message. | |
3027 | */ | |
73fa96d5 | 3028 | public function output_select_html($data, $current, $default, $extraname = '') { |
220a90c5 | 3029 | if (!$this->load_choices() or empty($this->choices)) { |
e2249afe | 3030 | return array('', ''); |
6e4dc10f | 3031 | } |
220a90c5 | 3032 | |
9c305ba1 | 3033 | $warning = ''; |
3034 | if (is_null($current)) { | |
9baf6825 | 3035 | // first run |
9c305ba1 | 3036 | } else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) { |
3037 | // no warning | |
9baf6825 | 3038 | } else if (!array_key_exists($current, $this->choices)) { |
3039 | $warning = get_string('warningcurrentsetting', 'admin', s($current)); | |
3040 | if (!is_null($default) and $data == $current) { | |
3041 | $data = $default; // use default instead of first value when showing the form | |
3042 | } | |
3043 | } | |
9c305ba1 | 3044 | |
e2249afe | 3045 | $selecthtml = '<select id="'.$this->get_id().'" name="'.$this->get_full_name().$extraname.'">'; |
6e4dc10f | 3046 | foreach ($this->choices as $key => $value) { |
9baf6825 | 3047 | // the string cast is needed because key may be integer - 0 is equal to most strings! |
e2249afe | 3048 | $selecthtml .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>'; |
eef868d1 | 3049 | } |
e2249afe | 3050 | $selecthtml .= '</select>'; |
3051 | return array($selecthtml, $warning); | |
3052 | } | |
3053 | ||
db26acd4 | 3054 | /** |
3055 | * Returns XHTML select field and wrapping div(s) | |
3056 | * | |
3057 | * @see output_select_html() | |
0c079f19 | 3058 | * |
db26acd4 | 3059 | * @param string $data the option to show as selected |
3060 | * @param string $query | |
3061 | * @return string XHTML field and wrapping div | |
3062 | */ | |
73fa96d5 | 3063 | public function output_html($data, $query='') { |
e2249afe | 3064 | $default = $this->get_defaultsetting(); |
3065 | $current = $this->get_setting(); | |
3066 | ||
3067 | list($selecthtml, $warning) = $this->output_select_html($data, $current, $default); | |
3068 | if (!$selecthtml) { | |
3069 | return ''; | |
3070 | } | |
3071 | ||
3072 | if (!is_null($default) and array_key_exists($default, $this->choices)) { | |
3073 | $defaultinfo = $this->choices[$default]; | |
3074 | } else { | |
3075 | $defaultinfo = NULL; | |
3076 | } | |
3077 | ||
3078 | $return = '<div class="form-select defaultsnext">' . $selecthtml . '</div>'; | |
220a90c5 | 3079 | |
587c7040 | 3080 | return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning, $defaultinfo, $query); |
6e4dc10f | 3081 | } |
6e4dc10f | 3082 | } |
3083 | ||
3e7069e7 | 3084 | |
220a90c5 | 3085 | /** |
3086 | * Select multiple items from list | |
db26acd4 | 3087 | * |
3088 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 3089 | */ |
6e4dc10f | 3090 | class admin_setting_configmultiselect extends admin_setting_configselect { |
3e7069e7 PS |
3091 | /** |
3092 | * Constructor | |
3093 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. | |
3094 | * @param string $visiblename localised | |
3095 | * @param string $description long localised info | |
3096 | * @param array $defaultsetting array of selected items | |
3097 | * @param array $choices array of $value=>$label for each list item | |
3098 | */ | |
73fa96d5 | 3099 | public function __construct($name, $visiblename, $description, $defaultsetting, $choices) { |
3100 | parent::__construct($name, $visiblename, $description, $defaultsetting, $choices); | |
6e4dc10f | 3101 | } |
3102 | ||
db26acd4 | 3103 | /** |
3104 | * Returns the select setting(s) | |
3105 | * | |
3106 | * @return mixed null or array. Null if no settings else array of setting(s) | |
3107 | */ | |
73fa96d5 | 3108 | public function get_setting() { |
220a90c5 | 3109 | $result = $this->config_read($this->name); |
3110 | if (is_null($result)) { | |
d7933a55 | 3111 | return NULL; |
3112 | } | |
220a90c5 | 3113 | if ($result === '') { |
3114 | return array(); | |
3115 | } | |
3116 | return explode(',', $result); | |
6e4dc10f | 3117 | } |
eef868d1 | 3118 | |
db26acd4 | 3119 | /** |
3120 | * Saves setting(s) provided through $data | |
3121 | * | |
3122 | * Potential bug in the works should anyone call with this function | |
3123 | * using a vartype that is not an array | |
3124 | * | |
db26acd4 | 3125 | * @param array $data |
3126 | */ | |
73fa96d5 | 3127 | public function write_setting($data) { |
220a90c5 | 3128 | if (!is_array($data)) { |
3129 | return ''; //ignore it | |
3130 | } | |
3131 | if (!$this->load_choices() or empty($this->choices)) { | |
3132 | return ''; | |
3133 | } | |
3134 | ||
a7ad48fd | 3135 | unset($data['xxxxx']); |
3136 | ||
220a90c5 | 3137 | $save = array(); |
3138 | foreach ($data as $value) { | |
3139 | if (!array_key_exists($value, $this->choices)) { | |
3140 | continue; // ignore it | |
3141 | } | |
3142 | $save[] = $value; | |
3143 | } | |
3144 | ||
3145 | return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin')); | |
3146 | } | |
3147 | ||
3148 | /** | |
3149 | * Is setting related to query text - used when searching | |
db26acd4 | 3150 | * |
220a90c5 | 3151 | * @param string $query |
db26acd4 | 3152 | * @return bool true if related, false if not |
220a90c5 | 3153 | */ |
73fa96d5 | 3154 | public function is_related($query) { |
220a90c5 | 3155 | if (!$this->load_choices() or empty($this->choices)) { |
3156 | return false; | |
3157 | } | |
3158 | if (parent::is_related($query)) { | |
3159 | return true; | |
3160 | } | |
3161 | ||
220a90c5 | 3162 | foreach ($this->choices as $desc) { |
2f1e464a | 3163 | if (strpos(core_text::strtolower($desc), $query) !== false) { |
220a90c5 | 3164 | return true; |
3165 | } | |
3166 | } | |
3167 | return false; | |
3168 | } | |
3169 | ||
db26acd4 | 3170 | /** |
3171 | * Returns XHTML multi-select field | |
3172 | * | |
3173 | * @todo Add vartype handling to ensure $data is an array | |
3174 | * @param array $data Array of values to select by default | |
3175 | * @param string $query | |
3176 | * @return string XHTML multi-select field | |
3177 | */ | |
73fa96d5 | 3178 | public function output_html($data, $query='') { |
220a90c5 | 3179 | if (!$this->load_choices() or empty($this->choices)) { |
3180 | return ''; | |
3181 | } | |
3182 | $choices = $this->choices; | |
3183 | $default = $this->get_defaultsetting(); | |
3184 | if (is_null($default)) { | |
3185 | $default = array(); | |
3186 | } | |
3187 | if (is_null($data)) { | |
d7933a55 | 3188 | $data = array(); |
3189 | } | |
220a90c5 | 3190 | |
3191 | $defaults = array(); | |
4413941f | 3192 | $size = min(10, count($this->choices)); |
a7ad48fd | 3193 | $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected |
4413941f | 3194 | $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="'.$size.'" multiple="multiple">'; |
220a90c5 | 3195 | foreach ($this->choices as $key => $description) { |
3196 | if (in_array($key, $data)) { | |
3197 | $selected = 'selected="selected"'; | |
3198 | } else { | |
3199 | $selected = ''; | |
3200 | } | |
3201 | if (in_array($key, $default)) { | |
3202 | $defaults[] = $description; | |
6e4dc10f | 3203 | } |
220a90c5 | 3204 | |
3205 | $return .= '<option value="'.s($key).'" '.$selected.'>'.$description.'</option>'; | |
3206 | } | |
3207 | ||
587c7040 | 3208 | if (is_null($default)) { |
3209 | $defaultinfo = NULL; | |
3210 | } if (!empty($defaults)) { | |
3211 | $defaultinfo = implode(', ', $defaults); | |
220a90c5 | 3212 | } else { |
587c7040 | 3213 | $defaultinfo = get_string('none'); |
6e4dc10f | 3214 | } |
eef868d1 | 3215 | |
587c7040 | 3216 | $return .= '</select></div>'; |
3217 | return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query); | |
6e4dc10f | 3218 | } |
220a90c5 | 3219 | } |
eef868d1 | 3220 | |
220a90c5 | 3221 | /** |
3222 | * Time selector | |
db26acd4 | 3223 | * |
3224 | * This is a liiitle bit messy. we're using two selects, but we're returning | |
220a90c5 | 3225 | * them as an array named after $name (so we only use $name2 internally for the setting) |
db26acd4 | 3226 | * |
3227 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
220a90c5 | 3228 | */ |
3229 | class admin_setting_configtime extends admin_setting { | |
3e7069e7 | 3230 | /** @var string Used for setting second select (minutes) */ |
73fa96d5 | 3231 | public $name2; |
220a90c5 | 3232 | |
3233 | /** | |
3234 | * Constructor | |
3235 | * @param string $hoursname setting for hours | |
3236 | * @param string $minutesname setting for hours | |
3237 | * @param string $visiblename localised | |
3238 | * @param string $description long localised info | |
3239 | * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes | |
3240 | */ | |
73fa96d5 | 3241 | public function __construct($hoursname, $minutesname, $visiblename, $description, $defaultsetting) { |
220a90c5 | 3242 | $this->name2 = $minutesname; |
73fa96d5 | 3243 | parent::__construct($hoursname, $visiblename, $description, $defaultsetting); |
220a90c5 | 3244 | } |
3245 | ||
db26acd4 | 3246 | /** |
3247 | * Get the selected time | |
0c079f19 | 3248 | * |
db26acd4 | 3249 | * @return mixed An array containing 'h'=>xx, 'm'=>xx, or null if not set |
3250 | */ | |
73fa96d5 | 3251 | public function get_setting() { |
220a90c5 | 3252 | $result1 = $this->config_read($this->name); |
3253 | $result2 = $this->config_read($this->name2); | |
3254 | if (is_null($result1) or is_null($result2)) { | |
3255 | return NULL; | |
3256 | } | |
3257 | ||
3258 | return array('h' => $result1, 'm' => $result2); | |
3259 | } | |
3260 | ||
db26acd4 | 3261 | /** |
3262 | * Store the time (hours and minutes) | |
0c079f19 | 3263 | * |
db26acd4 | 3264 | * @param array $data Must be form 'h'=>xx, 'm'=>xx |
3265 | * @return bool true if success, false if not | |
3266 | */ | |
73fa96d5 | 3267 | public function write_setting($data) { |
220a90c5 | 3268 | if (!is_array($data)) { |
3269 | return ''; | |
3270 | } | |
3271 | ||
3272 | $result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']); | |
3273 | return ($result ? '' : get_string('errorsetting', 'admin')); | |
3274 | } | |
3275 | ||
db26acd4 | 3276 | /** |
3277 | * Returns XHTML time select fields | |
3278 | * | |
3279 | * @param array $data Must be form 'h'=>xx, 'm'=>xx | |
3280 | * @param string $query | |
3281 | * @return string XHTML time select fields and wrapping div(s) | |
3282 | */ | |
73fa96d5 | 3283 | public function output_html($data, $query='') { |
220a90c5 | 3284 | $default = $this->get_defaultsetting(); |
3285 | ||
3286 | if (is_array($default)) { | |
587c7040 | 3287 | $defaultinfo = $default['h'].':'.$default['m']; |
cc73de71 | 3288 | } else { |
587c7040 | 3289 | $defaultinfo = NULL; |
6e4dc10f | 3290 | } |
220a90c5 | 3291 | |
c6bcbad0 AN |
3292 | $return = '<div class="form-time defaultsnext">'; |
3293 | $return .= '<label class="accesshide" for="' . $this->get_id() . 'h">' . get_string('hours') . '</label>'; | |
3294 | $return .= '<select id="' . $this->get_id() . 'h" name="' . $this->get_full_name() . '[h]">'; | |
220a90c5 | 3295 | for ($i = 0; $i < 24; $i++) { |
c6bcbad0 | 3296 | $return .= '<option value="' . $i . '"' . ($i == $data['h'] ? ' selected="selected"' : '') . '>' . $i . '</option>'; |
6e4dc10f | 3297 | } |
c6bcbad0 AN |
3298 | $return .= '</select>:'; |
3299 | $return .= '<label class="accesshide" for="' . $this->get_id() . 'm">' . get_string('minutes') . '</label>'; | |
3300 | $return .= '<select id="' . $this->get_id() . 'm" name="' . $this->get_full_name() . '[m]">'; | |
220a90c5 | 3301 | for ($i = 0; $i < 60; $i += 5) { |
c6bcbad0 | 3302 | $return .= '<option value="' . $i . '"' . ($i == $data['m'] ? ' selected="selected"' : '') . '>' . $i . '</option>'; |
220a90c5 | 3303 | } |
c6bcbad0 AN |
3304 | $return .= '</select>'; |
3305 | $return .= '</div>'; | |
e323bf51 BB |
3306 | return format_admin_setting($this, $this->visiblename, $return, $this->description, |
3307 | $this->get_id() . 'h', '', $defaultinfo, $query); | |
6e4dc10f | 3308 | } |
3309 | ||
3310 | } | |
3311 | ||
3e7069e7 | 3312 | |
38257347 PS |
3313 | /** |
3314 | * Seconds duration setting. | |
3315 | * | |
3316 | * @copyright 2012 Petr Skoda (http://skodak.org) | |
3317 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
3318 | */ | |
3319 | class admin_setting_configduration extends admin_setting { | |
3320 | ||
3321 | /** @var int default duration unit */ | |
3322 | protected $defaultunit; | |
3323 | ||
3324 | /** | |
3325 | * Constructor | |
3326 | * @param string $name unique ascii name, either 'mysetting' for settings that in config, | |
3327 | * or 'myplugin/mysetting' for ones in config_plugins. | |
3328 | * @param string $visiblename localised name | |
3329 | * @param string $description localised long description | |
3330 | * @param mixed $defaultsetting string or array depending on implementation | |
3331 | * @param int $defaultunit - day, week, etc. (in seconds) | |
3332 | */ | |
3333 | public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) { | |
3334 | if (is_number($defaultsetting)) { | |
3335 | $defaultsetting = self::parse_seconds($defaultsetting); | |
3336 | } | |
3337 | $units = self::get_units(); | |
3338 | if (isset($units[$defaultunit])) { | |
3339 | $this->defaultunit = $defaultunit; | |
3340 | } else { | |
3341 | $this->defaultunit = 86400; | |
3342 | } | |
3343 | parent::__construct($name, $visiblename, $description, $defaultsetting); | |