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;
134 $this->bug
= $original;
137 $this->original
= $original;
138 $this->modified
= $modified;
140 $this->roles
['-notapplicable-'] = (sizeof($modified) > 0 ?
array($original['assignedto'], $modified['assignedto']) : array($original['assignedto']));
141 $this->roles
['reporter'] = array($original['userid']);
142 $this->roles
['assignee'] = (sizeof($modified) > 0 ?
array($modified['assignedto']) : array($original['assignedto']));
144 $this->fetch_user_cache();
147 // ###################################################################
149 * Fetches all the users who could be related to the bug and sticks
150 * their information into an array.
154 function fetch_user_cache()
156 $favourites = $this->registry
->db
->query("SELECT userid FROM " . TABLE_PREFIX
. "favourite WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
157 while ($fav = $this->registry
->db
->fetch_array($favourites))
159 $this->roles
['favourite']["$fav[userid]"] = $fav['userid'];
162 $voters = $this->registry
->db
->query_first("SELECT userids FROM " . TABLE_PREFIX
. "vote WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
163 $this->roles
['voter'] = preg_split('#,#', $voters['userids'], 0, PREG_SPLIT_NO_EMPTY
);
165 $commenters = $this->registry
->db
->query("SELECT userid FROM " . TABLE_PREFIX
. "comment WHERE bugid = " . $this->registry
->clean($this->bug
['bugid'], TYPE_UINT
));
166 while ($comment = $this->registry
->db
->fetch_array($commenters))
168 $this->roles
['commenter']["$comment[userid]"] = $comment['userid'];
171 $masterids = array_merge($this->roles
['-notapplicable-'], $this->roles
['reporter'], $this->roles
['assignee'], $this->roles
['favourite'], $this->roles
['voter'], $this->roles
['commenter']);
172 $masterids = $this->registry
->funct
->array_strip_empty(array_unique($masterids));
174 $userinfo = $this->registry
->db
->query("
175 SELECT user.*, useremail.*
176 FROM " . TABLE_PREFIX
. "useremail AS useremail
177 LEFT JOIN " . TABLE_PREFIX
. "user AS user
178 ON (user.userid = useremail.userid)
179 WHERE useremail.userid IN (" . implode(',', $masterids) . ")
181 while ($user = $this->registry
->db
->fetch_array($userinfo))
183 if (!is_array($this->users
["$user[userid]"]))
185 $this->users
["$user[userid]"] = $user;
186 unset($this->users
["$user[userid]"]['mask'], $this->users
["$user[userid]"]['relation']);
188 $this->users
["$user[userid]"]['options']["$user[relation]"] = $user['mask'];
192 // ###################################################################
194 * Sends the appropriate emails for changes to bugs. This function
195 * works a lot like the Logging class by taking BugAPI->objdata and
196 * BugAPI->values and then comparing the two arries and sending emails
197 * with the differences.
201 * @param array Original custom fields data
202 * @param array Modified custom fields data
204 function send_bug_changes_notice($original, $modified)
206 if (!isset($this->modified
['bugid']))
211 // fields with custom mask information
212 if ($this->original
['assignedto'] != $this->modified
['assignedto'])
214 if ($this->original
['assignedto'] != '')
216 $this->notice_no_longer_assigned($this->original
['assignedto']);
218 if ($this->modified
['assignedto'] != '')
220 $this->notice_now_assigned($this->modified
['assignedto']);
223 if ($this->original
['status'] != $this->modified
['status'])
225 $this->notice_status_change($this->original
['status'], $this->modified
['status']);
227 if ($this->original
['resolution'] != $this->modified
['resolution'])
229 $this->notice_resolution_change($this->original
['resolution'], $this->modified
['resolution']);
231 if ($this->original
['duplicates'] != $this->modified
['duplicates'])
233 $this->notice_duplicates_change($this->original
['duplicates'], $this->modified
['duplicates']);
236 // other standard fields that don't have custom masks
237 if ($this->original
['severity'] != $this->modified
['severity'])
239 $this->notice_severity_change($this->original
['severity'], $this->modified
['severity']);
241 if ($this->original
['priority'] != $this->modified
['priority'])
243 $this->notice_priority_change($this->original
['priority'], $this->modified
['priority']);
245 if (($this->original
['product'] != $this->modified
['product']) OR ($this->original
['component'] != $this->modified
['component']) OR ($this->original
['version'] != $this->modified
['version']))
247 $this->notice_pcv_change(array($this->original
['product'], $this->original
['component'], $this->original
['version']), array($this->modified
['product'], $this->modified
['component'], $this->modified
['version']));
255 foreach ($dofields AS $field => $lookup)
257 if ($this->original
["$field"] != $this->modified
["$field"])
259 $this->notice_other_change($field, $this->original
["$field"], $this->modified
["$field"]);
264 foreach ($modified AS $field => $value)
266 if ($field == 'bugid')
270 if ($original["$field"] != $modified["$field"])
272 $this->notice_other_change($field, $original["$field"], $modified["$field"]);
277 // ###################################################################
279 * Sends an email to the specified user ID that they are no longer the
280 * person assigned to the bug.
284 * @param integer User ID to send to
286 function notice_no_longer_assigned($userid)
288 if ($this->users
["$userid"]['options'][0] & $this->registry
->emailoptions
['notifications']['assignedto'] AND in_array($userid, $this->roles
['-notapplicable-']))
290 $this->notices
["$userid"][] = sprintf(
291 $this->registry
->lang
->string('You are no longer assigned to this bug, per %1$s\'s changes.'),
293 construct_user_display($this->registry
->userinfo
, false
)
298 // ###################################################################
300 * Informs the user that they have been made the assignee of the bug.
304 * @param integer User ID
306 function notice_now_assigned($userid)
308 if ($this->users
["$userid"]['options'][0] & $this->registry
->emailoptions
['notifications']['assignedto'] AND in_array($userid, $this->roles
['-notapplicable-']))
310 $this->notices
["$userid"][] = sprintf(
311 $this->registry
->lang
->string('You have been assigned to this bug by %1$s.'),
313 construct_user_display($this->registry
->userinfo
, false
)
318 // ###################################################################
320 * Sends a message to inform users that the status has changed.
324 * @param integer Old status
325 * @param integer New status
327 function notice_status_change($old, $new)
329 $userlist = $this->fetch_users_with_on_bit('statusresolve');
330 foreach ($userlist AS $userid => $user)
332 $this->notices
["$user[userid]"][] = sprintf(
333 $this->registry
->lang
->string('The status field has changed from "%1$s" to "%2$s".'),
335 $this->registry
->datastore
['status']["$old"]['status'],
336 $this->registry
->datastore
['status']["$new"]['status']
341 // ###################################################################
343 * Sends an email to inform users that the resolution has changed.
347 * @param integer Old resolution
348 * @param integer New resolution
350 function notice_resolution_change($old, $new)
352 $userlist = $this->fetch_users_with_on_bit('statusresolve');
353 foreach ($userlist AS $userid => $user)
355 $this->notices
["$user[userid]"][] = sprintf(
356 $this->registry
->lang
->string('The resolution field has changed from "%1$s" to "%2$s".'),
358 $this->registry
->datastore
['resolution']["$old"]['resolution'],
359 $this->registry
->datastore
['resolution']["$new"]['resolution']
364 // ###################################################################
366 * Informs users that the duplicates list has changed.
370 * @param string Old duplicates list
371 * @param string New duplicates list
373 function notice_duplicates_change($old, $new)
375 $userlist = $this->fetch_useres_with_on_bit('duplicates');
376 foreach ($userlist AS $userid => $user)
378 $this->notices
["$user[userid]"][] = sprintf(
379 $this->registry
->lang
->string('The duplicates list has changed from "%1$s" to %2$s".'),
387 // ###################################################################
389 * Sends an email to inform users that the severity has changed.
393 * @param integer Old severity
394 * @param integer New severity
396 function notice_severity_change($old, $new)
398 $userlist = $this->fetch_users_with_on_bit('otherfield');
399 foreach ($userlist AS $userid => $user)
401 $this->notices
["$user[userid]"][] = sprintf(
402 $this->registry
->lang
->string('The severity field has changed from "%1$s" to "%2$s".'),
404 $this->registry
->datastore
['severity']["$old"]['severity'],
405 $this->registry
->datastore
['severity']["$new"]['severity']
410 // ###################################################################
412 * Informs users that the priority changed.
416 * @param integer Old priority
417 * @param integer New priority
419 function notice_priority_change($old, $new)
421 $userlist = $this->fetch_users_with_on_bit('otherfield');
422 foreach ($userlist AS $userid => $user)
424 $this->notices
["$user[userid]"][] = sprintf(
425 $this->registry
->lang
->string('The priority field has changed from "%1$s" to "%2$s".'),
427 $this->registry
->datastore
['priority']["$old"]['priority'],
428 $this->registry
->datastore
['priority']["$new"]['priority']
433 // ###################################################################
435 * Sends an email telling users that the product, component, or version
436 * has changed. This is done all at once because you really need to see
437 * the whole thing in the notice.
441 * @param array Original PCV
442 * @param array Modified PCV
444 function notice_pcv_change($old, $new)
446 $userlist = $this->fetch_users_with_on_bit('otherfield');
447 foreach ($userlist AS $userid => $user)
449 $this->notices
["$user[userid]"][] = sprintf(
450 $this->registry
->lang
->string('The product, component, and version combination has changed from "%1$s" to "%2$s".'),
452 $this->registry
->datastore
['product']["$old[0]"]['title'] . '/' . ($old[1] ?
$this->registry
->datastore
['product']["$old[1]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$old[2]"]['version'],
453 $this->registry
->datastore
['product']["$new[0]"]['title'] . '/' . ($new[1] ?
$this->registry
->datastore
['product']["$new[1]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$new[2]"]['version']
458 // ###################################################################
460 * Sends the appropriate users information about a new comment being
461 * posted to the bug report.
465 * @param array CommentAPI->values array
467 function send_new_comment_notice($comment)
469 $userlist = $this->fetch_users_with_on_bit('newcomment');
470 foreach ($userlist AS $userid => $user)
472 $this->notices
["$user[userid]"][] = sprintf(
473 $this->registry
->lang
->string('The following comment was added by %1$s on %2$s:
474 ============================================
476 ============================================'),
478 construct_user_display($this->registry
->userinfo
, false
),
479 $this->registry
->modules
['date']->format($this->registry
->options
['dateformat'], $comment['dateline']),
485 // ###################################################################
487 * A notice for an individual field changing.
491 * @param string Field name
492 * @param mixed Original value
493 * @param mixed Modified value
495 function notice_other_change($name, $old, $new)
497 $userlist = $this->fetch_users_with_on_bit('otherfield');
498 foreach ($userlist AS $userid => $user)
500 $this->notices
["$user[userid]"][] = sprintf(
501 $this->registry
->lang
->string('The %1$s field changed from "%2$s" to "%3$s".'),
510 // ###################################################################
512 * Sends appropriate users a notice when a new attachment has been
517 * @param array AttachmentAPI->values array
518 * @param array List of all attachments made obsolete
519 * @param array Newly-inserted attachment ID
521 function send_new_attachment_notice($attachment, $obsolete, $id)
523 $userlist = $this->fetch_users_with_on_bit('newattachment');
524 foreach ($userlist AS $userid => $user)
526 $this->notices
["$userid"][] = sprintf(
527 $this->registry
->lang
->string('%1$s has uploaded a new attachment:
528 ============================================
531 File size: %4$s Bytes
534 ============================================'),
536 construct_user_display($this->registry
->userinfo
, false
),
537 $attachment['filename'],
538 $attachment['description'],
539 $attachment['filesize'],
540 implode(', ', (array)$obsolete),
541 $this->registry
->options
['trackerurl'] . '/viewattachment.php?attachmentid=' . $id
546 // ###################################################################
548 * Sends a new bug notification notice to all those who have the option
549 * turned no. This does not use fetch_users_with_on_bit() because a
550 * query is more effective.
554 * @param array Bug values array
555 * @param array Comment values array
557 function send_new_bug_notice($bug, $comment)
559 $userinfo = $this->registry
->db
->query("
560 SELECT user.*, useremail.*
561 FROM " . TABLE_PREFIX
. "useremail AS useremail
562 LEFT JOIN " . TABLE_PREFIX
. "user AS user
563 ON (user.userid = useremail.userid)
564 WHERE useremail.relation = 0
565 AND useremail.mask & " . $this->registry
->emailoptions
['notifications']['newbug'] . "
567 while ($user = $this->registry
->db
->fetch_array($userinfo))
569 if (!is_array($this->users
["$user[userid]"]))
571 $this->notices
["$user[userid]"][] = sprintf(
572 $this->registry
->lang
->string('
573 This bug has been added to the database:
574 ============================================
578 Product/Component/Version: %4$s
580 --------------------------------------------
582 --------------------------------------------
583 ============================================'),
586 construct_user_display($this->registry
->userinfo
, false
),
587 $this->registry
->datastore
['product']["$bug[product]"]['title'] . '/' . ($bug['component'] ?
$this->registry
->datastore
['product']["$bug[component]"]['title'] . '/' : '') . $this->registry
->datastore
['version']["$bug[version]"]['version'],
590 $this->users
["$user[userid]"] = $user;
591 unset($this->users
["$user[userid]"]['mask'], $this->users
["$user[userid]"]['relation']);
593 $this->users
["$user[userid]"]['options']["$user[relation]"] = $user['mask'];
597 // ###################################################################
599 * Generates an array of users who have a given email notification flag
600 * turned on in their bitfields.
604 * @param string Notification bitfield name
606 * @return array Array of users and their data
608 function fetch_users_with_on_bit($bitname)
612 foreach ($this->users
AS $user)
614 foreach ($this->registry
->emailoptions
['relations'] AS $name => $bit)
616 if (in_array($user['userid'], $this->roles
["$name"]) AND $user['options']["$bit"] & $this->registry
->emailoptions
['notifications']["$bitname"])
618 $idlist[] = $user['userid'];
623 $masters = array_unique($idlist);
626 foreach ($masters AS $userid)
628 $return["$userid"] =& $this->users
["$userid"];
634 // ###################################################################
636 * Compiles and sends the actual emails to users.
642 $this->registry
->mail
->set('subject', sprintf($this->registry
->lang
->string('%1$s Bug Notification - %2$s'), $this->registry
->options
['trackertitle'], $this->bug
['summary']));
643 foreach ($this->notices
AS $userid => $noticelist)
645 if ($userid == $this->registry
->userinfo
['userid'])
650 $this->registry
->mail
->to_add($this->users
["$userid"]['displayname'], $this->users
["$userid"]['email']);
651 $this->registry
->mail
->set('bodytext', sprintf($this->registry
->lang
->string('Hi %1$s,
653 You are receiving this email because you have opted to get notifications for the %2$s bug tracker.
655 The bug is "%5$s" (id: %6$s) located at %4$s/showreport.php?bugid=%6$s
657 Here are the notices:
658 ###################################################################
662 ###################################################################
663 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.
666 $this->users
["$userid"]['displayname'],
667 $this->registry
->options
['trackertitle'],
668 implode("\n\n", $noticelist),
669 $this->registry
->options
['trackerurl'],
670 $this->bug
['summary'],
673 $this->registry
->mail
->send(true
);
678 /*=====================================================================*\
679 || ###################################################################
682 || ###################################################################
683 \*=====================================================================*/