X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FScripAction.pm;h=5d84673b80f6f1f1bfb2cfd573f06aaf0c033a31;hp=26824df5d3e0f96947e3ae135a26bdaa8a74ecd0;hb=919e930aa9279b3c5cd12b593889cd6de79d67bf;hpb=5e05724a635a22776f1b973f5d7e77989da4e048 diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm index 26824df5d..5d84673b8 100755 --- a/rt/lib/RT/ScripAction.pm +++ b/rt/lib/RT/ScripAction.pm @@ -1,120 +1,293 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have # been provided with this software, but in any event can be snarfed # from www.gnu.org. -# +# # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. -# -# Unless otherwise specified, all modifications, corrections or -# extensions to this work which alter its source code become the -# property of Best Practical Solutions, LLC when submitted for -# inclusion in the work. -# -# -# END LICENSE BLOCK -# Autogenerated by DBIx::SearchBuilder factory (by ) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! # - -use strict; - +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} =head1 NAME -RT::ScripAction - + RT::ScripAction - RT Action object =head1 SYNOPSIS + use RT::ScripAction; + + =head1 DESCRIPTION +This module should never be called directly by client code. it's an internal module which +should only be accessed through exported APIs in other modules. + + + =head1 METHODS =cut + package RT::ScripAction; -use RT::Record; + +use strict; +use warnings; + +use base 'RT::Record'; + +sub Table {'ScripActions'} -use vars qw( @ISA ); -@ISA= qw( RT::Record ); -sub _Init { - my $self = shift; +use RT::Template; - $self->Table('ScripActions'); - $self->SUPER::_Init(@_); +sub _Accessible { + my $self = shift; + my %Cols = ( Name => 'read', + Description => 'read', + ExecModule => 'read', + Argument => 'read', + Creator => 'read/auto', + Created => 'read/auto', + LastUpdatedBy => 'read/auto', + LastUpdated => 'read/auto' + ); + return($self->SUPER::_Accessible(@_, %Cols)); } +=head2 Create + +Takes a hash. Creates a new Action entry. should be better +documented. + +=cut + +sub Create { + my $self = shift; + #TODO check these args and do smart things. + return($self->SUPER::Create(@_)); +} +sub Delete { + my $self = shift; + + return (0, "ScripAction->Delete not implemented"); +} -=item Create PARAMHASH +=head2 Load IDENTIFIER -Create takes a hash of values and creates a row in the database: +Loads an action by its Name. - varchar(200) 'Name'. - varchar(255) 'Description'. - varchar(60) 'ExecModule'. - varchar(255) 'Argument'. +Returns: Id, Error Message =cut +sub Load { + my $self = shift; + my $identifier = shift; + + if (!$identifier) { + return (0, $self->loc('Input error')); + } + + my ($ok, $msg); + if ($identifier !~ /\D/) { + ($ok, $msg) = $self->SUPER::Load($identifier); + } + else { + ($ok, $msg) = $self->LoadByCol('Name', $identifier); + + } + + if (@_) { + # Set the template Id to the passed in template + my $template = shift; + + $self->{'Template'} = $template; + } + + return ($ok, $msg); +} + +=head2 LoadAction HASH + Takes a hash consisting of TicketObj and TransactionObj. Loads an RT::Action:: module. -sub Create { +=cut + +sub LoadAction { my $self = shift; - my %args = ( - Name => '', - Description => '', - ExecModule => '', - Argument => '', - - @_); - $self->SUPER::Create( - Name => $args{'Name'}, - Description => $args{'Description'}, - ExecModule => $args{'ExecModule'}, - Argument => $args{'Argument'}, -); + my %args = ( TransactionObj => undef, + TicketObj => undef, + @_ ); + + $self->{_TicketObj} = $args{TicketObj}; + + #TODO: Put this in an eval + $self->ExecModule =~ /^(\w+)$/; + my $module = $1; + my $type = "RT::Action::". $module; + + eval "require $type" || die "Require of $type failed.\n$@\n"; + + $self->{'Action'} = $type->new ( Argument => $self->Argument, + CurrentUser => $self->CurrentUser, + ScripActionObj => $self, + ScripObj => $args{'ScripObj'}, + TemplateObj => $self->TemplateObj, + TicketObj => $args{'TicketObj'}, + TransactionObj => $args{'TransactionObj'}, + ); +} + + +=head2 TemplateObj + +Return this action's template object + +TODO: Why are we not using the Scrip's template object? + +=cut + +sub TemplateObj { + my $self = shift; + return undef unless $self->{Template}; + if ( !$self->{'TemplateObj'} ) { + $self->{'TemplateObj'} = RT::Template->new( $self->CurrentUser ); + $self->{'TemplateObj'}->LoadById( $self->{'Template'} ); + + if ( ( $self->{'TemplateObj'}->__Value('Queue') == 0 ) + && $self->{'_TicketObj'} ) { + my $tmptemplate = RT::Template->new( $self->CurrentUser ); + my ( $ok, $err ) = $tmptemplate->LoadQueueTemplate( + Queue => $self->{'_TicketObj'}->QueueObj->id, + Name => $self->{'TemplateObj'}->Name); + + if ( $tmptemplate->id ) { + # found the queue-specific template with the same name + $self->{'TemplateObj'} = $tmptemplate; + } + } + + } + + return ( $self->{'TemplateObj'} ); +} + +# The following methods call the action object + + +sub Prepare { + my $self = shift; + $self->{_Message_ID} = 0; + return ($self->Action->Prepare()); + } +sub Commit { + my $self = shift; + return($self->Action->Commit()); + + +} +sub Describe { + my $self = shift; + return ($self->Action->Describe()); + +} -=item id +=head2 Action -Returns the current value of id. +Return the actual RT::Action object for this scrip. + +=cut + +sub Action { + my $self = shift; + return ($self->{'Action'}); +} + +sub DESTROY { + my $self=shift; + $self->{'_TicketObj'} = undef; + $self->{'Action'} = undef; + $self->{'TemplateObj'} = undef; +} + +=head2 TODO + +Between this, RT::Scrip and RT::Action::*, we need to be able to get rid of a +class. This just reeks of too much complexity -- jesse + +=cut + + + + +=head2 id + +Returns the current value of id. (In the database, id is stored as int(11).) =cut -=item Name +=head2 Name -Returns the current value of Name. +Returns the current value of Name. (In the database, Name is stored as varchar(200).) -=item SetName VALUE +=head2 SetName VALUE -Set Name to VALUE. +Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(200).) @@ -122,17 +295,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =cut -=item Description +=head2 Description -Returns the current value of Description. +Returns the current value of Description. (In the database, Description is stored as varchar(255).) -=item SetDescription VALUE +=head2 SetDescription VALUE -Set Description to VALUE. +Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).) @@ -140,17 +313,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =cut -=item ExecModule +=head2 ExecModule -Returns the current value of ExecModule. +Returns the current value of ExecModule. (In the database, ExecModule is stored as varchar(60).) -=item SetExecModule VALUE +=head2 SetExecModule VALUE -Set ExecModule to VALUE. +Set ExecModule to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ExecModule will be stored as a varchar(60).) @@ -158,54 +331,54 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =cut -=item Argument +=head2 Argument -Returns the current value of Argument. -(In the database, Argument is stored as varchar(255).) +Returns the current value of Argument. +(In the database, Argument is stored as varbinary(255).) -=item SetArgument VALUE +=head2 SetArgument VALUE -Set Argument to VALUE. +Set Argument to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. -(In the database, Argument will be stored as a varchar(255).) +(In the database, Argument will be stored as a varbinary(255).) =cut -=item Creator +=head2 Creator -Returns the current value of Creator. +Returns the current value of Creator. (In the database, Creator is stored as int(11).) =cut -=item Created +=head2 Created -Returns the current value of Created. +Returns the current value of Created. (In the database, Created is stored as datetime.) =cut -=item LastUpdatedBy +=head2 LastUpdatedBy -Returns the current value of LastUpdatedBy. +Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).) =cut -=item LastUpdated +=head2 LastUpdated -Returns the current value of LastUpdated. +Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.) @@ -213,67 +386,31 @@ Returns the current value of LastUpdated. -sub _ClassAccessible { +sub _CoreAccessible { { - + id => - {read => 1, type => 'int(11)', default => ''}, - Name => - {read => 1, write => 1, type => 'varchar(200)', default => ''}, - Description => - {read => 1, write => 1, type => 'varchar(255)', default => ''}, - ExecModule => - {read => 1, write => 1, type => 'varchar(60)', default => ''}, - Argument => - {read => 1, write => 1, type => 'varchar(255)', default => ''}, - Creator => - {read => 1, auto => 1, type => 'int(11)', default => '0'}, - Created => - {read => 1, auto => 1, type => 'datetime', default => ''}, - LastUpdatedBy => - {read => 1, auto => 1, type => 'int(11)', default => '0'}, - LastUpdated => - {read => 1, auto => 1, type => 'datetime', default => ''}, + {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, + Name => + {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''}, + Description => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, + ExecModule => + {read => 1, write => 1, sql_type => 12, length => 60, is_blob => 0, is_numeric => 0, type => 'varchar(60)', default => ''}, + Argument => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varbinary(255)', default => ''}, + Creator => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + Created => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, + LastUpdatedBy => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + LastUpdated => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, } }; - - eval "require RT::ScripAction_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Overlay.pm}) { - die $@; - }; - - eval "require RT::ScripAction_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Vendor.pm}) { - die $@; - }; - - eval "require RT::ScripAction_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Local.pm}) { - die $@; - }; - - - - -=head1 SEE ALSO - -This class allows "overlay" methods to be placed -into the following files _Overlay is for a System overlay by the original author, -_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations. - -These overlay files can contain new subs or subs to replace existing subs in this module. - -If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line - - no warnings qw(redefine); - -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. - -RT::ScripAction_Overlay, RT::ScripAction_Vendor, RT::ScripAction_Local - -=cut - +RT::Base->_ImportOverlays(); 1;