BugMail.pm 29.4 KB
Newer Older
1
# -*- Mode: perl; indent-tabs-mode: nil -*-
terry%netscape.com's avatar
terry%netscape.com committed
2
#
3 4 5 6 7 8 9 10 11 12
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
terry%netscape.com's avatar
terry%netscape.com committed
13
# The Original Code is the Bugzilla Bug Tracking System.
14
#
terry%netscape.com's avatar
terry%netscape.com committed
15
# The Initial Developer of the Original Code is Netscape Communications
16 17 18 19
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
20
# Contributor(s): Terry Weissman <terry@mozilla.org>,
21 22
#                 Bryce Nesbitt <bryce-mozilla@nextbus.com>
#                 Dan Mosedale <dmose@mozilla.org>
23
#                 Alan Raetz <al_raetz@yahoo.com>
24
#                 Jacob Steenhagen <jake@actex.net>
25
#                 Matthew Tuck <matty@chariot.net.au>
26 27
#                 Bradley Baetz <bbaetz@student.usyd.edu.au>
#                 J. Paul Reed <preed@sigkill.com>
28

29
use strict;
terry%netscape.com's avatar
terry%netscape.com committed
30

31
package Bugzilla::BugMail;
terry%netscape.com's avatar
terry%netscape.com committed
32

33 34
use RelationSet;

35 36
use Bugzilla::Config qw(:DEFAULT $datadir);

37 38 39 40
# This code is really ugly. It was a commandline interface, then it was moved
# There are package-global variables which we rely on ProcessOneBug to clean
# up each time, and other sorts of fun.
# This really needs to be cleaned at some point.
41

42
my $nametoexclude = "";
43
my %nomail;
44
my $last_changed;
45

46 47 48 49 50
my @excludedAddresses = ();

# disable email flag for offline debugging work
my $enableSendMail = 1;

51
my %force;
terry%netscape.com's avatar
terry%netscape.com committed
52

53
my %seen;
54 55
my @sentlist;

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
# I got sick of adding &:: to everything.
# However, 'Yuck!'
# I can't require, cause that pulls it in only once, so it won't then be
# in the global package, and these aren't modules, so I can't use globals.pl
# Remove this evilness once our stuff uses real packages.
sub AUTOLOAD {
    no strict 'refs';
    use vars qw($AUTOLOAD);
    my $subName = $AUTOLOAD;
    $subName =~ s/.*::/::/; # remove package name
    *$AUTOLOAD = \&$subName;
    goto &$AUTOLOAD;
}

# This is run when we load the package
71
if (open(NOMAIL, '<', "$datadir/nomail")) {
72 73 74 75 76 77 78
    while (<NOMAIL>) {
        $nomail{trim($_)} = 1;
    }
    close(NOMAIL);
}


79 80 81 82
sub FormatTriple {
    my ($a, $b, $c) = (@_);
    $^A = "";
    my $temp = formline << 'END', $a, $b, $c;
83
^>>>>>>>>>>>>>>>>>>|^<<<<<<<<<<<<<<<<<<<<<<<<<<<|^<<<<<<<<<<<<<<<<<<<<<<<<<<<~~
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
END
    ; # This semicolon appeases my emacs editor macros. :-)
    return $^A;
}
    
sub FormatDouble {
    my ($a, $b) = (@_);
    $a .= ":";
    $^A = "";
    my $temp = formline << 'END', $a, $b;
^>>>>>>>>>>>>>>>>>> ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<~~
END
    ; # This semicolon appeases my emacs editor macros. :-)
    return $^A;
}

