From: tjhunt Date: Thu, 8 Jan 2009 07:07:00 +0000 (+0000) Subject: course requests: MDL-6160 clean up admin option for choosing who is notified. Merged... X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=4413941fee3f6aab03834705c1c2f6c0012b6cb8;p=moodle.git course requests: MDL-6160 clean up admin option for choosing who is notified. Merged from MOODLE_19_STABLE. Also, change the 'notifyloginfailures' setting to use the same sort of admin setting type. --- diff --git a/admin/settings/courses.php b/admin/settings/courses.php index c8e545564c..e95bb448ea 100644 --- a/admin/settings/courses.php +++ b/admin/settings/courses.php @@ -122,7 +122,7 @@ if ($hassiteconfig $temp = new admin_settingpage('courserequest', get_string('courserequest')); $temp->add(new admin_setting_configcheckbox('enablecourserequests', get_string('enablecourserequests', 'admin'), get_string('configenablecourserequests', 'admin'), 0)); $temp->add(new admin_settings_coursecat_select('defaultrequestcategory', get_string('defaultrequestcategory', 'admin'), get_string('configdefaultrequestcategory', 'admin'), 1)); - $temp->add(new admin_setting_configtext('courserequestnotify', get_string('courserequestnotify', 'admin'), get_string('configcourserequestnotify', 'admin'), '')); + $temp->add(new admin_setting_users_with_capability('courserequestnotify', get_string('courserequestnotify', 'admin'), get_string('configcourserequestnotify2', 'admin'), array(), 'moodle/site:approvecourse')); $ADMIN->add('courses', $temp); /// Pending course requests. diff --git a/admin/settings/security.php b/admin/settings/security.php index c603abe983..77eba67fe4 100644 --- a/admin/settings/security.php +++ b/admin/settings/security.php @@ -90,9 +90,7 @@ if ($hassiteconfig) { // speedup for non-admins, add all caps used on this page 'admin' => get_string('administrators'), 'teacher' => get_string('administratorsandteachers'), 'everybody' => get_string('everybody')))); - $temp->add(new admin_setting_configselect('notifyloginfailures', get_string('notifyloginfailures', 'admin'), get_string('confignotifyloginfailures', 'admin'), '', array('' => get_string('nobody'), - 'mainadmin' => get_string('administrator'), - 'alladmins' => get_string('administratorsall')))); + $temp->add(new admin_setting_users_with_capability('notifyloginfailures', get_string('notifyloginfailures', 'admin'), get_string('confignotifyloginfailures', 'admin'), array(), 'moodle/site:config')); $options = array(); for ($i = 1; $i <= 100; $i++) { $options[$i] = $i; diff --git a/course/request.php b/course/request.php index 86dcfc66d8..aaa8050954 100644 --- a/course/request.php +++ b/course/request.php @@ -68,8 +68,8 @@ /// Notify the admin if required. if ($CFG->courserequestnotify) { - if ($user = $user = $DB->get_record('user', array('username' => $CFG->courserequestnotify, - 'mnethostid' => $CFG->mnet_localhost_id))) { + $users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse'); + foreach ($users as $user) { $eventdata = new object(); $eventdata->modulename = 'moodle'; $eventdata->component = 'course'; diff --git a/lang/en_utf8/admin.php b/lang/en_utf8/admin.php index 93efdcd317..1f6d2f482a 100644 --- a/lang/en_utf8/admin.php +++ b/lang/en_utf8/admin.php @@ -91,6 +91,7 @@ $string['configcookiesecure'] = 'If server is accepting only https connections i $string['configcountry'] = 'If you set a country here, then this country will be selected by default on new user accounts. To force users to choose a country, just leave this unset.'; $string['configcoursemanager'] = 'This setting allows you to control who appears on the course description. Users need to have at least one of these roles in a course to be shown on the course description for that course.'; $string['configcourserequestnotify'] = 'Type username of user to be notified when new course requested.'; +$string['configcourserequestnotify2'] = 'Users who will be notified when a course is requested. Only users who can approve course requests are listed here.'; $string['configcoursesperpage'] = 'Enter the number of courses to be display per page in a course listing.'; $string['configcreatornewroleid'] = 'This role is automatically assigned to creators in new courses they created. This role is not assigned if creator already has needed capabilities in parent context.'; $string['configdbsessions'] = 'If enabled, this setting will use the database to store information about current sessions. This is especially useful for large/busy sites or sites built on cluster of servers. For most sites this should probably be left disabled so that the server disk is used instead. Note that changing this setting now will log out all current users (including you). If you are using MySQL please make sure that \'max_allowed_packet\' in my.cnf (or my.ini) is at least 4M.'; @@ -387,6 +388,7 @@ $string['errordeletingconfig'] = 'An error occurred while deleting the configura $string['errors'] = 'Errors'; $string['errorsetting'] = 'Could not save setting:'; $string['errorwithsettings'] = 'Some settings were not changed due to an error.'; +$string['everyonewhocan'] = 'Everyone who can \'$a\''; $string['exceptions'] = 'exceptions'; $string['experimental'] = 'Experimental'; $string['experimentalsettings'] = 'Experimental settings'; diff --git a/lib/adminlib.php b/lib/adminlib.php index f62b0dac72..4bde5306f0 100644 --- a/lib/adminlib.php +++ b/lib/adminlib.php @@ -3292,8 +3292,9 @@ class admin_setting_configmultiselect extends admin_setting_configselect { } $defaults = array(); + $size = min(10, count($this->choices)); $return = '
'; // something must be submitted even if nothing selected - $return .= ''; foreach ($this->choices as $key => $description) { if (in_array($key, $data)) { $selected = 'selected="selected"'; @@ -3411,6 +3412,71 @@ class admin_setting_configiplist extends admin_setting_configtextarea { } } +/** + * An admin setting for selecting one or more users, who have a particular capability + * in the system context. Warning, make sure the list will never be too long. There is + * no paging or searching of this list. + * + * To correctly get a list of users from this config setting, you need to call the + * get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php. + */ +class admin_setting_users_with_capability extends admin_setting_configmultiselect { + protected $capability; + + /** + * Constructor. + * + * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. + * @param string $visiblename localised name + * @param string $description localised long description + * @param array $defaultsetting array of usernames + * @param string $capability string capability name. + */ + function __construct($name, $visiblename, $description, $defaultsetting, $capability) { + $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), + $capability, 'username,firstname,lastname', 'lastname,firstname'); + $choices = array( + '$@NONE@$' => get_string('nobody'), + '$@ALL@$' => get_string('everyonewhocan', 'admin', get_capability_string($capability)), + ); + foreach ($users as $user) { + $choices[$user->username] = fullname($user); + } + parent::admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices); + } + + function get_defaultsetting() { + $this->load_choices(); + if (empty($this->defaultsetting)) { + return array('$@NONE@$'); + } else if (array_key_exists($this->defaultsetting, $this->choices)) { + return $this->defaultsetting; + } else { + return ''; + } + } + + function get_setting() { + $result = parent::get_setting(); + if (empty($result)) { + $result = array('$@NONE@$'); + } + return $result; + } + + function write_setting($data) { + // If all is selected, remove any explicit options. + if (in_array('$@ALL@$', $data)) { + $data = array('$@ALL@$'); + } + // None never needs to be writted to the DB. + if (in_array('$@NONE@$', $data)) { + unset($data[array_search('$@NONE@$', $data)]); + } + return parent::write_setting($data); + } +} + /** * Special checkbox for calendar - resets SESSION vars. */ diff --git a/lib/db/upgrade.php b/lib/db/upgrade.php index abb89504d3..a2525dfc06 100644 --- a/lib/db/upgrade.php +++ b/lib/db/upgrade.php @@ -1295,6 +1295,20 @@ function xmldb_main_upgrade($oldversion) { upgrade_main_savepoint($result, 2009010606); } + if ($result && $oldversion < 2009010800) { + /// Update the notifyloginfailures setting. + if ($CFG->notifyloginfailures == 'mainadmin') { + set_config('notifyloginfailures', get_admin()->username); + } else if ($CFG->notifyloginfailures == 'alladmins') { + set_config('notifyloginfailures', '$@ALL@$'); + } else { + set_config('notifyloginfailures', ''); + } + + /// Main savepoint reached + upgrade_main_savepoint($result, 2009010800); + } + return $result; } diff --git a/lib/moodlelib.php b/lib/moodlelib.php index f8de272d0d..f9e3f23e29 100644 --- a/lib/moodlelib.php +++ b/lib/moodlelib.php @@ -818,6 +818,24 @@ function unset_all_config_for_plugin($plugin) { return $success; } +/** + * Use this funciton to get a list of users from a config setting of type admin_setting_users_with_capability. + * @param string $value the value of the config setting. + * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor. + * @return array of user objects. + */ +function get_users_from_config($value, $capability) { + global $CFG; + if ($value == '$@ALL@$') { + $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability); + } else { + list($where, $params) = $DB->get_in_or_equal(explode(',', $CFG->courserequestnotify)); + $params[] = $CFG->mnet_localhost_id; + $users = $DB->get_records_select('user', 'username ' . $where . ' AND mnethostid = ?', $params); + } + return $users; +} + /** * Get volatile flags * @@ -6556,14 +6574,7 @@ function upgrade_set_timeout($max_execution_time=300) { function notify_login_failures() { global $CFG, $DB; - switch ($CFG->notifyloginfailures) { - case 'mainadmin' : - $recip = array(get_admin()); - break; - case 'alladmins': - $recip = get_admins(); - break; - } + $recip = get_users_from_config($CFG->notifyloginfailures, 'moodle/site:config'); if (empty($CFG->lastnotifyfailure)) { $CFG->lastnotifyfailure=0; diff --git a/version.php b/version.php index 83272855c4..9ea71e3aad 100644 --- a/version.php +++ b/version.php @@ -6,7 +6,7 @@ // This is compared against the values stored in the database to determine // whether upgrades should be performed (see lib/db/*.php) - $version = 2009010606; // YYYYMMDD = date of the last version bump + $version = 2009010800; // YYYYMMDD = date of the last version bump // XX = daily increments $release = '2.0 dev (Build: 20090108)'; // Human-friendly version name