Permalink
Browse files

MDL-30260 message: added /message/upgrade.txt, checked calls to messa…

…ge_send() are supplying user.emailstop and improved message_send() to handle message requests that don't
  • Loading branch information...
1 parent cf04ce3 commit e732701b393d51ad3a569e6efdd0ee48771243fd @andyjdavis andyjdavis committed Nov 16, 2011
Showing with 25 additions and 5 deletions.
  1. +3 −0 error/index.php
  2. +1 −1 lib/accesslib.php
  3. +9 −2 lib/messagelib.php
  4. +9 −0 message/upgrade.txt
  5. +2 −1 mod/forum/lib.php
  6. +1 −1 mod/quiz/locallib.php
View
@@ -19,6 +19,9 @@
$supportuser->email = $CFG->supportemail ? $CFG->supportemail : $admin->email;
$supportuser->firstname = $CFG->supportname ? $CFG->supportname : $admin->firstname;
$supportuser->lastname = $CFG->supportname ? '' : $admin->lastname;
+ //emailstop could be hard coded "false" to ensure error reports are sent
+ //but then admin's would have to alter their messaging preferences to temporarily stop them
+ $supportuser->emailstop = $admin->emailstop;
$supportuser->maildisplay = true;
/// Send the message and redirect
View
@@ -5205,7 +5205,7 @@ function get_role_users($roleid, $context, $parent = false, $fields = '',
if (empty($fields)) {
$fields = 'u.id, u.confirmed, u.username, u.firstname, u.lastname, '.
- 'u.maildisplay, u.mailformat, u.maildigest, u.email, u.city, '.
+ 'u.maildisplay, u.mailformat, u.maildigest, u.email, u.emailstop, u.city, '.
'u.country, u.picture, u.idnumber, u.department, u.institution, '.
'u.lang, u.timezone, u.lastaccess, u.mnethostid, r.name AS rolename, r.sortorder';
}
View
@@ -139,12 +139,19 @@ function message_send($eventdata) {
debugging('Attempt to force message delivery to user who has "'.$processor->name.'" output unconfigured', DEBUG_NORMAL);
}
+ //warn developers that necessary data is missing regardless of how the processors are configured
+ if (!isset($eventdata->userto->emailstop)) {
+ debugging('userto->emailstop is not set. Retreiving it from the user table');
+ $eventdata->userto->emailstop = $DB->get_field('user', 'emailstop', array('id'=>$eventdata->userto->id));
+ }
+
// Populate the list of processors we will be using
if ($permitted == 'forced' && $userisconfigured) {
- // We force messages for this processor, so use this processor unconditionally if user has configured it
+ // An admin is forcing users to use this message processor. Use this processor unconditionally.
$processorlist[] = $processor->name;
} else if ($permitted == 'permitted' && $userisconfigured && !$eventdata->userto->emailstop) {
- // User settings are permitted, see if user set any, otherwise use site default ones
+ //user has not disabled notifications
+ //see if user set any notification preferences, otherwise use site default ones
$userpreferencename = 'message_provider_'.$preferencebase.'_'.$userstate;
if ($userpreference = get_user_preferences($userpreferencename, null, $eventdata->userto->id)) {
if (in_array($processor->name, explode(',', $userpreference))) {
View
@@ -0,0 +1,9 @@
+This files describes API changes in /message/ messaging system,
+information provided here is intended especially for developers.
+
+=== 2.2 ===
+
+required changes:
+* lib/messagelib.php message_send($eventdata)
+ $eventdata->userto should contain a property called "emailstop", $eventdata->userto->emailstop
+ If it is absent it will be retrieved from the user table causing an additional database query
View
@@ -2854,6 +2854,7 @@ function forum_subscribed_users($course, $forum, $groupid=0, $context = null, $f
u.maildigest,
u.imagealt,
u.email,
+ u.emailstop,
u.city,
u.country,
u.lastaccess,
@@ -8357,4 +8358,4 @@ function forum_get_posts_by_user($user, array $courses, $musthaveaccess = false,
}
return $return;
-}
+}
@@ -1201,7 +1201,7 @@ function quiz_send_notification_messages($course, $quiz, $attempt, $context, $cm
}
// check for notifications required
- $notifyfields = 'u.id, u.username, u.firstname, u.lastname, u.idnumber, u.email, ' .
+ $notifyfields = 'u.id, u.username, u.firstname, u.lastname, u.idnumber, u.email, u.emailstop, ' .
'u.lang, u.timezone, u.mailformat, u.maildisplay';
$groups = groups_get_all_groups($course->id, $submitter->id);
if (is_array($groups) && count($groups) > 0) {

0 comments on commit e732701

Please sign in to comment.