100 101 102 103 104 105 106 107 108 109 110 111
# This is a bit of a hack, basically keeping the old system()
# cmd line interface. Should clean this up at some point.
#
# args: bug_id, and an optional hash ref which may have keys for:
# changer, owner, qa, reporter, cc
# Optional hash contains values of people which will be forced to those
# roles when the email is sent.
# All the names are email addresses, not userids
# values are scalars, except for cc, which is a list
sub Send($;$) {
    my ($id, $recipients) = (@_);

112
    # This only works in a sub. Probably something to do with the
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    # require abuse we do.
    GetVersionTable();

    # Make sure to clean up _all_ package vars here. Yuck...
    $nametoexclude = $recipients->{'changer'} || "";
    @{$force{'CClist'}} = (exists $recipients->{'cc'} && 
     scalar($recipients->{'cc'}) > 0) ? map(trim($_), 
     @{$recipients->{'cc'}}) : ();
    @{$force{'Owner'}} = $recipients->{'owner'} ? 
     (trim($recipients->{'owner'})) : ();
    @{$force{'QAcontact'}} = $recipients->{'qacontact'} ? 
     (trim($recipients->{'qacontact'})) : ();
    @{$force{'Reporter'}} = $recipients->{'reporter'} ? 
     (trim($recipients->{'reporter'})) : ();
    @{$force{'Voter'}} = ();

    %seen = ();
    @excludedAddresses = ();
    @sentlist = ();

    return ProcessOneBug($id);
}

