97d408ca006c862aa06415a020f4d3e9b06dd2da
[usit-rt.git] / lib / RT / Action / EscalatePriority.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2012 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 =head1 NAME
50
51   RT::Action::EscalatePriority
52
53 =head1 DESCRIPTION
54
55 EscalatePriority is a ScripAction which is NOT intended to be called
56 per transaction. It's intended to be called by an RT escalation tool.
57 One such tool is called rt-crontool and is located in $RTHOME/bin (see
58 C<rt-crontool -h> for more details)
59
60 EsclatePriority uses the following formula to change a ticket's priority:
61
62     Priority = Priority +  (( FinalPriority - Priority ) / ( DueDate-Today))
63
64 Unless the duedate is past, in which case priority gets bumped straight
65 to final priority.
66
67 In this way, priority is either increased or decreased toward the final priority
68 as the ticket heads toward its due date.
69
70 Alternately, if you don't set a due date, the Priority will be incremented by 1
71 until it reaches the Final Priority.  If a ticket without a due date has a Priority
72 greater than Final Priority, it will be decremented by 1.
73
74 =cut
75
76
77 package RT::Action::EscalatePriority;
78 use base 'RT::Action';
79
80 use strict;
81
82 #Do what we need to do and send it out.
83
84 #What does this type of Action does
85
86 sub Describe  {
87   my $self = shift;
88   return (ref $self . " will move a ticket's priority toward its final priority.");
89 }
90         
91
92 sub Prepare  {
93     my $self = shift;
94     
95     if ($self->TicketObj->Priority() == $self->TicketObj->FinalPriority()) {
96         # no update necessary.
97         return 0;
98     }
99    
100     #compute the number of days until the ticket is due
101     my $due = $self->TicketObj->DueObj();
102     
103
104     # If we don't have a due date, adjust the priority by one
105     # until we hit the final priority
106     if ($due->Unix() < 1) {
107         if ( $self->TicketObj->Priority > $self->TicketObj->FinalPriority ){
108             $self->{'prio'} = ($self->TicketObj->Priority - 1);
109             return 1;
110         }
111         elsif ( $self->TicketObj->Priority < $self->TicketObj->FinalPriority ){
112             $self->{'prio'} = ($self->TicketObj->Priority + 1);
113             return 1;
114         }
115         # otherwise the priority is at the final priority. we don't need to
116         # Continue
117         else {
118             return 0;
119         }
120     }
121
122     # we've got a due date. now there are other things we should do
123     else { 
124         my $diff_in_seconds = $due->Diff(time());    
125         my $diff_in_days = int( $diff_in_seconds / 86400);    
126         
127         #if we haven't hit the due date yet
128         if ($diff_in_days > 0 ) {       
129             
130             # compute the difference between the current priority and the
131             # final priority
132             
133             my $prio_delta = 
134               $self->TicketObj->FinalPriority() - $self->TicketObj->Priority;
135             
136             my $inc_priority_by = int( $prio_delta / $diff_in_days );
137             
138             #set the ticket's priority to that amount
139             $self->{'prio'} = $self->TicketObj->Priority + $inc_priority_by;
140             
141         }
142         #if $days is less than 1, set priority to final_priority
143         else {  
144             $self->{'prio'} = $self->TicketObj->FinalPriority();
145         }
146
147     }
148     return 1;
149 }
150
151 sub Commit {
152     my $self = shift;
153    my ($val, $msg) = $self->TicketObj->SetPriority($self->{'prio'});
154
155    unless ($val) {
156         $RT::Logger->debug($self . " $msg"); 
157    }
158 }
159
160 RT::Base->_ImportOverlays();
161
162 1;