2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Functions and classes used during installation, upgrades and for admin settings.
20 * ADMIN SETTINGS TREE INTRODUCTION
22 * This file performs the following tasks:
23 * -it defines the necessary objects and interfaces to build the Moodle
25 * -it defines the admin_externalpage_setup()
27 * ADMIN_SETTING OBJECTS
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.
33 * ADMIN_SETTINGPAGE OBJECTS
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.
39 * ADMIN_EXTERNALPAGE OBJECTS
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.
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
52 * $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
53 * $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
56 * Next, in foo.php, your file structure would resemble the following:
58 * require(dirname(dirname(dirname(__FILE__))).'/config.php');
59 * require_once($CFG->libdir.'/adminlib.php');
60 * admin_externalpage_setup('foo');
61 * // functionality like processing form submissions goes here
62 * echo $OUTPUT->header();
63 * // your HTML goes here
64 * echo $OUTPUT->footer();
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.
69 * It also configures all $PAGE properties needed for navigation.
71 * ADMIN_CATEGORY OBJECTS
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.
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.
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.
89 * Please note that the $this->name field of any part_of_admin_tree must be
90 * UNIQUE throughout the ENTIRE admin tree.
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
96 * Original author: Vincenzo K. Marcovecchio
97 * Maintainer: Petr Skoda
101 * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
102 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
105 defined('MOODLE_INTERNAL') ||
die();
108 require_once($CFG->libdir
.'/ddllib.php');
109 require_once($CFG->libdir
.'/xmlize.php');
110 require_once($CFG->libdir
.'/messagelib.php');
112 define('INSECURE_DATAROOT_WARNING', 1);
113 define('INSECURE_DATAROOT_ERROR', 2);
116 * Automatically clean-up all plugin data and remove the plugin DB tables
118 * NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead!
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
125 function uninstall_plugin($type, $name) {
126 global $CFG, $DB, $OUTPUT;
128 // This may take a long time.
129 core_php_time_limit
::raise();
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);
135 if (file_exists("$base/db/subplugins.php")) {
136 $subplugins = array();
137 include("$base/db/subplugins.php");
138 foreach ($subplugins as $subplugintype=>$dir) {
139 $instances = core_component
::get_plugin_list($subplugintype);
140 foreach ($instances as $subpluginname => $notusedpluginpath) {
141 uninstall_plugin($subplugintype, $subpluginname);
148 $component = $type . '_' . $name; // eg. 'qtype_multichoice' or 'workshopgrading_accumulative' or 'mod_forum'
150 if ($type === 'mod') {
151 $pluginname = $name; // eg. 'forum'
152 if (get_string_manager()->string_exists('modulename', $component)) {
153 $strpluginname = get_string('modulename', $component);
155 $strpluginname = $component;
159 $pluginname = $component;
160 if (get_string_manager()->string_exists('pluginname', $component)) {
161 $strpluginname = get_string('pluginname', $component);
163 $strpluginname = $component;
167 echo $OUTPUT->heading($pluginname);
169 // Delete all tag instances associated with this plugin.
170 require_once($CFG->dirroot
. '/tag/lib.php');
171 tag_delete_instances($component);
173 // Custom plugin uninstall.
174 $plugindirectory = core_component
::get_plugin_directory($type, $name);
175 $uninstalllib = $plugindirectory . '/db/uninstall.php';
176 if (file_exists($uninstalllib)) {
177 require_once($uninstalllib);
178 $uninstallfunction = 'xmldb_' . $pluginname . '_uninstall'; // eg. 'xmldb_workshop_uninstall()'
179 if (function_exists($uninstallfunction)) {
180 // Do not verify result, let plugin complain if necessary.
181 $uninstallfunction();
185 // Specific plugin type cleanup.
186 $plugininfo = core_plugin_manager
::instance()->get_plugin_info($component);
188 $plugininfo->uninstall_cleanup();
189 core_plugin_manager
::reset_caches();
193 // perform clean-up task common for all the plugin/subplugin types
195 //delete the web service functions and pre-built services
196 require_once($CFG->dirroot
.'/lib/externallib.php');
197 external_delete_descriptions($component);
199 // delete calendar events
200 $DB->delete_records('event', array('modulename' => $pluginname));
202 // Delete scheduled tasks.
203 $DB->delete_records('task_scheduled', array('component' => $pluginname));
205 // Delete Inbound Message datakeys.
206 $DB->delete_records_select('messageinbound_datakeys',
207 'handler IN (SELECT id FROM {messageinbound_handlers} WHERE component = ?)', array($pluginname));
209 // Delete Inbound Message handlers.
210 $DB->delete_records('messageinbound_handlers', array('component' => $pluginname));
212 // delete all the logs
213 $DB->delete_records('log', array('module' => $pluginname));
215 // delete log_display information
216 $DB->delete_records('log_display', array('component' => $component));
218 // delete the module configuration records
219 unset_all_config_for_plugin($component);
220 if ($type === 'mod') {
221 unset_all_config_for_plugin($pluginname);
224 // delete message provider
225 message_provider_uninstall($component);
227 // delete the plugin tables
228 $xmldbfilepath = $plugindirectory . '/db/install.xml';
229 drop_plugin_tables($component, $xmldbfilepath, false);
230 if ($type === 'mod' or $type === 'block') {
231 // non-frankenstyle table prefixes
232 drop_plugin_tables($name, $xmldbfilepath, false);
235 // delete the capabilities that were defined by this module
236 capabilities_cleanup($component);
238 // remove event handlers and dequeue pending events
239 events_uninstall($component);
241 // Delete all remaining files in the filepool owned by the component.
242 $fs = get_file_storage();
243 $fs->delete_component_files($component);
245 // Finally purge all caches.
248 // Invalidate the hash used for upgrade detections.
249 set_config('allversionshash', '');
251 echo $OUTPUT->notification(get_string('success'), 'notifysuccess');
255 * Returns the version of installed component
257 * @param string $component component name
258 * @param string $source either 'disk' or 'installed' - where to get the version information from
259 * @return string|bool version number or false if the component is not found
261 function get_component_version($component, $source='installed') {
264 list($type, $name) = core_component
::normalize_component($component);
266 // moodle core or a core subsystem
267 if ($type === 'core') {
268 if ($source === 'installed') {
269 if (empty($CFG->version
)) {
272 return $CFG->version
;
275 if (!is_readable($CFG->dirroot
.'/version.php')) {
278 $version = null; //initialize variable for IDEs
279 include($CFG->dirroot
.'/version.php');
286 if ($type === 'mod') {
287 if ($source === 'installed') {
288 if ($CFG->version
< 2013092001.02) {
289 return $DB->get_field('modules', 'version', array('name'=>$name));
291 return get_config('mod_'.$name, 'version');
295 $mods = core_component
::get_plugin_list('mod');
296 if (empty($mods[$name]) or !is_readable($mods[$name].'/version.php')) {
299 $plugin = new stdClass();
300 $plugin->version
= null;
302 include($mods[$name].'/version.php');
303 return $plugin->version
;
309 if ($type === 'block') {
310 if ($source === 'installed') {
311 if ($CFG->version
< 2013092001.02) {
312 return $DB->get_field('block', 'version', array('name'=>$name));
314 return get_config('block_'.$name, 'version');
317 $blocks = core_component
::get_plugin_list('block');
318 if (empty($blocks[$name]) or !is_readable($blocks[$name].'/version.php')) {
321 $plugin = new stdclass();
322 include($blocks[$name].'/version.php');
323 return $plugin->version
;
328 // all other plugin types
329 if ($source === 'installed') {
330 return get_config($type.'_'.$name, 'version');
332 $plugins = core_component
::get_plugin_list($type);
333 if (empty($plugins[$name])) {
336 $plugin = new stdclass();
337 include($plugins[$name].'/version.php');
338 return $plugin->version
;
344 * Delete all plugin tables
346 * @param string $name Name of plugin, used as table prefix
347 * @param string $file Path to install.xml file
348 * @param bool $feedback defaults to true
349 * @return bool Always returns true
351 function drop_plugin_tables($name, $file, $feedback=true) {
354 // first try normal delete
355 if (file_exists($file) and $DB->get_manager()->delete_tables_from_xmldb_file($file)) {
359 // then try to find all tables that start with name and are not in any xml file
360 $used_tables = get_used_table_names();
362 $tables = $DB->get_tables();
364 /// Iterate over, fixing id fields as necessary
365 foreach ($tables as $table) {
366 if (in_array($table, $used_tables)) {
370 if (strpos($table, $name) !== 0) {
374 // found orphan table --> delete it
375 if ($DB->get_manager()->table_exists($table)) {
376 $xmldb_table = new xmldb_table($table);
377 $DB->get_manager()->drop_table($xmldb_table);
385 * Returns names of all known tables == tables that moodle knows about.
387 * @return array Array of lowercase table names
389 function get_used_table_names() {
390 $table_names = array();
391 $dbdirs = get_db_directories();
393 foreach ($dbdirs as $dbdir) {
394 $file = $dbdir.'/install.xml';
396 $xmldb_file = new xmldb_file($file);
398 if (!$xmldb_file->fileExists()) {
402 $loaded = $xmldb_file->loadXMLStructure();
403 $structure = $xmldb_file->getStructure();
405 if ($loaded and $tables = $structure->getTables()) {
406 foreach($tables as $table) {
407 $table_names[] = strtolower($table->getName());
416 * Returns list of all directories where we expect install.xml files
417 * @return array Array of paths
419 function get_db_directories() {
424 /// First, the main one (lib/db)
425 $dbdirs[] = $CFG->libdir
.'/db';
427 /// Then, all the ones defined by core_component::get_plugin_types()
428 $plugintypes = core_component
::get_plugin_types();
429 foreach ($plugintypes as $plugintype => $pluginbasedir) {
430 if ($plugins = core_component
::get_plugin_list($plugintype)) {
431 foreach ($plugins as $plugin => $plugindir) {
432 $dbdirs[] = $plugindir.'/db';
441 * Try to obtain or release the cron lock.
442 * @param string $name name of lock
443 * @param int $until timestamp when this lock considered stale, null means remove lock unconditionally
444 * @param bool $ignorecurrent ignore current lock state, usually extend previous lock, defaults to false
445 * @return bool true if lock obtained
447 function set_cron_lock($name, $until, $ignorecurrent=false) {
450 debugging("Tried to get a cron lock for a null fieldname");
454 // remove lock by force == remove from config table
455 if (is_null($until)) {
456 set_config($name, null);
460 if (!$ignorecurrent) {
461 // read value from db - other processes might have changed it
462 $value = $DB->get_field('config', 'value', array('name'=>$name));
464 if ($value and $value > time()) {
470 set_config($name, $until);
475 * Test if and critical warnings are present
478 function admin_critical_warnings_present() {
481 if (!has_capability('moodle/site:config', context_system
::instance())) {
485 if (!isset($SESSION->admin_critical_warning
)) {
486 $SESSION->admin_critical_warning
= 0;
487 if (is_dataroot_insecure(true) === INSECURE_DATAROOT_ERROR
) {
488 $SESSION->admin_critical_warning
= 1;
492 return $SESSION->admin_critical_warning
;
496 * Detects if float supports at least 10 decimal digits
498 * Detects if float supports at least 10 decimal digits
499 * and also if float-->string conversion works as expected.
501 * @return bool true if problem found
503 function is_float_problem() {
504 $num1 = 2009010200.01;
505 $num2 = 2009010200.02;
507 return ((string)$num1 === (string)$num2 or $num1 === $num2 or $num2 <= (string)$num1);
511 * Try to verify that dataroot is not accessible from web.
513 * Try to verify that dataroot is not accessible from web.
514 * It is not 100% correct but might help to reduce number of vulnerable sites.
515 * Protection from httpd.conf and .htaccess is not detected properly.
517 * @uses INSECURE_DATAROOT_WARNING
518 * @uses INSECURE_DATAROOT_ERROR
519 * @param bool $fetchtest try to test public access by fetching file, default false
520 * @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic
522 function is_dataroot_insecure($fetchtest=false) {
525 $siteroot = str_replace('\\', '/', strrev($CFG->dirroot
.'/')); // win32 backslash workaround
527 $rp = preg_replace('|https?://[^/]+|i', '', $CFG->wwwroot
, 1);
528 $rp = strrev(trim($rp, '/'));
529 $rp = explode('/', $rp);
531 if (strpos($siteroot, '/'.$r.'/') === 0) {
532 $siteroot = substr($siteroot, strlen($r)+
1); // moodle web in subdirectory
534 break; // probably alias root
538 $siteroot = strrev($siteroot);
539 $dataroot = str_replace('\\', '/', $CFG->dataroot
.'/');
541 if (strpos($dataroot, $siteroot) !== 0) {
546 return INSECURE_DATAROOT_WARNING
;
549 // now try all methods to fetch a test file using http protocol
551 $httpdocroot = str_replace('\\', '/', strrev($CFG->dirroot
.'/'));
552 preg_match('|(https?://[^/]+)|i', $CFG->wwwroot
, $matches);
553 $httpdocroot = $matches[1];
554 $datarooturl = $httpdocroot.'/'. substr($dataroot, strlen($siteroot));
555 make_upload_directory('diag');
556 $testfile = $CFG->dataroot
.'/diag/public.txt';
557 if (!file_exists($testfile)) {
558 file_put_contents($testfile, 'test file, do not delete');
559 @chmod
($testfile, $CFG->filepermissions
);
561 $teststr = trim(file_get_contents($testfile));
562 if (empty($teststr)) {
564 return INSECURE_DATAROOT_WARNING
;
567 $testurl = $datarooturl.'/diag/public.txt';
568 if (extension_loaded('curl') and
569 !(stripos(ini_get('disable_functions'), 'curl_init') !== FALSE) and
570 !(stripos(ini_get('disable_functions'), 'curl_setop') !== FALSE) and
571 ($ch = @curl_init
($testurl)) !== false) {
572 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, true);
573 curl_setopt($ch, CURLOPT_HEADER
, false);
574 $data = curl_exec($ch);
575 if (!curl_errno($ch)) {
577 if ($data === $teststr) {
579 return INSECURE_DATAROOT_ERROR
;
585 if ($data = @file_get_contents
($testurl)) {
587 if ($data === $teststr) {
588 return INSECURE_DATAROOT_ERROR
;
592 preg_match('|https?://([^/]+)|i', $testurl, $matches);
593 $sitename = $matches[1];
595 if ($fp = @fsockopen
($sitename, 80, $error)) {
596 preg_match('|https?://[^/]+(.*)|i', $testurl, $matches);
597 $localurl = $matches[1];
598 $out = "GET $localurl HTTP/1.1\r\n";
599 $out .= "Host: $sitename\r\n";
600 $out .= "Connection: Close\r\n\r\n";
606 $data .= fgets($fp, 1024);
607 } else if (@fgets
($fp, 1024) === "\r\n") {
613 if ($data === $teststr) {
614 return INSECURE_DATAROOT_ERROR
;
618 return INSECURE_DATAROOT_WARNING
;
622 * Enables CLI maintenance mode by creating new dataroot/climaintenance.html file.
624 function enable_cli_maintenance_mode() {
627 if (file_exists("$CFG->dataroot/climaintenance.html")) {
628 unlink("$CFG->dataroot/climaintenance.html");
631 if (isset($CFG->maintenance_message
) and !html_is_blank($CFG->maintenance_message
)) {
632 $data = $CFG->maintenance_message
;
633 $data = bootstrap_renderer
::early_error_content($data, null, null, null);
634 $data = bootstrap_renderer
::plain_page(get_string('sitemaintenance', 'admin'), $data);
636 } else if (file_exists("$CFG->dataroot/climaintenance.template.html")) {
637 $data = file_get_contents("$CFG->dataroot/climaintenance.template.html");
640 $data = get_string('sitemaintenance', 'admin');
641 $data = bootstrap_renderer
::early_error_content($data, null, null, null);
642 $data = bootstrap_renderer
::plain_page(get_string('sitemaintenance', 'admin'), $data);
645 file_put_contents("$CFG->dataroot/climaintenance.html", $data);
646 chmod("$CFG->dataroot/climaintenance.html", $CFG->filepermissions
);
649 /// CLASS DEFINITIONS /////////////////////////////////////////////////////////
653 * Interface for anything appearing in the admin tree
655 * The interface that is implemented by anything that appears in the admin tree
656 * block. It forces inheriting classes to define a method for checking user permissions
657 * and methods for finding something in the admin tree.
659 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
661 interface part_of_admin_tree
{
664 * Finds a named part_of_admin_tree.
666 * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
667 * and not parentable_part_of_admin_tree, then this function should only check if
668 * $this->name matches $name. If it does, it should return a reference to $this,
669 * otherwise, it should return a reference to NULL.
671 * If a class inherits parentable_part_of_admin_tree, this method should be called
672 * recursively on all child objects (assuming, of course, the parent object's name
673 * doesn't match the search criterion).
675 * @param string $name The internal name of the part_of_admin_tree we're searching for.
676 * @return mixed An object reference or a NULL reference.
678 public function locate($name);
681 * Removes named part_of_admin_tree.
683 * @param string $name The internal name of the part_of_admin_tree we want to remove.
684 * @return bool success.
686 public function prune($name);
690 * @param string $query
691 * @return mixed array-object structure of found settings and pages
693 public function search($query);
696 * Verifies current user's access to this part_of_admin_tree.
698 * Used to check if the current user has access to this part of the admin tree or
699 * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
700 * then this method is usually just a call to has_capability() in the site context.
702 * If a class inherits parentable_part_of_admin_tree, this method should return the
703 * logical OR of the return of check_access() on all child objects.
705 * @return bool True if the user has access, false if she doesn't.
707 public function check_access();
710 * Mostly useful for removing of some parts of the tree in admin tree block.
712 * @return True is hidden from normal list view
714 public function is_hidden();
717 * Show we display Save button at the page bottom?
720 public function show_save();
725 * Interface implemented by any part_of_admin_tree that has children.
727 * The interface implemented by any part_of_admin_tree that can be a parent
728 * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
729 * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
730 * include an add method for adding other part_of_admin_tree objects as children.
732 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
734 interface parentable_part_of_admin_tree
extends part_of_admin_tree
{
737 * Adds a part_of_admin_tree object to the admin tree.
739 * Used to add a part_of_admin_tree object to this object or a child of this
740 * object. $something should only be added if $destinationname matches
741 * $this->name. If it doesn't, add should be called on child objects that are
742 * also parentable_part_of_admin_tree's.
744 * $something should be appended as the last child in the $destinationname. If the
745 * $beforesibling is specified, $something should be prepended to it. If the given
746 * sibling is not found, $something should be appended to the end of $destinationname
747 * and a developer debugging message should be displayed.
749 * @param string $destinationname The internal name of the new parent for $something.
750 * @param part_of_admin_tree $something The object to be added.
751 * @return bool True on success, false on failure.
753 public function add($destinationname, $something, $beforesibling = null);
759 * The object used to represent folders (a.k.a. categories) in the admin tree block.
761 * Each admin_category object contains a number of part_of_admin_tree objects.
763 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
765 class admin_category
implements parentable_part_of_admin_tree
{
767 /** @var part_of_admin_tree[] An array of part_of_admin_tree objects that are this object's children */
769 /** @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects */
771 /** @var string The displayed name for this category. Usually obtained through get_string() */
773 /** @var bool Should this category be hidden in admin tree block? */
775 /** @var mixed Either a string or an array or strings */
777 /** @var mixed Either a string or an array or strings */
780 /** @var array fast lookup category cache, all categories of one tree point to one cache */
781 protected $category_cache;
783 /** @var bool If set to true children will be sorted when calling {@link admin_category::get_children()} */
784 protected $sort = false;
785 /** @var bool If set to true children will be sorted in ascending order. */
786 protected $sortasc = true;
787 /** @var bool If set to true sub categories and pages will be split and then sorted.. */
788 protected $sortsplit = true;
789 /** @var bool $sorted True if the children have been sorted and don't need resorting */
790 protected $sorted = false;
793 * Constructor for an empty admin category
795 * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
796 * @param string $visiblename The displayed named for this category. Usually obtained through get_string()
797 * @param bool $hidden hide category in admin tree block, defaults to false
799 public function __construct($name, $visiblename, $hidden=false) {
800 $this->children
= array();
802 $this->visiblename
= $visiblename;
803 $this->hidden
= $hidden;
807 * Returns a reference to the part_of_admin_tree object with internal name $name.
809 * @param string $name The internal name of the object we want.
810 * @param bool $findpath initialize path and visiblepath arrays
811 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
814 public function locate($name, $findpath=false) {
815 if (!isset($this->category_cache
[$this->name
])) {
816 // somebody much have purged the cache
817 $this->category_cache
[$this->name
] = $this;
820 if ($this->name
== $name) {
822 $this->visiblepath
[] = $this->visiblename
;
823 $this->path
[] = $this->name
;
828 // quick category lookup
829 if (!$findpath and isset($this->category_cache
[$name])) {
830 return $this->category_cache
[$name];
834 foreach($this->children
as $childid=>$unused) {
835 if ($return = $this->children
[$childid]->locate($name, $findpath)) {
840 if (!is_null($return) and $findpath) {
841 $return->visiblepath
[] = $this->visiblename
;
842 $return->path
[] = $this->name
;
851 * @param string query
852 * @return mixed array-object structure of found settings and pages
854 public function search($query) {
856 foreach ($this->get_children() as $child) {
857 $subsearch = $child->search($query);
858 if (!is_array($subsearch)) {
859 debugging('Incorrect search result from '.$child->name
);
862 $result = array_merge($result, $subsearch);
868 * Removes part_of_admin_tree object with internal name $name.
870 * @param string $name The internal name of the object we want to remove.
871 * @return bool success
873 public function prune($name) {
875 if ($this->name
== $name) {
876 return false; //can not remove itself
879 foreach($this->children
as $precedence => $child) {
880 if ($child->name
== $name) {
881 // clear cache and delete self
882 while($this->category_cache
) {
883 // delete the cache, but keep the original array address
884 array_pop($this->category_cache
);
886 unset($this->children
[$precedence]);
888 } else if ($this->children
[$precedence]->prune($name)) {
896 * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
898 * By default the new part of the tree is appended as the last child of the parent. You
899 * can specify a sibling node that the new part should be prepended to. If the given
900 * sibling is not found, the part is appended to the end (as it would be by default) and
901 * a developer debugging message is displayed.
903 * @throws coding_exception if the $beforesibling is empty string or is not string at all.
904 * @param string $destinationame The internal name of the immediate parent that we want for $something.
905 * @param mixed $something A part_of_admin_tree or setting instance to be added.
906 * @param string $beforesibling The name of the parent's child the $something should be prepended to.
907 * @return bool True if successfully added, false if $something can not be added.
909 public function add($parentname, $something, $beforesibling = null) {
912 $parent = $this->locate($parentname);
913 if (is_null($parent)) {
914 debugging('parent does not exist!');
918 if ($something instanceof part_of_admin_tree
) {
919 if (!($parent instanceof parentable_part_of_admin_tree
)) {
920 debugging('error - parts of tree can be inserted only into parentable parts');
923 if ($CFG->debugdeveloper
&& !is_null($this->locate($something->name
))) {
924 // The name of the node is already used, simply warn the developer that this should not happen.
925 // It is intentional to check for the debug level before performing the check.
926 debugging('Duplicate admin page name: ' . $something->name
, DEBUG_DEVELOPER
);
928 if (is_null($beforesibling)) {
929 // Append $something as the parent's last child.
930 $parent->children
[] = $something;
932 if (!is_string($beforesibling) or trim($beforesibling) === '') {
933 throw new coding_exception('Unexpected value of the beforesibling parameter');
935 // Try to find the position of the sibling.
936 $siblingposition = null;
937 foreach ($parent->children
as $childposition => $child) {
938 if ($child->name
=== $beforesibling) {
939 $siblingposition = $childposition;
943 if (is_null($siblingposition)) {
944 debugging('Sibling '.$beforesibling.' not found', DEBUG_DEVELOPER
);
945 $parent->children
[] = $something;
947 $parent->children
= array_merge(
948 array_slice($parent->children
, 0, $siblingposition),
950 array_slice($parent->children
, $siblingposition)
954 if ($something instanceof admin_category
) {
955 if (isset($this->category_cache
[$something->name
])) {
956 debugging('Duplicate admin category name: '.$something->name
);
958 $this->category_cache
[$something->name
] = $something;
959 $something->category_cache
=& $this->category_cache
;
960 foreach ($something->children
as $child) {
961 // just in case somebody already added subcategories
962 if ($child instanceof admin_category
) {
963 if (isset($this->category_cache
[$child->name
])) {
964 debugging('Duplicate admin category name: '.$child->name
);
966 $this->category_cache
[$child->name
] = $child;
967 $child->category_cache
=& $this->category_cache
;
976 debugging('error - can not add this element');
983 * Checks if the user has access to anything in this category.
985 * @return bool True if the user has access to at least one child in this category, false otherwise.
987 public function check_access() {
988 foreach ($this->children
as $child) {
989 if ($child->check_access()) {
997 * Is this category hidden in admin tree block?
999 * @return bool True if hidden
1001 public function is_hidden() {
1002 return $this->hidden
;
1006 * Show we display Save button at the page bottom?
1009 public function show_save() {
1010 foreach ($this->children
as $child) {
1011 if ($child->show_save()) {
1019 * Sets sorting on this category.
1021 * Please note this function doesn't actually do the sorting.
1022 * It can be called anytime.
1023 * Sorting occurs when the user calls get_children.
1024 * Code using the children array directly won't see the sorted results.
1026 * @param bool $sort If set to true children will be sorted, if false they won't be.
1027 * @param bool $asc If true sorting will be ascending, otherwise descending.
1028 * @param bool $split If true we sort pages and sub categories separately.
1030 public function set_sorting($sort, $asc = true, $split = true) {
1031 $this->sort
= (bool)$sort;
1032 $this->sortasc
= (bool)$asc;
1033 $this->sortsplit
= (bool)$split;
1037 * Returns the children associated with this category.
1039 * @return part_of_admin_tree[]
1041 public function get_children() {
1042 // If we should sort and it hasn't already been sorted.
1043 if ($this->sort
&& !$this->sorted
) {
1044 if ($this->sortsplit
) {
1045 $categories = array();
1047 foreach ($this->children
as $child) {
1048 if ($child instanceof admin_category
) {
1049 $categories[] = $child;
1054 core_collator
::asort_objects_by_property($categories, 'visiblename');
1055 core_collator
::asort_objects_by_property($pages, 'visiblename');
1056 if (!$this->sortasc
) {
1057 $categories = array_reverse($categories);
1058 $pages = array_reverse($pages);
1060 $this->children
= array_merge($pages, $categories);
1062 core_collator
::asort_objects_by_property($this->children
, 'visiblename');
1063 if (!$this->sortasc
) {
1064 $this->children
= array_reverse($this->children
);
1067 $this->sorted
= true;
1069 return $this->children
;
1073 * Magically gets a property from this object.
1076 * @return part_of_admin_tree[]
1077 * @throws coding_exception
1079 public function __get($property) {
1080 if ($property === 'children') {
1081 return $this->get_children();
1083 throw new coding_exception('Invalid property requested.');
1087 * Magically sets a property against this object.
1089 * @param string $property
1090 * @param mixed $value
1091 * @throws coding_exception
1093 public function __set($property, $value) {
1094 if ($property === 'children') {
1095 $this->sorted
= false;
1096 $this->children
= $value;
1098 throw new coding_exception('Invalid property requested.');
1103 * Checks if an inaccessible property is set.
1105 * @param string $property
1107 * @throws coding_exception
1109 public function __isset($property) {
1110 if ($property === 'children') {
1111 return isset($this->children
);
1113 throw new coding_exception('Invalid property requested.');
1119 * Root of admin settings tree, does not have any parent.
1121 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1123 class admin_root
extends admin_category
{
1124 /** @var array List of errors */
1126 /** @var string search query */
1128 /** @var bool full tree flag - true means all settings required, false only pages required */
1130 /** @var bool flag indicating loaded tree */
1132 /** @var mixed site custom defaults overriding defaults in settings files*/
1133 public $custom_defaults;
1136 * @param bool $fulltree true means all settings required,
1137 * false only pages required
1139 public function __construct($fulltree) {
1142 parent
::__construct('root', get_string('administration'), false);
1143 $this->errors
= array();
1145 $this->fulltree
= $fulltree;
1146 $this->loaded
= false;
1148 $this->category_cache
= array();
1150 // load custom defaults if found
1151 $this->custom_defaults
= null;
1152 $defaultsfile = "$CFG->dirroot/local/defaults.php";
1153 if (is_readable($defaultsfile)) {
1154 $defaults = array();
1155 include($defaultsfile);
1156 if (is_array($defaults) and count($defaults)) {
1157 $this->custom_defaults
= $defaults;
1163 * Empties children array, and sets loaded to false
1165 * @param bool $requirefulltree
1167 public function purge_children($requirefulltree) {
1168 $this->children
= array();
1169 $this->fulltree
= ($requirefulltree ||
$this->fulltree
);
1170 $this->loaded
= false;
1171 //break circular dependencies - this helps PHP 5.2
1172 while($this->category_cache
) {
1173 array_pop($this->category_cache
);
1175 $this->category_cache
= array();
1181 * Links external PHP pages into the admin tree.
1183 * See detailed usage example at the top of this document (adminlib.php)
1185 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1187 class admin_externalpage
implements part_of_admin_tree
{
1189 /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
1192 /** @var string The displayed name for this external page. Usually obtained through get_string(). */
1193 public $visiblename;
1195 /** @var string The external URL that we should link to when someone requests this external page. */
1198 /** @var string The role capability/permission a user must have to access this external page. */
1199 public $req_capability;
1201 /** @var object The context in which capability/permission should be checked, default is site context. */
1204 /** @var bool hidden in admin tree block. */
1207 /** @var mixed either string or array of string */
1210 /** @var array list of visible names of page parents */
1211 public $visiblepath;
1214 * Constructor for adding an external page into the admin tree.
1216 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1217 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1218 * @param string $url The external URL that we should link to when someone requests this external page.
1219 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1220 * @param boolean $hidden Is this external page hidden in admin tree block? Default false.
1221 * @param stdClass $context The context the page relates to. Not sure what happens
1222 * if you specify something other than system or front page. Defaults to system.
1224 public function __construct($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1225 $this->name
= $name;
1226 $this->visiblename
= $visiblename;
1228 if (is_array($req_capability)) {
1229 $this->req_capability
= $req_capability;
1231 $this->req_capability
= array($req_capability);
1233 $this->hidden
= $hidden;
1234 $this->context
= $context;
1238 * Returns a reference to the part_of_admin_tree object with internal name $name.
1240 * @param string $name The internal name of the object we want.
1241 * @param bool $findpath defaults to false
1242 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1244 public function locate($name, $findpath=false) {
1245 if ($this->name
== $name) {
1247 $this->visiblepath
= array($this->visiblename
);
1248 $this->path
= array($this->name
);
1258 * This function always returns false, required function by interface
1260 * @param string $name
1263 public function prune($name) {
1268 * Search using query
1270 * @param string $query
1271 * @return mixed array-object structure of found settings and pages
1273 public function search($query) {
1275 if (strpos(strtolower($this->name
), $query) !== false) {
1277 } else if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
1281 $result = new stdClass();
1282 $result->page
= $this;
1283 $result->settings
= array();
1284 return array($this->name
=> $result);
1291 * Determines if the current user has access to this external page based on $this->req_capability.
1293 * @return bool True if user has access, false otherwise.
1295 public function check_access() {
1297 $context = empty($this->context
) ? context_system
::instance() : $this->context
;
1298 foreach($this->req_capability
as $cap) {
1299 if (has_capability($cap, $context)) {
1307 * Is this external page hidden in admin tree block?
1309 * @return bool True if hidden
1311 public function is_hidden() {
1312 return $this->hidden
;
1316 * Show we display Save button at the page bottom?
1319 public function show_save() {
1326 * Used to group a number of admin_setting objects into a page and add them to the admin tree.
1328 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1330 class admin_settingpage
implements part_of_admin_tree
{
1332 /** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
1335 /** @var string The displayed name for this external page. Usually obtained through get_string(). */
1336 public $visiblename;
1338 /** @var mixed An array of admin_setting objects that are part of this setting page. */
1341 /** @var string The role capability/permission a user must have to access this external page. */
1342 public $req_capability;
1344 /** @var object The context in which capability/permission should be checked, default is site context. */
1347 /** @var bool hidden in admin tree block. */
1350 /** @var mixed string of paths or array of strings of paths */
1353 /** @var array list of visible names of page parents */
1354 public $visiblepath;
1357 * see admin_settingpage for details of this function
1359 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1360 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1361 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1362 * @param boolean $hidden Is this external page hidden in admin tree block? Default false.
1363 * @param stdClass $context The context the page relates to. Not sure what happens
1364 * if you specify something other than system or front page. Defaults to system.
1366 public function __construct($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1367 $this->settings
= new stdClass();
1368 $this->name
= $name;
1369 $this->visiblename
= $visiblename;
1370 if (is_array($req_capability)) {
1371 $this->req_capability
= $req_capability;
1373 $this->req_capability
= array($req_capability);
1375 $this->hidden
= $hidden;
1376 $this->context
= $context;
1380 * see admin_category
1382 * @param string $name
1383 * @param bool $findpath
1384 * @return mixed Object (this) if name == this->name, else returns null
1386 public function locate($name, $findpath=false) {
1387 if ($this->name
== $name) {
1389 $this->visiblepath
= array($this->visiblename
);
1390 $this->path
= array($this->name
);
1400 * Search string in settings page.
1402 * @param string $query
1405 public function search($query) {
1408 foreach ($this->settings
as $setting) {
1409 if ($setting->is_related($query)) {
1410 $found[] = $setting;
1415 $result = new stdClass();
1416 $result->page
= $this;
1417 $result->settings
= $found;
1418 return array($this->name
=> $result);
1422 if (strpos(strtolower($this->name
), $query) !== false) {
1424 } else if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
1428 $result = new stdClass();
1429 $result->page
= $this;
1430 $result->settings
= array();
1431 return array($this->name
=> $result);
1438 * This function always returns false, required by interface
1440 * @param string $name
1441 * @return bool Always false
1443 public function prune($name) {
1448 * adds an admin_setting to this admin_settingpage
1450 * 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
1451 * n.b. each admin_setting in an admin_settingpage must have a unique internal name
1453 * @param object $setting is the admin_setting object you want to add
1454 * @return bool true if successful, false if not
1456 public function add($setting) {
1457 if (!($setting instanceof admin_setting
)) {
1458 debugging('error - not a setting instance');
1462 $this->settings
->{$setting->name
} = $setting;
1467 * see admin_externalpage
1469 * @return bool Returns true for yes false for no
1471 public function check_access() {
1473 $context = empty($this->context
) ? context_system
::instance() : $this->context
;
1474 foreach($this->req_capability
as $cap) {
1475 if (has_capability($cap, $context)) {
1483 * outputs this page as html in a table (suitable for inclusion in an admin pagetype)
1484 * @return string Returns an XHTML string
1486 public function output_html() {
1487 $adminroot = admin_get_root();
1488 $return = '<fieldset>'."\n".'<div class="clearer"><!-- --></div>'."\n";
1489 foreach($this->settings
as $setting) {
1490 $fullname = $setting->get_full_name();
1491 if (array_key_exists($fullname, $adminroot->errors
)) {
1492 $data = $adminroot->errors
[$fullname]->data
;
1494 $data = $setting->get_setting();
1495 // do not use defaults if settings not available - upgrade settings handles the defaults!
1497 $return .= $setting->output_html($data);
1499 $return .= '</fieldset>';
1504 * Is this settings page hidden in admin tree block?
1506 * @return bool True if hidden
1508 public function is_hidden() {
1509 return $this->hidden
;
1513 * Show we display Save button at the page bottom?
1516 public function show_save() {
1517 foreach($this->settings
as $setting) {
1518 if (empty($setting->nosave
)) {
1528 * Admin settings class. Only exists on setting pages.
1529 * Read & write happens at this level; no authentication.
1531 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1533 abstract class admin_setting
{
1534 /** @var string unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. */
1536 /** @var string localised name */
1537 public $visiblename;
1538 /** @var string localised long description in Markdown format */
1539 public $description;
1540 /** @var mixed Can be string or array of string */
1541 public $defaultsetting;
1543 public $updatedcallback;
1544 /** @var mixed can be String or Null. Null means main config table */
1545 public $plugin; // null means main config table
1546 /** @var bool true indicates this setting does not actually save anything, just information */
1547 public $nosave = false;
1548 /** @var bool if set, indicates that a change to this setting requires rebuild course cache */
1549 public $affectsmodinfo = false;
1550 /** @var array of admin_setting_flag - These are extra checkboxes attached to a setting. */
1551 private $flags = array();
1555 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
1556 * or 'myplugin/mysetting' for ones in config_plugins.
1557 * @param string $visiblename localised name
1558 * @param string $description localised long description
1559 * @param mixed $defaultsetting string or array depending on implementation
1561 public function __construct($name, $visiblename, $description, $defaultsetting) {
1562 $this->parse_setting_name($name);
1563 $this->visiblename
= $visiblename;
1564 $this->description
= $description;
1565 $this->defaultsetting
= $defaultsetting;
1569 * Generic function to add a flag to this admin setting.
1571 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1572 * @param bool $default - The default for the flag
1573 * @param string $shortname - The shortname for this flag. Used as a suffix for the setting name.
1574 * @param string $displayname - The display name for this flag. Used as a label next to the checkbox.
1576 protected function set_flag_options($enabled, $default, $shortname, $displayname) {
1577 if (empty($this->flags
[$shortname])) {
1578 $this->flags
[$shortname] = new admin_setting_flag($enabled, $default, $shortname, $displayname);
1580 $this->flags
[$shortname]->set_options($enabled, $default);
1585 * Set the enabled options flag on this admin setting.
1587 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1588 * @param bool $default - The default for the flag
1590 public function set_enabled_flag_options($enabled, $default) {
1591 $this->set_flag_options($enabled, $default, 'enabled', new lang_string('enabled', 'core_admin'));
1595 * Set the advanced options flag on this admin setting.
1597 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1598 * @param bool $default - The default for the flag
1600 public function set_advanced_flag_options($enabled, $default) {
1601 $this->set_flag_options($enabled, $default, 'adv', new lang_string('advanced'));
1606 * Set the locked options flag on this admin setting.
1608 * @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
1609 * @param bool $default - The default for the flag
1611 public function set_locked_flag_options($enabled, $default) {
1612 $this->set_flag_options($enabled, $default, 'locked', new lang_string('locked', 'core_admin'));
1616 * Get the currently saved value for a setting flag
1618 * @param admin_setting_flag $flag - One of the admin_setting_flag for this admin_setting.
1621 public function get_setting_flag_value(admin_setting_flag
$flag) {
1622 $value = $this->config_read($this->name
. '_' . $flag->get_shortname());
1623 if (!isset($value)) {
1624 $value = $flag->get_default();
1627 return !empty($value);
1631 * Get the list of defaults for the flags on this setting.
1633 * @param array of strings describing the defaults for this setting. This is appended to by this function.
1635 public function get_setting_flag_defaults(& $defaults) {
1636 foreach ($this->flags
as $flag) {
1637 if ($flag->is_enabled() && $flag->get_default()) {
1638 $defaults[] = $flag->get_displayname();
1644 * Output the input fields for the advanced and locked flags on this setting.
1646 * @param bool $adv - The current value of the advanced flag.
1647 * @param bool $locked - The current value of the locked flag.
1648 * @return string $output - The html for the flags.
1650 public function output_setting_flags() {
1653 foreach ($this->flags
as $flag) {
1654 if ($flag->is_enabled()) {
1655 $output .= $flag->output_setting_flag($this);
1659 if (!empty($output)) {
1660 return html_writer
::tag('span', $output, array('class' => 'adminsettingsflags'));
1666 * Write the values of the flags for this admin setting.
1668 * @param array $data - The data submitted from the form or null to set the default value for new installs.
1669 * @return bool - true if successful.
1671 public function write_setting_flags($data) {
1673 foreach ($this->flags
as $flag) {
1674 $result = $result && $flag->write_setting_flag($this, $data);
1680 * Set up $this->name and potentially $this->plugin
1682 * Set up $this->name and possibly $this->plugin based on whether $name looks
1683 * like 'settingname' or 'plugin/settingname'. Also, do some sanity checking
1684 * on the names, that is, output a developer debug warning if the name
1685 * contains anything other than [a-zA-Z0-9_]+.
1687 * @param string $name the setting name passed in to the constructor.
1689 private function parse_setting_name($name) {
1690 $bits = explode('/', $name);
1691 if (count($bits) > 2) {
1692 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1694 $this->name
= array_pop($bits);
1695 if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->name
)) {
1696 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1698 if (!empty($bits)) {
1699 $this->plugin
= array_pop($bits);
1700 if ($this->plugin
=== 'moodle') {
1701 $this->plugin
= null;
1702 } else if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->plugin
)) {
1703 throw new moodle_exception('invalidadminsettingname', '', '', $name);
1709 * Returns the fullname prefixed by the plugin
1712 public function get_full_name() {
1713 return 's_'.$this->plugin
.'_'.$this->name
;
1717 * Returns the ID string based on plugin and name
1720 public function get_id() {
1721 return 'id_s_'.$this->plugin
.'_'.$this->name
;
1725 * @param bool $affectsmodinfo If true, changes to this setting will
1726 * cause the course cache to be rebuilt
1728 public function set_affects_modinfo($affectsmodinfo) {
1729 $this->affectsmodinfo
= $affectsmodinfo;
1733 * Returns the config if possible
1735 * @return mixed returns config if successful else null
1737 public function config_read($name) {
1739 if (!empty($this->plugin
)) {
1740 $value = get_config($this->plugin
, $name);
1741 return $value === false ?
NULL : $value;
1744 if (isset($CFG->$name)) {
1753 * Used to set a config pair and log change
1755 * @param string $name
1756 * @param mixed $value Gets converted to string if not null
1757 * @return bool Write setting to config table
1759 public function config_write($name, $value) {
1760 global $DB, $USER, $CFG;
1762 if ($this->nosave
) {
1766 // make sure it is a real change
1767 $oldvalue = get_config($this->plugin
, $name);
1768 $oldvalue = ($oldvalue === false) ?
null : $oldvalue; // normalise
1769 $value = is_null($value) ?
null : (string)$value;
1771 if ($oldvalue === $value) {
1776 set_config($name, $value, $this->plugin
);
1778 // Some admin settings affect course modinfo
1779 if ($this->affectsmodinfo
) {
1780 // Clear course cache for all courses
1781 rebuild_course_cache(0, true);
1784 $this->add_to_config_log($name, $oldvalue, $value);
1786 return true; // BC only
1790 * Log config changes if necessary.
1791 * @param string $name
1792 * @param string $oldvalue
1793 * @param string $value
1795 protected function add_to_config_log($name, $oldvalue, $value) {
1796 add_to_config_log($name, $oldvalue, $value, $this->plugin
);
1800 * Returns current value of this setting
1801 * @return mixed array or string depending on instance, NULL means not set yet
1803 public abstract function get_setting();
1806 * Returns default setting if exists
1807 * @return mixed array or string depending on instance; NULL means no default, user must supply
1809 public function get_defaultsetting() {
1810 $adminroot = admin_get_root(false, false);
1811 if (!empty($adminroot->custom_defaults
)) {
1812 $plugin = is_null($this->plugin
) ?
'moodle' : $this->plugin
;
1813 if (isset($adminroot->custom_defaults
[$plugin])) {
1814 if (array_key_exists($this->name
, $adminroot->custom_defaults
[$plugin])) { // null is valid value here ;-)
1815 return $adminroot->custom_defaults
[$plugin][$this->name
];
1819 return $this->defaultsetting
;
1825 * @param mixed $data string or array, must not be NULL
1826 * @return string empty string if ok, string error message otherwise
1828 public abstract function write_setting($data);
1831 * Return part of form with setting
1832 * This function should always be overwritten
1834 * @param mixed $data array or string depending on setting
1835 * @param string $query
1838 public function output_html($data, $query='') {
1839 // should be overridden
1844 * Function called if setting updated - cleanup, cache reset, etc.
1845 * @param string $functionname Sets the function name
1848 public function set_updatedcallback($functionname) {
1849 $this->updatedcallback
= $functionname;
1853 * Execute postupdatecallback if necessary.
1854 * @param mixed $original original value before write_setting()
1855 * @return bool true if changed, false if not.
1857 public function post_write_settings($original) {
1858 // Comparison must work for arrays too.
1859 if (serialize($original) === serialize($this->get_setting())) {
1863 $callbackfunction = $this->updatedcallback
;
1864 if (!empty($callbackfunction) and function_exists($callbackfunction)) {
1865 $callbackfunction($this->get_full_name());
1871 * Is setting related to query text - used when searching
1872 * @param string $query
1875 public function is_related($query) {
1876 if (strpos(strtolower($this->name
), $query) !== false) {
1879 if (strpos(core_text
::strtolower($this->visiblename
), $query) !== false) {
1882 if (strpos(core_text
::strtolower($this->description
), $query) !== false) {
1885 $current = $this->get_setting();
1886 if (!is_null($current)) {
1887 if (is_string($current)) {
1888 if (strpos(core_text
::strtolower($current), $query) !== false) {
1893 $default = $this->get_defaultsetting();
1894 if (!is_null($default)) {
1895 if (is_string($default)) {
1896 if (strpos(core_text
::strtolower($default), $query) !== false) {
1906 * An additional option that can be applied to an admin setting.
1907 * The currently supported options are 'ADVANCED' and 'LOCKED'.
1909 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1911 class admin_setting_flag
{
1912 /** @var bool Flag to indicate if this option can be toggled for this setting */
1913 private $enabled = false;
1914 /** @var bool Flag to indicate if this option defaults to true or false */
1915 private $default = false;
1916 /** @var string Short string used to create setting name - e.g. 'adv' */
1917 private $shortname = '';
1918 /** @var string String used as the label for this flag */
1919 private $displayname = '';
1920 /** @const Checkbox for this flag is displayed in admin page */
1921 const ENABLED
= true;
1922 /** @const Checkbox for this flag is not displayed in admin page */
1923 const DISABLED
= false;
1928 * @param bool $enabled Can this option can be toggled.
1929 * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
1930 * @param bool $default The default checked state for this setting option.
1931 * @param string $shortname The shortname of this flag. Currently supported flags are 'locked' and 'adv'
1932 * @param string $displayname The displayname of this flag. Used as a label for the flag.
1934 public function __construct($enabled, $default, $shortname, $displayname) {
1935 $this->shortname
= $shortname;
1936 $this->displayname
= $displayname;
1937 $this->set_options($enabled, $default);
1941 * Update the values of this setting options class
1943 * @param bool $enabled Can this option can be toggled.
1944 * Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
1945 * @param bool $default The default checked state for this setting option.
1947 public function set_options($enabled, $default) {
1948 $this->enabled
= $enabled;
1949 $this->default = $default;
1953 * Should this option appear in the interface and be toggleable?
1955 * @return bool Is it enabled?
1957 public function is_enabled() {
1958 return $this->enabled
;
1962 * Should this option be checked by default?
1964 * @return bool Is it on by default?
1966 public function get_default() {
1967 return $this->default;
1971 * Return the short name for this flag. e.g. 'adv' or 'locked'
1975 public function get_shortname() {
1976 return $this->shortname
;
1980 * Return the display name for this flag. e.g. 'Advanced' or 'Locked'
1984 public function get_displayname() {
1985 return $this->displayname
;
1989 * Save the submitted data for this flag - or set it to the default if $data is null.
1991 * @param admin_setting $setting - The admin setting for this flag
1992 * @param array $data - The data submitted from the form or null to set the default value for new installs.
1995 public function write_setting_flag(admin_setting
$setting, $data) {
1997 if ($this->is_enabled()) {
1998 if (!isset($data)) {
1999 $value = $this->get_default();
2001 $value = !empty($data[$setting->get_full_name() . '_' . $this->get_shortname()]);
2003 $result = $setting->config_write($setting->name
. '_' . $this->get_shortname(), $value);
2011 * Output the checkbox for this setting flag. Should only be called if the flag is enabled.
2013 * @param admin_setting $setting - The admin setting for this flag
2014 * @return string - The html for the checkbox.
2016 public function output_setting_flag(admin_setting
$setting) {
2017 $value = $setting->get_setting_flag_value($this);
2018 $output = ' <input type="checkbox" class="form-checkbox" ' .
2019 ' id="' . $setting->get_id() . '_' . $this->get_shortname() . '" ' .
2020 ' name="' . $setting->get_full_name() . '_' . $this->get_shortname() . '" ' .
2021 ' value="1" ' . ($value ?
'checked="checked"' : '') . ' />' .
2022 ' <label for="' . $setting->get_id() . '_' . $this->get_shortname() . '">' .
2023 $this->get_displayname() .
2031 * No setting - just heading and text.
2033 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2035 class admin_setting_heading
extends admin_setting
{
2038 * not a setting, just text
2039 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2040 * @param string $heading heading
2041 * @param string $information text in box
2043 public function __construct($name, $heading, $information) {
2044 $this->nosave
= true;
2045 parent
::__construct($name, $heading, $information, '');
2049 * Always returns true
2050 * @return bool Always returns true
2052 public function get_setting() {
2057 * Always returns true
2058 * @return bool Always returns true
2060 public function get_defaultsetting() {
2065 * Never write settings
2066 * @return string Always returns an empty string
2068 public function write_setting($data) {
2069 // do not write any setting
2074 * Returns an HTML string
2075 * @return string Returns an HTML string
2077 public function output_html($data, $query='') {
2080 if ($this->visiblename
!= '') {
2081 $return .= $OUTPUT->heading($this->visiblename
, 3, 'main');
2083 if ($this->description
!= '') {
2084 $return .= $OUTPUT->box(highlight($query, markdown_to_html($this->description
)), 'generalbox formsettingheading');
2092 * The most flexibly setting, user is typing text
2094 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2096 class admin_setting_configtext
extends admin_setting
{
2098 /** @var mixed int means PARAM_XXX type, string is a allowed format in regex */
2100 /** @var int default field size */
2104 * Config text constructor
2106 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2107 * @param string $visiblename localised
2108 * @param string $description long localised info
2109 * @param string $defaultsetting
2110 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
2111 * @param int $size default field size
2113 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $size=null) {
2114 $this->paramtype
= $paramtype;
2115 if (!is_null($size)) {
2116 $this->size
= $size;
2118 $this->size
= ($paramtype === PARAM_INT
) ?
5 : 30;
2120 parent
::__construct($name, $visiblename, $description, $defaultsetting);
2124 * Return the setting
2126 * @return mixed returns config if successful else null
2128 public function get_setting() {
2129 return $this->config_read($this->name
);
2132 public function write_setting($data) {
2133 if ($this->paramtype
=== PARAM_INT
and $data === '') {
2134 // do not complain if '' used instead of 0
2137 // $data is a string
2138 $validated = $this->validate($data);
2139 if ($validated !== true) {
2142 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
2146 * Validate data before storage
2147 * @param string data
2148 * @return mixed true if ok string if error found
2150 public function validate($data) {
2151 // allow paramtype to be a custom regex if it is the form of /pattern/
2152 if (preg_match('#^/.*/$#', $this->paramtype
)) {
2153 if (preg_match($this->paramtype
, $data)) {
2156 return get_string('validateerror', 'admin');
2159 } else if ($this->paramtype
=== PARAM_RAW
) {
2163 $cleaned = clean_param($data, $this->paramtype
);
2164 if ("$data" === "$cleaned") { // implicit conversion to string is needed to do exact comparison
2167 return get_string('validateerror', 'admin');
2173 * Return an XHTML string for the setting
2174 * @return string Returns an XHTML string
2176 public function output_html($data, $query='') {
2177 $default = $this->get_defaultsetting();
2179 return format_admin_setting($this, $this->visiblename
,
2180 '<div class="form-text defaultsnext"><input type="text" size="'.$this->size
.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>',
2181 $this->description
, true, '', $default, $query);
2186 * Text input with a maximum length constraint.
2188 * @copyright 2015 onwards Ankit Agarwal
2189 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2191 class admin_setting_configtext_with_maxlength
extends admin_setting_configtext
{
2193 /** @var int maximum number of chars allowed. */
2194 protected $maxlength;
2197 * Config text constructor
2199 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
2200 * or 'myplugin/mysetting' for ones in config_plugins.
2201 * @param string $visiblename localised
2202 * @param string $description long localised info
2203 * @param string $defaultsetting
2204 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
2205 * @param int $size default field size
2206 * @param mixed $maxlength int maxlength allowed, 0 for infinite.
2208 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
,
2209 $size=null, $maxlength = 0) {
2210 $this->maxlength
= $maxlength;
2211 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
2215 * Validate data before storage
2217 * @param string $data data
2218 * @return mixed true if ok string if error found
2220 public function validate($data) {
2221 $parentvalidation = parent
::validate($data);
2222 if ($parentvalidation === true) {
2223 if ($this->maxlength
> 0) {
2224 // Max length check.
2225 $length = core_text
::strlen($data);
2226 if ($length > $this->maxlength
) {
2227 return get_string('maximumchars', 'moodle', $this->maxlength
);
2231 return true; // No max length check needed.
2234 return $parentvalidation;
2240 * General text area without html editor.
2242 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2244 class admin_setting_configtextarea
extends admin_setting_configtext
{
2249 * @param string $name
2250 * @param string $visiblename
2251 * @param string $description
2252 * @param mixed $defaultsetting string or array
2253 * @param mixed $paramtype
2254 * @param string $cols The number of columns to make the editor
2255 * @param string $rows The number of rows to make the editor
2257 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $cols='60', $rows='8') {
2258 $this->rows
= $rows;
2259 $this->cols
= $cols;
2260 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype);
2264 * Returns an XHTML string for the editor
2266 * @param string $data
2267 * @param string $query
2268 * @return string XHTML string for the editor
2270 public function output_html($data, $query='') {
2271 $default = $this->get_defaultsetting();
2273 $defaultinfo = $default;
2274 if (!is_null($default) and $default !== '') {
2275 $defaultinfo = "\n".$default;
2278 return format_admin_setting($this, $this->visiblename
,
2279 '<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>',
2280 $this->description
, true, '', $defaultinfo, $query);
2286 * General text area with html editor.
2288 class admin_setting_confightmleditor
extends admin_setting_configtext
{
2293 * @param string $name
2294 * @param string $visiblename
2295 * @param string $description
2296 * @param mixed $defaultsetting string or array
2297 * @param mixed $paramtype
2299 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $cols='60', $rows='8') {
2300 $this->rows
= $rows;
2301 $this->cols
= $cols;
2302 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype);
2303 editors_head_setup();
2307 * Returns an XHTML string for the editor
2309 * @param string $data
2310 * @param string $query
2311 * @return string XHTML string for the editor
2313 public function output_html($data, $query='') {
2314 $default = $this->get_defaultsetting();
2316 $defaultinfo = $default;
2317 if (!is_null($default) and $default !== '') {
2318 $defaultinfo = "\n".$default;
2321 $editor = editors_get_preferred_editor(FORMAT_HTML
);
2322 $editor->set_text($data);
2323 $editor->use_editor($this->get_id(), array('noclean'=>true));
2325 return format_admin_setting($this, $this->visiblename
,
2326 '<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>',
2327 $this->description
, true, '', $defaultinfo, $query);
2333 * Password field, allows unmasking of password
2335 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2337 class admin_setting_configpasswordunmask
extends admin_setting_configtext
{
2340 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2341 * @param string $visiblename localised
2342 * @param string $description long localised info
2343 * @param string $defaultsetting default password
2345 public function __construct($name, $visiblename, $description, $defaultsetting) {
2346 parent
::__construct($name, $visiblename, $description, $defaultsetting, PARAM_RAW
, 30);
2350 * Log config changes if necessary.
2351 * @param string $name
2352 * @param string $oldvalue
2353 * @param string $value
2355 protected function add_to_config_log($name, $oldvalue, $value) {
2356 if ($value !== '') {
2357 $value = '********';
2359 if ($oldvalue !== '' and $oldvalue !== null) {
2360 $oldvalue = '********';
2362 parent
::add_to_config_log($name, $oldvalue, $value);
2366 * Returns XHTML for the field
2367 * Writes Javascript into the HTML below right before the last div
2369 * @todo Make javascript available through newer methods if possible
2370 * @param string $data Value for the field
2371 * @param string $query Passed as final argument for format_admin_setting
2372 * @return string XHTML field
2374 public function output_html($data, $query='') {
2375 $id = $this->get_id();
2376 $unmask = get_string('unmaskpassword', 'form');
2377 $unmaskjs = '<script type="text/javascript">
2379 var is_ie = (navigator.userAgent.toLowerCase().indexOf("msie") != -1);
2381 document.getElementById("'.$id.'").setAttribute("autocomplete", "off");
2383 var unmaskdiv = document.getElementById("'.$id.'unmaskdiv");
2385 var unmaskchb = document.createElement("input");
2386 unmaskchb.setAttribute("type", "checkbox");
2387 unmaskchb.setAttribute("id", "'.$id.'unmask");
2388 unmaskchb.onchange = function() {unmaskPassword("'.$id.'");};
2389 unmaskdiv.appendChild(unmaskchb);
2391 var unmasklbl = document.createElement("label");
2392 unmasklbl.innerHTML = "'.addslashes_js($unmask).'";
2394 unmasklbl.setAttribute("htmlFor", "'.$id.'unmask");
2396 unmasklbl.setAttribute("for", "'.$id.'unmask");
2398 unmaskdiv.appendChild(unmasklbl);
2401 // ugly hack to work around the famous onchange IE bug
2402 unmaskchb.onclick = function() {this.blur();};
2403 unmaskdiv.onclick = function() {this.blur();};
2407 return format_admin_setting($this, $this->visiblename
,
2408 '<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>',
2409 $this->description
, true, '', NULL, $query);
2414 * Empty setting used to allow flags (advanced) on settings that can have no sensible default.
2415 * Note: Only advanced makes sense right now - locked does not.
2417 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2419 class admin_setting_configempty
extends admin_setting_configtext
{
2422 * @param string $name
2423 * @param string $visiblename
2424 * @param string $description
2426 public function __construct($name, $visiblename, $description) {
2427 parent
::__construct($name, $visiblename, $description, '', PARAM_RAW
);
2431 * Returns an XHTML string for the hidden field
2433 * @param string $data
2434 * @param string $query
2435 * @return string XHTML string for the editor
2437 public function output_html($data, $query='') {
2438 return format_admin_setting($this,
2440 '<div class="form-empty" >' .
2441 '<input type="hidden"' .
2442 ' id="'. $this->get_id() .'"' .
2443 ' name="'. $this->get_full_name() .'"' .
2444 ' value=""/></div>',
2457 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2459 class admin_setting_configfile
extends admin_setting_configtext
{
2462 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2463 * @param string $visiblename localised
2464 * @param string $description long localised info
2465 * @param string $defaultdirectory default directory location
2467 public function __construct($name, $visiblename, $description, $defaultdirectory) {
2468 parent
::__construct($name, $visiblename, $description, $defaultdirectory, PARAM_RAW
, 50);
2472 * Returns XHTML for the field
2474 * Returns XHTML for the field and also checks whether the file
2475 * specified in $data exists using file_exists()
2477 * @param string $data File name and path to use in value attr
2478 * @param string $query
2479 * @return string XHTML field
2481 public function output_html($data, $query='') {
2483 $default = $this->get_defaultsetting();
2486 if (file_exists($data)) {
2487 $executable = '<span class="pathok">✔</span>';
2489 $executable = '<span class="patherror">✘</span>';
2495 if (!empty($CFG->preventexecpath
)) {
2496 $this->visiblename
.= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>';
2497 $readonly = 'readonly="readonly"';
2500 return format_admin_setting($this, $this->visiblename
,
2501 '<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>',
2502 $this->description
, true, '', $default, $query);
2506 * Checks if execpatch has been disabled in config.php
2508 public function write_setting($data) {
2510 if (!empty($CFG->preventexecpath
)) {
2511 if ($this->get_setting() === null) {
2512 // Use default during installation.
2513 $data = $this->get_defaultsetting();
2514 if ($data === null) {
2521 return parent
::write_setting($data);
2527 * Path to executable file
2529 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2531 class admin_setting_configexecutable
extends admin_setting_configfile
{
2534 * Returns an XHTML field
2536 * @param string $data This is the value for the field
2537 * @param string $query
2538 * @return string XHTML field
2540 public function output_html($data, $query='') {
2542 $default = $this->get_defaultsetting();
2545 if (file_exists($data) and !is_dir($data) and is_executable($data)) {
2546 $executable = '<span class="pathok">✔</span>';
2548 $executable = '<span class="patherror">✘</span>';
2554 if (!empty($CFG->preventexecpath
)) {
2555 $this->visiblename
.= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>';
2556 $readonly = 'readonly="readonly"';
2559 return format_admin_setting($this, $this->visiblename
,
2560 '<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>',
2561 $this->description
, true, '', $default, $query);
2569 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2571 class admin_setting_configdirectory
extends admin_setting_configfile
{
2574 * Returns an XHTML field
2576 * @param string $data This is the value for the field
2577 * @param string $query
2578 * @return string XHTML
2580 public function output_html($data, $query='') {
2582 $default = $this->get_defaultsetting();
2585 if (file_exists($data) and is_dir($data)) {
2586 $executable = '<span class="pathok">✔</span>';
2588 $executable = '<span class="patherror">✘</span>';
2594 if (!empty($CFG->preventexecpath
)) {
2595 $this->visiblename
.= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>';
2596 $readonly = 'readonly="readonly"';
2599 return format_admin_setting($this, $this->visiblename
,
2600 '<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>',
2601 $this->description
, true, '', $default, $query);
2609 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2611 class admin_setting_configcheckbox
extends admin_setting
{
2612 /** @var string Value used when checked */
2614 /** @var string Value used when not checked */
2619 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2620 * @param string $visiblename localised
2621 * @param string $description long localised info
2622 * @param string $defaultsetting
2623 * @param string $yes value used when checked
2624 * @param string $no value used when not checked
2626 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
2627 parent
::__construct($name, $visiblename, $description, $defaultsetting);
2628 $this->yes
= (string)$yes;
2629 $this->no
= (string)$no;
2633 * Retrieves the current setting using the objects name
2637 public function get_setting() {
2638 return $this->config_read($this->name
);
2642 * Sets the value for the setting
2644 * Sets the value for the setting to either the yes or no values
2645 * of the object by comparing $data to yes
2647 * @param mixed $data Gets converted to str for comparison against yes value
2648 * @return string empty string or error
2650 public function write_setting($data) {
2651 if ((string)$data === $this->yes
) { // convert to strings before comparison
2656 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
2660 * Returns an XHTML checkbox field
2662 * @param string $data If $data matches yes then checkbox is checked
2663 * @param string $query
2664 * @return string XHTML field
2666 public function output_html($data, $query='') {
2667 $default = $this->get_defaultsetting();
2669 if (!is_null($default)) {
2670 if ((string)$default === $this->yes
) {
2671 $defaultinfo = get_string('checkboxyes', 'admin');
2673 $defaultinfo = get_string('checkboxno', 'admin');
2676 $defaultinfo = NULL;
2679 if ((string)$data === $this->yes
) { // convert to strings before comparison
2680 $checked = 'checked="checked"';
2685 return format_admin_setting($this, $this->visiblename
,
2686 '<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no
).'" /> '
2687 .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes
).'" '.$checked.' /></div>',
2688 $this->description
, true, '', $defaultinfo, $query);
2694 * Multiple checkboxes, each represents different value, stored in csv format
2696 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2698 class admin_setting_configmulticheckbox
extends admin_setting
{
2699 /** @var array Array of choices value=>label */
2703 * Constructor: uses parent::__construct
2705 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2706 * @param string $visiblename localised
2707 * @param string $description long localised info
2708 * @param array $defaultsetting array of selected
2709 * @param array $choices array of $value=>$label for each checkbox
2711 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
2712 $this->choices
= $choices;
2713 parent
::__construct($name, $visiblename, $description, $defaultsetting);
2717 * This public function may be used in ancestors for lazy loading of choices
2719 * @todo Check if this function is still required content commented out only returns true
2720 * @return bool true if loaded, false if error
2722 public function load_choices() {
2724 if (is_array($this->choices)) {
2727 .... load choices here
2733 * Is setting related to query text - used when searching
2735 * @param string $query
2736 * @return bool true on related, false on not or failure
2738 public function is_related($query) {
2739 if (!$this->load_choices() or empty($this->choices
)) {
2742 if (parent
::is_related($query)) {
2746 foreach ($this->choices
as $desc) {
2747 if (strpos(core_text
::strtolower($desc), $query) !== false) {
2755 * Returns the current setting if it is set
2757 * @return mixed null if null, else an array
2759 public function get_setting() {
2760 $result = $this->config_read($this->name
);
2762 if (is_null($result)) {
2765 if ($result === '') {
2768 $enabled = explode(',', $result);
2770 foreach ($enabled as $option) {
2771 $setting[$option] = 1;
2777 * Saves the setting(s) provided in $data
2779 * @param array $data An array of data, if not array returns empty str
2780 * @return mixed empty string on useless data or bool true=success, false=failed
2782 public function write_setting($data) {
2783 if (!is_array($data)) {
2784 return ''; // ignore it
2786 if (!$this->load_choices() or empty($this->choices
)) {
2789 unset($data['xxxxx']);
2791 foreach ($data as $key => $value) {
2792 if ($value and array_key_exists($key, $this->choices
)) {
2796 return $this->config_write($this->name
, implode(',', $result)) ?
'' : get_string('errorsetting', 'admin');
2800 * Returns XHTML field(s) as required by choices
2802 * Relies on data being an array should data ever be another valid vartype with
2803 * acceptable value this may cause a warning/error
2804 * if (!is_array($data)) would fix the problem
2806 * @todo Add vartype handling to ensure $data is an array
2808 * @param array $data An array of checked values
2809 * @param string $query
2810 * @return string XHTML field
2812 public function output_html($data, $query='') {
2813 if (!$this->load_choices() or empty($this->choices
)) {
2816 $default = $this->get_defaultsetting();
2817 if (is_null($default)) {
2820 if (is_null($data)) {
2824 $defaults = array();
2825 foreach ($this->choices
as $key=>$description) {
2826 if (!empty($data[$key])) {
2827 $checked = 'checked="checked"';
2831 if (!empty($default[$key])) {
2832 $defaults[] = $description;
2835 $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
2836 .'<label for="'.$this->get_id().'_'.$key.'">'.highlightfast($query, $description).'</label>';
2839 if (is_null($default)) {
2840 $defaultinfo = NULL;
2841 } else if (!empty($defaults)) {
2842 $defaultinfo = implode(', ', $defaults);
2844 $defaultinfo = get_string('none');
2847 $return = '<div class="form-multicheckbox">';
2848 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2851 foreach ($options as $option) {
2852 $return .= '<li>'.$option.'</li>';
2856 $return .= '</div>';
2858 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, false, '', $defaultinfo, $query);
2865 * Multiple checkboxes 2, value stored as string 00101011
2867 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2869 class admin_setting_configmulticheckbox2
extends admin_setting_configmulticheckbox
{
2872 * Returns the setting if set
2874 * @return mixed null if not set, else an array of set settings
2876 public function get_setting() {
2877 $result = $this->config_read($this->name
);
2878 if (is_null($result)) {
2881 if (!$this->load_choices()) {
2884 $result = str_pad($result, count($this->choices
), '0');
2885 $result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY
);
2887 foreach ($this->choices
as $key=>$unused) {
2888 $value = array_shift($result);
2897 * Save setting(s) provided in $data param
2899 * @param array $data An array of settings to save
2900 * @return mixed empty string for bad data or bool true=>success, false=>error
2902 public function write_setting($data) {
2903 if (!is_array($data)) {
2904 return ''; // ignore it
2906 if (!$this->load_choices() or empty($this->choices
)) {
2910 foreach ($this->choices
as $key=>$unused) {
2911 if (!empty($data[$key])) {
2917 return $this->config_write($this->name
, $result) ?
'' : get_string('errorsetting', 'admin');
2923 * Select one value from list
2925 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2927 class admin_setting_configselect
extends admin_setting
{
2928 /** @var array Array of choices value=>label */
2933 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2934 * @param string $visiblename localised
2935 * @param string $description long localised info
2936 * @param string|int $defaultsetting
2937 * @param array $choices array of $value=>$label for each selection
2939 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
2940 $this->choices
= $choices;
2941 parent
::__construct($name, $visiblename, $description, $defaultsetting);
2945 * This function may be used in ancestors for lazy loading of choices
2947 * Override this method if loading of choices is expensive, such
2948 * as when it requires multiple db requests.
2950 * @return bool true if loaded, false if error
2952 public function load_choices() {
2954 if (is_array($this->choices)) {
2957 .... load choices here
2963 * Check if this is $query is related to a choice
2965 * @param string $query
2966 * @return bool true if related, false if not
2968 public function is_related($query) {
2969 if (parent
::is_related($query)) {
2972 if (!$this->load_choices()) {
2975 foreach ($this->choices
as $key=>$value) {
2976 if (strpos(core_text
::strtolower($key), $query) !== false) {
2979 if (strpos(core_text
::strtolower($value), $query) !== false) {
2987 * Return the setting
2989 * @return mixed returns config if successful else null
2991 public function get_setting() {
2992 return $this->config_read($this->name
);
2998 * @param string $data
2999 * @return string empty of error string
3001 public function write_setting($data) {
3002 if (!$this->load_choices() or empty($this->choices
)) {
3005 if (!array_key_exists($data, $this->choices
)) {
3006 return ''; // ignore it
3009 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
3013 * Returns XHTML select field
3015 * Ensure the options are loaded, and generate the XHTML for the select
3016 * element and any warning message. Separating this out from output_html
3017 * makes it easier to subclass this class.
3019 * @param string $data the option to show as selected.
3020 * @param string $current the currently selected option in the database, null if none.
3021 * @param string $default the default selected option.
3022 * @return array the HTML for the select element, and a warning message.
3024 public function output_select_html($data, $current, $default, $extraname = '') {
3025 if (!$this->load_choices() or empty($this->choices
)) {
3026 return array('', '');
3030 if (is_null($current)) {
3032 } else if (empty($current) and (array_key_exists('', $this->choices
) or array_key_exists(0, $this->choices
))) {
3034 } else if (!array_key_exists($current, $this->choices
)) {
3035 $warning = get_string('warningcurrentsetting', 'admin', s($current));
3036 if (!is_null($default) and $data == $current) {
3037 $data = $default; // use default instead of first value when showing the form
3041 $selecthtml = '<select id="'.$this->get_id().'" name="'.$this->get_full_name().$extraname.'">';
3042 foreach ($this->choices
as $key => $value) {
3043 // the string cast is needed because key may be integer - 0 is equal to most strings!
3044 $selecthtml .= '<option value="'.$key.'"'.((string)$key==$data ?
' selected="selected"' : '').'>'.$value.'</option>';
3046 $selecthtml .= '</select>';
3047 return array($selecthtml, $warning);
3051 * Returns XHTML select field and wrapping div(s)
3053 * @see output_select_html()
3055 * @param string $data the option to show as selected
3056 * @param string $query
3057 * @return string XHTML field and wrapping div
3059 public function output_html($data, $query='') {
3060 $default = $this->get_defaultsetting();
3061 $current = $this->get_setting();
3063 list($selecthtml, $warning) = $this->output_select_html($data, $current, $default);
3068 if (!is_null($default) and array_key_exists($default, $this->choices
)) {
3069 $defaultinfo = $this->choices
[$default];
3071 $defaultinfo = NULL;
3074 $return = '<div class="form-select defaultsnext">' . $selecthtml . '</div>';
3076 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, true, $warning, $defaultinfo, $query);
3082 * Select multiple items from list
3084 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3086 class admin_setting_configmultiselect
extends admin_setting_configselect
{
3089 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3090 * @param string $visiblename localised
3091 * @param string $description long localised info
3092 * @param array $defaultsetting array of selected items
3093 * @param array $choices array of $value=>$label for each list item
3095 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
3096 parent
::__construct($name, $visiblename, $description, $defaultsetting, $choices);
3100 * Returns the select setting(s)
3102 * @return mixed null or array. Null if no settings else array of setting(s)
3104 public function get_setting() {
3105 $result = $this->config_read($this->name
);
3106 if (is_null($result)) {
3109 if ($result === '') {
3112 return explode(',', $result);
3116 * Saves setting(s) provided through $data
3118 * Potential bug in the works should anyone call with this function
3119 * using a vartype that is not an array
3121 * @param array $data
3123 public function write_setting($data) {
3124 if (!is_array($data)) {
3125 return ''; //ignore it
3127 if (!$this->load_choices() or empty($this->choices
)) {
3131 unset($data['xxxxx']);
3134 foreach ($data as $value) {
3135 if (!array_key_exists($value, $this->choices
)) {
3136 continue; // ignore it
3141 return ($this->config_write($this->name
, implode(',', $save)) ?
'' : get_string('errorsetting', 'admin'));
3145 * Is setting related to query text - used when searching
3147 * @param string $query
3148 * @return bool true if related, false if not
3150 public function is_related($query) {
3151 if (!$this->load_choices() or empty($this->choices
)) {
3154 if (parent
::is_related($query)) {
3158 foreach ($this->choices
as $desc) {
3159 if (strpos(core_text
::strtolower($desc), $query) !== false) {
3167 * Returns XHTML multi-select field
3169 * @todo Add vartype handling to ensure $data is an array
3170 * @param array $data Array of values to select by default
3171 * @param string $query
3172 * @return string XHTML multi-select field
3174 public function output_html($data, $query='') {
3175 if (!$this->load_choices() or empty($this->choices
)) {
3178 $choices = $this->choices
;
3179 $default = $this->get_defaultsetting();
3180 if (is_null($default)) {
3183 if (is_null($data)) {
3187 $defaults = array();
3188 $size = min(10, count($this->choices
));
3189 $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
3190 $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="'.$size.'" multiple="multiple">';
3191 foreach ($this->choices
as $key => $description) {
3192 if (in_array($key, $data)) {
3193 $selected = 'selected="selected"';
3197 if (in_array($key, $default)) {
3198 $defaults[] = $description;
3201 $return .= '<option value="'.s($key).'" '.$selected.'>'.$description.'</option>';
3204 if (is_null($default)) {
3205 $defaultinfo = NULL;
3206 } if (!empty($defaults)) {
3207 $defaultinfo = implode(', ', $defaults);
3209 $defaultinfo = get_string('none');
3212 $return .= '</select></div>';
3213 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, true, '', $defaultinfo, $query);
3220 * This is a liiitle bit messy. we're using two selects, but we're returning
3221 * them as an array named after $name (so we only use $name2 internally for the setting)
3223 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3225 class admin_setting_configtime
extends admin_setting
{
3226 /** @var string Used for setting second select (minutes) */
3231 * @param string $hoursname setting for hours
3232 * @param string $minutesname setting for hours
3233 * @param string $visiblename localised
3234 * @param string $description long localised info
3235 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
3237 public function __construct($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
3238 $this->name2
= $minutesname;
3239 parent
::__construct($hoursname, $visiblename, $description, $defaultsetting);
3243 * Get the selected time
3245 * @return mixed An array containing 'h'=>xx, 'm'=>xx, or null if not set
3247 public function get_setting() {
3248 $result1 = $this->config_read($this->name
);
3249 $result2 = $this->config_read($this->name2
);
3250 if (is_null($result1) or is_null($result2)) {
3254 return array('h' => $result1, 'm' => $result2);
3258 * Store the time (hours and minutes)
3260 * @param array $data Must be form 'h'=>xx, 'm'=>xx
3261 * @return bool true if success, false if not
3263 public function write_setting($data) {
3264 if (!is_array($data)) {
3268 $result = $this->config_write($this->name
, (int)$data['h']) && $this->config_write($this->name2
, (int)$data['m']);
3269 return ($result ?
'' : get_string('errorsetting', 'admin'));
3273 * Returns XHTML time select fields
3275 * @param array $data Must be form 'h'=>xx, 'm'=>xx
3276 * @param string $query
3277 * @return string XHTML time select fields and wrapping div(s)
3279 public function output_html($data, $query='') {
3280 $default = $this->get_defaultsetting();
3282 if (is_array($default)) {
3283 $defaultinfo = $default['h'].':'.$default['m'];
3285 $defaultinfo = NULL;
3288 $return = '<div class="form-time defaultsnext">';
3289 $return .= '<label class="accesshide" for="' . $this->get_id() . 'h">' . get_string('hours') . '</label>';
3290 $return .= '<select id="' . $this->get_id() . 'h" name="' . $this->get_full_name() . '[h]">';
3291 for ($i = 0; $i < 24; $i++
) {
3292 $return .= '<option value="' . $i . '"' . ($i == $data['h'] ?
' selected="selected"' : '') . '>' . $i . '</option>';
3294 $return .= '</select>:';
3295 $return .= '<label class="accesshide" for="' . $this->get_id() . 'm">' . get_string('minutes') . '</label>';
3296 $return .= '<select id="' . $this->get_id() . 'm" name="' . $this->get_full_name() . '[m]">';
3297 for ($i = 0; $i < 60; $i +
= 5) {
3298 $return .= '<option value="' . $i . '"' . ($i == $data['m'] ?
' selected="selected"' : '') . '>' . $i . '</option>';
3300 $return .= '</select>';
3301 $return .= '</div>';
3302 return format_admin_setting($this, $this->visiblename
, $return, $this->description
,
3303 $this->get_id() . 'h', '', $defaultinfo, $query);
3310 * Seconds duration setting.
3312 * @copyright 2012 Petr Skoda (http://skodak.org)
3313 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3315 class admin_setting_configduration
extends admin_setting
{
3317 /** @var int default duration unit */
3318 protected $defaultunit;
3322 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
3323 * or 'myplugin/mysetting' for ones in config_plugins.
3324 * @param string $visiblename localised name
3325 * @param string $description localised long description
3326 * @param mixed $defaultsetting string or array depending on implementation
3327 * @param int $defaultunit - day, week, etc. (in seconds)
3329 public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) {
3330 if (is_number($defaultsetting)) {
3331 $defaultsetting = self
::parse_seconds($defaultsetting);
3333 $units = self
::get_units();
3334 if (isset($units[$defaultunit])) {
3335 $this->defaultunit
= $defaultunit;
3337 $this->defaultunit
= 86400;
3339 parent
::__construct($name, $visiblename, $description, $defaultsetting);
3343 * Returns selectable units.
3347 protected static function get_units() {
3349 604800 => get_string('weeks'),
3350 86400 => get_string('days'),
3351 3600 => get_string('hours'),
3352 60 => get_string('minutes'),
3353 1 => get_string('seconds'),
3358 * Converts seconds to some more user friendly string.
3360 * @param int $seconds
3363 protected static function get_duration_text($seconds) {
3364 if (empty($seconds)) {
3365 return get_string('none');
3367 $data = self
::parse_seconds($seconds);
3368 switch ($data['u']) {
3370 return get_string('numweeks', '', $data['v']);
3372 return get_string('numdays', '', $data['v']);
3374 return get_string('numhours', '', $data['v']);
3376 return get_string('numminutes', '', $data['v']);
3378 return get_string('numseconds', '', $data['v']*$data['u']);
3383 * Finds suitable units for given duration.
3385 * @param int $seconds
3388 protected static function parse_seconds($seconds) {
3389 foreach (self
::get_units() as $unit => $unused) {
3390 if ($seconds %
$unit === 0) {
3391 return array('v'=>(int)($seconds/$unit), 'u'=>$unit);
3394 return array('v'=>(int)$seconds, 'u'=>1);
3398 * Get the selected duration as array.
3400 * @return mixed An array containing 'v'=>xx, 'u'=>xx, or null if not set
3402 public function get_setting() {
3403 $seconds = $this->config_read($this->name
);
3404 if (is_null($seconds)) {
3408 return self
::parse_seconds($seconds);
3412 * Store the duration as seconds.
3414 * @param array $data Must be form 'h'=>xx, 'm'=>xx
3415 * @return bool true if success, false if not
3417 public function write_setting($data) {
3418 if (!is_array($data)) {
3422 $seconds = (int)($data['v']*$data['u']);
3424 return get_string('errorsetting', 'admin');
3427 $result = $this->config_write($this->name
, $seconds);
3428 return ($result ?
'' : get_string('errorsetting', 'admin'));
3432 * Returns duration text+select fields.
3434 * @param array $data Must be form 'v'=>xx, 'u'=>xx
3435 * @param string $query
3436 * @return string duration text+select fields and wrapping div(s)
3438 public function output_html($data, $query='') {
3439 $default = $this->get_defaultsetting();
3441 if (is_number($default)) {
3442 $defaultinfo = self
::get_duration_text($default);
3443 } else if (is_array($default)) {
3444 $defaultinfo = self
::get_duration_text($default['v']*$default['u']);
3446 $defaultinfo = null;
3449 $units = self
::get_units();
3451 $inputid = $this->get_id() . 'v';
3453 $return = '<div class="form-duration defaultsnext">';
3454 $return .= '<input type="text" size="5" id="' . $inputid . '" name="' . $this->get_full_name() .
3455 '[v]" value="' . s($data['v']) . '" />';
3456 $return .= '<label for="' . $this->get_id() . 'u" class="accesshide">' .
3457 get_string('durationunits', 'admin') . '</label>';
3458 $return .= '<select id="'.$this->get_id().'u" name="'.$this->get_full_name().'[u]">';
3459 foreach ($units as $val => $text) {
3461 if ($data['v'] == 0) {
3462 if ($val == $this->defaultunit
) {
3463 $selected = ' selected="selected"';
3465 } else if ($val == $data['u']) {
3466 $selected = ' selected="selected"';
3468 $return .= '<option value="'.$val.'"'.$selected.'>'.$text.'</option>';
3470 $return .= '</select></div>';
3471 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, $inputid, '', $defaultinfo, $query);
3477 * Seconds duration setting with an advanced checkbox, that controls a additional
3478 * $name.'_adv' setting.
3480 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3481 * @copyright 2014 The Open University
3483 class admin_setting_configduration_with_advanced
extends admin_setting_configduration
{
3486 * @param string $name unique ascii name, either 'mysetting' for settings that in config,
3487 * or 'myplugin/mysetting' for ones in config_plugins.
3488 * @param string $visiblename localised name
3489 * @param string $description localised long description
3490 * @param array $defaultsetting array of int value, and bool whether it is
3491 * is advanced by default.
3492 * @param int $defaultunit - day, week, etc. (in seconds)
3494 public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) {
3495 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $defaultunit);
3496 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
3502 * Used to validate a textarea used for ip addresses
3504 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3505 * @copyright 2011 Petr Skoda (http://skodak.org)
3507 class admin_setting_configiplist
extends admin_setting_configtextarea
{
3510 * Validate the contents of the textarea as IP addresses
3512 * Used to validate a new line separated list of IP addresses collected from
3513 * a textarea control
3515 * @param string $data A list of IP Addresses separated by new lines
3516 * @return mixed bool true for success or string:error on failure
3518 public function validate($data) {
3520 $ips = explode("\n", $data);
3525 foreach($ips as $ip) {
3527 if (preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}$#', $ip, $match) ||
3528 preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}(\/\d{1,2})$#', $ip, $match) ||
3529 preg_match('#^(\d{1,3})(\.\d{1,3}){3}(-\d{1,3})$#', $ip, $match)) {
3539 return get_string('validateerror', 'admin');
3546 * An admin setting for selecting one or more users who have a capability
3547 * in the system context
3549 * An admin setting for selecting one or more users, who have a particular capability
3550 * in the system context. Warning, make sure the list will never be too long. There is
3551 * no paging or searching of this list.
3553 * To correctly get a list of users from this config setting, you need to call the
3554 * get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php.
3556 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3558 class admin_setting_users_with_capability
extends admin_setting_configmultiselect
{
3559 /** @var string The capabilities name */
3560 protected $capability;
3561 /** @var int include admin users too */
3562 protected $includeadmins;
3567 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
3568 * @param string $visiblename localised name
3569 * @param string $description localised long description
3570 * @param array $defaultsetting array of usernames
3571 * @param string $capability string capability name.
3572 * @param bool $includeadmins include administrators
3574 function __construct($name, $visiblename, $description, $defaultsetting, $capability, $includeadmins = true) {
3575 $this->capability
= $capability;
3576 $this->includeadmins
= $includeadmins;
3577 parent
::__construct($name, $visiblename, $description, $defaultsetting, NULL);
3581 * Load all of the uses who have the capability into choice array
3583 * @return bool Always returns true
3585 function load_choices() {
3586 if (is_array($this->choices
)) {
3589 list($sort, $sortparams) = users_order_by_sql('u');
3590 if (!empty($sortparams)) {
3591 throw new coding_exception('users_order_by_sql returned some query parameters. ' .
3592 'This is unexpected, and a problem because there is no way to pass these ' .
3593 'parameters to get_users_by_capability. See MDL-34657.');
3595 $userfields = 'u.id, u.username, ' . get_all_user_name_fields(true, 'u');
3596 $users = get_users_by_capability(context_system
::instance(), $this->capability
, $userfields, $sort);
3597 $this->choices
= array(
3598 '$@NONE@$' => get_string('nobody'),
3599 '$@ALL@$' => get_string('everyonewhocan', 'admin', get_capability_string($this->capability
)),
3601 if ($this->includeadmins
) {
3602 $admins = get_admins();
3603 foreach ($admins as $user) {
3604 $this->choices
[$user->id
] = fullname($user);
3607 if (is_array($users)) {
3608 foreach ($users as $user) {
3609 $this->choices
[$user->id
] = fullname($user);
3616 * Returns the default setting for class
3618 * @return mixed Array, or string. Empty string if no default
3620 public function get_defaultsetting() {
3621 $this->load_choices();
3622 $defaultsetting = parent
::get_defaultsetting();
3623 if (empty($defaultsetting)) {
3624 return array('$@NONE@$');
3625 } else if (array_key_exists($defaultsetting, $this->choices
)) {
3626 return $defaultsetting;
3633 * Returns the current setting
3635 * @return mixed array or string
3637 public function get_setting() {
3638 $result = parent
::get_setting();
3639 if ($result === null) {
3640 // this is necessary for settings upgrade
3643 if (empty($result)) {
3644 $result = array('$@NONE@$');
3650 * Save the chosen setting provided as $data
3652 * @param array $data
3653 * @return mixed string or array
3655 public function write_setting($data) {
3656 // If all is selected, remove any explicit options.
3657 if (in_array('$@ALL@$', $data)) {
3658 $data = array('$@ALL@$');
3660 // None never needs to be written to the DB.
3661 if (in_array('$@NONE@$', $data)) {
3662 unset($data[array_search('$@NONE@$', $data)]);
3664 return parent
::write_setting($data);
3670 * Special checkbox for calendar - resets SESSION vars.
3672 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3674 class admin_setting_special_adminseesall
extends admin_setting_configcheckbox
{
3676 * Calls the parent::__construct with default values
3678 * name => calendar_adminseesall
3679 * visiblename => get_string('adminseesall', 'admin')
3680 * description => get_string('helpadminseesall', 'admin')
3681 * defaultsetting => 0
3683 public function __construct() {
3684 parent
::__construct('calendar_adminseesall', get_string('adminseesall', 'admin'),
3685 get_string('helpadminseesall', 'admin'), '0');
3689 * Stores the setting passed in $data
3691 * @param mixed gets converted to string for comparison
3692 * @return string empty string or error message
3694 public function write_setting($data) {
3696 return parent
::write_setting($data);
3701 * Special select for settings that are altered in setup.php and can not be altered on the fly
3703 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3705 class admin_setting_special_selectsetup
extends admin_setting_configselect
{
3707 * Reads the setting directly from the database
3711 public function get_setting() {
3712 // read directly from db!
3713 return get_config(NULL, $this->name
);
3717 * Save the setting passed in $data
3719 * @param string $data The setting to save
3720 * @return string empty or error message
3722 public function write_setting($data) {
3724 // do not change active CFG setting!
3725 $current = $CFG->{$this->name
};
3726 $result = parent
::write_setting($data);
3727 $CFG->{$this->name
} = $current;
3734 * Special select for frontpage - stores data in course table
3736 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3738 class admin_setting_sitesetselect
extends admin_setting_configselect
{
3740 * Returns the site name for the selected site
3743 * @return string The site name of the selected site
3745 public function get_setting() {
3746 $site = course_get_format(get_site())->get_course();
3747 return $site->{$this->name
};
3751 * Updates the database and save the setting
3753 * @param string data
3754 * @return string empty or error message
3756 public function write_setting($data) {
3757 global $DB, $SITE, $COURSE;
3758 if (!in_array($data, array_keys($this->choices
))) {
3759 return get_string('errorsetting', 'admin');
3761 $record = new stdClass();
3762 $record->id
= SITEID
;
3763 $temp = $this->name
;
3764 $record->$temp = $data;
3765 $record->timemodified
= time();
3767 course_get_format($SITE)->update_course_format_options($record);
3768 $DB->update_record('course', $record);
3771 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
3772 if ($SITE->id
== $COURSE->id
) {
3775 format_base
::reset_course_cache($SITE->id
);
3784 * Select for blog's bloglevel setting: if set to 0, will set blog_menu
3787 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3789 class admin_setting_bloglevel
extends admin_setting_configselect
{
3791 * Updates the database and save the setting
3793 * @param string data
3794 * @return string empty or error message
3796 public function write_setting($data) {
3799 $blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 1");
3800 foreach ($blogblocks as $block) {
3801 $DB->set_field('block', 'visible', 0, array('id' => $block->id
));
3804 // reenable all blocks only when switching from disabled blogs
3805 if (isset($CFG->bloglevel
) and $CFG->bloglevel
== 0) {
3806 $blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 0");
3807 foreach ($blogblocks as $block) {
3808 $DB->set_field('block', 'visible', 1, array('id' => $block->id
));
3812 return parent
::write_setting($data);
3818 * Special select - lists on the frontpage - hacky
3820 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3822 class admin_setting_courselist_frontpage
extends admin_setting
{
3823 /** @var array Array of choices value=>label */
3827 * Construct override, requires one param
3829 * @param bool $loggedin Is the user logged in
3831 public function __construct($loggedin) {
3833 require_once($CFG->dirroot
.'/course/lib.php');
3834 $name = 'frontpage'.($loggedin ?
'loggedin' : '');
3835 $visiblename = get_string('frontpage'.($loggedin ?
'loggedin' : ''),'admin');
3836 $description = get_string('configfrontpage'.($loggedin ?
'loggedin' : ''),'admin');
3837 $defaults = array(FRONTPAGEALLCOURSELIST
);
3838 parent
::__construct($name, $visiblename, $description, $defaults);
3842 * Loads the choices available
3844 * @return bool always returns true
3846 public function load_choices() {
3847 if (is_array($this->choices
)) {
3850 $this->choices
= array(FRONTPAGENEWS
=> get_string('frontpagenews'),
3851 FRONTPAGEALLCOURSELIST
=> get_string('frontpagecourselist'),
3852 FRONTPAGEENROLLEDCOURSELIST
=> get_string('frontpageenrolledcourselist'),
3853 FRONTPAGECATEGORYNAMES
=> get_string('frontpagecategorynames'),
3854 FRONTPAGECATEGORYCOMBO
=> get_string('frontpagecategorycombo'),
3855 FRONTPAGECOURSESEARCH
=> get_string('frontpagecoursesearch'),
3856 'none' => get_string('none'));
3857 if ($this->name
=== 'frontpage') {
3858 unset($this->choices
[FRONTPAGEENROLLEDCOURSELIST
]);
3864 * Returns the selected settings
3866 * @param mixed array or setting or null
3868 public function get_setting() {
3869 $result = $this->config_read($this->name
);
3870 if (is_null($result)) {
3873 if ($result === '') {
3876 return explode(',', $result);
3880 * Save the selected options
3882 * @param array $data
3883 * @return mixed empty string (data is not an array) or bool true=success false=failure
3885 public function write_setting($data) {
3886 if (!is_array($data)) {
3889 $this->load_choices();
3891 foreach($data as $datum) {
3892 if ($datum == 'none' or !array_key_exists($datum, $this->choices
)) {
3895 $save[$datum] = $datum; // no duplicates
3897 return ($this->config_write($this->name
, implode(',', $save)) ?
'' : get_string('errorsetting', 'admin'));
3901 * Return XHTML select field and wrapping div
3903 * @todo Add vartype handling to make sure $data is an array
3904 * @param array $data Array of elements to select by default
3905 * @return string XHTML select field and wrapping div
3907 public function output_html($data, $query='') {
3908 $this->load_choices();
3909 $currentsetting = array();
3910 foreach ($data as $key) {
3911 if ($key != 'none' and array_key_exists($key, $this->choices
)) {
3912 $currentsetting[] = $key; // already selected first
3916 $return = '<div class="form-group">';
3917 for ($i = 0; $i < count($this->choices
) - 1; $i++
) {
3918 if (!array_key_exists($i, $currentsetting)) {
3919 $currentsetting[$i] = 'none'; //none
3921 $return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
3922 foreach ($this->choices
as $key => $value) {
3923 $return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ?
' selected="selected"' : '').'>'.$value.'</option>';
3925 $return .= '</select>';
3926 if ($i !== count($this->choices
) - 2) {
3927 $return .= '<br />';
3930 $return .= '</div>';
3932 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, false, '', NULL, $query);
3938 * Special checkbox for frontpage - stores data in course table
3940 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3942 class admin_setting_sitesetcheckbox
extends admin_setting_configcheckbox
{
3944 * Returns the current sites name
3948 public function get_setting() {
3949 $site = course_get_format(get_site())->get_course();
3950 return $site->{$this->name
};
3954 * Save the selected setting
3956 * @param string $data The selected site
3957 * @return string empty string or error message
3959 public function write_setting($data) {
3960 global $DB, $SITE, $COURSE;
3961 $record = new stdClass();
3962 $record->id
= $SITE->id
;
3963 $record->{$this->name
} = ($data == '1' ?
1 : 0);
3964 $record->timemodified
= time();
3966 course_get_format($SITE)->update_course_format_options($record);
3967 $DB->update_record('course', $record);
3970 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
3971 if ($SITE->id
== $COURSE->id
) {
3974 format_base
::reset_course_cache($SITE->id
);
3981 * Special text for frontpage - stores data in course table.
3982 * Empty string means not set here. Manual setting is required.
3984 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3986 class admin_setting_sitesettext
extends admin_setting_configtext
{
3988 * Return the current setting
3990 * @return mixed string or null
3992 public function get_setting() {
3993 $site = course_get_format(get_site())->get_course();
3994 return $site->{$this->name
} != '' ?
$site->{$this->name
} : NULL;
3998 * Validate the selected data
4000 * @param string $data The selected value to validate
4001 * @return mixed true or message string
4003 public function validate($data) {
4004 $cleaned = clean_param($data, PARAM_TEXT
);
4005 if ($cleaned === '') {
4006 return get_string('required');
4008 if ("$data" == "$cleaned") { // implicit conversion to string is needed to do exact comparison
4011 return get_string('validateerror', 'admin');
4016 * Save the selected setting
4018 * @param string $data The selected value
4019 * @return string empty or error message
4021 public function write_setting($data) {
4022 global $DB, $SITE, $COURSE;
4023 $data = trim($data);
4024 $validated = $this->validate($data);
4025 if ($validated !== true) {
4029 $record = new stdClass();
4030 $record->id
= $SITE->id
;
4031 $record->{$this->name
} = $data;
4032 $record->timemodified
= time();
4034 course_get_format($SITE)->update_course_format_options($record);
4035 $DB->update_record('course', $record);
4038 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4039 if ($SITE->id
== $COURSE->id
) {
4042 format_base
::reset_course_cache($SITE->id
);
4050 * Special text editor for site description.
4052 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4054 class admin_setting_special_frontpagedesc
extends admin_setting
{
4056 * Calls parent::__construct with specific arguments
4058 public function __construct() {
4059 parent
::__construct('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
4060 editors_head_setup();
4064 * Return the current setting
4065 * @return string The current setting
4067 public function get_setting() {
4068 $site = course_get_format(get_site())->get_course();
4069 return $site->{$this->name
};
4073 * Save the new setting
4075 * @param string $data The new value to save
4076 * @return string empty or error message
4078 public function write_setting($data) {
4079 global $DB, $SITE, $COURSE;
4080 $record = new stdClass();
4081 $record->id
= $SITE->id
;
4082 $record->{$this->name
} = $data;
4083 $record->timemodified
= time();
4085 course_get_format($SITE)->update_course_format_options($record);
4086 $DB->update_record('course', $record);
4089 $SITE = $DB->get_record('course', array('id'=>$SITE->id
), '*', MUST_EXIST
);
4090 if ($SITE->id
== $COURSE->id
) {
4093 format_base
::reset_course_cache($SITE->id
);
4099 * Returns XHTML for the field plus wrapping div
4101 * @param string $data The current value
4102 * @param string $query
4103 * @return string The XHTML output
4105 public function output_html($data, $query='') {
4108 $return = '<div class="form-htmlarea">'.print_textarea(true, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, 'summary') .'</div>';
4110 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, false, '', NULL, $query);
4116 * Administration interface for emoticon_manager settings.
4118 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4120 class admin_setting_emoticons
extends admin_setting
{
4123 * Calls parent::__construct with specific args
4125 public function __construct() {
4128 $manager = get_emoticon_manager();
4129 $defaults = $this->prepare_form_data($manager->default_emoticons());
4130 parent
::__construct('emoticons', get_string('emoticons', 'admin'), get_string('emoticons_desc', 'admin'), $defaults);
4134 * Return the current setting(s)
4136 * @return array Current settings array
4138 public function get_setting() {
4141 $manager = get_emoticon_manager();
4143 $config = $this->config_read($this->name
);
4144 if (is_null($config)) {
4148 $config = $manager->decode_stored_config($config);
4149 if (is_null($config)) {
4153 return $this->prepare_form_data($config);
4157 * Save selected settings
4159 * @param array $data Array of settings to save
4162 public function write_setting($data) {
4164 $manager = get_emoticon_manager();
4165 $emoticons = $this->process_form_data($data);
4167 if ($emoticons === false) {
4171 if ($this->config_write($this->name
, $manager->encode_stored_config($emoticons))) {
4172 return ''; // success
4174 return get_string('errorsetting', 'admin') . $this->visiblename
. html_writer
::empty_tag('br');
4179 * Return XHTML field(s) for options
4181 * @param array $data Array of options to set in HTML
4182 * @return string XHTML string for the fields and wrapping div(s)
4184 public function output_html($data, $query='') {
4187 $out = html_writer
::start_tag('table', array('id' => 'emoticonsetting', 'class' => 'admintable generaltable'));
4188 $out .= html_writer
::start_tag('thead');
4189 $out .= html_writer
::start_tag('tr');
4190 $out .= html_writer
::tag('th', get_string('emoticontext', 'admin'));
4191 $out .= html_writer
::tag('th', get_string('emoticonimagename', 'admin'));
4192 $out .= html_writer
::tag('th', get_string('emoticoncomponent', 'admin'));
4193 $out .= html_writer
::tag('th', get_string('emoticonalt', 'admin'), array('colspan' => 2));
4194 $out .= html_writer
::tag('th', '');
4195 $out .= html_writer
::end_tag('tr');
4196 $out .= html_writer
::end_tag('thead');
4197 $out .= html_writer
::start_tag('tbody');
4199 foreach($data as $field => $value) {
4202 $out .= html_writer
::start_tag('tr');
4203 $current_text = $value;
4204 $current_filename = '';
4205 $current_imagecomponent = '';
4206 $current_altidentifier = '';
4207 $current_altcomponent = '';
4209 $current_filename = $value;
4211 $current_imagecomponent = $value;
4213 $current_altidentifier = $value;
4215 $current_altcomponent = $value;
4218 $out .= html_writer
::tag('td',
4219 html_writer
::empty_tag('input',
4222 'class' => 'form-text',
4223 'name' => $this->get_full_name().'['.$field.']',
4226 ), array('class' => 'c'.$i)
4230 if (get_string_manager()->string_exists($current_altidentifier, $current_altcomponent)) {
4231 $alt = get_string($current_altidentifier, $current_altcomponent);
4233 $alt = $current_text;
4235 if ($current_filename) {
4236 $out .= html_writer
::tag('td', $OUTPUT->render(new pix_emoticon($current_filename, $alt, $current_imagecomponent)));
4238 $out .= html_writer
::tag('td', '');
4240 $out .= html_writer
::end_tag('tr');
4247 $out .= html_writer
::end_tag('tbody');
4248 $out .= html_writer
::end_tag('table');
4249 $out = html_writer
::tag('div', $out, array('class' => 'form-group'));
4250 $out .= html_writer
::tag('div', html_writer
::link(new moodle_url('/admin/resetemoticons.php'), get_string('emoticonsreset', 'admin')));
4252 return format_admin_setting($this, $this->visiblename
, $out, $this->description
, false, '', NULL, $query);
4256 * Converts the array of emoticon objects provided by {@see emoticon_manager} into admin settings form data
4258 * @see self::process_form_data()
4259 * @param array $emoticons array of emoticon objects as returned by {@see emoticon_manager}
4260 * @return array of form fields and their values
4262 protected function prepare_form_data(array $emoticons) {
4266 foreach ($emoticons as $emoticon) {
4267 $form['text'.$i] = $emoticon->text
;
4268 $form['imagename'.$i] = $emoticon->imagename
;
4269 $form['imagecomponent'.$i] = $emoticon->imagecomponent
;
4270 $form['altidentifier'.$i] = $emoticon->altidentifier
;
4271 $form['altcomponent'.$i] = $emoticon->altcomponent
;
4274 // add one more blank field set for new object
4275 $form['text'.$i] = '';
4276 $form['imagename'.$i] = '';
4277 $form['imagecomponent'.$i] = '';
4278 $form['altidentifier'.$i] = '';
4279 $form['altcomponent'.$i] = '';
4285 * Converts the data from admin settings form into an array of emoticon objects
4287 * @see self::prepare_form_data()
4288 * @param array $data array of admin form fields and values
4289 * @return false|array of emoticon objects
4291 protected function process_form_data(array $form) {
4293 $count = count($form); // number of form field values
4296 // we must get five fields per emoticon object
4300 $emoticons = array();
4301 for ($i = 0; $i < $count / 5; $i++
) {
4302 $emoticon = new stdClass();
4303 $emoticon->text
= clean_param(trim($form['text'.$i]), PARAM_NOTAGS
);
4304 $emoticon->imagename
= clean_param(trim($form['imagename'.$i]), PARAM_PATH
);
4305 $emoticon->imagecomponent
= clean_param(trim($form['imagecomponent'.$i]), PARAM_COMPONENT
);
4306 $emoticon->altidentifier
= clean_param(trim($form['altidentifier'.$i]), PARAM_STRINGID
);
4307 $emoticon->altcomponent
= clean_param(trim($form['altcomponent'.$i]), PARAM_COMPONENT
);
4309 if (strpos($emoticon->text
, ':/') !== false or strpos($emoticon->text
, '//') !== false) {
4310 // prevent from breaking http://url.addresses by accident
4311 $emoticon->text
= '';
4314 if (strlen($emoticon->text
) < 2) {
4315 // do not allow single character emoticons
4316 $emoticon->text
= '';
4319 if (preg_match('/^[a-zA-Z]+[a-zA-Z0-9]*$/', $emoticon->text
)) {
4320 // emoticon text must contain some non-alphanumeric character to prevent
4321 // breaking HTML tags
4322 $emoticon->text
= '';
4325 if ($emoticon->text
!== '' and $emoticon->imagename
!== '' and $emoticon->imagecomponent
!== '') {
4326 $emoticons[] = $emoticon;
4335 * Special setting for limiting of the list of available languages.
4337 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4339 class admin_setting_langlist
extends admin_setting_configtext
{
4341 * Calls parent::__construct with specific arguments
4343 public function __construct() {
4344 parent
::__construct('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS
);
4348 * Save the new setting
4350 * @param string $data The new setting
4353 public function write_setting($data) {
4354 $return = parent
::write_setting($data);
4355 get_string_manager()->reset_caches();
4362 * Selection of one of the recognised countries using the list
4363 * returned by {@link get_list_of_countries()}.
4365 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4367 class admin_settings_country_select
extends admin_setting_configselect
{
4368 protected $includeall;
4369 public function __construct($name, $visiblename, $description, $defaultsetting, $includeall=false) {
4370 $this->includeall
= $includeall;
4371 parent
::__construct($name, $visiblename, $description, $defaultsetting, NULL);
4375 * Lazy-load the available choices for the select box
4377 public function load_choices() {
4379 if (is_array($this->choices
)) {
4382 $this->choices
= array_merge(
4383 array('0' => get_string('choosedots')),
4384 get_string_manager()->get_list_of_countries($this->includeall
));
4391 * admin_setting_configselect for the default number of sections in a course,
4392 * simply so we can lazy-load the choices.
4394 * @copyright 2011 The Open University
4395 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4397 class admin_settings_num_course_sections
extends admin_setting_configselect
{
4398 public function __construct($name, $visiblename, $description, $defaultsetting) {
4399 parent
::__construct($name, $visiblename, $description, $defaultsetting, array());
4402 /** Lazy-load the available choices for the select box */
4403 public function load_choices() {
4404 $max = get_config('moodlecourse', 'maxsections');
4405 if (!isset($max) ||
!is_numeric($max)) {
4408 for ($i = 0; $i <= $max; $i++
) {
4409 $this->choices
[$i] = "$i";
4417 * Course category selection
4419 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4421 class admin_settings_coursecat_select
extends admin_setting_configselect
{
4423 * Calls parent::__construct with specific arguments
4425 public function __construct($name, $visiblename, $description, $defaultsetting) {
4426 parent
::__construct($name, $visiblename, $description, $defaultsetting, NULL);
4430 * Load the available choices for the select box
4434 public function load_choices() {
4436 require_once($CFG->dirroot
.'/course/lib.php');
4437 if (is_array($this->choices
)) {
4440 $this->choices
= make_categories_options();
4447 * Special control for selecting days to backup
4449 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4451 class admin_setting_special_backupdays
extends admin_setting_configmulticheckbox2
{
4453 * Calls parent::__construct with specific arguments
4455 public function __construct() {
4456 parent
::__construct('backup_auto_weekdays', get_string('automatedbackupschedule','backup'), get_string('automatedbackupschedulehelp','backup'), array(), NULL);
4457 $this->plugin
= 'backup';
4461 * Load the available choices for the select box
4463 * @return bool Always returns true
4465 public function load_choices() {
4466 if (is_array($this->choices
)) {
4469 $this->choices
= array();
4470 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
4471 foreach ($days as $day) {
4472 $this->choices
[$day] = get_string($day, 'calendar');
4479 * Special setting for backup auto destination.
4483 * @copyright 2014 Frédéric Massart - FMCorz.net
4484 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4486 class admin_setting_special_backup_auto_destination
extends admin_setting_configdirectory
{
4489 * Calls parent::__construct with specific arguments.
4491 public function __construct() {
4492 parent
::__construct('backup/backup_auto_destination', new lang_string('saveto'), new lang_string('backupsavetohelp'), '');
4496 * Check if the directory must be set, depending on backup/backup_auto_storage.
4498 * Note: backup/backup_auto_storage must be specified BEFORE this setting otherwise
4499 * there will be conflicts if this validation happens before the other one.
4501 * @param string $data Form data.
4502 * @return string Empty when no errors.
4504 public function write_setting($data) {
4505 $storage = (int) get_config('backup', 'backup_auto_storage');
4506 if ($storage !== 0) {
4507 if (empty($data) ||
!file_exists($data) ||
!is_dir($data) ||
!is_writable($data) ) {
4508 // The directory must exist and be writable.
4509 return get_string('backuperrorinvaliddestination');
4512 return parent
::write_setting($data);
4518 * Special debug setting
4520 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4522 class admin_setting_special_debug
extends admin_setting_configselect
{
4524 * Calls parent::__construct with specific arguments
4526 public function __construct() {
4527 parent
::__construct('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE
, NULL);
4531 * Load the available choices for the select box
4535 public function load_choices() {
4536 if (is_array($this->choices
)) {
4539 $this->choices
= array(DEBUG_NONE
=> get_string('debugnone', 'admin'),
4540 DEBUG_MINIMAL
=> get_string('debugminimal', 'admin'),
4541 DEBUG_NORMAL
=> get_string('debugnormal', 'admin'),
4542 DEBUG_ALL
=> get_string('debugall', 'admin'),
4543 DEBUG_DEVELOPER
=> get_string('debugdeveloper', 'admin'));
4550 * Special admin control
4552 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4554 class admin_setting_special_calendar_weekend
extends admin_setting
{
4556 * Calls parent::__construct with specific arguments
4558 public function __construct() {
4559 $name = 'calendar_weekend';
4560 $visiblename = get_string('calendar_weekend', 'admin');
4561 $description = get_string('helpweekenddays', 'admin');
4562 $default = array ('0', '6'); // Saturdays and Sundays
4563 parent
::__construct($name, $visiblename, $description, $default);
4567 * Gets the current settings as an array
4569 * @return mixed Null if none, else array of settings
4571 public function get_setting() {
4572 $result = $this->config_read($this->name
);
4573 if (is_null($result)) {
4576 if ($result === '') {
4579 $settings = array();
4580 for ($i=0; $i<7; $i++
) {
4581 if ($result & (1 << $i)) {
4589 * Save the new settings
4591 * @param array $data Array of new settings
4594 public function write_setting($data) {
4595 if (!is_array($data)) {
4598 unset($data['xxxxx']);
4600 foreach($data as $index) {
4601 $result |
= 1 << $index;
4603 return ($this->config_write($this->name
, $result) ?
'' : get_string('errorsetting', 'admin'));
4607 * Return XHTML to display the control
4609 * @param array $data array of selected days
4610 * @param string $query
4611 * @return string XHTML for display (field + wrapping div(s)
4613 public function output_html($data, $query='') {
4614 // The order matters very much because of the implied numeric keys
4615 $days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
4616 $return = '<table><thead><tr>';
4617 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
4618 foreach($days as $index => $day) {
4619 $return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
4621 $return .= '</tr></thead><tbody><tr>';
4622 foreach($days as $index => $day) {
4623 $return .= '<td><input type="checkbox" class="form-checkbox" id="'.$this->get_id().$index.'" name="'.$this->get_full_name().'[]" value="'.$index.'" '.(in_array("$index", $data) ?
'checked="checked"' : '').' /></td>';
4625 $return .= '</tr></tbody></table>';
4627 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, false, '', NULL, $query);
4634 * Admin setting that allows a user to pick a behaviour.
4636 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4638 class admin_setting_question_behaviour
extends admin_setting_configselect
{
4640 * @param string $name name of config variable
4641 * @param string $visiblename display name
4642 * @param string $description description
4643 * @param string $default default.
4645 public function __construct($name, $visiblename, $description, $default) {
4646 parent
::__construct($name, $visiblename, $description, $default, NULL);
4650 * Load list of behaviours as choices
4651 * @return bool true => success, false => error.
4653 public function load_choices() {
4655 require_once($CFG->dirroot
. '/question/engine/lib.php');
4656 $this->choices
= question_engine
::get_behaviour_options('');
4663 * Admin setting that allows a user to pick appropriate roles for something.
4665 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4667 class admin_setting_pickroles
extends admin_setting_configmulticheckbox
{
4668 /** @var array Array of capabilities which identify roles */
4672 * @param string $name Name of config variable
4673 * @param string $visiblename Display name
4674 * @param string $description Description
4675 * @param array $types Array of archetypes which identify
4676 * roles that will be enabled by default.
4678 public function __construct($name, $visiblename, $description, $types) {
4679 parent
::__construct($name, $visiblename, $description, NULL, NULL);
4680 $this->types
= $types;
4684 * Load roles as choices
4686 * @return bool true=>success, false=>error
4688 public function load_choices() {
4690 if (during_initial_install()) {
4693 if (is_array($this->choices
)) {
4696 if ($roles = get_all_roles()) {
4697 $this->choices
= role_fix_names($roles, null, ROLENAME_ORIGINAL
, true);
4705 * Return the default setting for this control
4707 * @return array Array of default settings
4709 public function get_defaultsetting() {
4712 if (during_initial_install()) {
4716 foreach($this->types
as $archetype) {
4717 if ($caproles = get_archetype_roles($archetype)) {
4718 foreach ($caproles as $caprole) {
4719 $result[$caprole->id
] = 1;
4729 * Admin setting that is a list of installed filter plugins.
4731 * @copyright 2015 The Open University
4732 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4734 class admin_setting_pickfilters
extends admin_setting_configmulticheckbox
{
4739 * @param string $name unique ascii name, either 'mysetting' for settings
4740 * that in config, or 'myplugin/mysetting' for ones in config_plugins.
4741 * @param string $visiblename localised name
4742 * @param string $description localised long description
4743 * @param array $default the default. E.g. array('urltolink' => 1, 'emoticons' => 1)
4745 public function __construct($name, $visiblename, $description, $default) {
4746 if (empty($default)) {
4749 $this->load_choices();
4750 foreach ($default as $plugin) {
4751 if (!isset($this->choices
[$plugin])) {
4752 unset($default[$plugin]);
4755 parent
::__construct($name, $visiblename, $description, $default, null);
4758 public function load_choices() {
4759 if (is_array($this->choices
)) {
4762 $this->choices
= array();
4764 foreach (core_component
::get_plugin_list('filter') as $plugin => $unused) {
4765 $this->choices
[$plugin] = filter_get_name($plugin);
4773 * Text field with an advanced checkbox, that controls a additional $name.'_adv' setting.
4775 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4777 class admin_setting_configtext_with_advanced
extends admin_setting_configtext
{
4780 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
4781 * @param string $visiblename localised
4782 * @param string $description long localised info
4783 * @param array $defaultsetting ('value'=>string, '__construct'=>bool)
4784 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
4785 * @param int $size default field size
4787 public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW
, $size=null) {
4788 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $paramtype, $size);
4789 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
4795 * Checkbox with an advanced checkbox that controls an additional $name.'_adv' config setting.
4797 * @copyright 2009 Petr Skoda (http://skodak.org)
4798 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4800 class admin_setting_configcheckbox_with_advanced
extends admin_setting_configcheckbox
{
4804 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
4805 * @param string $visiblename localised
4806 * @param string $description long localised info
4807 * @param array $defaultsetting ('value'=>string, 'adv'=>bool)
4808 * @param string $yes value used when checked
4809 * @param string $no value used when not checked
4811 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
4812 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
4813 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
4820 * Checkbox with an advanced checkbox that controls an additional $name.'_locked' config setting.
4822 * This is nearly a copy/paste of admin_setting_configcheckbox_with_adv
4824 * @copyright 2010 Sam Hemelryk
4825 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4827 class admin_setting_configcheckbox_with_lock
extends admin_setting_configcheckbox
{
4830 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
4831 * @param string $visiblename localised
4832 * @param string $description long localised info
4833 * @param array $defaultsetting ('value'=>string, 'locked'=>bool)
4834 * @param string $yes value used when checked
4835 * @param string $no value used when not checked
4837 public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
4838 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
4839 $this->set_locked_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['locked']));
4846 * Dropdown menu with an advanced checkbox, that controls a additional $name.'_adv' setting.
4848 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4850 class admin_setting_configselect_with_advanced
extends admin_setting_configselect
{
4852 * Calls parent::__construct with specific arguments
4854 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
4855 parent
::__construct($name, $visiblename, $description, $defaultsetting['value'], $choices);
4856 $this->set_advanced_flag_options(admin_setting_flag
::ENABLED
, !empty($defaultsetting['adv']));
4863 * Graded roles in gradebook
4865 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4867 class admin_setting_special_gradebookroles
extends admin_setting_pickroles
{
4869 * Calls parent::__construct with specific arguments
4871 public function __construct() {
4872 parent
::__construct('gradebookroles', get_string('gradebookroles', 'admin'),
4873 get_string('configgradebookroles', 'admin'),
4881 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4883 class admin_setting_regradingcheckbox
extends admin_setting_configcheckbox
{
4885 * Saves the new settings passed in $data
4887 * @param string $data
4888 * @return mixed string or Array
4890 public function write_setting($data) {
4893 $oldvalue = $this->config_read($this->name
);
4894 $return = parent
::write_setting($data);
4895 $newvalue = $this->config_read($this->name
);
4897 if ($oldvalue !== $newvalue) {
4898 // force full regrading
4899 $DB->set_field('grade_items', 'needsupdate', 1, array('needsupdate'=>0));
4908 * Which roles to show on course description page
4910 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4912 class admin_setting_special_coursecontact
extends admin_setting_pickroles
{
4914 * Calls parent::__construct with specific arguments
4916 public function __construct() {
4917 parent
::__construct('coursecontact', get_string('coursecontact', 'admin'),
4918 get_string('coursecontact_desc', 'admin'),
4919 array('editingteacher'));
4926 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4928 class admin_setting_special_gradelimiting
extends admin_setting_configcheckbox
{
4930 * Calls parent::__construct with specific arguments
4932 function admin_setting_special_gradelimiting() {
4933 parent
::__construct('unlimitedgrades', get_string('unlimitedgrades', 'grades'),
4934 get_string('unlimitedgrades_help', 'grades'), '0', '1', '0');
4938 * Force site regrading
4940 function regrade_all() {
4942 require_once("$CFG->libdir/gradelib.php");
4943 grade_force_site_regrading();
4947 * Saves the new settings
4949 * @param mixed $data
4950 * @return string empty string or error message
4952 function write_setting($data) {
4953 $previous = $this->get_setting();
4955 if ($previous === null) {
4957 $this->regrade_all();
4960 if ($data != $previous) {
4961 $this->regrade_all();
4964 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
4970 * Special setting for $CFG->grade_minmaxtouse.
4973 * @copyright 2015 Frédéric Massart - FMCorz.net
4974 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4976 class admin_setting_special_grademinmaxtouse
extends admin_setting_configselect
{
4981 public function __construct() {
4982 parent
::__construct('grade_minmaxtouse', new lang_string('minmaxtouse', 'grades'),
4983 new lang_string('minmaxtouse_desc', 'grades'), GRADE_MIN_MAX_FROM_GRADE_ITEM
,
4985 GRADE_MIN_MAX_FROM_GRADE_ITEM
=> get_string('gradeitemminmax', 'grades'),
4986 GRADE_MIN_MAX_FROM_GRADE_GRADE
=> get_string('gradegrademinmax', 'grades')
4992 * Saves the new setting.
4994 * @param mixed $data
4995 * @return string empty string or error message
4997 function write_setting($data) {
5000 $previous = $this->get_setting();
5001 $result = parent
::write_setting($data);
5003 // If saved and the value has changed.
5004 if (empty($result) && $previous != $data) {
5005 require_once($CFG->libdir
. '/gradelib.php');
5006 grade_force_site_regrading();
5016 * Primary grade export plugin - has state tracking.
5018 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5020 class admin_setting_special_gradeexport
extends admin_setting_configmulticheckbox
{
5022 * Calls parent::__construct with specific arguments
5024 public function __construct() {
5025 parent
::__construct('gradeexport', get_string('gradeexport', 'admin'),
5026 get_string('configgradeexport', 'admin'), array(), NULL);
5030 * Load the available choices for the multicheckbox
5032 * @return bool always returns true
5034 public function load_choices() {
5035 if (is_array($this->choices
)) {
5038 $this->choices
= array();
5040 if ($plugins = core_component
::get_plugin_list('gradeexport')) {
5041 foreach($plugins as $plugin => $unused) {
5042 $this->choices
[$plugin] = get_string('pluginname', 'gradeexport_'.$plugin);
5051 * A setting for setting the default grade point value. Must be an integer between 1 and $CFG->gradepointmax.
5053 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5055 class admin_setting_special_gradepointdefault
extends admin_setting_configtext
{
5057 * Config gradepointmax constructor
5059 * @param string $name Overidden by "gradepointmax"
5060 * @param string $visiblename Overridden by "gradepointmax" language string.
5061 * @param string $description Overridden by "gradepointmax_help" language string.
5062 * @param string $defaultsetting Not used, overridden by 100.
5063 * @param mixed $paramtype Overridden by PARAM_INT.
5064 * @param int $size Overridden by 5.
5066 public function __construct($name = '', $visiblename = '', $description = '', $defaultsetting = '', $paramtype = PARAM_INT
, $size = 5) {
5067 $name = 'gradepointdefault';
5068 $visiblename = get_string('gradepointdefault', 'grades');
5069 $description = get_string('gradepointdefault_help', 'grades');
5070 $defaultsetting = 100;
5071 $paramtype = PARAM_INT
;
5073 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
5077 * Validate data before storage
5078 * @param string $data The submitted data
5079 * @return bool|string true if ok, string if error found
5081 public function validate($data) {
5083 if (((string)(int)$data === (string)$data && $data > 0 && $data <= $CFG->gradepointmax
)) {
5086 return get_string('gradepointdefault_validateerror', 'grades');
5093 * A setting for setting the maximum grade value. Must be an integer between 1 and 10000.
5095 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5097 class admin_setting_special_gradepointmax
extends admin_setting_configtext
{
5100 * Config gradepointmax constructor
5102 * @param string $name Overidden by "gradepointmax"
5103 * @param string $visiblename Overridden by "gradepointmax" language string.
5104 * @param string $description Overridden by "gradepointmax_help" language string.
5105 * @param string $defaultsetting Not used, overridden by 100.
5106 * @param mixed $paramtype Overridden by PARAM_INT.
5107 * @param int $size Overridden by 5.
5109 public function __construct($name = '', $visiblename = '', $description = '', $defaultsetting = '', $paramtype = PARAM_INT
, $size = 5) {
5110 $name = 'gradepointmax';
5111 $visiblename = get_string('gradepointmax', 'grades');
5112 $description = get_string('gradepointmax_help', 'grades');
5113 $defaultsetting = 100;
5114 $paramtype = PARAM_INT
;
5116 parent
::__construct($name, $visiblename, $description, $defaultsetting, $paramtype, $size);
5120 * Save the selected setting
5122 * @param string $data The selected site
5123 * @return string empty string or error message
5125 public function write_setting($data) {
5127 $data = (int)$this->defaultsetting
;
5131 return parent
::write_setting($data);
5135 * Validate data before storage
5136 * @param string $data The submitted data
5137 * @return bool|string true if ok, string if error found
5139 public function validate($data) {
5140 if (((string)(int)$data === (string)$data && $data > 0 && $data <= 10000)) {
5143 return get_string('gradepointmax_validateerror', 'grades');
5148 * Return an XHTML string for the setting
5149 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
5150 * @param string $query search query to be highlighted
5151 * @return string XHTML to display control
5153 public function output_html($data, $query = '') {
5154 $default = $this->get_defaultsetting();
5158 'size' => $this->size
,
5159 'id' => $this->get_id(),
5160 'name' => $this->get_full_name(),
5161 'value' => s($data),
5164 $input = html_writer
::empty_tag('input', $attr);
5166 $attr = array('class' => 'form-text defaultsnext');
5167 $div = html_writer
::tag('div', $input, $attr);
5168 return format_admin_setting($this, $this->visiblename
, $div, $this->description
, true, '', $default, $query);
5174 * Grade category settings
5176 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5178 class admin_setting_gradecat_combo
extends admin_setting
{
5179 /** @var array Array of choices */
5183 * Sets choices and calls parent::__construct with passed arguments
5184 * @param string $name
5185 * @param string $visiblename
5186 * @param string $description
5187 * @param mixed $defaultsetting string or array depending on implementation
5188 * @param array $choices An array of choices for the control
5190 public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
5191 $this->choices
= $choices;
5192 parent
::__construct($name, $visiblename, $description, $defaultsetting);
5196 * Return the current setting(s) array
5198 * @return array Array of value=>xx, forced=>xx, adv=>xx
5200 public function get_setting() {
5203 $value = $this->config_read($this->name
);
5204 $flag = $this->config_read($this->name
.'_flag');
5206 if (is_null($value) or is_null($flag)) {
5211 $forced = (boolean
)(1 & $flag); // first bit
5212 $adv = (boolean
)(2 & $flag); // second bit
5214 return array('value' => $value, 'forced' => $forced, 'adv' => $adv);
5218 * Save the new settings passed in $data
5220 * @todo Add vartype handling to ensure $data is array
5221 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
5222 * @return string empty or error message
5224 public function write_setting($data) {
5227 $value = $data['value'];
5228 $forced = empty($data['forced']) ?
0 : 1;
5229 $adv = empty($data['adv']) ?
0 : 2;
5230 $flag = ($forced |
$adv); //bitwise or
5232 if (!in_array($value, array_keys($this->choices
))) {
5233 return 'Error setting ';
5236 $oldvalue = $this->config_read($this->name
);
5237 $oldflag = (int)$this->config_read($this->name
.'_flag');
5238 $oldforced = (1 & $oldflag); // first bit
5240 $result1 = $this->config_write($this->name
, $value);
5241 $result2 = $this->config_write($this->name
.'_flag', $flag);
5243 // force regrade if needed
5244 if ($oldforced != $forced or ($forced and $value != $oldvalue)) {
5245 require_once($CFG->libdir
.'/gradelib.php');
5246 grade_category
::updated_forced_settings();
5249 if ($result1 and $result2) {
5252 return get_string('errorsetting', 'admin');
5257 * Return XHTML to display the field and wrapping div
5259 * @todo Add vartype handling to ensure $data is array
5260 * @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
5261 * @param string $query
5262 * @return string XHTML to display control
5264 public function output_html($data, $query='') {
5265 $value = $data['value'];
5266 $forced = !empty($data['forced']);
5267 $adv = !empty($data['adv']);
5269 $default = $this->get_defaultsetting();
5270 if (!is_null($default)) {
5271 $defaultinfo = array();
5272 if (isset($this->choices
[$default['value']])) {
5273 $defaultinfo[] = $this->choices
[$default['value']];
5275 if (!empty($default['forced'])) {
5276 $defaultinfo[] = get_string('force');
5278 if (!empty($default['adv'])) {
5279 $defaultinfo[] = get_string('advanced');
5281 $defaultinfo = implode(', ', $defaultinfo);
5284 $defaultinfo = NULL;
5288 $return = '<div class="form-group">';
5289 $return .= '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
5290 foreach ($this->choices
as $key => $val) {
5291 // the string cast is needed because key may be integer - 0 is equal to most strings!
5292 $return .= '<option value="'.$key.'"'.((string)$key==$value ?
' selected="selected"' : '').'>'.$val.'</option>';
5294 $return .= '</select>';
5295 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ?
'checked="checked"' : '').' />'
5296 .'<label for="'.$this->get_id().'force">'.get_string('force').'</label>';
5297 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ?
'checked="checked"' : '').' />'
5298 .'<label for="'.$this->get_id().'adv">'.get_string('advanced').'</label>';
5299 $return .= '</div>';
5301 return format_admin_setting($this, $this->visiblename
, $return, $this->description
, true, '', $defaultinfo, $query);
5307 * Selection of grade report in user profiles
5309 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5311 class admin_setting_grade_profilereport
extends admin_setting_configselect
{
5313 * Calls parent::__construct with specific arguments
5315 public function __construct() {
5316 parent
::__construct('grade_profilereport', get_string('profilereport', 'grades'), get_string('profilereport_help', 'grades'), 'user', null);
5320 * Loads an array of choices for the configselect control
5322 * @return bool always return true
5324 public function load_choices() {
5325 if (is_array($this->choices
)) {
5328 $this->choices
= array();
5331 require_once($CFG->libdir
.'/gradelib.php');
5333 foreach (core_component
::get_plugin_list('gradereport') as $plugin => $plugindir) {
5334 if (file_exists($plugindir.'/lib.php')) {
5335 require_once($plugindir.'/lib.php');
5336 $functionname = 'grade_report_'.$plugin.'_profilereport';
5337 if (function_exists($functionname)) {
5338 $this->choices
[$plugin] = get_string('pluginname', 'gradereport_'.$plugin);
5347 * Provides a selection of grade reports to be used for "grades".
5349 * @copyright 2015 Adrian Greeve <adrian@moodle.com>
5350 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5352 class admin_setting_my_grades_report
extends admin_setting_configselect
{
5355 * Calls parent::__construct with specific arguments.
5357 public function __construct() {
5358 parent
::__construct('grade_mygrades_report', new lang_string('mygrades', 'grades'),
5359 new lang_string('mygrades_desc', 'grades'), 'overview', null);
5363 * Loads an array of choices for the configselect control.
5365 * @return bool always returns true.
5367 public function load_choices() {
5368 global $CFG; // Remove this line and behold the horror of behat test failures!
5369 $this->choices
= array();
5370 foreach (core_component
::get_plugin_list('gradereport') as $plugin => $plugindir) {
5371 if (file_exists($plugindir . '/lib.php')) {
5372 require_once($plugindir . '/lib.php');
5373 // Check to see if the class exists. Check the correct plugin convention first.
5374 if (class_exists('gradereport_' . $plugin)) {
5375 $classname = 'gradereport_' . $plugin;
5376 } else if (class_exists('grade_report_' . $plugin)) {
5377 // We are using the old plugin naming convention.
5378 $classname = 'grade_report_' . $plugin;
5382 if ($classname::supports_mygrades()) {
5383 $this->choices
[$plugin] = get_string('pluginname', 'gradereport_' . $plugin);
5387 // Add an option to specify an external url.
5388 $this->choices
['external'] = get_string('externalurl', 'grades');
5394 * Special class for register auth selection
5396 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5398 class admin_setting_special_registerauth
extends admin_setting_configselect
{
5400 * Calls parent::__construct with specific arguments
5402 public function __construct() {
5403 parent
::__construct('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), '', null);
5407 * Returns the default option
5409 * @return string empty or default option
5411 public function get_defaultsetting() {
5412 $this->load_choices();
5413 $defaultsetting = parent
::get_defaultsetting();
5414 if (array_key_exists($defaultsetting, $this->choices
)) {
5415 return $defaultsetting;
5422 * Loads the possible choices for the array
5424 * @return bool always returns true
5426 public function load_choices() {
5429 if (is_array($this->choices
)) {
5432 $this->choices
= array();
5433 $this->choices
[''] = get_string('disable');
5435 $authsenabled = get_enabled_auth_plugins(true);
5437 foreach ($authsenabled as $auth) {
5438 $authplugin = get_auth_plugin($auth);
5439 if (!$authplugin->can_signup()) {
5442 // Get the auth title (from core or own auth lang files)
5443 $authtitle = $authplugin->get_title();
5444 $this->choices
[$auth] = $authtitle;
5452 * General plugins manager
5454 class admin_page_pluginsoverview
extends admin_externalpage
{
5457 * Sets basic information about the external page
5459 public function __construct() {
5461 parent
::__construct('pluginsoverview', get_string('pluginsoverview', 'core_admin'),
5462 "$CFG->wwwroot/$CFG->admin/plugins.php");
5467 * Module manage page
5469 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5471 class admin_page_managemods
extends admin_externalpage
{
5473 * Calls parent::__construct with specific arguments
5475 public function __construct() {
5477 parent
::__construct('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
5481 * Try to find the specified module
5483 * @param string $query The module to search for
5486 public function search($query) {
5488 if ($result = parent
::search($query)) {
5493 if ($modules = $DB->get_records('modules')) {
5494 foreach ($modules as $module) {
5495 if (!file_exists("$CFG->dirroot/mod/$module->name/lib.php")) {
5498 if (strpos($module->name
, $query) !== false) {
5502 $strmodulename = get_string('modulename', $module->name
);
5503 if (strpos(core_text
::strtolower($strmodulename), $query) !== false) {
5510 $result = new stdClass();
5511 $result->page
= $this;
5512 $result->settings
= array();
5513 return array($this->name
=> $result);
5522 * Special class for enrol plugins management.
5524 * @copyright 2010 Petr Skoda {@link http://skodak.org}
5525 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5527 class admin_setting_manageenrols
extends admin_setting
{
5529 * Calls parent::__construct with specific arguments
5531 public function __construct() {
5532 $this->nosave
= true;
5533 parent
::__construct('enrolsui', get_string('manageenrols', 'enrol'), '', '');
5537 * Always returns true, does nothing
5541 public function get_setting() {
5546 * Always returns true, does nothing
5550 public function get_defaultsetting() {
5555 * Always returns '', does not write anything
5557 * @return string Always returns ''
5559 public function write_setting($data) {
5560 // do not write any setting
5565 * Checks if $query is one of the available enrol plugins
5567 * @param string $query The string to search for
5568 * @return bool Returns true if found, false if not
5570 public function is_related($query) {
5571 if (parent
::is_related($query)) {
5575 $query = core_text
::strtolower($query);
5576 $enrols = enrol_get_plugins(false);
5577 foreach ($enrols as $name=>$enrol) {
5578 $localised = get_string('pluginname', 'enrol_'.$name);
5579 if (strpos(core_text
::strtolower($name), $query) !== false) {
5582 if (strpos(core_text
::strtolower($localised), $query) !== false) {
5590 * Builds the XHTML to display the control
5592 * @param string $data Unused
5593 * @param string $query
5596 public function output_html($data, $query='') {
5597 global $CFG, $OUTPUT, $DB, $PAGE;
5600 $strup = get_string('up');
5601 $strdown = get_string('down');
5602 $strsettings = get_string('settings');
5603 $strenable = get_string('enable');
5604 $strdisable = get_string('disable');
5605 $struninstall = get_string('uninstallplugin', 'core_admin');
5606 $strusage = get_string('enrolusage', 'enrol');
5607 $strversion = get_string('version');
5608 $strtest = get_string('testsettings', 'core_enrol');
5610 $pluginmanager = core_plugin_manager
::instance();
5612 $enrols_available = enrol_get_plugins(false);
5613 $active_enrols = enrol_get_plugins(true);
5615 $allenrols = array();
5616 foreach ($active_enrols as $key=>$enrol) {
5617 $allenrols[$key] = true;
5619 foreach ($enrols_available as $key=>$enrol) {
5620 $allenrols[$key] = true;
5622 // Now find all borked plugins and at least allow then to uninstall.
5623 $condidates = $DB->get_fieldset_sql("SELECT DISTINCT enrol FROM {enrol}");
5624 foreach ($condidates as $candidate) {
5625 if (empty($allenrols[$candidate])) {
5626 $allenrols[$candidate] = true;
5630 $return = $OUTPUT->heading(get_string('actenrolshhdr', 'enrol'), 3, 'main', true);
5631 $return .= $OUTPUT->box_start('generalbox enrolsui');
5633 $table = new html_table();
5634 $table->head
= array(get_string('name'), $strusage, $strversion, $strenable, $strup.'/'.$strdown, $strsettings, $strtest, $struninstall);
5635 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
5636 $table->id
= 'courseenrolmentplugins';
5637 $table->attributes
['class'] = 'admintable generaltable';
5638 $table->data
= array();
5640 // Iterate through enrol plugins and add to the display table.
5642 $enrolcount = count($active_enrols);
5643 $url = new moodle_url('/admin/enrol.php', array('sesskey'=>sesskey()));
5645 foreach($allenrols as $enrol => $unused) {
5646 $plugininfo = $pluginmanager->get_plugin_info('enrol_'.$enrol);
5647 $version = get_config('enrol_'.$enrol, 'version');
5648 if ($version === false) {
5652 if (get_string_manager()->string_exists('pluginname', 'enrol_'.$enrol)) {
5653 $name = get_string('pluginname', 'enrol_'.$enrol);
5658 $ci = $DB->count_records('enrol', array('enrol'=>$enrol));
5659 $cp = $DB->count_records_select('user_enrolments', "enrolid IN (SELECT id FROM {enrol} WHERE enrol = ?)", array($enrol));
5660 $usage = "$ci / $cp";
5664 if (isset($active_enrols[$enrol])) {
5665 $aurl = new moodle_url($url, array('action'=>'disable', 'enrol'=>$enrol));
5666 $hideshow = "<a href=\"$aurl\">";
5667 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"$strdisable\" /></a>";
5669 $displayname = $name;
5670 } else if (isset($enrols_available[$enrol])) {
5671 $aurl = new moodle_url($url, array('action'=>'enable', 'enrol'=>$enrol));
5672 $hideshow = "<a href=\"$aurl\">";
5673 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"$strenable\" /></a>";
5675 $displayname = $name;
5676 $class = 'dimmed_text';
5680 $displayname = '<span class="notifyproblem">'.$name.'</span>';
5682 if ($PAGE->theme
->resolve_image_location('icon', 'enrol_' . $name, false)) {
5683 $icon = $OUTPUT->pix_icon('icon', '', 'enrol_' . $name, array('class' => 'icon pluginicon'));
5685 $icon = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
5688 // Up/down link (only if enrol is enabled).
5691 if ($updowncount > 1) {
5692 $aurl = new moodle_url($url, array('action'=>'up', 'enrol'=>$enrol));
5693 $updown .= "<a href=\"$aurl\">";
5694 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"$strup\" class=\"iconsmall\" /></a> ";
5696 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
5698 if ($updowncount < $enrolcount) {
5699 $aurl = new moodle_url($url, array('action'=>'down', 'enrol'=>$enrol));
5700 $updown .= "<a href=\"$aurl\">";
5701 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"$strdown\" class=\"iconsmall\" /></a>";
5703 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
5708 // Add settings link.
5711 } else if ($surl = $plugininfo->get_settings_url()) {
5712 $settings = html_writer
::link($surl, $strsettings);
5717 // Add uninstall info.
5719 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('enrol_'.$enrol, 'manage')) {
5720 $uninstall = html_writer
::link($uninstallurl, $struninstall);
5724 if (!empty($enrols_available[$enrol]) and method_exists($enrols_available[$enrol], 'test_settings')) {
5725 $testsettingsurl = new moodle_url('/enrol/test_settings.php', array('enrol'=>$enrol, 'sesskey'=>sesskey()));
5726 $test = html_writer
::link($testsettingsurl, $strtest);
5729 // Add a row to the table.
5730 $row = new html_table_row(array($icon.$displayname, $usage, $version, $hideshow, $updown, $settings, $test, $uninstall));
5732 $row->attributes
['class'] = $class;
5734 $table->data
[] = $row;
5736 $printed[$enrol] = true;
5739 $return .= html_writer
::table($table);
5740 $return .= get_string('configenrolplugins', 'enrol').'<br />'.get_string('tablenosave', 'admin');
5741 $return .= $OUTPUT->box_end();
5742 return highlight($query, $return);
5748 * Blocks manage page
5750 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5752 class admin_page_manageblocks
extends admin_externalpage
{
5754 * Calls parent::__construct with specific arguments
5756 public function __construct() {
5758 parent
::__construct('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
5762 * Search for a specific block
5764 * @param string $query The string to search for
5767 public function search($query) {
5769 if ($result = parent
::search($query)) {
5774 if ($blocks = $DB->get_records('block')) {
5775 foreach ($blocks as $block) {
5776 if (!file_exists("$CFG->dirroot/blocks/$block->name/")) {
5779 if (strpos($block->name
, $query) !== false) {
5783 $strblockname = get_string('pluginname', 'block_'.$block->name
);
5784 if (strpos(core_text
::strtolower($strblockname), $query) !== false) {
5791 $result = new stdClass();
5792 $result->page
= $this;
5793 $result->settings
= array();
5794 return array($this->name
=> $result);
5802 * Message outputs configuration
5804 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5806 class admin_page_managemessageoutputs
extends admin_externalpage
{
5808 * Calls parent::__construct with specific arguments
5810 public function __construct() {
5812 parent
::__construct('managemessageoutputs', get_string('managemessageoutputs', 'message'), new moodle_url('/admin/message.php'));
5816 * Search for a specific message processor
5818 * @param string $query The string to search for
5821 public function search($query) {
5823 if ($result = parent
::search($query)) {
5828 if ($processors = get_message_processors()) {
5829 foreach ($processors as $processor) {
5830 if (!$processor->available
) {
5833 if (strpos($processor->name
, $query) !== false) {
5837 $strprocessorname = get_string('pluginname', 'message_'.$processor->name
);
5838 if (strpos(core_text
::strtolower($strprocessorname), $query) !== false) {
5845 $result = new stdClass();
5846 $result->page
= $this;
5847 $result->settings
= array();
5848 return array($this->name
=> $result);
5856 * Default message outputs configuration
5858 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5860 class admin_page_defaultmessageoutputs
extends admin_page_managemessageoutputs
{
5862 * Calls parent::__construct with specific arguments
5864 public function __construct() {
5866 admin_externalpage
::__construct('defaultmessageoutputs', get_string('defaultmessageoutputs', 'message'), new moodle_url('/message/defaultoutputs.php'));
5872 * Manage question behaviours page
5874 * @copyright 2011 The Open University
5875 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5877 class admin_page_manageqbehaviours
extends admin_externalpage
{
5881 public function __construct() {
5883 parent
::__construct('manageqbehaviours', get_string('manageqbehaviours', 'admin'),
5884 new moodle_url('/admin/qbehaviours.php'));
5888 * Search question behaviours for the specified string
5890 * @param string $query The string to search for in question behaviours
5893 public function search($query) {
5895 if ($result = parent
::search($query)) {
5900 require_once($CFG->dirroot
. '/question/engine/lib.php');
5901 foreach (core_component
::get_plugin_list('qbehaviour') as $behaviour => $notused) {
5902 if (strpos(core_text
::strtolower(question_engine
::get_behaviour_name($behaviour)),
5903 $query) !== false) {
5909 $result = new stdClass();
5910 $result->page
= $this;
5911 $result->settings
= array();
5912 return array($this->name
=> $result);
5921 * Question type manage page
5923 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5925 class admin_page_manageqtypes
extends admin_externalpage
{
5927 * Calls parent::__construct with specific arguments
5929 public function __construct() {
5931 parent
::__construct('manageqtypes', get_string('manageqtypes', 'admin'),
5932 new moodle_url('/admin/qtypes.php'));
5936 * Search question types for the specified string
5938 * @param string $query The string to search for in question types
5941 public function search($query) {
5943 if ($result = parent
::search($query)) {
5948 require_once($CFG->dirroot
. '/question/engine/bank.php');
5949 foreach (question_bank
::get_all_qtypes() as $qtype) {
5950 if (strpos(core_text
::strtolower($qtype->local_name()), $query) !== false) {
5956 $result = new stdClass();
5957 $result->page
= $this;
5958 $result->settings
= array();
5959 return array($this->name
=> $result);
5967 class admin_page_manageportfolios
extends admin_externalpage
{
5969 * Calls parent::__construct with specific arguments
5971 public function __construct() {
5973 parent
::__construct('manageportfolios', get_string('manageportfolios', 'portfolio'),
5974 "$CFG->wwwroot/$CFG->admin/portfolio.php");
5978 * Searches page for the specified string.
5979 * @param string $query The string to search for
5980 * @return bool True if it is found on this page
5982 public function search($query) {
5984 if ($result = parent
::search($query)) {
5989 $portfolios = core_component
::get_plugin_list('portfolio');
5990 foreach ($portfolios as $p => $dir) {
5991 if (strpos($p, $query) !== false) {
5997 foreach (portfolio_instances(false, false) as $instance) {
5998 $title = $instance->get('name');
5999 if (strpos(core_text
::strtolower($title), $query) !== false) {
6007 $result = new stdClass();
6008 $result->page
= $this;
6009 $result->settings
= array();
6010 return array($this->name
=> $result);
6018 class admin_page_managerepositories
extends admin_externalpage
{
6020 * Calls parent::__construct with specific arguments
6022 public function __construct() {
6024 parent
::__construct('managerepositories', get_string('manage',
6025 'repository'), "$CFG->wwwroot/$CFG->admin/repository.php");
6029 * Searches page for the specified string.
6030 * @param string $query The string to search for
6031 * @return bool True if it is found on this page
6033 public function search($query) {
6035 if ($result = parent
::search($query)) {
6040 $repositories= core_component
::get_plugin_list('repository');
6041 foreach ($repositories as $p => $dir) {
6042 if (strpos($p, $query) !== false) {
6048 foreach (repository
::get_types() as $instance) {
6049 $title = $instance->get_typename();
6050 if (strpos(core_text
::strtolower($title), $query) !== false) {
6058 $result = new stdClass();
6059 $result->page
= $this;
6060 $result->settings
= array();
6061 return array($this->name
=> $result);
6070 * Special class for authentication administration.
6072 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6074 class admin_setting_manageauths
extends admin_setting
{
6076 * Calls parent::__construct with specific arguments
6078 public function __construct() {
6079 $this->nosave
= true;
6080 parent
::__construct('authsui', get_string('authsettings', 'admin'), '', '');
6084 * Always returns true
6088 public function get_setting() {
6093 * Always returns true
6097 public function get_defaultsetting() {
6102 * Always returns '' and doesn't write anything
6104 * @return string Always returns ''
6106 public function write_setting($data) {
6107 // do not write any setting
6112 * Search to find if Query is related to auth plugin
6114 * @param string $query The string to search for
6115 * @return bool true for related false for not
6117 public function is_related($query) {
6118 if (parent
::is_related($query)) {
6122 $authsavailable = core_component
::get_plugin_list('auth');
6123 foreach ($authsavailable as $auth => $dir) {
6124 if (strpos($auth, $query) !== false) {
6127 $authplugin = get_auth_plugin($auth);
6128 $authtitle = $authplugin->get_title();
6129 if (strpos(core_text
::strtolower($authtitle), $query) !== false) {
6137 * Return XHTML to display control
6139 * @param mixed $data Unused
6140 * @param string $query
6141 * @return string highlight
6143 public function output_html($data, $query='') {
6144 global $CFG, $OUTPUT, $DB;
6147 $txt = get_strings(array('authenticationplugins', 'users', 'administration',
6148 'settings', 'edit', 'name', 'enable', 'disable',
6149 'up', 'down', 'none', 'users'));
6150 $txt->updown
= "$txt->up/$txt->down";
6151 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
6152 $txt->testsettings
= get_string('testsettings', 'core_auth');
6154 $authsavailable = core_component
::get_plugin_list('auth');
6155 get_enabled_auth_plugins(true); // fix the list of enabled auths
6156 if (empty($CFG->auth
)) {
6157 $authsenabled = array();
6159 $authsenabled = explode(',', $CFG->auth
);
6162 // construct the display array, with enabled auth plugins at the top, in order
6163 $displayauths = array();
6164 $registrationauths = array();
6165 $registrationauths[''] = $txt->disable
;
6166 $authplugins = array();
6167 foreach ($authsenabled as $auth) {
6168 $authplugin = get_auth_plugin($auth);
6169 $authplugins[$auth] = $authplugin;
6170 /// Get the auth title (from core or own auth lang files)
6171 $authtitle = $authplugin->get_title();
6173 $displayauths[$auth] = $authtitle;
6174 if ($authplugin->can_signup()) {
6175 $registrationauths[$auth] = $authtitle;
6179 foreach ($authsavailable as $auth => $dir) {
6180 if (array_key_exists($auth, $displayauths)) {
6181 continue; //already in the list
6183 $authplugin = get_auth_plugin($auth);
6184 $authplugins[$auth] = $authplugin;
6185 /// Get the auth title (from core or own auth lang files)
6186 $authtitle = $authplugin->get_title();
6188 $displayauths[$auth] = $authtitle;
6189 if ($authplugin->can_signup()) {
6190 $registrationauths[$auth] = $authtitle;
6194 $return = $OUTPUT->heading(get_string('actauthhdr', 'auth'), 3, 'main');
6195 $return .= $OUTPUT->box_start('generalbox authsui');
6197 $table = new html_table();
6198 $table->head
= array($txt->name
, $txt->users
, $txt->enable
, $txt->updown
, $txt->settings
, $txt->testsettings
, $txt->uninstall
);
6199 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
6200 $table->data
= array();
6201 $table->attributes
['class'] = 'admintable generaltable';
6202 $table->id
= 'manageauthtable';
6204 //add always enabled plugins first
6205 $displayname = $displayauths['manual'];
6206 $settings = "<a href=\"auth_config.php?auth=manual\">{$txt->settings}</a>";
6207 //$settings = "<a href=\"settings.php?section=authsettingmanual\">{$txt->settings}</a>";
6208 $usercount = $DB->count_records('user', array('auth'=>'manual', 'deleted'=>0));
6209 $table->data
[] = array($displayname, $usercount, '', '', $settings, '', '');
6210 $displayname = $displayauths['nologin'];
6211 $settings = "<a href=\"auth_config.php?auth=nologin\">{$txt->settings}</a>";
6212 $usercount = $DB->count_records('user', array('auth'=>'nologin', 'deleted'=>0));
6213 $table->data
[] = array($displayname, $usercount, '', '', $settings, '', '');
6216 // iterate through auth plugins and add to the display table
6218 $authcount = count($authsenabled);
6219 $url = "auth.php?sesskey=" . sesskey();
6220 foreach ($displayauths as $auth => $name) {
6221 if ($auth == 'manual' or $auth == 'nologin') {
6226 if (in_array($auth, $authsenabled)) {
6227 $hideshow = "<a href=\"$url&action=disable&auth=$auth\">";
6228 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"disable\" /></a>";
6229 // $hideshow = "<a href=\"$url&action=disable&auth=$auth\"><input type=\"checkbox\" checked /></a>";
6231 $displayname = $name;
6234 $hideshow = "<a href=\"$url&action=enable&auth=$auth\">";
6235 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"enable\" /></a>";
6236 // $hideshow = "<a href=\"$url&action=enable&auth=$auth\"><input type=\"checkbox\" /></a>";
6238 $displayname = $name;
6239 $class = 'dimmed_text';
6242 $usercount = $DB->count_records('user', array('auth'=>$auth, 'deleted'=>0));
6244 // up/down link (only if auth is enabled)
6247 if ($updowncount > 1) {
6248 $updown .= "<a href=\"$url&action=up&auth=$auth\">";
6249 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
6252 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
6254 if ($updowncount < $authcount) {
6255 $updown .= "<a href=\"$url&action=down&auth=$auth\">";
6256 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
6259 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
6265 if (file_exists($CFG->dirroot
.'/auth/'.$auth.'/settings.php')) {
6266 $settings = "<a href=\"settings.php?section=authsetting$auth\">{$txt->settings}</a>";
6268 $settings = "<a href=\"auth_config.php?auth=$auth\">{$txt->settings}</a>";
6273 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('auth_'.$auth, 'manage')) {
6274 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
6278 if (!empty($authplugins[$auth]) and method_exists($authplugins[$auth], 'test_settings')) {
6279 $testurl = new moodle_url('/auth/test_settings.php', array('auth'=>$auth, 'sesskey'=>sesskey()));
6280 $test = html_writer
::link($testurl, $txt->testsettings
);
6283 // Add a row to the table.
6284 $row = new html_table_row(array($displayname, $usercount, $hideshow, $updown, $settings, $test, $uninstall));
6286 $row->attributes
['class'] = $class;
6288 $table->data
[] = $row;
6290 $return .= html_writer
::table($table);
6291 $return .= get_string('configauthenticationplugins', 'admin').'<br />'.get_string('tablenosave', 'filters');
6292 $return .= $OUTPUT->box_end();
6293 return highlight($query, $return);
6299 * Special class for authentication administration.
6301 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6303 class admin_setting_manageeditors
extends admin_setting
{
6305 * Calls parent::__construct with specific arguments
6307 public function __construct() {
6308 $this->nosave
= true;
6309 parent
::__construct('editorsui', get_string('editorsettings', 'editor'), '', '');
6313 * Always returns true, does nothing
6317 public function get_setting() {
6322 * Always returns true, does nothing
6326 public function get_defaultsetting() {
6331 * Always returns '', does not write anything
6333 * @return string Always returns ''
6335 public function write_setting($data) {
6336 // do not write any setting
6341 * Checks if $query is one of the available editors
6343 * @param string $query The string to search for
6344 * @return bool Returns true if found, false if not
6346 public function is_related($query) {
6347 if (parent
::is_related($query)) {
6351 $editors_available = editors_get_available();
6352 foreach ($editors_available as $editor=>$editorstr) {
6353 if (strpos($editor, $query) !== false) {
6356 if (strpos(core_text
::strtolower($editorstr), $query) !== false) {
6364 * Builds the XHTML to display the control
6366 * @param string $data Unused
6367 * @param string $query
6370 public function output_html($data, $query='') {
6371 global $CFG, $OUTPUT;
6374 $txt = get_strings(array('administration', 'settings', 'edit', 'name', 'enable', 'disable',
6375 'up', 'down', 'none'));
6376 $struninstall = get_string('uninstallplugin', 'core_admin');
6378 $txt->updown
= "$txt->up/$txt->down";
6380 $editors_available = editors_get_available();
6381 $active_editors = explode(',', $CFG->texteditors
);
6383 $active_editors = array_reverse($active_editors);
6384 foreach ($active_editors as $key=>$editor) {
6385 if (empty($editors_available[$editor])) {
6386 unset($active_editors[$key]);
6388 $name = $editors_available[$editor];
6389 unset($editors_available[$editor]);
6390 $editors_available[$editor] = $name;
6393 if (empty($active_editors)) {
6394 //$active_editors = array('textarea');
6396 $editors_available = array_reverse($editors_available, true);
6397 $return = $OUTPUT->heading(get_string('acteditorshhdr', 'editor'), 3, 'main', true);
6398 $return .= $OUTPUT->box_start('generalbox editorsui');
6400 $table = new html_table();
6401 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->settings
, $struninstall);
6402 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
6403 $table->id
= 'editormanagement';
6404 $table->attributes
['class'] = 'admintable generaltable';
6405 $table->data
= array();
6407 // iterate through auth plugins and add to the display table
6409 $editorcount = count($active_editors);
6410 $url = "editors.php?sesskey=" . sesskey();
6411 foreach ($editors_available as $editor => $name) {
6414 if (in_array($editor, $active_editors)) {
6415 $hideshow = "<a href=\"$url&action=disable&editor=$editor\">";
6416 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"disable\" /></a>";
6417 // $hideshow = "<a href=\"$url&action=disable&editor=$editor\"><input type=\"checkbox\" checked /></a>";
6419 $displayname = $name;
6422 $hideshow = "<a href=\"$url&action=enable&editor=$editor\">";
6423 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"enable\" /></a>";
6424 // $hideshow = "<a href=\"$url&action=enable&editor=$editor\"><input type=\"checkbox\" /></a>";
6426 $displayname = $name;
6427 $class = 'dimmed_text';
6430 // up/down link (only if auth is enabled)
6433 if ($updowncount > 1) {
6434 $updown .= "<a href=\"$url&action=up&editor=$editor\">";
6435 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
6438 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
6440 if ($updowncount < $editorcount) {
6441 $updown .= "<a href=\"$url&action=down&editor=$editor\">";
6442 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
6445 $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
6451 if (file_exists($CFG->dirroot
.'/lib/editor/'.$editor.'/settings.php')) {
6452 $eurl = new moodle_url('/admin/settings.php', array('section'=>'editorsettings'.$editor));
6453 $settings = "<a href='$eurl'>{$txt->settings}</a>";
6459 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('editor_'.$editor, 'manage')) {
6460 $uninstall = html_writer
::link($uninstallurl, $struninstall);
6463 // Add a row to the table.
6464 $row = new html_table_row(array($displayname, $hideshow, $updown, $settings, $uninstall));
6466 $row->attributes
['class'] = $class;
6468 $table->data
[] = $row;
6470 $return .= html_writer
::table($table);
6471 $return .= get_string('configeditorplugins', 'editor').'<br />'.get_string('tablenosave', 'admin');
6472 $return .= $OUTPUT->box_end();
6473 return highlight($query, $return);
6479 * Special class for license administration.
6481 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6483 class admin_setting_managelicenses
extends admin_setting
{
6485 * Calls parent::__construct with specific arguments
6487 public function __construct() {
6488 $this->nosave
= true;
6489 parent
::__construct('licensesui', get_string('licensesettings', 'admin'), '', '');
6493 * Always returns true, does nothing
6497 public function get_setting() {
6502 * Always returns true, does nothing
6506 public function get_defaultsetting() {
6511 * Always returns '', does not write anything
6513 * @return string Always returns ''
6515 public function write_setting($data) {
6516 // do not write any setting
6521 * Builds the XHTML to display the control
6523 * @param string $data Unused
6524 * @param string $query
6527 public function output_html($data, $query='') {
6528 global $CFG, $OUTPUT;
6529 require_once($CFG->libdir
. '/licenselib.php');
6530 $url = "licenses.php?sesskey=" . sesskey();
6533 $txt = get_strings(array('administration', 'settings', 'name', 'enable', 'disable', 'none'));
6534 $licenses = license_manager
::get_licenses();
6536 $return = $OUTPUT->heading(get_string('availablelicenses', 'admin'), 3, 'main', true);
6538 $return .= $OUTPUT->box_start('generalbox editorsui');
6540 $table = new html_table();
6541 $table->head
= array($txt->name
, $txt->enable
);
6542 $table->colclasses
= array('leftalign', 'centeralign');
6543 $table->id
= 'availablelicenses';
6544 $table->attributes
['class'] = 'admintable generaltable';
6545 $table->data
= array();
6547 foreach ($licenses as $value) {
6548 $displayname = html_writer
::link($value->source
, get_string($value->shortname
, 'license'), array('target'=>'_blank'));
6550 if ($value->enabled
== 1) {
6551 $hideshow = html_writer
::link($url.'&action=disable&license='.$value->shortname
,
6552 html_writer
::tag('img', '', array('src'=>$OUTPUT->pix_url('t/hide'), 'class'=>'iconsmall', 'alt'=>'disable')));
6554 $hideshow = html_writer
::link($url.'&action=enable&license='.$value->shortname
,
6555 html_writer
::tag('img', '', array('src'=>$OUTPUT->pix_url('t/show'), 'class'=>'iconsmall', 'alt'=>'enable')));
6558 if ($value->shortname
== $CFG->sitedefaultlicense
) {
6559 $displayname .= ' '.html_writer
::tag('img', '', array('src'=>$OUTPUT->pix_url('t/locked'), 'class'=>'iconsmall', 'alt'=>get_string('default'), 'title'=>get_string('default')));
6565 $table->data
[] =array($displayname, $hideshow);
6567 $return .= html_writer
::table($table);
6568 $return .= $OUTPUT->box_end();
6569 return highlight($query, $return);
6574 * Course formats manager. Allows to enable/disable formats and jump to settings
6576 class admin_setting_manageformats
extends admin_setting
{
6579 * Calls parent::__construct with specific arguments
6581 public function __construct() {
6582 $this->nosave
= true;
6583 parent
::__construct('formatsui', new lang_string('manageformats', 'core_admin'), '', '');
6587 * Always returns true
6591 public function get_setting() {
6596 * Always returns true
6600 public function get_defaultsetting() {
6605 * Always returns '' and doesn't write anything
6607 * @param mixed $data string or array, must not be NULL
6608 * @return string Always returns ''
6610 public function write_setting($data) {
6611 // do not write any setting
6616 * Search to find if Query is related to format plugin
6618 * @param string $query The string to search for
6619 * @return bool true for related false for not
6621 public function is_related($query) {
6622 if (parent
::is_related($query)) {
6625 $formats = core_plugin_manager
::instance()->get_plugins_of_type('format');
6626 foreach ($formats as $format) {
6627 if (strpos($format->component
, $query) !== false ||
6628 strpos(core_text
::strtolower($format->displayname
), $query) !== false) {
6636 * Return XHTML to display control
6638 * @param mixed $data Unused
6639 * @param string $query
6640 * @return string highlight
6642 public function output_html($data, $query='') {
6643 global $CFG, $OUTPUT;
6645 $return = $OUTPUT->heading(new lang_string('courseformats'), 3, 'main');
6646 $return .= $OUTPUT->box_start('generalbox formatsui');
6648 $formats = core_plugin_manager
::instance()->get_plugins_of_type('format');
6651 $txt = get_strings(array('settings', 'name', 'enable', 'disable', 'up', 'down', 'default'));
6652 $txt->uninstall
= get_string('uninstallplugin', 'core_admin');
6653 $txt->updown
= "$txt->up/$txt->down";
6655 $table = new html_table();
6656 $table->head
= array($txt->name
, $txt->enable
, $txt->updown
, $txt->uninstall
, $txt->settings
);
6657 $table->align
= array('left', 'center', 'center', 'center', 'center');
6658 $table->attributes
['class'] = 'manageformattable generaltable admintable';
6659 $table->data
= array();
6662 $defaultformat = get_config('moodlecourse', 'format');
6663 $spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
6664 foreach ($formats as $format) {
6665 $url = new moodle_url('/admin/courseformats.php',
6666 array('sesskey' => sesskey(), 'format' => $format->name
));
6669 if ($format->is_enabled()) {
6670 $strformatname = $format->displayname
;
6671 if ($defaultformat === $format->name
) {
6672 $hideshow = $txt->default;
6674 $hideshow = html_writer
::link($url->out(false, array('action' => 'disable')),
6675 $OUTPUT->pix_icon('t/hide', $txt->disable
, 'moodle', array('class' => 'iconsmall')));
6678 $strformatname = $format->displayname
;
6679 $class = 'dimmed_text';
6680 $hideshow = html_writer
::link($url->out(false, array('action' => 'enable')),
6681 $OUTPUT->pix_icon('t/show', $txt->enable
, 'moodle', array('class' => 'iconsmall')));
6685 $updown .= html_writer
::link($url->out(false, array('action' => 'up')),
6686 $OUTPUT->pix_icon('t/up', $txt->up
, 'moodle', array('class' => 'iconsmall'))). '';
6690 if ($cnt < count($formats) - 1) {
6691 $updown .= ' '.html_writer
::link($url->out(false, array('action' => 'down')),
6692 $OUTPUT->pix_icon('t/down', $txt->down
, 'moodle', array('class' => 'iconsmall')));
6698 if ($format->get_settings_url()) {
6699 $settings = html_writer
::link($format->get_settings_url(), $txt->settings
);
6702 if ($uninstallurl = core_plugin_manager
::instance()->get_uninstall_url('format_'.$format->name
, 'manage')) {
6703 $uninstall = html_writer
::link($uninstallurl, $txt->uninstall
);
6705 $row = new html_table_row(array($strformatname, $hideshow, $updown, $uninstall, $settings));
6707 $row->attributes
['class'] = $class;
6709 $table->data
[] = $row;
6711 $return .= html_writer
::table($table);
6712 $link = html_writer
::link(new moodle_url('/admin/settings.php', array('section' => 'coursesettings')), new lang_string('coursesettings'));
6713 $return .= html_writer
::tag('p', get_string('manageformatsgotosettings', 'admin', $link));
6714 $return .= $OUTPUT->box_end();
6715 return highlight($query, $return);
6720 * Special class for filter administration.
6722 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6724 class admin_page_managefilters
extends admin_externalpage
{
6726 * Calls parent::__construct with specific arguments
6728 public function __construct() {
6730 parent
::__construct('managefilters', get_string('filtersettings', 'admin'), "$CFG->wwwroot/$CFG->admin/filters.php");
6734 * Searches all installed filters for specified filter
6736 * @param string $query The filter(string) to search for
6737 * @param string $query
6739 public function search($query) {
6741 if ($result = parent
::search($query)) {
6746 $filternames = filter_get_all_installed();
6747 foreach ($filternames as $path => $strfiltername) {
6748 if (strpos(core_text
::strtolower($strfiltername), $query) !== false) {
6752 if (strpos($path, $query) !== false) {
6759 $result = new stdClass
;
6760 $result->page
= $this;
6761 $result->settings
= array();
6762 return array($this->name
=> $result);
6771 * Initialise admin page - this function does require login and permission
6772 * checks specified in page definition.
6774 * This function must be called on each admin page before other code.
6776 * @global moodle_page $PAGE
6778 * @param string $section name of page
6779 * @param string $extrabutton extra HTML that is added after the blocks editing on/off button.
6780 * @param array $extraurlparams an array paramname => paramvalue, or parameters that need to be
6781 * added to the turn blocks editing on/off form, so this page reloads correctly.
6782 * @param string $actualurl if the actual page being viewed is not the normal one for this
6783 * page (e.g. admin/roles/allow.php, instead of admin/roles/manage.php, you can pass the alternate URL here.
6784 * @param array $options Additional options that can be specified for page setup.
6785 * pagelayout - This option can be used to set a specific pagelyaout, admin is default.
6787 function admin_externalpage_setup($section, $extrabutton = '', array $extraurlparams = null, $actualurl = '', array $options = array()) {
6788 global $CFG, $PAGE, $USER, $SITE, $OUTPUT;
6790 $PAGE->set_context(null); // hack - set context to something, by default to system context
6795 if (!empty($options['pagelayout'])) {
6796 // A specific page layout has been requested.
6797 $PAGE->set_pagelayout($options['pagelayout']);
6798 } else if ($section === 'upgradesettings') {
6799 $PAGE->set_pagelayout('maintenance');
6801 $PAGE->set_pagelayout('admin');
6804 $adminroot = admin_get_root(false, false); // settings not required for external pages
6805 $extpage = $adminroot->locate($section, true);
6807 if (empty($extpage) or !($extpage instanceof admin_externalpage
)) {
6808 // The requested section isn't in the admin tree
6809 // It could be because the user has inadequate capapbilities or because the section doesn't exist
6810 if (!has_capability('moodle/site:config', context_system
::instance())) {
6811 // The requested section could depend on a different capability
6812 // but most likely the user has inadequate capabilities
6813 print_error('accessdenied', 'admin');
6815 print_error('sectionerror', 'admin', "$CFG->wwwroot/$CFG->admin/");
6819 // this eliminates our need to authenticate on the actual pages
6820 if (!$extpage->check_access()) {
6821 print_error('accessdenied', 'admin');
6825 navigation_node
::require_admin_tree();
6827 // $PAGE->set_extra_button($extrabutton); TODO
6830 $actualurl = $extpage->url
;
6833 $PAGE->set_url($actualurl, $extraurlparams);
6834 if (strpos($PAGE->pagetype
, 'admin-') !== 0) {
6835 $PAGE->set_pagetype('admin-' . $PAGE->pagetype
);
6838 if (empty($SITE->fullname
) ||
empty($SITE->shortname
)) {
6839 // During initial install.
6840 $strinstallation = get_string('installation', 'install');
6841 $strsettings = get_string('settings');
6842 $PAGE->navbar
->add($strsettings);
6843 $PAGE->set_title($strinstallation);
6844 $PAGE->set_heading($strinstallation);
6845 $PAGE->set_cacheable(false);
6849 // Locate the current item on the navigation and make it active when found.
6850 $path = $extpage->path
;
6851 $node = $PAGE->settingsnav
;
6852 while ($node && count($path) > 0) {
6853 $node = $node->get(array_pop($path));
6856 $node->make_active();
6860 $adminediting = optional_param('adminedit', -1, PARAM_BOOL
);
6861 if ($PAGE->user_allowed_editing() && $adminediting != -1) {
6862 $USER->editing
= $adminediting;
6865 $visiblepathtosection = array_reverse($extpage->visiblepath
);
6867 if ($PAGE->user_allowed_editing()) {
6868 if ($PAGE->user_is_editing()) {
6869 $caption = get_string('blockseditoff');
6870 $url = new moodle_url($PAGE->url
, array('adminedit'=>'0', 'sesskey'=>sesskey()));
6872 $caption = get_string('blocksediton');
6873 $url = new moodle_url($PAGE->url
, array('adminedit'=>'1', 'sesskey'=>sesskey()));
6875 $PAGE->set_button($OUTPUT->single_button($url, $caption, 'get'));
6878 $PAGE->set_title("$SITE->shortname: " . implode(": ", $visiblepathtosection));
6879 $PAGE->set_heading($SITE->fullname
);
6881 // prevent caching in nav block
6882 $PAGE->navigation
->clear_cache();
6886 * Returns the reference to admin tree root
6888 * @return object admin_root object
6890 function admin_get_root($reload=false, $requirefulltree=true) {
6891 global $CFG, $DB, $OUTPUT;
6893 static $ADMIN = NULL;
6895 if (is_null($ADMIN)) {
6896 // create the admin tree!
6897 $ADMIN = new admin_root($requirefulltree);
6900 if ($reload or ($requirefulltree and !$ADMIN->fulltree
)) {
6901 $ADMIN->purge_children($requirefulltree);
6904 if (!$ADMIN->loaded
) {
6905 // we process this file first to create categories first and in correct order
6906 require($CFG->dirroot
.'/'.$CFG->admin
.'/settings/top.php');
6908 // now we process all other files in admin/settings to build the admin tree
6909 foreach (glob($CFG->dirroot
.'/'.$CFG->admin
.'/settings/*.php') as $file) {
6910 if ($file == $CFG->dirroot
.'/'.$CFG->admin
.'/settings/top.php') {
6913 if ($file == $CFG->dirroot
.'/'.$CFG->admin
.'/settings/plugins.php') {
6914 // plugins are loaded last - they may insert pages anywhere
6919 require($CFG->dirroot
.'/'.$CFG->admin
.'/settings/plugins.php');
6921 $ADMIN->loaded
= true;
6927 /// settings utility functions
6930 * This function applies default settings.
6932 * @param object $node, NULL means complete tree, null by default
6933 * @param bool $unconditional if true overrides all values with defaults, null buy default
6935 function admin_apply_default_settings($node=NULL, $unconditional=true) {
6938 if (is_null($node)) {
6939 core_plugin_manager
::reset_caches();
6940 $node = admin_get_root(true, true);
6943 if ($node instanceof admin_category
) {
6944 $entries = array_keys($node->children
);
6945 foreach ($entries as $entry) {
6946 admin_apply_default_settings($node->children
[$entry], $unconditional);
6949 } else if ($node instanceof admin_settingpage
) {
6950 foreach ($node->settings
as $setting) {
6951 if (!$unconditional and !is_null($setting->get_setting())) {
6952 //do not override existing defaults
6955 $defaultsetting = $setting->get_defaultsetting();
6956 if (is_null($defaultsetting)) {
6957 // no value yet - default maybe applied after admin user creation or in upgradesettings
6960 $setting->write_setting($defaultsetting);
6961 $setting->write_setting_flags(null);
6964 // Just in case somebody modifies the list of active plugins directly.
6965 core_plugin_manager
::reset_caches();
6969 * Store changed settings, this function updates the errors variable in $ADMIN
6971 * @param object $formdata from form
6972 * @return int number of changed settings
6974 function admin_write_settings($formdata) {
6975 global $CFG, $SITE, $DB;
6977 $olddbsessions = !empty($CFG->dbsessions
);
6978 $formdata = (array)$formdata;
6981 foreach ($formdata as $fullname=>$value) {
6982 if (strpos($fullname, 's_') !== 0) {
6983 continue; // not a config value
6985 $data[$fullname] = $value;
6988 $adminroot = admin_get_root();
6989 $settings = admin_find_write_settings($adminroot, $data);
6992 foreach ($settings as $fullname=>$setting) {
6993 /** @var $setting admin_setting */
6994 $original = $setting->get_setting();
6995 $error = $setting->write_setting($data[$fullname]);
6996 if ($error !== '') {
6997 $adminroot->errors
[$fullname] = new stdClass();
6998 $adminroot->errors
[$fullname]->data
= $data[$fullname];
6999 $adminroot->errors
[$fullname]->id
= $setting->get_id();
7000 $adminroot->errors
[$fullname]->error
= $error;
7002 $setting->write_setting_flags($data);
7004 if ($setting->post_write_settings($original)) {
7009 if ($olddbsessions != !empty($CFG->dbsessions
)) {
7013 // Now update $SITE - just update the fields, in case other people have a
7014 // a reference to it (e.g. $PAGE, $COURSE).
7015 $newsite = $DB->get_record('course', array('id'=>$SITE->id
));
7016 foreach (get_object_vars($newsite) as $field => $value) {
7017 $SITE->$field = $value;
7020 // now reload all settings - some of them might depend on the changed
7021 admin_get_root(true);
7026 * Internal recursive function - finds all settings from submitted form
7028 * @param object $node Instance of admin_category, or admin_settingpage
7029 * @param array $data
7032 function admin_find_write_settings($node, $data) {
7039 if ($node instanceof admin_category
) {
7040 $entries = array_keys($node->children
);
7041 foreach ($entries as $entry) {
7042 $return = array_merge($return, admin_find_write_settings($node->children
[$entry], $data));
7045 } else if ($node instanceof admin_settingpage
) {
7046 foreach ($node->settings
as $setting) {
7047 $fullname = $setting->get_full_name();
7048 if (array_key_exists($fullname, $data)) {
7049 $return[$fullname] = $setting;
7059 * Internal function - prints the search results
7061 * @param string $query String to search for
7062 * @return string empty or XHTML
7064 function admin_search_settings_html($query) {
7065 global $CFG, $OUTPUT;
7067 if (core_text
::strlen($query) < 2) {
7070 $query = core_text
::strtolower($query);
7072 $adminroot = admin_get_root();
7073 $findings = $adminroot->search($query);
7075 $savebutton = false;
7077 foreach ($findings as $found) {
7078 $page = $found->page
;
7079 $settings = $found->settings
;
7080 if ($page->is_hidden()) {
7081 // hidden pages are not displayed in search results
7084 if ($page instanceof admin_externalpage
) {
7085 $return .= $OUTPUT->heading(get_string('searchresults','admin').' - <a href="'.$page->url
.'">'.highlight($query, $page->visiblename
).'</a>', 2, 'main');
7086 } else if ($page instanceof admin_settingpage
) {
7087 $return .= $OUTPUT->heading(get_string('searchresults','admin').' - <a href="'.$CFG->wwwroot
.'/'.$CFG->admin
.'/settings.php?section='.$page->name
.'">'.highlight($query, $page->visiblename
).'</a>', 2, 'main');
7091 if (!empty($settings)) {
7092 $return .= '<fieldset class="adminsettings">'."\n";
7093 foreach ($settings as $setting) {
7094 if (empty($setting->nosave
)) {
7097 $return .= '<div class="clearer"><!-- --></div>'."\n";
7098 $fullname = $setting->get_full_name();
7099 if (array_key_exists($fullname, $adminroot->errors
)) {
7100 $data = $adminroot->errors
[$fullname]->data
;
7102 $data = $setting->get_setting();
7103 // do not use defaults if settings not available - upgradesettings handles the defaults!
7105 $return .= $setting->output_html($data, $query);
7107 $return .= '</fieldset>';
7112 $return .= '<div class="form-buttons"><input class="form-submit" type="submit" value="'.get_string('savechanges','admin').'" /></div>';
7119 * Internal function - returns arrays of html pages with uninitialised settings
7121 * @param object $node Instance of admin_category or admin_settingpage
7124 function admin_output_new_settings_by_page($node) {
7128 if ($node instanceof admin_category
) {
7129 $entries = array_keys($node->children
);
7130 foreach ($entries as $entry) {
7131 $return +
= admin_output_new_settings_by_page($node->children
[$entry]);
7134 } else if ($node instanceof admin_settingpage
) {
7135 $newsettings = array();
7136 foreach ($node->settings
as $setting) {
7137 if (is_null($setting->get_setting())) {
7138 $newsettings[] = $setting;
7141 if (count($newsettings) > 0) {
7142 $adminroot = admin_get_root();
7143 $page = $OUTPUT->heading(get_string('upgradesettings','admin').' - '.$node->visiblename
, 2, 'main');
7144 $page .= '<fieldset class="adminsettings">'."\n";
7145 foreach ($newsettings as $setting) {
7146 $fullname = $setting->get_full_name();
7147 if (array_key_exists($fullname, $adminroot->errors
)) {
7148 $data = $adminroot->errors
[$fullname]->data
;
7150 $data = $setting->get_setting();
7151 if (is_null($data)) {
7152 $data = $setting->get_defaultsetting();
7155 $page .= '<div class="clearer"><!-- --></div>'."\n";
7156 $page .= $setting->output_html($data);
7158 $page .= '</fieldset>';
7159 $return[$node->name
] = $page;
7167 * Format admin settings
7169 * @param object $setting
7170 * @param string $title label element
7171 * @param string $form form fragment, html code - not highlighted automatically
7172 * @param string $description
7173 * @param mixed $label link label to id, true by default or string being the label to connect it to
7174 * @param string $warning warning text
7175 * @param sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string, defaults to null
7176 * @param string $query search query to be highlighted
7177 * @return string XHTML
7179 function format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') {
7182 $name = empty($setting->plugin
) ?
$setting->name
: "$setting->plugin | $setting->name";
7183 $fullname = $setting->get_full_name();
7185 // sometimes the id is not id_s_name, but id_s_name_m or something, and this does not validate
7186 if ($label === true) {
7187 $labelfor = 'for = "'.$setting->get_id().'"';
7188 } else if ($label === false) {
7191 $labelfor = 'for="' . $label . '"';
7193 $form .= $setting->output_setting_flags();
7196 if (empty($setting->plugin
)) {
7197 if (array_key_exists($setting->name
, $CFG->config_php_settings
)) {
7198 $override = '<div class="form-overridden">'.get_string('configoverride', 'admin').'</div>';
7201 if (array_key_exists($setting->plugin
, $CFG->forced_plugin_settings
) and array_key_exists($setting->name
, $CFG->forced_plugin_settings
[$setting->plugin
])) {
7202 $override = '<div class="form-overridden">'.get_string('configoverride', 'admin').'</div>';
7206 if ($warning !== '') {
7207 $warning = '<div class="form-warning">'.$warning.'</div>';
7210 $defaults = array();
7211 if (!is_null($defaultinfo)) {
7212 if ($defaultinfo === '') {
7213 $defaultinfo = get_string('emptysettingvalue', 'admin');
7215 $defaults[] = $defaultinfo;
7218 $setting->get_setting_flag_defaults($defaults);
7220 if (!empty($defaults)) {
7221 $defaultinfo = implode(', ', $defaults);
7222 $defaultinfo = highlight($query, nl2br(s($defaultinfo)));
7223 $defaultinfo = '<div class="form-defaultinfo">'.get_string('defaultsettinginfo', 'admin', $defaultinfo).'</div>';
7227 $adminroot = admin_get_root();
7229 if (array_key_exists($fullname, $adminroot->errors
)) {
7230 $error = '<div><span class="error">' . $adminroot->errors
[$fullname]->error
. '</span></div>';
7234 <div class="form-item clearfix" id="admin-'.$setting->name
.'">
7235 <div class="form-label">
7236 <label '.$labelfor.'>'.highlightfast($query, $title).$override.$warning.'</label>
7237 <span class="form-shortname">'.highlightfast($query, $name).'</span>
7239 <div class="form-setting">'.$error.$form.$defaultinfo.'</div>
7240 <div class="form-description">'.highlight($query, markdown_to_html($description)).'</div>
7247 * Based on find_new_settings{@link ()} in upgradesettings.php
7248 * Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.
7250 * @param object $node Instance of admin_category, or admin_settingpage
7251 * @return boolean true if any settings haven't been initialised, false if they all have
7253 function any_new_admin_settings($node) {
7255 if ($node instanceof admin_category
) {
7256 $entries = array_keys($node->children
);
7257 foreach ($entries as $entry) {
7258 if (any_new_admin_settings($node->children
[$entry])) {
7263 } else if ($node instanceof admin_settingpage
) {
7264 foreach ($node->settings
as $setting) {
7265 if ($setting->get_setting() === NULL) {
7275 * Moved from admin/replace.php so that we can use this in cron
7277 * @param string $search string to look for
7278 * @param string $replace string to replace
7279 * @return bool success or fail
7281 function db_replace($search, $replace) {
7282 global $DB, $CFG, $OUTPUT;
7284 // TODO: this is horrible hack, we should do whitelisting and each plugin should be responsible for proper replacing...
7285 $skiptables = array('config', 'config_plugins', 'config_log', 'upgrade_log', 'log',
7286 'filter_config', 'sessions', 'events_queue', 'repository_instance_config',
7287 'block_instances', '');
7289 // Turn off time limits, sometimes upgrades can be slow.
7290 core_php_time_limit
::raise();
7292 if (!$tables = $DB->get_tables() ) { // No tables yet at all.
7295 foreach ($tables as $table) {
7297 if (in_array($table, $skiptables)) { // Don't process these
7301 if ($columns = $DB->get_columns($table)) {
7302 $DB->set_debug(true);
7303 foreach ($columns as $column) {
7304 $DB->replace_all_text($table, $column, $search, $replace);
7306 $DB->set_debug(false);
7310 // delete modinfo caches
7311 rebuild_course_cache(0, true);
7313 // TODO: we should ask all plugins to do the search&replace, for now let's do only blocks...
7314 $blocks = core_component
::get_plugin_list('block');
7315 foreach ($blocks as $blockname=>$fullblock) {
7316 if ($blockname === 'NEWBLOCK') { // Someone has unzipped the template, ignore it
7320 if (!is_readable($fullblock.'/lib.php')) {
7324 $function = 'block_'.$blockname.'_global_db_replace';
7325 include_once($fullblock.'/lib.php');
7326 if (!function_exists($function)) {
7330 echo $OUTPUT->notification("Replacing in $blockname blocks...", 'notifysuccess');
7331 $function($search, $replace);
7332 echo $OUTPUT->notification("...finished", 'notifysuccess');
7341 * Manage repository settings
7343 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7345 class admin_setting_managerepository
extends admin_setting
{
7350 * calls parent::__construct with specific arguments
7352 public function __construct() {
7354 parent
::__construct('managerepository', get_string('manage', 'repository'), '', '');
7355 $this->baseurl
= $CFG->wwwroot
. '/' . $CFG->admin
. '/repository.php?sesskey=' . sesskey();
7359 * Always returns true, does nothing
7363 public function get_setting() {
7368 * Always returns true does nothing
7372 public function get_defaultsetting() {
7377 * Always returns s_managerepository
7379 * @return string Always return 's_managerepository'
7381 public function get_full_name() {
7382 return 's_managerepository';
7386 * Always returns '' doesn't do anything
7388 public function write_setting($data) {
7389 $url = $this->baseurl
. '&new=' . $data;
7392 // Should not use redirect and exit here
7393 // Find a better way to do this.
7399 * Searches repository plugins for one that matches $query
7401 * @param string $query The string to search for
7402 * @return bool true if found, false if not
7404 public function is_related($query) {
7405 if (parent
::is_related($query)) {
7409 $repositories= core_component
::get_plugin_list('repository');
7410 foreach ($repositories as $p => $dir) {
7411 if (strpos($p, $query) !== false) {
7415 foreach (repository
::get_types() as $instance) {
7416 $title = $instance->get_typename();
7417 if (strpos(core_text
::strtolower($title), $query) !== false) {
7425 * Helper function that generates a moodle_url object
7426 * relevant to the repository
7429 function repository_action_url($repository) {
7430 return new moodle_url($this->baseurl
, array('sesskey'=>sesskey(), 'repos'=>$repository));
7434 * Builds XHTML to display the control
7436 * @param string $data Unused
7437 * @param string $query
7438 * @return string XHTML
7440 public function output_html($data, $query='') {
7441 global $CFG, $USER, $OUTPUT;
7443 // Get strings that are used
7444 $strshow = get_string('on', 'repository');
7445 $strhide = get_string('off', 'repository');
7446 $strdelete = get_string('disabled', 'repository');
7448 $actionchoicesforexisting = array(
7451 'delete' => $strdelete
7454 $actionchoicesfornew = array(
7455 'newon' => $strshow,
7456 'newoff' => $strhide,
7457 'delete' => $strdelete
7461 $return .= $OUTPUT->box_start('generalbox');
7463 // Set strings that are used multiple times
7464 $settingsstr = get_string('settings');
7465 $disablestr = get_string('disable');
7467 // Table to list plug-ins
7468 $table = new html_table();
7469 $table->head
= array(get_string('name'), get_string('isactive', 'repository'), get_string('order'), $settingsstr);
7470 $table->align
= array('left', 'center', 'center', 'center', 'center');
7471 $table->data
= array();
7473 // Get list of used plug-ins
7474 $repositorytypes = repository
::get_types();
7475 if (!empty($repositorytypes)) {
7476 // Array to store plugins being used
7477 $alreadyplugins = array();
7478 $totalrepositorytypes = count($repositorytypes);
7480 foreach ($repositorytypes as $i) {
7482 $typename = $i->get_typename();
7483 // Display edit link only if you can config the type or if it has multiple instances (e.g. has instance config)
7484 $typeoptionnames = repository
::static_function($typename, 'get_type_option_names');
7485 $instanceoptionnames = repository
::static_function($typename, 'get_instance_option_names');
7487 if (!empty($typeoptionnames) ||
!empty($instanceoptionnames)) {
7488 // Calculate number of instances in order to display them for the Moodle administrator
7489 if (!empty($instanceoptionnames)) {
7491 $params['context'] = array(context_system
::instance());
7492 $params['onlyvisible'] = false;
7493 $params['type'] = $typename;
7494 $admininstancenumber = count(repository
::static_function($typename, 'get_instances', $params));
7496 $admininstancenumbertext = get_string('instancesforsite', 'repository', $admininstancenumber);
7497 $params['context'] = array();
7498 $instances = repository
::static_function($typename, 'get_instances', $params);
7499 $courseinstances = array();
7500 $userinstances = array();
7502 foreach ($instances as $instance) {
7503 $repocontext = context
::instance_by_id($instance->instance
->contextid
);
7504 if ($repocontext->contextlevel
== CONTEXT_COURSE
) {
7505 $courseinstances[] = $instance;
7506 } else if ($repocontext->contextlevel
== CONTEXT_USER
) {
7507 $userinstances[] = $instance;
7511 $instancenumber = count($courseinstances);
7512 $courseinstancenumbertext = get_string('instancesforcourses', 'repository', $instancenumber);
7514 // user private instances
7515 $instancenumber = count($userinstances);
7516 $userinstancenumbertext = get_string('instancesforusers', 'repository', $instancenumber);
7518 $admininstancenumbertext = "";
7519 $courseinstancenumbertext = "";
7520 $userinstancenumbertext = "";
7523 $settings .= '<a href="' . $this->baseurl
. '&action=edit&repos=' . $typename . '">' . $settingsstr .'</a>';
7525 $settings .= $OUTPUT->container_start('mdl-left');
7526 $settings .= '<br/>';
7527 $settings .= $admininstancenumbertext;
7528 $settings .= '<br/>';
7529 $settings .= $courseinstancenumbertext;
7530 $settings .= '<br/>';
7531 $settings .= $userinstancenumbertext;
7532 $settings .= $OUTPUT->container_end();
7534 // Get the current visibility
7535 if ($i->get_visible()) {
7536 $currentaction = 'show';
7538 $currentaction = 'hide';
7541 $select = new single_select($this->repository_action_url($typename, 'repos'), 'action', $actionchoicesforexisting, $currentaction, null, 'applyto' . basename($typename));
7543 // Display up/down link
7545 // Should be done with CSS instead.
7546 $spacer = $OUTPUT->spacer(array('height' => 15, 'width' => 15, 'class' => 'smallicon'));
7548 if ($updowncount > 1) {
7549 $updown .= "<a href=\"$this->baseurl&action=moveup&repos=".$typename."\">";
7550 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
7555 if ($updowncount < $totalrepositorytypes) {
7556 $updown .= "<a href=\"$this->baseurl&action=movedown&repos=".$typename."\">";
7557 $updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
7565 $table->data
[] = array($i->get_readablename(), $OUTPUT->render($select), $updown, $settings);
7567 if (!in_array($typename, $alreadyplugins)) {
7568 $alreadyplugins[] = $typename;
7573 // Get all the plugins that exist on disk
7574 $plugins = core_component
::get_plugin_list('repository');
7575 if (!empty($plugins)) {
7576 foreach ($plugins as $plugin => $dir) {
7577 // Check that it has not already been listed
7578 if (!in_array($plugin, $alreadyplugins)) {
7579 $select = new single_select($this->repository_action_url($plugin, 'repos'), 'action', $actionchoicesfornew, 'delete', null, 'applyto' . basename($plugin));
7580 $table->data
[] = array(get_string('pluginname', 'repository_'.$plugin), $OUTPUT->render($select), '', '');
7585 $return .= html_writer
::table($table);
7586 $return .= $OUTPUT->box_end();
7587 return highlight($query, $return);
7592 * Special checkbox for enable mobile web service
7593 * If enable then we store the service id of the mobile service into config table
7594 * If disable then we unstore the service id from the config table
7596 class admin_setting_enablemobileservice
extends admin_setting_configcheckbox
{
7598 /** @var boolean True means that the capability 'webservice/xmlrpc:use' is set for authenticated user role */
7600 /** @var boolean True means that the capability 'webservice/rest:use' is set for authenticated user role */
7604 * Return true if Authenticated user role has the capability 'webservice/xmlrpc:use' and 'webservice/rest:use', otherwise false.
7608 private function is_protocol_cap_allowed() {
7611 // We keep xmlrpc enabled for backward compatibility.
7612 // If the $this->xmlrpcuse variable is not set, it needs to be set.
7613 if (empty($this->xmlrpcuse
) and $this->xmlrpcuse
!==false) {
7615 $params['permission'] = CAP_ALLOW
;
7616 $params['roleid'] = $CFG->defaultuserroleid
;
7617 $params['capability'] = 'webservice/xmlrpc:use';
7618 $this->xmlrpcuse
= $DB->record_exists('role_capabilities', $params);
7621 // If the $this->restuse variable is not set, it needs to be set.
7622 if (empty($this->restuse
) and $this->restuse
!==false) {
7624 $params['permission'] = CAP_ALLOW
;
7625 $params['roleid'] = $CFG->defaultuserroleid
;
7626 $params['capability'] = 'webservice/rest:use';
7627 $this->restuse
= $DB->record_exists('role_capabilities', $params);
7630 return ($this->xmlrpcuse
&& $this->restuse
);
7634 * Set the 'webservice/xmlrpc:use'/'webservice/rest:use' to the Authenticated user role (allow or not)
7635 * @param type $status true to allow, false to not set
7637 private function set_protocol_cap($status) {
7639 if ($status and !$this->is_protocol_cap_allowed()) {
7640 //need to allow the cap
7641 $permission = CAP_ALLOW
;
7643 } else if (!$status and $this->is_protocol_cap_allowed()){
7644 //need to disallow the cap
7645 $permission = CAP_INHERIT
;
7648 if (!empty($assign)) {
7649 $systemcontext = context_system
::instance();
7650 assign_capability('webservice/xmlrpc:use', $permission, $CFG->defaultuserroleid
, $systemcontext->id
, true);
7651 assign_capability('webservice/rest:use', $permission, $CFG->defaultuserroleid
, $systemcontext->id
, true);
7656 * Builds XHTML to display the control.
7657 * The main purpose of this overloading is to display a warning when https
7658 * is not supported by the server
7659 * @param string $data Unused
7660 * @param string $query
7661 * @return string XHTML
7663 public function output_html($data, $query='') {
7664 global $CFG, $OUTPUT;
7665 $html = parent
::output_html($data, $query);
7667 if ((string)$data === $this->yes
) {
7668 require_once($CFG->dirroot
. "/lib/filelib.php");
7670 $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot
); //force https url
7671 $curl->head($httpswwwroot . "/login/index.php");
7672 $info = $curl->get_info();
7673 if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
7674 $html .= $OUTPUT->notification(get_string('nohttpsformobilewarning', 'admin'));
7682 * Retrieves the current setting using the objects name
7686 public function get_setting() {
7689 // For install cli script, $CFG->defaultuserroleid is not set so return 0
7690 // Or if web services aren't enabled this can't be,
7691 if (empty($CFG->defaultuserroleid
) ||
empty($CFG->enablewebservices
)) {
7695 require_once($CFG->dirroot
. '/webservice/lib.php');
7696 $webservicemanager = new webservice();
7697 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
7698 if ($mobileservice->enabled
and $this->is_protocol_cap_allowed()) {
7699 return $this->config_read($this->name
); //same as returning 1
7706 * Save the selected setting
7708 * @param string $data The selected site
7709 * @return string empty string or error message
7711 public function write_setting($data) {
7714 //for install cli script, $CFG->defaultuserroleid is not set so do nothing
7715 if (empty($CFG->defaultuserroleid
)) {
7719 $servicename = MOODLE_OFFICIAL_MOBILE_SERVICE
;
7721 require_once($CFG->dirroot
. '/webservice/lib.php');
7722 $webservicemanager = new webservice();
7724 $updateprotocol = false;
7725 if ((string)$data === $this->yes
) {
7726 //code run when enable mobile web service
7727 //enable web service systeme if necessary
7728 set_config('enablewebservices', true);
7730 //enable mobile service
7731 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
7732 $mobileservice->enabled
= 1;
7733 $webservicemanager->update_external_service($mobileservice);
7735 //enable xml-rpc server
7736 $activeprotocols = empty($CFG->webserviceprotocols
) ?
array() : explode(',', $CFG->webserviceprotocols
);
7738 if (!in_array('xmlrpc', $activeprotocols)) {
7739 $activeprotocols[] = 'xmlrpc';
7740 $updateprotocol = true;
7743 if (!in_array('rest', $activeprotocols)) {
7744 $activeprotocols[] = 'rest';
7745 $updateprotocol = true;
7748 if ($updateprotocol) {
7749 set_config('webserviceprotocols', implode(',', $activeprotocols));
7752 //allow xml-rpc:use capability for authenticated user
7753 $this->set_protocol_cap(true);
7756 //disable web service system if no other services are enabled
7757 $otherenabledservices = $DB->get_records_select('external_services',
7758 'enabled = :enabled AND (shortname != :shortname OR shortname IS NULL)', array('enabled' => 1,
7759 'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE
));
7760 if (empty($otherenabledservices)) {
7761 set_config('enablewebservices', false);
7763 //also disable xml-rpc server
7764 $activeprotocols = empty($CFG->webserviceprotocols
) ?
array() : explode(',', $CFG->webserviceprotocols
);
7765 $protocolkey = array_search('xmlrpc', $activeprotocols);
7766 if ($protocolkey !== false) {
7767 unset($activeprotocols[$protocolkey]);
7768 $updateprotocol = true;
7771 $protocolkey = array_search('rest', $activeprotocols);
7772 if ($protocolkey !== false) {
7773 unset($activeprotocols[$protocolkey]);
7774 $updateprotocol = true;
7777 if ($updateprotocol) {
7778 set_config('webserviceprotocols', implode(',', $activeprotocols));
7781 //disallow xml-rpc:use capability for authenticated user
7782 $this->set_protocol_cap(false);
7785 //disable the mobile service
7786 $mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE
);
7787 $mobileservice->enabled
= 0;
7788 $webservicemanager->update_external_service($mobileservice);
7791 return (parent
::write_setting($data));
7796 * Special class for management of external services
7798 * @author Petr Skoda (skodak)
7800 class admin_setting_manageexternalservices
extends admin_setting
{
7802 * Calls parent::__construct with specific arguments
7804 public function __construct() {
7805 $this->nosave
= true;
7806 parent
::__construct('webservicesui', get_string('externalservices', 'webservice'), '', '');
7810 * Always returns true, does nothing
7814 public function get_setting() {
7819 * Always returns true, does nothing
7823 public function get_defaultsetting() {
7828 * Always returns '', does not write anything
7830 * @return string Always returns ''
7832 public function write_setting($data) {
7833 // do not write any setting
7838 * Checks if $query is one of the available external services
7840 * @param string $query The string to search for
7841 * @return bool Returns true if found, false if not
7843 public function is_related($query) {
7846 if (parent
::is_related($query)) {
7850 $services = $DB->get_records('external_services', array(), 'id, name');
7851 foreach ($services as $service) {
7852 if (strpos(core_text
::strtolower($service->name
), $query) !== false) {
7860 * Builds the XHTML to display the control
7862 * @param string $data Unused
7863 * @param string $query
7866 public function output_html($data, $query='') {
7867 global $CFG, $OUTPUT, $DB;
7870 $stradministration = get_string('administration');
7871 $stredit = get_string('edit');
7872 $strservice = get_string('externalservice', 'webservice');
7873 $strdelete = get_string('delete');
7874 $strplugin = get_string('plugin', 'admin');
7875 $stradd = get_string('add');
7876 $strfunctions = get_string('functions', 'webservice');
7877 $strusers = get_string('users');
7878 $strserviceusers = get_string('serviceusers', 'webservice');
7880 $esurl = "$CFG->wwwroot/$CFG->admin/webservice/service.php";
7881 $efurl = "$CFG->wwwroot/$CFG->admin/webservice/service_functions.php";
7882 $euurl = "$CFG->wwwroot/$CFG->admin/webservice/service_users.php";
7884 // built in services
7885 $services = $DB->get_records_select('external_services', 'component IS NOT NULL', null, 'name');
7887 if (!empty($services)) {
7888 $return .= $OUTPUT->heading(get_string('servicesbuiltin', 'webservice'), 3, 'main');
7892 $table = new html_table();
7893 $table->head
= array($strservice, $strplugin, $strfunctions, $strusers, $stredit);
7894 $table->colclasses
= array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
7895 $table->id
= 'builtinservices';
7896 $table->attributes
['class'] = 'admintable externalservices generaltable';
7897 $table->data
= array();
7899 // iterate through auth plugins and add to the display table
7900 foreach ($services as $service) {
7901 $name = $service->name
;
7904 if ($service->enabled
) {
7905 $displayname = "<span>$name</span>";
7907 $displayname = "<span class=\"dimmed_text\">$name</span>";
7910 $plugin = $service->component
;
7912 $functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
7914 if ($service->restrictedusers
) {
7915 $users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
7917 $users = get_string('allusers', 'webservice');
7920 $edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
7922 // add a row to the table
7923 $table->data
[] = array($displayname, $plugin, $functions, $users, $edit);
7925 $return .= html_writer
::table($table);
7929 $return .= $OUTPUT->heading(get_string('servicescustom', 'webservice'), 3, 'main');
7930 $services = $DB->get_records_select('external_services', 'component IS NULL', null, 'name');
7932 $table = new html_table();
7933 $table->head
= array($strservice, $strdelete, $strfunctions, $strusers, $stredit);
7934 $table->colclasses
= array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
7935 $table->id
= 'customservices';
7936 $table->attributes
['class'] = 'admintable externalservices generaltable';
7937 $table->data
= array();
7939 // iterate through auth plugins and add to the display table
7940 foreach ($services as $service) {
7941 $name = $service->name
;
7944 if ($service->enabled
) {
7945 $displayname = "<span>$name</span>";
7947 $displayname = "<span class=\"dimmed_text\">$name</span>";
7951 $delete = "<a href=\"$esurl?action=delete&sesskey=".sesskey()."&id=$service->id\">$strdelete</a>";
7953 $functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
7955 if ($service->restrictedusers
) {
7956 $users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
7958 $users = get_string('allusers', 'webservice');
7961 $edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
7963 // add a row to the table
7964 $table->data
[] = array($displayname, $delete, $functions, $users, $edit);
7966 // add new custom service option
7967 $return .= html_writer
::table($table);
7969 $return .= '<br />';
7970 // add a token to the table
7971 $return .= "<a href=\"$esurl?id=0\">$stradd</a>";
7973 return highlight($query, $return);
7978 * Special class for overview of external services
7980 * @author Jerome Mouneyrac
7982 class admin_setting_webservicesoverview
extends admin_setting
{
7985 * Calls parent::__construct with specific arguments
7987 public function __construct() {
7988 $this->nosave
= true;
7989 parent
::__construct('webservicesoverviewui',
7990 get_string('webservicesoverview', 'webservice'), '', '');
7994 * Always returns true, does nothing
7998 public function get_setting() {
8003 * Always returns true, does nothing
8007 public function get_defaultsetting() {
8012 * Always returns '', does not write anything
8014 * @return string Always returns ''
8016 public function write_setting($data) {
8017 // do not write any setting
8022 * Builds the XHTML to display the control
8024 * @param string $data Unused
8025 * @param string $query
8028 public function output_html($data, $query='') {
8029 global $CFG, $OUTPUT;
8032 $brtag = html_writer
::empty_tag('br');
8034 // Enable mobile web service
8035 $enablemobile = new admin_setting_enablemobileservice('enablemobilewebservice',
8036 get_string('enablemobilewebservice', 'admin'),
8037 get_string('configenablemobilewebservice',
8038 'admin', ''), 0); //we don't want to display it but to know the ws mobile status
8039 $manageserviceurl = new moodle_url("/admin/settings.php?section=mobile");
8040 $wsmobileparam = new stdClass();
8041 $wsmobileparam->enablemobileservice
= get_string('enablemobilewebservice', 'admin');
8042 $wsmobileparam->manageservicelink
= html_writer
::link($manageserviceurl,
8043 get_string('mobile', 'admin'));
8044 $mobilestatus = $enablemobile->get_setting()?
get_string('mobilewsenabled', 'webservice'):get_string('mobilewsdisabled', 'webservice');
8045 $wsmobileparam->wsmobilestatus
= html_writer
::tag('strong', $mobilestatus);
8046 $return .= $OUTPUT->heading(get_string('enablemobilewebservice', 'admin'), 3, 'main');
8047 $return .= $brtag . get_string('enablemobilewsoverview', 'webservice', $wsmobileparam)
8050 /// One system controlling Moodle with Token
8051 $return .= $OUTPUT->heading(get_string('onesystemcontrolling', 'webservice'), 3, 'main');
8052 $table = new html_table();
8053 $table->head
= array(get_string('step', 'webservice'), get_string('status'),
8054 get_string('description'));
8055 $table->colclasses
= array('leftalign step', 'leftalign status', 'leftalign description');
8056 $table->id
= 'onesystemcontrol';
8057 $table->attributes
['class'] = 'admintable wsoverview generaltable';
8058 $table->data
= array();
8060 $return .= $brtag . get_string('onesystemcontrollingdescription', 'webservice')
8063 /// 1. Enable Web Services
8065 $url = new moodle_url("/admin/search.php?query=enablewebservices");
8066 $row[0] = "1. " . html_writer
::tag('a', get_string('enablews', 'webservice'),
8067 array('href' => $url));
8068 $status = html_writer
::tag('span', get_string('no'), array('class' => 'statuscritical'));
8069 if ($CFG->enablewebservices
) {
8070 $status = get_string('yes');
8073 $row[2] = get_string('enablewsdescription', 'webservice');
8074 $table->data
[] = $row;
8076 /// 2. Enable protocols
8078 $url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
8079 $row[0] = "2. " . html_writer
::tag('a', get_string('enableprotocols', 'webservice'),
8080 array('href' => $url));
8081 $status = html_writer
::tag('span', get_string('none'), array('class' => 'statuscritical'));
8082 //retrieve activated protocol
8083 $active_protocols = empty($CFG->webserviceprotocols
) ?
8084 array() : explode(',', $CFG->webserviceprotocols
);
8085 if (!empty($active_protocols)) {
8087 foreach ($active_protocols as $protocol) {
8088 $status .= $protocol . $brtag;
8092 $row[2] = get_string('enableprotocolsdescription', 'webservice');
8093 $table->data
[] = $row;
8095 /// 3. Create user account
8097 $url = new moodle_url("/user/editadvanced.php?id=-1");
8098 $row[0] = "3. " . html_writer
::tag('a', get_string('createuser', 'webservice'),
8099 array('href' => $url));
8101 $row[2] = get_string('createuserdescription', 'webservice');
8102 $table->data
[] = $row;
8104 /// 4. Add capability to users
8106 $url = new moodle_url("/admin/roles/check.php?contextid=1");
8107 $row[0] = "4. " . html_writer
::tag('a', get_string('checkusercapability', 'webservice'),
8108 array('href' => $url));
8110 $row[2] = get_string('checkusercapabilitydescription', 'webservice');
8111 $table->data
[] = $row;
8113 /// 5. Select a web service
8115 $url = new moodle_url("/admin/settings.php?section=externalservices");
8116 $row[0] = "5. " . html_writer
::tag('a', get_string('selectservice', 'webservice'),
8117 array('href' => $url));
8119 $row[2] = get_string('createservicedescription', 'webservice');
8120 $table->data
[] = $row;
8122 /// 6. Add functions
8124 $url = new moodle_url("/admin/settings.php?section=externalservices");
8125 $row[0] = "6. " . html_writer
::tag('a', get_string('addfunctions', 'webservice'),
8126 array('href' => $url));
8128 $row[2] = get_string('addfunctionsdescription', 'webservice');
8129 $table->data
[] = $row;
8131 /// 7. Add the specific user
8133 $url = new moodle_url("/admin/settings.php?section=externalservices");
8134 $row[0] = "7. " . html_writer
::tag('a', get_string('selectspecificuser', 'webservice'),
8135 array('href' => $url));
8137 $row[2] = get_string('selectspecificuserdescription', 'webservice');
8138 $table->data
[] = $row;
8140 /// 8. Create token for the specific user
8142 $url = new moodle_url("/admin/webservice/tokens.php?sesskey=" . sesskey() . "&action=create");
8143 $row[0] = "8. " . html_writer
::tag('a', get_string('createtokenforuser', 'webservice'),
8144 array('href' => $url));
8146 $row[2] = get_string('createtokenforuserdescription', 'webservice');
8147 $table->data
[] = $row;
8149 /// 9. Enable the documentation
8151 $url = new moodle_url("/admin/search.php?query=enablewsdocumentation");
8152 $row[0] = "9. " . html_writer
::tag('a', get_string('enabledocumentation', 'webservice'),
8153 array('href' => $url));
8154 $status = '<span class="warning">' . get_string('no') . '</span>';
8155 if ($CFG->enablewsdocumentation
) {
8156 $status = get_string('yes');
8159 $row[2] = get_string('enabledocumentationdescription', 'webservice');
8160 $table->data
[] = $row;
8162 /// 10. Test the service
8164 $url = new moodle_url("/admin/webservice/testclient.php");
8165 $row[0] = "10. " . html_writer
::tag('a', get_string('testwithtestclient', 'webservice'),
8166 array('href' => $url));
8168 $row[2] = get_string('testwithtestclientdescription', 'webservice');
8169 $table->data
[] = $row;
8171 $return .= html_writer
::table($table);
8173 /// Users as clients with token
8174 $return .= $brtag . $brtag . $brtag;
8175 $return .= $OUTPUT->heading(get_string('userasclients', 'webservice'), 3, 'main');
8176 $table = new html_table();
8177 $table->head
= array(get_string('step', 'webservice'), get_string('status'),
8178 get_string('description'));
8179 $table->colclasses
= array('leftalign step', 'leftalign status', 'leftalign description');
8180 $table->id
= 'userasclients';
8181 $table->attributes
['class'] = 'admintable wsoverview generaltable';
8182 $table->data
= array();
8184 $return .= $brtag . get_string('userasclientsdescription', 'webservice') .
8187 /// 1. Enable Web Services
8189 $url = new moodle_url("/admin/search.php?query=enablewebservices");
8190 $row[0] = "1. " . html_writer
::tag('a', get_string('enablews', 'webservice'),
8191 array('href' => $url));
8192 $status = html_writer
::tag('span', get_string('no'), array('class' => 'statuscritical'));
8193 if ($CFG->enablewebservices
) {
8194 $status = get_string('yes');
8197 $row[2] = get_string('enablewsdescription', 'webservice');
8198 $table->data
[] = $row;
8200 /// 2. Enable protocols
8202 $url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
8203 $row[0] = "2. " . html_writer
::tag('a', get_string('enableprotocols', 'webservice'),
8204 array('href' => $url));
8205 $status = html_writer
::tag('span', get_string('none'), array('class' => 'statuscritical'));
8206 //retrieve activated protocol
8207 $active_protocols = empty($CFG->webserviceprotocols
) ?
8208 array() : explode(',', $CFG->webserviceprotocols
);
8209 if (!empty($active_protocols)) {
8211 foreach ($active_protocols as $protocol) {
8212 $status .= $protocol . $brtag;
8216 $row[2] = get_string('enableprotocolsdescription', 'webservice');
8217 $table->data
[] = $row;
8220 /// 3. Select a web service
8222 $url = new moodle_url("/admin/settings.php?section=externalservices");
8223 $row[0] = "3. " . html_writer
::tag('a', get_string('selectservice', 'webservice'),
8224 array('href' => $url));
8226 $row[2] = get_string('createserviceforusersdescription', 'webservice');
8227 $table->data
[] = $row;
8229 /// 4. Add functions
8231 $url = new moodle_url("/admin/settings.php?section=externalservices");
8232 $row[0] = "4. " . html_writer
::tag('a', get_string('addfunctions', 'webservice'),
8233 array('href' => $url));
8235 $row[2] = get_string('addfunctionsdescription', 'webservice');
8236 $table->data
[] = $row;
8238 /// 5. Add capability to users
8240 $url = new moodle_url("/admin/roles/check.php?contextid=1");
8241 $row[0] = "5. " . html_writer
::tag('a', get_string('addcapabilitytousers', 'webservice'),
8242 array('href' => $url));
8244 $row[2] = get_string('addcapabilitytousersdescription', 'webservice');
8245 $table->data
[] = $row;
8247 /// 6. Test the service
8249 $url = new moodle_url("/admin/webservice/testclient.php");
8250 $row[0] = "6. " . html_writer
::tag('a', get_string('testwithtestclient', 'webservice'),
8251 array('href' => $url));
8253 $row[2] = get_string('testauserwithtestclientdescription', 'webservice');
8254 $table->data
[] = $row;
8256 $return .= html_writer
::table($table);
8258 return highlight($query, $return);
8265 * Special class for web service protocol administration.
8267 * @author Petr Skoda (skodak)
8269 class admin_setting_managewebserviceprotocols
extends admin_setting
{
8272 * Calls parent::__construct with specific arguments
8274 public function __construct() {
8275 $this->nosave
= true;
8276 parent
::__construct('webservicesui', get_string('manageprotocols', 'webservice'), '', '');
8280 * Always returns true, does nothing
8284 public function get_setting() {
8289 * Always returns true, does nothing
8293 public function get_defaultsetting() {
8298 * Always returns '', does not write anything
8300 * @return string Always returns ''
8302 public function write_setting($data) {
8303 // do not write any setting
8308 * Checks if $query is one of the available webservices
8310 * @param string $query The string to search for
8311 * @return bool Returns true if found, false if not
8313 public function is_related($query) {
8314 if (parent
::is_related($query)) {
8318 $protocols = core_component
::get_plugin_list('webservice');
8319 foreach ($protocols as $protocol=>$location) {
8320 if (strpos($protocol, $query) !== false) {
8323 $protocolstr = get_string('pluginname', 'webservice_'.$protocol);
8324 if (strpos(core_text
::strtolower($protocolstr), $query) !== false) {
8332 * Builds the XHTML to display the control
8334 * @param string $data Unused
8335 * @param string $query
8338 public function output_html($data, $query='') {
8339 global $CFG, $OUTPUT;
8342 $stradministration = get_string('administration');
8343 $strsettings = get_string('settings');
8344 $stredit = get_string('edit');
8345 $strprotocol = get_string('protocol', 'webservice');
8346 $strenable = get_string('enable');
8347 $strdisable = get_string('disable');
8348 $strversion = get_string('version');
8350 $protocols_available = core_component
::get_plugin_list('webservice');
8351 $active_protocols = empty($CFG->webserviceprotocols
) ?
array() : explode(',', $CFG->webserviceprotocols
);
8352 ksort($protocols_available);
8354 foreach ($active_protocols as $key=>$protocol) {
8355 if (empty($protocols_available[$protocol])) {
8356 unset($active_protocols[$key]);
8360 $return = $OUTPUT->heading(get_string('actwebserviceshhdr', 'webservice'), 3, 'main');
8361 $return .= $OUTPUT->box_start('generalbox webservicesui');
8363 $table = new html_table();
8364 $table->head
= array($strprotocol, $strversion, $strenable, $strsettings);
8365 $table->colclasses
= array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
8366 $table->id
= 'webserviceprotocols';
8367 $table->attributes
['class'] = 'admintable generaltable';
8368 $table->data
= array();
8370 // iterate through auth plugins and add to the display table
8371 $url = "$CFG->wwwroot/$CFG->admin/webservice/protocols.php?sesskey=" . sesskey();
8372 foreach ($protocols_available as $protocol => $location) {
8373 $name = get_string('pluginname', 'webservice_'.$protocol);
8375 $plugin = new stdClass();
8376 if (file_exists($CFG->dirroot
.'/webservice/'.$protocol.'/version.php')) {
8377 include($CFG->dirroot
.'/webservice/'.$protocol.'/version.php');
8379 $version = isset($plugin->version
) ?
$plugin->version
: '';
8382 if (in_array($protocol, $active_protocols)) {
8383 $hideshow = "<a href=\"$url&action=disable&webservice=$protocol\">";
8384 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"$strdisable\" /></a>";
8385 $displayname = "<span>$name</span>";
8387 $hideshow = "<a href=\"$url&action=enable&webservice=$protocol\">";
8388 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"$strenable\" /></a>";
8389 $displayname = "<span class=\"dimmed_text\">$name</span>";
8393 if (file_exists($CFG->dirroot
.'/webservice/'.$protocol.'/settings.php')) {
8394 $settings = "<a href=\"settings.php?section=webservicesetting$protocol\">$strsettings</a>";
8399 // add a row to the table
8400 $table->data
[] = array($displayname, $version, $hideshow, $settings);
8402 $return .= html_writer
::table($table);
8403 $return .= get_string('configwebserviceplugins', 'webservice');
8404 $return .= $OUTPUT->box_end();
8406 return highlight($query, $return);
8412 * Special class for web service token administration.
8414 * @author Jerome Mouneyrac
8416 class admin_setting_managewebservicetokens
extends admin_setting
{
8419 * Calls parent::__construct with specific arguments
8421 public function __construct() {
8422 $this->nosave
= true;
8423 parent
::__construct('webservicestokenui', get_string('managetokens', 'webservice'), '', '');
8427 * Always returns true, does nothing
8431 public function get_setting() {
8436 * Always returns true, does nothing
8440 public function get_defaultsetting() {
8445 * Always returns '', does not write anything
8447 * @return string Always returns ''
8449 public function write_setting($data) {
8450 // do not write any setting
8455 * Builds the XHTML to display the control
8457 * @param string $data Unused
8458 * @param string $query
8461 public function output_html($data, $query='') {
8462 global $CFG, $OUTPUT, $DB, $USER;
8465 $stroperation = get_string('operation', 'webservice');
8466 $strtoken = get_string('token', 'webservice');
8467 $strservice = get_string('service', 'webservice');
8468 $struser = get_string('user');
8469 $strcontext = get_string('context', 'webservice');
8470 $strvaliduntil = get_string('validuntil', 'webservice');
8471 $striprestriction = get_string('iprestriction', 'webservice');
8473 $return = $OUTPUT->box_start('generalbox webservicestokenui');
8475 $table = new html_table();
8476 $table->head
= array($strtoken, $struser, $strservice, $striprestriction, $strvaliduntil, $stroperation);
8477 $table->colclasses
= array('leftalign', 'leftalign', 'leftalign', 'centeralign', 'centeralign', 'centeralign');
8478 $table->id
= 'webservicetokens';
8479 $table->attributes
['class'] = 'admintable generaltable';
8480 $table->data
= array();
8482 $tokenpageurl = "$CFG->wwwroot/$CFG->admin/webservice/tokens.php?sesskey=" . sesskey();
8484 //TODO: in order to let the administrator delete obsolete token, split this request in multiple request or use LEFT JOIN
8486 //here retrieve token list (including linked users firstname/lastname and linked services name)
8487 $sql = "SELECT t.id, t.token, u.id AS userid, u.firstname, u.lastname, s.name, t.iprestriction, t.validuntil, s.id AS serviceid
8488 FROM {external_tokens} t, {user} u, {external_services} s
8489 WHERE t.creatorid=? AND t.tokentype = ? AND s.id = t.externalserviceid AND t.userid = u.id";
8490 $tokens = $DB->get_records_sql($sql, array($USER->id
, EXTERNAL_TOKEN_PERMANENT
));
8491 if (!empty($tokens)) {
8492 foreach ($tokens as $token) {
8493 //TODO: retrieve context
8495 $delete = "<a href=\"".$tokenpageurl."&action=delete&tokenid=".$token->id
."\">";
8496 $delete .= get_string('delete')."</a>";
8499 if (!empty($token->validuntil
)) {
8500 $validuntil = userdate($token->validuntil
, get_string('strftimedatetime', 'langconfig'));
8503 $iprestriction = '';
8504 if (!empty($token->iprestriction
)) {
8505 $iprestriction = $token->iprestriction
;
8508 $userprofilurl = new moodle_url('/user/profile.php?id='.$token->userid
);
8509 $useratag = html_writer
::start_tag('a', array('href' => $userprofilurl));
8510 $useratag .= $token->firstname
." ".$token->lastname
;
8511 $useratag .= html_writer
::end_tag('a');
8513 //check user missing capabilities
8514 require_once($CFG->dirroot
. '/webservice/lib.php');
8515 $webservicemanager = new webservice();
8516 $usermissingcaps = $webservicemanager->get_missing_capabilities_by_users(
8517 array(array('id' => $token->userid
)), $token->serviceid
);
8519 if (!is_siteadmin($token->userid
) and
8520 array_key_exists($token->userid
, $usermissingcaps)) {
8521 $missingcapabilities = implode(', ',
8522 $usermissingcaps[$token->userid
]);
8523 if (!empty($missingcapabilities)) {
8524 $useratag .= html_writer
::tag('div',
8525 get_string('usermissingcaps', 'webservice',
8526 $missingcapabilities)
8527 . ' ' . $OUTPUT->help_icon('missingcaps', 'webservice'),
8528 array('class' => 'missingcaps'));
8532 $table->data
[] = array($token->token
, $useratag, $token->name
, $iprestriction, $validuntil, $delete);
8535 $return .= html_writer
::table($table);
8537 $return .= get_string('notoken', 'webservice');
8540 $return .= $OUTPUT->box_end();
8541 // add a token to the table
8542 $return .= "<a href=\"".$tokenpageurl."&action=create\">";
8543 $return .= get_string('add')."</a>";
8545 return highlight($query, $return);
8553 * @copyright 2010 Sam Hemelryk
8554 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8556 class admin_setting_configcolourpicker
extends admin_setting
{
8559 * Information for previewing the colour
8563 protected $previewconfig = null;
8566 * Use default when empty.
8568 protected $usedefaultwhenempty = true;
8572 * @param string $name
8573 * @param string $visiblename
8574 * @param string $description
8575 * @param string $defaultsetting
8576 * @param array $previewconfig Array('selector'=>'.some .css .selector','style'=>'backgroundColor');
8578 public function __construct($name, $visiblename, $description, $defaultsetting, array $previewconfig = null,
8579 $usedefaultwhenempty = true) {
8580 $this->previewconfig
= $previewconfig;
8581 $this->usedefaultwhenempty
= $usedefaultwhenempty;
8582 parent
::__construct($name, $visiblename, $description, $defaultsetting);
8586 * Return the setting
8588 * @return mixed returns config if successful else null
8590 public function get_setting() {
8591 return $this->config_read($this->name
);
8597 * @param string $data
8600 public function write_setting($data) {
8601 $data = $this->validate($data);
8602 if ($data === false) {
8603 return get_string('validateerror', 'admin');
8605 return ($this->config_write($this->name
, $data) ?
'' : get_string('errorsetting', 'admin'));
8609 * Validates the colour that was entered by the user
8611 * @param string $data
8612 * @return string|false
8614 protected function validate($data) {
8616 * List of valid HTML colour names
8620 $colornames = array(
8621 'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure',
8622 'beige', 'bisque', 'black', 'blanchedalmond', 'blue',
8623 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse',
8624 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson',
8625 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray',
8626 'darkgrey', 'darkgreen', 'darkkhaki', 'darkmagenta',
8627 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred',
8628 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray',
8629 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink',
8630 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick',
8631 'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro',
8632 'ghostwhite', 'gold', 'goldenrod', 'gray', 'grey', 'green',
8633 'greenyellow', 'honeydew', 'hotpink', 'indianred', 'indigo',
8634 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen',
8635 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan',
8636 'lightgoldenrodyellow', 'lightgray', 'lightgrey', 'lightgreen',
8637 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue',
8638 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow',
8639 'lime', 'limegreen', 'linen', 'magenta', 'maroon',
8640 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple',
8641 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen',
8642 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream',
8643 'mistyrose', 'moccasin', 'navajowhite', 'navy', 'oldlace', 'olive',
8644 'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod',
8645 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip',
8646 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'red',
8647 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown',
8648 'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue',
8649 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan',
8650 'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white',
8651 'whitesmoke', 'yellow', 'yellowgreen'
8654 if (preg_match('/^#?([[:xdigit:]]{3}){1,2}$/', $data)) {
8655 if (strpos($data, '#')!==0) {
8659 } else if (in_array(strtolower($data), $colornames)) {
8661 } else if (preg_match('/rgb\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\)/i', $data)) {
8663 } else if (preg_match('/rgba\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\, ?\d(\.\d)?\)/i', $data)) {
8665 } else if (preg_match('/hsl\(\d{0,3}\, ?\d{0,3}%, ?\d{0,3}%\)/i', $data)) {
8667 } else if (preg_match('/hsla\(\d{0,3}\, ?\d{0,3}%,\d{0,3}%\, ?\d(\.\d)?\)/i', $data)) {
8669 } else if (($data == 'transparent') ||
($data == 'currentColor') ||
($data == 'inherit')) {
8671 } else if (empty($data)) {
8672 if ($this->usedefaultwhenempty
){
8673 return $this->defaultsetting
;
8683 * Generates the HTML for the setting
8685 * @global moodle_page $PAGE
8686 * @global core_renderer $OUTPUT
8687 * @param string $data
8688 * @param string $query
8690 public function output_html($data, $query = '') {
8691 global $PAGE, $OUTPUT;
8692 $PAGE->requires
->js_init_call('M.util.init_colour_picker', array($this->get_id(), $this->previewconfig
));
8693 $content = html_writer
::start_tag('div', array('class'=>'form-colourpicker defaultsnext'));
8694 $content .= html_writer
::tag('div', $OUTPUT->pix_icon('i/loading', get_string('loading', 'admin'), 'moodle', array('class'=>'loadingicon')), array('class'=>'admin_colourpicker clearfix'));
8695 $content .= html_writer
::empty_tag('input', array('type'=>'text','id'=>$this->get_id(), 'name'=>$this->get_full_name(), 'value'=>$data, 'size'=>'12'));
8696 if (!empty($this->previewconfig
)) {
8697 $content .= html_writer
::empty_tag('input', array('type'=>'button','id'=>$this->get_id().'_preview', 'value'=>get_string('preview'), 'class'=>'admin_colourpicker_preview'));
8699 $content .= html_writer
::end_tag('div');
8700 return format_admin_setting($this, $this->visiblename
, $content, $this->description
, true, '', $this->get_defaultsetting(), $query);
8706 * Class used for uploading of one file into file storage,
8707 * the file name is stored in config table.
8709 * Please note you need to implement your own '_pluginfile' callback function,
8710 * this setting only stores the file, it does not deal with file serving.
8712 * @copyright 2013 Petr Skoda {@link http://skodak.org}
8713 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8715 class admin_setting_configstoredfile
extends admin_setting
{
8716 /** @var array file area options - should be one file only */
8718 /** @var string name of the file area */
8719 protected $filearea;
8720 /** @var int intemid */
8722 /** @var string used for detection of changes */
8723 protected $oldhashes;
8726 * Create new stored file setting.
8728 * @param string $name low level setting name
8729 * @param string $visiblename human readable setting name
8730 * @param string $description description of setting
8731 * @param mixed $filearea file area for file storage
8732 * @param int $itemid itemid for file storage
8733 * @param array $options file area options
8735 public function __construct($name, $visiblename, $description, $filearea, $itemid = 0, array $options = null) {
8736 parent
::__construct($name, $visiblename, $description, '');
8737 $this->filearea
= $filearea;
8738 $this->itemid
= $itemid;
8739 $this->options
= (array)$options;
8743 * Applies defaults and returns all options.
8746 protected function get_options() {
8749 require_once("$CFG->libdir/filelib.php");
8750 require_once("$CFG->dirroot/repository/lib.php");
8752 'mainfile' => '', 'subdirs' => 0, 'maxbytes' => -1, 'maxfiles' => 1,
8753 'accepted_types' => '*', 'return_types' => FILE_INTERNAL
, 'areamaxbytes' => FILE_AREA_MAX_BYTES_UNLIMITED
,
8754 'context' => context_system
::instance());
8755 foreach($this->options
as $k => $v) {
8762 public function get_setting() {
8763 return $this->config_read($this->name
);
8766 public function write_setting($data) {
8769 // Let's not deal with validation here, this is for admins only.
8770 $current = $this->get_setting();
8771 if (empty($data) && $current === null) {
8772 // This will be the case when applying default settings (installation).
8773 return ($this->config_write($this->name
, '') ?
'' : get_string('errorsetting', 'admin'));
8774 } else if (!is_number($data)) {
8775 // Draft item id is expected here!
8776 return get_string('errorsetting', 'admin');
8779 $options = $this->get_options();
8780 $fs = get_file_storage();
8781 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
8783 $this->oldhashes
= null;
8785 $hash = sha1('/'.$options['context']->id
.'/'.$component.'/'.$this->filearea
.'/'.$this->itemid
.$current);
8786 if ($file = $fs->get_file_by_hash($hash)) {
8787 $this->oldhashes
= $file->get_contenthash().$file->get_pathnamehash();
8792 if ($fs->file_exists($options['context']->id
, $component, $this->filearea
, $this->itemid
, '/', '.')) {
8793 // Make sure the settings form was not open for more than 4 days and draft areas deleted in the meantime.
8794 // But we can safely ignore that if the destination area is empty, so that the user is not prompt
8795 // with an error because the draft area does not exist, as he did not use it.
8796 $usercontext = context_user
::instance($USER->id
);
8797 if (!$fs->file_exists($usercontext->id
, 'user', 'draft', $data, '/', '.') && $current !== '') {
8798 return get_string('errorsetting', 'admin');
8802 file_save_draft_area_files($data, $options['context']->id
, $component, $this->filearea
, $this->itemid
, $options);
8803 $files = $fs->get_area_files($options['context']->id
, $component, $this->filearea
, $this->itemid
, 'sortorder,filepath,filename', false);
8807 /** @var stored_file $file */
8808 $file = reset($files);
8809 $filepath = $file->get_filepath().$file->get_filename();
8812 return ($this->config_write($this->name
, $filepath) ?
'' : get_string('errorsetting', 'admin'));
8815 public function post_write_settings($original) {
8816 $options = $this->get_options();
8817 $fs = get_file_storage();
8818 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
8820 $current = $this->get_setting();
8823 $hash = sha1('/'.$options['context']->id
.'/'.$component.'/'.$this->filearea
.'/'.$this->itemid
.$current);
8824 if ($file = $fs->get_file_by_hash($hash)) {
8825 $newhashes = $file->get_contenthash().$file->get_pathnamehash();
8830 if ($this->oldhashes
=== $newhashes) {
8831 $this->oldhashes
= null;
8834 $this->oldhashes
= null;
8836 $callbackfunction = $this->updatedcallback
;
8837 if (!empty($callbackfunction) and function_exists($callbackfunction)) {
8838 $callbackfunction($this->get_full_name());
8843 public function output_html($data, $query = '') {
8846 $options = $this->get_options();
8847 $id = $this->get_id();
8848 $elname = $this->get_full_name();
8849 $draftitemid = file_get_submitted_draft_itemid($elname);
8850 $component = is_null($this->plugin
) ?
'core' : $this->plugin
;
8851 file_prepare_draft_area($draftitemid, $options['context']->id
, $component, $this->filearea
, $this->itemid
, $options);
8853 // Filemanager form element implementation is far from optimal, we need to rework this if we ever fix it...
8854 require_once("$CFG->dirroot/lib/form/filemanager.php");
8856 $fmoptions = new stdClass();
8857 $fmoptions->mainfile
= $options['mainfile'];
8858 $fmoptions->maxbytes
= $options['maxbytes'];
8859 $fmoptions->maxfiles
= $options['maxfiles'];
8860 $fmoptions->client_id
= uniqid();
8861 $fmoptions->itemid
= $draftitemid;
8862 $fmoptions->subdirs
= $options['subdirs'];
8863 $fmoptions->target
= $id;
8864 $fmoptions->accepted_types
= $options['accepted_types'];
8865 $fmoptions->return_types
= $options['return_types'];
8866 $fmoptions->context
= $options['context'];
8867 $fmoptions->areamaxbytes
= $options['areamaxbytes'];
8869 $fm = new form_filemanager($fmoptions);
8870 $output = $PAGE->get_renderer('core', 'files');
8871 $html = $output->render($fm);
8873 $html .= '<input value="'.$draftitemid.'" name="'.$elname.'" type="hidden" />';
8874 $html .= '<input value="" id="'.$id.'" type="hidden" />';
8876 return format_admin_setting($this, $this->visiblename
,
8877 '<div class="form-filemanager">'.$html.'</div>', $this->description
, true, '', '', $query);
8883 * Administration interface for user specified regular expressions for device detection.
8885 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
8887 class admin_setting_devicedetectregex
extends admin_setting
{
8890 * Calls parent::__construct with specific args
8892 * @param string $name
8893 * @param string $visiblename
8894 * @param string $description
8895 * @param mixed $defaultsetting
8897 public function __construct($name, $visiblename, $description, $defaultsetting = '') {
8899 parent
::__construct($name, $visiblename, $description, $defaultsetting);
8903 * Return the current setting(s)
8905 * @return array Current settings array
8907 public function get_setting() {
8910 $config = $this->config_read($this->name
);
8911 if (is_null($config)) {
8915 return $this->prepare_form_data($config);
8919 * Save selected settings
8921 * @param array $data Array of settings to save
8924 public function write_setting($data) {
8929 if ($this->config_write($this->name
, $this->process_form_data($data))) {
8930 return ''; // success
8932 return get_string('errorsetting', 'admin') . $this->visiblename
. html_writer
::empty_tag('br');
8937 * Return XHTML field(s) for regexes
8939 * @param array $data Array of options to set in HTML
8940 * @return string XHTML string for the fields and wrapping div(s)
8942 public function output_html($data, $query='') {
8945 $out = html_writer
::start_tag('table', array('class' => 'generaltable'));
8946 $out .= html_writer
::start_tag('thead');
8947 $out .= html_writer
::start_tag('tr');
8948 $out .= html_writer
::tag('th', get_string('devicedetectregexexpression', 'admin'));
8949 $out .= html_writer
::tag('th', get_string('devicedetectregexvalue', 'admin'));
8950 $out .= html_writer
::end_tag('tr');
8951 $out .= html_writer
::end_tag('thead');
8952 $out .= html_writer
::start_tag('tbody');
8957 $looplimit = (count($data)/2)+
1;
8960 for ($i=0; $i<$looplimit; $i++
) {
8961 $out .= html_writer
::start_tag('tr');
8963 $expressionname = 'expression'.$i;
8965 if (!empty($data[$expressionname])){
8966 $expression = $data[$expressionname];
8971 $out .= html_writer
::tag('td',
8972 html_writer
::empty_tag('input',
8975 'class' => 'form-text',
8976 'name' => $this->get_full_name().'[expression'.$i.']',
8977 'value' => $expression,
8979 ), array('class' => 'c'.$i)
8982 $valuename = 'value'.$i;
8984 if (!empty($data[$valuename])){
8985 $value = $data[$valuename];
8990 $out .= html_writer
::tag('td',
8991 html_writer
::empty_tag('input',
8994 'class' => 'form-text',
8995 'name' => $this->get_full_name().'[value'.$i.']',
8998 ), array('class' => 'c'.$i)
9001 $out .= html_writer
::end_tag('tr');
9004 $out .= html_writer
::end_tag('tbody');
9005 $out .= html_writer
::end_tag('table');
9007 return format_admin_setting($this, $this->visiblename
, $out, $this->description
, false, '', null, $query);
9011 * Converts the string of regexes
9013 * @see self::process_form_data()
9014 * @param $regexes string of regexes
9015 * @return array of form fields and their values
9017 protected function prepare_form_data($regexes) {
9019 $regexes = json_decode($regexes);
9025 foreach ($regexes as $value => $regex) {
9026 $expressionname = 'expression'.$i;
9027 $valuename = 'value'.$i;
9029 $form[$expressionname] = $regex;
9030 $form[$valuename] = $value;
9038 * Converts the data from admin settings form into a string of regexes
9040 * @see self::prepare_form_data()
9041 * @param array $data array of admin form fields and values
9042 * @return false|string of regexes
9044 protected function process_form_data(array $form) {
9046 $count = count($form); // number of form field values
9049 // we must get five fields per expression
9054 for ($i = 0; $i < $count / 2; $i++
) {
9055 $expressionname = "expression".$i;
9056 $valuename = "value".$i;
9058 $expression = trim($form['expression'.$i]);
9059 $value = trim($form['value'.$i]);
9061 if (empty($expression)){
9065 $regexes[$value] = $expression;
9068 $regexes = json_encode($regexes);
9075 * Multiselect for current modules
9077 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9079 class admin_setting_configmultiselect_modules
extends admin_setting_configmultiselect
{
9080 private $excludesystem;
9083 * Calls parent::__construct - note array $choices is not required
9085 * @param string $name setting name
9086 * @param string $visiblename localised setting name
9087 * @param string $description setting description
9088 * @param array $defaultsetting a plain array of default module ids
9089 * @param bool $excludesystem If true, excludes modules with 'system' archetype
9091 public function __construct($name, $visiblename, $description, $defaultsetting = array(),
9092 $excludesystem = true) {
9093 parent
::__construct($name, $visiblename, $description, $defaultsetting, null);
9094 $this->excludesystem
= $excludesystem;
9098 * Loads an array of current module choices
9100 * @return bool always return true
9102 public function load_choices() {
9103 if (is_array($this->choices
)) {
9106 $this->choices
= array();
9109 $records = $DB->get_records('modules', array('visible'=>1), 'name');
9110 foreach ($records as $record) {
9111 // Exclude modules if the code doesn't exist
9112 if (file_exists("$CFG->dirroot/mod/$record->name/lib.php")) {
9113 // Also exclude system modules (if specified)
9114 if (!($this->excludesystem
&&
9115 plugin_supports('mod', $record->name
, FEATURE_MOD_ARCHETYPE
) ===
9116 MOD_ARCHETYPE_SYSTEM
)) {
9117 $this->choices
[$record->id
] = $record->name
;
9126 * Admin setting to show if a php extension is enabled or not.
9128 * @copyright 2013 Damyon Wiese
9129 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9131 class admin_setting_php_extension_enabled
extends admin_setting
{
9133 /** @var string The name of the extension to check for */
9137 * Calls parent::__construct with specific arguments
9139 public function __construct($name, $visiblename, $description, $extension) {
9140 $this->extension
= $extension;
9141 $this->nosave
= true;
9142 parent
::__construct($name, $visiblename, $description, '');
9146 * Always returns true, does nothing
9150 public function get_setting() {
9155 * Always returns true, does nothing
9159 public function get_defaultsetting() {
9164 * Always returns '', does not write anything
9166 * @return string Always returns ''
9168 public function write_setting($data) {
9169 // Do not write any setting.
9174 * Outputs the html for this setting.
9175 * @return string Returns an XHTML string
9177 public function output_html($data, $query='') {
9181 if (!extension_loaded($this->extension
)) {
9182 $warning = $OUTPUT->pix_icon('i/warning', '', '', array('role' => 'presentation')) . ' ' . $this->description
;
9184 $o .= format_admin_setting($this, $this->visiblename
, $warning);
9191 * Server timezone setting.
9193 * @copyright 2015 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
9194 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9195 * @author Petr Skoda <petr.skoda@totaralms.com>
9197 class admin_setting_servertimezone
extends admin_setting_configselect
{
9201 public function __construct() {
9202 $default = core_date
::get_default_php_timezone();
9203 if ($default === 'UTC') {
9204 // Nobody really wants UTC, so instead default selection to the country that is confused by the UTC the most.
9205 $default = 'Europe/London';
9208 parent
::__construct('timezone',
9209 new lang_string('timezone', 'core_admin'),
9210 new lang_string('configtimezone', 'core_admin'), $default, null);
9214 * Lazy load timezone options.
9215 * @return bool true if loaded, false if error
9217 public function load_choices() {
9219 if (is_array($this->choices
)) {
9223 $current = isset($CFG->timezone
) ?
$CFG->timezone
: null;
9224 $this->choices
= core_date
::get_list_of_timezones($current, false);
9225 if ($current == 99) {
9226 // Do not show 99 unless it is current value, we want to get rid of it over time.
9227 $this->choices
['99'] = new lang_string('timezonephpdefault', 'core_admin',
9228 core_date
::get_default_php_timezone());
9236 * Forced user timezone setting.
9238 * @copyright 2015 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
9239 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9240 * @author Petr Skoda <petr.skoda@totaralms.com>
9242 class admin_setting_forcetimezone
extends admin_setting_configselect
{
9246 public function __construct() {
9247 parent
::__construct('forcetimezone',
9248 new lang_string('forcetimezone', 'core_admin'),
9249 new lang_string('helpforcetimezone', 'core_admin'), '99', null);
9253 * Lazy load timezone options.
9254 * @return bool true if loaded, false if error
9256 public function load_choices() {
9258 if (is_array($this->choices
)) {
9262 $current = isset($CFG->forcetimezone
) ?
$CFG->forcetimezone
: null;
9263 $this->choices
= core_date
::get_list_of_timezones($current, true);
9264 $this->choices
['99'] = new lang_string('timezonenotforced', 'core_admin');