Putting 4.2.0 on top of 4.0.17
[usit-rt.git] / lib / RT / Condition / StatusChange.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
6 #                                          <sales@bestpractical.com>
7 #
8 # (Except where explicitly superseded by other copyright notices)
9 #
10 #
11 # LICENSE:
12 #
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
16 # from www.gnu.org.
17 #
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 # General Public License for more details.
22 #
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28 #
29 #
30 # CONTRIBUTION SUBMISSION POLICY:
31 #
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
37 #
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
46 #
47 # END BPS TAGGED BLOCK }}}
48
49 package RT::Condition::StatusChange;
50 use base 'RT::Condition';
51 use strict;
52 use warnings;
53
54 =head2 DESCRIPTION
55
56 This condition check passes if the current transaction is a status change.
57
58 The argument can be used to apply additional conditions on old and new values.
59
60 If argument is empty then the check passes for any change of the status field.
61
62 If argument is equal to new value then check is passed. This is behavior
63 is close to RT 3.8 and older. For example, setting the argument to 'resolved' means
64 'fire scrip when status changed from any to resolved'.
65
66 The following extended format is supported:
67
68     old: comma separated list; new: comma separated list
69
70 For example:
71
72     old: open; new: resolved
73
74 You can omit old or new part, for example:
75
76     old: open
77
78     new: resolved
79
80 You can specify multiple values, for example:
81
82     old: new, open; new: resolved, rejected
83
84 Status sets ('initial', 'active' or 'inactive') can be used, for example:
85
86     old: active; new: inactive
87
88     old: initial, active; new: resolved
89
90 =cut
91
92 sub IsApplicable {
93     my $self = shift;
94     my $txn = $self->TransactionObj;
95     my ($type, $field) = ($txn->Type, $txn->Field);
96     return 0 unless $type eq 'Status' || ($type eq 'Set' && $field eq 'Status');
97
98     my $argument = $self->Argument;
99     return 1 unless $argument;
100
101     my $new = $txn->NewValue || '';
102     return 1 if $argument eq $new;
103
104     # let's parse argument
105     my ($old_must_be, $new_must_be) = ('', '');
106     if ( $argument =~ /^\s*old:\s*(.*);\s*new:\s*(.*)\s*$/i ) {
107         ($old_must_be, $new_must_be) = ($1, $2);
108     }
109     elsif ( $argument =~ /^\s*new:\s*(.*)\s*$/i ) {
110         $new_must_be = $1;
111     }
112     elsif ( $argument =~ /^\s*old:\s*(.*)\s*$/i ) {
113         $old_must_be = $1;
114     }
115     else {
116         $RT::Logger->error("Argument '$argument' is incorrect.")
117             unless RT::Lifecycle->Load(Type => 'ticket')->IsValid( $argument );
118         return 0;
119     }
120
121     my $lifecycle = $self->TicketObj->LifecycleObj;
122     if ( $new_must_be ) {
123         return 0 unless grep lc($new) eq lc($_),
124             map {m/^(initial|active|inactive)$/i? $lifecycle->Valid(lc $_): $_ }
125             grep defined && length,
126             map { s/^\s+//; s/\s+$//; $_ }
127             split /,/, $new_must_be;
128     }
129     if ( $old_must_be ) {
130         my $old = lc($txn->OldValue || '');
131         return 0 unless grep $old eq lc($_),
132             map {m/^(initial|active|inactive)$/i? $lifecycle->Valid(lc $_): $_ }
133             grep defined && length,
134             map { s/^\s+//; s/\s+$//; $_ }
135             split /,/, $old_must_be;
136     }
137     return 1;
138 }
139
140 RT::Base->_ImportOverlays();
141
142 1;
143