| blob | a8e12774ac4f48000c15fa3ba0642b43dc8ef3cc |
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 * Detects if float support at least 10 deciman digits
754 * and also if float-->string conversion works as expected.
755 * @return bool true if problem found
756 */
762 }
764 /**
765 * Try to verify that dataroot is not accessible from web.
766 * It is not 100% correct but might help to reduce number of vulnerable sites.
767 *
768 * Protection from httpd.conf and .htaccess is not detected properly.
769 * @param bool $fetchtest try to test public access by fetching file
770 * @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING migth be problematic
771 */
785 }
786 }
793 }
797 }
799 // now try all methods to fetch a test file using http protocol
807 }
811 }
814 // hmm, strange
816 }
831 }
832 }
834 }
840 }
841 }
860 }
861 }
866 }
867 }
870 }
872 /// =============================================================================================================
873 /// administration tree classes and functions
876 // n.b. documentation is still in progress for this code
878 /// INTRODUCTION
880 /// This file performs the following tasks:
881 /// -it defines the necessary objects and interfaces to build the Moodle
882 /// admin hierarchy
883 /// -it defines the admin_externalpage_setup(), admin_externalpage_print_header(),
884 /// and admin_externalpage_print_footer() functions used on admin pages
886 /// ADMIN_SETTING OBJECTS
888 /// Moodle settings are represented by objects that inherit from the admin_setting
889 /// class. These objects encapsulate how to read a setting, how to write a new value
890 /// to a setting, and how to appropriately display the HTML to modify the setting.
892 /// ADMIN_SETTINGPAGE OBJECTS
894 /// The admin_setting objects are then grouped into admin_settingpages. The latter
895 /// appear in the Moodle admin tree block. All interaction with admin_settingpage
896 /// objects is handled by the admin/settings.php file.
898 /// ADMIN_EXTERNALPAGE OBJECTS
900 /// There are some settings in Moodle that are too complex to (efficiently) handle
901 /// with admin_settingpages. (Consider, for example, user management and displaying
902 /// lists of users.) In this case, we use the admin_externalpage object. This object
903 /// places a link to an external PHP file in the admin tree block.
905 /// If you're using an admin_externalpage object for some settings, you can take
906 /// advantage of the admin_externalpage_* functions. For example, suppose you wanted
907 /// to add a foo.php file into admin. First off, you add the following line to
908 /// admin/settings/first.php (at the end of the file) or to some other file in
909 /// admin/settings:
911 /// $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
912 /// $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
914 /// Next, in foo.php, your file structure would resemble the following:
916 /// require_once('.../config.php');
917 /// require_once($CFG->libdir.'/adminlib.php');
918 /// admin_externalpage_setup('foo');
919 /// // functionality like processing form submissions goes here
920 /// admin_externalpage_print_header();
921 /// // your HTML goes here
922 /// admin_externalpage_print_footer();
924 /// The admin_externalpage_setup() function call ensures the user is logged in,
925 /// and makes sure that they have the proper role permission to access the page.
927 /// The admin_externalpage_print_header() function prints the header (it figures
928 /// out what category and subcategories the page is classified under) and ensures
929 /// that you're using the admin pagelib (which provides the admin tree block and
930 /// the admin bookmarks block).
932 /// The admin_externalpage_print_footer() function properly closes the tables
933 /// opened up by the admin_externalpage_print_header() function and prints the
934 /// standard Moodle footer.
936 /// ADMIN_CATEGORY OBJECTS
938 /// Above and beyond all this, we have admin_category objects. These objects
939 /// appear as folders in the admin tree block. They contain admin_settingpage's,
940 /// admin_externalpage's, and other admin_category's.
942 /// OTHER NOTES
944 /// admin_settingpage's, admin_externalpage's, and admin_category's all inherit
945 /// from part_of_admin_tree (a pseudointerface). This interface insists that
946 /// a class has a check_access method for access permissions, a locate method
947 /// used to find a specific node in the admin tree and find parent path.
949 /// admin_category's inherit from parentable_part_of_admin_tree. This pseudo-
950 /// interface ensures that the class implements a recursive add function which
951 /// accepts a part_of_admin_tree object and searches for the proper place to
952 /// put it. parentable_part_of_admin_tree implies part_of_admin_tree.
954 /// Please note that the $this->name field of any part_of_admin_tree must be
955 /// UNIQUE throughout the ENTIRE admin tree.
957 /// The $this->name field of an admin_setting object (which is *not* part_of_
958 /// admin_tree) must be unique on the respective admin_settingpage where it is
959 /// used.
962 /// CLASS DEFINITIONS /////////////////////////////////////////////////////////
964 /**
965 * Pseudointerface for anything appearing in the admin tree
966 *
967 * The pseudointerface that is implemented by anything that appears in the admin tree
968 * block. It forces inheriting classes to define a method for checking user permissions
969 * and methods for finding something in the admin tree.
970 *
971 * @author Vincenzo K. Marcovecchio
972 * @package admin
973 */
976 /**
977 * Finds a named part_of_admin_tree.
978 *
979 * Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
980 * and not parentable_part_of_admin_tree, then this function should only check if
981 * $this->name matches $name. If it does, it should return a reference to $this,
982 * otherwise, it should return a reference to NULL.
983 *
984 * If a class inherits parentable_part_of_admin_tree, this method should be called
985 * recursively on all child objects (assuming, of course, the parent object's name
986 * doesn't match the search criterion).
987 *
988 * @param string $name The internal name of the part_of_admin_tree we're searching for.
989 * @return mixed An object reference or a NULL reference.
990 */
992 trigger_error('Admin class does not implement method <strong>locate()</strong>', E_USER_WARNING);
994 }
996 /**
997 * Removes named part_of_admin_tree.
998 *
999 * @param string $name The internal name of the part_of_admin_tree we want to remove.
1000 * @return bool success.
1001 */
1003 trigger_error('Admin class does not implement method <strong>prune()</strong>', E_USER_WARNING);
1005 }
1007 /**
1008 * Search using query
1009 * @param strin query
1010 * @return mixed array-object structure of found settings and pages
1011 */
1013 trigger_error('Admin class does not implement method <strong>search()</strong>', E_USER_WARNING);
1015 }
1017 /**
1018 * Verifies current user's access to this part_of_admin_tree.
1019 *
1020 * Used to check if the current user has access to this part of the admin tree or
1021 * not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
1022 * then this method is usually just a call to has_capability() in the site context.
1023 *
1024 * If a class inherits parentable_part_of_admin_tree, this method should return the
1025 * logical OR of the return of check_access() on all child objects.
1026 *
1027 * @return bool True if the user has access, false if she doesn't.
1028 */
1030 trigger_error('Admin class does not implement method <strong>check_access()</strong>', E_USER_WARNING);
1032 }
1034 /**
1035 * Mostly usefull for removing of some parts of the tree in admin tree block.
1036 *
1037 * @return True is hidden from normal list view
1038 */
1040 trigger_error('Admin class does not implement method <strong>is_hidden()</strong>', E_USER_WARNING);
1042 }
1043 }
1045 /**
1046 * Pseudointerface implemented by any part_of_admin_tree that has children.
1047 *
1048 * The pseudointerface implemented by any part_of_admin_tree that can be a parent
1049 * to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
1050 * from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
1051 * include an add method for adding other part_of_admin_tree objects as children.
1052 *
1053 * @author Vincenzo K. Marcovecchio
1054 * @package admin
1055 */
1058 /**
1059 * Adds a part_of_admin_tree object to the admin tree.
1060 *
1061 * Used to add a part_of_admin_tree object to this object or a child of this
1062 * object. $something should only be added if $destinationname matches
1063 * $this->name. If it doesn't, add should be called on child objects that are
1064 * also parentable_part_of_admin_tree's.
1065 *
1066 * @param string $destinationname The internal name of the new parent for $something.
1067 * @param part_of_admin_tree &$something The object to be added.
1068 * @return bool True on success, false on failure.
1069 */
1073 }
1075 }
1077 /**
1078 * The object used to represent folders (a.k.a. categories) in the admin tree block.
1079 *
1080 * Each admin_category object contains a number of part_of_admin_tree objects.
1081 *
1082 * @author Vincenzo K. Marcovecchio
1083 * @package admin
1084 */
1087 /**
1088 * @var mixed An array of part_of_admin_tree objects that are this object's children
1089 */
1092 /**
1093 * @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
1094 */
1097 /**
1098 * @var string The displayed name for this category. Usually obtained through get_string()
1099 */
1102 /**
1103 * @var bool Should this category be hidden in admin tree block?
1104 */
1107 /**
1108 * paths
1109 */
1113 /**
1114 * Constructor for an empty admin category
1115 *
1116 * @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
1117 * @param string $visiblename The displayed named for this category. Usually obtained through get_string()
1118 * @param bool $hidden hide category in admin tree block
1119 */
1125 }
1127 /**
1128 * Returns a reference to the part_of_admin_tree object with internal name $name.
1129 *
1130 * @param string $name The internal name of the object we want.
1131 * @param bool $findpath initialize path and visiblepath arrays
1132 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1133 */
1139 }
1141 }
1147 }
1148 }
1153 }
1156 }
1158 /**
1159 * Search using query
1160 * @param strin query
1161 * @return mixed array-object structure of found settings and pages
1162 */
1170 }
1172 }
1174 }
1176 /**
1177 * Removes part_of_admin_tree object with internal name $name.
1178 *
1179 * @param string $name The internal name of the object we want to remove.
1180 * @return bool success
1181 */
1186 }
1190 // found it!
1193 }
1196 }
1197 }
1199 }
1201 /**
1202 * Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
1203 *
1204 * @param string $destinationame The internal name of the immediate parent that we want for $something.
1205 * @param mixed $something A part_of_admin_tree or setting instanceto be added.
1206 * @return bool True if successfully added, false if $something can not be added.
1207 */
1213 }
1219 }
1226 }
1228 }
1230 /**
1231 * Checks if the user has access to anything in this category.
1232 *
1233 * @return bool True if the user has access to atleast one child in this category, false otherwise.
1234 */
1239 }
1240 }
1242 }
1244 /**
1245 * Is this category hidden in admin tree block?
1246 *
1247 * @return bool True if hidden
1248 */
1251 }
1252 }
1255 /**
1256 * list of errors
1257 */
1260 /**
1261 * search query
1262 */
1265 /**
1266 * full tree flag - true means all settings required, false onlypages required
1267 */
1276 }
1277 }
1279 /**
1280 * Links external PHP pages into the admin tree.
1281 *
1282 * See detailed usage example at the top of this document (adminlib.php)
1283 *
1284 * @author Vincenzo K. Marcovecchio
1285 * @package admin
1286 */
1289 /**
1290 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1291 */
1294 /**
1295 * @var string The displayed name for this external page. Usually obtained through get_string().
1296 */
1299 /**
1300 * @var string The external URL that we should link to when someone requests this external page.
1301 */
1304 /**
1305 * @var string The role capability/permission a user must have to access this external page.
1306 */
1309 /**
1310 * @var object The context in which capability/permission should be checked, default is site context.
1311 */
1314 /**
1315 * @var bool hidden in admin tree block.
1316 */
1319 /**
1320 * visible path
1321 */
1325 /**
1326 * Constructor for adding an external page into the admin tree.
1327 *
1328 * @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
1329 * @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
1330 * @param string $url The external URL that we should link to when someone requests this external page.
1331 * @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
1332 * @param boolean $hidden Is this external page hidden in admin tree block? Default false.
1333 * @param context $context The context the page relates to. Not sure what happens
1334 * if you specify something other than system or front page. Defaults to system.
1335 */
1336 function admin_externalpage($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1344 }
1347 }
1349 /**
1350 * Returns a reference to the part_of_admin_tree object with internal name $name.
1351 *
1352 * @param string $name The internal name of the object we want.
1353 * @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
1354 */
1360 }
1365 }
1366 }
1370 }
1372 /**
1373 * Search using query
1374 * @param strin query
1375 * @return mixed array-object structure of found settings and pages
1376 */
1385 }
1393 }
1394 }
1396 /**
1397 * Determines if the current user has access to this external page based on $this->req_capability.
1398 * @return bool True if user has access, false otherwise.
1399 */
1403 }
1408 }
1409 }
1411 }
1413 /**
1414 * Is this external page hidden in admin tree block?
1415 *
1416 * @return bool True if hidden
1417 */
1420 }
1422 }
1424 /**
1425 * Used to group a number of admin_setting objects into a page and add them to the admin tree.
1426 *
1427 * @author Vincenzo K. Marcovecchio
1428 * @package admin
1429 */
1432 /**
1433 * @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects
1434 */
1437 /**
1438 * @var string The displayed name for this external page. Usually obtained through get_string().
1439 */
1441 /**
1442 * @var mixed An array of admin_setting objects that are part of this setting page.
1443 */
1446 /**
1447 * @var string The role capability/permission a user must have to access this external page.
1448 */
1451 /**
1452 * @var object The context in which capability/permission should be checked, default is site context.
1453 */
1456 /**
1457 * @var bool hidden in admin tree block.
1458 */
1461 /**
1462 * paths
1463 */
1467 // see admin_externalpage
1468 function admin_settingpage($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
1476 }
1479 }
1481 // see admin_category
1487 }
1492 }
1493 }
1501 }
1502 }
1509 }
1518 }
1526 }
1527 }
1531 }
1533 /**
1534 * 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
1535 * n.b. each admin_setting in an admin_settingpage must have a unique internal name
1536 * @param object $setting is the admin_setting object you want to add
1537 * @return true if successful, false if not
1538 */
1543 }
1547 }
1549 // see admin_externalpage
1553 }
1558 }
1559 }
1561 }
1563 /**
1564 * outputs this page as html in a table (suitable for inclusion in an admin pagetype)
1565 * returns a string of the html
1566 */
1578 }
1579 }
1581 }
1584 }
1586 /**
1587 * Is this settigns page hidden in admin tree block?
1588 *
1589 * @return bool True if hidden
1590 */
1593 }
1595 }
1598 /**
1599 * Admin settings class. Only exists on setting pages.
1600 * Read & write happens at this level; no authentication.
1601 */
1611 /**
1612 * Constructor
1613 * @param $name string unique ascii name
1614 * @param $visiblename string localised name
1615 * @param strin $description localised long description
1616 * @param mixed $defaultsetting string or array depending on implementation
1617 */
1623 }
1625 /**
1626 * Set up $this->name and possibly $this->plugin based on whether $name looks
1627 * like 'settingname' or 'plugin/settingname'. Also, do some sanity checking
1628 * on the names, that is, output a developer debug warning if the name
1629 * contains anything other than [a-zA-Z0-9_]+.
1630 *
1631 * @param string $name the setting name passed in to the constructor.
1632 */
1637 }
1641 }
1648 }
1649 }
1650 }
1654 }
1658 }
1669 }
1680 }
1681 }
1682 }
1691 }
1692 }
1694 /**
1695 * Returns current value of this setting
1696 * @return mixed array or string depending on instance, NULL means not set yet
1697 */
1699 // has to be overridden
1701 }
1703 /**
1704 * Returns default setting if exists
1705 * @return mixed array or string depending on instance; NULL means no default, user must supply
1706 */
1709 }
1711 /**
1712 * Store new setting
1713 * @param mixed string or array, must not be NULL
1714 * @return '' if ok, string error message otherwise
1715 */
1717 // should be overridden
1719 }
1721 /**
1722 * Return part of form with setting
1723 * @param mixed data array or string depending on setting
1724 * @return string
1725 */
1727 // should be overridden
1729 }
1731 /**
1732 * function called if setting updated - cleanup, cache reset, etc.
1733 */
1736 }
1738 /**
1739 * Is setting related to query text - used when searching
1740 * @param string $query
1741 * @return bool
1742 */
1746 }
1750 }
1753 }
1759 }
1760 }
1761 }
1767 }
1768 }
1769 }
1771 }
1772 }
1774 /**
1775 * No setting - just heading and text.
1776 */
1778 /**
1779 * not a setting, just text
1780 * @param string $name of setting
1781 * @param string $heading heading
1782 * @param string $information text in box
1783 */
1786 }
1790 }
1794 }
1797 // do not write any setting
1799 }
1804 $return .= print_heading('<a name="'.$this->name.'">'.highlightfast($query, $this->visiblename).'</a>', '', 3, 'main', true);
1805 }
1807 $return .= print_box(highlight($query, $this->description), 'generalbox formsettingheading', '', true);
1808 }
1810 }
1811 }
1813 /**
1814 * The most flexibly setting, user is typing text
1815 */
1821 /**
1822 * config text contructor
1823 * @param string $name of setting
1824 * @param string $visiblename localised
1825 * @param string $description long localised info
1826 * @param string $defaultsetting
1827 * @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
1828 * @param int $size default field size
1829 */
1830 function admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) {
1836 }
1838 }
1842 }
1846 // do not complain if '' used instead of 0
1848 }
1849 // $data is a string
1853 }
1855 }
1857 /**
1858 * Validate data before storage
1859 * @param string data
1860 * @return mixed true if ok string if error found
1861 */
1868 }
1879 }
1880 }
1881 }
1887 '<div class="form-text defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>',
1889 }
1890 }
1892 /**
1893 * General text area without html editor.
1894 */
1899 function admin_setting_configtextarea($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
1902 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype);
1903 }
1911 }
1914 '<div class="form-textarea form-textarea-advanced" ><textarea rows="'. $this->rows .'" cols="'. $this->cols .'" id="'. $this->get_id() .'" name="'. $this->get_full_name() .'">'. s($data) .'</textarea></div>',
1916 }
1917 }
1919 /**
1920 * Password field, allows unmasking of password
1921 */
1923 /**
1924 * Constructor
1925 * @param string $name of setting
1926 * @param string $visiblename localised
1927 * @param string $description long localised info
1928 * @param string $defaultsetting default password
1929 */
1930 function admin_setting_configpasswordunmask($name, $visiblename, $description, $defaultsetting) {
1931 parent::admin_setting_configtext($name, $visiblename, $description, $defaultsetting, PARAM_RAW, 30);
1932 }
1938 //<![CDATA[
1939 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>\');
1941 //]]>
1944 '<div class="form-password"><input type="password" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$unmaskjs.'</div>',
1946 }
1947 }
1949 /**
1950 * Path to directory
1951 */
1953 /**
1954 * Constructor
1955 * @param string $name of setting
1956 * @param string $visiblename localised
1957 * @param string $description long localised info
1958 * @param string $defaultdirectory default directory location
1959 */
1961 parent::admin_setting_configtext($name, $visiblename, $description, $defaultdirectory, PARAM_RAW, 50);
1962 }
1972 }
1975 }
1978 '<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>',
1980 }
1981 }
1983 /**
1984 * Path to executable file
1985 */
1996 }
1999 }
2002 '<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>',
2004 }
2005 }
2007 /**
2008 * Path to directory
2009 */
2019 }
2022 }
2025 '<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>',
2027 }
2028 }
2030 /**
2031 * Checkbox
2032 */
2037 /**
2038 * Constructor
2039 * @param string $name of setting
2040 * @param string $visiblename localised
2041 * @param string $description long localised info
2042 * @param string $defaultsetting
2043 * @param string $yes value used when checked
2044 * @param string $no value used when not checked
2045 */
2046 function admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
2050 }
2054 }
2061 }
2063 }
2073 }
2076 }
2082 }
2085 '<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> '
2086 .'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' /></div>',
2088 }
2089 }
2091 /**
2092 * Multiple checkboxes, each represents different value, stored in csv format
2093 */
2097 /**
2098 * Constructor
2099 * @param string $name of setting
2100 * @param string $visiblename localised
2101 * @param string $description long localised info
2102 * @param array $defaultsetting array of selected
2103 * @param array $choices array of $value=>$label for each checkbox
2104 */
2105 function admin_setting_configmulticheckbox($name, $visiblename, $description, $defaultsetting, $choices) {
2108 }
2110 /**
2111 * This function may be used in ancestors for lazy loading of choices
2112 * @return true if loaded, false if error
2113 */
2115 /*
2116 if (is_array($this->choices)) {
2117 return true;
2118 }
2119 .... load choices here
2120 */
2122 }
2124 /**
2125 * Is setting related to query text - used when searching
2126 * @param string $query
2127 * @return bool
2128 */
2132 }
2135 }
2141 }
2142 }
2144 }
2150 }
2153 }
2155 }
2160 }
2163 }
2169 }
2170 }
2171 return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin');
2172 }
2177 }
2181 }
2186 }
2187 }
2188 }
2197 }
2200 }
2202 $options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
2204 }
2212 }
2215 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2220 }
2222 }
2225 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
2227 }
2228 }
2230 /**
2231 * Multiple checkboxes 2, value stored as string 00101011
2232 */
2238 }
2241 }
2249 }
2250 }
2252 }
2257 }
2260 }
2267 }
2268 }
2270 }
2271 }
2273 /**
2274 * Select one value from list
2275 */
2279 /**
2280 * Constructor
2281 * @param string $name of setting
2282 * @param string $visiblename localised
2283 * @param string $description long localised info
2284 * @param string $defaultsetting
2285 * @param array $choices array of $value=>$label for each selection
2286 */
2287 function admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) {
2290 }
2292 /**
2293 * This function may be used in ancestors for lazy loading of choices
2294 * @return true if loaded, false if error
2295 */
2297 /*
2298 if (is_array($this->choices)) {
2299 return true;
2300 }
2301 .... load choices here
2302 */
2304 }
2309 }
2312 }
2317 }
2320 }
2321 }
2323 }
2327 }
2332 }
2335 }
2338 }
2343 }
2350 }
2355 //first run
2356 } else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) {
2357 // no warning
2362 }
2363 }
2365 $return = '<div class="form-select defaultsnext"><select id="'.$this->get_id().'" name="'.$this->get_full_name().'">';
2367 // the string cast is needed because key may be integer - 0 is equal to most strings!
2368 $return .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>';
2369 }
2372 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning, $defaultinfo, $query);
2373 }
2375 }
2377 /**
2378 * Select multiple items from list
2379 */
2381 /**
2382 * Constructor
2383 * @param string $name of setting
2384 * @param string $visiblename localised
2385 * @param string $description long localised info
2386 * @param array $defaultsetting array of selected items
2387 * @param array $choices array of $value=>$label for each list item
2388 */
2389 function admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) {
2390 parent::admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices);
2391 }
2397 }
2400 }
2402 }
2407 }
2410 }
2418 }
2420 }
2422 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2423 }
2425 /**
2426 * Is setting related to query text - used when searching
2427 * @param string $query
2428 * @return bool
2429 */
2433 }
2436 }
2442 }
2443 }
2445 }
2450 }
2455 }
2458 }
2462 $return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
2463 $return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="'.$size.'" multiple="multiple">';
2469 }
2472 }
2475 }
2483 }
2486 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
2487 }
2488 }
2490 /**
2491 * Time selector
2492 * this is a liiitle bit messy. we're using two selects, but we're returning
2493 * them as an array named after $name (so we only use $name2 internally for the setting)
2494 */
2498 /**
2499 * Constructor
2500 * @param string $hoursname setting for hours
2501 * @param string $minutesname setting for hours
2502 * @param string $visiblename localised
2503 * @param string $description long localised info
2504 * @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
2505 */
2506 function admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
2509 }
2516 }
2519 }
2524 }
2526 $result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']);
2528 }
2537 }
2542 $return .= '<option value="'.$i.'"'.($i == $data['h'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2543 }
2544 $return .= '</select>:<select id="'.$this->get_id().'m" name="'.$this->get_full_name().'[m]">';
2546 $return .= '<option value="'.$i.'"'.($i == $data['m'] ? ' selected="selected"' : '').'>'.$i.'</option>';
2547 }
2549 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
2550 }
2552 }
2554 /**
2555 * An admin setting for selecting one or more users, who have a particular capability
2556 * in the system context. Warning, make sure the list will never be too long. There is
2557 * no paging or searching of this list.
2558 *
2559 * To correctly get a list of users from this config setting, you need to call the
2560 * get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php.
2561 */
2565 /**
2566 * Constructor.
2567 *
2568 * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
2569 * @param string $visiblename localised name
2570 * @param string $description localised long description
2571 * @param array $defaultsetting array of usernames
2572 * @param string $capability string capability name.
2573 */
2574 function admin_setting_users_with_capability($name, $visiblename, $description, $defaultsetting, $capability) {
2576 parent::admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, NULL);
2577 }
2582 }
2588 );
2591 }
2593 }
2603 }
2604 }
2610 }
2612 }
2615 // If all is selected, remove any explicit options.
2618 }
2619 // None never needs to be writted to the DB.
2622 }
2624 }
2625 }
2627 /**
2628 * Special checkbox for calendar - resets SESSION vars.
2629 */
2632 parent::admin_setting_configcheckbox('calendar_adminseesall', get_string('adminseesall', 'admin'),
2634 }
2640 }
2641 }
2643 /**
2644 * Special select for settings that are altered in setup.php and can not be altered on the fly
2645 */
2648 // read directly from db!
2650 }
2654 // do not change active CFG setting!
2659 }
2660 }
2662 /**
2663 * Special select for frontpage - stores data in course table
2664 */
2669 }
2675 }
2681 // update $SITE
2684 }
2685 }
2687 /**
2688 * Special select - lists on the frontpage - hacky
2689 */
2701 }
2706 }
2714 }
2716 }
2721 }
2724 }
2726 }
2731 }
2737 }
2739 }
2740 return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
2741 }
2749 }
2750 }
2756 }
2757 $return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
2759 $return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ? ' selected="selected"' : '').'>'.$value.'</option>';
2760 }
2764 }
2765 }
2768 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2769 }
2770 }
2772 /**
2773 * Special checkbox for frontpage - stores data in course table
2774 */
2779 }
2787 // update $SITE
2790 }
2791 }
2793 /**
2794 * Special text for frontpage - stores data in course table.
2795 * Empty string means not set here. Manual setting is required.
2796 */
2801 }
2807 }
2812 }
2813 }
2821 }
2827 // update $SITE
2830 }
2831 }
2833 /**
2834 * Special text editor for site description.
2835 */
2838 parent::admin_setting('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
2839 }
2844 }
2854 }
2860 $return = '<div class="form-htmlarea">'.print_textarea($CFG->adminusehtmleditor, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, 'summary') .'</div>';
2862 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2863 }
2864 }
2894 }
2901 }
2910 }
2912 }
2916 // there miiight be an easier way to do this :)
2917 // if this is changed, make sure the $defaults array above is modified so that this
2918 // function processes it correctly
2928 }
2929 }
2935 }
2936 }
2938 return ($this->config_write($this->name, implode(';', $result)) ? '' : get_string('errorsetting', 'admin'));
2939 }
2945 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
2947 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
2948 }
2951 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
2952 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
2954 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
2957 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
2958 }
2960 }
3028 }
3035 }
3044 }
3046 }
3050 // there miiight be an easier way to do this :)
3051 // if this is changed, make sure the $defaults array above is modified so that this
3052 // function processes it correctly
3062 }
3063 }
3069 }
3070 }
3072 return ($this->config_write($this->name, implode('{;}', $result)) ? '' : get_string('errorsetting', 'admin').$this->visiblename.'<br />');
3073 }
3079 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.$i.']" value="'.$data['k'.$i].'" />';
3081 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="'.$data['v'.$i].'" /><br />';
3082 }
3085 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.$i.']" value="" /><br />';
3086 $return .= '<input type="text" class="form-text" name="'.$fullname.'[k'.($i + 1).']" value="" />';
3088 $return .= '<input type="text" class="form-text" name="'.$fullname.'[v'.($i + 1).']" value="" />';
3091 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
3092 }
3094 }
3096 /**
3097 * Setting for spellchecker language selection.
3098 */
3106 }
3109 // function borrowed from the old moodle/admin/editor.php, slightly modified
3110 // Get all installed dictionaries in the system
3113 }
3121 // If aspellpath isn't set don't even bother ;-)
3125 }
3127 // Do we have access to popen function?
3131 }
3139 }
3143 }
3150 }
3152 }
3156 }
3158 }
3159 }
3168 // weird array... buttonname => buttonimage (assume proper path appended). if you leave buttomimage blank, text will be printed instead
3208 }
3214 }
3217 }
3219 }
3224 }
3231 }
3234 }
3235 }
3236 return ($this->config_write($this->name, implode(' ', $result)) ? '' : get_string('errorsetting', 'admin'));
3237 }
3243 // checkboxes with input name="$this->name[$key]" value="1"
3244 // we do 15 fields per column
3248 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
3255 }
3258 $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').'" />').' ';
3259 $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"' : '').' /> ';
3264 }
3265 }
3271 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
3272 }
3273 }
3275 /**
3276 * Special setting for limiting of the list of available languages.
3277 */
3280 parent::admin_setting_configtext('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS);
3281 }
3287 }
3288 }
3290 /**
3291 * Course category selection
3292 */
3296 }
3303 }
3306 }
3307 }
3311 parent::admin_setting_configmulticheckbox2('backup_sche_weekdays', get_string('schedule'), get_string('backupschedulehelp'), array(), NULL);
3313 }
3318 }
3323 }
3325 }
3326 }
3328 /**
3329 * Special debug setting
3330 */
3333 parent::admin_setting_configselect('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE, NULL);
3334 }
3339 }
3346 }
3347 }
3357 }
3363 }
3366 }
3371 }
3372 }
3374 }
3379 }
3384 }
3386 }
3389 // The order matters very much because of the implied numeric keys
3392 $return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
3394 $return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
3395 }
3398 $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>';
3399 }
3402 return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
3404 }
3405 }
3408 /**
3409 * Graded roles in gradebook
3410 */
3413 parent::admin_setting_configmulticheckbox('gradebookroles', get_string('gradebookroles', 'admin'),
3415 }
3421 }
3424 }
3429 }
3433 }
3434 }
3440 }
3445 }
3446 }
3448 }
3449 }
3460 // force full regrading
3462 }
3465 }
3466 }
3468 /**
3469 * Which roles to show on course decription page
3470 */
3473 parent::admin_setting_configmulticheckbox('coursemanager', get_string('coursemanager', 'admin'),
3475 }
3480 }
3485 }
3487 }
3489 }
3495 }
3500 }
3501 }
3503 }
3504 }
3508 parent::admin_setting_configcheckbox('unlimitedgrades', get_string('unlimitedgrades', 'grades'),
3510 }
3516 }
3524 }
3528 }
3529 }
3531 }
3533 }
3535 /**
3536 * Primary grade export plugin - has state tracking.
3537 */
3542 }
3547 }
3553 }
3554 }
3556 }
3557 }
3559 /**
3560 * Grade category settings
3561 */
3566 function admin_setting_gradecat_combo($name, $visiblename, $description, $defaultsetting, $choices) {
3569 }
3579 }
3586 }
3598 }
3607 // force regrade if needed
3611 }
3617 }
3618 }
3630 }
3633 }
3636 }
3641 }
3645 $return .= '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
3647 // the string cast is needed because key may be integer - 0 is equal to most strings!
3648 $return .= '<option value="'.$key.'"'.((string)$key==$value ? ' selected="selected"' : '').'>'.$val.'</option>';
3649 }
3651 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ? 'checked="checked"' : '').' />'
3653 $return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ? 'checked="checked"' : '').' />'
3657 return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
3658 }
3659 }
3662 /**
3663 * Selection of grade report in user profiles
3664 */
3667 parent::admin_setting_configselect('grade_profilereport', get_string('profilereport', 'grades'), get_string('configprofilereport', 'grades'), 'user', null);
3668 }
3673 }
3684 $this->choices[$plugin] = get_string('modulename', 'gradereport_'.$plugin, NULL, $CFG->dirroot.'/grade/report/'.$plugin.'/lang/');
3685 }
3686 }
3687 }
3689 }
3690 }
3692 /**
3693 * Special class for register auth selection
3694 */
3697 parent::admin_setting_configselect('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), '', null);
3698 }
3706 }
3707 }
3714 }
3724 }
3725 // Get the auth title (from core or own auth lang files)
3728 }
3730 }
3731 }
3733 /**
3734 * Module manage page
3735 */
3739 parent::admin_externalpage('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
3740 }
3745 }
3754 }
3759 }
3760 }
3761 }
3769 }
3770 }
3771 }
3773 /**
3774 * Enrolment manage page
3775 */
3779 parent::admin_externalpage('enrolment', get_string('enrolments'), $CFG->wwwroot . '/'.$CFG->admin.'/enrol.php');
3780 }
3785 }
3795 }
3800 }
3801 }
3802 }
3803 //ugly harcoded hacks
3806 } else if (strpos($textlib->strtolower(get_string('sendcoursewelcomemessage', 'admin')), $query) !== false) {
3808 } else if (strpos($textlib->strtolower(get_string('configsendcoursewelcomemessage', 'admin')), $query) !== false) {
3810 } else if (strpos($textlib->strtolower(get_string('configenrolmentplugins', 'admin')), $query) !== false) {
3812 }
3820 }
3821 }
3822 }
3824 /**
3825 * Blocks manage page
3826 */
3830 parent::admin_externalpage('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
3831 }
3837 }
3846 }
3851 }
3852 }
3853 }
3861 }
3862 }
3863 }
3865 /**
3866 * Special class for authentication administration.
3867 */
3871 }
3875 }
3879 }
3882 // do not write any setting
3884 }
3889 }
3896 }
3901 }
3902 }
3904 }
3910 // display strings
3922 }
3924 // construct the display array, with enabled auth plugins at the top, in order
3930 /// Get the auth title (from core or own auth lang files)
3932 /// Apply titles
3936 }
3937 }
3942 }
3944 /// Get the auth title (from core or own auth lang files)
3946 /// Apply titles
3950 }
3951 }
3962 //add always enabled plugins first
3965 //$settings = "<a href=\"settings.php?section=authsettingmanual\">{$txt->settings}</a>";
3972 // iterate through auth plugins and add to the display table
3979 }
3980 // hide/show link
3984 // $hideshow = "<a href=\"$url&action=disable&auth=$auth\"><input type=\"checkbox\" checked /></a>";
3987 }
3991 // $hideshow = "<a href=\"$url&action=enable&auth=$auth\"><input type=\"checkbox\" /></a>";
3994 }
3996 // up/down link (only if auth is enabled)
4002 }
4005 }
4009 }
4012 }
4014 }
4016 // settings link
4021 }
4023 // add a row to the table
4025 }
4027 $return .= get_string('configauthenticationplugins', 'admin').'<br />'.get_string('tablenosave', 'filters');
4030 }
4031 }
4032 /**
4033 * Special class for filter administration.
4034 */
4038 }
4042 }
4046 }
4049 // do not write any setting
4051 }
4056 }
4065 }
4069 }
4070 }
4071 }
4073 }
4087 // get a list of possible filters (and translate name if possible)
4088 // note filters can be in the dedicated filters area OR in their
4089 // associated modules
4105 }
4111 }
4112 }
4113 }
4114 }
4116 // get all the currently selected filters
4122 }
4124 // take this opportunity to clean up filters
4129 }
4130 }
4132 // construct the display array with installed filters
4133 // at the top in the right order
4138 }
4142 }
4143 }
4157 // iterate through filters adding to display table
4162 // get hide/show link
4168 }
4174 }
4176 // get up/down link (only if not hidden)
4182 }
4185 }
4189 }
4192 }
4194 }
4196 // settings link (if defined)
4199 $settings = "<a href=\"settings.php?section=filtersetting".str_replace('/', '',$path)."\">$strsettings</a>";
4202 }
4204 // write data into the table object
4206 }
4211 }
4212 }
4214 /**
4215 * Initialise admin page - this function does require login and permission
4216 * checks specified in page definition.
4217 * This function must be called on each admin page before other code.
4218 * @param string $section name of page
4219 * @param string $extrabutton extra HTML that is added after the blocks editing on/off button.
4220 * @param string $extraurlparams an array paramname => paramvalue, or parameters that need to be
4221 * added to the turn blocks editing on/off form, so this page reloads correctly.
4222 * @param string $actualurl if the actual page being viewed is not the normal one for this
4223 * page (e.g. admin/roles/allowassin.php, instead of admin/roles/manage.php, you can pass the alternate URL here.
4224 */
4225 function admin_externalpage_setup($section, $extrabutton='', $extraurlparams=array(), $actualurl='') {
4236 }
4244 }
4246 // this eliminates our need to authenticate on the actual pages
4250 }
4262 }
4269 }
4270 }
4271 }
4273 /**
4274 * Print header for admin page
4275 * @param string $focus focus element
4276 */
4281 }
4292 BLOCK_L_MAX_WIDTH);
4295 BLOCK_R_MAX_WIDTH);
4304 }
4318 $THEME->open_header_containers++; // this is hacky workaround for the error()/notice() autoclosing problems on admin pages
4328 }
4330 }
4331 }
4334 }
4335 }
4337 /**
4338 * Print footer on admin page - please use normal print_footer() instead
4339 */
4350 BLOCK_L_MAX_WIDTH);
4353 BLOCK_R_MAX_WIDTH);
4361 }
4362 }
4375 $THEME->open_header_containers--; // this is hacky workaround for the error()/notice() autoclosing problems on admin pages
4386 }
4388 }
4389 }
4391 }
4393 }
4395 /**
4396 * Returns the reference to admin tree root
4397 * @return reference
4398 */
4412 }
4416 }
4419 // start the admin tree!
4421 // array of error messages and search query
4428 }
4430 // we process this file first to create categories first and in correct order
4433 // now we process all other files in admin/settings to build the admin tree
4437 }
4439 // plugins are loaded last - they may insert pages anywhere
4441 }
4443 }
4448 }
4449 }
4452 }
4454 /// settings utility functions
4456 /**
4457 * This function applies default settings.
4458 * @param object $node, NULL means complete tree
4459 * @param bool $uncoditional if true overrides all values with defaults
4460 * @return void
4461 */
4467 }
4473 }
4478 //do not override existing defaults
4480 }
4483 // no value yet - default maybe applied after admin user creation or in upgradesettings
4485 }
4487 }
4488 }
4489 }
4491 /**
4492 * Store changed settings, this function updates the errors variable in $ADMIN
4493 * @param object $formdata from form (without magic quotes)
4494 * @return int number of changed settings
4495 */
4506 }
4508 }
4522 }
4528 }
4529 }
4530 }
4534 }
4536 // now update $SITE - it might have been changed
4540 // now reload all settings - some of them might depend on the changed
4543 }
4545 /**
4546 * Internal recursive function - finds all settings from submitted form
4547 */
4553 }
4559 }
4566 }
4567 }
4569 }
4572 }
4574 /**
4575 * Internal function - prints the search results
4576 */
4583 }
4595 // hidden pages are not displayed in search results
4597 }
4599 $return .= print_heading(get_string('searchresults','admin').' - <a href="'.$page->url.'">'.highlight($query, $page->visiblename).'</a>', '', 2, 'main', true);
4601 $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);
4604 }
4617 }
4618 }
4620 }
4622 }
4623 }
4626 $return .= '<div class="form-buttons"><input class="form-submit" type="submit" value="'.get_string('savechanges','admin').'" /></div>';
4627 }
4630 }
4632 /**
4633 * Internal function - returns arrays of html pages with uninitialised settings
4634 */
4642 }
4649 }
4650 }
4653 $page = print_heading(get_string('upgradesettings','admin').' - '.$node->visiblename, '', 2, 'main', true);
4663 }
4664 }
4667 }
4670 }
4671 }
4674 }
4676 /**
4677 * Unconditionally applies default admin settings in main config table
4678 * @param array $defaults array of string values
4679 */
4683 }
4684 }
4686 /**
4687 * Format admin settings
4688 * @param string $object setting
4689 * @param string $title label element
4690 * @param string $form form fragment, html code - not highlighed automaticaly
4691 * @param string $description
4692 * @param bool $label link label to id
4693 * @param string $warning warning text
4694 * @param sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string
4695 * @param string $query search query to be highlighted
4696 */
4697 function format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') {
4703 // sometimes the id is not id_s_name, but id_s_name_m or something, and this does not validate
4708 }
4714 }
4718 }
4725 }
4727 $defaultinfo = '<div class="form-defaultinfo">'.get_string('defaultsettinginfo', 'admin', $defaultinfo).'</div>';
4728 }
4733 <div class="form-label">
4734 <label '.$labelfor.'>'.highlightfast($query, $title).'<span class="form-shortname">'.highlightfast($query, $name).'</span>
4736 </label>
4737 </div>
4744 $str = '<fieldset class="error"><legend>'.$adminroot->errors[$fullname]->error.'</legend>'.$str.'</fieldset>';
4745 }
4748 }
4750 /**
4751 * Try to upgrade the given language pack (or current language)
4752 * If it doesn't work, fail silently and return false
4753 */
4759 }
4763 }
4767 @mkdir ($CFG->dataroot.'/temp/'); //make it in case it's a fresh install, it might not be there
4772 if ($cd = new component_installer('http://download.moodle.org', 'lang16', $lang.'.zip', 'languages.md5', 'lang')) {
4779 }
4780 }
4783 }
4785 /**
4786 * Based on find_new_settings{@link ()} in upgradesettings.php
4787 * Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.
4788 *
4789 * @param string $node The node at which to start searching.
4790 * @return boolen true if any settings haven't been initialised, false if they all have
4791 */
4799 }
4800 }
4806 }
4807 }
4808 }
4811 }
4814 /**
4815 * Moved from admin/replace.php so that we can use this in cron
4816 * @param string $search - string to look for (with magic quotes)
4817 * @param string $replace - string to replace (with magic quotes)
4818 * @return bool - success or fail
4819 */
4824 /// Turn off time limits, sometimes upgrades can be slow.
4831 }
4836 }
4840 if (in_array($data->type, array('text','mediumtext','longtext','varchar'))) { // Text stuff only
4844 }
4845 }
4846 }
4847 }
4850 }
4852 /**
4853 * Prints tables of detected plugins, one table per plugin type,
4854 * and prints whether they are part of the standard Moodle
4855 * distribution or not.
4856 */
4926 }
4930 }
4944 $html .= '<table class="generaltable plugincheckwrapper" cellspacing="4" cellpadding="1"><tr valign="top">';
4952 }
4954 $html .= '<td><table class="plugincompattable generaltable boxaligncenter" cellspacing="1" cellpadding="5" '
4955 . 'id="' . $cat . 'compattable" summary="compatibility table"><caption>' . $strcaption . '</caption>' . "\n";
4970 }
4972 // Get real name and full path of plugin
4979 // Determine if the plugin is about to be installed
4983 }
4991 // If the plugin was both on disk and in the db, unset the value from the installed plugins list
4994 }
4995 }
4997 // If there are plugins left in the plugins_installed list, it means they are missing from disk
4999 // Make sure the plugin really is missing from disk
5006 }
5012 . "<td class=\"$standard $status cell c2\">" . ${'str' . $standard} . " $strmissingfromdisk</td>\n</tr>\n";
5014 }
5015 }
5018 }
5023 }
5025 ?>