summaryrefslogtreecommitdiffstats
path: root/Bugzilla/Status.pm
blob: 619594f5b0d198e81560146eb66f26891d18b6d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

package Bugzilla::Status;

use 5.10.1;
use strict;
use warnings;

# This subclasses Bugzilla::Field::Choice instead of implementing
# ChoiceInterface, because a bug status literally is a special type
# of Field::Choice, not just an object that happens to have the same
# methods.
use base qw(Bugzilla::Field::Choice Exporter);
@Bugzilla::Status::EXPORT = qw(
  BUG_STATE_OPEN
  SPECIAL_STATUS_WORKFLOW_ACTIONS

  is_open_state
  closed_bug_statuses
);

use Bugzilla::Error;

################################
#####   Initialization     #####
################################

use constant SPECIAL_STATUS_WORKFLOW_ACTIONS => qw(
  none
  duplicate
  change_resolution
  clearresolution
);

use constant DB_TABLE => 'bug_status';

# This has all the standard Bugzilla::Field::Choice columns plus "is_open"
sub DB_COLUMNS {
  return ($_[0]->SUPER::DB_COLUMNS, 'is_open');
}

sub VALIDATORS {
  my $invocant   = shift;
  my $validators = $invocant->SUPER::VALIDATORS;
  $validators->{is_open} = \&Bugzilla::Object::check_boolean;
  $validators->{value}   = \&_check_value;
  return $validators;
}

#########################
# Database Manipulation #
#########################

sub create {
  my $class = shift;
  my $self  = $class->SUPER::create(@_);
  delete Bugzilla->request_cache->{status_bug_state_open};
  add_missing_bug_status_transitions();
  return $self;
}

sub remove_from_db {
  my $self = shift;
  my $dbh  = Bugzilla->dbh;
  my $id   = $self->id;
  $dbh->bz_start_transaction();
  $self->SUPER::remove_from_db();
  $dbh->do(
    'DELETE FROM status_workflow
               WHERE old_status = ? OR new_status = ?', undef, $id, $id
  );
  $dbh->bz_commit_transaction();
  delete Bugzilla->request_cache->{status_bug_state_open};
}

###############################
#####     Accessors        ####
###############################

sub is_active { return $_[0]->{'isactive'}; }
sub is_open   { return $_[0]->{'is_open'}; }

sub is_static {
  my $self = shift;
  if ( $self->name eq 'UNCONFIRMED'
    || $self->name eq Bugzilla->params->{'duplicate_or_move_bug_status'})
  {
    return 1;
  }
  return 0;
}

##############
# Validators #
##############

sub _check_value {
  my $invocant = shift;
  my $value    = $invocant->SUPER::_check_value(@_);

  if (grep { lc($value) eq lc($_) } SPECIAL_STATUS_WORKFLOW_ACTIONS) {
    ThrowUserError('fieldvalue_reserved_word',
      {field => $invocant->field, value => $value});
  }
  return $value;
}


###############################
#####       Methods        ####
###############################

sub BUG_STATE_OPEN {
  my $dbh           = Bugzilla->dbh;
  my $request_cache = Bugzilla->request_cache;
  my $cache_key     = 'status_bug_state_open';
  return @{$request_cache->{$cache_key}} if exists $request_cache->{$cache_key};

  my $rows = Bugzilla->memcached->get_config({key => $cache_key});
  if (!$rows) {
    $rows
      = $dbh->selectcol_arrayref('SELECT value FROM bug_status WHERE is_open = 1');
    Bugzilla->memcached->set_config({key => $cache_key, data => $rows});
  }

  $request_cache->{$cache_key} = $rows;
  return @$rows;
}

# Tells you whether or not the argument is a valid "open" state.
sub is_open_state {
  my ($state) = @_;
  return (grep($_ eq $state, BUG_STATE_OPEN) ? 1 : 0);
}

sub closed_bug_statuses {
  my @bug_statuses = Bugzilla::Status->get_all;
  @bug_statuses = grep { !$_->is_open } @bug_statuses;
  return @bug_statuses;
}

