| blob | 542105a6fbdbb8db32f4f32b1cff6e4e1fbe5f23 |
1 <?php
3 /**
4 * adminlib.php - Contains functions that only administrators will ever need to use
5 *
6 * @author Martin Dougiamas and many others
7 * @version $Id$
8 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
9 * @package moodlecore
10 */
20 // something really wrong is going on in main upgrade script
22 }
26 }
27 }
30 //TODO
31 }
34 //TODO
35 }
38 //TODO
39 }
42 //TODO
43 }
45 /**
46 * Upgrade plugins
47 *
48 * @uses $db
49 * @uses $CFG
50 * @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
51 * @param string $dir The directory where the plugins are located (e.g. 'question/questiontypes')
52 * @param string $return The url to prompt the user to continue to
53 */
57 /// Let's know if the header has been printed, so the funcion is being called embedded in an outer page
74 }
81 }
85 }
89 }
100 build_navigation(array(array('name' => $strpluginsetup, 'link' => null, 'type' => 'misc'))), '',
102 }
107 }
108 }
116 }
119 // do nothing
123 build_navigation(array(array('name' => $strpluginsetup, 'link' => null, 'type' => 'misc'))), '',
125 }
133 /// Both old .sql files and new install.xml are supported
134 /// but we priorize install.xml (XMLDB) if present
142 }
145 /// Continue with the instalation, roles and other stuff
147 /// OK so far, now update the plugins record
150 /// Install capabilities
153 }
154 /// Install events
157 /// Run local install function if there is one
164 }
165 }
166 }
171 }
173 /// Run de old and new upgrade functions for the module
177 /// First, the old function if exists
185 }
187 /// Then, the new function if exists and the old one was ok
195 }
198 /// Now analyze upgrade results
200 // OK so far, now update the plugins record
204 }
208 notify('Upgrading '. $plugin->name .' from '. $CFG->$pluginversion .' to '. $plugin->version .' FAILED!');
209 }
210 }
214 error('Version mismatch: '. $plugin->name .' can\'t downgrade '. $CFG->$pluginversion .' -> '. $plugin->version .' !');
215 }
216 }
224 }
225 }
227 /**
228 * Find and check all modules and load them up or upgrade them if necessary
229 *
230 * @uses $db
231 * @uses $CFG
232 * @param string $return The url to prompt the user to continue to
233 * @todo Finish documenting this function
234 */
241 }
250 }
261 }
268 }
272 }
276 }
287 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
289 }
294 }
295 }
303 // do nothing
305 /// If versions say that we need to upgrade but no upgrade files are available, notify and continue
310 }
313 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
315 }
319 /// Run de old and new upgrade functions for the module
323 /// First, the old function if exists
331 }
335 }
337 /// Then, the new function if exists and the old one was ok
345 }
348 /// Now analyze upgrade results
350 // OK so far, now update the modules record
354 }
359 notify('Upgrading '. $module->name .' from '. $currmodule->version .' to '. $module->version .' FAILED!');
360 }
362 /// Update the capabilities table?
365 }
372 error('Version mismatch: '. $module->name .' can\'t downgrade '. $currmodule->version .' -> '. $module->version .' !');
373 }
378 build_navigation(array(array('name' => $strmodulesetup, 'link' => null, 'type' => 'misc'))), '',
380 }
387 /// Both old .sql files and new install.xml are supported
388 /// but we priorize install.xml (XMLDB) if present
393 }
397 /// Continue with the installation, roles and other stuff
401 /// Capabilities
404 }
406 /// Events
409 /// Run local install function if there is one
414 }
415 }
421 }
424 }
425 }
427 /// Check submodules of this module if necessary
432 }
435 /// Run any defaults or final code that is necessary for this module
438 // Insert default values for any important configuration variables
445 }
446 }
447 }
448 }
449 }
457 }
458 }
460 /**
461 * Try to obtain or release the cron lock.
462 *
463 * @param string $name name of lock
464 * @param int $until timestamp when this lock considered stale, null means remove lock unconditionaly
465 * @param bool $ignorecurrent ignore current lock state, usually entend previous lock
466 * @return bool true if lock obtained
467 */
472 }
474 // remove lock by force == remove from config table
478 }
481 // read value from db - other processes might have changed it
485 //lock active
487 }
488 }
492 }
501 }
503 // Are we done?
510 }
512 }
519 echo '<div id="bar'.$thisbarid.'" style="border-style:solid;border-width:1px;width:500px;height:50px;">';
520 echo '<div id="slider'.$thisbarid.'" style="border-style:solid;border-width:1px;height:48px;width:10px;background-color:green;"></div>';
525 }
539 }
545 }
546 }
548 // Don't call this function directly, it's called from print_progress.
552 }
554 echo 'document.getElementById("text'.$thisbarid.'").innerHTML = "'.addslashes($donetext).'";'."\n";
557 }
563 $linktoscrolltoerrors = '<script type="text/javascript">var installautopilot = true;</script>'."\n";
565 $linktoscrolltoerrors = '<script type="text/javascript">var installautopilot = false;</script>'."\n";
566 }
567 $linktoscrolltoerrors .= '<script type="text/javascript" src="' . $CFG->wwwroot . '/lib/scroll_to_errors.js"></script>';
570 }
592 }
596 }
598 // Assign the default admin roles to the new user.
601 }
605 }
609 // Log the user in.
617 }
618 }
620 ////////////////////////////////////////////////
621 /// upgrade logging functions
622 ////////////////////////////////////////////////
626 // I did not find out how to use static variable in callback function,
627 // the problem was that I could not flush the static buffer :-(
630 /**
631 * Check if upgrade is already running.
632 *
633 * If anything goes wrong due to missing call to upgrade_log_finish()
634 * just restart the browser.
635 *
636 * @param string warning message indicating upgrade is already running
637 * @param int page reload timeout
638 */
643 }
644 }
646 /**
647 * Start logging of output into file (if not disabled) and
648 * prevent aborting and concurrent execution of upgrade script.
649 *
650 * Please note that you can not write into session variables after calling this function!
651 *
652 * This function may be called repeatedly.
653 */
659 }
665 }
667 ob_start('upgrade_log_callback', 2); // function for logging to disk; flush each line of text ASAP
669 }
671 /**
672 * Terminate logging of output, flush all data, allow script aborting
673 * and reopen session for writing. Function error() does terminate the logging too.
674 *
675 * Please make sure that each upgrade_log_start() is properly terminated by
676 * this function or error().
677 *
678 * This function may be called repeatedly.
679 */
685 }
687 @ob_end_flush();
691 }
695 }
698 }
702 }
704 }
706 /**
707 * Callback function for logging into files. Not more than one file is created per minute,
708 * upgrade session (terminated by upgrade_log_finish()) is always stored in one file.
709 *
710 * This function must not output any characters or throw warnigns and errors!
711 */
715 if (empty($CFG->disableupgradelogging) and ($string != '') and ($upgradeloghandle !== 'error')) {
716 if ($upgradeloghandle or ($upgradeloghandle = @fopen($CFG->dataroot.'/upgradelogs/upg_'.date('Ymd-Hi').'.html', 'a'))) {
721 }
724 }
725 }
727 }
729 /**
730 * Test if and critical warnings are present
731 * @return bool
732 */
738 }
746 }
747 }
750 }
752 /**
753 * Try to verify that dataroot is not accessible from web.
754 * It is not 100% correct but might help to reduce number of vulnerable sites.
755 *
756 * Protection from httpd.conf and .htaccess is not detected properly.
757 * @param bool $fetchtest try to test public access by fetching file
758 * @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING migth be problematic
759 */
773 }
774 }
781 }
785 }
787 // now try all methods to fetch a test file using http protocol
795 }
799 }
802 // hmm, strange
804 }
817 }
818 }
820 }
826 }
827 }
846 }
847 }
852 }
853 }
856 }
858 /// =============================================================================================================
859 /// administration tree classes and functions
862 // n.b. documentation is still in progress for this code
864 /// INTRODUCTION
866 /// This file performs the following tasks:
867 /// -it defines the necessary objects and interfaces to build the Moodle
868 /// admin hierarchy
869 /// -it defines the admin_externalpage_setup(), admin_externalpage_print_header(),
870 /// and admin_externalpage_print_footer() functions used on admin pages
872 /// ADMIN_SETTING OBJECTS
874 /// Moodle settings are represented by objects that inherit from the admin_setting
875 /// class. These objects encapsulate how to read a setting, how to write a new value
876 /// to a setting, and how to appropriately display the HTML to modify the setting.
878 /// ADMIN_SETTINGPAGE OBJECTS
880 /// The admin_setting objects are then grouped into admin_settingpages. The latter
881 /// appear in the Moodle admin tree block. All interaction with admin_settingpage
882 /// objects is handled by the admin/settings.php file.
884 /// ADMIN_EXTERNALPAGE OBJECTS
886 /// There are some settings in Moodle that are too complex to (efficiently) handle
887 /// with admin_settingpages. (Consider, for example, user management and displaying
888 /// lists of users.) In this case, we use the admin_externalpage object. This object
889 /// places a link to an external PHP file in the admin tree block.
891 /// If you're using an admin_externalpage object for some settings, you can take
892 /// advantage of the admin_externalpage_* functions. For example, suppose you wanted
893 /// to add a foo.php file into admin. First off, you add the following line to
894 /// admin/settings/first.php (at the end of the file) or to some other file in
895 /// admin/settings:
897 /// $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
898 /// $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
900 /// Next, in foo.php, your file structure would resemble the following:
902 /// require_once('.../config.php');
903 /// require_once($CFG->libdir.'/adminlib.php');
904 /// admin_externalpage_setup('foo');
905 /// // functionality like processing form submissions goes here
906 /// admin_externalpage_print_header();
907 /// // your HTML goes here
908 /// admin_externalpage_print_footer();
910 /// The admin_externalpage_setup() function call ensures the user is logged in,
911 /// and makes sure that they have the proper role permission to access the page.
913 /// The admin_externalpage_print_header() function prints the header (it figures
914 /// out what category and subcategories the page is classified under) and ensures
915 /// that you're using the admin pagelib (which provides the admin tree block and
916 /// the admin bookmarks block).
918 /// The admin_externalpage_print_footer() function properly closes the tables
919 /// opened up by the admin_externalpage_print_header() function and prints the
920 /// standard Moodle footer.
922 /// ADMIN_CATEGORY OBJECTS
924 /// Above and beyond all this, we have admin_category objects. These objects
925 /// appear as folders in the admin tree block. They contain admin_settingpage's,
926 /// admin_externalpage's, and other admin_category's.
928 /// OTHER NOTES
930 /// admin_settingpage's, admin_externalpage's, and admin_category's all inherit
931 /// from part_of_admin_tree (a pseudointerface). This interface insists that
932 /// a class has a check_access method for access permissions, a locate method
933 /// used to find a specific node in the admin tree and find parent path.
935 /// admin_category's inherit from parentable_part_of_admin_tree. This pseudo-
936 /// interface ensures that the class implements a recursive add function which
937 /// accepts a part_of_admin_tree object and searches for the proper place to
938 /// put it. parentable_part_of_admin_tree implies part_of_admin_tree.
940 /// Please note that the $this->name field of any part_of_admin_tree must be
941 /// UNIQUE throughout the ENTIRE admin tree.
943 /// The $this->name field of an admin_setting object (which is *not* part_of_
944 /// admin_tree) must be unique on the respective admin_settingpage where it is
945 /// used.
948 /// CLASS DEFINITIONS /////////////////////////////////////////////////////////
950 /**
951 * Pseudointerface for anything appearing in the admin tree
952 *
953 * The pseudointerface that is implemented by anything that appears in the admin tree
954 * block. It forces inheriting classes to define a method for checking user permissions
955 * and methods for finding something in the admin tree.
956 *
957 * @author Vincenzo K. Marcovecchio
958 * @package admin
959 */
962 /**
963 * Finds a named part_of_admin_tree.
964 *
965 * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
966 * and not parentable_part_of_admin_tree, then this function should only check if
967 * $this->name matches $name. If it does, it should return a reference to $this,
968 * otherwise, it should return a reference to NULL.
969 *
970 * If a class inherits parentable_part_of_admin_tree, this method should be called
971 * recursively on all child objects (assuming, of course, the parent object's name
972 * doesn't match the search criterion).
973 *
974 * @param string $name The internal name of the part_of_admin_tree we're searching for.
975 * @return mixed An object reference or a NULL reference.
976 */
978 trigger_error('Admin class does not implement method <strong>locate()</strong>', E_USER_WARNING);
980 }
982 /**
983 * Removes named part_of_admin_tree.
984 *
985 * @param string $name The internal name of the part_of_admin_tree we want to remove.
986 * @return bool success.
987 */
989 trigger_error('Admin class does not implement method <strong>prune()</strong>', E_USER_WARNING);
991 }
993 /**
994 * Search using query
995 * @param strin query
996 * @return mixed array-object structure of found settings and pages
997 */
999 trigger_error('Admin class does not implement method <strong>search()</strong>', E_USER_WARNING);
1001 }
1003 /**
1004 * Verifies current user's access to this part_of_admin_tree.
1005 *
1006 * Used to check if the current user has access to this part of the admin tree or
1007 * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
1008 * then this method is usually just a call to has_capability() in the site context.
1009 *
1010 * If a class inherits parentable_part_of_admin_tree, this method should return the
1011 * logical OR of the return of check_access() on all child objects.
1012 *
1013 * @return bool True if the user has access, false if she doesn't.
1014 */
1016 trigger_error('Admin class does not implement method <strong>check_access()</strong>', E_USER_WARNING);
1018 }
1020 /**
1021 * Mostly usefull for removing of some parts of the tree in admin tree block.
1022 *
1023 * @return True is hidden from normal list view
1024 */
1026 trigger_error('Admin class does not implement method <strong>is_hidden()</strong>', E_USER_WARNING);
1028 }
1029 }
1031 /**
1032 * Pseudointerface implemented by any part_of_admin_tree that has children.
1033 *
1034 * The pseudointerface implemented by any part_of_admin_tree that can be a parent
1035 * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
1036 * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
1037 * include an add method for adding other part_of_admin_tree objects as children.
1038 *
1039 * @author Vincenzo K. Marcovecchio
1040 * @package admin
1041 */
1044 /**
1045 * Adds a part_of_admin_tree object to the admin tree.
1046 *
1047 * Used to add a part_of_admin_tree object to this object or a child of this
1048 * object. $something should only be added if $destinationname matches
1049 * $this->name. If it doesn't, add should be called on child objects that are
1050 * also parentable_part_of_admin_tree's.
1051 *
1052 * @param string $destinationname The internal name of the new parent for $something.
1053 * @param part_of_admin_tree &$something The object to be added.
1054 * @return bool True on success, false on failure.
1055 */
1059 }
1061 }
1063 /**
1064 * The object used to represent folders (a.k.a. categories) in the admin tree block.
1065 *
1066 * Each admin_category object contains a number of part_of_admin_tree objects.
1067 *
1068 * @author Vincenzo K. Marcovecchio
1069 * @package admin
1070 */
1073 /**
1074 * @var mixed An array of part_of_admin_tree objects that are this object's children
1075 */
1078 /**
1079 * @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
1080 */
1083 /**
1084 * @var string The displayed name for this category. Usually obtained through get_string()
1085 */
1088 /**
1089 * @var bool Should this category be hidden in admin tree block?
1090 */
1093 /**
1094 * paths
1095 */
1099 /**
1100 * Constructor for an empty admin category
1101 *
1102 * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
1103 * @param string $visiblename The displayed named for this category. Usually obtained through get_string()
1104 * @param bool $hidden hide category in admin tree block
1105 */
1111 }
1113 /**
1114 * Returns a reference to the part_of_admin_tree object with internal name $name.
1115 *
1116 * @param string $name The internal name of the object we want.
1117 * @param bool $findpath initialize path and visiblepath arrays
1118 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1119 */
1125 }
1127 }
1133 }
1134 }
1139 }
1142 }
1144 /**
1145 * Search using query
1146 * @param strin query
1147 * @return mixed array-object structure of found settings and pages
1148 */
1156 }
1158 }
1160 }
1162 /**
1163 * Removes part_of_admin_tree object with internal name $name.
1164 *
1165 * @param string $name The internal name of the object we want to remove.
1166 * @return bool success
1167 */
1172 }
1176 // found it!
1179 }
1182 }
1183 }
1185 }
1187 /**
1188 * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
1189 *
1190 * @param string $destinationame The internal name of the immediate parent that we want for $something.
1191 * @param mixed $something A part_of_admin_tree or setting instanceto be added.
1192 * @return bool True if successfully added, false if $something can not be added.
1193 */
1199 }
1205 }
1212 }
1214 }
1216 /**
1217 * Checks if the user has access to anything in this category.
1218 *
1219 * @return bool True if the user has access to atleast one child in this category, false otherwise.
1220 */
1225 }
1226 }
1228 }
1230 /**
1231 * Is this category hidden in admin tree block?
1232 *
1233 * @return bool True if hidden
1234 */
1237 }
1238 }
1241 /**
1242 * list of errors
1243 */
1246 /**
1247 * search query
1248 */
1251 /**
1252 * full tree flag - true means all settings required, false onlypages required
1253 */
1262 }
1263 }
1265 /**
1266 * Links external PHP pages into the admin tree.
1267 *
1268 * See detailed usage example at the top of this document (adminlib.php)
1269 *
1270 * @author Vincenzo K. Marcovecchio
1271 * @package admin
1272 */
1275 /**
1276 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1277 */
1280 /**
1281 * @var string The displayed name for this external page. Usually obtained through get_string().
1282 */
1285 /**
1286 * @var string The external URL that we should link to when someone requests this external page.
1287 */
1290 /**
1291 * @var string The role capability/permission a user must have to access this external page.
1292 */
1295 /**
1296 * @var object The context in which capability/permission should be checked, default is site context.
1297 */
1300 /**
1301 * @var bool hidden in admin tree block.
1302 */
1305 /**
1306 * visible path
1307 */
1311 /**
1312 * Constructor for adding an external page into the admin tree.
1313 *
1314 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1315 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1316 * @param string $url The external URL that we should link to when someone requests this external page.
1317 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1318 */
1319 function admin_externalpage($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1327 }
1330 }
1332 /**
1333 * Returns a reference to the part_of_admin_tree object with internal name $name.
1334 *
1335 * @param string $name The internal name of the object we want.
1336 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1337 */
1343 }
1348 }
1349 }
1353 }
1355 /**
1356 * Search using query
1357 * @param strin query
1358 * @return mixed array-object structure of found settings and pages
1359 */
1368 }
1376 }
1377 }
1379 /**
1380 * Determines if the current user has access to this external page based on $this->req_capability.
1381 * @return bool True if user has access, false otherwise.
1382 */
1386 }
1391 }
1392 }
1394 }
1396 /**
1397 * Is this external page hidden in admin tree block?
1398 *
1399 * @return bool True if hidden
1400 */
1403 }
1405 }
1407 /**
1408 * Used to group a number of admin_setting objects into a page and add them to the admin tree.
1409 *
1410 * @author Vincenzo K. Marcovecchio
1411 * @package admin
1412 */
1415 /**
1416 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1417 */
1420 /**
1421 * @var string The displayed name for this external page. Usually obtained through get_string().
1422 */
1424 /**
1425 * @var mixed An array of admin_setting objects that are part of this setting page.
1426 */
1429 /**
1430 * @var string The role capability/permission a user must have to access this external page.
1431 */
1434 /**
1435 * @var object The context in which capability/permission should be checked, default is site context.
1436 */
1439 /**
1440 * @var bool hidden in admin tree block.
1441 */
1444 /**
1445 * paths
1446 */
1450 // see admin_externalpage
1451 function admin_settingpage($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1459 }
1462 }
1464 // see admin_category
1470 }
1475 }
1476 }
1484 }
1485 }
1492 }
1501 }
1509 }
1510 }
1514 }
1516 /**
1517 * 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
1518 * n.b. each admin_setting in an admin_settingpage must have a unique internal name
1519 * @param object $setting is the admin_setting object you want to add
1520 * @return true if successful, false if not
1521 */
1526 }
1530 }
1532 // see admin_externalpage
1536 }
1541 }
1542 }
1544 }
1546 /**
1547 * outputs this page as html in a table (suitable for inclusion in an admin pagetype)
1548 * returns a string of the html
1549 */
1561 }
1562 }
1564 }
1567 }
1569 /**
1570 * Is this settigns page hidden in admin tree block?
1571 *
1572 * @return bool True if hidden
1573 */
1576 }
1578 }
1581 /**
1582 * Admin settings class. Only exists on setting pages.
1583 * Read & write happens at this level; no authentication.
1584 */
1594 /**
1595 * Constructor
1596 * @param $name string unique ascii name
1597 * @param $visiblename string localised name
1598 * @param strin $description localised long description
1599 * @param mixed $defaultsetting string or array depending on implementation
1600 */
1606 }
1610 }
1614 }
1625 }
1636 }
1637 }
1638 }
1647 }
1648 }
1650 /**
1651 * Returns current value of this setting
1652 * @return mixed array or string depending on instance, NULL means not set yet
1653 */
1655 // has to be overridden
1657 }
1659 /**
1660 * Returns default setting if exists
1661 * @return mixed array or string depending on instance; NULL means no default, user must supply
1662 */
1665 }
1667 /**
1668 * Store new setting
1669 * @param mixed string or array, must not be NULL
1670 * @return '' if ok, string error message otherwise
1671 */
1673 // should be overridden
1675 }
1677 /**
1678 * Return part of form with setting
1679 * @param mixed data array or string depending on setting
1680 * @return string
1681 */
1683 // should be overridden
1685 }
1687 /**
1688 * function called if setting updated - cleanup, cache reset, etc.
1689 */
1692 }
1694 /**
1695 * Is setting related to query text - used when searching
1696 * @param string $query
1697 * @return bool
1698 */
1702 }
1706 }
1709 }
1715 }
1716 }
1717 }
1723 }
1724 }
1725 }
1727 }
1728 }
1730 /**
1731 * No setting - just heading and text.
1732 */
1734 /**
1735 * not a setting, just text
1736 * @param string $name of setting
1737 * @param string $heading heading
1738 * @param string $information text in box
1739 */
1742 }
1746 }
1750 }
1753 // do not write any setting
1755 }
1760 $return .= print_heading('<a name="'.$this->name.'">'.highlightfast($query, $this->visiblename).'</a>', '', 3, 'main', true);
1761 }
1763 $return .= print_box(highlight($query, $this->description), 'generalbox formsettingheading', '', true);
1764 }
1766 }
1767 }
1769 /**
1770 * The most flexibly setting, user is typing text
1771 */
1777 /**
1778 * config text contructor
1779 * @param string $name of setting
1780 * @param string $visiblename localised
1781 * @param string $description long localised info
1782 * @param string $defaultsetting
1783 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
1784 * @param int $size default field size
1785 */
1786 function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) {
1792 }
1794 }
1798 }
1802 // do not complain if '' used instead of 0
1804 }
1805 // $data is a string
1809 }
1811 }
1813 /**
1814 * Validate data before storage
1815 * @param string data
1816 * @return mixed true if ok string if error found
1817 */
1824 }
1835 }
1836 }
1837 }
1843 '<div class="form-text defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>',
1845 }
1846 }
1848 /**
1849 * General text area without html editor.
1850 */
1855 function admin_setting_configtextarea($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
1858 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype);
1859 }
1867 }
1870 '<div class="form-textarea" ><textarea rows="'.$this->rows.'" cols="'.$this->cols.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'">'.s($data).'</textarea></div>',
1872 }
1873 }
1875 /**
1876 * Password field, allows unmasking of password
1877 */
1879 /**
1880 * Constructor
1881 * @param string $name of setting
1882 * @param string $visiblename localised
1883 * @param string $description long localised info
1884 * @param string $defaultsetting default password
1885 */
1886 function admin_setting_configpasswordunmask($name, $visiblename, $description, $defaultsetting) {
1887 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, PARAM_RAW, 30);
1888 }
1894 //<![CDATA[
1895 document.write(\'<span class="unmask"><input id="'.$id.'unmask" value="1" type="checkbox" onclick="unmaskPassword(\\\''.$id.'\\\')"/><label for="'.$id.'unmask">'.addslashes_js($unmask).'<\/label><\/span>\');
1897 //]]>
1900 '<div class="form-password"><input type="password" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$unmaskjs.'</div>',
1902 }
1903 }
1905 /**
1906 * Path to directory
1907 */
1909 /**
1910 * Constructor
1911 * @param string $name of setting
1912 * @param string $visiblename localised
1913 * @param string $description long localised info
1914 * @param string $defaultdirectory default directory location
1915 */
1917 parent::admin_setting_configtext($name, $visiblename, $description, $defaultdirectory, PARAM_RAW, 50);
1918 }
1928 }
1931 }
1934 '<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
1936 }
1937 }
1939 /**
1940 * Path to executable file
1941 */
1952 }
1955 }
1958 '<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
1960 }
1961 }
1963 /**
1964 * Path to directory
1965 */
1975 }
1978 }
1981 '<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
1983 }
1984 }
1986 /**
1987 * Checkbox
1988 */
1993 /**
1994 * Constructor
1995 * @param string $name of setting
1996 * @param string $visiblename localised
1997 * @param string $description long localised info
1998 * @param string $defaultsetting
1999 * @param string $yes value used when checked
2000 * @param string $no value used when not checked
2001 */
2002 function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
2006 }
2010 }
2017 }
2019 }
2029 }
2032 }
2038 }
2041 '<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> '
2042 .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' /></div>',
2044 }
2045 }
2047 /**
2048 * Multiple checkboxes, each represents different value, stored in csv format
2049 */
2053 /**
2054 * Constructor
2055 * @param string $name of setting
2056 * @param string $visiblename localised
2057 * @param string $description long localised info
2058 * @param array $defaultsetting array of selected
2059 * @param array $choices array of $value=>$label for each checkbox
2060 */
2061 function admin_setting_configmulticheckbox($name, $visiblename, $description, $defaultsetting, $choices) {
2064 }
2066 /**
2067 * This function may be used in ancestors for lazy loading of choices
2068 * @return true if loaded, false if error
2069 */
2071 /*
2072 if (is_array($this->choices)) {
2073 return true;
2074 }
2075 .... load choices here
2076 */
2078 }
2080 /**
2081 * Is setting related to query text - used when searching
2082 * @param string $query
2083 * @return bool
2084 */
2088 }
2091 }
2097 }
2098 }
2100 }
2106 }
2109 }
2111 }
2116 }
2119 }
2125 }
2126 }
2127 return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin');
2128 }
2133 }
2137 }
2142 }
2143 }
2144 }
2153 }
2156 }
2158 $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
2160 }
2168 }
2171 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2176 }
2178 }
2181 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
2183 }
2184 }
2186 /**
2187 * Multiple checkboxes 2, value stored as string 00101011
2188 */
2194 }
2197 }
2205 }
2206 }
2208 }
2213 }
2216 }
2223 }
2224 }
2226 }
2227 }
2229 /**
2230 * Select one value from list
2231 */
2235 /**
2236 * Constructor
2237 * @param string $name of setting
2238 * @param string $visiblename localised
2239 * @param string $description long localised info
2240 * @param string $defaultsetting
2241 * @param array $choices array of $value=>$label for each selection
2242 */
2243 function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) {
2246 }
2248 /**
2249 * This function may be used in ancestors for lazy loading of choices
2250 * @return true if loaded, false if error
2251 */
2253 /*
2254 if (is_array($this->choices)) {
2255 return true;
2256 }
2257 .... load choices here
2258 */
2260 }
2265 }
2268 }
2273 }
2276 }
2277 }
2279 }
2283 }
2288 }
2291 }
2294 }
2299 }
2306 }
2311 //first run
2312 } else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) {
2313 // no warning
2318 }
2319 }
2321 $return = '<div class="form-select defaultsnext"><select id="'.$this->get_id().'" name="'.$this->get_full_name().'">';
2323 // the string cast is needed because key may be integer - 0 is equal to most strings!
2324 $return .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>';
2325 }
2328 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning, $defaultinfo, $query);
2329 }
2331 }
2333 /**
2334 * Select multiple items from list
2335 */
2337 /**
2338 * Constructor
2339 * @param string $name of setting
2340 * @param string $visiblename localised
2341 * @param string $description long localised info
2342 * @param array $defaultsetting array of selected items
2343 * @param array $choices array of $value=>$label for each list item
2344 */
2345 function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) {
2346 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices);
2347 }
2353 }
2356 }
2358 }
2363 }
2366 }
2374 }
2376 }
2378 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2379 }
2381 /**
2382 * Is setting related to query text - used when searching
2383 * @param string $query
2384 * @return bool
2385 */
2389 }
2392 }
2398 }
2399 }
2401 }
2406 }
2411 }
2414 }
2417 $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2418 $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="10" multiple="multiple">';
2424 }
2427 }
2430 }
2438 }
2441 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
2442 }
2443 }
2445 /**
2446 * Time selector
2447 * this is a liiitle bit messy. we're using two selects, but we're returning
2448 * them as an array named after $name (so we only use $name2 internally for the setting)
2449 */
2453 /**
2454 * Constructor
2455 * @param string $hoursname setting for hours
2456 * @param string $minutesname setting for hours
2457 * @param string $visiblename localised
2458 * @param string $description long localised info
2459 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
2460 */
2461 function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
2464 }
2471 }
2474 }
2479 }
2481 $result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']);
2483 }
2492 }
2497 $return .= '<option value="'.$i.'"'.($i == $data['h'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2498 }
2499 $return .= '</select>:<select id="'.$this->get_id().'m" name="'.$this->get_full_name().'[m]">';
2501 $return .= '<option value="'.$i.'"'.($i == $data['m'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2502 }
2504 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
2505 }
2507 }
2509 /**
2510 * Special checkbox for calendar - resets SESSION vars.
2511 */
2514 parent::admin_setting_configcheckbox('calendar_adminseesall', get_string('adminseesall', 'admin'),
2516 }
2522 }
2523 }
2525 /**
2526 * Special select for settings that are altered in setup.php and can not be altered on the fly
2527 */
2530 // read directly from db!
2532 }
2536 // do not change active CFG setting!
2541 }
2542 }
2544 /**
2545 * Special select for frontpage - stores data in course table
2546 */
2551 }
2556 }
2563 }
2564 }
2566 /**
2567 * Special select - lists on the frontpage - hacky
2568 */
2580 }
2585 }
2593 }
2595 }
2600 }
2603 }
2605 }
2610 }
2616 }
2618 }
2619 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2620 }
2628 }
2629 }
2635 }
2636 $return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
2638 $return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ? ' selected="selected"' : '').'>'.$value.'</option>';
2639 }
2643 }
2644 }
2647 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2648 }
2649 }
2651 /**
2652 * Special checkbox for frontpage - stores data in course table
2653 */
2658 }
2666 }
2667 }
2669 /**
2670 * Special text for frontpage - stores data in course table.
2671 * Empty string means not set here. Manual setting is required.
2672 */
2677 }
2683 }
2688 }
2689 }
2696 }
2703 }
2704 }
2706 /**
2707 * Special text editor for site description.
2708 */
2711 parent::admin_setting('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
2712 }
2717 }
2725 }
2731 $return = '<div class="form-htmlarea">'.print_textarea($CFG->adminusehtmleditor, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true).'</div>';
2733 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2734 }
2735 }
2765 }
2772 }
2781 }
2783 }
2787 // there miiight be an easier way to do this :)
2788 // if this is changed, make sure the $defaults array above is modified so that this
2789 // function processes it correctly
2799 }
2800 }
2806 }
2807 }
2809 return ($this->config_write($this->name, implode(';', $result)) ? '' : get_string('errorsetting', 'admin'));
2810 }
2816 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
2818 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
2819 }
2822 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2823 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
2825 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
2828 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2829 }
2831 }
2899 }
2906 }
2915 }
2917 }
2921 // there miiight be an easier way to do this :)
2922 // if this is changed, make sure the $defaults array above is modified so that this
2923 // function processes it correctly
2933 }
2934 }
2940 }
2941 }
2943 return ($this->config_write($this->name, implode('{;}', $result)) ? '' : get_string('errorsetting', 'admin').$this->visiblename.'<br />');
2944 }
2950 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
2952 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
2953 }
2956 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2957 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
2959 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
2962 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2963 }
2965 }
2967 /**
2968 * Setting for spellchecker language selection.
2969 */
2977 }
2980 // function borrowed from the old moodle/admin/editor.php, slightly modified
2981 // Get all installed dictionaries in the system
2984 }
2992 // If aspellpath isn't set don't even bother ;-)
2996 }
2998 // Do we have access to popen function?
3002 }
3010 }
3014 }
3021 }
3023 }
3027 }
3029 }
3030 }
3039 // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead
3079 }
3085 }
3088 }
3090 }
3095 }
3102 }
3105 }
3106 }
3107 return ($this->config_write($this->name, implode(' ', $result)) ? '' : get_string('errorsetting', 'admin'));
3108 }
3114 // checkboxes with input name="$this->name[$key]" value="1"
3115 // we do 15 fields per column
3119 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
3126 }
3129 $return .= ($value == '' ? get_string($key,'editor') : '<img width="18" height="18" src="'.$CFG->wwwroot.'/lib/editor/htmlarea/images/'.$value.'" alt="'.get_string($key,'editor').'" title="'.get_string($key,'editor').'" />').' ';
3130 $return .= '<input type="checkbox" class="form-checkbox" value="1" id="'.$this->get_id().$key.'" name="'.$this->get_full_name().'['.$key.']"'.(in_array($key,$data) ? ' checked="checked"' : '').' /> ';
3135 }
3136 }
3142 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
3143 }
3144 }
3146 /**
3147 * Special setting for limiting of the list of available languages.
3148 */
3151 parent::admin_setting_configtext('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS);
3152 }
3158 }
3159 }
3161 /**
3162 * Course category selection
3163 */
3167 }
3174 }
3177 }
3178 }
3182 parent::admin_setting_configmulticheckbox2('backup_sche_weekdays', get_string('schedule'), get_string('backupschedulehelp'), array(), NULL);
3184 }
3189 }
3194 }
3196 }
3197 }
3199 /**
3200 * Special debug setting
3201 */
3204 parent::admin_setting_configselect('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE, NULL);
3205 }
3210 }
3217 }
3218 }
3228 }
3234 }
3237 }
3242 }
3243 }
3245 }
3250 }
3255 }
3257 }
3260 // The order matters very much because of the implied numeric keys
3263 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
3265 $return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
3266 }
3269 $return .= '<td><input type="checkbox" class="form-checkbox" id="'.$this->get_id().$index.'" name="'.$this->get_full_name().'[]" value="'.$index.'" '.(in_array("$index", $data) ? 'checked="checked"' : '').' /></td>';
3270 }
3273 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
3275 }
3276 }
3279 /**
3280 * Graded roles in gradebook
3281 */
3284 parent::admin_setting_configmulticheckbox('gradebookroles', get_string('gradebookroles', 'admin'),
3286 }
3292 }
3295 }
3300 }
3304 }
3305 }
3311 }
3316 }
3317 }
3319 }
3320 }
3331 // force full regrading
3333 }
3336 }
3337 }
3339 /**
3340 * Which roles to show on course decription page
3341 */
3344 parent::admin_setting_configmulticheckbox('coursemanager', get_string('coursemanager', 'admin'),
3346 }
3351 }
3356 }
3358 }
3360 }
3366 }
3371 }
3372 }
3374 }
3375 }
3377 /**
3378 * Primary grade export plugin - has state tracking.
3379 */
3384 }
3389 }
3395 }
3396 }
3398 }
3399 }
3401 /**
3402 * Grade category settings
3403 */
3408 function admin_setting_gradecat_combo($name, $visiblename, $description, $defaultsetting, $choices) {
3411 }
3421 }
3428 }
3440 }
3449 // force regrade if needed
3453 }
3459 }
3460 }
3472 }
3475 }
3478 }
3483 }
3487 $return .= '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
3489 // the string cast is needed because key may be integer - 0 is equal to most strings!
3490 $return .= '<option value="'.$key.'"'.((string)$key==$value ? ' selected="selected"' : '').'>'.$val.'</option>';
3491 }
3493 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ? 'checked="checked"' : '').' />'
3495 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ? 'checked="checked"' : '').' />'
3499 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
3500 }
3501 }
3504 /**
3505 * Selection of grade report in user profiles
3506 */
3509 parent::admin_setting_configselect('grade_profilereport', get_string('profilereport', 'grades'), get_string('configprofilereport', 'grades'), 'user', null);
3510 }
3515 }
3526 $this->choices[$plugin] = get_string('modulename', 'gradereport_'.$plugin, NULL, $CFG->dirroot.'/grade/report/'.$plugin.'/lang/');
3527 }
3528 }
3529 }
3531 }
3532 }
3534 /**
3535 * Special class for register auth selection
3536 */
3539 parent::admin_setting_configselect('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), '', null);
3540 }
3548 }
3549 }
3556 }
3566 }
3567 // Get the auth title (from core or own auth lang files)
3570 }
3572 }
3573 }
3575 /**
3576 * Module manage page
3577 */
3581 parent::admin_externalpage('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
3582 }
3587 }
3596 }
3601 }
3602 }
3603 }
3611 }
3612 }
3613 }
3615 /**
3616 * Enrolment manage page
3617 */
3621 parent::admin_externalpage('enrolment', get_string('enrolments'), $CFG->wwwroot . '/'.$CFG->admin.'/enrol.php');
3622 }
3627 }
3637 }
3642 }
3643 }
3644 }
3645 //ugly harcoded hacks
3648 } else if (strpos($textlib->strtolower(get_string('sendcoursewelcomemessage', 'admin')), $query) !== false) {
3650 } else if (strpos($textlib->strtolower(get_string('configsendcoursewelcomemessage', 'admin')), $query) !== false) {
3652 } else if (strpos($textlib->strtolower(get_string('configenrolmentplugins', 'admin')), $query) !== false) {
3654 }
3662 }
3663 }
3664 }
3666 /**
3667 * Blocks manage page
3668 */
3672 parent::admin_externalpage('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
3673 }
3679 }
3688 }
3693 }
3694 }
3695 }
3703 }
3704 }
3705 }
3707 /**
3708 * Special class for authentication administration.
3709 */
3713 }
3717 }
3721 }
3724 // do not write any setting
3726 }
3731 }
3738 }
3743 }
3744 }
3746 }
3752 // display strings
3764 }
3766 // construct the display array, with enabled auth plugins at the top, in order
3772 /// Get the auth title (from core or own auth lang files)
3774 /// Apply titles
3778 }
3779 }
3784 }
3786 /// Get the auth title (from core or own auth lang files)
3788 /// Apply titles
3792 }
3793 }
3804 //add always enabled plugins first
3807 //$settings = "<a href=\"settings.php?section=authsettingmanual\">{$txt->settings}</a>";
3814 // iterate through auth plugins and add to the display table
3821 }
3822 // hide/show link
3826 // $hideshow = "<a href=\"$url&action=disable&auth=$auth\"><input type=\"checkbox\" checked /></a>";
3829 }
3833 // $hideshow = "<a href=\"$url&action=enable&auth=$auth\"><input type=\"checkbox\" /></a>";
3836 }
3838 // up/down link (only if auth is enabled)
3844 }
3847 }
3851 }
3854 }
3856 }
3858 // settings link
3863 }
3865 // add a row to the table
3867 }
3869 $return .= get_string('configauthenticationplugins', 'admin').'<br />'.get_string('tablenosave', 'filters');
3872 }
3873 }
3874 /**
3875 * Special class for filter administration.
3876 */
3880 }
3884 }
3888 }
3891 // do not write any setting
3893 }
3898 }
3907 }
3911 }
3912 }
3913 }
3915 }
3929 // get a list of possible filters (and translate name if possible)
3930 // note filters can be in the dedicated filters area OR in their
3931 // associated modules
3947 }
3953 }
3954 }
3955 }
3956 }
3958 // get all the currently selected filters
3964 }
3966 // take this opportunity to clean up filters
3971 }
3972 }
3974 // construct the display array with installed filters
3975 // at the top in the right order
3980 }
3984 }
3985 }
3999 // iterate through filters adding to display table
4004 // get hide/show link
4010 }
4016 }
4018 // get up/down link (only if not hidden)
4024 }
4027 }
4031 }
4034 }
4036 }
4038 // settings link (if defined)
4041 $settings = "<a href=\"settings.php?section=filtersetting".str_replace('/', '',$path)."\">$strsettings</a>";
4044 }
4046 // write data into the table object
4048 }
4053 }
4054 }
4056 /**
4057 * Initialise admin page - this function does require login and permission
4058 * checks specified in page definition.
4059 * This function must be called on each admin page before other code.
4060 * @param string $section name of page
4061 */
4073 }
4081 }
4083 // this eliminates our need to authenticate on the actual pages
4087 }
4097 }
4104 }
4105 }
4106 }
4108 /**
4109 * Print header for admin page
4110 * @param string $focus focus element
4111 */
4116 }
4127 BLOCK_L_MAX_WIDTH);
4130 BLOCK_R_MAX_WIDTH);
4139 }
4153 $THEME->open_header_containers++; // this is hacky workaround for the error()/notice() autoclosing problems on admin pages
4163 }
4165 }
4166 }
4169 }
4170 }
4172 /**
4173 * Print footer on admin page - please use normal print_footer() instead
4174 */
4185 BLOCK_L_MAX_WIDTH);
4188 BLOCK_R_MAX_WIDTH);
4196 }
4197 }
4210 $THEME->open_header_containers--; // this is hacky workaround for the error()/notice() autoclosing problems on admin pages
4221 }
4223 }
4224 }
4226 }
4228 }
4230 /**
4231 * Returns the reference to admin tree root
4232 * @return reference
4233 */
4247 }
4251 }
4254 // start the admin tree!
4256 // array of error messages and search query
4263 }
4265 // we process this file first to create categories first and in correct order
4268 // now we process all other files in admin/settings to build the admin tree
4272 }
4273 }
4276 }
4277 }
4280 }
4282 /// settings utility functions
4284 /**
4285 * This function applies default settings.
4286 * @param object $node, NULL means complete tree
4287 * @param bool $uncoditional if true overrides all values with defaults
4288 * @return void
4289 */
4295 }
4301 }
4306 //do not override existing defaults
4308 }
4311 // no value yet - default maybe applied after admin user creation or in upgradesettings
4313 }
4315 }
4316 }
4317 }
4319 /**
4320 * Store changed settings, this function updates the errors variable in $ADMIN
4321 * @param object $formdata from form (without magic quotes)
4322 * @return int number of changed settings
4323 */
4334 }
4336 }
4350 }
4356 }
4357 }
4358 }
4362 }
4364 // now update $SITE - it might have been changed
4368 // now reload all settings - some of them might depend on the changed
4371 }
4373 /**
4374 * Internal recursive function - finds all settings from submitted form
4375 */
4381 }
4387 }
4394 }
4395 }
4397 }
4400 }
4402 /**
4403 * Internal function - prints the search results
4404 */
4411 }
4423 // hidden pages are not displayed in search results
4425 }
4427 $return .= print_heading(get_string('searchresults','admin').' - <a href="'.$page->url.'">'.highlight($query, $page->visiblename).'</a>', '', 2, 'main', true);
4429 $return .= print_heading(get_string('searchresults','admin').' - <a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section='.$page->name.'">'.highlight($query, $page->visiblename).'</a>', '', 2, 'main', true);
4432 }
4445 }
4446 }
4448 }
4450 }
4451 }
4454 $return .= '<div class="form-buttons"><input class="form-submit" type="submit" value="'.get_string('savechanges','admin').'" /></div>';
4455 }
4458 }
4460 /**
4461 * Internal function - returns arrays of html pages with uninitialised settings
4462 */
4470 }
4477 }
4478 }
4481 $page = print_heading(get_string('upgradesettings','admin').' - '.$node->visiblename, '', 2, 'main', true);
4491 }
4492 }
4495 }
4498 }
4499 }
4502 }
4504 /**
4505 * Unconditionally applies default admin settings in main config table
4506 * @param array $defaults array of string values
4507 */
4511 }
4512 }
4514 /**
4515 * Format admin settings
4516 * @param string $object setting
4517 * @param string $title label element
4518 * @param string $form form fragment, html code - not highlighed automaticaly
4519 * @param string $description
4520 * @param bool $label link label to id
4521 * @param string $warning warning text
4522 * @param sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string
4523 * @param string $query search query to be highlighted
4524 */
4525 function format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') {
4531 // sometimes the id is not id_s_name, but id_s_name_m or something, and this does not validate
4536 }
4542 }
4546 }
4553 }
4555 $defaultinfo = '<div class="form-defaultinfo">'.get_string('defaultsettinginfo', 'admin', $defaultinfo).'</div>';
4556 }
4561 <div class="form-label">
4562 <label '.$labelfor.'>'.highlightfast($query, $title).'<span class="form-shortname">'.highlightfast($query, $name).'</span>
4564 </label>
4565 </div>
4572 $str = '<fieldset class="error"><legend>'.$adminroot->errors[$fullname]->error.'</legend>'.$str.'</fieldset>';
4573 }
4576 }
4578 /**
4579 * Try to upgrade the given language pack (or current language)
4580 * If it doesn't work, fail silently and return false
4581 */
4587 }
4591 }
4595 @mkdir ($CFG->dataroot.'/temp/'); //make it in case it's a fresh install, it might not be there
4600 if ($cd = new component_installer('http://download.moodle.org', 'lang16', $lang.'.zip', 'languages.md5', 'lang')) {
4607 }
4608 }
4611 }
4613 /**
4614 * Based on find_new_settings{@link ()} in upgradesettings.php
4615 * Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.
4616 *
4617 * @param string $node The node at which to start searching.
4618 * @return boolen true if any settings haven't been initialised, false if they all have
4619 */
4627 }
4628 }
4634 }
4635 }
4636 }
4639 }
4642 /**
4643 * Moved from admin/replace.php so that we can use this in cron
4644 * @param string $search - string to look for (with magic quotes)
4645 * @param string $replace - string to replace (with magic quotes)
4646 * @return bool - success or fail
4647 */
4652 /// Turn off time limits, sometimes upgrades can be slow.
4659 }
4664 }
4668 if (in_array($data->type, array('text','mediumtext','longtext','varchar'))) { // Text stuff only
4672 }
4673 }
4674 }
4675 }
4678 }
4680 /**
4681 * Prints tables of detected plugins, one table per plugin type,
4682 * and prints whether they are part of the standard Moodle
4683 * distribution or not.
4684 */
4754 }
4758 }
4772 $html .= '<table class="generaltable plugincheckwrapper" cellspacing="4" cellpadding="1"><tr valign="top">';
4780 }
4782 $html .= '<td><table class="plugincompattable generaltable boxaligncenter" cellspacing="1" cellpadding="5" '
4783 . 'id="' . $cat . 'compattable" summary="compatibility table"><caption>' . $strcaption . '</caption>' . "\n";
4798 }
4800 // Get real name and full path of plugin
4807 // Determine if the plugin is about to be installed
4811 }
4819 // If the plugin was both on disk and in the db, unset the value from the installed plugins list
4822 }
4823 }
4825 // If there are plugins left in the plugins_installed list, it means they are missing from disk
4827 // Make sure the plugin really is missing from disk
4834 }
4840 . "<td class=\"$standard $status cell c2\">" . ${'str' . $standard} . " $strmissingfromdisk</td>\n</tr>\n";
4842 }
4843 }
4846 }
4851 }
4853 ?>