Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / Condition / BeforeDue.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::Condition::BeforeDue
52
53 =head1 DESCRIPTION
54
55 Returns true if the ticket we're operating on is within the
56 amount of time defined by the passed in argument.
57
58 The passed in value is a date in the format "1d2h3m4s"
59 for 1 day and 2 hours and 3 minutes and 4 seconds. Single
60 units can also be passed such as 1d for just one day.
61
62
63 =cut
64
65
66 package RT::Condition::BeforeDue;
67 use base 'RT::Condition';
68
69 use RT::Date;
70
71 use strict;
72 use warnings;
73
74 sub IsApplicable {
75     my $self = shift;
76
77     # Parse date string.  Format is "1d2h3m4s" for 1 day and 2 hours
78     # and 3 minutes and 4 seconds.
79     my %e;
80     foreach (qw(d h m s)) {
81         my @vals = $self->Argument =~ m/(\d+)$_/i;
82         $e{$_} = pop @vals || 0;
83     }
84     my $elapse = $e{'d'} * 24*60*60 + $e{'h'} * 60*60 + $e{'m'} * 60 + $e{'s'};
85
86     my $cur = RT::Date->new( RT->SystemUser );
87     $cur->SetToNow();
88     my $due = $self->TicketObj->DueObj;
89     return (undef) unless $due->IsSet;
90
91     my $diff = $due->Diff($cur);
92     if ( $diff >= 0 and $diff <= $elapse ) {
93         return(1);
94     } else {
95         return(undef);
96     }
97 }
98
99 RT::Base->_ImportOverlays();
100
101 1;