X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FScripAction.pm;h=428ad5d3541fafa7dc3227789f84d0d235cc4185;hp=26824df5d3e0f96947e3ae135a26bdaa8a74ecd0;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hpb=f7fd2a3e34da751cbc02bbf215e99c6dc89adc15

diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm
index 26824df5d..428ad5d35 100755
--- a/rt/lib/RT/ScripAction.pm
+++ b/rt/lib/RT/ScripAction.pm
@@ -1,279 +1,382 @@
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (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 <jesse@bestpractical.com>)
-# 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
-
-
-=head1 SYNOPSIS
+RT::ScripAction - RT Action object
 
 =head1 DESCRIPTION
 
-=head1 METHODS
+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.
 
 =cut
 
-package RT::ScripAction;
-use RT::Record; 
 
+package RT::ScripAction;
 
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+use strict;
+use warnings;
 
-sub _Init {
-  my $self = shift; 
+use base 'RT::Record';
 
-  $self->Table('ScripActions');
-  $self->SUPER::_Init(@_);
-}
 
+sub Table {'ScripActions'}
 
+use RT::Template;
 
+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));
+}
 
 
-=item Create PARAMHASH
+=head1 METHODS
 
-Create takes a hash of values and creates a row in the database:
+=head2 Create
 
-  varchar(200) 'Name'.
-  varchar(255) 'Description'.
-  varchar(60) 'ExecModule'.
-  varchar(255) 'Argument'.
+Takes a hash. Creates a new Action entry.
 
 =cut
 
-
-
-
-sub Create {
+sub Create  {
     my $self = shift;
-    my %args = ( 
-                Name => '',
-                Description => '',
-                ExecModule => '',
-                Argument => '',
-
-		  @_);
-    $self->SUPER::Create(
-                         Name => $args{'Name'},
-                         Description => $args{'Description'},
-                         ExecModule => $args{'ExecModule'},
-                         Argument => $args{'Argument'},
-);
-
+    #TODO check these args and do smart things.
+    return($self->SUPER::Create(@_));
 }
 
+sub Delete  {
+    my $self = shift;
+    return (0, "ScripAction->Delete not implemented");
+}
 
 
-=item id
+=head2 Load IDENTIFIER
 
-Returns the current value of id. 
-(In the database, id is stored as int(11).)
+Loads an action by its Name.
 
+Returns: Id, Error Message
 
 =cut
 
+sub Load  {
+    my $self = shift;
+    my $identifier = shift;
+
+    if (!$identifier) {
+        return wantarray ? (0, $self->loc('Input error')) : 0;
+    }
+
+    my ($ok, $msg);
+    if ($identifier !~ /\D/) {
+        ($ok, $msg) = $self->SUPER::Load($identifier);
+    }
+    else {
+        ($ok, $msg) = $self->LoadByCol('Name', $identifier);
+    }
+
+    if (@_) {
+        RT->Deprecated(
+            Arguments => "Template as second argument",
+            Remove    => "4.4",
+        );
+        $self->{'Template'} = shift;
+    }
+
+    return wantarray ? ($ok, $msg) : $ok;
+}
 
-=item Name
 
-Returns the current value of Name. 
-(In the database, Name is stored as varchar(200).)
+=head2 LoadAction HASH
 
+Takes a hash consisting of TicketObj and TransactionObj.  Loads an RT::Action:: module.
 
+=cut
 
-=item SetName VALUE
+sub LoadAction  {
+    my $self = shift;
+    my %args = (
+        TransactionObj => undef,
+        TicketObj => undef,
+        ScripObj => undef,
+        @_
+    );
+
+    # XXX: this whole block goes with TemplateObj method
+    unless ( @_ && exists $args{'TemplateObj'} ) {
+        local $self->{_TicketObj} = $args{TicketObj};
+        $args{'TemplateObj'} = $self->TemplateObj;
+    }
+    else {
+        $self->{'TemplateObj'} = $args{'TemplateObj'};
+    }
+
+    $self->ExecModule =~ /^(\w+)$/;
+    my $module = $1;
+    my $type = "RT::Action::". $module;
+
+    $type->require or die "Require of $type action module failed.\n$@\n";
+
+    return $self->{'Action'} = $type->new(
+        %args,
+        Argument       => $self->Argument,
+        CurrentUser    => $self->CurrentUser,
+        ScripActionObj => $self,
+    );
+}
 
 
-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).)
+=head2 TemplateObj
 
+Return this action's template object.  Deprecated.
 
 =cut
 