sub can_change_to {
  my $self = shift;
  my $dbh  = Bugzilla->dbh;

  if (!ref($self) || !defined $self->{'can_change_to'}) {
    my ($cond, @args, $self_exists);
    if (ref($self)) {
      $cond = '= ?';
      push(@args, $self->id);
      $self_exists = 1;
    }
    else {
      $cond = 'IS NULL';

      # Let's do it so that the code below works in all cases.
      $self = {};
    }

    my $new_status_ids = $dbh->selectcol_arrayref(
      "SELECT new_status
                                                         FROM status_workflow
                                                   INNER JOIN bug_status
                                                           ON id = new_status
                                                        WHERE isactive = 1
                                                          AND old_status $cond
                                                     ORDER BY sortkey", undef, @args
    );

    # Allow the bug status to remain unchanged.
    push(@$new_status_ids, $self->id) if $self_exists;
    $self->{'can_change_to'} = Bugzilla::Status->new_from_list($new_status_ids);
  }

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

sub comment_required_on_change_from {
  my ($self, $old_status) = @_;
  my ($cond, $values)     = $self->_status_condition($old_status);

  my ($require_comment) = Bugzilla->dbh->selectrow_array(
    "SELECT require_comment FROM status_workflow
          WHERE $cond", undef, @$values
  );
  return $require_comment;
}

# Used as a helper for various functions that have to deal with old_status
# sometimes being NULL and sometimes having a value.
sub _status_condition {
  my ($self, $old_status) = @_;
  my @values;
  my $cond = 'old_status IS NULL';

  # For newly-filed bugs
  if ($old_status) {
    $cond = 'old_status = ?';
    push(@values, $old_status->id);
  }
  $cond .= " AND new_status = ?";
  push(@values, $self->id);
  return ($cond, \@values);
}

sub add_missing_bug_status_transitions {
  my $bug_status = shift || Bugzilla->params->{'duplicate_or_move_bug_status'};
  my $dbh        = Bugzilla->dbh;
  my $new_status = new Bugzilla::Status({name => $bug_status});

  # Silently discard invalid bug statuses.
  $new_status || return;

  my $missing_statuses = $dbh->selectcol_arrayref(
    'SELECT id
                                                       FROM bug_status
                                                  LEFT JOIN status_workflow
                                                         ON old_status = id
                                                        AND new_status = ?
                                                      WHERE old_status IS NULL',
    undef, $new_status->id
  );

  my $sth = $dbh->prepare(
    'INSERT INTO status_workflow
                             (old_status, new_status) VALUES (?, ?)'
  );

  foreach my $old_status_id (@$missing_statuses) {
    next if ($old_status_id == $new_status->id);
    $sth->execute($old_status_id, $new_status->id);
  }
}

1;

__END__

=head1 NAME

Bugzilla::Status - Bug status class.

=head1 SYNOPSIS

    use Bugzilla::Status;

    my $bug_status = new Bugzilla::Status({ name => 'IN_PROGRESS' });
    my $bug_status = new Bugzilla::Status(4);

    my @closed_bug_statuses = closed_bug_statuses();

    Bugzilla::Status::add_missing_bug_status_transitions($bug_status);

=head1 DESCRIPTION

Status.pm represents a bug status object. It is an implementation
of L<Bugzilla::Object>, and thus provides all methods that
L<Bugzilla::Object> provides.

The methods that are specific to C<Bugzilla::Status> are listed
below.

=head1 METHODS

=over

=item C<closed_bug_statuses>

 Description: Returns a list of C<Bugzilla::Status> objects which can have
              a resolution associated with them ("closed" bug statuses).

 Params:      none.

 Returns:     A list of Bugzilla::Status objects.

=item C<can_change_to>

 Description: Returns the list of active statuses a bug can be changed to
              given the current bug status. If this method is called as a
              class method, then it returns all bug statuses available on
              bug creation.

 Params:      none.

 Returns:     A list of Bugzilla::Status objects.

=item C<comment_required_on_change_from>

=over

=item B<Description>

Checks if a comment is required to change to this status from another
status, according to the current settings in the workflow.

Note that this doesn't implement the checks enforced by the various
C<commenton> parameters--those are checked by internal checks in
L<Bugzilla::Bug>.

=item B<Params>

C<$old_status> - The status you're changing from.

=item B<Returns>

C<1> if a comment is required on this change, C<0> if not.

=back

=item C<add_missing_bug_status_transitions>

 Description: Insert all missing transitions to a given bug status.

 Params:      $bug_status - The value (name) of a bug status.

 Returns:     nothing.

=back

=cut