2 /*=====================================================================*\
3 || ###################################################################
4 || # Bugdar [#]version[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
25 * This class determines which emails need to be sent out based on user
26 * options and bug changes, and then it sends said emails.
29 * @copyright Copyright ©2002 - [#]year[#], Blue Static
34 class NotificationCenter
48 var $original = array();
55 var $modified = array();
58 * Global bugsys registry
65 * Role list: a list of user IDs with their relations to the bug
70 '-notapplicable-' => array(),
71 'reporter' => array(),
72 'assignee' => array(),
73 'favourite' => array(),
75 'commenter' => array()
86 * A list of notices per-user that are combined together in NotificationCenter::finalize()
90 var $notices = array();
92 // ###################################################################
94 * Constructor: set database objects
98 function __construct()
102 $this->registry
=& $bugsys;
105 // ###################################################################
107 * (PHP 4) Constructor
111 function NotificationCenter()
113 $this->__construct();
116 // ###################################################################
118 * Sets the bug data so that all methods in this class have access to
119 * it when sending emails.
123 * @param array Original bug data
124 * @param array Modified bug data
126 function set_bug_data($original, $modified = array())
128 if (sizeof($modified) > 0)
130 $this->bug
= $modified;
133 $this->original
= $original;
134 $this->modified
= $modified;
136 $this->roles
['-notapplicable-'] = (sizeof($modified) > 0 ?
array($original['assignedto'], $modified['assignedto']) : array($original['assignedto']));
137 $this->roles
['reporter'] = array($original['userid']);
138 $this->roles
['assignee'] = (sizeof($modified) > 0 ?
array($modified['assignedto']) : array($original['assignedto']));
140 $this->fetch_user_cache();
143 // ###################################################################
145 * Fetches all the users who could be related to the bug and sticks
146 * their information into an array.
150 function fetch_user_cache()
152 $favourites = $this->registry
->db
->query("SELECT userid FROM " . TABLE_PREFIX
. "favourite WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
153 while ($fav = $this->registry
->db
->fetch_array($favourites))
155 $this->roles
['favourite']["$fav[userid]"] = $fav['userid'];
158 $voters = $this->registry
->db
->query_first("SELECT userids FROM " . TABLE_PREFIX
. "vote WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
159 $this->roles
['voter'] = preg_split('#,#', $voters['userids'], 0, PREG_SPLIT_NO_EMPTY
);
161 $commenters = $this->registry
->db
->query("SELECT userid FROM " . TABLE_PREFIX
. "comment WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
162 while ($comment = $this->registry
->db
->fetch_array($commenters))
164 $this->roles
['commenter']["$comment[userid]"] = $comment['userid'];
167 $masterids = array_merge($this->roles
['-notapplicable-'], $this->roles
['reporter'], $this->roles
['assignee'], $this->roles
['favourite'], $this->roles
['voter'], $this->roles
['commenter']);
168 $masterids = array_unique($masterids);
170 $userinfo = $this->registry
->db
->query("
171 SELECT user.*, useremail.*
172 FROM " . TABLE_PREFIX
. "useremail AS useremail
173 LEFT JOIN " . TABLE_PREFIX
. "user AS user
174 ON (user.userid = useremail.userid)
175 WHERE useremail.userid IN (" . implode(',', $masterids) . ")
177 while ($user = $this->registry
->db
->fetch_array($userinfo))
179 if (!is_array($this->users
["$user[userid]"]))
181 $this->users
["$user[userid]"] = $user;
182 unset($this->users
["$user[userid]"]['mask'], $this->users
["$user[userid]"]['relation']);
184 $this->users
["$user[userid]"]['options']["$user[relation]"] = $user['mask'];
188 // ###################################################################
190 * Sends the appropriate emails for changes to bugs. This function
191 * works a lot like the Logging class by taking BugAPI->objdata and
192 * BugAPI->values and then comparing the two arries and sending emails
193 * with the differences.
197 * @param array Original custom fields data
198 * @param array Modified custom fields data
200 function send_bug_changes_notice($original, $modified)
202 if (!isset($this->modified
['bugid']))
207 // fields with custom mask information
208 if ($this->original
['assignedto'] != $this->modified
['assignedto'])
210 if ($this->original
['assignedto'] != '')
212 $this->notice_no_longer_assigned($this->original
['assignedto']);
214 if ($this->modified
['assignedto'] != '')
216 $this->notice_now_assigned($this->modified
['assignedto']);
219 if ($this->original
['status'] != $this->modified
['status'])
221 $this->notice_status_change($this->original
['status'], $this->modified
['status']);
223 if ($this->original
['resolution'] != $this->modified
['resolution'])
225 $this->notice_resolution_change($this->original
['resolution'], $this->modified
['resolution']);
227 if ($this->original
['duplicates'] != $this->modified
['duplicates'])
229 $this->notice_duplicates_change($this->original
['duplicates'], $this->modified
['duplicates']);
232 // other standard fields that don't have custom masks
233 if ($this->original
['severity'] != $this->modified
['severity'])
235 $this->notice_severity_change($this->original
['severity'], $this->modified
['severity']);
237 if ($this->original
['priority'] != $this->modified
['priority'])
239 $this->notice_priority_change($this->original
['priority'], $this->modified
['priority']);
241 if (($this->original
['product'] != $this->modified
['product']) OR ($this->original
['component'] != $this->modified
['component']) OR ($this->original
['version'] != $this->modified
['version']))
243 $this->notice_pcv_change(array($this->original
['product'], $this->original
['component'], $this->original
['version']), array($this->modified
['product'], $this->modified
['component'], $this->modified
['version']));
251 foreach ($dofields AS $field => $lookup)
253 if ($this->original
["$field"] != $this->modified
["$field"])
255 $this->notice_other_change($field, $this->original
["$field"], $this->modified
["$field"]);
260 foreach ($modified AS $field => $value)
262 if ($field == 'bugid')
266 if ($original["$field"] != $modified["$field"])
268 $this->notice_other_change($field, $original["$field"], $modified["$field"]);
273 // ###################################################################
275 * Sends an email to the specified user ID that they are no longer the
276 * person assigned to the bug.
280 * @param integer User ID to send to
282 function notice_no_longer_assigned($userid)
284 if ($this->users
["$userid"]['options'][0] & $this->registry
->emailoptions
['notifications']['assignedto'] AND in_array($userid, $this->roles
['-notapplicable-']))
286 $this->notices
["$userid"][] = sprintf(
287 $this->registry
->lang
->string('You are no longer assigned to this bug, per %1$s\'s changes.'),
289 construct_user_display($this->registry
->userinfo
, false
)
294 // ###################################################################
296 * Informs the user that they have been made the assignee of the bug.
300 * @param integer User ID
302 function notice_now_assigned($userid)
304 if ($this->users
["$userid"]['options'][0] & $this->registry
->emailoptions
['notifications']['assignedto'] AND in_array($userid, $this->roles
['-notapplicable-']))
306 $this->notices
["$userid"][] = sprintf(
307 $this->registry
->lang
->string('You have been assigned to this bug by %1$s.'),
309 construct_user_display($this->registry
->userinfo
, false
)
314 // ###################################################################
316 * Sends a message to inform users that the status has changed.
320 * @param integer Old status
321 * @param integer New status
323 function notice_status_change($old, $new)
325 $userlist = $this->fetch_users_with_on_bit('statusresolve');
326 foreach ($userlist AS $userid => $user)
328 $this->notices
["$user[userid]"][] = sprintf(
329 $this->registry
->lang
->string('The status field has changed from "%1$s" to "%2$s".'),
331 $this->registry
->datastore
['status']["$old"]['status'],
332 $this->registry
->datastore
['status']["$new"]['status']
337 // ###################################################################
339 * Sends an email to inform users that the resolution has changed.
343 * @param integer Old resolution
344 * @param integer New resolution
346 function notice_resolution_change($old, $new)
348 $userlist = $this->fetch_users_with_on_bit('statusresolve');
349 foreach ($userlist AS $userid => $user)
351 $this->notices
["$user[userid]"][] = sprintf(
352 $this->registry
->lang
->string('The resolution field has changed from "%1$s" to "%2$s".'),
354 $this->registry
->datastore
['resolution']["$old"]['resolution'],
355 $this->registry
->datastore
['resolution']["$new"]['resolution']
360 // ###################################################################
362 * Informs users that the duplicates list has changed.
366 * @param string Old duplicates list
367 * @param string New duplicates list
369 function notice_duplicates_change($old, $new)
371 $userlist = $this->fetch_useres_with_on_bit('duplicates');
372 foreach ($userlist AS $userid => $user)
374 $this->notices
["$user[userid]"][] = sprintf(
375 $this->registry
->lang
->string('The duplicates list has changed from "%1$s" to %2$s".'),
383 // ###################################################################
385 * Sends an email to inform users that the severity has changed.
389 * @param integer Old severity
390 * @param integer New severity
392 function notice_severity_change($old, $new)
394 $userlist = $this->fetch_users_with_on_bit('otherfield');
395 foreach ($userlist AS $userid => $user)
397 $this->notices
["$user[userid]"][] = sprintf(
398 $this->registry
->lang
->string('The severity field has changed from "%1$s" to "%2$s".'),
400 $this->registry
->datastore
['severity']["$old"]['severity'],
401 $this->registry
->datastore
['severity']["$new"]['severity']
406 // ###################################################################
408 * Informs users that the priority changed.
412 * @param integer Old priority
413 * @param integer New priority
415 function notice_priority_change($old, $new)
417 $userlist = $this->fetch_users_with_on_bit('otherfield');
418 foreach ($userlist AS $userid => $user)
420 $this->notices
["$user[userid]"][] = sprintf(
421 $this->registry
->lang
->string('The priority field has changed from "%1$s" to "%2$s".'),
423 $this->registry
->datastore
['priority']["$old"]['priority'],
424 $this->registry
->datastore
['priority']["$new"]['priority']
429 // ###################################################################
431 * Sends an email telling users that the product, component, or version
432 * has changed. This is done all at once because you really need to see
433 * the whole thing in the notice.
437 * @param array Original PCV
438 * @param array Modified PCV
440 function notice_pcv_change($old, $new)
442 $userlist = $this->fetch_users_with_on_bit('otherfield');
443 foreach ($userlist AS $userid => $user)
445 $this->notices
["$user[userid]"][] = sprintf(
446 $this->registry
->lang
->string('The product, component, and version combination has changed from "%1$s" to "%2$s".'),
448 $this->registry
->datastore
['product']["$old[0]"]['title'] . '/' . ($old[1] ?
$this->registry
->datastore
['product']["$old[1]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$old[2]"]['version'],
449 $this->registry
->datastore
['product']["$new[0]"]['title'] . '/' . ($new[1] ?
$this->registry
->datastore
['product']["$new[1]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$new[2]"]['version']
454 // ###################################################################
456 * Sends the appropriate users information about a new comment being
457 * posted to the bug report.
461 * @param array CommentAPI->values array
463 function send_new_comment_notice($comment)
465 $userlist = $this->fetch_users_with_on_bit('newcomment');
466 foreach ($userlist AS $userid => $user)
468 $this->notices
["$user[userid]"][] = sprintf(
469 $this->registry
->lang
->string('The following comment was added by %1$s on %2$s:
470 ============================================
472 ============================================'),
474 construct_user_display($this->registry
->userinfo
, false
),
475 $this->registry
->modules
['date']->format($this->registry
->options
['dateformat'], $comment['dateline']),
481 // ###################################################################
483 * A notice for an individual field changing.
487 * @param string Field name
488 * @param mixed Original value
489 * @param mixed Modified value
491 function notice_other_change($name, $old, $new)
493 $userlist = $this->fetch_users_with_on_bit('otherfield');
494 foreach ($userlist AS $userid => $user)
496 $this->notices
["$user[userid]"][] = sprintf(
497 $this->registry
->lang
->string('The %1$s field changed from "%2$s" to "%3$s".'),
506 // ###################################################################
508 * Sends appropriate users a notice when a new attachment has been
513 * @param array AttachmentAPI->values array
514 * @param array List of all attachments made obsolete
515 * @param array Newly-inserted attachment ID
517 function send_new_attachment_notice($attachment, $obsolete, $id)
519 $userlist = $this->fetch_users_with_on_bit('newattachment');
520 foreach ($userlist AS $userid => $user)
522 $this->notices
["$userid"][] = sprintf(
523 $this->registry
->lang
->string('%1$s has uploaded a new attachment:
524 ============================================
527 File size: %4$s Bytes
530 ============================================'),
532 construct_user_display($this->registry
->userinfo
, false
),
533 $attachment['filename'],
534 $attachment['description'],
535 $attachment['filesize'],
536 implode(', ', (array)$obsolete),
537 $this->registry
->options
['trackerurl'] . '/viewattachment.php?attachmentid=' . $id
542 // ###################################################################
544 * Sends a new bug notification notice to all those who have the option
545 * turned no. This does not use fetch_users_with_on_bit() because a
546 * query is more effective.
550 * @param array Bug values array
551 * @param array Comment values array
553 function send_new_bug_notice($bug, $comment)
555 $userinfo = $this->registry
->db
->query("
556 SELECT user.*, useremail.*
557 FROM " . TABLE_PREFIX
. "useremail AS useremail
558 LEFT JOIN " . TABLE_PREFIX
. "user AS user
559 ON (user.userid = useremail.userid)
560 WHERE useremail.relation = 0
561 AND useremail.mask & " . $this->registry
->emailoptions
['notifications']['newbug'] . "
563 while ($user = $this->registry
->db
->fetch_array($userinfo))
565 if (!is_array($this->users
["$user[userid]"]))
567 $this->notices
["$user[userid]"][] = sprintf(
568 $this->registry
->lang
->string('
569 This bug has been added to the database:
570 ============================================
574 Product/Component/Version: %4$s
576 --------------------------------------------
578 --------------------------------------------
579 ============================================'),
582 construct_user_display($this->registry
->userinfo
, false
),
583 $this->registry
->datastore
['product']["$bug[product]"]['title'] . '/' . ($bug['component'] ?
$this->registry
->datastore
['product']["$bug[component]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$bug[version]"]['version'],
586 $this->users
["$user[userid]"] = $user;
587 unset($this->users
["$user[userid]"]['mask'], $this->users
["$user[userid]"]['relation']);
589 $this->users
["$user[userid]"]['options']["$user[relation]"] = $user['mask'];
593 // ###################################################################
595 * Generates an array of users who have a given email notification flag
596 * turned on in their bitfields.
600 * @param string Notification bitfield name
602 * @return array Array of users and their data
604 function fetch_users_with_on_bit($bitname)
608 foreach ($this->users
AS $user)
610 foreach ($this->registry
->emailoptions
['relations'] AS $name => $bit)
612 if (in_array($user['userid'], $this->roles
["$name"]) AND $user['options']["$bit"] & $this->registry
->emailoptions
['notifications']["$bitname"])
614 $idlist[] = $user['userid'];
619 $masters = array_unique($idlist);
622 foreach ($masters AS $userid)
624 $return["$userid"] =& $this->users
["$userid"];
630 // ###################################################################
632 * Compiles and sends the actual emails to users.
638 $this->registry
->mail
->set('subject', sprintf($this->registry
->lang
->string('%1$s Bug Notification - %2$s'), $this->registry
->options
['trackertitle'], $this->bug
['summary']));
639 foreach ($this->notices
AS $userid => $noticelist)
641 if ($userid == $this->registry
->userinfo
['userid'])
646 $this->registry
->mail
->to_add($this->users
["$userid"]['displayname'], $this->users
["$userid"]['email']);
647 $this->registry
->mail
->set('bodytext', sprintf($this->registry
->lang
->string('Hi %1$s,
649 You are receiving this email because you have opted to get notifications for the %2$s bug tracker.
651 The bug is "%5$s" (id: %6$s) located at %4$s/showreport.php?bugid=%6$s
653 Here are the notices:
654 ###################################################################
658 ###################################################################
659 If you no longer want to receive email from us, please log into your account and click the "My Controls" tab at the top of the screen to change email preferences.
662 $this->users
["$userid"]['displayname'],
663 $this->registry
->options
['trackertitle'],
664 implode("\n\n", $noticelist),
665 $this->registry
->options
['trackerurl'],
666 $this->bug
['summary'],
669 $this->registry
->mail
->send(true
);
674 /*=====================================================================*\
675 || ###################################################################
678 || ###################################################################
679 \*=====================================================================*/