sub ProcessOneBug($) {
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
    my ($id) = (@_);

    my @headerlist;
    my %values;
    my %defmailhead;
    my %fielddescription;

    my $msg = "";

    SendSQL("SELECT name, description, mailhead FROM fielddefs " .
            "ORDER BY sortkey");
    while (MoreSQLData()) {
        my ($field, $description, $mailhead) = (FetchSQLData());
        push(@headerlist, $field);
        $defmailhead{$field} = $mailhead;
        $fielddescription{$field} = $description;
    }
    SendSQL("SELECT " . join(',', @::log_columns) . ", lastdiffed, now() " .
            "FROM bugs WHERE bug_id = $id");
    my @row = FetchSQLData();
    foreach my $i (@::log_columns) {
        $values{$i} = shift(@row);
    }
160 161 162
    $values{product} = get_product_name($values{product_id});
    $values{component} = get_component_name($values{component_id});

163
    my ($start, $end) = (@row);
164
    # $start and $end are considered safe because users can't touch them
165 166
    trick_taint($start);
    trick_taint($end);
167

168 169 170
    my $ccSet = new RelationSet();
    $ccSet->mergeFromDB("SELECT who FROM cc WHERE bug_id = $id");
    $values{'cc'} = $ccSet->toString();
171
    
172
    my @voterList;
173 174 175
    SendSQL("SELECT profiles.login_name FROM votes, profiles " .
            "WHERE votes.bug_id = $id AND profiles.userid = votes.who");
    while (MoreSQLData()) {
176
        push(@voterList, FetchOneColumn());
177
    }
178 179 180 181 182 183

    $values{'assigned_to'} = DBID_to_name($values{'assigned_to'});
    $values{'reporter'} = DBID_to_name($values{'reporter'});
    if ($values{'qa_contact'}) {
        $values{'qa_contact'} = DBID_to_name($values{'qa_contact'});
    }
184
    $values{'estimated_time'} = FormatTimeUnit($values{'estimated_time'});
185

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    my @dependslist;
    SendSQL("SELECT dependson FROM dependencies WHERE 
             blocked = $id ORDER BY dependson");
    while (MoreSQLData()) {
        push(@dependslist, FetchOneColumn());
    }
    $values{'dependson'} = join(",", @dependslist);

    my @blockedlist;
    SendSQL("SELECT blocked FROM dependencies WHERE 
             dependson = $id ORDER BY blocked");
    while (MoreSQLData()) {
        push(@blockedlist, FetchOneColumn());
    }
    $values{'blocked'} = join(",", @blockedlist);

202 203 204 205
    my @diffs;


    SendSQL("SELECT profiles.login_name, fielddefs.description, " .
206
            "       bug_when, removed, added, attach_id, fielddefs.name " .
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
            "FROM bugs_activity, fielddefs, profiles " .
            "WHERE bug_id = $id " .
            "  AND fielddefs.fieldid = bugs_activity.fieldid " .
            "  AND profiles.userid = who " .
            "  AND bug_when > '$start' " .
            "  AND bug_when <= '$end' " .
            "ORDER BY bug_when"
            );

    while (MoreSQLData()) {
        my @row = FetchSQLData();
        push(@diffs, \@row);
    }

    my $difftext = "";
222 223 224
    my $diffheader = "";
    my $diffpart = {};
    my @diffparts;
225 226
    my $lastwho = "";
    foreach my $ref (@diffs) {
227 228
        my ($who, $what, $when, $old, $new, $attachid, $fieldname) = (@$ref);
        $diffpart = {};
229 230
        if ($who ne $lastwho) {
            $lastwho = $who;
231 232 233
            $diffheader = "\n$who" . Param('emailsuffix') . " changed:\n\n";
            $diffheader .= FormatTriple("What    ", "Removed", "Added");
            $diffheader .= ('-' x 76) . "\n";
234
        }
235
        $what =~ s/^(Attachment )?/Attachment #$attachid / if $attachid;
236 237 238 239 240 241 242 243 244 245
        if( $fieldname eq 'estimated_time' ||
            $fieldname eq 'remaining_time' ) {
            $old = FormatTimeUnit($old);
            $new = FormatTimeUnit($new);
        }
        $difftext = FormatTriple($what, $old, $new);
        $diffpart->{'header'} = $diffheader;
        $diffpart->{'fieldname'} = $fieldname;
        $diffpart->{'text'} = $difftext;
        push(@diffparts, $diffpart);
246 247 248
    }


249 250 251 252
    my $deptext = "";

    my $resid = 

253
    SendSQL("SELECT bugs_activity.bug_id, bugs.short_desc, fielddefs.name, " .
254
            "       removed, added " .
255
            "FROM bugs_activity, bugs, dependencies, fielddefs ".
256
            "WHERE bugs_activity.bug_id = dependencies.dependson " .
257
            "  AND bugs.bug_id = bugs_activity.bug_id ".
258 259 260 261 262 263 264 265 266 267 268
            "  AND dependencies.blocked = $id " .
            "  AND fielddefs.fieldid = bugs_activity.fieldid" .
            "  AND (fielddefs.name = 'bug_status' " .
            "    OR fielddefs.name = 'resolution') " .
            "  AND bug_when > '$start' " .
            "  AND bug_when <= '$end' " .
            "ORDER BY bug_when, bug_id");
    
    my $thisdiff = "";
    my $lastbug = "";
    my $interestingchange = 0;
269 270
    my $depbug = 0;
    my @depbugs;
271
    while (MoreSQLData()) {
272 273 274
        my ($summary, $what, $old, $new);
        ($depbug, $summary, $what, $old, $new) = (FetchSQLData());
        if ($depbug ne $lastbug) {
275 276 277
            if ($interestingchange) {
                $deptext .= $thisdiff;
            }
278
            $lastbug = $depbug;
279
            my $urlbase = Param("urlbase");
280
            $thisdiff =
281 282 283
              "\nBug $id depends on bug $depbug, which changed state.\n\n" . 
              "Bug $depbug Summary: $summary\n" . 
              "${urlbase}show_bug.cgi?id=$depbug\n\n"; 
284 285 286 287 288 289 290 291
            $thisdiff .= FormatTriple("What    ", "Old Value", "New Value");
            $thisdiff .= ('-' x 76) . "\n";
            $interestingchange = 0;
        }
        $thisdiff .= FormatTriple($fielddescription{$what}, $old, $new);
        if ($what eq 'bug_status' && IsOpenedState($old) ne IsOpenedState($new)) {
            $interestingchange = 1;
        }
292 293
        
        push(@depbugs, $depbug);
294
    }
295
    
296 297 298 299 300 301 302
    if ($interestingchange) {
        $deptext .= $thisdiff;
    }

    $deptext = trim($deptext);

    if ($deptext) {
303 304 305
        #$difftext = trim($difftext . "\n\n" . $deptext);
        $diffpart->{'text'} = trim("\n\n" . $deptext);
        push(@diffparts, $diffpart);
306 307 308
    }


309
    my ($newcomments, $anyprivate) = GetLongDescriptionAsText($id, $start, $end);
310

311 312 313 314
    #
    # Start of email filtering code
    #
    my $count = 0;
315

316 317 318 319
    # Get a list of the reasons a user might receive email about the bug.
    my @currentEmailAttributes = 
      getEmailAttributes(\%values, \@diffs, $newcomments);
    
320
    my (@assigned_toList,@reporterList,@qa_contactList,@ccList) = ();
321

322 323 324
    #open(LOG, ">>/tmp/maillog");
    #print LOG "\nBug ID: $id   CurrentEmailAttributes:";
    #print LOG join(',', @currentEmailAttributes) . "\n";
325

326
    @excludedAddresses = (); # zero out global list 
327

328 329 330 331 332 333 334 335 336 337 338 339 340
    @assigned_toList = filterEmailGroup('Owner',
                                        \@currentEmailAttributes,
                                        $values{'assigned_to'});
    @reporterList = filterEmailGroup('Reporter', 
                                     \@currentEmailAttributes,
                                     $values{'reporter'});
    if (Param('useqacontact') && $values{'qa_contact'}) {
        @qa_contactList = filterEmailGroup('QAcontact',
                                           \@currentEmailAttributes,
                                           $values{'qa_contact'});
    } else { 
        @qa_contactList = (); 
    }
341

342 343
    @ccList = filterEmailGroup('CClist', \@currentEmailAttributes,
                               $values{'cc'});
344

345 346
    @voterList = filterEmailGroup('Voter', \@currentEmailAttributes,
                                  join(',',@voterList));
347

348
    my @emailList = (@assigned_toList, @reporterList, 
349
                     @qa_contactList, @ccList, @voterList);
350

351 352 353
    # only need one entry per person
    my @allEmail = ();
    my %AlreadySeen = ();
354
    my $checkperson = "";
355
    foreach my $person (@emailList) {
356 357 358 359
        # don't modify the original so it sends out with the right case
        # based on who came first.
        $checkperson = lc($person);
        if ( !($AlreadySeen{$checkperson}) ) {
360
            push(@allEmail,$person);
361
            $AlreadySeen{$checkperson}++;
362
        }
363
    }
364

365 366 367 368
    #print LOG "\nbug $id email sent: " . join(',', @allEmail) . "\n";
        
    @excludedAddresses = filterExcludeList(\@excludedAddresses,
                                           \@allEmail);
369

370 371 372
    # print LOG "excluded: " . join(',',@excludedAddresses) . "\n\n";

    foreach my $person ( @allEmail ) {
373 374
        my @reasons;

375
        $count++;
376 377 378

        push(@reasons, 'AssignedTo') if lsearch(\@assigned_toList, $person) != -1;
        push(@reasons, 'Reporter') if lsearch(\@reporterList, $person) != -1;
379
        push(@reasons, 'QAcontact') if lsearch(\@qa_contactList, $person) != -1;
380 381 382
        push(@reasons, 'CC') if lsearch(\@ccList, $person) != -1;
        push(@reasons, 'Voter') if lsearch(\@voterList, $person) != -1;

383
        if ( !defined(NewProcessOnePerson($person, $count, \@headerlist,
384 385
                                          \@reasons, \%values,
                                          \%defmailhead, 
386 387 388
                                          \%fielddescription, \@diffparts,
                                          $newcomments, 
                                          $anyprivate, $start, $id, 
389 390
                                          \@depbugs))) 
        {
391 392 393 394 395 396

            # if a value is not returned, this means that the person
            # was not sent mail.  add them to the excludedAddresses list.
            # it will be filtered later for dups.
            #
            push @excludedAddresses, $person;
397 398

        }
399
    }
400

401

402 403
    SendSQL("UPDATE bugs SET lastdiffed = '$end', delta_ts = delta_ts " .
            "WHERE bug_id = $id");
404 405 406 407 408

    # Filter the exclude list for dupes one last time
    @excludedAddresses = filterExcludeList(\@excludedAddresses,
                                           \@sentlist);

409
    return { sent => \@sentlist, excluded => \@excludedAddresses };
410
}
411

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
# When one person is in different fields on one bug, they may be
# excluded from email because of one relationship to the bug (eg
# they're the QA contact) but included because of another (eg they
# also reported the bug).  Inclusion takes precedence, so this
# function looks for and removes any users from the exclude list who
# are also on the include list.  Additionally, it removes duplicate
# entries from the exclude list.  
#
# Arguments are the exclude list and the include list; the cleaned up
# exclude list is returned.
#
sub filterExcludeList ($$) {

    if ($#_ != 1) {
        die ("filterExcludeList called with wrong number of args");
    }

    my ($refExcluded, $refAll) = @_;

    my @excludedAddrs = @$refExcluded;
    my @allEmail = @$refAll;
    my @tmpList = @excludedAddrs;
    my (@result,@uniqueResult) = ();
    my %alreadySeen;

    foreach my $excluded (@tmpList) {

        push (@result,$excluded);
        foreach my $included (@allEmail) {

            # match found, so we remove the entry
443
            if (lc($included) eq lc($excluded)) {
444
                pop(@result);
445
                last;
446 447 448 449 450
            }
        }
    }

    # only need one entry per person
451 452
    my $checkperson = "";

453
    foreach my $person (@result) {
454 455
        $checkperson = lc($person);
        if ( !($alreadySeen{$checkperson}) ) {
456
            push(@uniqueResult,$person);
457
            $alreadySeen{$checkperson}++;
458 459 460 461 462 463 464 465 466
        }
    }

    return @uniqueResult;
}

# if the Status was changed to Resolved or Verified
#       set the Resolved flag
#
467
# else if Severity, Status, Target Milestone OR Priority fields have any change
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
#       set the Status flag
#
# else if Keywords has changed
#       set the Keywords flag
#
# else if CC has changed
#       set the CC flag
#
# if the Comments field shows an attachment
#       set the Attachment flag
#
# else if Comments exist
#       set the Comments flag
#
# if no flags are set and there was some other field change
#       set the Status flag
#
485
sub getEmailAttributes (\%\@$) {
486
    
487
    my ($bug, $fieldDiffs, $commentField) = @_;
488 489
    my (@flags,@uniqueFlags,%alreadySeen) = ();
    
490 491 492 493 494 495
    # Add a flag if the status of the bug is "unconfirmed".
    if ($bug->{'bug_status'} eq $::unconfirmedstate) {
        push (@flags, 'Unconfirmed')
    };
    
    foreach my $ref (@$fieldDiffs) {
496 497 498 499
        my ($who, $fieldName, $when, $old, $new) = (@$ref);
        
        #print qq{field: $fieldName $new<br>};
        
500
        # the STATUS will be flagged for Severity, Status, Target Milestone and 
501 502
        # Priority changes
        #
503 504
        if ( $fieldName eq 'Status' && ($new eq 'RESOLVED' || $new eq 'VERIFIED')) {
            push (@flags, 'Resolved');
505 506
        }
        elsif ( $fieldName eq 'Severity' || $fieldName eq 'Status' ||
507
                $fieldName eq 'Priority' || $fieldName eq 'Target Milestone') {
508 509 510 511 512 513
            push (@flags, 'Status');
        } elsif ( $fieldName eq 'Keywords') {
            push (@flags, 'Keywords');
        } elsif ( $fieldName eq 'CC') {
            push (@flags, 'CC');
        }
514

515 516 517 518
        # These next few lines find out who has been added
        # to the Owner, QA, CC, etc. fields.  They do not affect
        # the @flags array at all, but are run here because they
        # affect filtering later and we're already in the loop.
519
        if ($fieldName eq 'AssignedTo') {
520
            push (@{$force{'Owner'}}, $new);
521
        } elsif ($fieldName eq 'QAcontact') {
522
           push (@{$force{'QAcontact'}}, $new);
523
        } elsif ($fieldName eq 'CC') {
524
            my @added = split (/[ ,]/, $new);
525 526
            push (@{$force{'CClist'}}, @added);
        }
527 528 529 530 531
    }
    
    if ( $commentField =~ /Created an attachment \(/ ) {
        push (@flags, 'Attachments');
    }
532
    elsif ( ($commentField ne '') && !(scalar(@flags) == 1 && $flags[0] eq 'Resolved')) {
533 534 535 536
        push (@flags, 'Comments');
    }
    
    # default fallthrough for any unflagged change is 'Other'
537
    if ( @flags == 0 && @$fieldDiffs != 0 ) {
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
        push (@flags, 'Other');
    }
    
    # only need one flag per attribute type
    foreach my $flag (@flags) {
        if ( !($alreadySeen{$flag}) ) {
            push(@uniqueFlags,$flag);
            $alreadySeen{$flag}++;
        }
    }
    #print "\nEmail Attributes: ", join(' ,',@uniqueFlags), "<br>\n";
    
    # catch-all default, just in case the above logic is faulty
    if ( @uniqueFlags == 0) {
        push (@uniqueFlags, 'Comments');
    }
    
    return @uniqueFlags;
}

sub filterEmailGroup ($$$) {
559
    # This function figures out who should receive email about the bug
560
    # based on the user's role with respect to the bug (assignee, reporter, 
561
    # etc.), the changes that occurred (new comments, attachment added, 
562
    # status changed, etc.) and the user's email preferences.
563
    
564 565 566
    # Returns a filtered list of those users who would receive email
    # about these changes, and adds the names of those users who would
    # not receive email about them to the global @excludedAddresses list.
567
    
568 569 570 571 572 573
    my ($role, $reasons, $users) = @_;
    
    # Make a list of users to filter.
    my @users = split( /,/ , $users );
    
    # Treat users who are in the process of being removed from this role
574
    # as if they still have it.
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    push @users, @{$force{$role}};

    # If this installation supports user watching, add to the list those
    # users who are watching other users already on the list.  By doing
    # this here, we allow watchers to inherit the roles of the people 
    # they are watching while at the same time filtering email for watchers
    # based on their own preferences.
    if (Param("supportwatchers") && scalar(@users)) {
        # Convert the unfiltered list of users into an SQL-quoted, 
        # comma-separated string suitable for use in an SQL query.
        my $watched = join(",", map(SqlQuote($_), @users));
        SendSQL("SELECT watchers.login_name 
                   FROM watch, profiles AS watchers, profiles AS watched
                  WHERE watched.login_name IN ($watched)
                    AND watched.userid = watch.watched
                    AND watch.watcher = watchers.userid");
        push (@users, FetchOneColumn()) while MoreSQLData();
592 593
    }

594 595
    # Initialize the list of recipients.
    my @recipients = ();
596

597 598
    USER: foreach my $user (@users) {
        next unless $user;
599
        
600 601 602 603
        # Get the user's unique ID, and if the user is not registered
        # (no idea why unregistered users should even be on this list,
        # but the code that was here before I re-wrote it allows this),
        # then we do not have any preferences for them, so assume the
604
        # default preference is to receive all mail.
605 606 607
        my $userid = DBname_to_id($user);
        if (!$userid) {
            push(@recipients, $user);
608 609 610
            next;
        }
        
611 612 613
        # Get the user's email preferences from the database.
        SendSQL("SELECT emailflags FROM profiles WHERE userid = $userid");
        my $prefs = FetchOneColumn();
614
        
615 616 617 618
        # If the user's preferences are empty, it means the user has not set
        # their mail preferences after the installation upgraded from a
        # version of Bugzilla without email preferences to one with them. In
        # this case, assume they want to receive all mail.
619 620 621 622
        if (!defined($prefs) || $prefs !~ /email/) {
            push(@recipients, $user);
            next;
        }
623
        
624 625 626 627 628 629 630 631 632 633
        # Write the user's preferences into a Perl record indexed by 
        # preference name.  We pass the value "255" to the split function 
        # because otherwise split will trim trailing null fields, causing 
        # Perl to generate lots of warnings.  Any suitably large number 
        # would do.
        my %prefs = split(/~/, $prefs, 255);
        
        # If this user is the one who made the change in the first place,
        # and they prefer not to receive mail about their own changes,
        # filter them from the list.
634
        if (lc($user) eq lc($nametoexclude) && $prefs{'ExcludeSelf'} eq 'on') {
635 636
            push(@excludedAddresses, $user);
            next;
637 638
        }
        
639 640 641 642 643 644 645 646 647 648 649 650
        # If the user doesn't want to receive email about unconfirmed
        # bugs, that setting overrides their other preferences, including
        # the preference to receive email when they are added to or removed
        # from a role, so remove them from the list before checking their
        # other preferences.
        if (grep(/Unconfirmed/, @$reasons)
            && exists($prefs{"email${role}Unconfirmed"})
            && $prefs{"email${role}Unconfirmed"} eq '')
        {
            push(@excludedAddresses, $user);
            next;
        }
651
        
652 653 654 655 656 657 658 659 660 661
        # If the user was added to or removed from this role, and they
        # prefer to receive email when that happens, send them mail.
        # Note: This was originally written to send email when users
        # were removed from roles and was later enhanced for additions,
        # but for simplicity's sake the name "Removeme" was retained.
        if (grep($_ eq $user, @{$force{$role}})
            && $prefs{"email${role}Removeme"} eq 'on')
        {
            push (@recipients, $user);
            next;
662
        }
663 664 665 666 667 668 669 670 671 672 673
        
        # If the user prefers to be included in mail about this change,
        # or they haven't specified a preference for it (because they
        # haven't visited the email preferences page since the preference
        # was added, in which case we include them by default), add them
        # to the list of recipients.
        foreach my $reason (@$reasons) {
            my $pref = "email$role$reason";
            if (!exists($prefs{$pref}) || $prefs{$pref} eq 'on') {
                push(@recipients, $user);
                next USER;
674
            }
675 676 677 678 679 680 681
        }
    
        # At this point there's no way the user wants to receive email
        # about this change, so exclude them from the list of recipients.
        push(@excludedAddresses, $user);
    
    } # for each user on the unfiltered list
682

683
    return @recipients;
684 685
}

686
sub NewProcessOnePerson ($$$$$$$$$$$$$) {
687 688 689
    my ($person, $count, $hlRef, $reasonsRef, $valueRef, $dmhRef, $fdRef,  
        $diffRef, $newcomments, $anyprivate, $start, 
        $id, $depbugsRef) = @_;
690

691 692
    my %values = %$valueRef;
    my @headerlist = @$hlRef;
693
    my @reasons = @$reasonsRef;
694 695
    my %defmailhead = %$dmhRef;
    my %fielddescription = %$fdRef;
696
    my @diffparts = @$diffRef;
697 698
    my @depbugs = @$depbugsRef;
    
699 700 701
    if ($seen{$person}) {
      return;
    }
702 703 704 705

    if ($nomail{$person}) {
      return;
    }
706

707 708 709 710
    # This routine should really get passed a userid
    # This rederives groups as a side effect
    my $user = Bugzilla::User->new_from_login($person);
    my $userid = $user->id;
711

712
    $seen{$person} = 1;
713

714 715 716
    # if this person doesn't have permission to see info on this bug, 
    # return.
    #
717
    # XXX - This currently means that if a bug is suddenly given
718 719 720 721
    # more restrictive permissions, people without those permissions won't
    # see the action of restricting the bug itself; the bug will just 
    # quietly disappear from their radar.
    #
722
    return unless CanSeeBug($id, $userid);
723 724

    #  Drop any non-insiders if the comment is private
725
    return if (Param("insidergroup") && 
726
               ($anyprivate != 0) && 
727
               (!$user->groups->{Param("insidergroup")}));
728

729
    # We shouldn't send changedmail if this is a dependency mail, and any of 
730
    # the depending bugs are not visible to the user.
731 732 733 734
    foreach my $dep_id (@depbugs) {
        my $save_id = $dep_id;
        detaint_natural($dep_id) || warn("Unexpected Error: \@depbugs contains a non-numeric value: '$save_id'")
                                 && return;
735
        return unless CanSeeBug($dep_id, $userid);
736 737
    }

738 739 740 741 742 743 744
    my %mailhead = %defmailhead;
    
    my $head = "";
    
    foreach my $f (@headerlist) {
      if ($mailhead{$f}) {
        my $value = $values{$f};
745 746
        # If there isn't anything to show, don't include this header
        if (! $value) {
747 748
          next;
        }
749
        # Only send estimated_time if it is enabled and the user is in the group
750
        if ($f ne 'estimated_time' ||
751 752
            $user->groups->{Param('timetrackinggroup')}) {

753 754 755
            my $desc = $fielddescription{$f};
            $head .= FormatDouble($desc, $value);
        }
756 757
      }
    }
758 759 760 761 762

    # Build difftext (the actions) by verifying the user should see them
    my $difftext = "";
    my $diffheader = "";
    my $add_diff;
763

764 765 766
    foreach my $diff (@diffparts) {
        $add_diff = 0;
        
767 768 769 770
        if (exists($diff->{'fieldname'}) && 
         ($diff->{'fieldname'} eq 'estimated_time' ||
         $diff->{'fieldname'} eq 'remaining_time' ||
         $diff->{'fieldname'} eq 'work_time')) {
771
            if ($user->groups->{Param("timetrackinggroup")}) {
772 773 774 775 776
                $add_diff = 1;
            }
        } else {
            $add_diff = 1;
        }
777

778
        if ($add_diff) {
779 780
            if (exists($diff->{'header'}) && 
             ($diffheader ne $diff->{'header'})) {
781 782 783 784 785 786
                $diffheader = $diff->{'header'};
                $difftext .= $diffheader;
            }
            $difftext .= $diff->{'text'};
        }
    }
787
 
788 789 790 791 792
    if ($difftext eq "" && $newcomments eq "") {
      # Whoops, no differences!
      return;
    }
    
793
    my $reasonsbody = "------- You are receiving this mail because: -------\n";
794 795 796 797 798 799 800 801 802

    if (scalar(@reasons) == 0) {
        $reasonsbody .= "Whoops!  I have no idea!\n";
    } else {
        foreach my $reason (@reasons) {
            if ($reason eq 'AssignedTo') {
                $reasonsbody .= "You are the assignee for the bug, or are watching the assignee.\n";
            } elsif ($reason eq 'Reporter') {
                $reasonsbody .= "You reported the bug, or are watching the reporter.\n";
803
            } elsif ($reason eq 'QAcontact') {
804 805 806 807 808 809 810 811 812 813 814
                $reasonsbody .= "You are the QA contact for the bug, or are watching the QA contact.\n";
            } elsif ($reason eq 'CC') {
                $reasonsbody .= "You are on the CC list for the bug, or are watching someone who is.\n";
            } elsif ($reason eq 'Voter') {
                $reasonsbody .= "You are a voter for the bug, or are watching someone who is.\n";
            } else {
                $reasonsbody .= "Whoops!  There is an unknown reason!\n";
            }
        }
    }

815 816 817
    my $isnew = ($start !~ m/[1-9]/);
    
    my %substs;
818

819 820 821 822 823 824
    # If an attachment was created, then add an URL. (Note: the 'g'lobal
    # replace should work with comments with multiple attachments.)

    if ( $newcomments =~ /Created an attachment \(/ ) {

        my $showattachurlbase =
825
            Param('urlbase') . "attachment.cgi?id=";
826

827
        $newcomments =~ s/(Created an attachment \(id=([0-9]+)\))/$1\n --> \(${showattachurlbase}$2&action=view\)/g;
828 829
    }

830
    $person .= Param('emailsuffix');
831 832 833 834 835
# 09/13/2000 cyeh@bluemartini.com
# If a bug is changed, don't put the word "Changed" in the subject mail
# since if the bug didn't change, you wouldn't be getting mail
# in the first place! see http://bugzilla.mozilla.org/show_bug.cgi?id=29820 
# for details.
836
    $substs{"neworchanged"} = $isnew ? ' New: ' : '';
837 838 839 840 841 842 843 844 845
    $substs{"to"} = $person;
    $substs{"cc"} = '';
    $substs{"bugid"} = $id;
    if ($isnew) {
      $substs{"diffs"} = $head . "\n\n" . $newcomments;
    } else {
      $substs{"diffs"} = $difftext . "\n\n" . $newcomments;
    }
    $substs{"summary"} = $values{'short_desc'};
846 847
    $substs{"reasonsheader"} = join(" ", @reasons);
    $substs{"reasonsbody"} = $reasonsbody;
848
    $substs{"space"} = " ";
849 850 851 852
    
    my $template = Param("newchangedmail");
    
    my $msg = PerformSubsts($template, \%substs);
853 854 855

    my $sendmailparam = "-ODeliveryMode=deferred";
    if (Param("sendmailnow")) {
856
       $sendmailparam = "";
857
    }
858 859

    if ($enableSendMail == 1) {
860 861
        open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") ||
          die "Can't open sendmail";
862
    
863 864
        print SENDMAIL trim($msg) . "\n";
        close SENDMAIL;
865
    }
866
    push(@sentlist, $person);
867
    return 1;
868 869
}

870
1;