rt 4.2.15
[freeside.git] / rt / lib / RT / Rule.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2018 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::Rule;
50 use strict;
51 use warnings;
52
53 use base 'RT::Action';
54
55 use constant _Stage => 'TransactionCreate';
56 use constant _Queue => undef;
57
58
59
60 sub Prepare {
61     my $self = shift;
62     if ( $self->_Queue ) {
63         my $queue = RT::Queue->new( RT->SystemUser );
64         $queue->Load( $self->TicketObj->__Value('Queue') );
65         if ( $queue->Name ne $self->_Queue ) {
66             return (0);
67         }
68         return 1;
69     }
70 }
71
72 sub Commit  {
73     my $self = shift;
74     return(0, $self->loc("Commit Stubbed"));
75 }
76
77 sub Describe {
78     my $self = shift;
79     return $self->loc( $self->Description );
80 }
81
82 sub OnStatusChange {
83     my ($self, $value) = @_;
84
85     $self->TransactionObj->Type eq 'Status' and
86     $self->TransactionObj->Field eq 'Status' and
87     $self->TransactionObj->NewValue eq $value
88 }
89
90 sub RunScripAction {
91     my ($self, $scrip_action, $template, %args) = @_;
92     my $ScripAction = RT::ScripAction->new($self->CurrentUser);
93     $ScripAction->Load($scrip_action) or die ;
94
95     unless (ref($template)) {
96         # XXX: load per-queue template
97         #    $template->LoadQueueTemplate( Queue => ..., ) || $template->LoadGlobalTemplate(...)
98
99         my $t = RT::Template->new($self->CurrentUser);
100         $t->Load($template) or die;
101         $template = $t;
102     }
103
104     my $action = $ScripAction->LoadAction( TransactionObj => $self->TransactionObj,
105                                            TicketObj => $self->TicketObj,
106                                            TemplateObj => $template,
107                                            %args,
108                                        );
109
110     $action->{'ScripObj'} = RT::Scrip->new($self->CurrentUser); # Stub. sendemail action really wants a scripobj available
111     $action->Prepare or return;
112     $action->Commit;
113
114 }
115
116 RT::Base->_ImportOverlays();
117
118 1;