rt/lib/RT/Action/EscalatePriority.pm

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