includes/class_notification.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Bugdar
   5 || # Copyright ©2002-2007 Blue Static
   6 || #
   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 2 of the License.
  10 || #
  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
  14 || # more details.
  15 || #
  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 \*=====================================================================*/
  21
  22 /**
  23 * Notification Center
  24 *
  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.
  27 *
  28 * @author               Blue Static
  29 * @copyright    Copyright ©2002 - 2007, Blue Static
  30 * @version              $Revision$
  31 * @package              Bugdar
  32 *
  33 */
  34 class NotificationCenter
  35 {
  36         /**
  37         * Bug information
  38         * @var  array
  39         * @access       private
  40         */
  41         var $bug = array();
  42
  43         /**
  44         * Original bug data
  45         * @var  array
  46         * @access       private
  47         */
  48         var $original = array();
  49
  50         /**
  51         * Modified bug data
  52         * @var  array
  53         * @access       private
  54         */
  55         var $modified = array();
  56
  57         /**
  58         * Global bugsys registry
  59         * @var  object
  60         * @access       private
  61         */
  62         var $registry = null;
  63
  64         /**
  65         * Role list: a list of user IDs with their relations to the bug
  66         * @var  array
  67         * @access       private
  68         */
  69         var $roles = array(
  70                 '-notapplicable-'       => array(),
  71                 'reporter'                      => array(),
  72                 'assignee'                      => array(),
  73                 'favorite'                      => array(),
  74                 'voter'                         => array(),
  75                 'commenter'                     => array()
  76         );
  77
  78         /**
  79         * User cache list
  80         * @var  array
  81         * @access       private
  82         */
  83         var $users = array();
  84
  85         /**
  86         * A list of notices per-user that are combined together in NotificationCenter::finalize()
  87         * @var  array
  88         * @access       private
  89         */
  90         var $notices = array();
  91
  92         // ###################################################################
  93         /**
  94         * Constructor: set database objects
  95         *
  96         * @access       public
  97         */
  98         function __construct()
  99         {
 100                 global $bugsys;
 101
 102                 $this->registry =& $bugsys;
 103         }
 104
 105         // ###################################################################
 106         /**
 107         * (PHP 4) Constructor
 108         *
 109         * @access       public
 110         */
 111         function NotificationCenter()
 112         {
 113                 $this->__construct();
 114         }
 115
 116         // ###################################################################
 117         /**
 118         * Sets the bug data so that all methods in this class have access to
 119         * it when sending emails.
 120         *
 121         * @access       public
 122         *
 123         * @param        array   Original bug data
 124         * @param        array   Modified bug data
 125         */
 126         function set_bug_data($original, $modified = array())
 127         {
 128                 if (sizeof($modified) > 0)
 129                 {
 130                         $this->bug = $modified;
 131                 }
 132                 else
 133                 {
 134                         $this->bug = $original;
 135                 }
 136
 137                 $this->original = $original;
 138                 $this->modified = $modified;
 139
 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 ? $modified['assignedto'] : $original['assignedto']);
 143
 144                 $this->fetch_user_cache();
 145         }
 146
 147         // ###################################################################
 148         /**
 149         * Fetches all the users who could be related to the bug and sticks
 150         * their information into an array.
 151         *
 152         * @access       private
 153         */
 154         function fetch_user_cache()
 155         {
 156                 $newbuggers = $this->registry->db->query("SELECT userid FROM " . TABLE_PREFIX . "useremail WHERE relation = " . $this->registry->emailoptions['relations']['-notapplicable-'] . " AND mask & " . $this->registry->emailoptions['notifications']['newbug']);
 157                 foreach ($newbuggers as $newbug)
 158                 {
 159                         $this->roles['-notapplicable-']["$newbug[userid]"] = $newbug['userid'];
 160                 }
 161
 162                 $favorites = $this->registry->db->query("SELECT userid FROM " . TABLE_PREFIX . "favorite WHERE bugid = " . $this->registry->clean($this->bug['bugid'], TYPE_UINT));
 163                 foreach ($favorites as $fav)
 164                 {
 165                         $this->roles['favorite']["$fav[userid]"] = $fav['userid'];
 166                 }
 167
 168                 $voters = $this->registry->db->query_first("SELECT userids FROM " . TABLE_PREFIX . "vote WHERE bugid = " . $this->registry->clean($this->bug['bugid'], TYPE_UINT));
 169                 $this->roles['voter'] = preg_split('#,#', $voters['userids'], 0, PREG_SPLIT_NO_EMPTY);
 170
 171                 $commenters = $this->registry->db->query("SELECT userid FROM " . TABLE_PREFIX . "comment WHERE bugid = " . $this->registry->clean($this->bug['bugid'], TYPE_UINT));
 172                 foreach ($commenters as $comment)
 173                 {
 174                         $this->roles['commenter']["$comment[userid]"] = $comment['userid'];
 175                 }
 176
 177                 $masterids = array_merge($this->roles['-notapplicable-'], $this->roles['reporter'], $this->roles['assignee'], $this->roles['favorite'], $this->roles['voter'], $this->roles['commenter']);
 178                 $masterids = BSFunctions::array_strip_empty(array_unique($masterids));
 179
 180                 if (is_array($masterids) AND sizeof($masterids) > 0)
 181                 {
 182                         $userinfo = $this->registry->db->query("
 183                                 SELECT user.*, useremail.*
 184                                 FROM " . TABLE_PREFIX . "useremail AS useremail
 185                                 LEFT JOIN " . TABLE_PREFIX . "user AS user
 186                                         ON (user.userid = useremail.userid)
 187                                 WHERE useremail.userid IN (" . implode(',', $masterids) . ")
 188                         ");
 189                         foreach ($userinfo as $user)
 190                         {
 191                                 if (!is_array($this->users["$user[userid]"]))
 192                                 {
 193                                         $this->users["$user[userid]"] = $user;
 194                                         unset($this->users["$user[userid]"]['mask'], $this->users["$user[userid]"]['relation']);
 195                                 }
 196                                 $this->users["$user[userid]"]['options']["$user[relation]"] = $user['mask'];
 197                         }
 198                 }
 199         }
 200
 201         // ###################################################################
 202         /**
 203         * Sends the appropriate emails for changes to bugs. This function
 204         * works a lot like the Logging class by taking BugAPI->record and
 205         * BugAPI->values and then comparing the two arries and sending emails
 206         * with the differences.
 207         *
 208         * @access       public
 209         */
 210         function send_bug_changes_notice()
 211         {
 212                 if (!isset($this->modified['bugid']))
 213                 {
 214                         return;
 215                 }
 216
 217                 // fields with custom mask information
 218                 if ($this->original['assignedto'] != $this->modified['assignedto'])
 219                 {
 220                         if ($this->original['assignedto'] != '')
 221                         {
 222                                 $this->notice_no_longer_assigned($this->original['assignedto']);
 223                         }
 224                         if ($this->modified['assignedto'] != '')
 225                         {
 226                                 $this->notice_now_assigned($this->modified['assignedto']);
 227                         }
 228                 }
 229                 if ($this->original['status'] != $this->modified['status'])
 230                 {
 231                         $this->notice_status_change($this->original['status'], $this->modified['status']);
 232                 }
 233                 if ($this->original['resolution'] != $this->modified['resolution'])
 234                 {
 235                         $this->notice_resolution_change($this->original['resolution'], $this->modified['resolution']);
 236                 }
 237                 if ($this->original['duplicates'] != $this->modified['duplicates'])
 238                 {
 239                         $this->notice_duplicates_change($this->original['duplicates'], $this->modified['duplicates']);
 240                 }
 241
 242                 // other standard fields that don't have custom masks
 243                 if ($this->original['severity'] != $this->modified['severity'])
 244                 {
 245                         $this->notice_severity_change($this->original['severity'], $this->modified['severity']);
 246                 }
 247                 if ($this->original['priority'] != $this->modified['priority'])
 248                 {
 249                         $this->notice_priority_change($this->original['priority'], $this->modified['priority']);
 250                 }
 251                 if (($this->original['product'] != $this->modified['product']) OR ($this->original['component'] != $this->modified['component']) OR ($this->original['version'] != $this->modified['version']))
 252                 {
 253                         $this->notice_pcv_change(array($this->original['product'], $this->original['component'], $this->original['version']), array($this->modified['product'], $this->modified['component'], $this->modified['version']));
 254                 }
 255
 256                 $dofields = array(
 257                         'summary'               => -1,
 258                         'dependency'    => -1,
 259                         'hidden'                => -1
 260                 );
 261                 foreach ($dofields AS $field => $lookup)
 262                 {
 263                         if ($this->original["$field"] != $this->modified["$field"])
 264                         {
 265                                 $this->notice_other_change($field, $this->original["$field"], $this->modified["$field"]);
 266                         }
 267                 }
 268         }
 269
 270         // ###################################################################
 271         /**
 272         * Sends an email to the specified user ID that they are no longer the
 273         * person assigned to the bug.
 274         *
 275         * @access       private
 276         *
 277         * @param        integer User ID to send to
 278         */
 279         function notice_no_longer_assigned($userid)
 280         {
 281                 if ($this->users["$userid"]['options'][0] & $this->registry->emailoptions['notifications']['assignedto'] AND in_array($userid, $this->roles['-notapplicable-']))
 282                 {
 283                         $user = construct_user_display(bugdar::$userinfo, false);
 284                         eval('$part = "' . $this->registry->template->fetch(FetchEmailPath('notice_unassigned.part', $this->_localeFromUserId($userid))) . '";');
 285                         $this->notices["$userid"][] = $part;
 286                 }
 287         }
 288
 289         // ###################################################################
 290         /**
 291         * Informs the user that they have been made the assignee of the bug.
 292         *
 293         * @access       private
 294         *
 295         * @param        integer User ID
 296         */
 297         function notice_now_assigned($userid)
 298         {
 299                 if ($this->users["$userid"]['options'][0] & $this->registry->emailoptions['notifications']['assignedto'] AND in_array($userid, $this->roles['-notapplicable-']))
 300                 {
 301                         $user = construct_user_display(bugdar::$userinfo, false);
 302                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_assigned.part', $this->_localeFromUserId($userid))) . '";');
 303                         $this->notices["$userid"][] = $email;
 304                 }
 305         }
 306
 307         // ###################################################################
 308         /**
 309         * Sends a message to inform users that the status has changed.
 310         *
 311         * @access       private
 312         *
 313         * @param        integer Old status
 314         * @param        integer New status
 315         */
 316         function notice_status_change($old, $new)
 317         {
 318                 $userlist = $this->fetch_users_with_on_bit('statusresolve');
 319                 foreach ($userlist AS $userid => $user)
 320                 {
 321                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_status.part', $this->_localeFromUserId($userid))) . '";');
 322                         $this->notices["$user[userid]"][] = $email;
 323                 }
 324         }
 325
 326         // ###################################################################
 327         /**
 328         * Sends an email to inform users that the resolution has changed.
 329         *
 330         * @access       private
 331         *
 332         * @param        integer Old resolution
 333         * @param        integer New resolution
 334         */
 335         function notice_resolution_change($old, $new)
 336         {
 337                 $userlist = $this->fetch_users_with_on_bit('statusresolve');
 338                 foreach ($userlist AS $userid => $user)
 339                 {
 340                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_resolution.part', $this->_localeFromUserId($userid))) . '";');
 341                         $this->notices["$user[userid]"][] = $email;
 342                 }
 343         }
 344
 345         // ###################################################################
 346         /**
 347         * Informs users that the duplicates list has changed.
 348         *
 349         * @access       private
 350         *
 351         * @param        string  Old duplicates list
 352         * @param        string  New duplicates list
 353         */
 354         function notice_duplicates_change($old, $new)
 355         {
 356                 $userlist = $this->fetch_useres_with_on_bit('duplicates');
 357                 foreach ($userlist AS $userid => $user)
 358                 {
 359                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_duplicates.part', $this->_localeFromUserId($userid))) . '";');
 360                         $this->notices["$user[userid]"][] = $email;
 361                 }
 362         }
 363
 364         // ###################################################################
 365         /**
 366         * Sends an email to inform users that the severity has changed.
 367         *
 368         * @access       private
 369         *
 370         * @param        integer Old severity
 371         * @param        integer New severity
 372         */
 373         function notice_severity_change($old, $new)
 374         {
 375                 $userlist = $this->fetch_users_with_on_bit('otherfield');
 376                 foreach ($userlist AS $userid => $user)
 377                 {
 378                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_severity.part', $this->_localeFromUserId($userid))) . '";');
 379                         $this->notices["$user[userid]"][] = $email;
 380                 }
 381         }
 382
 383         // ###################################################################
 384         /**
 385         * Informs users that the priority changed.
 386         *
 387         * @access       private
 388         *
 389         * @param        integer Old priority
 390         * @param        integer New priority
 391         */
 392         function notice_priority_change($old, $new)
 393         {
 394                 $userlist = $this->fetch_users_with_on_bit('otherfield');
 395                 foreach ($userlist AS $userid => $user)
 396                 {
 397                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_priority.part', $this->_localeFromUserId($userid))) . '";');
 398                         $this->notices["$user[userid]"][] = $email;
 399                 }
 400         }
 401
 402         // ###################################################################
 403         /**
 404         * Sends an email telling users that the product, component, or version
 405         * has changed. This is done all at once because you really need to see
 406         * the whole thing in the notice.
 407         *
 408         * @access       private
 409         *
 410         * @param        array   Original PCV
 411         * @param        array   Modified PCV
 412         */
 413         function notice_pcv_change($old, $new)
 414         {
 415                 $userlist = $this->fetch_users_with_on_bit('otherfield');
 416
 417                 $old = bugdar::$datastore['product']["$old[0]"]['title'] . '/' . ($old[1] ? bugdar::$datastore['product']["$old[1]"]['title'] . '/' : '') . bugdar::$datastore['version']["$old[2]"]['version'];
 418                 $new =  bugdar::$datastore['product']["$new[0]"]['title'] . '/' . ($new[1] ? bugdar::$datastore['product']["$new[1]"]['title'] . '/' : '') . bugdar::$datastore['version']["$new[2]"]['version'];
 419
 420                 foreach ($userlist AS $userid => $user)
 421                 {
 422                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_product.part', $this->_localeFromUserId($userid))) . '";');
 423                         $this->notices["$user[userid]"][] = $email;
 424                 }
 425         }
 426
 427         // ###################################################################
 428         /**
 429         * Sends the appropriate users information about a new comment being
 430         * posted to the bug report.
 431         *
 432         * @access       public
 433         *
 434         * @param        array   CommentAPI->values array
 435         */
 436         function send_new_comment_notice($comment)
 437         {
 438                 $userlist = $this->fetch_users_with_on_bit('newcomment');
 439                 foreach ($userlist AS $userid => $user)
 440                 {
 441                         $user = construct_user_display(bugdar::$userinfo, false);
 442                         $date = $this->registry->modules['date']->format(bugdar::$options['dateformat'], $comment['dateline']);
 443
 444                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_comment.part', $this->_localeFromUserId($userid))) . '";');
 445                         $this->notices["$userid"][] = $email;
 446                 }
 447         }
 448
 449         // ###################################################################
 450         /**
 451         * A notice for an individual field changing.
 452         *
 453         * @access       private
 454         *
 455         * @param        string  Field name
 456         * @param        mixed   Original value
 457         * @param        mixed   Modified value
 458         */
 459         function notice_other_change($name, $old, $new)
 460         {
 461                 $userlist = $this->fetch_users_with_on_bit('otherfield');
 462                 foreach ($userlist AS $userid => $user)
 463                 {
 464                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_other.part', $this->_localeFromUserId($userid))) . '";');
 465                         $this->notices["$user[userid]"][] = $email;
 466                 }
 467         }
 468
 469         // ###################################################################
 470         /**
 471         * Sends appropriate users a notice when a new attachment has been
 472         * added.
 473         *
 474         * @access       public
 475         *
 476         * @param        array   AttachmentAPI->values array
 477         * @param        array   List of all attachments made obsolete
 478         * @param        array   Newly-inserted attachment ID
 479         */
 480         function send_new_attachment_notice($attachment, $obsolete, $id)
 481         {
 482                 $userlist = $this->fetch_users_with_on_bit('newattachment');
 483                 foreach ($userlist AS $userid => $user)
 484                 {
 485                         $user = construct_user_display(bugdar::$userinfo, false);
 486                         $obsoletes = implode(', ', (array)$obsolete);
 487
 488                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_attachment.part', $this->_localeFromUserId($userid))) . '";');
 489                         $this->notices["$userid"][] = $email;
 490                 }
 491         }
 492
 493         // ###################################################################
 494         /**
 495         * Sends a new bug notification notice to all those who have the option
 496         * turned no. This does not use fetch_users_with_on_bit() because a
 497         * query is more effective.
 498         *
 499         * @access       public
 500         *
 501         * @param        array   Bug values array
 502         * @param        array   Comment values array
 503         */
 504         function send_new_bug_notice($bug, $comment)
 505         {
 506                 $userinfo = $this->registry->db->query("
 507                         SELECT user.*, useremail.*
 508                         FROM " . TABLE_PREFIX . "useremail AS useremail
 509                         LEFT JOIN " . TABLE_PREFIX . "user AS user
 510                                 ON (user.userid = useremail.userid)
 511                         WHERE useremail.relation = 0
 512                         AND useremail.mask & " . $this->registry->emailoptions['notifications']['newbug'] . "
 513                 ");
 514                 foreach ($userinfo as $userInfo)
 515                 {
 516                         if (!is_array($this->users["$userInfo[userid]"]))
 517                         {
 518                                 $user = construct_user_display(bugdar::$userinfo, false);
 519                                 $this->users["$userInfo[userid]"] = $userInfo;
 520                                 $product = bugdar::$datastore['product']["$bug[product]"]['title'] . '/' . ($bug['component'] ? bugdar::$datastore['product']["$bug[component]"]['title'] . '/' : '') . bugdar::$datastore['version']["$bug[version]"]['version'];
 521                                 eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('notice_new_bug.part', $this->_localeFromUserId($userInfo['userid']))) . '";');
 522                                 $this->notices["$userInfo[userid]"][] = $email;
 523                                 unset($this->users["$userInfo[userid]"]['mask'], $this->users["$userInfo[userid]"]['relation']);
 524                         }
 525                         $this->users["$userInfo[userid]"]['options']["$userInfo[relation]"] = $userInfo['mask'];
 526                 }
 527         }
 528
 529         // ###################################################################
 530         /**
 531         * Generates an array of users who have a given email notification flag
 532         * turned on in their bitfields.
 533         *
 534         * @access       private
 535         *
 536         * @param        string  Notification bitfield name
 537         *
 538         * @return       array   Array of users and their data
 539         */
 540         function fetch_users_with_on_bit($bitname)
 541         {
 542                 $idlist = array();
 543
 544                 foreach ($this->users AS $user)
 545                 {
 546                         foreach ($this->registry->emailoptions['relations'] AS $name => $bit)
 547                         {
 548                                 if (in_array($user['userid'], $this->roles["$name"]) AND $user['options']["$bit"] & $this->registry->emailoptions['notifications']["$bitname"])
 549                                 {
 550                                         $idlist[] = $user['userid'];
 551                                 }
 552                         }
 553                 }
 554
 555                 $masters = array_unique($idlist);
 556
 557                 $return = array();
 558                 foreach ($masters AS $userid)
 559                 {
 560                         $return["$userid"] =& $this->users["$userid"];
 561                 }
 562
 563                 return $return;
 564         }
 565
 566         // ###################################################################
 567         /**
 568         * Compiles and sends the actual emails to users.
 569         *
 570         * @access       public
 571         */
 572         function finalize()
 573         {
 574                 // get the current bug for permissions checks
 575                 $bug = $this->registry->db->query_first("SELECT * FROM " . TABLE_PREFIX . "bug WHERE bugid = " . $this->bug['bugid']);
 576                 foreach ($this->notices AS $userid => $noticelist)
 577                 {
 578                         if ($userid == bugdar::$userinfo['userid'])
 579                         {
 580                                 $this->registry->debug("skipping user $userid because they're the one doing the thing");
 581                                 continue;
 582                         }
 583
 584                         // we wouldn't want people who favorite bugs getting hidden notices
 585                         if (!check_bug_permissions($bug, $this->users["$userid"]))
 586                         {
 587                                 $this->registry->debug("skipping user $userid ({$this->users[$userid]['email']}) because of permissions");
 588                                 continue;
 589                         }
 590
 591                         $parts = implode("\n\n", $noticelist);
 592
 593                         eval('$email = "' . $this->registry->template->fetch(FetchEmailPath('bugnotification.xml', $this->_localeFromUserId($userid))) . '";');
 594                         $email = $this->registry->xml->parse($email, true);
 595                         $this->registry->mail->setSubject($email['email']['subject']['value']);
 596                         $this->registry->mail->setBodyText($email['email']['bodyText']['value']);
 597
 598                         if (!empty($this->users["$userid"]['email']))
 599                         {
 600                                 $this->registry->mail->send($this->users["$userid"]['email'], $this->users["$userid"]['displayname']);
 601                         }
 602                         else
 603                         {
 604                                 $this->registry->debug("not sending an email to " . $userid . " because they don't have one?");
 605                         }
 606                 }
 607         }
 608
 609         // ###################################################################
 610         /**
 611         * Returns the locale name from a given user ID
 612         *
 613         * @param        integer User ID
 614         *
 615         * @return       string  Locale
 616         */
 617         function _localeFromUserId($userid)
 618         {
 619                 $langcode = bugdar::$datastore['language'][$this->users[$userid]['languageid']]['langcode'];
 620                 if (!$langcode)
 621                 {
 622                         $langcode = bugdar::$datastore['language'][bugdar::$options['defaultlanguage']]['langcode'];
 623                 }
 624                 return $langcode;
 625         }
 626 }
 627
 628 /*=====================================================================*\
 629 || ###################################################################
 630 || # $HeadURL$
 631 || # $Id$
 632 || ###################################################################
 633 \*=====================================================================*/
 634 ?>