+sub TemplateObj {
+    my $self = shift;
+    RT->Deprecated(
+        Remove => "4.4",
+    );
+
+    if ( !$self->{'TemplateObj'} ) {
+        return undef unless $self->{Template};
+        $self->{'TemplateObj'} = RT::Template->new( $self->CurrentUser );
+        $self->{'TemplateObj'}->Load( $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'} );
+}
 
-=item Description
-
-Returns the current value of Description. 
-(In the database, Description is stored as varchar(255).)
-
-
+sub Prepare  {
+    my $self = shift;
+    $self->{_Message_ID} = 0;
+    return $self->Action->Prepare( @_ );
+}
 
-=item SetDescription VALUE
+sub Commit  {
+    my $self = shift;
+    return $self->Action->Commit( @_ );
+}
 
+sub Describe  {
+    my $self = shift;
+    return $self->Action->Describe( @_ );
+}
 
-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).)
+=head2 Action
 
+Return the actual RT::Action object for this scrip.
 
 =cut
 
+sub Action {
+    my $self = shift;
+    return $self->{'Action'};
+}
 
-=item ExecModule
+=head2 id
 
-Returns the current value of ExecModule. 
-(In the database, ExecModule is stored as varchar(60).)
+Returns the current value of id.
+(In the database, id is stored as int(11).)
 
 
+=head2 Name
 
-=item SetExecModule VALUE
+Returns the current value of Name.
+(In the database, Name is stored as varchar(200).)
 
+=head2 SetName VALUE
 
-Set ExecModule to VALUE. 
+Set Name 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).)
+(In the database, Name will be stored as a varchar(200).)
 
 
-=cut
+=head2 Description
 
+Returns the current value of Description.
+(In the database, Description is stored as varchar(255).)
 
-=item Argument
+=head2 SetDescription VALUE
 
-Returns the current value of Argument. 
-(In the database, Argument is stored as varchar(255).)
+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).)
 
 
+=head2 ExecModule
 
-=item SetArgument VALUE
+Returns the current value of ExecModule.
+(In the database, ExecModule is stored as varchar(60).)
 
+=head2 SetExecModule VALUE
 
-Set Argument to VALUE. 
+Set ExecModule 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, ExecModule will be stored as a varchar(60).)
 
 
-=cut
+=head2 Argument
 
+Returns the current value of Argument.
+(In the database, Argument is stored as varbinary(255).)
 
-=item Creator
+=head2 SetArgument VALUE
 
-Returns the current value of Creator. 
-(In the database, Creator is stored as int(11).)
+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 varbinary(255).)
 
 
-=cut
+=head2 Creator
 
+Returns the current value of Creator.
+(In the database, Creator is stored as int(11).)
 
-=item Created
+=head2 Created
 
-Returns the current value of Created. 
+Returns the current value of Created.
 (In the database, Created is stored as datetime.)
 
+=head2 LastUpdatedBy
 
-=cut
-
-
-=item LastUpdatedBy
-
-Returns the current value of LastUpdatedBy. 
+Returns the current value of LastUpdatedBy.
 (In the database, LastUpdatedBy is stored as int(11).)
 
+=head2 LastUpdated
 
-=cut
-
-
-=item LastUpdated
-
-Returns the current value of LastUpdated. 
+Returns the current value of LastUpdated.
 (In the database, LastUpdated is stored as datetime.)
 
-
 =cut
 
 
-
-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 => ''},
 
  }
 };
 
+sub PreInflate {
+    my $class = shift;
+    my ($importer, $uid, $data) = @_;
 
-        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 $@;
-        };
-
+    $class->SUPER::PreInflate( $importer, $uid, $data );
 
+    return not $importer->SkipBy( "Name", $class, $uid, $data );
+}
 
+sub __DependsOn {
+    my $self = shift;
+    my %args = (
+        Shredder => undef,
+        Dependencies => undef,
+        @_,
+    );
+    my $deps = $args{'Dependencies'};
+
+# Scrips
+    my $objs = RT::Scrips->new( $self->CurrentUser );
+    $objs->Limit( FIELD => 'ScripAction', VALUE => $self->Id );
+    $deps->_PushDependencies(
+        BaseObject => $self,
+        Flags => RT::Shredder::Constants::DEPENDS_ON,
+        TargetObjects => $objs,
+        Shredder => $args{'Shredder'}
+    );
+
+    return $self->SUPER::__DependsOn( %args );
+}
 
-=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;