rt/lib/RT/Action/EscalatePriority.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2015 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 use warnings;
  82
  83 #Do what we need to do and send it out.
  84
  85 #What does this type of Action does
  86
  87 sub Describe  {
  88   my $self = shift;
  89   return (ref $self . " will move a ticket's priority toward its final priority.");
  90 }
  91
  92
  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 $arg = $self->Argument || '';
 126         my $now = time();
 127         if ( $arg =~ /CurrentTime:\s*(\d+)/i ) {
 128             $now = $1;
 129         }
 130         my $diff_in_seconds = $due->Diff($now);
 131         my $diff_in_days = int( $diff_in_seconds / 86400);
 132
 133         #if we haven't hit the due date yet
 134         if ($diff_in_days > 0 ) {
 135
 136             # compute the difference between the current priority and the
 137             # final priority
 138
 139             my $prio_delta =
 140               $self->TicketObj->FinalPriority() - $self->TicketObj->Priority;
 141
 142             my $inc_priority_by = int( $prio_delta / $diff_in_days );
 143
 144             #set the ticket's priority to that amount
 145             $self->{'prio'} = $self->TicketObj->Priority + $inc_priority_by;
 146
 147         }
 148         #if $days is less than 1, set priority to final_priority
 149         else {
 150             $self->{'prio'} = $self->TicketObj->FinalPriority();
 151         }
 152
 153     }
 154     return 1;
 155 }
 156
 157 sub Commit {
 158     my $self = shift;
 159    my ($val, $msg) = $self->TicketObj->SetPriority($self->{'prio'});
 160
 161    unless ($val) {
 162         $RT::Logger->debug($self . " $msg");
 163    }
 164 }
 165
 166 RT::Base->_ImportOverlays();
 167
 168 1;