Bug.pm 145 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# 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.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dawn Endico    <endico@mozilla.org>
#                 Terry Weissman <terry@mozilla.org>
cyeh%bluemartini.com's avatar
cyeh%bluemartini.com committed
22
#                 Chris Yeh      <cyeh@bluemartini.com>
23 24
#                 Bradley Baetz  <bbaetz@acm.org>
#                 Dave Miller    <justdave@bugzilla.org>
25
#                 Max Kanat-Alexander <mkanat@bugzilla.org>
26
#                 Frédéric Buclin <LpSolit@gmail.com>
27
#                 Lance Larsh <lance.larsh@oracle.com>
28
#                 Elliotte Martin <elliotte_martin@yahoo.com>
29
#                 Christian Legnitto <clegnitto@mozilla.com>
30

31
package Bugzilla::Bug;
32

33 34
use strict;

35
use Bugzilla::Attachment;
36
use Bugzilla::Constants;
37
use Bugzilla::Field;
38 39
use Bugzilla::Flag;
use Bugzilla::FlagType;
40
use Bugzilla::Hook;
41
use Bugzilla::Keyword;
42
use Bugzilla::Milestone;
43
use Bugzilla::User;
44
use Bugzilla::Util;
45
use Bugzilla::Version;
46
use Bugzilla::Error;
47
use Bugzilla::Product;
48 49
use Bugzilla::Component;
use Bugzilla::Group;
50
use Bugzilla::Status;
51
use Bugzilla::Comment;
52

53
use List::MoreUtils qw(firstidx uniq);
54
use List::Util qw(min max first);
55
use Storable qw(dclone);
56 57
use URI;
use URI::QueryParam;
58
use Scalar::Util qw(blessed);
59

60
use base qw(Bugzilla::Object Exporter);
61
@Bugzilla::Bug::EXPORT = qw(
62
    bug_alias_to_id
63
    LogActivityEntry
64
    editable_bug_fields
65 66
);

67 68 69 70
#####################################################################
# Constants
#####################################################################

71 72 73 74 75 76 77 78
use constant DB_TABLE   => 'bugs';
use constant ID_FIELD   => 'bug_id';
use constant NAME_FIELD => 'alias';
use constant LIST_ORDER => ID_FIELD;

# This is a sub because it needs to call other subroutines.
sub DB_COLUMNS {
    my $dbh = Bugzilla->dbh;
79 80
    my @custom = grep {$_->type != FIELD_TYPE_MULTI_SELECT}
                      Bugzilla->active_custom_fields;
81
    my @custom_names = map {$_->name} @custom;
82

83
    my @columns = (qw(
84
        alias
85
        assigned_to
86 87 88 89 90 91 92 93 94
        bug_file_loc
        bug_id
        bug_severity
        bug_status
        cclist_accessible
        component_id
        delta_ts
        estimated_time
        everconfirmed
95
        lastdiffed
96 97 98
        op_sys
        priority
        product_id
99
        qa_contact
100 101 102 103 104 105 106 107 108 109 110 111
        remaining_time
        rep_platform
        reporter_accessible
        resolution
        short_desc
        status_whiteboard
        target_milestone
        version
    ),
    'reporter    AS reporter_id',
    $dbh->sql_date_format('creation_ts', '%Y.%m.%d %H:%i') . ' AS creation_ts',
    $dbh->sql_date_format('deadline', '%Y-%m-%d') . ' AS deadline',
112
    @custom_names);
113
    
114
    Bugzilla::Hook::process("bug_columns", { columns => \@columns });
115 116
    
    return @columns;
117 118
}

119
sub VALIDATORS {
120

121 122
    my $validators = {
        alias          => \&_check_alias,
123
        assigned_to    => \&_check_assigned_to,
124
        bug_file_loc   => \&_check_bug_file_loc,
125
        bug_severity   => \&_check_select_field,
126 127
        bug_status     => \&_check_bug_status,
        cc             => \&_check_cc,
128
        comment        => \&_check_comment,
129
        component      => \&_check_component,
130
        creation_ts    => \&_check_creation_ts,
131
        deadline       => \&_check_deadline,
132
        dup_id         => \&_check_dup_id,
133
        estimated_time => \&Bugzilla::Object::check_time,
134 135 136
        everconfirmed  => \&Bugzilla::Object::check_boolean,
        groups         => \&_check_groups,
        keywords       => \&_check_keywords,
137
        op_sys         => \&_check_select_field,
138 139
        priority       => \&_check_priority,
        product        => \&_check_product,
140
        qa_contact     => \&_check_qa_contact,
141
        remaining_time => \&Bugzilla::Object::check_time,
142
        rep_platform   => \&_check_select_field,
143
        resolution     => \&_check_resolution,
144 145
        short_desc     => \&_check_short_desc,
        status_whiteboard => \&_check_status_whiteboard,
146 147 148 149 150
        target_milestone  => \&_check_target_milestone,
        version           => \&_check_version,

        cclist_accessible   => \&Bugzilla::Object::check_boolean,
        reporter_accessible => \&Bugzilla::Object::check_boolean,
151 152
    };

153
    # Set up validators for custom fields.    
154
    foreach my $field (Bugzilla->active_custom_fields) {
155 156 157 158
        my $validator;
        if ($field->type == FIELD_TYPE_SINGLE_SELECT) {
            $validator = \&_check_select_field;
        }
159 160 161
        elsif ($field->type == FIELD_TYPE_MULTI_SELECT) {
            $validator = \&_check_multi_select_field;
        }
162 163 164
        elsif ($field->type == FIELD_TYPE_DATETIME) {
            $validator = \&_check_datetime_field;
        }
165
        elsif ($field->type == FIELD_TYPE_FREETEXT) {
166 167
            $validator = \&_check_freetext_field;
        }
168 169 170
        elsif ($field->type == FIELD_TYPE_BUG_ID) {
            $validator = \&_check_bugid_field;
        }
171 172 173
        else {
            $validator = \&_check_default_field;
        }
174
        $validators->{$field->name} = $validator;
175
    }
176

177
    return $validators;
178 179
};

180 181 182 183 184 185 186
sub VALIDATOR_DEPENDENCIES {
    my $cache = Bugzilla->request_cache;
    return $cache->{bug_validator_dependencies} 
        if $cache->{bug_validator_dependencies};

    my %deps = (
        assigned_to      => ['component'],
187
        bug_status       => ['product', 'comment', 'target_milestone'],
188
        cc               => ['component'],
189
        comment          => ['creation_ts'],
190
        component        => ['product'],
191
        dup_id           => ['bug_status', 'resolution'],
192 193
        groups           => ['product'],
        keywords         => ['product'],
194
        resolution       => ['bug_status'],
195 196 197 198 199
        qa_contact       => ['component'],
        target_milestone => ['product'],
        version          => ['product'],
    );

200 201 202
    foreach my $field (@{ Bugzilla->fields }) {
        $deps{$field->name} = [ $field->visibility_field->name ]
            if $field->{visibility_field_id};
203
    }
204

205 206
    $cache->{bug_validator_dependencies} = \%deps;
    return \%deps;
207 208
};

209
sub UPDATE_COLUMNS {
210 211
    my @custom = grep {$_->type != FIELD_TYPE_MULTI_SELECT}
                      Bugzilla->active_custom_fields;
212
    my @custom_names = map {$_->name} @custom;
213
    my @columns = qw(
214
        alias
215
        assigned_to
216 217 218
        bug_file_loc
        bug_severity
        bug_status
219
        cclist_accessible
220
        component_id
221 222
        deadline
        estimated_time
223 224 225
        everconfirmed
        op_sys
        priority
226
        product_id
227
        qa_contact
228
        remaining_time
229
        rep_platform
230
        reporter_accessible
231 232 233
        resolution
        short_desc
        status_whiteboard
234 235
        target_milestone
        version
236
    );
237
    push(@columns, @custom_names);
238 239
    return @columns;
};
240

241 242 243 244 245
use constant NUMERIC_COLUMNS => qw(
    estimated_time
    remaining_time
);

246
sub DATE_COLUMNS {
247
    my @fields = @{ Bugzilla->fields({ type => FIELD_TYPE_DATETIME }) };
248 249 250
    return map { $_->name } @fields;
}

251 252 253 254
# Used in LogActivityEntry(). Gives the max length of lines in the
# activity table.
use constant MAX_LINE_LENGTH => 254;

255 256 257 258 259
# This maps the names of internal Bugzilla bug fields to things that would
# make sense to somebody who's not intimately familiar with the inner workings
# of Bugzilla. (These are the field names that the WebService and email_in.pl
# use.)
use constant FIELD_MAP => {
260 261
    blocks           => 'blocked',
    cc_accessible    => 'cclist_accessible',
262
    commentprivacy   => 'comment_is_private',
263
    creation_time    => 'creation_ts',
264
    creator          => 'reporter',
265
    description      => 'comment',
266 267
    depends_on       => 'dependson',
    dupe_of          => 'dup_id',
268
    id               => 'bug_id',
269 270 271
    is_confirmed     => 'everconfirmed',
    is_cc_accessible => 'cclist_accessible',
    is_creator_accessible => 'reporter_accessible',
272 273 274 275 276 277 278 279 280 281 282 283 284
    last_change_time => 'delta_ts',
    platform         => 'rep_platform',
    severity         => 'bug_severity',
    status           => 'bug_status',
    summary          => 'short_desc',
    url              => 'bug_file_loc',
    whiteboard       => 'status_whiteboard',

    # These are special values for the WebService Bug.search method.
    limit            => 'LIMIT',
    offset           => 'OFFSET',
};

285 286 287 288 289
use constant REQUIRED_FIELD_MAP => {
    product_id   => 'product',
    component_id => 'component',
};

290 291 292
# Creation timestamp is here because it needs to be validated
# but it can be NULL in the database (see comments in create above)
#
293 294 295 296 297 298 299 300 301 302 303 304 305
# Target Milestone is here because it has a default that the validator
# creates (product.defaultmilestone) that is different from the database
# default.
#
# CC is here because it is a separate table, and has a validator-created
# default of the component initialcc.
#
# QA Contact is allowed to be NULL in the database, so it wouldn't normally
# be caught by _required_create_fields. However, it always has to be validated,
# because it has a default of the component.defaultqacontact.
#
# Groups are in a separate table, but must always be validated so that
# mandatory groups get set on bugs.
306
use constant EXTRA_REQUIRED_FIELDS => qw(creation_ts target_milestone cc qa_contact groups);
307

308 309
#####################################################################

310 311 312 313 314 315 316 317
# This and "new" catch every single way of creating a bug, so that we
# can call _create_cf_accessors.
sub _do_list_select {
    my $invocant = shift;
    $invocant->_create_cf_accessors();
    return $invocant->SUPER::_do_list_select(@_);
}

318
sub new {
319 320 321 322
    my $invocant = shift;
    my $class = ref($invocant) || $invocant;
    my $param = shift;

323 324
    $class->_create_cf_accessors();

325 326 327 328 329
    # Remove leading "#" mark if we've just been passed an id.
    if (!ref $param && $param =~ /^#(\d+)$/) {
        $param = $1;
    }

330 331
    # If we get something that looks like a word (not a number),
    # make it the "name" param.
332
    if (!defined $param || (!ref($param) && $param !~ /^\d+$/)) {
333
        # But only if aliases are enabled.
334
        if (Bugzilla->params->{'usebugaliases'} && $param) {
335 336 337 338 339 340 341 342 343 344
            $param = { name => $param };
        }
        else {
            # Aliases are off, and we got something that's not a number.
            my $error_self = {};
            bless $error_self, $class;
            $error_self->{'bug_id'} = $param;
            $error_self->{'error'}  = 'InvalidBugId';
            return $error_self;
        }
345 346
    }

347 348 349 350 351 352 353
    unshift @_, $param;
    my $self = $class->SUPER::new(@_);

    # Bugzilla::Bug->new always returns something, but sets $self->{error}
    # if the bug wasn't found in the database.
    if (!$self) {
        my $error_self = {};
354 355 356 357 358 359 360 361
        if (ref $param) {
            $error_self->{bug_id} = $param->{name};
            $error_self->{error}  = 'InvalidBugId';
        }
        else {
            $error_self->{bug_id} = $param;
            $error_self->{error}  = 'NotFound';
        }
362 363
        bless $error_self, $class;
        return $error_self;
364
    }
365 366

    return $self;
367 368
}

369 370
sub check {
    my $class = shift;
371 372
    my ($id, $field) = @_;

373 374
    ThrowUserError('improper_bug_id_field_value', { field => $field }) unless defined $id;

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    # Bugzilla::Bug throws lots of special errors, so we don't call
    # SUPER::check, we just call our new and do our own checks.
    my $self = $class->new(trim($id));
    # For error messages, use the id that was returned by new(), because
    # it's cleaned up.
    $id = $self->id;

    if ($self->{error}) {
        if ($self->{error} eq 'NotFound') {
             ThrowUserError("bug_id_does_not_exist", { bug_id => $id });
        }
        if ($self->{error} eq 'InvalidBugId') {
            ThrowUserError("improper_bug_id_field_value",
                              { bug_id => $id,
                                field  => $field });
        }
    }

393 394 395 396 397
    unless ($field && $field =~ /^(dependson|blocked|dup_id)$/) {
        $self->check_is_visible;
    }
    return $self;
}
398

