From 6e4dc10f545a4e23705e3882f562c35a77232790 Mon Sep 17 00:00:00 2001 From: skodak Date: Sat, 2 Sep 2006 13:14:57 +0000 Subject: [PATCH] deglobalization of $ADMIN; merged admin/adminlib.php into lib/adminlib.php; fixed includes and some other minor fixes --- admin/adminlib.php | 1657 ---------------- admin/auth.php | 9 +- admin/block.php | 9 +- admin/blocks.php | 11 +- admin/cron.php | 2 +- admin/enrol.php | 9 +- admin/enrol_config.php | 9 +- admin/environment.php | 9 +- admin/filter.php | 9 +- admin/filters.php | 9 +- admin/index.php | 19 +- admin/lang.php | 11 +- admin/langdoc.php | 9 +- admin/langimport.php | 9 +- admin/maintenance.php | 9 +- admin/module.php | 9 +- admin/modules.php | 11 +- admin/pagelib.php | 15 +- admin/roles/manage.php | 11 +- admin/settings.php | 8 +- admin/settings/first.php | 2 +- admin/timezoneimport.php | 9 +- admin/upgradesettings.php | 12 +- backup/lib.php | 6 +- blocks/admin/block_admin.php | 2 +- blocks/admin_2/block_admin_2.php | 14 +- .../admin_bookmarks/block_admin_bookmarks.php | 11 +- blocks/admin_bookmarks/create.php | 5 +- blocks/admin_bookmarks/delete.php | 5 +- course/category.php | 9 +- course/index.php | 9 +- lib/adminlib.php | 1664 +++++++++++++++++ lib/environmentlib.php | 2 +- theme/index.php | 11 +- 34 files changed, 1819 insertions(+), 1786 deletions(-) delete mode 100644 admin/adminlib.php diff --git a/admin/adminlib.php b/admin/adminlib.php deleted file mode 100644 index 87f2697121..0000000000 --- a/admin/adminlib.php +++ /dev/null @@ -1,1657 +0,0 @@ -add('userinterface', new admin_externalpage('foo', get_string('foo'), -/// $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission')); - -/// Next, in foo.php, your file structure would resemble the following: - -/// require_once('.../config.php'); -/// require_once($CFG->dirroot . '/' . $CFG->admin . '/adminlib.php'); -/// admin_externalpage_setup('foo'); -/// // functionality like processing form submissions goes here -/// admin_externalpage_print_header(); -/// // your HTML goes here -/// admin_externalpage_print_footer(); - -/// The admin_externalpage_setup() function call ensures the user is logged in, -/// and makes sure that they have the proper role permission to access the page. - -/// The admin_externalpage_print_header() function prints the header (it figures -/// out what category and subcategories the page is classified under) and ensures -/// that you're using the admin pagelib (which provides the admin tree block and -/// the admin bookmarks block). - -/// The admin_externalpage_print_footer() function properly closes the tables -/// opened up by the admin_externalpage_print_header() function and prints the -/// standard Moodle footer. - -/// ADMIN_CATEGORY OBJECTS - -/// Above and beyond all this, we have admin_category objects. These objects -/// appear as folders in the admin tree block. They contain admin_settingpage's, -/// admin_externalpage's, and other admin_category's. - -/// OTHER NOTES - -/// admin_settingpage's, admin_externalpage's, and admin_category's all inherit -/// from part_of_admin_tree (a pseudointerface). This interface insists that -/// a class has a check_access method for access permissions, a locate method -/// used to find a specific node in the $ADMIN tree, and a path method used -/// to determine the path to a specific node in the $ADMIN tree. - -/// admin_category's inherit from parentable_part_of_admin_tree. This pseudo- -/// interface ensures that the class implements a recursive add function which -/// accepts a part_of_admin_tree object and searches for the proper place to -/// put it. parentable_part_of_admin_tree implies part_of_admin_tree. - -/// Please note that the $this->name field of any part_of_admin_tree must be -/// UNIQUE throughout the ENTIRE admin tree. - -/// The $this->name field of an admin_setting object (which is *not* part_of_ -/// admin_tree) must be unique on the respective admin_settingpage where it is -/// used. - - -/// MISCELLANEOUS STUFF (used by classes defined below) /////////////////////// -include_once($CFG->dirroot . '/backup/lib.php'); - -/// CLASS DEFINITIONS ///////////////////////////////////////////////////////// - -/** - * Pseudointerface for anything appearing in the admin tree - * - * The pseudointerface that is implemented by anything that appears in the admin tree - * block. It forces inheriting classes to define a method for checking user permissions - * and methods for finding something in the admin tree. - * - * @author Vincenzo K. Marcovecchio - * @package admin - */ -class part_of_admin_tree { - - /** - * Finds a named part_of_admin_tree. - * - * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree - * and not parentable_part_of_admin_tree, then this function should only check if - * $this->name matches $name. If it does, it should return a reference to $this, - * otherwise, it should return a reference to NULL. - * - * If a class inherits parentable_part_of_admin_tree, this method should be called - * recursively on all child objects (assuming, of course, the parent object's name - * doesn't match the search criterion). - * - * @param string $name The internal name of the part_of_admin_tree we're searching for. - * @return mixed An object reference or a NULL reference. - */ - function &locate($name) { - trigger_error('Admin class does not implement method locate()', E_USER_WARNING); - return; - } - - /** - * Verifies current user's access to this part_of_admin_tree. - * - * Used to check if the current user has access to this part of the admin tree or - * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, - * then this method is usually just a call to has_capability() in the site context. - * - * If a class inherits parentable_part_of_admin_tree, this method should return the - * logical OR of the return of check_access() on all child objects. - * - * @return bool True if the user has access, false if she doesn't. - */ - function check_access() { - trigger_error('Admin class does not implement method check_access()', E_USER_WARNING); - return; - } - - /** - * Determines the path to $name in the admin tree. - * - * Used to determine the path to $name in the admin tree. If a class inherits only - * part_of_admin_tree and not parentable_part_of_admin_tree, then this method should - * check if $this->name matches $name. If it does, $name is pushed onto the $path - * array (at the end), and $path should be returned. If it doesn't, NULL should be - * returned. - * - * If a class inherits parentable_part_of_admin_tree, it should do the above, but not - * return NULL on failure. Instead, it pushes $this->name onto $path, and then - * recursively calls path() on its child objects. If any are non-NULL, it should - * return $path (being certain that the last element of $path is equal to $name). - * If they are all NULL, it returns NULL. - * - * @param string $name The internal name of the part_of_admin_tree we're searching for. - * @param array $path Not used on external calls. Defaults to empty array. - * @return mixed If found, an array containing the internal names of each part_of_admin_tree that leads to $name. If not found, NULL. - */ - function path($name, $path = array()) { - trigger_error('Admin class does not implement method path()', E_USER_WARNING); - return; - } -} - -/** - * Pseudointerface implemented by any part_of_admin_tree that has children. - * - * The pseudointerface implemented by any part_of_admin_tree that can be a parent - * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart - * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods - * include an add method for adding other part_of_admin_tree objects as children. - * - * @author Vincenzo K. Marcovecchio - * @package admin - */ -class parentable_part_of_admin_tree extends part_of_admin_tree { - - /** - * Adds a part_of_admin_tree object to the admin tree. - * - * Used to add a part_of_admin_tree object to this object or a child of this - * object. $something should only be added if $destinationname matches - * $this->name. If it doesn't, add should be called on child objects that are - * also parentable_part_of_admin_tree's. - * - * @param string $destinationname The internal name of the new parent for $something. - * @param part_of_admin_tree &$something The object to be added. - * @return bool True on success, false on failure. - */ - function add($destinationname, &$something) { - trigger_error('Admin class does not implement method add()', E_USER_WARNING); - return; - } - -} - -/** - * The object used to represent folders (a.k.a. categories) in the admin tree block. - * - * Each admin_category object contains a number of part_of_admin_tree objects. - * - * @author Vincenzo K. Marcovecchio - * @package admin - */ -class admin_category extends parentable_part_of_admin_tree { - - /** - * @var mixed An array of part_of_admin_tree objects that are this object's children - */ - var $children; - - /** - * @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects - */ - var $name; - - /** - * @var string The displayed name for this category. Usually obtained through get_string() - */ - var $visiblename; - - // constructor for an empty admin category - // $name is the internal name of the category. it MUST be unique in the entire hierarchy - // $visiblename is the displayed name of the category. use a get_string for this - - /** - * Constructor for an empty admin category - * - * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects - * @param string $visiblename The displayed named for this category. Usually obtained through get_string() - * @return mixed Returns the new object. - */ - function admin_category($name, $visiblename) { - $this->children = array(); - $this->name = $name; - $this->visiblename = $visiblename; - } - - /** - * Finds the path to the part_of_admin_tree called $name. - * - * @param string $name The internal name that we're searching for. - * @param array $path Used internally for recursive calls. Do not specify on external calls. Defaults to array(). - * @return mixed An array of internal names that leads to $name, or NULL if not found. - */ - function path($name, $path = array()) { - - $path[count($path)] = $this->name; - - if ($this->name == $name) { - return $path; - } - - foreach($this->children as $child) { - if ($return = $child->path($name, $path)) { - return $return; - } - } - - return NULL; - - } - - /** - * Returns a reference to the part_of_admin_tree object with internal name $name. - * - * @param string $name The internal name of the object we want. - * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. - */ - function &locate($name) { - - if ($this->name == $name) { - return $this; - } - - foreach($this->children as $child) { - if ($return =& $child->locate($name)) { - return $return; - } - } - $return = NULL; - return $return; - } - - /** - * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object. - * - * @param string $destinationame The internal name of the immediate parent that we want for &$something. - * @param mixed &$something A part_of_admin_tree object to be added. - * @param int $precedence The precedence of &$something when displayed. Smaller numbers mean it'll be displayed higher up in the admin menu. Defaults to '', meaning "next available position". - * @return bool True if successfully added, false if &$something is not a part_of_admin_tree or if $name is not found. - */ - function add($destinationname, &$something, $precedence = '') { - - if (!is_a($something, 'part_of_admin_tree')) { - return false; - } - - if ($destinationname == $this->name) { - if ($precedence === '') { - $this->children[] = $something; - } else { - if (isset($this->children[$precedence])) { // this should never, ever be triggered in a release version of moodle. - echo ('There is a precedence conflict in the category ' . $this->name . '. The object named ' . $something->name . ' is overwriting the object named ' . $this->children[$precedence]->name . '.
'); - } - $this->children[$precedence] = $something; - } - return true; - } - - unset($entries); - - $entries = array_keys($this->children); - - foreach($entries as $entry) { - $child =& $this->children[$entry]; - if (is_a($child, 'parentable_part_of_admin_tree')) { - if ($child->add($destinationname, $something, $precedence)) { - return true; - } - } - } - - return false; - - } - - /** - * Checks if the user has access to anything in this category. - * - * @return bool True if the user has access to atleast one child in this category, false otherwise. - */ - function check_access() { - - $return = false; - foreach ($this->children as $child) { - $return = $return || $child->check_access(); - } - - return $return; - - } - -} - -/** - * Links external PHP pages into the admin tree. - * - * See detailed usage example at the top of this document (adminlib.php) - * - * @author Vincenzo K. Marcovecchio - * @package admin - */ -class admin_externalpage extends part_of_admin_tree { - - /** - * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects - */ - var $name; - - /** - * @var string The displayed name for this external page. Usually obtained through get_string(). - */ - var $visiblename; - - /** - * @var string The external URL that we should link to when someone requests this external page. - */ - var $url; - - /** - * @var string The role capability/permission a user must have to access this external page. - */ - var $role; - - /** - * Constructor for adding an external page into the admin tree. - * - * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. - * @param string $visiblename The displayed name for this external page. Usually obtained through get_string(). - * @param string $url The external URL that we should link to when someone requests this external page. - * @param string $role The role capability/permission a user must have to access this external page. Defaults to 'moodle/legacy:admin'. - */ - function admin_externalpage($name, $visiblename, $url, $role = 'moodle/legacy:admin') { - $this->name = $name; - $this->visiblename = $visiblename; - $this->url = $url; - $this->role = $role; - } - - /** - * Finds the path to the part_of_admin_tree called $name. - * - * @param string $name The internal name that we're searching for. - * @param array $path Used internally for recursive calls. Do not specify on external calls. Defaults to array(). - * @return mixed An array of internal names that leads to $name, or NULL if not found. - */ - function path($name, $path = array()) { - if ($name == $this->name) { - array_push($path, $this->name); - return $path; - } else { - return NULL; - } - } - - /** - * Returns a reference to the part_of_admin_tree object with internal name $name. - * - * @param string $name The internal name of the object we want. - * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. - */ - function &locate($name) { - $return = ($this->name == $name ? $this : NULL); - return $return; - } - - /** - * Determines if the current user has access to this external page based on $this->role. - * - * @uses CONTEXT_SYSTEM - * @uses SITEID - * @return bool True if user has access, false otherwise. - */ - function check_access() { - if (!get_site()) { - return true; // no access check before site is fully set up - } - $context = get_context_instance(CONTEXT_SYSTEM, SITEID); - return has_capability($this->role, $context); - } - -} - -/** - * Used to group a number of admin_setting objects into a page and add them to the admin tree. - * - * @author Vincenzo K. Marcovecchio - * @package admin - */ -class admin_settingpage extends part_of_admin_tree { - - /** - * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects - */ - var $name; - - /** - * @var string The displayed name for this external page. Usually obtained through get_string(). - */ - var $visiblename; - /** - * @var mixed An array of admin_setting objects that are part of this setting page. - */ - var $settings; - - /** - * @var string The role capability/permission a user must have to access this external page. - */ - var $role; - - // see admin_category - function path($name, $path = array()) { - if ($name == $this->name) { - array_push($path, $this->name); - return $path; - } else { - return NULL; - } - } - - // see admin_category - function &locate($name) { - $return = ($this->name == $name ? $this : NULL); - return $return; - } - - // see admin_externalpage - function admin_settingpage($name, $visiblename, $role = 'moodle/legacy:admin') { - global $CFG; - $this->settings = new stdClass(); - $this->name = $name; - $this->visiblename = $visiblename; - $this->role = $role; - } - - // 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 - // n.b. each admin_setting in an admin_settingpage must have a unique internal name - // &$setting is the admin_setting object you want to add - // returns true if successful, false if not (will fail if &$setting is an admin_setting or child thereof) - function add(&$setting) { - if (is_a($setting, 'admin_setting')) { - $this->settings->{$setting->name} =& $setting; - return true; - } - return false; - } - - // see admin_externalpage - function check_access() { - if (!get_site()) { - return true; // no access check before site is fully set up - } - $context = get_context_instance(CONTEXT_SYSTEM, SITEID); - return has_capability($this->role, $context); - } - - // outputs this page as html in a table (suitable for inclusion in an admin pagetype) - // returns a string of the html - function output_html() { - $return = '' . "\n"; - foreach($this->settings as $setting) { - $return .= $setting->output_html(); - } - $return .= '
'; - return $return; - } - - // writes settings (the ones that have been added to this admin_settingpage) to the database, or wherever else they're supposed to be written to - // -- calls write_setting() to each child setting, sending it only the data that matches each setting's internal name - // $data should be the result from data_submitted() - // returns an empty string if everything went well, otherwise returns a printable error string (that's language-specific) - function write_settings($data) { - $return = ''; - foreach($this->settings as $setting) { - if (isset($data['s_' . $setting->name])) { - $return .= $setting->write_setting($data['s_' . $setting->name]); - } else { - $return .= $setting->write_setting(''); - } - } - return $return; - } - -} - - -// read & write happens at this level; no authentication -class admin_setting { - - var $name; - var $visiblename; - var $description; - var $defaultsetting; - - function admin_setting($name, $visiblename, $description, $defaultsetting) { - $this->name = $name; - $this->visiblename = $visiblename; - $this->description = $description; - $this->defaultsetting = $defaultsetting; - } - - function get_setting() { - return NULL; // has to be overridden - } - - function write_setting($data) { - return; // has to be overridden - } - - function output_html() { - return; // has to be overridden - } - -} - - -class admin_setting_configtext extends admin_setting { - - var $paramtype; - - function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype) { - $this->paramtype = $paramtype; - parent::admin_setting($name, $visiblename, $description, $defaultsetting); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); - } - - function write_setting($data) { - $data = clean_param($data, $this->paramtype); - return (set_config($this->name,$data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - return '' . $this->visiblename . '' . - '' . - ' ' . $this->description . ''; - } - -} - -class admin_setting_configcheckbox extends admin_setting { - - function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting) { - parent::admin_setting($name, $visiblename, $description, $defaultsetting); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); - } - - function write_setting($data) { - if ($data == '1') { - return (set_config($this->name,1) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } else { - return (set_config($this->name,0) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - } - - function output_html() { - return '' . $this->visiblename . '' . - 'get_setting() == true ? 'checked="checked"' : '') . ' />' . - ' ' . $this->description . ''; - } - -} - -class admin_setting_configselect extends admin_setting { - - var $choices; - - function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) { - $this->choices = $choices; - parent::admin_setting($name, $visiblename, $description, $defaultsetting); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); - } - - function write_setting($data) { - // check that what we got was in the original choices - // or that the data is the default setting - needed during install when choices can not be constructed yet - if ($data != $this->defaultsetting and ! in_array($data, array_keys($this->choices))) { - return 'Error setting ' . $this->visiblename . '
'; - } - - return (set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - $return = '' . $this->visiblename . ' ' . $this->description . ''; - return $return; - } - -} - -// this is a liiitle bit messy. we're using two selects, but we're returning them as an array named after $name (so we only use $name2 -// internally for the setting) -class admin_setting_configtime extends admin_setting { - - var $name2; - var $choices; - var $choices2; - var $defaultsetting2; - - function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) { - $this->name2 = $minutesname; - $this->choices = array(); - for ($i = 0; $i < 24; $i++) { - $this->choices[$i] = $i; - } - $this->choices2 = array(); - for ($i = 0; $i < 60; $i += 5) { - $this->choices2[$i] = $i; - } - parent::admin_setting($hoursname, $visiblename, $description, $defaultsetting); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) && isset($CFG->{$this->name2}) ? array($CFG->{$this->name}, $CFG->{$this->name2}) : NULL); - } - - function write_setting($data) { - // check that what we got was in the original choices - if (!(in_array($data['h'], array_keys($this->choices)) && in_array($data['m'], array_keys($this->choices2)))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - - return (set_config($this->name, $data['h']) && set_config($this->name2, $data['m']) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - $setvalue = $this->get_setting(); - if (!is_array($setvalue)) { - $setvalue = array(0,0); - } - $return = '' . $this->visiblename . '    ' . $this->description . ''; - return $return; - } - -} - -class admin_setting_configmultiselect extends admin_setting_configselect { - - function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) { - parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? explode(',', $CFG->{$this->name}) : NULL);; - } - - function write_setting($data) { - foreach ($data as $datum) { - if (! in_array($datum, array_keys($this->choices))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - } - - return (set_config($this->name, implode(',',$data)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - $currentsetting = $this->get_setting(); - if (!is_array($currentsetting)) { - $currentsetting = array(); - } - $return = '' . $this->visiblename . ' ' . $this->description . ''; - return $return; - } - -} - -class admin_setting_special_adminseesall extends admin_setting_configcheckbox { - - function admin_setting_special_adminseesall() { - $name = 'calendar_adminseesall'; - $visiblename = get_string('adminseesall', 'admin'); - $description = get_string('helpadminseesall', 'admin'); - parent::admin_setting($name, $visiblename, $description, 0); - } - - function write_setting($data) { - global $SESSION; - unset($SESSION->cal_courses_shown); - parent::write_setting($data); - } -} - -class admin_setting_sitesetselect extends admin_setting_configselect { - - var $id; - - function admin_setting_sitesetselect($name, $visiblename, $description, $defaultsetting, $choices) { - - $this->id = SITEID; - parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices); - - } - - function get_setting() { - $site = get_site(); - return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); - } - - function write_setting($data) { - if (!in_array($data, array_keys($this->choices))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - $record = new stdClass(); - $record->id = $this->id; - $temp = $this->name; - $record->$temp = $data; - $record->timemodified = time(); - return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - - -class admin_setting_special_frontpage extends admin_setting_configselect { - - function admin_setting_special_frontpage($loggedin = false) { - global $CFG; - require_once($CFG->dirroot . '/course/lib.php'); - $name = 'frontpage' . ($loggedin ? 'loggedin' : ''); - $visiblename = get_string('frontpage' . ($loggedin ? 'loggedin' : ''),'admin'); - $description = get_string('configfrontpage' . ($loggedin ? 'loggedin' : ''),'admin'); - $choices = array(FRONTPAGENEWS => get_string('frontpagenews'), - FRONTPAGECOURSELIST => get_string('frontpagecourselist'), - FRONTPAGECATEGORYNAMES => get_string('frontpagecategorynames'), - FRONTPAGECATEGORYCOMBO => get_string('frontpagecategorycombo'), - '' => get_string('none')); - if (count_records("course") > FRONTPAGECOURSELIMIT) { - unset($choices[FRONTPAGECOURSELIST]); - } - parent::admin_setting_configselect($name, $visiblename, $description, '', $choices); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? explode(',', $CFG->{$this->name}) : NULL); - } - - function write_setting($data) { - if (empty($data)) { - $data = array(); - } - foreach($data as $datum) { - if (! in_array($datum, array_keys($this->choices))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - } - return (set_config($this->name, implode(',', $data)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - - $currentsetting = $this->get_setting(); - if (!is_array($currentsetting)) { - $currentsetting = array(); - } - for ($i = 0; $i < count($this->choices) - 1; $i++) { - if (!isset($currentsetting[$i])) { - $currentsetting[$i] = 0; - } - } - $return = '' . $this->visiblename . ''; - for ($i = 0; $i < count($this->choices) - 1; $i++) { - $return .=''; - if ($i !== count($this->choices) - 2) { - $return .= '  ' . get_string('then') . '  '; - } - } - $return .= ' ' . $this->description . ''; - return $return; - - - } -} - -class admin_setting_sitesetcheckbox extends admin_setting_configcheckbox { - - var $id; - - function admin_setting_sitesetcheckbox($name, $visiblename, $description, $defaultsetting) { - - $this->id = SITEID; - parent::admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting); - - } - - function get_setting() { - $site = get_site(); - return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); - } - - function write_setting($data) { - $record = new stdClass(); - $record->id = $this->id; - $temp = $this->name; - $record->$temp = ($data == '1' ? 1 : 0); - $record->timemodified = time(); - return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - -class admin_setting_sitesettext extends admin_setting_configtext { - - var $id; - - function admin_setting_sitesettext($name, $visiblename, $description, $defaultsetting, $paramtype) { - - $this->id = SITEID; - parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype); - - } - - function get_setting() { - $site = get_site(); - return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); - } - - function write_setting($data) { - $record = new stdClass(); - $record->id = $this->id; - $temp = $this->name; - $record->$temp = $data; - $record->timemodified = time(); - return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - -class admin_setting_special_frontpagedesc extends admin_setting { - - var $id; - - function admin_setting_special_frontpagedesc() { - $this->id = SITEID; - $name = 'summary'; - $visiblename = get_string('frontpagedescription'); - $description = get_string('frontpagedescriptionhelp'); - parent::admin_setting($name, $visiblename, $description, ''); - } - - function output_html() { - - $usehtmleditor = can_use_html_editor(); - - $return = '' . $this->visiblename . '' . - ''; - - ob_start(); // double-check the number of columns below... might overrun some screen resolutions - print_textarea($usehtmleditor, 20, 40, 0, 0, 's_' . $this->name, $this->get_setting()); - - if ($usehtmleditor) { - use_html_editor(); - } - $return .= ob_get_contents(); - ob_end_clean(); - $return .= ' ' . $this->description . ''; - return $return; - - } - - function get_setting() { - - $site = get_site(); - return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); - - } - - function write_setting($data) { - - $data = addslashes(clean_param($data, PARAM_CLEANHTML)); - - $record = new stdClass(); - $record->id = $this->id; - $temp = $this->name; - $record->$temp = $data; - $record->timemodified = time(); - - return(update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - - } - -} - - -class admin_setting_special_editorfontlist extends admin_setting { - - var $items; - - function admin_setting_special_editorfontlist() { - global $CFG; - $name = 'editorfontlist'; - $visiblename = get_string('editorfontlist', 'admin'); - $description = get_string('configeditorfontlist', 'admin'); - if (isset($CFG->editorfontlist)) { - $items = explode(';', $CFG->editorfontlist); - $this->items = array(); - foreach ($items as $item) { - $item = explode(':', $item); - $this->items[$item[0]] = $item[1]; - } - } else { - $items = NULL; - } - unset($defaults); - $defaults = array('k0' => 'Trebuchet', - 'v0' => 'Trebuchet MS,Verdana,Arial,Helvetica,sans-serif', - 'k1' => 'Arial', - 'v1' => 'arial,helvetica,sans-serif', - 'k2' => 'Courier New', - 'v2' => 'courier new,courier,monospace', - 'k3' => 'Georgia', - 'v3' => 'georgia,times new roman,times,serif', - 'k4' => 'Tahoma', - 'v4' => 'tahoma,arial,helvetica,sans-serif', - 'k5' => 'Times New Roman', - 'v5' => 'times new roman,times,serif', - 'k6' => 'Verdana', - 'v6' => 'verdana,arial,helvetica,sans-serif', - 'k7' => 'Impact', - 'v7' => 'impact', - 'k8' => 'Wingdings', - 'v8' => 'wingdings'); - parent::admin_setting($name, $visiblename, $description, $defaults); - } - - function get_setting() { - return $this->items; - } - - function write_setting($data) { - - // there miiight be an easier way to do this :) - // if this is changed, make sure the $defaults array above is modified so that this - // function processes it correctly - - $keys = array(); - $values = array(); - - foreach ($data as $key => $value) { - if (substr($key,0,1) == 'k') { - $keys[substr($key,1)] = $value; - } elseif (substr($key,0,1) == 'v') { - $values[substr($key,1)] = $value; - } - } - - $result = ''; - for ($i = 0; $i < count($keys); $i++) { - if (($keys[$i] !== '') && ($values[$i] !== '')) { - $result .= clean_param($keys[$i],PARAM_NOTAGS) . ':' . clean_param($values[$i], PARAM_NOTAGS) . ';'; - } - } - - $result = substr($result, 0, -1); // trim the last semicolon - - return (set_config($this->name, $result) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - $return = '' . $this->visiblename . ''; - $count = 0; - $currentsetting = $this->items; - if (!is_array($currentsetting)) { - $currentsetting = NULL; - } - foreach ($currentsetting as $key => $value) { - $return .= ''; - $return .= '  '; - $return .= '
'; - $count++; - } - $return .= ''; - $return .= '  '; - $return .= '
'; - $return .= ''; - $return .= '  '; - $return .= ''; - $return .= ' ' . $this->description . ''; - return $return; - } - -} - -class admin_setting_special_editordictionary extends admin_setting_configselect { - - function admin_setting_special_editordictionary() { - $name = 'editordictionary'; - $visiblename = get_string('editordictionary','admin'); - $description = get_string('configeditordictionary', 'admin'); - $choices = $this->editor_get_dictionaries(); - if (! is_array($choices)) { - $choices = array(''); - } - - parent::admin_setting_configselect($name, $visiblename, $description, '', $choices); - } - - // function borrowed from the old moodle/admin/editor.php, slightly modified - function editor_get_dictionaries () { - /// Get all installed dictionaries in the system - - global $CFG; - -// error_reporting(E_ALL); // for debug, final version shouldn't have this... - clearstatcache(); - - // If aspellpath isn't set don't even bother ;-) - if (empty($CFG->aspellpath)) { - return 'Empty aspell path!'; - } - - // Do we have access to popen function? - if (!function_exists('popen')) { - return 'Popen function disabled!'; - } - - $cmd = $CFG->aspellpath; - $output = ''; - $dictionaries = array(); - $dicts = array(); - - if(!($handle = @popen(escapeshellarg($cmd) .' dump dicts', 'r'))) { - return 'Couldn\'t create handle!'; - } - - while(!feof($handle)) { - $output .= fread($handle, 1024); - } - @pclose($handle); - - $dictionaries = explode(chr(10), $output); - - // Get rid of possible empty values - if (is_array($dictionaries)) { - - $cnt = count($dictionaries); - - for ($i = 0; $i < $cnt; $i++) { - if (!empty($dictionaries[$i])) { - $dicts[] = $dictionaries[$i]; - } - } - } - - if (count($dicts) >= 1) { - return $dicts; - } - - return 'Error! Check your aspell installation!'; - } - - - -} - - -class admin_setting_special_editorhidebuttons extends admin_setting { - - var $name; - var $visiblename; - var $description; - var $items; - - function admin_setting_special_editorhidebuttons() { - $this->name = 'editorhidebuttons'; - $this->visiblename = get_string('editorhidebuttons', 'admin'); - $this->description = get_string('confeditorhidebuttons', 'admin'); - $this->defaultsetting = array(); - // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead - $this->items = array('fontname' => '', - 'fontsize' => '', - 'formatblock' => '', - 'bold' => 'ed_format_bold.gif', - 'italic' => 'ed_format_italic.gif', - 'underline' => 'ed_format_underline.gif', - 'strikethrough' => 'ed_format_strike.gif', - 'subscript' => 'ed_format_sub.gif', - 'superscript' => 'ed_format_sup.gif', - 'copy' => 'ed_copy.gif', - 'cut' => 'ed_cut.gif', - 'paste' => 'ed_paste.gif', - 'clean' => 'ed_wordclean.gif', - 'undo' => 'ed_undo.gif', - 'redo' => 'ed_redo.gif', - 'justifyleft' => 'ed_align_left.gif', - 'justifycenter' => 'ed_align_center.gif', - 'justifyright' => 'ed_align_right.gif', - 'justifyfull' => 'ed_align_justify.gif', - 'lefttoright' => 'ed_left_to_right.gif', - 'righttoleft' => 'ed_right_to_left.gif', - 'insertorderedlist' => 'ed_list_num.gif', - 'insertunorderedlist' => 'ed_list_bullet.gif', - 'outdent' => 'ed_indent_less.gif', - 'indent' => 'ed_indent_more.gif', - 'forecolor' => 'ed_color_fg.gif', - 'hilitecolor' => 'ed_color_bg.gif', - 'inserthorizontalrule' => 'ed_hr.gif', - 'createanchor' => 'ed_anchor.gif', - 'createlink' => 'ed_link.gif', - 'unlink' => 'ed_unlink.gif', - 'insertimage' => 'ed_image.gif', - 'inserttable' => 'insert_table.gif', - 'insertsmile' => 'em.icon.smile.gif', - 'insertchar' => 'icon_ins_char.gif', - 'spellcheck' => 'spell-check.gif', - 'htmlmode' => 'ed_html.gif', - 'popupeditor' => 'fullscreen_maximize.gif', - 'search_replace' => 'ed_replace.gif'); - } - - function get_setting() { - global $CFG; - return (isset($CFG->{$this->name}) ? explode(' ', $CFG->{$this->name}) : NULL); - } - - function write_setting($data) { - $result = array(); - if (empty($data)) { $data = array(); } - foreach ($data as $key => $value) { - if (!in_array($key, array_keys($this->items))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - if ($value == '1') { - $result[] = $key; - } - } - return (set_config($this->name, implode(' ',$result)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - - global $CFG; - - // checkboxes with input name="$this->name[$key]" value="1" - // we do 15 fields per column - - $currentsetting = $this->get_setting(); - if (!is_array($currentsetting)) { - $currentsetting = array(); - } - - $return = '' . $this->visiblename . ''; - - $return .= ''; - $return .= '
'; - - $count = 0; - - foreach($this->items as $key => $value) { - if ($count % 15 == 0) { - $return .= ''; - } - - $return .= ($value == '' ? get_string($key,'editor') : '' . get_string($key,'editor') . '') . ' '; - $return .= '       '; - $count++; - if ($count % 15 != 0) { - $return .= '

'; - } - } - - $return .= '
'; - $return .= ' ' . $this->description . ''; - - return $return; - } - -} - -class admin_setting_backupselect extends admin_setting_configselect { - - function admin_setting_backupselect($name, $visiblename, $description, $default, $choices) { - parent::admin_setting_configselect($name, $visiblename, $description, $default, $choices); - } - - function get_setting() { - $backup_config = backup_get_config(); - return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); - } - - function write_setting($data) { - // check that what we got was in the original choices - if (! in_array($data, array_keys($this->choices))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - - return (backup_set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - -class admin_setting_special_backupsaveto extends admin_setting_configtext { - - function admin_setting_special_backupsaveto() { - $name = 'backup_sche_destination'; - $visiblename = get_string('saveto'); - $description = get_string('backupsavetohelp'); - parent::admin_setting_configtext($name, $visiblename, $description, '', PARAM_PATH); - } - - function get_setting() { - $backup_config = backup_get_config(); - return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); - } - - function write_setting($data) { - $data = clean_param($data, PARAM_PATH); - if (!empty($data) and (substr($data,-1) == '/' or substr($data,-1) == '\\')) { - return get_string('pathslasherror') . '
'; - } else if (!empty($data) and !is_dir($data)) { - return get_string('pathnotexists') . '
'; - } - return (backup_set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - -class admin_setting_backupcheckbox extends admin_setting_configcheckbox { - - function admin_setting_backupcheckbox($name, $visiblename, $description, $default) { - parent::admin_setting_configcheckbox($name, $visiblename, $description, $default); - } - - function write_setting($data) { - if ($data == '1') { - return (backup_set_config($this->name, 1) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } else { - return (backup_set_config($this->name, 0) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - } - - function get_setting() { - $backup_config = backup_get_config(); - return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); - } - -} - -class admin_setting_special_backuptime extends admin_setting_configtime { - - function admin_setting_special_backuptime() { - $name = 'backup_sche_hour'; - $name2 = 'backup_sche_minute'; - $visiblename = get_string('executeat'); - $description = get_string('backupexecuteathelp'); - $default = array('h' => 0, 'm' => 0); - parent::admin_setting_configtime($name, $name2, $visiblename, $description, $default); - } - - function get_setting() { - $backup_config = backup_get_config(); - return (isset($backup_config->{$this->name}) && isset($backup_config->{$this->name}) ? array($backup_config->{$this->name}, $backup_config->{$this->name2}) : NULL); - } - - function write_setting($data) { - // check that what we got was in the original choices - if (!(in_array($data['h'], array_keys($this->choices)) && in_array($data['m'], array_keys($this->choices2)))) { - return get_string('errorsetting', 'admin') . $this->visiblename . '
'; - } - - return (backup_set_config($this->name, $data['h']) && backup_set_config($this->name2, $data['m']) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - -} - -class admin_setting_special_backupdays extends admin_setting { - - function admin_setting_special_backupdays() { - $name = 'backup_sche_weekdays'; - $visiblename = get_string('schedule'); - $description = get_string('backupschedulehelp'); - parent::admin_setting($name, $visiblename, $description, array()); - } - - function get_setting() { - $backup_config = backup_get_config(); - return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); - } - - function output_html() { - - $currentsetting = $this->get_setting(); - if ($currentsetting === NULL) { - $currentsetting = '0000000'; - } - - return '' . $this->visiblename . '' . - '' . - '' . - '' . - '' . - '' . - '' . - '' . - '' . - '
  ' . get_string('sunday', 'calendar') . '  
  ' . - get_string('monday', 'calendar') . '  
  ' . get_string('tuesday', 'calendar') . '  
  ' . - get_string('wednesday', 'calendar') . '  
  ' . get_string('thursday', 'calendar') . '  
  ' . - get_string('friday', 'calendar') . '  
  ' . get_string('saturday', 'calendar') . '  
' . - ' ' . $this->description . ''; - - } - - // we're using the array trick (see http://ca.php.net/manual/en/faq.html.php#faq.html.arrays) to get the data passed to use without having to modify - // admin_settingpage (note that admin_settingpage only calls write_setting with the data that matches $this->name... so if we have multiple form fields, - // they MUST go into an array named $this->name, or else we won't receive them here - function write_setting($data) { - $week = 'umtwrfs'; - $result = array(0 => 0, 1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0, 6 => 0); - foreach($data as $key => $value) { - if ($value == '1') { - $result[strpos($week, $key)] = 1; - } - } - return (backup_set_config($this->name, implode('',$result)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } -} - -class admin_setting_special_debug extends admin_setting_configcheckbox { - - function admin_setting_special_debug() { - $name = 'debug'; - $visiblename = get_string('debug', 'admin'); - $description = get_string('configdebug', 'admin'); - parent::admin_setting_configcheckbox($name, $visiblename, $description, ''); - } - - function write_setting($data) { - if ($data == '1') { - return (set_config($this->name,15) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } else { - return (set_config($this->name,7) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - } - - function output_html() { - return '' . $this->visiblename . '' . - 'get_setting() == 15 ? 'checked="checked"' : '') . ' />' . - ' ' . $this->description . ''; - } - -} - - -class admin_setting_special_calendar_weekend extends admin_setting { - - function admin_setting_special_calendar_weekend() { - $name = 'calendar_weekend'; - $visiblename = get_string('calendar_weekend', 'admin'); - $description = get_string('helpweekenddays', 'admin'); - parent::admin_setting($name, $visiblename, $description, array('u' => 1, 's' => 1)); - } - - function get_setting() { - global $CFG; - if (isset($CFG->{$this->name})) { - $setting = intval($CFG->{$this->name}); - return array('u' => $setting & 1, 'm' => $setting & 2, 't' => $setting & 4, 'w' => $setting & 8, 'r' => $setting & 16, 'f' => $setting & 32, 's' => $setting & 64); - } else { - return NULL; - } - } - - function write_setting($data) { - $week = 'umtwrfs'; - $result = array(0 => 0, 1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0, 6 => 0); - foreach($data as $key => $value) { - if ($value == '1') { - $result[strpos($week, $key)] = 1; - } - } - return (set_config($this->name, bindec(implode('',$result))) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - - function output_html() { - - $currentsetting = $this->get_setting(); - if (!is_array($currentsetting)) { - $currentsetting = array('u' => 0, 'm' => 0, 't' => 0, 'w' => 0, 'r' => 0, 'f' => 0, 's' => 0); - } - return '' . $this->visiblename . '' . - '' . - '' . - '' . - '' . - '' . - '' . - '' . - '' . - '
  ' . get_string('sunday', 'calendar') . '  
  ' . - get_string('monday', 'calendar') . '  
  ' . get_string('tuesday', 'calendar') . '  
  ' . - get_string('wednesday', 'calendar') . '  
  ' . get_string('thursday', 'calendar') . '  
  ' . - get_string('friday', 'calendar') . '  
  ' . get_string('saturday', 'calendar') . '  
' . - ' ' . $this->description . ''; - - } - -} - - -class admin_setting_special_perfdebug extends admin_setting_configcheckbox { - - function admin_setting_special_perfdebug() { - $name = 'perfdebug'; - $visiblename = get_string('perfdebug', 'admin'); - $description = get_string('configperfdebug', 'admin'); - parent::admin_setting_configcheckbox($name, $visiblename, $description, ''); - } - - function write_setting($data) { - if ($data == '1') { - return (set_config($this->name,15) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } else { - return (set_config($this->name,7) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); - } - } - - function output_html() { - return '' . $this->visiblename . '' . - 'get_setting() == 15 ? 'checked="checked"' : '') . ' />' . - ' ' . $this->description . ''; - } - -} - -// Code for a function that helps externalpages print proper headers and footers -// N.B.: THIS FUNCTION HANDLES AUTHENTICATION -function admin_externalpage_setup($section) { - - global $CFG, $ADMIN, $PAGE, $USER; - - require_once($CFG->libdir . '/blocklib.php'); - require_once($CFG->dirroot . '/' . $CFG->admin . '/pagelib.php'); - - define('TEMPORARY_ADMIN_PAGE_ID',26); - - define('BLOCK_L_MIN_WIDTH',160); - define('BLOCK_L_MAX_WIDTH',210); - - $pagetype = PAGE_ADMIN; - $pageclass = 'page_admin'; - page_map_class($pagetype, $pageclass); - - $PAGE = page_create_object($pagetype,TEMPORARY_ADMIN_PAGE_ID); - - $PAGE->init_full($section); - - $root = $ADMIN->locate($PAGE->section); - - if ($site = get_site()) { - require_login(); - } else { - redirect($CFG->wwwroot . '/admin/index.php'); - die; - } - - if (!is_a($root, 'admin_externalpage')) { - error(get_string('sectionerror','admin')); - die; - } - - // this eliminates our need to authenticate on the actual pages - if (!($root->check_access())) { - error(get_string('accessdenied', 'admin')); - die; - } - - $adminediting = optional_param('adminedit', -1, PARAM_BOOL); - - if (!isset($USER->adminediting)) { - $USER->adminediting = false; - } - - if ($PAGE->user_allowed_editing()) { - if ($adminediting == 1) { - $USER->adminediting = true; - } elseif ($adminediting == 0) { - $USER->adminediting = false; - } - } - -} - -function admin_externalpage_print_header() { - - global $CFG, $ADMIN, $PAGE; - - $pageblocks = blocks_setup($PAGE); - - $preferred_width_left = bounded_number(BLOCK_L_MIN_WIDTH, blocks_preferred_width($pageblocks[BLOCK_POS_LEFT]), BLOCK_L_MAX_WIDTH); - - $PAGE->print_header(); - echo ''; - echo ''; - echo '
'; - blocks_print_group($PAGE, $pageblocks, BLOCK_POS_LEFT); - echo ''; - -} - -function admin_externalpage_print_footer() { - - echo '
'; - print_footer(); - -} - -// n.b. this function unconditionally applies default settings -function apply_default_settings(&$node) { - - global $CFG; - - if (is_a($node, 'admin_category')) { - $entries = array_keys($node->children); - foreach ($entries as $entry) { - apply_default_settings($node->children[$entry]); - } - return; - } - - if (is_a($node, 'admin_settingpage')) { - foreach ($node->settings as $setting) { - $CFG->{$setting->name} = $setting->defaultsetting; - $setting->write_setting($setting->defaultsetting); - unset($setting); // needed to prevent odd (imho) reference behaviour - // see http://www.php.net/manual/en/language.references.whatdo.php#AEN6399 - } - return; - } - - return; - -} - -// n.b. this function unconditionally applies default settings -function apply_default_exception_settings($defaults) { - - global $CFG; - - foreach($defaults as $key => $value) { - $CFG->$key = $value; - set_config($key, $value); - } - -} - - -// Code to build admin-tree ---------------------------------------------------------------------------- - -// hrm... gotta put this somewhere more systematic -$site = get_site(); - -// start the admin tree! -$ADMIN = new admin_category('root','Administration'); - -// we process this file first to get categories up and running -include_once($CFG->dirroot . '/admin/settings/first.php'); - -// now we process all other files in admin/settings to build the -// admin tree -foreach (glob($CFG->dirroot . '/admin/settings/*.php') as $file) { - if ($file != $CFG->dirroot . '/admin/settings/first.php') { - include_once($file); - } -} - -?> \ No newline at end of file diff --git a/admin/auth.php b/admin/auth.php index 9362c7bae4..42a757323b 100644 --- a/admin/auth.php +++ b/admin/auth.php @@ -3,9 +3,10 @@ require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); - admin_externalpage_setup('userauthentication'); + $adminroot = admin_get_root(); + admin_externalpage_setup('userauthentication', $adminroot); $auth = optional_param('auth', '', PARAM_SAFEDIR); @@ -121,7 +122,7 @@ $strsettings = get_string("settings"); $strusers = get_string("users"); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); echo "
"; echo "
framename}\" name=\"authmenu\" method=\"post\" action=\"auth.php\">"; @@ -231,7 +232,7 @@ print_simple_box_end(); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; /// Functions ///////////////////////////////////////////////////////////////// diff --git a/admin/block.php b/admin/block.php index 8ea52e0834..e5566494a2 100644 --- a/admin/block.php +++ b/admin/block.php @@ -3,8 +3,9 @@ // block.php - allows admin to edit all local configuration variables for a block require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('blockmanagement'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('blockmanagement', $adminroot); require_once($CFG->libdir.'/blocklib.php'); $blockid = required_param('block', PARAM_INT); @@ -56,7 +57,7 @@ $CFG->pagepath = 'block/' . $block->name() . '/config'; - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strblockname); @@ -71,6 +72,6 @@ echo '

'; $block->config_print(); echo '
'; - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/blocks.php b/admin/blocks.php index f6e4ebfb3b..553c09dfbe 100644 --- a/admin/blocks.php +++ b/admin/blocks.php @@ -3,8 +3,9 @@ // Allows the admin to configure blocks (hide/show, delete and configure) require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('blockmanagement'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('blockmanagement', $adminroot); require_once($CFG->libdir.'/blocklib.php'); require_once($CFG->libdir.'/tablelib.php'); @@ -29,7 +30,7 @@ $strname = get_string('name'); $strmultiple = get_string('blockmultiple', 'admin'); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strmanageblocks); @@ -75,7 +76,7 @@ notice_yesno(get_string('blockdeleteconfirm', '', $strblockname), 'blocks.php?delete='.$block->id.'&confirm=1&sesskey='.$USER->sesskey, 'blocks.php'); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; } else { @@ -231,6 +232,6 @@ $table->print_html(); } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/cron.php b/admin/cron.php index 59fdca826e..222c1d0a58 100644 --- a/admin/cron.php +++ b/admin/cron.php @@ -27,7 +27,7 @@ } require_once(dirname(__FILE__) . '/../config.php'); - require_once($CFG->dirroot.'/lib/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); if (!$alreadyadmin = has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM, SITEID))) { unset($_SESSION['USER']); diff --git a/admin/enrol.php b/admin/enrol.php index 1661bb7281..9e1da25dca 100644 --- a/admin/enrol.php +++ b/admin/enrol.php @@ -3,12 +3,13 @@ // Yes, enrol is correct English spelling. require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); $enrol = optional_param('enrol', $CFG->enrol, PARAM_SAFEDIR); $CFG->pagepath = 'enrol'; - admin_externalpage_setup('enrolment'); + $adminroot = admin_get_root(); + admin_externalpage_setup('enrolment', $adminroot); @@ -40,7 +41,7 @@ $str = get_strings(array('enrolmentplugins', 'users', 'administration', 'settings', 'edit')); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); $modules = get_list_of_plugins("enrol"); $options = array(); @@ -98,6 +99,6 @@ echo "
\n"; echo ""; - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> \ No newline at end of file diff --git a/admin/enrol_config.php b/admin/enrol_config.php index 1bbc993910..aafd31a66d 100644 --- a/admin/enrol_config.php +++ b/admin/enrol_config.php @@ -3,9 +3,10 @@ // Yes, enrol is correct English spelling. require_once("../config.php"); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); - admin_externalpage_setup('enrolment'); + $adminroot = admin_get_root(); + admin_externalpage_setup('enrolment', $adminroot); $enrol = required_param('enrol', PARAM_ALPHA); $CFG->pagepath = 'enrol/' . $enrol; @@ -41,7 +42,7 @@ } asort($options); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); echo "
framename}\" name=\"enrolmenu\" method=\"post\" action=\"enrol_config.php\">"; echo "sesskey."\">"; @@ -72,7 +73,7 @@ print_simple_box_end(); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; ?> diff --git a/admin/environment.php b/admin/environment.php index 175ca0f3fe..95f4c1ed15 100644 --- a/admin/environment.php +++ b/admin/environment.php @@ -30,11 +30,12 @@ // from moodle.org be able to check more and more versions. require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); require_once($CFG->libdir.'/environmentlib.php'); require_once($CFG->libdir.'/componentlib.class.php'); - admin_externalpage_setup('environment'); + $adminroot = admin_get_root(); + admin_externalpage_setup('environment', $adminroot); /// Parameters $action = optional_param('action', '', PARAM_ACTION); @@ -52,7 +53,7 @@ $strmisc = get_string('miscellaneous'); /// Print the header stuff - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); /// Print the component download link echo '
'.$strupdate.'
'; @@ -137,5 +138,5 @@ echo ''; /// Print footer - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/filter.php b/admin/filter.php index 56b7d1cb8b..e136a52040 100644 --- a/admin/filter.php +++ b/admin/filter.php @@ -3,10 +3,11 @@ // Edit text filter settings require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); require_once($CFG->libdir.'/tablelib.php'); - admin_externalpage_setup('filtermanagement'); + $adminroot = admin_get_root(); + admin_externalpage_setup('filtermanagement', $adminroot); // get parameters $param = new Object; @@ -70,7 +71,7 @@ //============================== $filtername = ucfirst($filtername); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading( $filtername ); print_simple_box("
".get_string("configwarning", "admin")."
", "center", "50%"); @@ -95,5 +96,5 @@ print_simple_box_end(); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/filters.php b/admin/filters.php index 5490e84d17..9646db530a 100644 --- a/admin/filters.php +++ b/admin/filters.php @@ -3,13 +3,14 @@ // Edit list of available text filters require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); require_once($CFG->libdir.'/tablelib.php'); // defines define('FILTER_TABLE','filter_administration_table'); - admin_externalpage_setup('filtermanagement'); + $adminroot = admin_get_root(); + admin_externalpage_setup('filtermanagement', $adminroot); // get values from page $params = new object(); @@ -267,7 +268,7 @@ // Display logic //============================== - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading_with_help($txt->managefilters, 'filters'); @@ -276,6 +277,6 @@ // cache control table has been removed - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/index.php b/admin/index.php index 87ed57434d..45d619bf9b 100644 --- a/admin/index.php +++ b/admin/index.php @@ -22,8 +22,8 @@ require_once('../config.php'); - include_once($CFG->dirroot.'/lib/adminlib.php'); // Contains various admin-only functions - include_once($CFG->dirroot.'/lib/ddllib.php'); // Install/upgrade related db functions + require_once($CFG->libdir.'/adminlib.php'); // Contains various admin-only functions + require_once($CFG->libdir.'/ddllib.php'); // Install/upgrade related db functions $id = optional_param('id', '', PARAM_ALPHANUM); $confirmupgrade = optional_param('confirmupgrade', 0, PARAM_BOOL); @@ -152,11 +152,11 @@ // Write default settings unconditionally (i.e. even if a setting is already set, overwrite it) // (this should only have any effect during initial install). - require_once($CFG->dirroot . '/admin/adminlib.php'); - apply_default_settings($ADMIN); + $adminroot = admin_get_root(); + apply_default_settings($adminroot); /// This is used to handle any settings that must exist in $CFG but which do not exist in - /// $ADMIN as admin_setting objects (there are some exceptions). + /// admin_get_root()/$ADMIN as admin_setting objects (there are some exceptions). apply_default_exception_settings(array('alternateloginurl' => '', 'auth' => 'email', 'auth_pop3mailbox' => 'INBOX', @@ -373,9 +373,10 @@ /// Print default admin page with notifications. - require_once($CFG->dirroot . '/' . $CFG->admin . '/adminlib.php'); - admin_externalpage_setup('adminnotifications'); - admin_externalpage_print_header(); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('adminnotifications', $adminroot); + admin_externalpage_print_header($adminroot); /// Deprecated database! Warning!! if (!empty($CFG->migrated_to_new_db)) { @@ -569,7 +570,7 @@ } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); diff --git a/admin/lang.php b/admin/lang.php index cc418e2e6d..a8534b3e70 100644 --- a/admin/lang.php +++ b/admin/lang.php @@ -33,8 +33,9 @@ */ require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('langedit'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('langedit', $adminroot); define('LANG_SUBMIT_REPEAT', 1); // repeat displaying submit button? define('LANG_SUBMIT_REPEAT_EVERY', 20); // if so, after how many lines? @@ -110,7 +111,7 @@ } - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); if (!$mode) { print_simple_box_start('center','80%'); @@ -128,7 +129,7 @@ print_heading("$stredithelpdocs"); echo ''; print_simple_box_end(); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; } @@ -499,7 +500,7 @@ } } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ////////////////////////////////////////////////////////////////////// diff --git a/admin/langdoc.php b/admin/langdoc.php index 920a73534b..7f0821b062 100755 --- a/admin/langdoc.php +++ b/admin/langdoc.php @@ -10,8 +10,9 @@ * for intensive testing of this my first contribution */ require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('langedit'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('langedit', $adminroot); // // Some local configuration @@ -33,7 +34,7 @@ $strthislanguage = get_string("thislanguage"); $stredithelpdocs = get_string('edithelpdocs', 'admin'); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); $currentlang = current_language(); $langdir = "$CFG->dataroot/lang/$currentlang"; @@ -195,7 +196,7 @@ $langdir/$currentfile")."

"; error_reporting($CFG->debug); } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ////////////////////////////////////////////////////////////////////// diff --git a/admin/langimport.php b/admin/langimport.php index b019a6072b..5cb623f776 100755 --- a/admin/langimport.php +++ b/admin/langimport.php @@ -5,8 +5,9 @@ ///This helps to avoid confusion. require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('langimport'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('langimport', $adminroot); $mode = optional_param('mode', 0, PARAM_INT); //phase $pack = optional_param('pack', '', PARAM_FILE); //pack to install @@ -28,7 +29,7 @@ $strthislanguage = get_string("thislanguage"); $title = $strlang; - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); switch ($mode){ @@ -343,7 +344,7 @@ } //close of main switch - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); /* returns a list of available language packs from a * local copy shipped with standard moodle distro diff --git a/admin/maintenance.php b/admin/maintenance.php index da8e96764f..9b4f2d9bb7 100644 --- a/admin/maintenance.php +++ b/admin/maintenance.php @@ -2,11 +2,12 @@ // Enables/disables maintenance mode require('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); $action = optional_param('action', '', PARAM_ALPHA); - admin_externalpage_setup('maintenancemode'); + $adminroot = admin_get_root(); + admin_externalpage_setup('maintenancemode', $adminroot); //Check folder exists if (! make_upload_directory(SITEID)) { // Site folder @@ -31,7 +32,7 @@ /// Print the header stuff - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); /// Print the appropriate form @@ -63,5 +64,5 @@ } } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/module.php b/admin/module.php index b2e60b37c1..ce9f4cc8a3 100644 --- a/admin/module.php +++ b/admin/module.php @@ -2,8 +2,9 @@ // module.php - allows admin to edit all local configuration variables for a module require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('modulemanagement'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('modulemanagement', $adminroot); /// If data submitted, then process and store. @@ -53,7 +54,7 @@ // of the page. It is also used to generate the link to the Moodle Docs for this view. $CFG->pagepath = 'mod/' . $module . '/config'; - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strmodulename); @@ -64,6 +65,6 @@ include("$CFG->dirroot/mod/$module/config.html"); print_simple_box_end(); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/modules.php b/admin/modules.php index 3070028d42..623d66db97 100644 --- a/admin/modules.php +++ b/admin/modules.php @@ -2,8 +2,9 @@ // Allows the admin to manage activity modules require_once('../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('modulemanagement'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('modulemanagement', $adminroot); require_once('../course/lib.php'); $show = optional_param('show', '', PARAM_SAFEDIR); @@ -29,7 +30,7 @@ // "$stradministration -> ". // "$strconfiguration -> $strmanagemodules"); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strmanagemodules); @@ -66,7 +67,7 @@ notice_yesno(get_string("moduledeleteconfirm", "", $strmodulename), "modules.php?delete=$delete&confirm=1&sesskey=$USER->sesskey", "modules.php"); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; } else { // Delete everything!! @@ -195,6 +196,6 @@ echo "

"; - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/pagelib.php b/admin/pagelib.php index a1adcbb9f1..3fd7ba55d9 100644 --- a/admin/pagelib.php +++ b/admin/pagelib.php @@ -13,12 +13,14 @@ class page_admin extends page_base { var $visiblepathtosection; function init_full($section) { - global $CFG, $ADMIN; + global $CFG; if($this->full_init_done) { return; } + $adminroot = admin_get_root(); + // fetch the path parameter $this->section = $section; @@ -26,9 +28,9 @@ class page_admin extends page_base { // this part is (potentially) processor-intensive... there's gotta be a better way // of handling this - if ($this->pathtosection = $ADMIN->path($this->section)) { + if ($this->pathtosection = $adminroot->path($this->section)) { foreach($this->pathtosection as $element) { - if ($pointer = $ADMIN->locate($element)) { + if ($pointer = $adminroot->locate($element)) { array_push($this->visiblepathtosection, $pointer->visiblename); } } @@ -55,8 +57,11 @@ class page_admin extends page_base { } function url_get_path() { - global $ADMIN, $CFG; - $root = $ADMIN->locate($this->section); + global $CFG; + + $adminroot = admin_get_root(); + + $root = $adminroot->locate($this->section); if (is_a($root, 'admin_externalpage')) { return $root->url; } else { diff --git a/admin/roles/manage.php b/admin/roles/manage.php index 62c13102da..689940f57a 100755 --- a/admin/roles/manage.php +++ b/admin/roles/manage.php @@ -3,8 +3,9 @@ //testing require_once('../../config.php'); - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('manageroles'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('manageroles', $adminroot); // require_login(); $roleid = optional_param('roleid', 0, PARAM_INT); // if set, we are editing a role @@ -26,7 +27,7 @@ $editingstr =''; } - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); // print_header("$site->shortname: $strmanageroles", // "$site->fullname", // "$stradministration -> $strmanageroles @@ -126,7 +127,7 @@ echo (''); echo ('are you sure?'); echo (''); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); // print_footer($course); exit; @@ -204,6 +205,6 @@ } use_html_editor("description"); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); // print_footer($course); ?> diff --git a/admin/settings.php b/admin/settings.php index 074aef206c..77bc65afff 100644 --- a/admin/settings.php +++ b/admin/settings.php @@ -1,9 +1,9 @@ dirroot . '/' . $CFG->admin . '/adminlib.php'); +require_once($CFG->libdir.'/adminlib.php'); require_once($CFG->libdir . '/blocklib.php'); -require_once($CFG->dirroot . '/' . $CFG->admin . '/pagelib.php'); +require_once($CFG->dirroot . '/admin/pagelib.php'); if ($site = get_site()) { require_login(); @@ -38,9 +38,9 @@ if ($PAGE->user_allowed_editing()) { } } -unset($root); +$adminroot = admin_get_root(); -$root = $ADMIN->locate($PAGE->section); +$root = $adminroot->locate($PAGE->section); if (!is_a($root, 'admin_settingpage')) { error(get_string('sectionerror', 'admin')); diff --git a/admin/settings/first.php b/admin/settings/first.php index de2b03c57e..af89c830f2 100644 --- a/admin/settings/first.php +++ b/admin/settings/first.php @@ -20,7 +20,7 @@ $ADMIN->add('plugins', new admin_externalpage('filtermanagement', get_string('fi $ADMIN->add('plugins', new admin_externalpage('blockmanagement', get_string('blockmanagement', 'admin'), $CFG->wwwroot . '/admin/blocks.php')); $ADMIN->add('plugins', new admin_externalpage('modulemanagement', get_string('modulemanagement', 'admin'), $CFG->wwwroot . '/admin/modules.php')); -if (file_exists($CFG->dirroot . '/' . $CFG->admin . '/mysql/frame.php')) { +if (file_exists($CFG->dirroot . '/admin/mysql/frame.php')) { $ADMIN->add('root', new admin_externalpage('database', get_string('managedatabase'), $CFG->wwwroot . '/' . $CFG->admin . '/mysql/frame.php')); } diff --git a/admin/timezoneimport.php b/admin/timezoneimport.php index 308c0fab79..5f8ff9e020 100644 --- a/admin/timezoneimport.php +++ b/admin/timezoneimport.php @@ -7,7 +7,8 @@ require_once($CFG->libdir.'/filelib.php'); require_once($CFG->libdir.'/olson.php'); - admin_externalpage_setup('timezoneimport'); + $adminroot = admin_get_root(); + admin_externalpage_setup('timezoneimport', $adminroot); $ok = optional_param('ok', 0, PARAM_BOOL); @@ -19,7 +20,7 @@ $strcalendarsettings = get_string('calendarsettings', 'admin'); $strimporttimezones = get_string('importtimezones', 'admin'); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strimporttimezones); @@ -35,7 +36,7 @@ notice_yesno($message, 'timezoneimport.php?ok=1&sesskey='.sesskey(), 'index.php'); - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; } @@ -125,6 +126,6 @@ print_continue('index.php'); } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> diff --git a/admin/upgradesettings.php b/admin/upgradesettings.php index 2c4577ba4c..3638c3f326 100644 --- a/admin/upgradesettings.php +++ b/admin/upgradesettings.php @@ -4,15 +4,17 @@ // modify them, and then processes modifications require_once('../config.php'); -require_once($CFG->dirroot . '/' . $CFG->admin . '/adminlib.php'); +require_once($CFG->libdir.'/adminlib.php'); -admin_externalpage_setup('adminnotifications'); // we pretend to be the adminnotifications page... don't wanna show up in the menu :) + $adminroot = admin_get_root(); +admin_externalpage_setup('adminnotifications', $adminroot); // we pretend to be the adminnotifications page... don't wanna show up in the menu :) // a caveat: we're depending on only having one admin access this page at once. why? the following line // (the function call to find_new_settings) must have the EXACT SAME RETURN VALUE both times that this // page is loaded (i.e. both when we're displaying the form and then when we process the form's input). // if the return values don't match, we could potentially lose changes that the admin is making. -$newsettings = find_new_settings($ADMIN); + +$newsettings = find_new_settings(admin_get_root()); // first we deal with the case where there are no new settings to be set if (count($newsettings) === 0) { @@ -50,7 +52,7 @@ if ($data = data_submitted()) { // and finally, if we get here, then there are new settings and we have to print a form // to modify them -admin_externalpage_print_header(); +admin_externalpage_print_header($adminroot); echo ''; @@ -67,7 +69,7 @@ echo '
'; print_simple_box_end(); echo '
'; -admin_externalpage_print_footer(); +admin_externalpage_print_footer($adminroot); diff --git a/backup/lib.php b/backup/lib.php index 95c768c25c..f5f36627a8 100644 --- a/backup/lib.php +++ b/backup/lib.php @@ -319,7 +319,7 @@ /// This function upgrades the backup tables, if necessary /// It's called from admin/index.php, also backup.php and restore.php - global $CFG, $db, $ADMIN; + global $CFG, $db; require_once ("$CFG->dirroot/backup/version.php"); // Get code versions @@ -346,8 +346,8 @@ if ($status) { if (set_config("backup_version", $backup_version) and set_config("backup_release", $backup_release)) { //initialize default backup settings now - require_once($CFG->dirroot . '/admin/adminlib.php'); - apply_default_settings($ADMIN->locate('backups')); + $adminroot = admin_get_root(); + apply_default_settings($adminroot->locate('backups')); notify(get_string("databasesuccess"), "green"); notify(get_string("databaseupgradebackups", "", $backup_version), "green"); print_continue($continueto); diff --git a/blocks/admin/block_admin.php b/blocks/admin/block_admin.php index 1101cbc800..d922617042 100644 --- a/blocks/admin/block_admin.php +++ b/blocks/admin/block_admin.php @@ -70,7 +70,7 @@ class block_admin extends block_list { $this->content->items[] = ''.get_string('sitefiles').''; $this->content->icons[] = ''; - if (file_exists($CFG->dirroot.'/'.$CFG->admin.'/'.$CFG->dbtype)) { + if (file_exists($CFG->dirroot.'/admin/'.$CFG->dbtype)) { $this->content->items[] = ''.get_string('managedatabase').''; $this->content->icons[] = ''; } diff --git a/blocks/admin_2/block_admin_2.php b/blocks/admin_2/block_admin_2.php index 523ab9d347..bb1ed89200 100644 --- a/blocks/admin_2/block_admin_2.php +++ b/blocks/admin_2/block_admin_2.php @@ -89,31 +89,29 @@ class block_admin_2 extends block_base { global $CFG, $ADMIN; - // better place to require this? - if (!$ADMIN) { - require_once($CFG->dirroot . '/admin/adminlib.php'); - } + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); if ($this->content !== NULL) { return $this->content; } - if ($this->pathtosection = $ADMIN->path($this->section)) { + if ($this->pathtosection = $adminroot->path($this->section)) { $this->pathtosection = array_reverse($this->pathtosection); array_pop($this->pathtosection); } - // we need to do this instead of $this->build_tree($ADMIN) because the top-level folder + // we need to do this instead of $this->build_tree($adminroot) because the top-level folder // is redundant (and ideally ignored). (the top-level folder is "administration".) unset($entries); - $entries = array_keys($ADMIN->children); + $entries = array_keys($adminroot->children); asort($entries); foreach ($entries as $entry) { - $this->build_tree($ADMIN->children[$entry]); + $this->build_tree($adminroot->children[$entry]); } if ($this->tempcontent !== '') { diff --git a/blocks/admin_bookmarks/block_admin_bookmarks.php b/blocks/admin_bookmarks/block_admin_bookmarks.php index e6f273b1d2..fa7ae9cabe 100644 --- a/blocks/admin_bookmarks/block_admin_bookmarks.php +++ b/blocks/admin_bookmarks/block_admin_bookmarks.php @@ -21,11 +21,10 @@ class block_admin_bookmarks extends block_base { function get_content() { - global $CFG, $USER, $ADMIN, $PAGE; + global $CFG, $USER, $PAGE; - if (!$ADMIN) { - require_once($CFG->dirroot . '/admin/adminlib.php'); - } + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); if ($this->content !== NULL) { return $this->content; @@ -36,9 +35,9 @@ class block_admin_bookmarks extends block_base { if (isset($USER->preference['admin_bookmarks'])) { $bookmarks = explode(',',$USER->preference['admin_bookmarks']); // hmm... just a liiitle (potentially) processor-intensive - // (recall that $ADMIN->locate is a huge recursive call... and we're calling it repeatedly here + // (recall that $adminroot->locate is a huge recursive call... and we're calling it repeatedly here foreach($bookmarks as $bookmark) { - $temp = $ADMIN->locate($bookmark); + $temp = $adminroot->locate($bookmark); if (is_a($temp, 'admin_settingpage')) { $this->content->text .= '' . $temp->visiblename . '' . '
'; } elseif (is_a($temp, 'admin_externalpage')) { diff --git a/blocks/admin_bookmarks/create.php b/blocks/admin_bookmarks/create.php index d66c81e48e..c47ef8ab08 100644 --- a/blocks/admin_bookmarks/create.php +++ b/blocks/admin_bookmarks/create.php @@ -2,7 +2,8 @@ require('../../config.php'); -require_once($CFG->dirroot . '/' . $CFG->admin . '/adminlib.php'); +require_once($CFG->libdir.'/adminlib.php'); +$adminroot = admin_get_root(); if ($section = optional_param('section', '', PARAM_ALPHAEXT)) { @@ -18,7 +19,7 @@ if ($section = optional_param('section', '', PARAM_ALPHAEXT)) { $bookmarks = array(); } - $temp = $ADMIN->locate($section); + $temp = $adminroot->locate($section); if (is_a($temp, 'admin_settingpage') || is_a($temp, 'admin_externalpage')) { diff --git a/blocks/admin_bookmarks/delete.php b/blocks/admin_bookmarks/delete.php index 22fd1860b4..9a8f7fd1ed 100644 --- a/blocks/admin_bookmarks/delete.php +++ b/blocks/admin_bookmarks/delete.php @@ -2,7 +2,8 @@ require('../../config.php'); -require_once($CFG->dirroot . '/' . $CFG->admin . '/adminlib.php'); +require_once($CFG->libdir.'/adminlib.php'); +$adminroot = admin_get_root(); if ($section = optional_param('section', '', PARAM_ALPHAEXT)) { @@ -21,7 +22,7 @@ if ($section = optional_param('section', '', PARAM_ALPHAEXT)) { $bookmarks = implode(',',$bookmarks); set_user_preference('admin_bookmarks', $bookmarks); - $temp = $ADMIN->locate($section); + $temp = $adminroot->locate($section); if (is_a($temp, 'admin_externalpage')) { redirect($temp->url, 'Bookmark deleted.',1); diff --git a/course/category.php b/course/category.php index ec0aff91da..e9708c043f 100644 --- a/course/category.php +++ b/course/category.php @@ -91,9 +91,10 @@ if ($adminediting) { // modify this to treat this as an admin page - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('coursemgmt'); - admin_externalpage_print_header(); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('coursemgmt', $adminroot); + admin_externalpage_print_header($adminroot); } else { print_header("$site->shortname: $category->name", "$site->fullname: $strcourses", "$strcategories -> $category->name", "", "", true, $navbaritem); @@ -444,7 +445,7 @@ echo "
"; if ($adminediting) { - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); } else { print_footer(); } diff --git a/course/index.php b/course/index.php index ed57d7d0bd..93ff5b72ec 100644 --- a/course/index.php +++ b/course/index.php @@ -75,8 +75,9 @@ /// From now on is all the admin functions - require_once($CFG->dirroot . '/admin/adminlib.php'); - admin_externalpage_setup('coursemgmt'); + require_once($CFG->libdir.'/adminlib.php'); + $adminroot = admin_get_root(); + admin_externalpage_setup('coursemgmt', $adminroot); /// Print headings @@ -92,7 +93,7 @@ - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading($strcategories); @@ -323,7 +324,7 @@ echo "
"; echo ""; - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); diff --git a/lib/adminlib.php b/lib/adminlib.php index a36c1351f9..8e91b6ae1b 100644 --- a/lib/adminlib.php +++ b/lib/adminlib.php @@ -609,4 +609,1668 @@ function is_dataroot_insecure() { } return false; } + +/// ============================================================================================================= +/// administration tree classes and functions + + +// n.b. documentation is still in progress for this code + +/// INTRODUCTION + +/// This file performs the following tasks: +/// -it defines the necessary objects and interfaces to build the Moodle +/// admin hierarchy +/// -it defines the admin_externalpage_setup(), admin_externalpage_print_header(), +/// and admin_externalpage_print_footer() functions used on admin pages + +/// ADMIN_SETTING OBJECTS + +/// Moodle settings are represented by objects that inherit from the admin_setting +/// class. These objects encapsulate how to read a setting, how to write a new value +/// to a setting, and how to appropriately display the HTML to modify the setting. + +/// ADMIN_SETTINGPAGE OBJECTS + +/// The admin_setting objects are then grouped into admin_settingpages. The latter +/// appear in the Moodle admin tree block. All interaction with admin_settingpage +/// objects is handled by the admin/settings.php file. + +/// ADMIN_EXTERNALPAGE OBJECTS + +/// There are some settings in Moodle that are too complex to (efficiently) handle +/// with admin_settingpages. (Consider, for example, user management and displaying +/// lists of users.) In this case, we use the admin_externalpage object. This object +/// places a link to an external PHP file in the admin tree block. + +/// If you're using an admin_externalpage object for some settings, you can take +/// advantage of the admin_externalpage_* functions. For example, suppose you wanted +/// to add a foo.php file into admin. First off, you add the following line to +/// admin/settings/first.php (at the end of the file) or to some other file in +/// admin/settings: + +/// $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'), +/// $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission')); + +/// Next, in foo.php, your file structure would resemble the following: + +/// require_once('.../config.php'); +/// require_once($CFG->libdir.'/adminlib.php'); +/// $adminroot = admin_get_root(); +/// admin_externalpage_setup('foo', $adminroot); +/// // functionality like processing form submissions goes here +/// admin_externalpage_print_header($adminroot); +/// // your HTML goes here +/// admin_externalpage_print_footer($adminroot); + +/// The admin_externalpage_setup() function call ensures the user is logged in, +/// and makes sure that they have the proper role permission to access the page. + +/// The admin_externalpage_print_header() function prints the header (it figures +/// out what category and subcategories the page is classified under) and ensures +/// that you're using the admin pagelib (which provides the admin tree block and +/// the admin bookmarks block). + +/// The admin_externalpage_print_footer() function properly closes the tables +/// opened up by the admin_externalpage_print_header() function and prints the +/// standard Moodle footer. + +/// ADMIN_CATEGORY OBJECTS + +/// Above and beyond all this, we have admin_category objects. These objects +/// appear as folders in the admin tree block. They contain admin_settingpage's, +/// admin_externalpage's, and other admin_category's. + +/// OTHER NOTES + +/// admin_settingpage's, admin_externalpage's, and admin_category's all inherit +/// from part_of_admin_tree (a pseudointerface). This interface insists that +/// a class has a check_access method for access permissions, a locate method +/// used to find a specific node in the admin tree, and a path method used +/// to determine the path to a specific node in the $ADMIN tree. + +/// admin_category's inherit from parentable_part_of_admin_tree. This pseudo- +/// interface ensures that the class implements a recursive add function which +/// accepts a part_of_admin_tree object and searches for the proper place to +/// put it. parentable_part_of_admin_tree implies part_of_admin_tree. + +/// Please note that the $this->name field of any part_of_admin_tree must be +/// UNIQUE throughout the ENTIRE admin tree. + +/// The $this->name field of an admin_setting object (which is *not* part_of_ +/// admin_tree) must be unique on the respective admin_settingpage where it is +/// used. + + +/// MISCELLANEOUS STUFF (used by classes defined below) /////////////////////// +include_once($CFG->dirroot . '/backup/lib.php'); + +/// CLASS DEFINITIONS ///////////////////////////////////////////////////////// + +/** + * Pseudointerface for anything appearing in the admin tree + * + * The pseudointerface that is implemented by anything that appears in the admin tree + * block. It forces inheriting classes to define a method for checking user permissions + * and methods for finding something in the admin tree. + * + * @author Vincenzo K. Marcovecchio + * @package admin + */ +class part_of_admin_tree { + + /** + * Finds a named part_of_admin_tree. + * + * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree + * and not parentable_part_of_admin_tree, then this function should only check if + * $this->name matches $name. If it does, it should return a reference to $this, + * otherwise, it should return a reference to NULL. + * + * If a class inherits parentable_part_of_admin_tree, this method should be called + * recursively on all child objects (assuming, of course, the parent object's name + * doesn't match the search criterion). + * + * @param string $name The internal name of the part_of_admin_tree we're searching for. + * @return mixed An object reference or a NULL reference. + */ + function &locate($name) { + trigger_error('Admin class does not implement method locate()', E_USER_WARNING); + return; + } + + /** + * Verifies current user's access to this part_of_admin_tree. + * + * Used to check if the current user has access to this part of the admin tree or + * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, + * then this method is usually just a call to has_capability() in the site context. + * + * If a class inherits parentable_part_of_admin_tree, this method should return the + * logical OR of the return of check_access() on all child objects. + * + * @return bool True if the user has access, false if she doesn't. + */ + function check_access() { + trigger_error('Admin class does not implement method check_access()', E_USER_WARNING); + return; + } + + /** + * Determines the path to $name in the admin tree. + * + * Used to determine the path to $name in the admin tree. If a class inherits only + * part_of_admin_tree and not parentable_part_of_admin_tree, then this method should + * check if $this->name matches $name. If it does, $name is pushed onto the $path + * array (at the end), and $path should be returned. If it doesn't, NULL should be + * returned. + * + * If a class inherits parentable_part_of_admin_tree, it should do the above, but not + * return NULL on failure. Instead, it pushes $this->name onto $path, and then + * recursively calls path() on its child objects. If any are non-NULL, it should + * return $path (being certain that the last element of $path is equal to $name). + * If they are all NULL, it returns NULL. + * + * @param string $name The internal name of the part_of_admin_tree we're searching for. + * @param array $path Not used on external calls. Defaults to empty array. + * @return mixed If found, an array containing the internal names of each part_of_admin_tree that leads to $name. If not found, NULL. + */ + function path($name, $path = array()) { + trigger_error('Admin class does not implement method path()', E_USER_WARNING); + return; + } +} + +/** + * Pseudointerface implemented by any part_of_admin_tree that has children. + * + * The pseudointerface implemented by any part_of_admin_tree that can be a parent + * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart + * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods + * include an add method for adding other part_of_admin_tree objects as children. + * + * @author Vincenzo K. Marcovecchio + * @package admin + */ +class parentable_part_of_admin_tree extends part_of_admin_tree { + + /** + * Adds a part_of_admin_tree object to the admin tree. + * + * Used to add a part_of_admin_tree object to this object or a child of this + * object. $something should only be added if $destinationname matches + * $this->name. If it doesn't, add should be called on child objects that are + * also parentable_part_of_admin_tree's. + * + * @param string $destinationname The internal name of the new parent for $something. + * @param part_of_admin_tree &$something The object to be added. + * @return bool True on success, false on failure. + */ + function add($destinationname, &$something) { + trigger_error('Admin class does not implement method add()', E_USER_WARNING); + return; + } + +} + +/** + * The object used to represent folders (a.k.a. categories) in the admin tree block. + * + * Each admin_category object contains a number of part_of_admin_tree objects. + * + * @author Vincenzo K. Marcovecchio + * @package admin + */ +class admin_category extends parentable_part_of_admin_tree { + + /** + * @var mixed An array of part_of_admin_tree objects that are this object's children + */ + var $children; + + /** + * @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects + */ + var $name; + + /** + * @var string The displayed name for this category. Usually obtained through get_string() + */ + var $visiblename; + + // constructor for an empty admin category + // $name is the internal name of the category. it MUST be unique in the entire hierarchy + // $visiblename is the displayed name of the category. use a get_string for this + + /** + * Constructor for an empty admin category + * + * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects + * @param string $visiblename The displayed named for this category. Usually obtained through get_string() + * @return mixed Returns the new object. + */ + function admin_category($name, $visiblename) { + $this->children = array(); + $this->name = $name; + $this->visiblename = $visiblename; + } + + /** + * Finds the path to the part_of_admin_tree called $name. + * + * @param string $name The internal name that we're searching for. + * @param array $path Used internally for recursive calls. Do not specify on external calls. Defaults to array(). + * @return mixed An array of internal names that leads to $name, or NULL if not found. + */ + function path($name, $path = array()) { + + $path[count($path)] = $this->name; + + if ($this->name == $name) { + return $path; + } + + foreach($this->children as $child) { + if ($return = $child->path($name, $path)) { + return $return; + } + } + + return NULL; + + } + + /** + * Returns a reference to the part_of_admin_tree object with internal name $name. + * + * @param string $name The internal name of the object we want. + * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. + */ + function &locate($name) { + + if ($this->name == $name) { + return $this; + } + + foreach($this->children as $child) { + if ($return =& $child->locate($name)) { + return $return; + } + } + $return = NULL; + return $return; + } + + /** + * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object. + * + * @param string $destinationame The internal name of the immediate parent that we want for &$something. + * @param mixed &$something A part_of_admin_tree object to be added. + * @param int $precedence The precedence of &$something when displayed. Smaller numbers mean it'll be displayed higher up in the admin menu. Defaults to '', meaning "next available position". + * @return bool True if successfully added, false if &$something is not a part_of_admin_tree or if $name is not found. + */ + function add($destinationname, &$something, $precedence = '') { + + if (!is_a($something, 'part_of_admin_tree')) { + return false; + } + + if ($destinationname == $this->name) { + if ($precedence === '') { + $this->children[] = $something; + } else { + if (isset($this->children[$precedence])) { // this should never, ever be triggered in a release version of moodle. + echo ('There is a precedence conflict in the category ' . $this->name . '. The object named ' . $something->name . ' is overwriting the object named ' . $this->children[$precedence]->name . '.
'); + } + $this->children[$precedence] = $something; + } + return true; + } + + unset($entries); + + $entries = array_keys($this->children); + + foreach($entries as $entry) { + $child =& $this->children[$entry]; + if (is_a($child, 'parentable_part_of_admin_tree')) { + if ($child->add($destinationname, $something, $precedence)) { + return true; + } + } + } + + return false; + + } + + /** + * Checks if the user has access to anything in this category. + * + * @return bool True if the user has access to atleast one child in this category, false otherwise. + */ + function check_access() { + + $return = false; + foreach ($this->children as $child) { + $return = $return || $child->check_access(); + } + + return $return; + + } + +} + +/** + * Links external PHP pages into the admin tree. + * + * See detailed usage example at the top of this document (adminlib.php) + * + * @author Vincenzo K. Marcovecchio + * @package admin + */ +class admin_externalpage extends part_of_admin_tree { + + /** + * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects + */ + var $name; + + /** + * @var string The displayed name for this external page. Usually obtained through get_string(). + */ + var $visiblename; + + /** + * @var string The external URL that we should link to when someone requests this external page. + */ + var $url; + + /** + * @var string The role capability/permission a user must have to access this external page. + */ + var $role; + + /** + * Constructor for adding an external page into the admin tree. + * + * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. + * @param string $visiblename The displayed name for this external page. Usually obtained through get_string(). + * @param string $url The external URL that we should link to when someone requests this external page. + * @param string $role The role capability/permission a user must have to access this external page. Defaults to 'moodle/legacy:admin'. + */ + function admin_externalpage($name, $visiblename, $url, $role = 'moodle/legacy:admin') { + $this->name = $name; + $this->visiblename = $visiblename; + $this->url = $url; + $this->role = $role; + } + + /** + * Finds the path to the part_of_admin_tree called $name. + * + * @param string $name The internal name that we're searching for. + * @param array $path Used internally for recursive calls. Do not specify on external calls. Defaults to array(). + * @return mixed An array of internal names that leads to $name, or NULL if not found. + */ + function path($name, $path = array()) { + if ($name == $this->name) { + array_push($path, $this->name); + return $path; + } else { + return NULL; + } + } + + /** + * Returns a reference to the part_of_admin_tree object with internal name $name. + * + * @param string $name The internal name of the object we want. + * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. + */ + function &locate($name) { + $return = ($this->name == $name ? $this : NULL); + return $return; + } + + /** + * Determines if the current user has access to this external page based on $this->role. + * + * @uses CONTEXT_SYSTEM + * @uses SITEID + * @return bool True if user has access, false otherwise. + */ + function check_access() { + if (!get_site()) { + return true; // no access check before site is fully set up + } + $context = get_context_instance(CONTEXT_SYSTEM, SITEID); + return has_capability($this->role, $context); + } + +} + +/** + * Used to group a number of admin_setting objects into a page and add them to the admin tree. + * + * @author Vincenzo K. Marcovecchio + * @package admin + */ +class admin_settingpage extends part_of_admin_tree { + + /** + * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects + */ + var $name; + + /** + * @var string The displayed name for this external page. Usually obtained through get_string(). + */ + var $visiblename; + /** + * @var mixed An array of admin_setting objects that are part of this setting page. + */ + var $settings; + + /** + * @var string The role capability/permission a user must have to access this external page. + */ + var $role; + + // see admin_category + function path($name, $path = array()) { + if ($name == $this->name) { + array_push($path, $this->name); + return $path; + } else { + return NULL; + } + } + + // see admin_category + function &locate($name) { + $return = ($this->name == $name ? $this : NULL); + return $return; + } + + // see admin_externalpage + function admin_settingpage($name, $visiblename, $role = 'moodle/legacy:admin') { + global $CFG; + $this->settings = new stdClass(); + $this->name = $name; + $this->visiblename = $visiblename; + $this->role = $role; + } + + // 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 + // n.b. each admin_setting in an admin_settingpage must have a unique internal name + // &$setting is the admin_setting object you want to add + // returns true if successful, false if not (will fail if &$setting is an admin_setting or child thereof) + function add(&$setting) { + if (is_a($setting, 'admin_setting')) { + $this->settings->{$setting->name} =& $setting; + return true; + } + return false; + } + + // see admin_externalpage + function check_access() { + if (!get_site()) { + return true; // no access check before site is fully set up + } + $context = get_context_instance(CONTEXT_SYSTEM, SITEID); + return has_capability($this->role, $context); + } + + // outputs this page as html in a table (suitable for inclusion in an admin pagetype) + // returns a string of the html + function output_html() { + $return = '' . "\n"; + foreach($this->settings as $setting) { + $return .= $setting->output_html(); + } + $return .= '
'; + return $return; + } + + // writes settings (the ones that have been added to this admin_settingpage) to the database, or wherever else they're supposed to be written to + // -- calls write_setting() to each child setting, sending it only the data that matches each setting's internal name + // $data should be the result from data_submitted() + // returns an empty string if everything went well, otherwise returns a printable error string (that's language-specific) + function write_settings($data) { + $return = ''; + foreach($this->settings as $setting) { + if (isset($data['s_' . $setting->name])) { + $return .= $setting->write_setting($data['s_' . $setting->name]); + } else { + $return .= $setting->write_setting(''); + } + } + return $return; + } + +} + + +// read & write happens at this level; no authentication +class admin_setting { + + var $name; + var $visiblename; + var $description; + var $defaultsetting; + + function admin_setting($name, $visiblename, $description, $defaultsetting) { + $this->name = $name; + $this->visiblename = $visiblename; + $this->description = $description; + $this->defaultsetting = $defaultsetting; + } + + function get_setting() { + return NULL; // has to be overridden + } + + function write_setting($data) { + return; // has to be overridden + } + + function output_html() { + return; // has to be overridden + } + +} + + +class admin_setting_configtext extends admin_setting { + + var $paramtype; + + function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype) { + $this->paramtype = $paramtype; + parent::admin_setting($name, $visiblename, $description, $defaultsetting); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); + } + + function write_setting($data) { + $data = clean_param($data, $this->paramtype); + return (set_config($this->name,$data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + return '' . $this->visiblename . '' . + '' . + ' ' . $this->description . ''; + } + +} + +class admin_setting_configcheckbox extends admin_setting { + + function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting) { + parent::admin_setting($name, $visiblename, $description, $defaultsetting); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); + } + + function write_setting($data) { + if ($data == '1') { + return (set_config($this->name,1) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } else { + return (set_config($this->name,0) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + } + + function output_html() { + return '' . $this->visiblename . '' . + 'get_setting() == true ? 'checked="checked"' : '') . ' />' . + ' ' . $this->description . ''; + } + +} + +class admin_setting_configselect extends admin_setting { + + var $choices; + + function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) { + $this->choices = $choices; + parent::admin_setting($name, $visiblename, $description, $defaultsetting); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? $CFG->{$this->name} : NULL); + } + + function write_setting($data) { + // check that what we got was in the original choices + // or that the data is the default setting - needed during install when choices can not be constructed yet + if ($data != $this->defaultsetting and ! in_array($data, array_keys($this->choices))) { + return 'Error setting ' . $this->visiblename . '
'; + } + + return (set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + $return = '' . $this->visiblename . ' ' . $this->description . ''; + return $return; + } + +} + +// this is a liiitle bit messy. we're using two selects, but we're returning them as an array named after $name (so we only use $name2 +// internally for the setting) +class admin_setting_configtime extends admin_setting { + + var $name2; + var $choices; + var $choices2; + var $defaultsetting2; + + function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) { + $this->name2 = $minutesname; + $this->choices = array(); + for ($i = 0; $i < 24; $i++) { + $this->choices[$i] = $i; + } + $this->choices2 = array(); + for ($i = 0; $i < 60; $i += 5) { + $this->choices2[$i] = $i; + } + parent::admin_setting($hoursname, $visiblename, $description, $defaultsetting); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) && isset($CFG->{$this->name2}) ? array($CFG->{$this->name}, $CFG->{$this->name2}) : NULL); + } + + function write_setting($data) { + // check that what we got was in the original choices + if (!(in_array($data['h'], array_keys($this->choices)) && in_array($data['m'], array_keys($this->choices2)))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + + return (set_config($this->name, $data['h']) && set_config($this->name2, $data['m']) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + $setvalue = $this->get_setting(); + if (!is_array($setvalue)) { + $setvalue = array(0,0); + } + $return = '' . $this->visiblename . '    ' . $this->description . ''; + return $return; + } + +} + +class admin_setting_configmultiselect extends admin_setting_configselect { + + function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) { + parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? explode(',', $CFG->{$this->name}) : NULL);; + } + + function write_setting($data) { + foreach ($data as $datum) { + if (! in_array($datum, array_keys($this->choices))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + } + + return (set_config($this->name, implode(',',$data)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + $currentsetting = $this->get_setting(); + if (!is_array($currentsetting)) { + $currentsetting = array(); + } + $return = '' . $this->visiblename . ' ' . $this->description . ''; + return $return; + } + +} + +class admin_setting_special_adminseesall extends admin_setting_configcheckbox { + + function admin_setting_special_adminseesall() { + $name = 'calendar_adminseesall'; + $visiblename = get_string('adminseesall', 'admin'); + $description = get_string('helpadminseesall', 'admin'); + parent::admin_setting($name, $visiblename, $description, 0); + } + + function write_setting($data) { + global $SESSION; + unset($SESSION->cal_courses_shown); + parent::write_setting($data); + } +} + +class admin_setting_sitesetselect extends admin_setting_configselect { + + var $id; + + function admin_setting_sitesetselect($name, $visiblename, $description, $defaultsetting, $choices) { + + $this->id = SITEID; + parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices); + + } + + function get_setting() { + $site = get_site(); + return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); + } + + function write_setting($data) { + if (!in_array($data, array_keys($this->choices))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + $record = new stdClass(); + $record->id = $this->id; + $temp = $this->name; + $record->$temp = $data; + $record->timemodified = time(); + return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + + +class admin_setting_special_frontpage extends admin_setting_configselect { + + function admin_setting_special_frontpage($loggedin = false) { + global $CFG; + require_once($CFG->dirroot . '/course/lib.php'); + $name = 'frontpage' . ($loggedin ? 'loggedin' : ''); + $visiblename = get_string('frontpage' . ($loggedin ? 'loggedin' : ''),'admin'); + $description = get_string('configfrontpage' . ($loggedin ? 'loggedin' : ''),'admin'); + $choices = array(FRONTPAGENEWS => get_string('frontpagenews'), + FRONTPAGECOURSELIST => get_string('frontpagecourselist'), + FRONTPAGECATEGORYNAMES => get_string('frontpagecategorynames'), + FRONTPAGECATEGORYCOMBO => get_string('frontpagecategorycombo'), + '' => get_string('none')); + if (count_records("course") > FRONTPAGECOURSELIMIT) { + unset($choices[FRONTPAGECOURSELIST]); + } + parent::admin_setting_configselect($name, $visiblename, $description, '', $choices); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? explode(',', $CFG->{$this->name}) : NULL); + } + + function write_setting($data) { + if (empty($data)) { + $data = array(); + } + foreach($data as $datum) { + if (! in_array($datum, array_keys($this->choices))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + } + return (set_config($this->name, implode(',', $data)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + + $currentsetting = $this->get_setting(); + if (!is_array($currentsetting)) { + $currentsetting = array(); + } + for ($i = 0; $i < count($this->choices) - 1; $i++) { + if (!isset($currentsetting[$i])) { + $currentsetting[$i] = 0; + } + } + $return = '' . $this->visiblename . ''; + for ($i = 0; $i < count($this->choices) - 1; $i++) { + $return .=''; + if ($i !== count($this->choices) - 2) { + $return .= '  ' . get_string('then') . '  '; + } + } + $return .= ' ' . $this->description . ''; + return $return; + + + } +} + +class admin_setting_sitesetcheckbox extends admin_setting_configcheckbox { + + var $id; + + function admin_setting_sitesetcheckbox($name, $visiblename, $description, $defaultsetting) { + + $this->id = SITEID; + parent::admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting); + + } + + function get_setting() { + $site = get_site(); + return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); + } + + function write_setting($data) { + $record = new stdClass(); + $record->id = $this->id; + $temp = $this->name; + $record->$temp = ($data == '1' ? 1 : 0); + $record->timemodified = time(); + return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + +class admin_setting_sitesettext extends admin_setting_configtext { + + var $id; + + function admin_setting_sitesettext($name, $visiblename, $description, $defaultsetting, $paramtype) { + + $this->id = SITEID; + parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype); + + } + + function get_setting() { + $site = get_site(); + return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); + } + + function write_setting($data) { + $record = new stdClass(); + $record->id = $this->id; + $temp = $this->name; + $record->$temp = $data; + $record->timemodified = time(); + return (update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + +class admin_setting_special_frontpagedesc extends admin_setting { + + var $id; + + function admin_setting_special_frontpagedesc() { + $this->id = SITEID; + $name = 'summary'; + $visiblename = get_string('frontpagedescription'); + $description = get_string('frontpagedescriptionhelp'); + parent::admin_setting($name, $visiblename, $description, ''); + } + + function output_html() { + + $usehtmleditor = can_use_html_editor(); + + $return = '' . $this->visiblename . '' . + ''; + + ob_start(); // double-check the number of columns below... might overrun some screen resolutions + print_textarea($usehtmleditor, 20, 40, 0, 0, 's_' . $this->name, $this->get_setting()); + + if ($usehtmleditor) { + use_html_editor(); + } + $return .= ob_get_contents(); + ob_end_clean(); + $return .= ' ' . $this->description . ''; + return $return; + + } + + function get_setting() { + + $site = get_site(); + return (isset($site->{$this->name}) ? $site->{$this->name} : NULL); + + } + + function write_setting($data) { + + $data = addslashes(clean_param($data, PARAM_CLEANHTML)); + + $record = new stdClass(); + $record->id = $this->id; + $temp = $this->name; + $record->$temp = $data; + $record->timemodified = time(); + + return(update_record('course', $record) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + + } + +} + + +class admin_setting_special_editorfontlist extends admin_setting { + + var $items; + + function admin_setting_special_editorfontlist() { + global $CFG; + $name = 'editorfontlist'; + $visiblename = get_string('editorfontlist', 'admin'); + $description = get_string('configeditorfontlist', 'admin'); + if (isset($CFG->editorfontlist)) { + $items = explode(';', $CFG->editorfontlist); + $this->items = array(); + foreach ($items as $item) { + $item = explode(':', $item); + $this->items[$item[0]] = $item[1]; + } + } else { + $items = NULL; + } + unset($defaults); + $defaults = array('k0' => 'Trebuchet', + 'v0' => 'Trebuchet MS,Verdana,Arial,Helvetica,sans-serif', + 'k1' => 'Arial', + 'v1' => 'arial,helvetica,sans-serif', + 'k2' => 'Courier New', + 'v2' => 'courier new,courier,monospace', + 'k3' => 'Georgia', + 'v3' => 'georgia,times new roman,times,serif', + 'k4' => 'Tahoma', + 'v4' => 'tahoma,arial,helvetica,sans-serif', + 'k5' => 'Times New Roman', + 'v5' => 'times new roman,times,serif', + 'k6' => 'Verdana', + 'v6' => 'verdana,arial,helvetica,sans-serif', + 'k7' => 'Impact', + 'v7' => 'impact', + 'k8' => 'Wingdings', + 'v8' => 'wingdings'); + parent::admin_setting($name, $visiblename, $description, $defaults); + } + + function get_setting() { + return $this->items; + } + + function write_setting($data) { + + // there miiight be an easier way to do this :) + // if this is changed, make sure the $defaults array above is modified so that this + // function processes it correctly + + $keys = array(); + $values = array(); + + foreach ($data as $key => $value) { + if (substr($key,0,1) == 'k') { + $keys[substr($key,1)] = $value; + } elseif (substr($key,0,1) == 'v') { + $values[substr($key,1)] = $value; + } + } + + $result = ''; + for ($i = 0; $i < count($keys); $i++) { + if (($keys[$i] !== '') && ($values[$i] !== '')) { + $result .= clean_param($keys[$i],PARAM_NOTAGS) . ':' . clean_param($values[$i], PARAM_NOTAGS) . ';'; + } + } + + $result = substr($result, 0, -1); // trim the last semicolon + + return (set_config($this->name, $result) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + $return = '' . $this->visiblename . ''; + $count = 0; + $currentsetting = $this->items; + if (!is_array($currentsetting)) { + $currentsetting = NULL; + } + foreach ($currentsetting as $key => $value) { + $return .= ''; + $return .= '  '; + $return .= '
'; + $count++; + } + $return .= ''; + $return .= '  '; + $return .= '
'; + $return .= ''; + $return .= '  '; + $return .= ''; + $return .= ' ' . $this->description . ''; + return $return; + } + +} + +class admin_setting_special_editordictionary extends admin_setting_configselect { + + function admin_setting_special_editordictionary() { + $name = 'editordictionary'; + $visiblename = get_string('editordictionary','admin'); + $description = get_string('configeditordictionary', 'admin'); + $choices = $this->editor_get_dictionaries(); + if (! is_array($choices)) { + $choices = array(''); + } + + parent::admin_setting_configselect($name, $visiblename, $description, '', $choices); + } + + // function borrowed from the old moodle/admin/editor.php, slightly modified + function editor_get_dictionaries () { + /// Get all installed dictionaries in the system + + global $CFG; + +// error_reporting(E_ALL); // for debug, final version shouldn't have this... + clearstatcache(); + + // If aspellpath isn't set don't even bother ;-) + if (empty($CFG->aspellpath)) { + return 'Empty aspell path!'; + } + + // Do we have access to popen function? + if (!function_exists('popen')) { + return 'Popen function disabled!'; + } + + $cmd = $CFG->aspellpath; + $output = ''; + $dictionaries = array(); + $dicts = array(); + + if(!($handle = @popen(escapeshellarg($cmd) .' dump dicts', 'r'))) { + return 'Couldn\'t create handle!'; + } + + while(!feof($handle)) { + $output .= fread($handle, 1024); + } + @pclose($handle); + + $dictionaries = explode(chr(10), $output); + + // Get rid of possible empty values + if (is_array($dictionaries)) { + + $cnt = count($dictionaries); + + for ($i = 0; $i < $cnt; $i++) { + if (!empty($dictionaries[$i])) { + $dicts[] = $dictionaries[$i]; + } + } + } + + if (count($dicts) >= 1) { + return $dicts; + } + + return 'Error! Check your aspell installation!'; + } + + + +} + + +class admin_setting_special_editorhidebuttons extends admin_setting { + + var $name; + var $visiblename; + var $description; + var $items; + + function admin_setting_special_editorhidebuttons() { + $this->name = 'editorhidebuttons'; + $this->visiblename = get_string('editorhidebuttons', 'admin'); + $this->description = get_string('confeditorhidebuttons', 'admin'); + $this->defaultsetting = array(); + // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead + $this->items = array('fontname' => '', + 'fontsize' => '', + 'formatblock' => '', + 'bold' => 'ed_format_bold.gif', + 'italic' => 'ed_format_italic.gif', + 'underline' => 'ed_format_underline.gif', + 'strikethrough' => 'ed_format_strike.gif', + 'subscript' => 'ed_format_sub.gif', + 'superscript' => 'ed_format_sup.gif', + 'copy' => 'ed_copy.gif', + 'cut' => 'ed_cut.gif', + 'paste' => 'ed_paste.gif', + 'clean' => 'ed_wordclean.gif', + 'undo' => 'ed_undo.gif', + 'redo' => 'ed_redo.gif', + 'justifyleft' => 'ed_align_left.gif', + 'justifycenter' => 'ed_align_center.gif', + 'justifyright' => 'ed_align_right.gif', + 'justifyfull' => 'ed_align_justify.gif', + 'lefttoright' => 'ed_left_to_right.gif', + 'righttoleft' => 'ed_right_to_left.gif', + 'insertorderedlist' => 'ed_list_num.gif', + 'insertunorderedlist' => 'ed_list_bullet.gif', + 'outdent' => 'ed_indent_less.gif', + 'indent' => 'ed_indent_more.gif', + 'forecolor' => 'ed_color_fg.gif', + 'hilitecolor' => 'ed_color_bg.gif', + 'inserthorizontalrule' => 'ed_hr.gif', + 'createanchor' => 'ed_anchor.gif', + 'createlink' => 'ed_link.gif', + 'unlink' => 'ed_unlink.gif', + 'insertimage' => 'ed_image.gif', + 'inserttable' => 'insert_table.gif', + 'insertsmile' => 'em.icon.smile.gif', + 'insertchar' => 'icon_ins_char.gif', + 'spellcheck' => 'spell-check.gif', + 'htmlmode' => 'ed_html.gif', + 'popupeditor' => 'fullscreen_maximize.gif', + 'search_replace' => 'ed_replace.gif'); + } + + function get_setting() { + global $CFG; + return (isset($CFG->{$this->name}) ? explode(' ', $CFG->{$this->name}) : NULL); + } + + function write_setting($data) { + $result = array(); + if (empty($data)) { $data = array(); } + foreach ($data as $key => $value) { + if (!in_array($key, array_keys($this->items))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + if ($value == '1') { + $result[] = $key; + } + } + return (set_config($this->name, implode(' ',$result)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + + global $CFG; + + // checkboxes with input name="$this->name[$key]" value="1" + // we do 15 fields per column + + $currentsetting = $this->get_setting(); + if (!is_array($currentsetting)) { + $currentsetting = array(); + } + + $return = '' . $this->visiblename . ''; + + $return .= ''; + $return .= '
'; + + $count = 0; + + foreach($this->items as $key => $value) { + if ($count % 15 == 0) { + $return .= ''; + } + + $return .= ($value == '' ? get_string($key,'editor') : '' . get_string($key,'editor') . '') . ' '; + $return .= '       '; + $count++; + if ($count % 15 != 0) { + $return .= '

'; + } + } + + $return .= '
'; + $return .= ' ' . $this->description . ''; + + return $return; + } + +} + +class admin_setting_backupselect extends admin_setting_configselect { + + function admin_setting_backupselect($name, $visiblename, $description, $default, $choices) { + parent::admin_setting_configselect($name, $visiblename, $description, $default, $choices); + } + + function get_setting() { + $backup_config = backup_get_config(); + return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); + } + + function write_setting($data) { + // check that what we got was in the original choices + if (! in_array($data, array_keys($this->choices))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + + return (backup_set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + +class admin_setting_special_backupsaveto extends admin_setting_configtext { + + function admin_setting_special_backupsaveto() { + $name = 'backup_sche_destination'; + $visiblename = get_string('saveto'); + $description = get_string('backupsavetohelp'); + parent::admin_setting_configtext($name, $visiblename, $description, '', PARAM_PATH); + } + + function get_setting() { + $backup_config = backup_get_config(); + return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); + } + + function write_setting($data) { + $data = clean_param($data, PARAM_PATH); + if (!empty($data) and (substr($data,-1) == '/' or substr($data,-1) == '\\')) { + return get_string('pathslasherror') . '
'; + } else if (!empty($data) and !is_dir($data)) { + return get_string('pathnotexists') . '
'; + } + return (backup_set_config($this->name, $data) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + +class admin_setting_backupcheckbox extends admin_setting_configcheckbox { + + function admin_setting_backupcheckbox($name, $visiblename, $description, $default) { + parent::admin_setting_configcheckbox($name, $visiblename, $description, $default); + } + + function write_setting($data) { + if ($data == '1') { + return (backup_set_config($this->name, 1) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } else { + return (backup_set_config($this->name, 0) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + } + + function get_setting() { + $backup_config = backup_get_config(); + return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); + } + +} + +class admin_setting_special_backuptime extends admin_setting_configtime { + + function admin_setting_special_backuptime() { + $name = 'backup_sche_hour'; + $name2 = 'backup_sche_minute'; + $visiblename = get_string('executeat'); + $description = get_string('backupexecuteathelp'); + $default = array('h' => 0, 'm' => 0); + parent::admin_setting_configtime($name, $name2, $visiblename, $description, $default); + } + + function get_setting() { + $backup_config = backup_get_config(); + return (isset($backup_config->{$this->name}) && isset($backup_config->{$this->name}) ? array($backup_config->{$this->name}, $backup_config->{$this->name2}) : NULL); + } + + function write_setting($data) { + // check that what we got was in the original choices + if (!(in_array($data['h'], array_keys($this->choices)) && in_array($data['m'], array_keys($this->choices2)))) { + return get_string('errorsetting', 'admin') . $this->visiblename . '
'; + } + + return (backup_set_config($this->name, $data['h']) && backup_set_config($this->name2, $data['m']) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + +} + +class admin_setting_special_backupdays extends admin_setting { + + function admin_setting_special_backupdays() { + $name = 'backup_sche_weekdays'; + $visiblename = get_string('schedule'); + $description = get_string('backupschedulehelp'); + parent::admin_setting($name, $visiblename, $description, array()); + } + + function get_setting() { + $backup_config = backup_get_config(); + return (isset($backup_config->{$this->name}) ? $backup_config->{$this->name} : NULL); + } + + function output_html() { + + $currentsetting = $this->get_setting(); + if ($currentsetting === NULL) { + $currentsetting = '0000000'; + } + + return '' . $this->visiblename . '' . + '' . + '' . + '' . + '' . + '' . + '' . + '' . + '' . + '
  ' . get_string('sunday', 'calendar') . '  
  ' . + get_string('monday', 'calendar') . '  
  ' . get_string('tuesday', 'calendar') . '  
  ' . + get_string('wednesday', 'calendar') . '  
  ' . get_string('thursday', 'calendar') . '  
  ' . + get_string('friday', 'calendar') . '  
  ' . get_string('saturday', 'calendar') . '  
' . + ' ' . $this->description . ''; + + } + + // we're using the array trick (see http://ca.php.net/manual/en/faq.html.php#faq.html.arrays) to get the data passed to use without having to modify + // admin_settingpage (note that admin_settingpage only calls write_setting with the data that matches $this->name... so if we have multiple form fields, + // they MUST go into an array named $this->name, or else we won't receive them here + function write_setting($data) { + $week = 'umtwrfs'; + $result = array(0 => 0, 1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0, 6 => 0); + foreach($data as $key => $value) { + if ($value == '1') { + $result[strpos($week, $key)] = 1; + } + } + return (backup_set_config($this->name, implode('',$result)) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } +} + +class admin_setting_special_debug extends admin_setting_configcheckbox { + + function admin_setting_special_debug() { + $name = 'debug'; + $visiblename = get_string('debug', 'admin'); + $description = get_string('configdebug', 'admin'); + parent::admin_setting_configcheckbox($name, $visiblename, $description, ''); + } + + function write_setting($data) { + if ($data == '1') { + return (set_config($this->name,15) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } else { + return (set_config($this->name,7) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + } + + function output_html() { + return '' . $this->visiblename . '' . + 'get_setting() == 15 ? 'checked="checked"' : '') . ' />' . + ' ' . $this->description . ''; + } + +} + + +class admin_setting_special_calendar_weekend extends admin_setting { + + function admin_setting_special_calendar_weekend() { + $name = 'calendar_weekend'; + $visiblename = get_string('calendar_weekend', 'admin'); + $description = get_string('helpweekenddays', 'admin'); + parent::admin_setting($name, $visiblename, $description, array('u' => 1, 's' => 1)); + } + + function get_setting() { + global $CFG; + if (isset($CFG->{$this->name})) { + $setting = intval($CFG->{$this->name}); + return array('u' => $setting & 1, 'm' => $setting & 2, 't' => $setting & 4, 'w' => $setting & 8, 'r' => $setting & 16, 'f' => $setting & 32, 's' => $setting & 64); + } else { + return NULL; + } + } + + function write_setting($data) { + $week = 'umtwrfs'; + $result = array(0 => 0, 1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0, 6 => 0); + foreach($data as $key => $value) { + if ($value == '1') { + $result[strpos($week, $key)] = 1; + } + } + return (set_config($this->name, bindec(implode('',$result))) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + + function output_html() { + + $currentsetting = $this->get_setting(); + if (!is_array($currentsetting)) { + $currentsetting = array('u' => 0, 'm' => 0, 't' => 0, 'w' => 0, 'r' => 0, 'f' => 0, 's' => 0); + } + return '' . $this->visiblename . '' . + '' . + '' . + '' . + '' . + '' . + '' . + '' . + '' . + '
  ' . get_string('sunday', 'calendar') . '  
  ' . + get_string('monday', 'calendar') . '  
  ' . get_string('tuesday', 'calendar') . '  
  ' . + get_string('wednesday', 'calendar') . '  
  ' . get_string('thursday', 'calendar') . '  
  ' . + get_string('friday', 'calendar') . '  
  ' . get_string('saturday', 'calendar') . '  
' . + ' ' . $this->description . ''; + + } + +} + + +class admin_setting_special_perfdebug extends admin_setting_configcheckbox { + + function admin_setting_special_perfdebug() { + $name = 'perfdebug'; + $visiblename = get_string('perfdebug', 'admin'); + $description = get_string('configperfdebug', 'admin'); + parent::admin_setting_configcheckbox($name, $visiblename, $description, ''); + } + + function write_setting($data) { + if ($data == '1') { + return (set_config($this->name,15) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } else { + return (set_config($this->name,7) ? '' : get_string('errorsetting', 'admin') . $this->visiblename . '
'); + } + } + + function output_html() { + return '' . $this->visiblename . '' . + 'get_setting() == 15 ? 'checked="checked"' : '') . ' />' . + ' ' . $this->description . ''; + } + +} + +// Code for a function that helps externalpages print proper headers and footers +// N.B.: THIS FUNCTION HANDLES AUTHENTICATION +function admin_externalpage_setup($section, $adminroot) { + + global $CFG, $PAGE, $USER; + + require_once($CFG->libdir . '/blocklib.php'); + require_once($CFG->dirroot . '/admin/pagelib.php'); + + define('TEMPORARY_ADMIN_PAGE_ID',26); + + define('BLOCK_L_MIN_WIDTH',160); + define('BLOCK_L_MAX_WIDTH',210); + + $pagetype = PAGE_ADMIN; + $pageclass = 'page_admin'; + page_map_class($pagetype, $pageclass); + + $PAGE = page_create_object($pagetype,TEMPORARY_ADMIN_PAGE_ID); + + $PAGE->init_full($section); + + $root = $adminroot->locate($PAGE->section); + + if ($site = get_site()) { + require_login(); + } else { + redirect($CFG->wwwroot . '/admin/index.php'); + die; + } + + if (!is_a($root, 'admin_externalpage')) { + error(get_string('sectionerror','admin')); + die; + } + + // this eliminates our need to authenticate on the actual pages + if (!($root->check_access())) { + error(get_string('accessdenied', 'admin')); + die; + } + + $adminediting = optional_param('adminedit', -1, PARAM_BOOL); + + if (!isset($USER->adminediting)) { + $USER->adminediting = false; + } + + if ($PAGE->user_allowed_editing()) { + if ($adminediting == 1) { + $USER->adminediting = true; + } elseif ($adminediting == 0) { + $USER->adminediting = false; + } + } + +} + +function admin_externalpage_print_header($adminroot) { + + global $CFG, $PAGE; + + $pageblocks = blocks_setup($PAGE); + + $preferred_width_left = bounded_number(BLOCK_L_MIN_WIDTH, blocks_preferred_width($pageblocks[BLOCK_POS_LEFT]), BLOCK_L_MAX_WIDTH); + + $PAGE->print_header(); + echo ''; + echo ''; + echo '
'; + blocks_print_group($PAGE, $pageblocks, BLOCK_POS_LEFT); + echo ''; + +} + +function admin_externalpage_print_footer($adminroot) { + + echo '
'; + print_footer(); + +} + +function admin_get_root() { + global $CFG; + + static $ADMIN; + + if (!isset($ADMIN)) { + // start the admin tree! + $ADMIN = new admin_category('root','Administration'); + // we process this file first to get categories up and running + include($CFG->dirroot . '/admin/settings/first.php'); + + // now we process all other files in admin/settings to build the + // admin tree + foreach (glob($CFG->dirroot . '/admin/settings/*.php') as $file) { + if ($file != $CFG->dirroot . '/admin/settings/first.php') { + include_once($file); + } + } + } + + return $ADMIN; +} + +/// settings utiliti functions + +// n.b. this function unconditionally applies default settings +function apply_default_settings(&$node) { + + global $CFG; + + if (is_a($node, 'admin_category')) { + $entries = array_keys($node->children); + foreach ($entries as $entry) { + apply_default_settings($node->children[$entry]); + } + return; + } + + if (is_a($node, 'admin_settingpage')) { + foreach ($node->settings as $setting) { + $CFG->{$setting->name} = $setting->defaultsetting; + $setting->write_setting($setting->defaultsetting); + unset($setting); // needed to prevent odd (imho) reference behaviour + // see http://www.php.net/manual/en/language.references.whatdo.php#AEN6399 + } + return; + } + + return; + +} + +// n.b. this function unconditionally applies default settings +function apply_default_exception_settings($defaults) { + + global $CFG; + + foreach($defaults as $key => $value) { + $CFG->$key = $value; + set_config($key, $value); + } + +} + ?> diff --git a/lib/environmentlib.php b/lib/environmentlib.php index 515d4c56ed..09f5d1178c 100644 --- a/lib/environmentlib.php +++ b/lib/environmentlib.php @@ -279,7 +279,7 @@ function load_environment_xml() { $file = $CFG->dataroot.'/environment/environment.xml'; if (!is_file($file) || !is_readable($file) || !$contents = file_get_contents($file)) { /// Fallback to fixed $CFG->admin/environment.xml - $file = $CFG->dirroot.'/'.$CFG->admin.'/environment.xml'; + $file = $CFG->dirroot.'/admin/environment.xml'; if (!is_file($file) || !is_readable($file) || !$contents = file_get_contents($file)) { return false; } diff --git a/theme/index.php b/theme/index.php index c50ecc2d21..e6a419092a 100644 --- a/theme/index.php +++ b/theme/index.php @@ -1,11 +1,12 @@ dirroot . '/admin/adminlib.php'); + require_once($CFG->libdir.'/adminlib.php'); $choose = optional_param("choose",'',PARAM_FILE); // set this theme as default - admin_externalpage_setup('themeselector'); + $adminroot = admin_get_root(); + admin_externalpage_setup('themeselector', $adminroot); unset($SESSION->theme); @@ -27,7 +28,7 @@ } if (set_config("theme", $choose)) { theme_setup($choose); - admin_externalpage_print_header(); + admin_externalpage_print_header($adminroot); print_heading(get_string("themesaved")); print_continue("$CFG->wwwroot/"); @@ -42,7 +43,7 @@ echo format_text(implode('', $file), FORMAT_MOODLE); print_simple_box_end(); } - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); exit; } else { error("Could not set the theme!"); @@ -131,7 +132,7 @@ $options["sub"] = "themes"; print_single_button("$CFG->wwwroot/doc/index.php", $options, get_string("howtomakethemes")); echo ""; - admin_externalpage_print_footer(); + admin_externalpage_print_footer($adminroot); ?> -- 2.39.5