1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
51 RT::ScripAction - RT Action object
60 This module should never be called directly by client code. it's an internal module which
61 should only be accessed through exported APIs in other modules.
70 package RT::ScripAction;
73 no warnings qw(redefine);
79 my %Cols = ( Name => 'read',
80 Description => 'read',
83 Creator => 'read/auto',
84 Created => 'read/auto',
85 LastUpdatedBy => 'read/auto',
86 LastUpdated => 'read/auto'
88 return($self->SUPER::_Accessible(@_, %Cols));
96 Takes a hash. Creates a new Action entry. should be better
103 #TODO check these args and do smart things.
104 return($self->SUPER::Create(@_));
112 return (0, "ScripAction->Delete not implemented");
118 =head2 Load IDENTIFIER
120 Loads an action by its Name.
122 Returns: Id, Error Message
128 my $identifier = shift;
131 return (0, $self->loc('Input error'));
134 if ($identifier !~ /\D/) {
135 $self->SUPER::Load($identifier);
138 $self->LoadByCol('Name', $identifier);
143 # Set the template Id to the passed in template
144 my $template = shift;
146 $self->{'Template'} = $template;
148 return ($self->Id, ($self->loc('[_1] ScripAction loaded', $self->Id)));
154 =head2 LoadAction HASH
156 Takes a hash consisting of TicketObj and TransactionObj. Loads an RT::Action:: module.
162 my %args = ( TransactionObj => undef,
166 $self->{_TicketObj} = $args{TicketObj};
168 #TODO: Put this in an eval
169 $self->ExecModule =~ /^(\w+)$/;
171 my $type = "RT::Action::". $module;
173 eval "require $type" || die "Require of $type failed.\n$@\n";
175 $self->{'Action'} = $type->new ( Argument => $self->Argument,
176 CurrentUser => $self->CurrentUser,
177 ScripActionObj => $self,
178 ScripObj => $args{'ScripObj'},
179 TemplateObj => $self->TemplateObj,
180 TicketObj => $args{'TicketObj'},
181 TransactionObj => $args{'TransactionObj'},
186 # {{{ sub TemplateObj
190 Return this action's template object
192 TODO: Why are we not using the Scrip's template object?
199 return undef unless $self->{Template};
200 if ( !$self->{'TemplateObj'} ) {
201 $self->{'TemplateObj'} = RT::Template->new( $self->CurrentUser );
202 $self->{'TemplateObj'}->LoadById( $self->{'Template'} );
204 if ( ( $self->{'TemplateObj'}->__Value('Queue') == 0 )
205 && $self->{'_TicketObj'} ) {
206 my $tmptemplate = RT::Template->new( $self->CurrentUser );
207 my ( $ok, $err ) = $tmptemplate->LoadQueueTemplate(
208 Queue => $self->{'_TicketObj'}->QueueObj->id,
209 Name => $self->{'TemplateObj'}->Name);
211 if ( $tmptemplate->id ) {
212 # found the queue-specific template with the same name
213 $self->{'TemplateObj'} = $tmptemplate;
219 return ( $self->{'TemplateObj'} );
223 # The following methods call the action object
229 $self->{_Message_ID} = 0;
230 return ($self->Action->Prepare());
238 return($self->Action->Commit());
247 return ($self->Action->Describe());
254 Return the actual RT::Action object for this scrip.
260 return ($self->{'Action'});
266 $self->{'_TicketObj'} = undef;
267 $self->{'Action'} = undef;
268 $self->{'TemplateObj'} = undef;
274 Between this, RT::Scrip and RT::Action::*, we need to be able to get rid of a
275 class. This just reeks of too much complexity -- jesse