399 400
sub check_is_visible {
    my $self = shift;
401
    my $user = Bugzilla->user;
402 403

    if (!$user->can_see_bug($self->id)) {
404 405 406
        # The error the user sees depends on whether or not they are
        # logged in (i.e. $user->id contains the user's positive integer ID).
        if ($user->id) {
407
            ThrowUserError("bug_access_denied", { bug_id => $self->id });
408
        } else {
409
            ThrowUserError("bug_access_query", { bug_id => $self->id });
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 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
sub match {
    my $class = shift;
    my ($params) = @_;

    # Allow matching certain fields by name (in addition to matching by ID).
    my %translate_fields = (
        assigned_to => 'Bugzilla::User',
        qa_contact  => 'Bugzilla::User',
        reporter    => 'Bugzilla::User',
        product     => 'Bugzilla::Product',
        component   => 'Bugzilla::Component',
    );
    my %translated;

    foreach my $field (keys %translate_fields) {
        my @ids;
        # Convert names to ids. We use "exists" everywhere since people can
        # legally specify "undef" to mean IS NULL (even though most of these
        # fields can't be NULL, people can still specify it...).
        if (exists $params->{$field}) {
            my $names = $params->{$field};
            my $type = $translate_fields{$field};
            my $param = $type eq 'Bugzilla::User' ? 'login_name' : 'name';
            # We call Bugzilla::Object::match directly to avoid the
            # Bugzilla::User::match implementation which is different.
            my $objects = Bugzilla::Object::match($type, { $param => $names });
            push(@ids, map { $_->id } @$objects);
        }
        # You can also specify ids directly as arguments to this function,
        # so include them in the list if they have been specified.
        if (exists $params->{"${field}_id"}) {
            my $current_ids = $params->{"${field}_id"};
            my @id_array = ref $current_ids ? @$current_ids : ($current_ids);
            push(@ids, @id_array);
        }
        # We do this "or" instead of a "scalar(@ids)" to handle the case
        # when people passed only invalid object names. Otherwise we'd
        # end up with a SUPER::match call with zero criteria (which dies).
        if (exists $params->{$field} or exists $params->{"${field}_id"}) {
            $translated{$field} = scalar(@ids) == 1 ? $ids[0] : \@ids;
        }
    }

    # The user fields don't have an _id on the end of them in the database,
    # but the product & component fields do, so we have to have separate
    # code to deal with the different sets of fields here.
    foreach my $field (qw(assigned_to qa_contact reporter)) {
        delete $params->{"${field}_id"};
        $params->{$field} = $translated{$field} 
            if exists $translated{$field};
    }
    foreach my $field (qw(product component)) {
        delete $params->{$field};
        $params->{"${field}_id"} = $translated{$field} 
            if exists $translated{$field};
    }

    return $class->SUPER::match(@_);
}

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
sub possible_duplicates {
    my ($class, $params) = @_;
    my $short_desc = $params->{summary};
    my $products = $params->{products} || [];
    my $limit = $params->{limit} || MAX_POSSIBLE_DUPLICATES;
    $limit = MAX_POSSIBLE_DUPLICATES if $limit > MAX_POSSIBLE_DUPLICATES;
    $products = [$products] if !ref($products) eq 'ARRAY';

    my $orig_limit = $limit;
    detaint_natural($limit) 
        || ThrowCodeError('param_must_be_numeric', 
                          { function => 'possible_duplicates',
                            param    => $orig_limit });

    my $dbh = Bugzilla->dbh;
    my $user = Bugzilla->user;
    my @words = split(/[\b\s]+/, $short_desc || '');
    # Exclude punctuation from the array.
    @words = map { /(\w+)/; $1 } @words;
    # And make sure that each word is longer than 2 characters.
    @words = grep { defined $_ and length($_) > 2 } @words;

    return [] if !@words;

    my ($where_sql, $relevance_sql);
    if ($dbh->FULLTEXT_OR) {
        my $joined_terms = join($dbh->FULLTEXT_OR, @words);
        ($where_sql, $relevance_sql) = 
            $dbh->sql_fulltext_search('bugs_fulltext.short_desc', 
                                      $joined_terms, 1);
        $relevance_sql ||= $where_sql;
    }
    else {
        my (@where, @relevance);
        my $count = 0;
        foreach my $word (@words) {
            $count++;
            my ($term, $rel_term) = $dbh->sql_fulltext_search(
                'bugs_fulltext.short_desc', $word, $count);
            push(@where, $term);
            push(@relevance, $rel_term || $term);
        }

        $where_sql = join(' OR ', @where);
        $relevance_sql = join(' + ', @relevance);
    }

    my $product_ids = join(',', map { $_->id } @$products);
    my $product_sql = $product_ids ? "AND product_id IN ($product_ids)" : "";

    # Because we collapse duplicates, we want to get slightly more bugs
    # than were actually asked for.
    my $sql_limit = $limit + 5;

    my $possible_dupes = $dbh->selectall_arrayref(
        "SELECT bugs.bug_id AS bug_id, bugs.resolution AS resolution,
                ($relevance_sql) AS relevance
           FROM bugs
                INNER JOIN bugs_fulltext ON bugs.bug_id = bugs_fulltext.bug_id
          WHERE ($where_sql) $product_sql
       ORDER BY relevance DESC, bug_id DESC
          LIMIT $sql_limit", {Slice=>{}});

    my @actual_dupe_ids;
    # Resolve duplicates into their ultimate target duplicates.
    foreach my $bug (@$possible_dupes) {
        my $push_id = $bug->{bug_id};
        if ($bug->{resolution} && $bug->{resolution} eq 'DUPLICATE') {
            $push_id = _resolve_ultimate_dup_id($bug->{bug_id});
        }
        push(@actual_dupe_ids, $push_id);
    }
    @actual_dupe_ids = uniq @actual_dupe_ids;
    if (scalar @actual_dupe_ids > $limit) {
        @actual_dupe_ids = @actual_dupe_ids[0..($limit-1)];
    }

    my $visible = $user->visible_bugs(\@actual_dupe_ids);
    return $class->new_from_list($visible);
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
# Docs for create() (there's no POD in this file yet, but we very
# much need this documented right now):
#
# The same as Bugzilla::Object->create. Parameters are only required
# if they say so below.
#
# Params:
#
# C<product>     - B<Required> The name of the product this bug is being
#                  filed against.
# C<component>   - B<Required> The name of the component this bug is being
#                  filed against.
#
# C<bug_severity> - B<Required> The severity for the bug, a string.
# C<creation_ts>  - B<Required> A SQL timestamp for when the bug was created.
# C<short_desc>   - B<Required> A summary for the bug.
# C<op_sys>       - B<Required> The OS the bug was found against.
# C<priority>     - B<Required> The initial priority for the bug.
# C<rep_platform> - B<Required> The platform the bug was found against.
# C<version>      - B<Required> The version of the product the bug was found in.
#
# C<alias>        - An alias for this bug. Will be ignored if C<usebugaliases>
#                   is off.
# C<target_milestone> - When this bug is expected to be fixed.
# C<status_whiteboard> - A string.
# C<bug_status>   - The initial status of the bug, a string.
# C<bug_file_loc> - The URL field.
#
# C<assigned_to> - The full login name of the user who the bug is
#                  initially assigned to.
# C<qa_contact>  - The full login name of the QA Contact for this bug. 
#                  Will be ignored if C<useqacontact> is off.
#
# C<estimated_time> - For time-tracking. Will be ignored if 
#                     C<timetrackinggroup> is not set, or if the current
#                     user is not a member of the timetrackinggroup.
# C<deadline>       - For time-tracking. Will be ignored for the same
#                     reasons as C<estimated_time>.
593
sub create {
594
    my ($class, $params) = @_;
595 596
    my $dbh = Bugzilla->dbh;

597 598
    $dbh->bz_start_transaction();

599 600 601 602 603 604 605 606 607 608 609 610 611 612
    # These fields have default values which we can use if they are undefined.
    $params->{bug_severity} = Bugzilla->params->{defaultseverity}
      unless defined $params->{bug_severity};
    $params->{priority} = Bugzilla->params->{defaultpriority}
      unless defined $params->{priority};
    $params->{op_sys} = Bugzilla->params->{defaultopsys}
      unless defined $params->{op_sys};
    $params->{rep_platform} = Bugzilla->params->{defaultplatform}
      unless defined $params->{rep_platform};
    # Make sure a comment is always defined.
    $params->{comment} = '' unless defined $params->{comment};

    $class->check_required_create_fields($params);
    $params = $class->run_create_validators($params);
613

614
    # These are not a fields in the bugs table, so we don't pass them to
615
    # insert_create_data.
616 617 618 619 620 621
    my $cc_ids           = delete $params->{cc};
    my $groups           = delete $params->{groups};
    my $depends_on       = delete $params->{dependson};
    my $blocked          = delete $params->{blocked};
    my $keywords         = delete $params->{keywords};
    my $creation_comment = delete $params->{comment};
622

623 624
    # We don't want the bug to appear in the system until it's correctly
    # protected by groups.
625
    my $timestamp = delete $params->{creation_ts}; 
626

627
    my $ms_values = $class->_extract_multi_selects($params);
628 629
    my $bug = $class->insert_create_data($params);

630 631 632
    # Add the group restrictions
    my $sth_group = $dbh->prepare(
        'INSERT INTO bug_group_map (bug_id, group_id) VALUES (?, ?)');
633 634
    foreach my $group (@$groups) {
        $sth_group->execute($bug->bug_id, $group->id);
635 636
    }

637 638
    $dbh->do('UPDATE bugs SET creation_ts = ? WHERE bug_id = ?', undef,
             $timestamp, $bug->bug_id);
639 640
    # Update the bug instance as well
    $bug->{creation_ts} = $timestamp;
641

642
    # Add the CCs
643 644 645 646 647
    my $sth_cc = $dbh->prepare('INSERT INTO cc (bug_id, who) VALUES (?,?)');
    foreach my $user_id (@$cc_ids) {
        $sth_cc->execute($bug->bug_id, $user_id);
    }

648 649 650 651 652 653 654
    # Add in keywords
    my $sth_keyword = $dbh->prepare(
        'INSERT INTO keywords (bug_id, keywordid) VALUES (?, ?)');
    foreach my $keyword_id (map($_->id, @$keywords)) {
        $sth_keyword->execute($bug->bug_id, $keyword_id);
    }

655 656 657
    # Set up dependencies (blocked/dependson)
    my $sth_deps = $dbh->prepare(
        'INSERT INTO dependencies (blocked, dependson) VALUES (?, ?)');
658 659
    my $sth_bug_time = $dbh->prepare('UPDATE bugs SET delta_ts = ? WHERE bug_id = ?');

660 661 662 663
    foreach my $depends_on_id (@$depends_on) {
        $sth_deps->execute($bug->bug_id, $depends_on_id);
        # Log the reverse action on the other bug.
        LogActivityEntry($depends_on_id, 'blocked', '', $bug->bug_id,
664
                         $bug->{reporter_id}, $timestamp);
665
        $sth_bug_time->execute($timestamp, $depends_on_id);
666 667 668 669 670
    }
    foreach my $blocked_id (@$blocked) {
        $sth_deps->execute($blocked_id, $bug->bug_id);
        # Log the reverse action on the other bug.
        LogActivityEntry($blocked_id, 'dependson', '', $bug->bug_id,
671
                         $bug->{reporter_id}, $timestamp);
672
        $sth_bug_time->execute($timestamp, $blocked_id);
673 674
    }

675 676 677 678 679 680 681 682 683 684
    # Insert the values into the multiselect value tables
    foreach my $field (keys %$ms_values) {
        $dbh->do("DELETE FROM bug_$field where bug_id = ?",
                undef, $bug->bug_id);
        foreach my $value ( @{$ms_values->{$field}} ) {
            $dbh->do("INSERT INTO bug_$field (bug_id, value) VALUES (?,?)",
                    undef, $bug->bug_id, $value);
        }
    }

685 686 687 688 689 690
    # Comment #0 handling...

    # We now have a bug id so we can fill this out
    $creation_comment->{'bug_id'} = $bug->id;

    # Insert the comment. We always insert a comment on bug creation,
691
    # but sometimes it's blank.
692
    Bugzilla::Comment->insert_create_data($creation_comment);
693

694
    Bugzilla::Hook::process('bug_end_of_create', { bug => $bug,
695 696 697
                                                   timestamp => $timestamp,
                                                 });

698 699 700 701 702 703
    $dbh->bz_commit_transaction();

    # Because MySQL doesn't support transactions on the fulltext table,
    # we do this after we've committed the transaction. That way we're
    # sure we're inserting a good Bug ID.
    $bug->_sync_fulltext('new bug');
704

705 706 707
    return $bug;
}

708 709
sub run_create_validators {
    my $class  = shift;
710
    my $params = $class->SUPER::run_create_validators(@_);
711

712
    my $product = delete $params->{product};
713
    $params->{product_id} = $product->id;
714
    my $component = delete $params->{component};
715
    $params->{component_id} = $component->id;
716

717
    # Callers cannot set reporter, creation_ts, or delta_ts.
718
    $params->{reporter} = $class->_check_reporter();
719
    $params->{delta_ts} = $params->{creation_ts};
720 721 722 723

    if ($params->{estimated_time}) {
        $params->{remaining_time} = $params->{estimated_time};
    }
724

725 726
    $class->_check_strict_isolation($params->{cc}, $params->{assigned_to},
                                    $params->{qa_contact}, $product);
727

728
    ($params->{dependson}, $params->{blocked}) = 
729 730
        $class->_check_dependencies($params->{dependson}, $params->{blocked},
                                    $product);
731

732 733 734 735 736
    # You can't set these fields on bug creation (or sometimes ever).
    delete $params->{resolution};
    delete $params->{lastdiffed};
    delete $params->{bug_id};

737
    Bugzilla::Hook::process('bug_end_of_create_validators',
738 739
                            { params => $params });

740 741 742
    my @mandatory_fields = @{ Bugzilla->fields({ is_mandatory => 1,
                                                 enter_bug    => 1,
                                                 obsolete     => 0 }) };
743 744 745 746 747
    foreach my $field (@mandatory_fields) {
        $class->_check_field_is_mandatory($params->{$field->name}, $field,
                                          $params);
    }

748
    return $params;
749 750
}

751 752 753
sub update {
    my $self = shift;

754
    my $dbh = Bugzilla->dbh;
755 756
    # XXX This is just a temporary hack until all updating happens
    # inside this function.
757
    my $delta_ts = shift || $dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)');
758

759 760
    $dbh->bz_start_transaction();

761
    my ($changes, $old_bug) = $self->SUPER::update(@_);
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782

    # Certain items in $changes have to be fixed so that they hold
    # a name instead of an ID.
    foreach my $field (qw(product_id component_id)) {
        my $change = delete $changes->{$field};
        if ($change) {
            my $new_field = $field;
            $new_field =~ s/_id$//;
            $changes->{$new_field} = 
                [$self->{"_old_${new_field}_name"}, $self->$new_field];
        }
    }
    foreach my $field (qw(qa_contact assigned_to)) {
        if ($changes->{$field}) {
            my ($from, $to) = @{ $changes->{$field} };
            $from = $old_bug->$field->login if $from;
            $to   = $self->$field->login    if $to;
            $changes->{$field} = [$from, $to];
        }
    }

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
    # CC
    my @old_cc = map {$_->id} @{$old_bug->cc_users};
    my @new_cc = map {$_->id} @{$self->cc_users};
    my ($removed_cc, $added_cc) = diff_arrays(\@old_cc, \@new_cc);
    
    if (scalar @$removed_cc) {
        $dbh->do('DELETE FROM cc WHERE bug_id = ? AND ' 
                 . $dbh->sql_in('who', $removed_cc), undef, $self->id);
    }
    foreach my $user_id (@$added_cc) {
        $dbh->do('INSERT INTO cc (bug_id, who) VALUES (?,?)',
                 undef, $self->id, $user_id);
    }
    # If any changes were found, record it in the activity log
    if (scalar @$removed_cc || scalar @$added_cc) {
        my $removed_users = Bugzilla::User->new_from_list($removed_cc);
        my $added_users   = Bugzilla::User->new_from_list($added_cc);
        my $removed_names = join(', ', (map {$_->login} @$removed_users));
        my $added_names   = join(', ', (map {$_->login} @$added_users));
        $changes->{cc} = [$removed_names, $added_names];
    }
    
    # Keywords
    my @old_kw_ids = map { $_->id } @{$old_bug->keyword_objects};
    my @new_kw_ids = map { $_->id } @{$self->keyword_objects};

    my ($removed_kw, $added_kw) = diff_arrays(\@old_kw_ids, \@new_kw_ids);

    if (scalar @$removed_kw) {
        $dbh->do('DELETE FROM keywords WHERE bug_id = ? AND ' 
                 . $dbh->sql_in('keywordid', $removed_kw), undef, $self->id);
    }
    foreach my $keyword_id (@$added_kw) {
        $dbh->do('INSERT INTO keywords (bug_id, keywordid) VALUES (?,?)',
                 undef, $self->id, $keyword_id);
    }
    # If any changes were found, record it in the activity log
    if (scalar @$removed_kw || scalar @$added_kw) {
        my $removed_keywords = Bugzilla::Keyword->new_from_list($removed_kw);
        my $added_keywords   = Bugzilla::Keyword->new_from_list($added_kw);
        my $removed_names = join(', ', (map {$_->name} @$removed_keywords));
        my $added_names   = join(', ', (map {$_->name} @$added_keywords));
        $changes->{keywords} = [$removed_names, $added_names];
    }

    # Dependencies
    foreach my $pair ([qw(dependson blocked)], [qw(blocked dependson)]) {
        my ($type, $other) = @$pair;
        my $old = $old_bug->$type;
        my $new = $self->$type;
        
        my ($removed, $added) = diff_arrays($old, $new);
        foreach my $removed_id (@$removed) {
            $dbh->do("DELETE FROM dependencies WHERE $type = ? AND $other = ?",
                     undef, $removed_id, $self->id);
            
            # Add an activity entry for the other bug.
            LogActivityEntry($removed_id, $other, $self->id, '',
                             Bugzilla->user->id, $delta_ts);
            # Update delta_ts on the other bug so that we trigger mid-airs.
            $dbh->do('UPDATE bugs SET delta_ts = ? WHERE bug_id = ?',
                     undef, $delta_ts, $removed_id);
        }
        foreach my $added_id (@$added) {
            $dbh->do("INSERT INTO dependencies ($type, $other) VALUES (?,?)",
                     undef, $added_id, $self->id);
            
            # Add an activity entry for the other bug.
            LogActivityEntry($added_id, $other, '', $self->id,
                             Bugzilla->user->id, $delta_ts);
            # Update delta_ts on the other bug so that we trigger mid-airs.
            $dbh->do('UPDATE bugs SET delta_ts = ? WHERE bug_id = ?',
                     undef, $delta_ts, $added_id);
        }
        
        if (scalar(@$removed) || scalar(@$added)) {
            $changes->{$type} = [join(', ', @$removed), join(', ', @$added)];
        }
    }

    # Groups
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
    my %old_groups = map {$_->id => $_} @{$old_bug->groups_in};
    my %new_groups = map {$_->id => $_} @{$self->groups_in};
    my ($removed_gr, $added_gr) = diff_arrays([keys %old_groups],
                                              [keys %new_groups]);
    if (scalar @$removed_gr || scalar @$added_gr) {
        if (@$removed_gr) {
            my $qmarks = join(',', ('?') x @$removed_gr);
            $dbh->do("DELETE FROM bug_group_map
                       WHERE bug_id = ? AND group_id IN ($qmarks)", undef,
                     $self->id, @$removed_gr);
        }
        my $sth_insert = $dbh->prepare(
            'INSERT INTO bug_group_map (bug_id, group_id) VALUES (?,?)');
        foreach my $gid (@$added_gr) {
            $sth_insert->execute($self->id, $gid);
        }
        my @removed_names = map { $old_groups{$_}->name } @$removed_gr;
        my @added_names   = map { $new_groups{$_}->name } @$added_gr;
        $changes->{'bug_group'} = [join(', ', @removed_names),
                                   join(', ', @added_names)];
    }
885 886 887 888 889 890 891

    # Flags
    my ($removed, $added) = Bugzilla::Flag->update_flags($self, $old_bug, $delta_ts);
    if ($removed || $added) {
        $changes->{'flagtypes.name'} = [$removed, $added];
    }

892
    # Comments
893
    foreach my $comment (@{$self->{added_comments} || []}) {
894 895 896
        # Override the Comment's timestamp to be identical to the update
        # timestamp.
        $comment->{bug_when} = $delta_ts;
897
        $comment = Bugzilla::Comment->insert_create_data($comment);
898 899
        if ($comment->work_time) {
            LogActivityEntry($self->id, "work_time", "", $comment->work_time,
900 901
                Bugzilla->user->id, $delta_ts);
        }
902
    }
903

904
    # Comment Privacy 
905 906 907
    foreach my $comment (@{$self->{comment_isprivate} || []}) {
        $comment->update();
        
908
        my ($from, $to) 
909
            = $comment->is_private ? (0, 1) : (1, 0);
910
        LogActivityEntry($self->id, "longdescs.isprivate", $from, $to, 
911
                         Bugzilla->user->id, $delta_ts, $comment->id);
912
    }
913

914
    # Insert the values into the multiselect value tables
915 916
    my @multi_selects = grep {$_->type == FIELD_TYPE_MULTI_SELECT}
                             Bugzilla->active_custom_fields;
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
    foreach my $field (@multi_selects) {
        my $name = $field->name;
        my ($removed, $added) = diff_arrays($old_bug->$name, $self->$name);
        if (scalar @$removed || scalar @$added) {
            $changes->{$name} = [join(', ', @$removed), join(', ', @$added)];

            $dbh->do("DELETE FROM bug_$name where bug_id = ?",
                     undef, $self->id);
            foreach my $value (@{$self->$name}) {
                $dbh->do("INSERT INTO bug_$name (bug_id, value) VALUES (?,?)",
                         undef, $self->id, $value);
            }
        }
    }

932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
    # See Also
    my ($removed_see, $added_see) = 
        diff_arrays($old_bug->see_also, $self->see_also);

    if (scalar @$removed_see) {
        $dbh->do('DELETE FROM bug_see_also WHERE bug_id = ? AND '
                 . $dbh->sql_in('value', [('?') x @$removed_see]),
                  undef, $self->id, @$removed_see);
    }
    foreach my $url (@$added_see) {
        $dbh->do('INSERT INTO bug_see_also (bug_id, value) VALUES (?,?)',
                 undef, $self->id, $url);
    }
    # If any changes were found, record it in the activity log
    if (scalar @$removed_see || scalar @$added_see) {
        $changes->{see_also} = [join(', ', @$removed_see),
                                join(', ', @$added_see)];
    }

951 952 953
    # Call update for the referenced bugs.
    $_->update() foreach @{ $self->{see_also_update} || [] };

954 955 956 957 958
    # Log bugs_activity items
    # XXX Eventually, when bugs_activity is able to track the dupe_id,
    # this code should go below the duplicates-table-updating code below.
    foreach my $field (keys %$changes) {
        my $change = $changes->{$field};
959 960 961 962
        my $from = defined $change->[0] ? $change->[0] : '';
        my $to   = defined $change->[1] ? $change->[1] : '';
        LogActivityEntry($self->id, $field, $from, $to, Bugzilla->user->id,
                         $delta_ts);
963 964
    }

965 966 967
    # Check if we have to update the duplicates table and the other bug.
    my ($old_dup, $cur_dup) = ($old_bug->dup_id || 0, $self->dup_id || 0);
    if ($old_dup != $cur_dup) {
968
        $dbh->do("DELETE FROM duplicates WHERE dupe = ?", undef, $self->id);
969 970 971 972 973 974 975 976 977
        if ($cur_dup) {
            $dbh->do('INSERT INTO duplicates (dupe, dupe_of) VALUES (?,?)',
                     undef, $self->id, $cur_dup);
            if (my $update_dup = delete $self->{_dup_for_update}) {
                $update_dup->update();
            }
        }
        
        $changes->{'dup_id'} = [$old_dup || undef, $cur_dup || undef];
978 979
    }

980 981 982
    Bugzilla::Hook::process('bug_end_of_update', 
        { bug => $self, timestamp => $delta_ts, changes => $changes,
          old_bug => $old_bug });
983

984
    # If any change occurred, refresh the timestamp of the bug.
985 986 987
    if (scalar(keys %$changes) || $self->{added_comments}
        || $self->{comment_isprivate})
    {
988 989
        $dbh->do('UPDATE bugs SET delta_ts = ? WHERE bug_id = ?',
                 undef, ($delta_ts, $self->id));
990
        $self->{delta_ts} = $delta_ts;
991 992
    }

993 994
    $dbh->bz_commit_transaction();

995 996 997 998 999
    # The only problem with this here is that update() is often called
    # in the middle of a transaction, and if that transaction is rolled
    # back, this change will *not* be rolled back. As we expect rollbacks
    # to be extremely rare, that is OK for us.
    $self->_sync_fulltext()
1000 1001
        if $self->{added_comments} || $changes->{short_desc}
           || $self->{comment_isprivate};
1002

1003 1004 1005 1006
    # Remove obsolete internal variables.
    delete $self->{'_old_assigned_to'};
    delete $self->{'_old_qa_contact'};

1007 1008 1009 1010
    # Also flush the visible_bugs cache for this bug as the user's
    # relationship with this bug may have changed.
    delete Bugzilla->user->{_visible_bugs_cache}->{$self->id};

1011 1012 1013
    return $changes;
}

1014 1015 1016 1017 1018 1019
# Used by create().
# We need to handle multi-select fields differently than normal fields,
# because they're arrays and don't go into the bugs table.
sub _extract_multi_selects {
    my ($invocant, $params) = @_;

1020 1021
    my @multi_selects = grep {$_->type == FIELD_TYPE_MULTI_SELECT}
                             Bugzilla->active_custom_fields;
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    my %ms_values;
    foreach my $field (@multi_selects) {
        my $name = $field->name;
        if (exists $params->{$name}) {
            my $array = delete($params->{$name}) || [];
            $ms_values{$name} = $array;
        }
    }
    return \%ms_values;
}

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
# Should be called any time you update short_desc or change a comment.
sub _sync_fulltext {
    my ($self, $new_bug) = @_;
    my $dbh = Bugzilla->dbh;
    if ($new_bug) {
        $dbh->do('INSERT INTO bugs_fulltext (bug_id, short_desc)
                  SELECT bug_id, short_desc FROM bugs WHERE bug_id = ?',
                 undef, $self->id);
    }
    else {
        $dbh->do('UPDATE bugs_fulltext SET short_desc = ? WHERE bug_id = ?',
                 undef, $self->short_desc, $self->id);
    }
    my $comments = $dbh->selectall_arrayref(
        'SELECT thetext, isprivate FROM longdescs WHERE bug_id = ?',
        undef, $self->id);
    my $all = join("\n", map { $_->[0] } @$comments);
    my @no_private = grep { !$_->[1] } @$comments;
    my $nopriv_string = join("\n", map { $_->[0] } @no_private);
    $dbh->do('UPDATE bugs_fulltext SET comments = ?, comments_noprivate = ?
               WHERE bug_id = ?', undef, $all, $nopriv_string, $self->id);
}


1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
# This is the correct way to delete bugs from the DB.
# No bug should be deleted from anywhere else except from here.
#
sub remove_from_db {
    my ($self) = @_;
    my $dbh = Bugzilla->dbh;

    if ($self->{'error'}) {
        ThrowCodeError("bug_error", { bug => $self });
    }

    my $bug_id = $self->{'bug_id'};

    # tables having 'bugs.bug_id' as a foreign key:
    # - attachments
    # - bug_group_map
    # - bugs
    # - bugs_activity
1075
    # - bugs_fulltext
1076 1077 1078 1079 1080 1081 1082
    # - cc
    # - dependencies
    # - duplicates
    # - flags
    # - keywords
    # - longdescs

1083 1084 1085
    # Also, the attach_data table uses attachments.attach_id as a foreign
    # key, and so indirectly depends on a bug deletion too.

1086
    $dbh->bz_start_transaction();
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

    $dbh->do("DELETE FROM bug_group_map WHERE bug_id = ?", undef, $bug_id);
    $dbh->do("DELETE FROM bugs_activity WHERE bug_id = ?", undef, $bug_id);
    $dbh->do("DELETE FROM cc WHERE bug_id = ?", undef, $bug_id);
    $dbh->do("DELETE FROM dependencies WHERE blocked = ? OR dependson = ?",
             undef, ($bug_id, $bug_id));
    $dbh->do("DELETE FROM duplicates WHERE dupe = ? OR dupe_of = ?",
             undef, ($bug_id, $bug_id));
    $dbh->do("DELETE FROM flags WHERE bug_id = ?", undef, $bug_id);
    $dbh->do("DELETE FROM keywords WHERE bug_id = ?", undef, $bug_id);
1097 1098 1099 1100 1101 1102 1103

    # The attach_data table doesn't depend on bugs.bug_id directly.
    my $attach_ids =
        $dbh->selectcol_arrayref("SELECT attach_id FROM attachments
                                  WHERE bug_id = ?", undef, $bug_id);

    if (scalar(@$attach_ids)) {
1104 1105
        $dbh->do("DELETE FROM attach_data WHERE " 
                 . $dbh->sql_in('id', $attach_ids));
1106 1107
    }

1108 1109 1110
    # Several of the previous tables also depend on attach_id.
    $dbh->do("DELETE FROM attachments WHERE bug_id = ?", undef, $bug_id);
    $dbh->do("DELETE FROM bugs WHERE bug_id = ?", undef, $bug_id);
1111
    $dbh->do("DELETE FROM longdescs WHERE bug_id = ?", undef, $bug_id);
1112

1113 1114
    $dbh->bz_commit_transaction();

1115 1116 1117
    # The bugs_fulltext table doesn't support transactions.
    $dbh->do("DELETE FROM bugs_fulltext WHERE bug_id = ?", undef, $bug_id);

1118 1119 1120 1121
    # Now this bug no longer exists
    $self->DESTROY;
    return $self;
}
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139

#####################################################################
# Sending Email After Bug Update
#####################################################################

sub send_changes {
    my ($self, $changes, $vars) = @_;

    my $user = Bugzilla->user;

    my $old_qa  = $changes->{'qa_contact'}  
                  ? $changes->{'qa_contact'}->[0] : '';
    my $old_own = $changes->{'assigned_to'} 
                  ? $changes->{'assigned_to'}->[0] : '';
    my $old_cc  = $changes->{cc}
                  ? $changes->{cc}->[0] : '';

    my %forced = (
1140
        cc        => [split(/[,;]+/, $old_cc)],
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
        owner     => $old_own,
        qacontact => $old_qa,
        changer   => $user,
    );

    _send_bugmail({ id => $self->id, type => 'bug', forced => \%forced }, 
                  $vars);

    # If the bug was marked as a duplicate, we need to notify users on the
    # other bug of any changes to that bug.
    my $new_dup_id = $changes->{'dup_id'} ? $changes->{'dup_id'}->[1] : undef;
    if ($new_dup_id) {
        _send_bugmail({ forced => { changer => $user }, type => "dupe",
                        id => $new_dup_id }, $vars);
    }

    # If there were changes in dependencies, we need to notify those
    # dependencies.
    if ($changes->{'bug_status'}) {
        my ($old_status, $new_status) = @{ $changes->{'bug_status'} };

        # If this bug has changed from opened to closed or vice-versa,
        # then all of the bugs we block need to be notified.
        if (is_open_state($old_status) ne is_open_state($new_status)) {
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
            my $params = { forced   => { changer => $user },
                           type     => 'dep',
                           dep_only => 1,
                           blocker  => $self,
                           changes  => $changes };

            foreach my $id (@{ $self->blocked }) {
                $params->{id} = $id;
                _send_bugmail($params, $vars);
            }
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
        }
    }

    # To get a list of all changed dependencies, convert the "changes" arrays
    # into a long string, then collapse that string into unique numbers in
    # a hash.
    my $all_changed_deps = join(', ', @{ $changes->{'dependson'} || [] });
    $all_changed_deps = join(', ', @{ $changes->{'blocked'} || [] },
                                   $all_changed_deps);
    my %changed_deps = map { $_ => 1 } split(', ', $all_changed_deps);
    # When clearning one field (say, blocks) and filling in the other
    # (say, dependson), an empty string can get into the hash and cause
    # an error later.
    delete $changed_deps{''};

1190
    foreach my $id (sort { $a <=> $b } (keys %changed_deps)) {
1191 1192 1193
        _send_bugmail({ forced => { changer => $user }, type => "dep",
                         id => $id }, $vars);
    }
1194 1195 1196 1197 1198 1199

    # Sending emails for the referenced bugs.
    foreach my $ref_bug (@{ $self->{see_also_update} || [] }) {
        _send_bugmail({ forced => { changer => $user },
                        id => $ref_bug->id }, $vars);
    }
1200 1201 1202 1203 1204 1205
}

sub _send_bugmail {
    my ($params, $vars) = @_;

    my $results = 
1206
        Bugzilla::BugMail::Send($params->{'id'}, $params->{'forced'}, $params);
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216

    if (Bugzilla->usage_mode == USAGE_MODE_BROWSER) {
        my $template = Bugzilla->template;
        $vars->{$_} = $params->{$_} foreach keys %$params;
        $vars->{'sent_bugmail'} = $results;
        $template->process("bug/process/results.html.tmpl", $vars)
            || ThrowTemplateError($template->error());
        $vars->{'header_done'} = 1;
    }
}
1217

1218 1219 1220 1221 1222
#####################################################################
# Validators
#####################################################################

sub _check_alias {
1223
   my ($invocant, $alias) = @_;
1224
   $alias = trim($alias);
1225
   return undef if (!Bugzilla->params->{'usebugaliases'} || !$alias);
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

    # Make sure the alias isn't too long.
    if (length($alias) > 20) {
        ThrowUserError("alias_too_long");
    }
    # Make sure the alias isn't just a number.
    if ($alias =~ /^\d+$/) {
        ThrowUserError("alias_is_numeric", { alias => $alias });
    }
    # Make sure the alias has no commas or spaces.
    if ($alias =~ /[, ]/) {
        ThrowUserError("alias_has_comma_or_space", { alias => $alias });
    }
    # Make sure the alias is unique, or that it's already our alias.
    my $other_bug = new Bugzilla::Bug($alias);
    if (!$other_bug->{error}
        && (!ref $invocant || $other_bug->id != $invocant->id))
    {
        ThrowUserError("alias_in_use", { alias => $alias,
                                         bug_id => $other_bug->id });
    }

1248 1249 1250 1251
   return $alias;
}

sub _check_assigned_to {
1252
    my ($invocant, $assignee, undef, $params) = @_;
1253
    my $user = Bugzilla->user;
1254 1255
    my $component = blessed($invocant) ? $invocant->component_obj
                                       : $params->{component};
1256 1257 1258

    # Default assignee is the component owner.
    my $id;
1259 1260 1261 1262 1263
    # If this is a new bug, you can only set the assignee if you have editbugs.
    # If you didn't specify the assignee, we use the default assignee.
    if (!ref $invocant
        && (!$user->in_group('editbugs', $component->product_id) || !$assignee))
    {
1264 1265
        $id = $component->default_assignee->id;
    } else {
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
        if (!ref $assignee) {
            $assignee = trim($assignee);
            # When updating a bug, assigned_to can't be empty.
            ThrowUserError("reassign_to_empty") if ref $invocant && !$assignee;
            $assignee = Bugzilla::User->check($assignee);
        }
        $id = $assignee->id;
        # create() checks this another way, so we don't have to run this
        # check during create().
        $invocant->_check_strict_isolation_for_user($assignee) if ref $invocant;
1276 1277 1278 1279 1280
    }
    return $id;
}

sub _check_bug_file_loc {
1281
    my ($invocant, $url) = @_;
1282 1283 1284 1285 1286 1287 1288
    $url = '' if !defined($url);
    # On bug entry, if bug_file_loc is "http://", the default, use an 
    # empty value instead. However, on bug editing people can set that
    # back if they *really* want to.
    if (!ref $invocant && $url eq 'http://') {
        $url = '';
    }
1289 1290 1291
    return $url;
}

1292
sub _check_bug_status {
1293
    my ($invocant, $new_status, undef, $params) = @_;
1294
    my $user = Bugzilla->user;
1295
    my @valid_statuses;
1296
    my $old_status; # Note that this is undef for new bugs.
1297

1298
    my ($product, $comment);
1299
    if (ref $invocant) {
1300
        @valid_statuses = @{$invocant->statuses_available};
1301
        $product = $invocant->product_obj;
1302 1303 1304
        $old_status = $invocant->status;
        my $comments = $invocant->{added_comments} || [];
        $comment = $comments->[-1];
1305
    }
1306
    else {
1307 1308
        $product = $params->{product};
        $comment = $params->{comment};
1309
        @valid_statuses = @{Bugzilla::Status->can_change_to()};
1310
        if (!$product->allows_unconfirmed) {
1311 1312
            @valid_statuses = grep {$_->name ne 'UNCONFIRMED'} @valid_statuses;
        }
1313 1314
    }

1315 1316
    # Check permissions for users filing new bugs.
    if (!ref $invocant) {
1317 1318
        if ($user->in_group('editbugs', $product->id)
            || $user->in_group('canconfirm', $product->id)) {
1319 1320
            # If the user with privs hasn't selected another status,
            # select the first one of the list.
1321 1322 1323 1324 1325 1326 1327 1328 1329
            unless ($new_status) {
                if (scalar(@valid_statuses) == 1) {
                    $new_status = $valid_statuses[0];
                }
                else {
                    $new_status = ($valid_statuses[0]->name ne 'UNCONFIRMED') ?
                                  $valid_statuses[0] : $valid_statuses[1];
                }
            }
1330 1331
        }
        else {
1332
            # A user with no privs cannot choose the initial status.
1333 1334
            # If UNCONFIRMED is valid for this product, use it; else
            # use the first bug status available.
1335 1336 1337 1338 1339 1340
            if (grep {$_->name eq 'UNCONFIRMED'} @valid_statuses) {
                $new_status = 'UNCONFIRMED';
            }
            else {
                $new_status = $valid_statuses[0];
            }
1341
        }
1342
    }
1343

1344 1345
    # Time to validate the bug status.
    $new_status = Bugzilla::Status->check($new_status) unless ref($new_status);
1346 1347 1348 1349
    # We skip this check if we are changing from a status to itself.
    if ( (!$old_status || $old_status->id != $new_status->id)
          && !grep {$_->name eq $new_status->name} @valid_statuses) 
    {
1350 1351
        ThrowUserError('illegal_bug_status_transition',
                       { old => $old_status, new => $new_status });
1352
    }
1353

1354 1355 1356 1357 1358 1359 1360 1361
    # Check if a comment is required for this change.
    if ($new_status->comment_required_on_change_from($old_status) && !$comment)
    {
        ThrowUserError('comment_required', { old => $old_status,
                                             new => $new_status });
        
    }
    
1362 1363 1364 1365
    if (ref $invocant 
        && ($new_status->name eq 'IN_PROGRESS'
            # Backwards-compat for the old default workflow.
            or $new_status->name eq 'ASSIGNED')
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
        && Bugzilla->params->{"usetargetmilestone"}
        && Bugzilla->params->{"musthavemilestoneonaccept"}
        # musthavemilestoneonaccept applies only if at least two
        # target milestones are defined for the product.
        && scalar(@{ $product->milestones }) > 1
        && $invocant->target_milestone eq $product->default_milestone)
    {
        ThrowUserError("milestone_required", { bug => $invocant });
    }

1376 1377 1378 1379 1380
    if (!blessed $invocant) {
        $params->{everconfirmed} = $new_status->name eq 'UNCONFIRMED' ? 0 : 1;
    }

    return $new_status->name;
1381 1382
}

1383
sub _check_cc {
1384 1385 1386
    my ($invocant, $ccs, undef, $params) = @_;
    my $component = blessed($invocant) ? $invocant->component_obj
                                       : $params->{component};
1387
    return [map {$_->id} @{$component->initial_cc}] unless $ccs;
1388

1389
    # Allow comma-separated input as well as arrayrefs.
1390
    $ccs = [split(/[,;]+/, $ccs)] if !ref $ccs;
1391

1392 1393
    my %cc_ids;
    foreach my $person (@$ccs) {
1394
        $person = trim($person);
1395 1396 1397 1398
        next unless $person;
        my $id = login_to_id($person, THROW_ERROR);
        $cc_ids{$id} = 1;
    }
1399 1400 1401 1402

    # Enforce Default CC
    $cc_ids{$_->id} = 1 foreach (@{$component->initial_cc});

1403 1404 1405
    return [keys %cc_ids];
}

1406
sub _check_comment {
1407
    my ($invocant, $comment_txt, undef, $params) = @_;
1408

1409 1410 1411 1412
    # Comment can be empty. We should force it to be empty if the text is undef
    if (!defined $comment_txt) {
        $comment_txt = '';
    }
1413

1414
    # Load up some data
1415
    my $isprivate = delete $params->{comment_is_private};
1416
    my $timestamp = $params->{creation_ts};
1417

1418 1419 1420 1421 1422
    # Create the new comment so we can check it
    my $comment = {
        thetext  => $comment_txt,
        bug_when => $timestamp,
    };
1423

1424 1425 1426 1427
    # We don't include the "isprivate" column unless it was specified. 
    # This allows it to fall back to its database default.
    if (defined $isprivate) {
        $comment->{isprivate} = $isprivate;
1428
    }
1429

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
    # Validate comment. We have to do this special as a comment normally
    # requires a bug to be already created. For a new bug, the first comment
    # obviously can't get the bug if the bug is created after this
    # (see bug 590334)
    Bugzilla::Comment->check_required_create_fields($comment);
    $comment = Bugzilla::Comment->run_create_validators($comment,
                                                        { skip => ['bug_id'] }
    );

    return $comment; 

1441 1442
}

1443
sub _check_component {
1444
    my ($invocant, $name, undef, $params) = @_;
1445 1446
    $name = trim($name);
    $name || ThrowUserError("require_component");
1447 1448
    my $product = blessed($invocant) ? $invocant->product_obj 
                                     : $params->{product};
1449
    my $obj = Bugzilla::Component->check({ product => $product, name => $name });
1450 1451 1452
    return $obj;
}

1453 1454 1455 1456
sub _check_creation_ts {
    return Bugzilla->dbh->selectrow_array('SELECT LOCALTIMESTAMP(0)');
}

1457
sub _check_deadline {
1458
    my ($invocant, $date) = @_;
1459 1460
    
    # Check time-tracking permissions.
1461 1462
    # deadline() returns '' instead of undef if no deadline is set.
    my $current = ref $invocant ? ($invocant->deadline || undef) : undef;
1463
    return $current unless Bugzilla->user->is_timetracker;
1464 1465 1466 1467
    
    # Validate entered deadline
    $date = trim($date);
    return undef if !$date;
1468 1469 1470 1471 1472 1473
    validate_date($date)
        || ThrowUserError('illegal_date', { date   => $date,
                                            format => 'YYYY-MM-DD' });
    return $date;
}

1474 1475 1476
# Takes two comma/space-separated strings and returns arrayrefs
# of valid bug IDs.
sub _check_dependencies {
1477 1478 1479 1480 1481 1482
    my ($invocant, $depends_on, $blocks, $product) = @_;

    if (!ref $invocant) {
        # Only editbugs users can set dependencies on bug entry.
        return ([], []) unless Bugzilla->user->in_group('editbugs',
                                                        $product->id);
1483 1484
    }

1485 1486
    my %deps_in = (dependson => $depends_on || '', blocked => $blocks || '');

1487
    foreach my $type (qw(dependson blocked)) {
1488 1489 1490
        my @bug_ids = ref($deps_in{$type}) 
            ? @{$deps_in{$type}} 
            : split(/[\s,]+/, $deps_in{$type});
1491 1492
        # Eliminate nulls.
        @bug_ids = grep {$_} @bug_ids;
1493 1494
        # We do this up here to make sure all aliases are converted to IDs.
        @bug_ids = map { $invocant->check($_, $type)->id } @bug_ids;
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
       
        my @check_access = @bug_ids;
        # When we're updating a bug, only added or removed bug_ids are 
        # checked for whether or not we can see/edit those bugs.
        if (ref $invocant) {
            my $old = $invocant->$type;
            my ($removed, $added) = diff_arrays($old, \@bug_ids);
            @check_access = (@$added, @$removed);
            
            # Check field permissions if we've changed anything.
            if (@check_access) {
                my $privs;
                if (!$invocant->check_can_change_field($type, 0, 1, \$privs)) {
                    ThrowUserError('illegal_change', { field => $type,
                                                       privs => $privs });
                }
            }
        }

        my $user = Bugzilla->user;
        foreach my $modified_id (@check_access) {
1516
            my $delta_bug = $invocant->check($modified_id);
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
            # Under strict isolation, you can't modify a bug if you can't
            # edit it, even if you can see it.
            if (Bugzilla->params->{"strict_isolation"}) {
                if (!$user->can_edit_product($delta_bug->{'product_id'})) {
                    ThrowUserError("illegal_change_deps", {field => $type});
                }
            }
        }
        
        $deps_in{$type} = \@bug_ids;
    }
1528

1529
    # And finally, check for dependency loops.
1530 1531
    my $bug_id = ref($invocant) ? $invocant->id : 0;
    my %deps = ValidateDependencies($deps_in{dependson}, $deps_in{blocked}, $bug_id);
1532 1533 1534 1535

    return ($deps{'dependson'}, $deps{'blocked'});
}

1536 1537 1538 1539 1540 1541
sub _check_dup_id {
    my ($self, $dupe_of) = @_;
    my $dbh = Bugzilla->dbh;
    
    $dupe_of = trim($dupe_of);
    $dupe_of || ThrowCodeError('undefined_field', { field => 'dup_id' });
1542 1543 1544
    # Validate the bug ID. The second argument will force check() to only
    # make sure that the bug exists, and convert the alias to the bug ID
    # if a string is passed. Group restrictions are checked below.
1545
    my $dupe_of_bug = $self->check($dupe_of, 'dup_id');
1546
    $dupe_of = $dupe_of_bug->id;
1547 1548 1549 1550 1551 1552 1553 1554

    # If the dupe is unchanged, we have nothing more to check.
    return $dupe_of if ($self->dup_id && $self->dup_id == $dupe_of);

    # If we come here, then the duplicate is new. We have to make sure
    # that we can view/change it (issue A on bug 96085).
    $dupe_of_bug->check_is_visible;

1555 1556
    # Make sure a loop isn't created when marking this bug
    # as duplicate.
1557
   _resolve_ultimate_dup_id($self->id, $dupe_of, 1);
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575

    my $cur_dup = $self->dup_id || 0;
    if ($cur_dup != $dupe_of && Bugzilla->params->{'commentonduplicate'}
        && !$self->{added_comments})
    {
        ThrowUserError('comment_required');
    }

    # Should we add the reporter to the CC list of the new bug?
    # If he can see the bug...
    if ($self->reporter->can_see_bug($dupe_of)) {
        # We only add him if he's not the reporter of the other bug.
        $self->{_add_dup_cc} = 1
            if $dupe_of_bug->reporter->id != $self->reporter->id;
    }
    # What if the reporter currently can't see the new bug? In the browser 
    # interface, we prompt the user. In other interfaces, we default to 
    # not adding the user, as the safest option.
1576
    elsif (Bugzilla->usage_mode == USAGE_MODE_BROWSER) {
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
        # If we've already confirmed whether the user should be added...
        my $cgi = Bugzilla->cgi;
        my $add_confirmed = $cgi->param('confirm_add_duplicate');
        if (defined $add_confirmed) {
            $self->{_add_dup_cc} = $add_confirmed;
        }
        else {
            # Note that here we don't check if he user is already the reporter
            # of the dupe_of bug, since we already checked if he can *see*
            # the bug, above. People might have reporter_accessible turned
            # off, but cclist_accessible turned on, so they might want to
            # add the reporter even though he's already the reporter of the
            # dup_of bug.
            my $vars = {};
            my $template = Bugzilla->template;
            # Ask the user what they want to do about the reporter.
1593
            $vars->{'cclist_accessible'} = $dupe_of_bug->cclist_accessible;
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
            $vars->{'original_bug_id'} = $dupe_of;
            $vars->{'duplicate_bug_id'} = $self->id;
            print $cgi->header();
            $template->process("bug/process/confirm-duplicate.html.tmpl", $vars)
              || ThrowTemplateError($template->error());
            exit;
        }
    }

    return $dupe_of;
}

1606
sub _check_groups {
1607 1608 1609
    my ($invocant, $group_names, undef, $params) = @_;
    my $product = blessed($invocant) ? $invocant->product_obj 
                                     : $params->{product};
1610 1611
    my %add_groups;

1612 1613 1614 1615 1616 1617 1618
    # In email or WebServices, when the "groups" item actually 
    # isn't specified, then just add the default groups.
    if (!defined $group_names) {
        my $available = $product->groups_available;
        foreach my $group (@$available) {
            $add_groups{$group->id} = $group if $group->{is_default};
        }
1619
    }
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
    else {
        # Allow a comma-separated list, for email_in.pl.
        $group_names = [map { trim($_) } split(',', $group_names)]
            if !ref $group_names;

        # First check all the groups they chose to set.
        foreach my $name (@$group_names) {
            # We don't want to expose the existence or non-existence of groups,
            # so instead of doing check(), we just do "next" on an invalid
            # group.
            my $group = new Bugzilla::Group({ name => $name }) or next;
1631
            next if !$product->group_is_settable($group);
1632
            $add_groups{$group->id} = $group;
1633 1634 1635
        }
    }

1636 1637 1638 1639
    # Now enforce mandatory groups.
    $add_groups{$_->id} = $_ foreach @{ $product->groups_mandatory };

    my @add_groups = values %add_groups;
1640 1641 1642
    return \@add_groups;
}

1643
sub _check_keywords {
1644 1645 1646 1647 1648 1649 1650 1651 1652
    my ($invocant, $keywords_in, undef, $params) = @_;

    return [] if !defined $keywords_in;

    my $keyword_array = $keywords_in;
    if (!ref $keyword_array) {
        $keywords_in = trim($keywords_in);
        $keyword_array = [split(/[\s,]+/, $keywords_in)];
    }
1653 1654 1655
    
    # On creation, only editbugs users can set keywords.
    if (!ref $invocant) {
1656
        my $product = $params->{product};
1657 1658 1659
        return [] if !Bugzilla->user->in_group('editbugs', $product->id);
    }
    
1660
    my %keywords;
1661
    foreach my $keyword (@$keyword_array) {
1662
        next unless $keyword;
1663
        my $obj = Bugzilla::Keyword->check($keyword);
1664
        $keywords{$obj->id} = $obj;
1665
    }
1666
    return [values %keywords];
1667 1668
}

1669
sub _check_product {
1670
    my ($invocant, $name) = @_;
1671 1672 1673 1674 1675
    $name = trim($name);
    # If we're updating the bug and they haven't changed the product,
    # always allow it.
    if (ref $invocant && lc($invocant->product_obj->name) eq lc($name)) {
        return $invocant->product_obj;
1676
    }
1677 1678
    # Check that the product exists and that the user
    # is allowed to enter bugs into this product.
1679 1680
    my $product = Bugzilla->user->can_enter_product($name, THROW_ERROR);
    return $product;
1681 1682
}

1683
sub _check_priority {
1684
    my ($invocant, $priority) = @_;
1685
    if (!ref $invocant && !Bugzilla->params->{'letsubmitterchoosepriority'}) {
1686 1687
        $priority = Bugzilla->params->{'defaultpriority'};
    }
1688
    return $invocant->_check_select_field($priority, 'priority');
1689 1690
}

1691
sub _check_qa_contact {
1692
    my ($invocant, $qa_contact, undef, $params) = @_;
1693
    $qa_contact = trim($qa_contact) if !ref $qa_contact;
1694 1695
    my $component = blessed($invocant) ? $invocant->component_obj
                                       : $params->{component};
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
    my $id;
    if (!ref $invocant) {
        # Bugs get no QA Contact on creation if useqacontact is off.
        return undef if !Bugzilla->params->{useqacontact};
        # Set the default QA Contact if one isn't specified or if the
        # user doesn't have editbugs.
        if (!Bugzilla->user->in_group('editbugs', $component->product_id)
            || !$qa_contact)
        {
            $id = $component->default_qa_contact->id;
        }
    }
    
    # If a QA Contact was specified or if we're updating, check
    # the QA Contact for validity.
    if (!defined $id && $qa_contact) {
        $qa_contact = Bugzilla::User->check($qa_contact) if !ref $qa_contact;
        $id = $qa_contact->id;
        # create() checks this another way, so we don't have to run this
        # check during create().
1716
        # If there is no QA contact, this check is not required.
1717
        $invocant->_check_strict_isolation_for_user($qa_contact)
1718
            if (ref $invocant && $id);
1719 1720 1721 1722 1723 1724
    }

    # "0" always means "undef", for QA Contact.
    return $id || undef;
}

1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
sub _check_reporter {
    my $invocant = shift;
    my $reporter;
    if (ref $invocant) {
        # You cannot change the reporter of a bug.
        $reporter = $invocant->reporter->id;
    }
    else {
        # On bug creation, the reporter is the logged in user
        # (meaning that he must be logged in first!).
1735
        Bugzilla->login(LOGIN_REQUIRED);
1736 1737 1738 1739 1740
        $reporter = Bugzilla->user->id;
    }
    return $reporter;
}

1741
sub _check_resolution {
1742
    my ($self, $resolution) = @_;
1743
    $resolution = trim($resolution);
1744 1745 1746 1747 1748 1749 1750 1751
    
    # Throw a special error for resolving bugs without a resolution
    # (or trying to change the resolution to '' on a closed bug without
    # using clear_resolution).
    ThrowUserError('missing_resolution', { status => $self->status->name })
        if !$resolution && !$self->status->is_open;
    
    # Make sure this is a valid resolution.
1752
    $resolution = $self->_check_select_field($resolution, 'resolution');
1753 1754 1755 1756 1757

    # Don't allow open bugs to have resolutions.
    ThrowUserError('resolution_not_allowed') if $self->status->is_open;
    
    # Check noresolveonopenblockers.
1758 1759
    if (Bugzilla->params->{"noresolveonopenblockers"}
        && $resolution eq 'FIXED'
1760 1761
        && (!$self->resolution || $resolution ne $self->resolution)
        && scalar @{$self->dependson})
1762
    {
1763 1764 1765
        my $dep_bugs = Bugzilla::Bug->new_from_list($self->dependson);
        my $count_open = grep { $_->isopened } @$dep_bugs;
        if ($count_open) {
1766
            ThrowUserError("still_unresolved_bugs",
1767
                           { bug_id => $self->id, dep_count => $count_open });
1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
        }
    }

    # Check if they're changing the resolution and need to comment.
    if (Bugzilla->params->{'commentonchange_resolution'} 
        && $self->resolution && $resolution ne $self->resolution 
        && !$self->{added_comments})
    {
        ThrowUserError('comment_required');
    }
    
1779 1780 1781
    return $resolution;
}

1782
sub _check_short_desc {
1783
    my ($invocant, $short_desc) = @_;
1784 1785 1786 1787 1788 1789 1790 1791 1792
    # Set the parameter to itself, but cleaned up
    $short_desc = clean_text($short_desc) if $short_desc;

    if (!defined $short_desc || $short_desc eq '') {
        ThrowUserError("require_summary");
    }
    return $short_desc;
}

1793
sub _check_status_whiteboard { return defined $_[1] ? $_[1] : ''; }
1794

1795 1796
# Unlike other checkers, this one doesn't return anything.
sub _check_strict_isolation {
1797
    my ($invocant, $ccs, $assignee, $qa_contact, $product) = @_;
1798 1799
    return unless Bugzilla->params->{'strict_isolation'};

1800 1801 1802 1803 1804 1805 1806 1807 1808
    if (ref $invocant) {
        my $original = $invocant->new($invocant->id);

        # We only check people if they've been added. This way, if
        # strict_isolation is turned on when there are invalid users
        # on bugs, people can still add comments and so on.
        my @old_cc = map { $_->id } @{$original->cc_users};
        my @new_cc = map { $_->id } @{$invocant->cc_users};
        my ($removed, $added) = diff_arrays(\@old_cc, \@new_cc);
1809 1810
        $ccs = Bugzilla::User->new_from_list($added);

1811 1812
        $assignee = $invocant->assigned_to
            if $invocant->assigned_to->id != $original->assigned_to->id;
1813 1814 1815 1816 1817 1818
        if ($invocant->qa_contact
            && (!$original->qa_contact
                || $invocant->qa_contact->id != $original->qa_contact->id))
        {
            $qa_contact = $invocant->qa_contact;
        }
1819
        $product = $invocant->product_obj;
1820 1821 1822 1823
    }

    my @related_users = @$ccs;
    push(@related_users, $assignee) if $assignee;
1824

1825 1826
    if (Bugzilla->params->{'useqacontact'} && $qa_contact) {
        push(@related_users, $qa_contact);
1827 1828
    }

1829 1830 1831
    @related_users = @{Bugzilla::User->new_from_list(\@related_users)}
        if !ref $invocant;

1832 1833
    # For each unique user in @related_users...(assignee and qa_contact
    # could be duplicates of users in the CC list)
1834
    my %unique_users = map {$_->id => $_} @related_users;
1835
    my @blocked_users;
1836 1837
    foreach my $id (keys %unique_users) {
        my $related_user = $unique_users{$id};
1838
        if (!$related_user->can_edit_product($product->id) ||
1839
            !$related_user->can_see_product($product->name)) {
1840 1841 1842 1843
            push (@blocked_users, $related_user->login);
        }
    }
    if (scalar(@blocked_users)) {
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
        my %vars = ( users   => \@blocked_users,
                     product => $product->name );
        if (ref $invocant) {
            $vars{'bug_id'} = $invocant->id;
        }
        else {
            $vars{'new'} = 1;
        }
        ThrowUserError("invalid_user_group", \%vars);
    }
}

# This is used by various set_ checkers, to make their code simpler.
sub _check_strict_isolation_for_user {
    my ($self, $user) = @_;
    return unless Bugzilla->params->{"strict_isolation"};
    if (!$user->can_edit_product($self->{product_id})) {
        ThrowUserError('invalid_user_group',
                       { users   => $user->login,
                         product => $self->product,
                         bug_id  => $self->id });
1865 1866 1867
    }
}

1868
sub _check_target_milestone {
1869 1870 1871
    my ($invocant, $target, undef, $params) = @_;
    my $product = blessed($invocant) ? $invocant->product_obj 
                                     : $params->{product};
1872 1873
    $target = trim($target);
    $target = $product->default_milestone if !defined $target;
1874 1875 1876
    my $object = Bugzilla::Milestone->check(
        { product => $product, name => $target });
    return $object->name;
1877 1878 1879
}

sub _check_version {
1880
    my ($invocant, $version, undef, $params) = @_;
1881
    $version = trim($version);
1882 1883
    my $product = blessed($invocant) ? $invocant->product_obj 
                                     : $params->{product};
1884 1885 1886
    my $object = 
        Bugzilla::Version->check({ product => $product, name => $version });
    return $object->name;
1887 1888
}

1889 1890
# Custom Field Validators

1891 1892 1893 1894
sub _check_field_is_mandatory {
    my ($invocant, $value, $field, $params) = @_;

    if (!blessed($field)) {
1895 1896
        $field = Bugzilla::Field->new({ name => $field });
        return if !$field;
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
    }

    return if !$field->is_mandatory;

    return if !$field->is_visible_on_bug($params || $invocant);

    if (ref($value) eq 'ARRAY') {
        $value = join('', @$value);
    }

    $value = trim($value);
    if (!defined($value)
        or $value eq ""
        or ($value eq '---' and $field->type == FIELD_TYPE_SINGLE_SELECT)
        or ($value =~ EMPTY_DATETIME_REGEX
            and $field->type == FIELD_TYPE_DATETIME))
    {
        ThrowUserError('required_field', { field => $field });
    }
}

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
sub _check_datetime_field {
    my ($invocant, $date_time) = @_;

    # Empty datetimes are empty strings or strings only containing
    # 0's, whitespace, and punctuation.
    if ($date_time =~ /^[\s0[:punct:]]*$/) {
        return undef;
    }

    $date_time = trim($date_time);
    my ($date, $time) = split(' ', $date_time);
    if ($date && !validate_date($date)) {
        ThrowUserError('illegal_date', { date   => $date,
                                         format => 'YYYY-MM-DD' });
    }
    if ($time && !validate_time($time)) {
        ThrowUserError('illegal_time', { 'time' => $time,
                                         format => 'HH:MM:SS' });
    }
    return $date_time
}

1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
sub _check_default_field { return defined $_[1] ? trim($_[1]) : ''; }

sub _check_freetext_field {
    my ($invocant, $text) = @_;

    $text = (defined $text) ? trim($text) : '';
    if (length($text) > MAX_FREETEXT_LENGTH) {
        ThrowUserError('freetext_too_long', { text => $text });
    }
    return $text;
}

1952 1953
sub _check_multi_select_field {
    my ($invocant, $values, $field) = @_;
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964

    # Allow users (mostly email_in.pl) to specify multi-selects as
    # comma-separated values.
    if (defined $values and !ref $values) {
        # We don't split on spaces because multi-select values can and often
        # do have spaces in them. (Theoretically they can have commas in them
        # too, but that's much less common and people should be able to work
        # around it pretty cleanly, if they want to use email_in.pl.)
        $values = [split(',', $values)];
    }

1965
    return [] if !$values;
1966
    my @checked_values;
1967
    foreach my $value (@$values) {
1968
        push(@checked_values, $invocant->_check_select_field($value, $field));
1969
    }
1970
    return \@checked_values;
1971 1972
}

1973 1974
sub _check_select_field {
    my ($invocant, $value, $field) = @_;
1975 1976
    my $object = Bugzilla::Field::Choice->type($field)->check($value);
    return $object->name;
1977
}
1978

1979 1980 1981
sub _check_bugid_field {
    my ($invocant, $value, $field) = @_;
    return undef if !$value;
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
    
    # check that the value is a valid, visible bug id
    my $checked_id = $invocant->check($value, $field)->id;
    
    # check for loop (can't have a loop if this is a new bug)
    if (ref $invocant) {
        _check_relationship_loop($field, $invocant->bug_id, $checked_id);
    }

    return $checked_id;
}

sub _check_relationship_loop {
    # Generates a dependency tree for a given bug.  Calls itself recursively
    # to generate sub-trees for the bug's dependencies.
    my ($field, $bug_id, $dep_id, $ids) = @_;

    # Don't do anything if this bug doesn't have any dependencies.
    return unless defined($dep_id);

    # Check whether we have seen this bug yet
    $ids = {} unless defined $ids;
    $ids->{$bug_id} = 1;
    if ($ids->{$dep_id}) {
        ThrowUserError("relationship_loop_single", {
            'bug_id' => $bug_id,
            'dep_id' => $dep_id,
            'field_name' => $field});
    }
    
    # Get this dependency's record from the database
    my $dbh = Bugzilla->dbh;
    my $next_dep_id = $dbh->selectrow_array(
        "SELECT $field FROM bugs WHERE bug_id = ?", undef, $dep_id);

    _check_relationship_loop($field, $dep_id, $next_dep_id, $ids);
2018 2019
}

2020
#####################################################################
2021 2022 2023 2024 2025 2026
# Class Accessors
#####################################################################

sub fields {
    my $class = shift;

2027 2028
   my @fields =
   (
2029 2030 2031 2032 2033 2034
        # Standard Fields
        # Keep this ordering in sync with bugzilla.dtd.
        qw(bug_id alias creation_ts short_desc delta_ts
           reporter_accessible cclist_accessible
           classification_id classification
           product component version rep_platform op_sys
2035
           bug_status resolution dup_id see_also
2036 2037
           bug_file_loc status_whiteboard keywords
           priority bug_severity target_milestone
2038
           dependson blocked everconfirmed
2039 2040 2041
           reporter assigned_to cc estimated_time
           remaining_time actual_time deadline),

2042
        # Conditional Fields
2043
        Bugzilla->params->{'useqacontact'} ? "qa_contact" : (),
2044
        # Custom Fields
2045
        map { $_->name } Bugzilla->active_custom_fields
2046
    );
2047
    Bugzilla::Hook::process('bug_fields', {'fields' => \@fields} );
2048 2049
    
    return @fields;
2050 2051
}

2052 2053 2054 2055
#####################################################################
# Mutators 
#####################################################################

2056 2057 2058
# To run check_can_change_field.
sub _set_global_validator {
    my ($self, $value, $field) = @_;
2059
    my $current = $self->$field;
2060
    my $privs;
2061 2062 2063 2064 2065 2066 2067 2068 2069

    if (ref $current && ref($current) ne 'ARRAY'
        && $current->isa('Bugzilla::Object')) {
        $current = $current->id ;
    }
    if (ref $value && ref($value) ne 'ARRAY'
        && $value->isa('Bugzilla::Object')) {
        $value = $value->id ;
    }
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
    my $can = $self->check_can_change_field($field, $current, $value, \$privs);
    if (!$can) {
        if ($field eq 'assigned_to' || $field eq 'qa_contact') {
            $value   = user_id_to_login($value);
            $current = user_id_to_login($current);
        }
        ThrowUserError('illegal_change', { field    => $field,
                                           oldvalue => $current,
                                           newvalue => $value,
                                           privs    => $privs });
    }
2081
    $self->_check_field_is_mandatory($value, $field);
2082 2083 2084
}


2085 2086 2087 2088
#################
# "Set" Methods #
#################

2089 2090
# Note that if you are changing multiple bugs at once, you must pass
# other_bugs to set_all in order for it to behave properly.
2091 2092 2093 2094
sub set_all {
    my $self = shift;
    my ($params) = @_;

2095 2096 2097 2098 2099 2100 2101 2102 2103
    # You cannot mark bugs as duplicate when changing several bugs at once
    # (because currently there is no way to check for duplicate loops in that
    # situation). You also cannot set the alias of several bugs at once.
    if ($params->{other_bugs} and scalar @{ $params->{other_bugs} } > 1) {
        ThrowUserError('dupe_not_allowed') if exists $params->{dup_id};
        ThrowUserError('multiple_alias_not_allowed') 
            if defined $params->{alias};
    }

2104 2105 2106 2107 2108 2109 2110
    # For security purposes, and because lots of other checks depend on it,
    # we set the product first before anything else.
    my $product_changed; # Used only for strict_isolation checks.
    if (exists $params->{'product'}) {
        $product_changed = $self->_set_product($params->{'product'}, $params);
    }

2111 2112
    # strict_isolation checks mean that we should set the groups
    # immediately after changing the product.
2113
    $self->_add_remove($params, 'groups');
2114

2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
    if (exists $params->{'dependson'} or exists $params->{'blocked'}) {
        my %set_deps;
        foreach my $name (qw(dependson blocked)) {
            my @dep_ids = @{ $self->$name };
            # If only one of the two fields was passed in, then we need to
            # retain the current value for the other one.
            if (!exists $params->{$name}) {
                $set_deps{$name} = \@dep_ids;
                next;
            }

            # Explicitly setting them to a particular value overrides
            # add/remove.
            if (exists $params->{$name}->{set}) {
                $set_deps{$name} = $params->{$name}->{set};
                next;
            }

            foreach my $add (@{ $params->{$name}->{add} || [] }) {
                push(@dep_ids, $add) if !grep($_ == $add, @dep_ids);
            }
            foreach my $remove (@{ $params->{$name}->{remove} || [] }) {
                @dep_ids = grep($_ != $remove, @dep_ids);
            }
            $set_deps{$name} = \@dep_ids;
        }

        $self->set_dependencies($set_deps{'dependson'}, $set_deps{'blocked'});
    }

2145
    if (exists $params->{'keywords'}) {
2146 2147 2148 2149 2150
        # Sorting makes the order "add, remove, set", just like for other
        # fields.
        foreach my $action (sort keys %{ $params->{'keywords'} }) {
            $self->modify_keywords($params->{'keywords'}->{$action}, $action);
        }
2151 2152
    }

2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
    if (exists $params->{'comment'} or exists $params->{'work_time'}) {
        # Add a comment as needed to each bug. This is done early because
        # there are lots of things that want to check if we added a comment.
        $self->add_comment($params->{'comment'}->{'body'},
            { isprivate => $params->{'comment'}->{'is_private'},
              work_time => $params->{'work_time'} });
    }

    my %normal_set_all;
    foreach my $name (keys %$params) {
2163
        # These are handled separately below.
2164 2165 2166 2167 2168
        if ($self->can("set_$name")) {
            $normal_set_all{$name} = $params->{$name};
        }
    }
    $self->SUPER::set_all(\%normal_set_all);
2169 2170 2171 2172

    $self->reset_assigned_to if $params->{'reset_assigned_to'};
    $self->reset_qa_contact  if $params->{'reset_qa_contact'};

2173
    $self->_add_remove($params, 'see_also');
2174 2175 2176 2177 2178 2179 2180 2181 2182

    # And set custom fields.
    my @custom_fields = Bugzilla->active_custom_fields;
    foreach my $field (@custom_fields) {
        my $fname = $field->name;
        if (exists $params->{$fname}) {
            $self->set_custom_field($field, $params->{$fname});
        }
    }
2183 2184

    $self->_add_remove($params, 'cc');
2185 2186 2187 2188 2189 2190 2191 2192

    # Theoretically you could move a product without ever specifying
    # a new assignee or qa_contact, or adding/removing any CCs. So,
    # we have to check that the current assignee, qa, and CCs are still
    # valid if we've switched products, under strict_isolation. We can only
    # do that here, because if they *did* change the assignee, qa, or CC,
    # then we don't want to check the original ones, only the new ones. 
    $self->_check_strict_isolation() if $product_changed;
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
}

# Helper for set_all that helps with fields that have an "add/remove"
# pattern instead of a "set_" pattern.
sub _add_remove {
    my ($self, $params, $name) = @_;
    my @add    = @{ $params->{$name}->{add}    || [] };
    my @remove = @{ $params->{$name}->{remove} || [] };
    $name =~ s/s$//;
    my $add_method = "add_$name";
    my $remove_method = "remove_$name";
    $self->$add_method($_) foreach @add;
    $self->$remove_method($_) foreach @remove;
2206 2207
}

2208
sub set_alias { $_[0]->set('alias', $_[1]); }
2209 2210 2211
sub set_assigned_to {
    my ($self, $value) = @_;
    $self->set('assigned_to', $value);
2212 2213
    # Store the old assignee. check_can_change_field() needs it.
    $self->{'_old_assigned_to'} = $self->{'assigned_to_obj'}->id;
2214 2215 2216 2217 2218 2219 2220
    delete $self->{'assigned_to_obj'};
}
sub reset_assigned_to {
    my $self = shift;
    my $comp = $self->component_obj;
    $self->set_assigned_to($comp->default_assignee);
}
2221
sub set_cclist_accessible { $_[0]->set('cclist_accessible', $_[1]); }
2222 2223 2224
sub set_comment_is_private {
    my ($self, $comment_id, $isprivate) = @_;
    return unless Bugzilla->user->is_insider;
2225 2226 2227 2228 2229 2230 2231 2232 2233

    # We also allow people to pass in a hash of comment ids to update.
    if (ref $comment_id) {
        while (my ($id, $is) = each %$comment_id) {
            $self->set_comment_is_private($id, $is);
        }
        return;
    }

2234
    my ($comment) = grep($comment_id == $_->id, @{ $self->comments });
2235 2236 2237 2238
    ThrowUserError('comment_invalid_isprivate', { id => $comment_id }) 
        if !$comment;

    $isprivate = $isprivate ? 1 : 0;
2239
    if ($isprivate != $comment->is_private) {
2240 2241 2242
        $self->{comment_isprivate} ||= [];
        $comment->set_is_private($isprivate);
        push @{$self->{comment_isprivate}}, $comment;
2243 2244
    }
}
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
sub set_component  {
    my ($self, $name) = @_;
    my $old_comp  = $self->component_obj;
    my $component = $self->_check_component($name);
    if ($old_comp->id != $component->id) {
        $self->{component_id}  = $component->id;
        $self->{component}     = $component->name;
        $self->{component_obj} = $component;
        # For update()
        $self->{_old_component_name} = $old_comp->name;
        # Add in the Default CC of the new Component;
        foreach my $cc (@{$component->initial_cc}) {
            $self->add_cc($cc);
        }
    }
}
2261 2262
sub set_custom_field {
    my ($self, $field, $value) = @_;
2263

2264
    if (ref $value eq 'ARRAY' && $field->type != FIELD_TYPE_MULTI_SELECT) {
2265 2266
        $value = $value->[0];
    }
2267 2268 2269
    ThrowCodeError('field_not_custom', { field => $field }) if !$field->custom;
    $self->set($field->name, $value);
}
2270
sub set_deadline { $_[0]->set('deadline', $_[1]); }
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
sub set_dependencies {
    my ($self, $dependson, $blocked) = @_;
    ($dependson, $blocked) = $self->_check_dependencies($dependson, $blocked);
    # These may already be detainted, but all setters are supposed to
    # detaint their input if they've run a validator (just as though
    # we had used Bugzilla::Object::set), so we do that here.
    detaint_natural($_) foreach (@$dependson, @$blocked);
    $self->{'dependson'} = $dependson;
    $self->{'blocked'}   = $blocked;
}
2281 2282 2283 2284 2285
sub _clear_dup_id { $_[0]->{dup_id} = undef; }
sub set_dup_id {
    my ($self, $dup_id) = @_;
    my $old = $self->dup_id || 0;
    $self->set('dup_id', $dup_id);
2286
    my $new = $self->dup_id;
2287
    return if $old == $new;
2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302

    # Make sure that we have the DUPLICATE resolution. This is needed
    # if somebody calls set_dup_id without calling set_bug_status or
    # set_resolution.
    if ($self->resolution ne 'DUPLICATE') {
        # Even if the current status is VERIFIED, we change it back to
        # RESOLVED (or whatever the duplicate_or_move_bug_status is) here,
        # because that's the same thing the UI does when you click on the
        # "Mark as Duplicate" link. If people really want to retain their
        # current status, they can use set_bug_status and set the DUPLICATE
        # resolution before getting here.
        $self->set_bug_status(
            Bugzilla->params->{'duplicate_or_move_bug_status'},
            { resolution => 'DUPLICATE' });
    }
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
    
    # Update the other bug.
    my $dupe_of = new Bugzilla::Bug($self->dup_id);
    if (delete $self->{_add_dup_cc}) {
        $dupe_of->add_cc($self->reporter);
    }
    $dupe_of->add_comment("", { type       => CMT_HAS_DUPE,
                                extra_data => $self->id });
    $self->{_dup_for_update} = $dupe_of;
    
    # Now make sure that we add a duplicate comment on *this* bug.
    # (Change an existing comment into a dup comment, if there is one,
    # or add an empty dup comment.)
    if ($self->{added_comments}) {
        my @normal = grep { !defined $_->{type} || $_->{type} == CMT_NORMAL }
                          @{ $self->{added_comments} };
        # Turn the last one into a dup comment.
        $normal[-1]->{type} = CMT_DUPE_OF;
        $normal[-1]->{extra_data} = $self->dup_id;
    }
    else {
        $self->add_comment('', { type       => CMT_DUPE_OF,
                                 extra_data => $self->dup_id });
    }
}
2328
sub set_estimated_time { $_[0]->set('estimated_time', $_[1]); }
2329
sub _set_everconfirmed { $_[0]->set('everconfirmed', $_[1]); }
2330 2331 2332 2333 2334
sub set_flags {
    my ($self, $flags, $new_flags) = @_;

    Bugzilla::Flag->set_flag($self, $_) foreach (@$flags, @$new_flags);
}
2335 2336 2337
sub set_op_sys         { $_[0]->set('op_sys',        $_[1]); }
sub set_platform       { $_[0]->set('rep_platform',  $_[1]); }
sub set_priority       { $_[0]->set('priority',      $_[1]); }
2338 2339 2340
# For security reasons, you have to use set_all to change the product.
# See the strict_isolation check in set_all for an explanation.
sub _set_product {
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357
    my ($self, $name, $params) = @_;
    my $old_product = $self->product_obj;
    my $product = $self->_check_product($name);
    
    my $product_changed = 0;
    if ($old_product->id != $product->id) {
        $self->{product_id}  = $product->id;
        $self->{product}     = $product->name;
        $self->{product_obj} = $product;
        # For update()
        $self->{_old_product_name} = $old_product->name;
        # Delete fields that depend upon the old Product value.
        delete $self->{choices};
        $product_changed = 1;
    }

    $params ||= {};
2358 2359 2360 2361
    # We delete these so that they're not set again later in set_all.
    my $comp_name = delete $params->{component} || $self->component;
    my $vers_name = delete $params->{version}   || $self->version;
    my $tm_name   = delete $params->{target_milestone};
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
    # This way, if usetargetmilestone is off and we've changed products,
    # set_target_milestone will reset our target_milestone to
    # $product->default_milestone. But if we haven't changed products,
    # we don't reset anything.
    if (!defined $tm_name
        && (Bugzilla->params->{'usetargetmilestone'} || !$product_changed))
    {
        $tm_name = $self->target_milestone;
    }

    if ($product_changed && Bugzilla->usage_mode == USAGE_MODE_BROWSER) {
        # Try to set each value with the new product.
        # Have to set error_mode because Throw*Error calls exit() otherwise.
        my $old_error_mode = Bugzilla->error_mode;
        Bugzilla->error_mode(ERROR_MODE_DIE);
        my $component_ok = eval { $self->set_component($comp_name);      1; };
        my $version_ok   = eval { $self->set_version($vers_name);        1; };
2379 2380 2381 2382 2383 2384 2385 2386 2387
        my $milestone_ok = 1;
        # Reporters can move bugs between products but not set the TM.
        if ($self->check_can_change_field('target_milestone', 0, 1)) {
            $milestone_ok = eval { $self->set_target_milestone($tm_name); 1; };
        }
        else {
            # Have to set this directly to bypass the validators.
            $self->{target_milestone} = $product->default_milestone;
        }
2388 2389 2390 2391 2392
        # If there were any errors thrown, make sure we don't mess up any
        # other part of Bugzilla that checks $@.
        undef $@;
        Bugzilla->error_mode($old_error_mode);
        
2393
        my $verified = $params->{product_change_confirmed};
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419
        my %vars;
        if (!$verified || !$component_ok || !$version_ok || !$milestone_ok) {
            $vars{defaults} = {
                # Note that because of the eval { set } above, these are
                # already set correctly if they're valid, otherwise they're
                # set to some invalid value which the template will ignore.
                component => $self->component,
                version   => $self->version,
                milestone => $milestone_ok ? $self->target_milestone
                                           : $product->default_milestone
            };
            $vars{components} = [map { $_->name } @{$product->components}];
            $vars{milestones} = [map { $_->name } @{$product->milestones}];
            $vars{versions}   = [map { $_->name } @{$product->versions}];
        }

        if (!$verified) {
            $vars{verify_bug_groups} = 1;
            my $dbh = Bugzilla->dbh;
            my @idlist = ($self->id);
            push(@idlist, map {$_->id} @{ $params->{other_bugs} })
                if $params->{other_bugs};
            # Get the ID of groups which are no longer valid in the new product.
            my $gids = $dbh->selectcol_arrayref(
                'SELECT bgm.group_id
                   FROM bug_group_map AS bgm
2420
                  WHERE bgm.bug_id IN (' . join(',', ('?') x @idlist) . ')
2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
                    AND bgm.group_id NOT IN
                        (SELECT gcm.group_id
                           FROM group_control_map AS gcm
                           WHERE gcm.product_id = ?
                                 AND ( (gcm.membercontrol != ?
                                        AND gcm.group_id IN ('
                                        . Bugzilla->user->groups_as_string . '))
                                       OR gcm.othercontrol != ?) )',
                undef, (@idlist, $product->id, CONTROLMAPNA, CONTROLMAPNA));
            $vars{'old_groups'} = Bugzilla::Group->new_from_list($gids);            
        }
        
        if (%vars) {
            $vars{product} = $product;
2435
            $vars{bug} = $self;
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446
            my $template = Bugzilla->template;
            $template->process("bug/process/verify-new-product.html.tmpl",
                \%vars) || ThrowTemplateError($template->error());
            exit;
        }
    }
    else {
        # When we're not in the browser (or we didn't change the product), we
        # just die if any of these are invalid.
        $self->set_component($comp_name);
        $self->set_version($vers_name);
2447 2448 2449
        if ($product_changed 
            and !$self->check_can_change_field('target_milestone', 0, 1)) 
        {
2450 2451 2452
            # Have to set this directly to bypass the validators.
            $self->{target_milestone} = $product->default_milestone;
        }
2453 2454 2455
        else {
            $self->set_target_milestone($tm_name);
        }
2456 2457
    }
    
2458
    if ($product_changed) {
2459 2460
        # Remove groups that can't be set in the new product, or that aren't
        # active.
2461 2462 2463 2464 2465
        #
        # We copy this array because the original array is modified while we're
        # working, and that confuses "foreach".
        my @current_groups = @{$self->groups_in};
        foreach my $group (@current_groups) {
2466
            if (!$group->is_active or !$product->group_is_valid($group)) {
2467 2468 2469 2470 2471
                $self->remove_group($group);
            }
        }
    
        # Make sure the bug is in all the mandatory groups for the new product.
2472
        foreach my $group (@{$product->groups_mandatory}) {
2473 2474 2475 2476
            $self->add_group($group);
        }
    }
    
2477 2478 2479
    return $product_changed;
}

2480 2481 2482
sub set_qa_contact {
    my ($self, $value) = @_;
    $self->set('qa_contact', $value);
2483 2484 2485 2486
    # Store the old QA contact. check_can_change_field() needs it.
    if ($self->{'qa_contact_obj'}) {
        $self->{'_old_qa_contact'} = $self->{'qa_contact_obj'}->id;
    }
2487 2488 2489 2490 2491 2492 2493
    delete $self->{'qa_contact_obj'};
}
sub reset_qa_contact {
    my $self = shift;
    my $comp = $self->component_obj;
    $self->set_qa_contact($comp->default_qa_contact);
}
2494 2495 2496
sub set_remaining_time { $_[0]->set('remaining_time', $_[1]); }
# Used only when closing a bug or moving between closed states.
sub _zero_remaining_time { $_[0]->{'remaining_time'} = 0; }
2497
sub set_reporter_accessible { $_[0]->set('reporter_accessible', $_[1]); }
2498
sub set_resolution {
2499
    my ($self, $value, $params) = @_;
2500 2501 2502
    
    my $old_res = $self->resolution;
    $self->set('resolution', $value);
2503
    delete $self->{choices};
2504
    my $new_res = $self->resolution;
2505

2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
    if ($new_res ne $old_res) {
        # Clear the dup_id if we're leaving the dup resolution.
        if ($old_res eq 'DUPLICATE') {
            $self->_clear_dup_id();
        }
        # Duplicates should have no remaining time left.
        elsif ($new_res eq 'DUPLICATE' && $self->remaining_time != 0) {
            $self->_zero_remaining_time();
        }
    }
    
    # We don't check if we're entering or leaving the dup resolution here,
    # because we could be moving from being a dup of one bug to being a dup
    # of another, theoretically. Note that this code block will also run
    # when going between different closed states.
    if ($self->resolution eq 'DUPLICATE') {
2522 2523
        if (my $dup_id = $params->{dup_id}) {
            $self->set_dup_id($dup_id);
2524 2525 2526 2527 2528
        }
        elsif (!$self->dup_id) {
            ThrowUserError('dupe_id_required');
        }
    }
2529 2530 2531 2532

    # This method has handled dup_id, so set_all doesn't have to worry
    # about it now.
    delete $params->{dup_id};
2533 2534 2535 2536 2537 2538 2539 2540 2541
}
sub clear_resolution {
    my $self = shift;
    if (!$self->status->is_open) {
        ThrowUserError('resolution_cant_clear', { bug_id => $self->id });
    }
    $self->{'resolution'} = ''; 
    $self->_clear_dup_id; 
}
2542
sub set_severity       { $_[0]->set('bug_severity',  $_[1]); }
2543
sub set_bug_status {
2544
    my ($self, $status, $params) = @_;
2545
    my $old_status = $self->status;
2546
    $self->set('bug_status', $status);
2547
    delete $self->{'status'};
2548 2549
    delete $self->{'statuses_available'};
    delete $self->{'choices'};
2550
    my $new_status = $self->status;
2551
   
2552 2553
    if ($new_status->is_open) {
        # Check for the everconfirmed transition
2554
        $self->_set_everconfirmed($new_status->name eq 'UNCONFIRMED' ? 0 : 1);
2555
        $self->clear_resolution();
2556 2557 2558 2559
        # Calling clear_resolution handled the "resolution" and "dup_id"
        # setting, so set_all doesn't have to worry about them.
        delete $params->{resolution};
        delete $params->{dup_id};
2560 2561 2562 2563
    }
    else {
        # We do this here so that we can make sure closed statuses have
        # resolutions.
2564 2565 2566
        my $resolution = delete $params->{resolution} || $self->resolution;
        $self->set_resolution($resolution, $params);

2567 2568 2569 2570 2571
        # Changing between closed statuses zeros the remaining time.
        if ($new_status->id != $old_status->id && $self->remaining_time != 0) {
            $self->_zero_remaining_time();
        }
    }
2572
}
2573
sub set_status_whiteboard { $_[0]->set('status_whiteboard', $_[1]); }
2574 2575 2576 2577
sub set_summary           { $_[0]->set('short_desc',        $_[1]); }
sub set_target_milestone  { $_[0]->set('target_milestone',  $_[1]); }
sub set_url               { $_[0]->set('bug_file_loc',      $_[1]); }
sub set_version           { $_[0]->set('version',           $_[1]); }
2578 2579 2580 2581 2582

########################
# "Add/Remove" Methods #
########################

2583 2584
# These are in alphabetical order by field name.

2585 2586 2587
# Accepts a User object or a username. Adds the user only if they
# don't already exist as a CC on the bug.
sub add_cc {
2588
    my ($self, $user_or_name) = @_;
2589 2590
    return if !$user_or_name;
    my $user = ref $user_or_name ? $user_or_name
2591
                                 : Bugzilla::User->check($user_or_name);
2592
    $self->_check_strict_isolation_for_user($user);
2593 2594 2595 2596 2597 2598 2599 2600 2601
    my $cc_users = $self->cc_users;
    push(@$cc_users, $user) if !grep($_->id == $user->id, @$cc_users);
}

# Accepts a User object or a username. Removes the User if they exist
# in the list, but doesn't throw an error if they don't exist.
sub remove_cc {
    my ($self, $user_or_name) = @_;
    my $user = ref $user_or_name ? $user_or_name
2602
                                 : Bugzilla::User->check($user_or_name);
2603 2604 2605 2606
    my $cc_users = $self->cc_users;
    @$cc_users = grep { $_->id != $user->id } @$cc_users;
}

2607 2608 2609 2610 2611 2612 2613
# $bug->add_comment("comment", {isprivate => 1, work_time => 10.5,
#                               type => CMT_NORMAL, extra_data => $data});
sub add_comment {
    my ($self, $comment, $params) = @_;

    $params ||= {};

2614 2615
    # This makes it so we won't create new comments when there is nothing
    # to add 
2616
    if ($comment eq '' && !($params->{type} || abs($params->{work_time}))) {
2617 2618 2619
        return;
    }

2620 2621 2622 2623 2624 2625 2626 2627
    # Fill out info that doesn't change and callers may not pass in
    $params->{'bug_id'}  = $self;
    $params->{'thetext'} = $comment;

    # Validate all the entered data
    Bugzilla::Comment->check_required_create_fields($params);
    $params = Bugzilla::Comment->run_create_validators($params);

2628 2629 2630 2631
    # If the user has explicitly set remaining_time, this will be overridden
    # later in set_all. But if they haven't, this keeps remaining_time
    # up-to-date.
    if ($params->{work_time}) {
2632
        $self->set_remaining_time(max($self->remaining_time - $params->{work_time}, 0));
2633 2634
    }

2635 2636
    $self->{added_comments} ||= [];

2637
    push(@{$self->{added_comments}}, $params);
2638
}
2639

2640 2641 2642 2643 2644 2645
# There was a lot of duplicate code when I wrote this as three separate
# functions, so I just combined them all into one. This is also easier for
# process_bug to use.
sub modify_keywords {
    my ($self, $keywords, $action) = @_;
    
2646 2647 2648
    $action ||= 'set';
    if (!grep($action eq $_, qw(add remove set))) {
        $action = 'set';
2649 2650 2651 2652 2653
    }
    
    $keywords = $self->_check_keywords($keywords);

    my (@result, $any_changes);
2654
    if ($action eq 'set') {
2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
        @result = @$keywords;
        # Check if anything was added or removed.
        my @old_ids = map { $_->id } @{$self->keyword_objects};
        my @new_ids = map { $_->id } @result;
        my ($removed, $added) = diff_arrays(\@old_ids, \@new_ids);
        $any_changes = scalar @$removed || scalar @$added;
    }
    else {
        # We're adding or deleting specific keywords.
        my %keys = map {$_->id => $_} @{$self->keyword_objects};
        if ($action eq 'add') {
            $keys{$_->id} = $_ foreach @$keywords;
        }
        else {
            delete $keys{$_->id} foreach @$keywords;
        }
        @result = values %keys;
        $any_changes = scalar @$keywords;
    }
    # Make sure we retain the sort order.
    @result = sort {lc($a->name) cmp lc($b->name)} @result;
    
    if ($any_changes) {
        my $privs;
        my $new = join(', ', (map {$_->name} @result));
        my $check = $self->check_can_change_field('keywords', 0, 1, \$privs)
            || ThrowUserError('illegal_change', { field    => 'keywords',
                                                  oldvalue => $self->keywords,
                                                  newvalue => $new,
                                                  privs    => $privs });
    }

    $self->{'keyword_objects'} = \@result;
}

2690 2691 2692 2693
sub add_group {
    my ($self, $group) = @_;
    # Invalid ids are silently ignored. (We can't tell people whether
    # or not a group exists.)
2694
    $group = Bugzilla::Group->check($group) if !blessed $group;
2695

2696 2697
    return if !$group->is_active or !$group->is_bug_group;

2698
    # Make sure that bugs in this product can actually be restricted
2699 2700
    # to this group by the current user.
    $self->product_obj->group_is_settable($group)
2701
         || ThrowUserError('group_invalid_restriction',
2702
                { product => $self->product, group => $group,
2703
                  bug => $self });
2704 2705 2706 2707 2708 2709 2710 2711 2712

    # OtherControl people can add groups only during a product change,
    # and only when the group is not NA for them.
    if (!Bugzilla->user->in_group($group->name)) {
        my $controls = $self->product_obj->group_controls->{$group->id};
        if (!$self->{_old_product_name}
            || $controls->{othercontrol} == CONTROLMAPNA)
        {
            ThrowUserError('group_change_denied',
2713
                           { bug => $self, group => $group });
2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
        }
    }

    my $current_groups = $self->groups_in;
    if (!grep($group->id == $_->id, @$current_groups)) {
        push(@$current_groups, $group);
    }
}

sub remove_group {
    my ($self, $group) = @_;
2725
    $group = Bugzilla::Group->check($group) if !blessed $group;
2726 2727
    
    # First, check if this is a valid group for this product.
2728 2729 2730 2731
    # You can *always* remove a group that is not valid for this product
    # or that is not active, so we don't do any other checks if either of
    # those are the case. (Users might remove inactive groups, and set_product
    # removes groups that aren't valid for this product.)
2732 2733 2734
    #
    # This particularly happens when isbuggroup is no longer 1, and we're
    # moving a bug to a new product.
2735
    if ($group->is_active and $self->product_obj->group_is_valid($group)) {
2736 2737 2738 2739 2740
        my $controls = $self->product_obj->group_controls->{$group->id};

        # Nobody can ever remove a Mandatory group.
        if ($controls->{membercontrol} == CONTROLMAPMANDATORY) {
            ThrowUserError('group_invalid_removal',
2741
                { product => $self->product, group => $group,
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
                  bug => $self });
        }

        # OtherControl people can remove groups only during a product change,
        # and only when they are non-Mandatory and non-NA.
        if (!Bugzilla->user->in_group($group->name)) {
            if (!$self->{_old_product_name}
                || $controls->{othercontrol} == CONTROLMAPMANDATORY
                || $controls->{othercontrol} == CONTROLMAPNA)
            {
                ThrowUserError('group_change_denied',
2753
                               { bug => $self, group => $group });
2754 2755 2756 2757 2758 2759 2760 2761
            }
        }
    }
    
    my $current_groups = $self->groups_in;
    @$current_groups = grep { $_->id != $group->id } @$current_groups;
}

2762
sub add_see_also {
2763
    my ($self, $input, $skip_recursion) = @_;
2764 2765
    $input = trim($input);

2766 2767 2768 2769 2770
    if (!$input) {
        ThrowCodeError('param_required', 
                       { function => 'add_see_also', param => '$input' });
    }

2771 2772 2773
    # If a bug id/alias has been taken, then treat it
    # as a link to the local Bugzilla.
    my $local_bug_uri = correct_urlbase() . "show_bug.cgi?id=";
2774 2775
    if ($input =~ m/^\w+$/) {
        $input = $local_bug_uri . $input;
2776 2777
    }

2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790
    # We assume that the URL is an HTTP URL if there is no (something):// 
    # in front.
    my $uri = new URI($input);
    if (!$uri->scheme) {
        # This works better than setting $uri->scheme('http'), because
        # that creates URLs like "http:domain.com" and doesn't properly
        # differentiate the path from the domain.
        $uri = new URI("http://$input");
    }
    elsif ($uri->scheme ne 'http' && $uri->scheme ne 'https') {
        ThrowUserError('bug_url_invalid', { url => $input, reason => 'http' });
    }

2791 2792 2793 2794 2795 2796 2797 2798 2799
    # This stops the following edge cases from being accepted:
    # * show_bug.cgi?id=1
    # * /show_bug.cgi?id=1
    # * http:///show_bug.cgi?id=1
    if (!$uri->authority or $uri->path !~ m{/}) {
        ThrowUserError('bug_url_invalid',
                       { url => $input, reason => 'path_only' });
    }

2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
    my $result;
    # Launchpad URLs
    if ($uri->authority =~ /launchpad.net$/) {
        # Launchpad bug URLs can look like various things:
        #   https://bugs.launchpad.net/ubuntu/+bug/1234
        #   https://launchpad.net/bugs/1234
        # All variations end with either "/bugs/1234" or "/+bug/1234"
        if ($uri->path =~ m|bugs?/(\d+)$|) {
            # This is the shortest standard URL form for Launchpad bugs,
            # and so we reduce all URLs to this.
            $result = "https://launchpad.net/bugs/$1";
        }
        else {
            ThrowUserError('bug_url_invalid',
                           { url => $input, reason => 'id' });
        }
    }
2817
    # Google Code URLs
2818
    elsif ($uri->authority =~ /^code.google.com$/i) {
2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
        # Google Code URLs only have one form:
        #   http(s)://code.google.com/p/PROJECT_NAME/issues/detail?id=1234
        my $project_name;
        if ($uri->path =~ m|^/p/([^/]+)/issues/detail$|) {
            $project_name = $1;
        } else {
            ThrowUserError('bug_url_invalid', 
                           { url => $input });
        }
        my $bug_id = $uri->query_param('id');
        detaint_natural($bug_id);
        if (!$bug_id) {
            ThrowUserError('bug_url_invalid', 
                           { url => $input, reason => 'id' });
        }
        # While Google Code URLs can be either HTTP or HTTPS,
        # always go with the HTTP scheme, as that's the default.
        $result = "http://code.google.com/p/" . $project_name .
                  "/issues/detail?id=" . $bug_id;
    }
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
    # Debian BTS URLs
    elsif ($uri->authority =~ /^bugs.debian.org$/i) {
        # Debian BTS URLs can look like various things:
        #   http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1234
        #   http://bugs.debian.org/1234
        my $bug_id;
        if ($uri->path =~ m|^/(\d+)$|) {
            $bug_id = $1;
        }
        elsif ($uri->path =~ /bugreport\.cgi$/) {
            $bug_id = $uri->query_param('bug');
            detaint_natural($bug_id);
        }
        if (!$bug_id) {
            ThrowUserError('bug_url_invalid',
                           { url => $input, reason => 'id' });
        }
        # This is the shortest standard URL form for Debian BTS URLs,
        # and so we reduce all URLs to this.
        $result = "http://bugs.debian.org/" . $bug_id;
    }
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881
    # Bugzilla URLs
    else {
        if ($uri->path !~ /show_bug\.cgi$/) {
            ThrowUserError('bug_url_invalid', 
                           { url => $input, reason => 'show_bug' });
        }

        my $bug_id = $uri->query_param('id');
        # We don't currently allow aliases, because we can't check to see
        # if somebody's putting both an alias link and a numeric ID link.
        # When we start validating the URL by accessing the other Bugzilla,
        # we can allow aliases.
        detaint_natural($bug_id);
        if (!$bug_id) {
            ThrowUserError('bug_url_invalid', 
                           { url => $input, reason => 'id' });
        }

        # Make sure that "id" is the only query parameter.
        $uri->query("id=$bug_id");
        # And remove any # part if there is one.
        $uri->fragment(undef);
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
        my $uri_canonical = $uri->canonical;
        $result = $uri_canonical->as_string;

        # If this is a link to a local bug (treating the domain
        # case-insensitively and ignoring http(s)://), then also update
        # the other bug to point at this one.
        my $canonical_local = URI->new($local_bug_uri)->canonical;
        if (!$skip_recursion 
            and $canonical_local->authority eq $uri_canonical->authority
            and $canonical_local->path eq $uri_canonical->path) 
        {
2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905
            my $ref_bug = Bugzilla::Bug->check($bug_id);
            if ($ref_bug->id == $self->id) {
                ThrowUserError('see_also_self_reference');
            }
        
            my $product = $ref_bug->product_obj;
            if (!Bugzilla->user->can_edit_product($product->id)) {
                ThrowUserError("product_edit_denied",
                               { product => $product->name });
            }

            my $ref_input = $local_bug_uri . $self->id;
            if (!grep($ref_input, @{ $ref_bug->see_also })) {
2906
                $ref_bug->add_see_also($ref_input, 'skip recursion');
2907 2908 2909 2910
                push @{ $self->{see_also_update} }, $ref_bug;
            }
        }

2911
    }
2912 2913 2914 2915 2916 2917 2918 2919 2920

    if (length($result) > MAX_BUG_URL_LENGTH) {
        ThrowUserError('bug_url_too_long', { url => $result });
    }

    # We only add the new URI if it hasn't been added yet. URIs are
    # case-sensitive, but most of our DBs are case-insensitive, so we do
    # this check case-insensitively.
    if (!grep { lc($_) eq lc($result) } @{ $self->see_also }) {
2921 2922 2923 2924 2925 2926 2927 2928
        my $privs;
        my $can = $self->check_can_change_field('see_also', '', $result, \$privs);
        if (!$can) {
            ThrowUserError('illegal_change', { field    => 'see_also',
                                               newvalue => $result,
                                               privs    => $privs });
        }

2929 2930 2931 2932 2933 2934 2935
        push(@{ $self->see_also }, $result);
    }
}

sub remove_see_also {
    my ($self, $url) = @_;
    my $see_also = $self->see_also;
2936 2937 2938 2939 2940 2941 2942 2943 2944
    my @new_see_also = grep { lc($_) ne lc($url) } @$see_also;
    my $privs;
    my $can = $self->check_can_change_field('see_also', $see_also, \@new_see_also, \$privs);
    if (!$can) {
        ThrowUserError('illegal_change', { field    => 'see_also',
                                           oldvalue => $url,
                                           privs    => $privs });
        }
    $self->{see_also} = \@new_see_also;
2945 2946
}

2947
#####################################################################
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
# Simple Accessors
#####################################################################

# These are accessors that don't need to access the database.
# Keep them in alphabetical order.

sub alias               { return $_[0]->{alias}               }
sub bug_file_loc        { return $_[0]->{bug_file_loc}        }
sub bug_id              { return $_[0]->{bug_id}              }
sub bug_severity        { return $_[0]->{bug_severity}        }
sub bug_status          { return $_[0]->{bug_status}          }
sub cclist_accessible   { return $_[0]->{cclist_accessible}   }
sub component_id        { return $_[0]->{component_id}        }
sub creation_ts         { return $_[0]->{creation_ts}         }
sub estimated_time      { return $_[0]->{estimated_time}      }
sub deadline            { return $_[0]->{deadline}            }
sub delta_ts            { return $_[0]->{delta_ts}            }
sub error               { return $_[0]->{error}               }
sub everconfirmed       { return $_[0]->{everconfirmed}       }
sub lastdiffed          { return $_[0]->{lastdiffed}          }
sub op_sys              { return $_[0]->{op_sys}              }
sub priority            { return $_[0]->{priority}            }
sub product_id          { return $_[0]->{product_id}          }
sub remaining_time      { return $_[0]->{remaining_time}      }
sub reporter_accessible { return $_[0]->{reporter_accessible} }
sub rep_platform        { return $_[0]->{rep_platform}        }
sub resolution          { return $_[0]->{resolution}          }
sub short_desc          { return $_[0]->{short_desc}          }
sub status_whiteboard   { return $_[0]->{status_whiteboard}   }
sub target_milestone    { return $_[0]->{target_milestone}    }
sub version             { return $_[0]->{version}             }

#####################################################################
# Complex Accessors
2982 2983
#####################################################################

2984 2985 2986
# These are accessors that have to access the database for additional
# information about a bug.

2987 2988 2989 2990
# These subs are in alphabetical order, as much as possible.
# If you add a new sub, please try to keep it in alphabetical order
# with the other ones.

2991 2992 2993 2994 2995
# Note: If you add a new method, remember that you must check the error
# state of the bug before returning any data. If $self->{error} is
# defined, then return something empty. Otherwise you risk potential
# security holes.

2996 2997 2998 2999 3000
sub dup_id {
    my ($self) = @_;
    return $self->{'dup_id'} if exists $self->{'dup_id'};

    $self->{'dup_id'} = undef;
3001 3002
    return if $self->{'error'};

3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014
    if ($self->{'resolution'} eq 'DUPLICATE') { 
        my $dbh = Bugzilla->dbh;
        $self->{'dup_id'} =
          $dbh->selectrow_array(q{SELECT dupe_of 
                                  FROM duplicates
                                  WHERE dupe = ?},
                                undef,
                                $self->{'bug_id'});
    }
    return $self->{'dup_id'};
}

3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046
sub _resolve_ultimate_dup_id {
    my ($bug_id, $dupe_of, $loops_are_an_error) = @_;
    my $dbh = Bugzilla->dbh;
    my $sth = $dbh->prepare('SELECT dupe_of FROM duplicates WHERE dupe = ?');

    my $this_dup = $dupe_of || $dbh->selectrow_array($sth, undef, $bug_id);
    my $last_dup = $bug_id;

    my %dupes;
    while ($this_dup) {
        if ($this_dup == $bug_id) {
            if ($loops_are_an_error) {
                ThrowUserError('dupe_loop_detected', { bug_id  => $bug_id,
                                                       dupe_of => $dupe_of });
            }
            else {
                return $last_dup;
            }
        }
        # If $dupes{$this_dup} is already set to 1, then a loop
        # already exists which does not involve this bug.
        # As the user is not responsible for this loop, do not
        # prevent him from marking this bug as a duplicate.
        return $last_dup if exists $dupes{$this_dup};
        $dupes{$this_dup} = 1;
        $last_dup = $this_dup;
        $this_dup = $dbh->selectrow_array($sth, undef, $this_dup);
    }

    return $last_dup;
}

3047 3048 3049 3050
sub actual_time {
    my ($self) = @_;
    return $self->{'actual_time'} if exists $self->{'actual_time'};

3051
    if ( $self->{'error'} || !Bugzilla->user->is_timetracker ) {
3052 3053 3054
        $self->{'actual_time'} = undef;
        return $self->{'actual_time'};
    }
3055

3056 3057 3058 3059 3060
    my $sth = Bugzilla->dbh->prepare("SELECT SUM(work_time)
                                      FROM longdescs 
                                      WHERE longdescs.bug_id=?");
    $sth->execute($self->{bug_id});
    $self->{'actual_time'} = $sth->fetchrow_array();
3061 3062 3063
    return $self->{'actual_time'};
}

3064
sub any_flags_requesteeble {
3065 3066 3067
    my ($self) = @_;
    return $self->{'any_flags_requesteeble'} 
        if exists $self->{'any_flags_requesteeble'};
3068
    return 0 if $self->{'error'};
3069

3070 3071 3072 3073 3074 3075
    my $any_flags_requesteeble =
      grep { $_->is_requestable && $_->is_requesteeble } @{$self->flag_types};
    # Useful in case a flagtype is no longer requestable but a requestee
    # has been set before we turned off that bit.
    $any_flags_requesteeble ||= grep { $_->requestee_id } @{$self->flags};
    $self->{'any_flags_requesteeble'} = $any_flags_requesteeble;
3076 3077 3078 3079

    return $self->{'any_flags_requesteeble'};
}

3080
sub attachments {
3081 3082
    my ($self) = @_;
    return $self->{'attachments'} if exists $self->{'attachments'};
3083
    return [] if $self->{'error'};
3084 3085

    $self->{'attachments'} =
3086
        Bugzilla::Attachment->get_attachments_by_bug($self->bug_id, {preload => 1});
3087 3088 3089
    return $self->{'attachments'};
}

3090
sub assigned_to {
3091
    my ($self) = @_;
3092 3093 3094 3095
    return $self->{'assigned_to_obj'} if exists $self->{'assigned_to_obj'};
    $self->{'assigned_to'} = 0 if $self->{'error'};
    $self->{'assigned_to_obj'} ||= new Bugzilla::User($self->{'assigned_to'});
    return $self->{'assigned_to_obj'};
3096 3097
}

3098
sub blocked {
3099 3100
    my ($self) = @_;
    return $self->{'blocked'} if exists $self->{'blocked'};
3101
    return [] if $self->{'error'};
3102 3103 3104 3105
    $self->{'blocked'} = EmitDependList("dependson", "blocked", $self->bug_id);
    return $self->{'blocked'};
}

3106 3107 3108 3109 3110
sub bug_group {
    my ($self) = @_;
    return join(', ', (map { $_->name } @{$self->groups_in}));
}

3111 3112 3113 3114 3115 3116 3117 3118 3119
sub related_bugs {
    my ($self, $relationship) = @_;
    return [] if $self->{'error'};

    my $field_name = $relationship->name;
    $self->{'related_bugs'}->{$field_name} ||= $self->match({$field_name => $self->id});
    return $self->{'related_bugs'}->{$field_name}; 
}

3120
sub cc {
3121 3122
    my ($self) = @_;
    return $self->{'cc'} if exists $self->{'cc'};
3123
    return [] if $self->{'error'};
3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137

    my $dbh = Bugzilla->dbh;
    $self->{'cc'} = $dbh->selectcol_arrayref(
        q{SELECT profiles.login_name FROM cc, profiles
           WHERE bug_id = ?
             AND cc.who = profiles.userid
        ORDER BY profiles.login_name},
      undef, $self->bug_id);

    $self->{'cc'} = undef if !scalar(@{$self->{'cc'}});

    return $self->{'cc'};
}

3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
# XXX Eventually this will become the standard "cc" method used everywhere.
sub cc_users {
    my $self = shift;
    return $self->{'cc_users'} if exists $self->{'cc_users'};
    return [] if $self->{'error'};
    
    my $dbh = Bugzilla->dbh;
    my $cc_ids = $dbh->selectcol_arrayref(
        'SELECT who FROM cc WHERE bug_id = ?', undef, $self->id);
    $self->{'cc_users'} = Bugzilla::User->new_from_list($cc_ids);
    return $self->{'cc_users'};
}

3151 3152 3153 3154 3155 3156 3157 3158 3159 3160
sub component {
    my ($self) = @_;
    return $self->{component} if exists $self->{component};
    return '' if $self->{error};
    ($self->{component}) = Bugzilla->dbh->selectrow_array(
        'SELECT name FROM components WHERE id = ?',
        undef, $self->{component_id});
    return $self->{component};
}

3161 3162 3163 3164 3165 3166 3167 3168 3169
# XXX Eventually this will replace component()
sub component_obj {
    my ($self) = @_;
    return $self->{component_obj} if defined $self->{component_obj};
    return {} if $self->{error};
    $self->{component_obj} = new Bugzilla::Component($self->{component_id});
    return $self->{component_obj};
}

3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
sub classification_id {
    my ($self) = @_;
    return $self->{classification_id} if exists $self->{classification_id};
    return 0 if $self->{error};
    ($self->{classification_id}) = Bugzilla->dbh->selectrow_array(
        'SELECT classification_id FROM products WHERE id = ?',
        undef, $self->{product_id});
    return $self->{classification_id};
}

sub classification {
    my ($self) = @_;
    return $self->{classification} if exists $self->{classification};
    return '' if $self->{error};
    ($self->{classification}) = Bugzilla->dbh->selectrow_array(
        'SELECT name FROM classifications WHERE id = ?',
        undef, $self->classification_id);
    return $self->{classification};
}

3190
sub dependson {
3191 3192
    my ($self) = @_;
    return $self->{'dependson'} if exists $self->{'dependson'};
3193
    return [] if $self->{'error'};
3194 3195 3196 3197 3198
    $self->{'dependson'} = 
        EmitDependList("blocked", "dependson", $self->bug_id);
    return $self->{'dependson'};
}

3199
sub flag_types {
3200 3201
    my ($self) = @_;
    return $self->{'flag_types'} if exists $self->{'flag_types'};
3202
    return [] if $self->{'error'};
3203

3204 3205 3206 3207
    my $vars = { target_type  => 'bug',
                 product_id   => $self->{product_id},
                 component_id => $self->{component_id},
                 bug_id       => $self->bug_id };
3208

3209
    $self->{'flag_types'} = Bugzilla::Flag->_flag_types($vars);
3210 3211 3212
    return $self->{'flag_types'};
}

3213 3214 3215 3216 3217 3218 3219 3220
sub flags {
    my $self = shift;

    # Don't cache it as it must be in sync with ->flag_types.
    $self->{flags} = [map { @{$_->{flags}} } @{$self->flag_types}];
    return $self->{flags};
}

3221 3222 3223 3224 3225
sub isopened {
    my $self = shift;
    return is_open_state($self->{bug_status}) ? 1 : 0;
}

3226
sub keywords {
3227
    my ($self) = @_;
3228 3229
    return join(', ', (map { $_->name } @{$self->keyword_objects}));
}
3230

3231 3232 3233 3234 3235
# XXX At some point, this should probably replace the normal "keywords" sub.
sub keyword_objects {
    my $self = shift;
    return $self->{'keyword_objects'} if defined $self->{'keyword_objects'};
    return [] if $self->{'error'};
3236

3237 3238 3239 3240 3241
    my $dbh = Bugzilla->dbh;
    my $ids = $dbh->selectcol_arrayref(
         "SELECT keywordid FROM keywords WHERE bug_id = ?", undef, $self->id);
    $self->{'keyword_objects'} = Bugzilla::Keyword->new_from_list($ids);
    return $self->{'keyword_objects'};
3242 3243
}

3244 3245
sub comments {
    my ($self, $params) = @_;
3246
    return [] if $self->{'error'};
3247 3248 3249 3250 3251 3252 3253
    $params ||= {};

    if (!defined $self->{'comments'}) {
        $self->{'comments'} = Bugzilla::Comment->match({ bug_id => $self->id });
        my $count = 0;
        foreach my $comment (@{ $self->{'comments'} }) {
            $comment->{count} = $count++;
3254
            $comment->{bug} = $self;
3255
        }
3256
        Bugzilla::Comment->preload($self->{'comments'});
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277
    }
    my @comments = @{ $self->{'comments'} };

    my $order = $params->{order} 
        || Bugzilla->user->settings->{'comment_sort_order'}->{'value'};
    if ($order ne 'oldest_to_newest') {
        @comments = reverse @comments;
        if ($order eq 'newest_to_oldest_desc_first') {
            unshift(@comments, pop @comments);
        }
    }

    if ($params->{after}) {
        my $from = datetime_from($params->{after});
        @comments = grep { datetime_from($_->creation_ts) > $from } @comments;
    }
    if ($params->{to}) {
        my $to = datetime_from($params->{to});
        @comments = grep { datetime_from($_->creation_ts) <= $to } @comments;
    }
    return \@comments;
3278 3279
}

3280 3281 3282 3283 3284 3285 3286 3287
# This is needed by xt/search.t.
sub percentage_complete {
    my $self = shift;
    return undef if $self->{'error'} || !Bugzilla->user->is_timetracker;
    my $remaining = $self->remaining_time;
    my $actual    = $self->actual_time;
    my $total = $remaining + $actual;
    return undef if $total == 0;
3288 3289 3290 3291
    # Search.pm truncates this value to an integer, so we want to as well,
    # since this is mostly used in a test where its value needs to be
    # identical to what the database will return.
    return int(100 * ($actual / $total));
3292 3293
}

3294 3295 3296 3297 3298 3299 3300 3301 3302 3303
sub product {
    my ($self) = @_;
    return $self->{product} if exists $self->{product};
    return '' if $self->{error};
    ($self->{product}) = Bugzilla->dbh->selectrow_array(
        'SELECT name FROM products WHERE id = ?',
        undef, $self->{product_id});
    return $self->{product};
}

3304 3305 3306 3307
# XXX This should eventually replace the "product" subroutine.
sub product_obj {
    my $self = shift;
    return {} if $self->{error};
3308 3309
    $self->{product_obj} ||= new Bugzilla::Product($self->{product_id});
    return $self->{product_obj};
3310 3311
}

3312
sub qa_contact {
3313
    my ($self) = @_;
3314
    return $self->{'qa_contact_obj'} if exists $self->{'qa_contact_obj'};
3315
    return undef if $self->{'error'};
3316

3317 3318
    if (Bugzilla->params->{'useqacontact'} && $self->{'qa_contact'}) {
        $self->{'qa_contact_obj'} = new Bugzilla::User($self->{'qa_contact'});
3319 3320 3321 3322
    } else {
        # XXX - This is somewhat inconsistent with the assignee/reporter 
        # methods, which will return an empty User if they get a 0. 
        # However, we're keeping it this way now, for backwards-compatibility.
3323
        $self->{'qa_contact_obj'} = undef;
3324
    }
3325
    return $self->{'qa_contact_obj'};
3326 3327
}

3328
sub reporter {
3329 3330
    my ($self) = @_;
    return $self->{'reporter'} if exists $self->{'reporter'};
3331
    $self->{'reporter_id'} = 0 if $self->{'error'};
3332 3333 3334 3335
    $self->{'reporter'} = new Bugzilla::User($self->{'reporter_id'});
    return $self->{'reporter'};
}

3336 3337 3338 3339 3340 3341 3342 3343
sub see_also {
    my ($self) = @_;
    return [] if $self->{'error'};
    $self->{'see_also'} ||= Bugzilla->dbh->selectcol_arrayref(
        'SELECT value FROM bug_see_also WHERE bug_id = ?', undef, $self->id);
    return $self->{'see_also'};
}

3344 3345 3346 3347 3348 3349 3350
sub status {
    my $self = shift;
    return undef if $self->{'error'};

    $self->{'status'} ||= new Bugzilla::Status({name => $self->{'bug_status'}});
    return $self->{'status'};
}
3351

3352 3353 3354 3355 3356 3357 3358 3359 3360
sub statuses_available {
    my $self = shift;
    return [] if $self->{'error'};
    return $self->{'statuses_available'}
        if defined $self->{'statuses_available'};

    my @statuses = @{ $self->status->can_change_to };

    # UNCONFIRMED is only a valid status if it is enabled in this product.
3361
    if (!$self->product_obj->allows_unconfirmed) {
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372
        @statuses = grep { $_->name ne 'UNCONFIRMED' } @statuses;
    }

    my @available;
    foreach my $status (@statuses) {
        # Make sure this is a legal status transition
        next if !$self->check_can_change_field(
                     'bug_status', $self->status->name, $status->name);
        push(@available, $status);
    }

3373 3374 3375 3376 3377
    # If this bug has an inactive status set, it should still be in the list.
    if (!grep($_->name eq $self->status->name, @available)) {
        unshift(@available, $self->status);
    }

3378 3379 3380 3381
    $self->{'statuses_available'} = \@available;
    return $self->{'statuses_available'};
}

3382
sub show_attachment_flags {
3383 3384 3385
    my ($self) = @_;
    return $self->{'show_attachment_flags'} 
        if exists $self->{'show_attachment_flags'};
3386
    return 0 if $self->{'error'};
3387 3388 3389 3390 3391 3392 3393 3394 3395

    # The number of types of flags that can be set on attachments to this bug
    # and the number of flags on those attachments.  One of these counts must be
    # greater than zero in order for the "flags" column to appear in the table
    # of attachments.
    my $num_attachment_flag_types = Bugzilla::FlagType::count(
        { 'target_type'  => 'attachment',
          'product_id'   => $self->{'product_id'},
          'component_id' => $self->{'component_id'} });
3396
    my $num_attachment_flags = Bugzilla::Flag->count(
3397
        { 'target_type'  => 'attachment',
3398
          'bug_id'       => $self->bug_id });
3399 3400 3401 3402 3403 3404 3405

    $self->{'show_attachment_flags'} =
        ($num_attachment_flag_types || $num_attachment_flags);

    return $self->{'show_attachment_flags'};
}

3406 3407 3408
sub groups {
    my $self = shift;
    return $self->{'groups'} if exists $self->{'groups'};
3409
    return [] if $self->{'error'};
3410

3411
    my $dbh = Bugzilla->dbh;
3412 3413 3414 3415 3416 3417 3418 3419 3420
    my @groups;

    # Some of this stuff needs to go into Bugzilla::User

    # For every group, we need to know if there is ANY bug_group_map
    # record putting the current bug in that group and if there is ANY
    # user_group_map record putting the user in that group.
    # The LEFT JOINs are checking for record existence.
    #
3421
    my $grouplist = Bugzilla->user->groups_as_string;
3422 3423
    my $sth = $dbh->prepare(
             "SELECT DISTINCT groups.id, name, description," .
3424 3425
             " CASE WHEN bug_group_map.group_id IS NOT NULL" .
             " THEN 1 ELSE 0 END," .
3426
             " CASE WHEN groups.id IN($grouplist) THEN 1 ELSE 0 END," .
3427 3428 3429 3430
             " isactive, membercontrol, othercontrol" .
             " FROM groups" . 
             " LEFT JOIN bug_group_map" .
             " ON bug_group_map.group_id = groups.id" .
3431
             " AND bug_id = ?" .
3432 3433
             " LEFT JOIN group_control_map" .
             " ON group_control_map.group_id = groups.id" .
3434
             " AND group_control_map.product_id = ? " .
3435 3436
             " WHERE isbuggroup = 1" .
             " ORDER BY description");
3437
    $sth->execute($self->{'bug_id'},
3438
                  $self->{'product_id'});
3439

3440 3441
    while (my ($groupid, $name, $description, $ison, $ingroup, $isactive,
            $membercontrol, $othercontrol) = $sth->fetchrow_array()) {
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458

        $membercontrol ||= 0;

        # For product groups, we only want to use the group if either
        # (1) The bit is set and not required, or
        # (2) The group is Shown or Default for members and
        #     the user is a member of the group.
        if ($ison ||
            ($isactive && $ingroup
                       && (($membercontrol == CONTROLMAPDEFAULT)
                           || ($membercontrol == CONTROLMAPSHOWN))
            ))
        {
            my $ismandatory = $isactive
              && ($membercontrol == CONTROLMAPMANDATORY);

            push (@groups, { "bit" => $groupid,
3459
                             "name" => $name,
3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
                             "ison" => $ison,
                             "ingroup" => $ingroup,
                             "mandatory" => $ismandatory,
                             "description" => $description });
        }
    }

    $self->{'groups'} = \@groups;

    return $self->{'groups'};
}

3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482
sub groups_in {
    my $self = shift;
    return $self->{'groups_in'} if exists $self->{'groups_in'};
    return [] if $self->{'error'};
    my $group_ids = Bugzilla->dbh->selectcol_arrayref(
        'SELECT group_id FROM bug_group_map WHERE bug_id = ?',
        undef, $self->id);
    $self->{'groups_in'} = Bugzilla::Group->new_from_list($group_ids);
    return $self->{'groups_in'};
}

3483 3484 3485
sub user {
    my $self = shift;
    return $self->{'user'} if exists $self->{'user'};
3486
    return {} if $self->{'error'};
3487

3488
    my $user = Bugzilla->user;
3489

3490 3491 3492
    my $prod_id = $self->{'product_id'};

    my $unknown_privileges = $user->in_group('editbugs', $prod_id);
3493
    my $canedit = $unknown_privileges
3494
                  || $user->id == $self->{'assigned_to'}
3495
                  || (Bugzilla->params->{'useqacontact'}
3496 3497
                      && $self->{'qa_contact'}
                      && $user->id == $self->{'qa_contact'});
3498
    my $canconfirm = $unknown_privileges
3499
                     || $user->in_group('canconfirm', $prod_id);
3500 3501
    my $isreporter = $user->id
                     && $user->id == $self->{reporter_id};
3502

3503
    $self->{'user'} = {canconfirm => $canconfirm,
3504 3505
                       canedit    => $canedit,
                       isreporter => $isreporter};
3506 3507 3508
    return $self->{'user'};
}

3509 3510
# This is intended to get values that can be selected by the user in the
# UI. It should not be used for security or validation purposes.
3511 3512 3513
sub choices {
    my $self = shift;
    return $self->{'choices'} if exists $self->{'choices'};
3514
    return {} if $self->{'error'};
3515
    my $user = Bugzilla->user;
3516

3517
    my @products = @{ $user->get_enterable_products };
3518 3519
    # The current product is part of the popup, even if new bugs are no longer
    # allowed for that product
3520 3521 3522
    if (!grep($_->name eq $self->product_obj->name, @products)) {
        unshift(@products, $self->product_obj);
    }
3523 3524 3525
    my %class_ids = map { $_->classification_id => 1 } @products;
    my $classifications = 
        Bugzilla::Classification->new_from_list([keys %class_ids]);
3526 3527

    my %choices = (
3528
        bug_status => $self->statuses_available,
3529
        classification => $classifications,
3530 3531 3532
        product    => \@products,
        component  => $self->product_obj->components,
        version    => $self->product_obj->versions,
3533 3534 3535 3536 3537 3538 3539
        target_milestone => $self->product_obj->milestones,
    );

    my $resolution_field = new Bugzilla::Field({ name => 'resolution' });
    # Don't include the empty resolution in drop-downs.
    my @resolutions = grep($_->name, @{ $resolution_field->legal_values });
    $choices{'resolution'} = \@resolutions;
3540

3541
    $self->{'choices'} = \%choices;
3542 3543
    return $self->{'choices'};
}
3544

3545 3546 3547 3548 3549
# Convenience Function. If you need speed, use this. If you need
# other Bug fields in addition to this, just create a new Bug with
# the alias.
# Queries the database for the bug with a given alias, and returns
# the ID of the bug if it exists or the undefined value if it doesn't.
3550
sub bug_alias_to_id {
3551
    my ($alias) = @_;
3552
    return undef unless Bugzilla->params->{"usebugaliases"};
3553 3554 3555 3556 3557 3558
    my $dbh = Bugzilla->dbh;
    trick_taint($alias);
    return $dbh->selectrow_array(
        "SELECT bug_id FROM bugs WHERE alias = ?", undef, $alias);
}

3559 3560 3561 3562
#####################################################################
# Subroutines
#####################################################################

3563 3564 3565
# Represents which fields from the bugs table are handled by process_bug.cgi.
sub editable_bug_fields {
    my @fields = Bugzilla->dbh->bz_table_columns('bugs');
3566
    # Obsolete custom fields are not editable.
3567
    my @obsolete_fields = @{ Bugzilla->fields({obsolete => 1, custom => 1}) };
3568
    @obsolete_fields = map { $_->name } @obsolete_fields;
3569 3570 3571 3572
    foreach my $remove ("bug_id", "reporter", "creation_ts", "delta_ts", 
                        "lastdiffed", @obsolete_fields) 
    {
        my $location = firstidx { $_ eq $remove } @fields;
3573 3574
        # Custom multi-select fields are not stored in the bugs table.
        splice(@fields, $location, 1) if ($location > -1);
3575 3576 3577 3578 3579 3580
    }
    # Sorted because the old @::log_columns variable, which this replaces,
    # was sorted.
    return sort(@fields);
}

3581 3582
# XXX - When Bug::update() will be implemented, we should make this routine
#       a private method.
3583 3584
# Join with bug_status and bugs tables to show bugs with open statuses first,
# and then the others
3585
sub EmitDependList {
3586 3587
    my ($myfield, $targetfield, $bug_id) = (@_);
    my $dbh = Bugzilla->dbh;
3588
    my $list_ref = $dbh->selectcol_arrayref(
3589 3590 3591 3592 3593 3594
          "SELECT $targetfield
             FROM dependencies
                  INNER JOIN bugs ON dependencies.$targetfield = bugs.bug_id
                  INNER JOIN bug_status ON bugs.bug_status = bug_status.value
            WHERE $myfield = ?
            ORDER BY is_open DESC, $targetfield",
3595
            undef, $bug_id);
3596
    return $list_ref;
3597 3598
}

3599
# Get the activity of a bug, starting from $starttime (if given).
3600
# This routine assumes Bugzilla::Bug->check has been previously called.
3601
sub GetBugActivity {
3602
    my ($bug_id, $attach_id, $starttime) = @_;
3603 3604 3605
    my $dbh = Bugzilla->dbh;

    # Arguments passed to the SQL query.
3606
    my @args = ($bug_id);
3607 3608 3609 3610 3611 3612 3613 3614 3615

    # Only consider changes since $starttime, if given.
    my $datepart = "";
    if (defined $starttime) {
        trick_taint($starttime);
        push (@args, $starttime);
        $datepart = "AND bugs_activity.bug_when > ?";
    }

3616 3617 3618 3619 3620 3621
    my $attachpart = "";
    if ($attach_id) {
        push(@args, $attach_id);
        $attachpart = "AND bugs_activity.attach_id = ?";
    }

3622 3623 3624
    # Only includes attachments the user is allowed to see.
    my $suppjoins = "";
    my $suppwhere = "";
3625
    if (!Bugzilla->user->is_insider) 
3626
    {
3627 3628 3629 3630 3631
        $suppjoins = "LEFT JOIN attachments 
                   ON attachments.attach_id = bugs_activity.attach_id";
        $suppwhere = "AND COALESCE(attachments.isprivate, 0) = 0";
    }

3632
    my $query = "SELECT fielddefs.name, bugs_activity.attach_id, " .
3633
        $dbh->sql_date_format('bugs_activity.bug_when', '%Y.%m.%d %H:%i:%s') .
3634 3635
            ", bugs_activity.removed, bugs_activity.added, profiles.login_name, 
               bugs_activity.comment_id
3636 3637 3638
          FROM bugs_activity
               $suppjoins
     LEFT JOIN fielddefs
3639
            ON bugs_activity.fieldid = fielddefs.id
3640 3641 3642 3643
    INNER JOIN profiles
            ON profiles.userid = bugs_activity.who
         WHERE bugs_activity.bug_id = ?
               $datepart
3644
               $attachpart
3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655
               $suppwhere
      ORDER BY bugs_activity.bug_when";

    my $list = $dbh->selectall_arrayref($query, undef, @args);

    my @operations;
    my $operation = {};
    my $changes = [];
    my $incomplete_data = 0;

    foreach my $entry (@$list) {
3656
        my ($fieldname, $attachid, $when, $removed, $added, $who, $comment_id) = @$entry;
3657 3658 3659 3660 3661 3662 3663 3664 3665
        my %change;
        my $activity_visible = 1;

        # check if the user should see this field's activity
        if ($fieldname eq 'remaining_time'
            || $fieldname eq 'estimated_time'
            || $fieldname eq 'work_time'
            || $fieldname eq 'deadline')
        {
3666
            $activity_visible = Bugzilla->user->is_timetracker;
3667 3668 3669 3670 3671 3672 3673 3674
        }
        elsif ($fieldname eq 'longdescs.isprivate'
                && !Bugzilla->user->is_insider 
                && $added) 
        { 
            $activity_visible = 0;
        } 
        else {
3675 3676 3677 3678 3679
            $activity_visible = 1;
        }

        if ($activity_visible) {
            # Check for the results of an old Bugzilla data corruption bug
3680 3681 3682 3683
            if (($added eq '?' && $removed eq '?')
                || ($added =~ /^\? / || $removed =~ /^\? /)) {
                $incomplete_data = 1;
            }
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707

            # An operation, done by 'who' at time 'when', has a number of
            # 'changes' associated with it.
            # If this is the start of a new operation, store the data from the
            # previous one, and set up the new one.
            if ($operation->{'who'}
                && ($who ne $operation->{'who'}
                    || $when ne $operation->{'when'}))
            {
                $operation->{'changes'} = $changes;
                push (@operations, $operation);

                # Create new empty anonymous data structures.
                $operation = {};
                $changes = [];
            }

            $operation->{'who'} = $who;
            $operation->{'when'} = $when;

            $change{'fieldname'} = $fieldname;
            $change{'attachid'} = $attachid;
            $change{'removed'} = $removed;
            $change{'added'} = $added;
3708 3709 3710 3711 3712
            
            if ($comment_id) {
                $change{'comment'} = Bugzilla::Comment->new($comment_id);
            }

3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724
            push (@$changes, \%change);
        }
    }

    if ($operation->{'who'}) {
        $operation->{'changes'} = $changes;
        push (@operations, $operation);
    }

    return(\@operations, $incomplete_data);
}

3725 3726
# Update the bugs_activity table to reflect changes made in bugs.
sub LogActivityEntry {
3727
    my ($i, $col, $removed, $added, $whoid, $timestamp, $comment_id) = @_;
3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752
    my $dbh = Bugzilla->dbh;
    # in the case of CCs, deps, and keywords, there's a possibility that someone
    # might try to add or remove a lot of them at once, which might take more
    # space than the activity table allows.  We'll solve this by splitting it
    # into multiple entries if it's too long.
    while ($removed || $added) {
        my ($removestr, $addstr) = ($removed, $added);
        if (length($removestr) > MAX_LINE_LENGTH) {
            my $commaposition = find_wrap_point($removed, MAX_LINE_LENGTH);
            $removestr = substr($removed, 0, $commaposition);
            $removed = substr($removed, $commaposition);
            $removed =~ s/^[,\s]+//; # remove any comma or space
        } else {
            $removed = ""; # no more entries
        }
        if (length($addstr) > MAX_LINE_LENGTH) {
            my $commaposition = find_wrap_point($added, MAX_LINE_LENGTH);
            $addstr = substr($added, 0, $commaposition);
            $added = substr($added, $commaposition);
            $added =~ s/^[,\s]+//; # remove any comma or space
        } else {
            $added = ""; # no more entries
        }
        trick_taint($addstr);
        trick_taint($removestr);
3753
        my $fieldid = get_field_id($col);
3754
        $dbh->do("INSERT INTO bugs_activity
3755 3756 3757
                  (bug_id, who, bug_when, fieldid, removed, added, comment_id)
                  VALUES (?, ?, ?, ?, ?, ?, ?)",
                  undef, ($i, $whoid, $timestamp, $fieldid, $removestr, $addstr, $comment_id));
3758 3759 3760
    }
}

3761 3762 3763
# Convert WebService API and email_in.pl field names to internal DB field
# names.
sub map_fields {
3764
    my ($params, $except) = @_; 
3765 3766 3767

    my %field_values;
    foreach my $field (keys %$params) {
3768 3769 3770 3771 3772 3773 3774
        my $field_name;
        if ($except->{$field}) {
           $field_name = $field;
        }
        else {
            $field_name = FIELD_MAP->{$field} || $field;
        }
3775 3776 3777 3778 3779
        $field_values{$field_name} = $params->{$field};
    }
    return \%field_values;
}

3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797
################################################################################
# check_can_change_field() defines what users are allowed to change. You
# can add code here for site-specific policy changes, according to the
# instructions given in the Bugzilla Guide and below. Note that you may also
# have to update the Bugzilla::Bug::user() function to give people access to the
# options that they are permitted to change.
#
# check_can_change_field() returns true if the user is allowed to change this
# field, and false if they are not.
#
# The parameters to this method are as follows:
# $field    - name of the field in the bugs table the user is trying to change
# $oldvalue - what they are changing it from
# $newvalue - what they are changing it to
# $PrivilegesRequired - return the reason of the failure, if any
################################################################################
sub check_can_change_field {
    my $self = shift;
3798
    my ($field, $oldvalue, $newvalue, $PrivilegesRequired) = (@_);
3799
    my $user = Bugzilla->user;
3800 3801 3802 3803 3804 3805 3806

    $oldvalue = defined($oldvalue) ? $oldvalue : '';
    $newvalue = defined($newvalue) ? $newvalue : '';

    # Return true if they haven't changed this field at all.
    if ($oldvalue eq $newvalue) {
        return 1;
3807 3808 3809
    } elsif (ref($newvalue) eq 'ARRAY' && ref($oldvalue) eq 'ARRAY') {
        my ($removed, $added) = diff_arrays($oldvalue, $newvalue);
        return 1 if !scalar(@$removed) && !scalar(@$added);
3810 3811 3812 3813 3814 3815 3816 3817 3818
    } elsif (trim($oldvalue) eq trim($newvalue)) {
        return 1;
    # numeric fields need to be compared using ==
    } elsif (($field eq 'estimated_time' || $field eq 'remaining_time')
             && $oldvalue == $newvalue)
    {
        return 1;
    }

3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832
    my @priv_results;
    Bugzilla::Hook::process('bug_check_can_change_field',
        { bug => $self, field => $field, 
          new_value => $newvalue, old_value => $oldvalue, 
          priv_results => \@priv_results });
    if (my $priv_required = first { $_ > 0 } @priv_results) {
        $$PrivilegesRequired = $priv_required;
        return 0;
    }
    my $allow_found = first { $_ == 0 } @priv_results;
    if (defined $allow_found) {
        return 1;
    }

3833 3834 3835 3836 3837 3838 3839 3840 3841
    # Allow anyone to change comments.
    if ($field =~ /^longdesc/) {
        return 1;
    }

    # If the user isn't allowed to change a field, we must tell him who can.
    # We store the required permission set into the $PrivilegesRequired
    # variable which gets passed to the error template.
    #
3842 3843 3844 3845
    # $PrivilegesRequired = PRIVILEGES_REQUIRED_NONE : no privileges required;
    # $PrivilegesRequired = PRIVILEGES_REQUIRED_REPORTER : the reporter, assignee or an empowered user;
    # $PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE : the assignee or an empowered user;
    # $PrivilegesRequired = PRIVILEGES_REQUIRED_EMPOWERED : an empowered user.
3846 3847 3848
    
    # Only users in the time-tracking group can change time-tracking fields.
    if ( grep($_ eq $field, qw(deadline estimated_time remaining_time)) ) {
3849
        if (!$user->is_timetracker) {
3850
            $$PrivilegesRequired = PRIVILEGES_REQUIRED_EMPOWERED;
3851 3852 3853
            return 0;
        }
    }
3854

3855 3856
    # Allow anyone with (product-specific) "editbugs" privs to change anything.
    if ($user->in_group('editbugs', $self->{'product_id'})) {
3857 3858 3859
        return 1;
    }

3860
    # *Only* users with (product-specific) "canconfirm" privs can confirm bugs.
3861
    if ($self->_changes_everconfirmed($field, $oldvalue, $newvalue)) {
3862
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_EMPOWERED;
3863
        return $user->in_group('canconfirm', $self->{'product_id'});
3864 3865 3866 3867 3868
    }

    # Make sure that a valid bug ID has been given.
    if (!$self->{'error'}) {
        # Allow the assignee to change anything else.
3869 3870 3871
        if ($self->{'assigned_to'} == $user->id
            || $self->{'_old_assigned_to'} && $self->{'_old_assigned_to'} == $user->id)
        {
3872 3873 3874 3875 3876
            return 1;
        }

        # Allow the QA contact to change anything else.
        if (Bugzilla->params->{'useqacontact'}
3877 3878
            && (($self->{'qa_contact'} && $self->{'qa_contact'} == $user->id)
                || ($self->{'_old_qa_contact'} && $self->{'_old_qa_contact'} == $user->id)))
3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
        {
            return 1;
        }
    }

    # At this point, the user is either the reporter or an
    # unprivileged user. We first check for fields the reporter
    # is not allowed to change.

    # The reporter may not:
    # - reassign bugs, unless the bugs are assigned to him;
    #   in that case we will have already returned 1 above
    #   when checking for the assignee of the bug.
    if ($field eq 'assigned_to') {
3893
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3894 3895 3896 3897
        return 0;
    }
    # - change the QA contact
    if ($field eq 'qa_contact') {
3898
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3899 3900 3901 3902
        return 0;
    }
    # - change the target milestone
    if ($field eq 'target_milestone') {
3903
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3904 3905 3906 3907
        return 0;
    }
    # - change the priority (unless he could have set it originally)
    if ($field eq 'priority'
3908
        && !Bugzilla->params->{'letsubmitterchoosepriority'})
3909
    {
3910
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3911 3912
        return 0;
    }
3913 3914
    # - unconfirm bugs (confirming them is handled above)
    if ($field eq 'everconfirmed') {
3915
        $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3916 3917 3918 3919 3920 3921
        return 0;
    }
    # - change the status from one open state to another
    if ($field eq 'bug_status'
        && is_open_state($oldvalue) && is_open_state($newvalue)) 
    {
3922
       $$PrivilegesRequired = PRIVILEGES_REQUIRED_ASSIGNEE;
3923 3924
       return 0;
    }
3925 3926 3927 3928 3929 3930 3931 3932

    # The reporter is allowed to change anything else.
    if (!$self->{'error'} && $self->{'reporter_id'} == $user->id) {
        return 1;
    }

    # If we haven't returned by this point, then the user doesn't
    # have the necessary permissions to change this field.
3933
    $$PrivilegesRequired = PRIVILEGES_REQUIRED_REPORTER;
3934 3935 3936
    return 0;
}

3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954
# A helper for check_can_change_field
sub _changes_everconfirmed {
    my ($self, $field, $old, $new) = @_;
    return 1 if $field eq 'everconfirmed';
    if ($field eq 'bug_status') {
        if ($self->everconfirmed) {
            # Moving a confirmed bug to UNCONFIRMED will change everconfirmed.
            return 1 if $new eq 'UNCONFIRMED';
        }
        else {
            # Moving an unconfirmed bug to an open state that isn't 
            # UNCONFIRMED will confirm the bug.
            return 1 if (is_open_state($new) and $new ne 'UNCONFIRMED');
        }
    }
    return 0;
}

3955 3956 3957 3958
#
# Field Validation
#

3959
# Validate and return a hash of dependencies
3960
sub ValidateDependencies {
3961
    my $fields = {};
3962
    # These can be arrayrefs or they can be strings.
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982
    $fields->{'dependson'} = shift;
    $fields->{'blocked'} = shift;
    my $id = shift || 0;

    unless (defined($fields->{'dependson'})
            || defined($fields->{'blocked'}))
    {
        return;
    }

    my $dbh = Bugzilla->dbh;
    my %deps;
    my %deptree;
    foreach my $pair (["blocked", "dependson"], ["dependson", "blocked"]) {
        my ($me, $target) = @{$pair};
        $deptree{$target} = [];
        $deps{$target} = [];
        next unless $fields->{$target};

        my %seen;
3983 3984 3985
        my $target_array = ref($fields->{$target}) ? $fields->{$target}
                           : [split(/[\s,]+/, $fields->{$target})];
        foreach my $i (@$target_array) {
3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020
            if ($id == $i) {
                ThrowUserError("dependency_loop_single");
            }
            if (!exists $seen{$i}) {
                push(@{$deptree{$target}}, $i);
                $seen{$i} = 1;
            }
        }
        # populate $deps{$target} as first-level deps only.
        # and find remainder of dependency tree in $deptree{$target}
        @{$deps{$target}} = @{$deptree{$target}};
        my @stack = @{$deps{$target}};
        while (@stack) {
            my $i = shift @stack;
            my $dep_list =
                $dbh->selectcol_arrayref("SELECT $target
                                          FROM dependencies
                                          WHERE $me = ?", undef, $i);
            foreach my $t (@$dep_list) {
                # ignore any _current_ dependencies involving this bug,
                # as they will be overwritten with data from the form.
                if ($t != $id && !exists $seen{$t}) {
                    push(@{$deptree{$target}}, $t);
                    push @stack, $t;
                    $seen{$t} = 1;
                }
            }
        }
    }

    my @deps   = @{$deptree{'dependson'}};
    my @blocks = @{$deptree{'blocked'}};
    my %union = ();
    my %isect = ();
    foreach my $b (@deps, @blocks) { $union{$b}++ && $isect{$b}++ }
4021
    my @isect = keys %isect;
4022
    if (scalar(@isect) > 0) {
4023
        ThrowUserError("dependency_loop_multi", {'deps' => \@isect});
4024 4025 4026
    }
    return %deps;
}
4027

4028 4029

#####################################################################
4030
# Custom Field Accessors
4031 4032
#####################################################################

4033 4034 4035 4036
sub _create_cf_accessors {
    my ($invocant) = @_;
    my $class = ref($invocant) || $invocant;
    return if Bugzilla->request_cache->{"${class}_cf_accessors_created"};
4037

4038 4039 4040 4041 4042 4043 4044 4045 4046 4047
    my $fields = Bugzilla->fields({ custom => 1 });
    foreach my $field (@$fields) {
        my $accessor = $class->_accessor_for($field);
        my $name = "${class}::" . $field->name;
        {
            no strict 'refs';
            next if defined *{$name};
            *{$name} = $accessor;
        }
    }
4048

4049 4050
    Bugzilla->request_cache->{"${class}_cf_accessors_created"} = 1;
}
4051

4052 4053 4054 4055 4056 4057 4058
sub _accessor_for {
    my ($class, $field) = @_;
    if ($field->type == FIELD_TYPE_MULTI_SELECT) {
        return $class->_multi_select_accessor($field->name);
    }
    return $class->_cf_accessor($field->name);
}
4059

4060 4061 4062 4063 4064 4065 4066 4067
sub _cf_accessor {
    my ($class, $field) = @_;
    my $accessor = sub {
        my ($self) = @_;
        return $self->{$field};
    };
    return $accessor;
}
4068

4069 4070 4071 4072 4073 4074 4075 4076 4077 4078
sub _multi_select_accessor {
    my ($class, $field) = @_;
    my $accessor = sub {
        my ($self) = @_;
        $self->{$field} ||= Bugzilla->dbh->selectcol_arrayref(
            "SELECT value FROM bug_$field WHERE bug_id = ? ORDER BY value",
            undef, $self->id);
        return $self->{$field};
    };
    return $accessor;
4079 4080 4081
}

1;