rt 4.0.23

[freeside.git] / rt / lib / RT / ScripAction.pm

diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm
index 471ad91..5d84673 100755 (executable)
--- a/rt/lib/RT/ScripAction.pm
+++ b/rt/lib/RT/ScripAction.pm
@@ -1,6 +1,50 @@
-# Copyright 1999-2000 Jesse Vincent <jesse@fsck.com>
-# Released under the terms of the GNU Public License
-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/ScripAction.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# 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.
+#
+# 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
 
 
 =head1 NAME
 


@@ -17,30 +61,25 @@ This module should never be called directly by client code. it's an internal mod
 should only be accessed through exported APIs in other modules.
 
 
 should only be accessed through exported APIs in other modules.
 
 

-=begin testing
-
-ok (require RT::TestHarness);
-ok (require RT::ScripAction);
-
-=end testing

 
 =head1 METHODS
 
 =cut
 
 
 =head1 METHODS
 
 =cut
 

+

 package RT::ScripAction;
 package RT::ScripAction;

-use RT::Record;
-@ISA= qw(RT::Record);
-
-# {{{  sub _Init 
-sub _Init  {
-    my $self = shift; 
-    $self->{'table'} = "ScripActions";
-    return ($self->SUPER::_Init(@_));
-}
-# }}}

 
 

-# {{{ sub _Accessible 
+use strict;
+use warnings;
+
+use base 'RT::Record';
+
+sub Table {'ScripActions'}
+
+
+
+use RT::Template;
+

 sub _Accessible  {
     my $self = shift;
     my %Cols = ( Name  => 'read',
 sub _Accessible  {
     my $self = shift;
     my %Cols = ( Name  => 'read',


@@ -54,13 +93,13 @@ sub _Accessible  {
        );
     return($self->SUPER::_Accessible(@_, %Cols));
 }
        );
     return($self->SUPER::_Accessible(@_, %Cols));
 }

-# }}}

 
 

-# {{{ sub Create 
+

 =head2 Create
 =head2 Create

-  
- Takes a hash. Creates a new Action entry.
- should be better documented.
+
+Takes a hash. Creates a new Action entry.  should be better
+documented.
+

 =cut
 
 sub Create  {
 =cut
 
 sub Create  {


@@ -68,30 +107,36 @@ sub Create  {
     #TODO check these args and do smart things.
     return($self->SUPER::Create(@_));
 }
     #TODO check these args and do smart things.
     return($self->SUPER::Create(@_));
 }

-# }}}

 
 

-# {{{ sub Delete 

 sub Delete  {
     my $self = shift;
     
     return (0, "ScripAction->Delete not implemented");
 }
 sub Delete  {
     my $self = shift;
     
     return (0, "ScripAction->Delete not implemented");
 }

-# }}}

 
 

-# {{{ sub Load 
+
+=head2 Load IDENTIFIER
+
+Loads an action by its Name.
+
+Returns: Id, Error Message
+
+=cut
+

 sub Load  {
     my $self = shift;
     my $identifier = shift;
     
     if (!$identifier) {
 sub Load  {
     my $self = shift;
     my $identifier = shift;
     
     if (!$identifier) {

-       return (0, 'Input error');
+       return (0, $self->loc('Input error'));

     }      
     
     }      
     

+    my ($ok, $msg);

     if ($identifier !~ /\D/) {
     if ($identifier !~ /\D/) {

-       $self->SUPER::LoadById($identifier);
+       ($ok, $msg) = $self->SUPER::Load($identifier);

     }
     else {
     }
     else {

-       $self->LoadByCol('Name', $identifier);
+       ($ok, $msg) = $self->LoadByCol('Name', $identifier);

        
     }
 
        
     }
 


@@ -101,11 +146,10 @@ sub Load  {
        
        $self->{'Template'} = $template;
     }
        
        $self->{'Template'} = $template;
     }

-    return ($self->Id, 'ScripAction loaded');
+
+    return ($ok, $msg);

 }
 }

-# }}}

 
 

-# {{{ sub LoadAction 

 
 =head2 LoadAction HASH
 
 
 =head2 LoadAction HASH
 


@@ -118,83 +162,255 @@ sub LoadAction  {
     my %args = ( TransactionObj => undef,
                 TicketObj => undef,
                 @_ );
     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;
  
     
     #TODO: Put this in an eval  
     $self->ExecModule =~ /^(\w+)$/;
     my $module = $1;
     my $type = "RT::Action::". $module;
  

-    $RT::Logger->debug("now requiring $type\n"); 

     eval "require $type" || die "Require of $type failed.\n$@\n";
     
     eval "require $type" || die "Require of $type failed.\n$@\n";
     

-    $self->{'Action'}  = $type->new ( 'ScripActionObj' => $self, 
-                                     'TicketObj' => $args{'TicketObj'},
-                                     'TransactionObj' => $args{'TransactionObj'},
-                                     'TemplateObj' => $self->TemplateObj,
-                                     'Argument' => $self->Argument,
+    $self->{'Action'}  = $type->new ( Argument => $self->Argument,
+                                      CurrentUser => $self->CurrentUser,
+                                      ScripActionObj => $self, 
+                                      ScripObj => $args{'ScripObj'},
+                                      TemplateObj => $self->TemplateObj,
+                                      TicketObj => $args{'TicketObj'},
+                                      TransactionObj => $args{'TransactionObj'},

                                    );
 }
                                    );
 }

-# }}}

 
 

-# {{{ sub TemplateObj

 
 =head2 TemplateObj
 
 
 =head2 TemplateObj
 

-Return this action\'s template object
+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};
 
 =cut
 
 sub TemplateObj {
     my $self = shift;
     return undef unless $self->{Template};

-    if (!$self->{'TemplateObj'})  {
-       require RT::Template;
-       $self->{'TemplateObj'} = RT::Template->new($self->CurrentUser);
-       $self->{'TemplateObj'}->LoadById($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'});
+
+    return ( $self->{'TemplateObj'} );

 }
 }

-# }}}

 
 # The following methods call the action object
 
 
 # The following methods call the action object
 

-# {{{ sub Prepare 

 
 sub Prepare  {
     my $self = shift;
 
 sub Prepare  {
     my $self = shift;

-    return ($self->{'Action'}->Prepare());
+    $self->{_Message_ID} = 0;
+    return ($self->Action->Prepare());

   
 }
   
 }

-# }}}

 
 

-# {{{ sub Commit 

 sub Commit  {
     my $self = shift;
 sub Commit  {
     my $self = shift;

-    return($self->{'Action'}->Commit());
+    return($self->Action->Commit());

     
     
 }
     
     
 }

-# }}}

 
 

-# {{{ sub Describe 

 sub Describe  {
     my $self = shift;
 sub Describe  {
     my $self = shift;

-    return ($self->{'Action'}->Describe());
+    return ($self->Action->Describe());

     
 }
     
 }

-# }}}

 
 

-# {{{ sub DESTROY
+=head2 Action
+
+Return the actual RT::Action object for this scrip.
+
+=cut
+
+sub Action {
+    my $self = shift;
+    return ($self->{'Action'});
+}
+

 sub DESTROY {
     my $self=shift;
 sub DESTROY {
     my $self=shift;

+    $self->{'_TicketObj'} = undef;

     $self->{'Action'} = undef;
     $self->{'TemplateObj'} = undef;
 }
     $self->{'Action'} = undef;
     $self->{'TemplateObj'} = undef;
 }

-# }}}

 
 

+=head2 TODO

 
 

-1;
+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
+
+
+=head2 Name
+
+Returns the current value of Name.
+(In the database, Name is stored as varchar(200).)
+
+
+
+=head2 SetName 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).)
+
+
+=cut
+
+
+=head2 Description
+
+Returns the current value of Description.
+(In the database, Description is stored as varchar(255).)

 
 
 
 

+
+=head2 SetDescription 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).)
+
+
+=cut
+
+
+=head2 ExecModule
+
+Returns the current value of ExecModule.
+(In the database, ExecModule is stored as varchar(60).)
+
+
+
+=head2 SetExecModule 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).)
+
+
+=cut
+
+
+=head2 Argument
+
+Returns the current value of Argument.
+(In the database, Argument is stored as varbinary(255).)
+
+
+
+=head2 SetArgument 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 varbinary(255).)
+
+
+=cut
+
+
+=head2 Creator
+
+Returns the current value of Creator.
+(In the database, Creator is stored as int(11).)
+
+
+=cut
+
+
+=head2 Created
+
+Returns the current value of Created.
+(In the database, Created is stored as datetime.)
+
+
+=cut
+
+
+=head2 LastUpdatedBy
+
+Returns the current value of LastUpdatedBy.
+(In the database, LastUpdatedBy is stored as int(11).)
+
+
+=cut
+
+
+=head2 LastUpdated
+
+Returns the current value of LastUpdated.
+(In the database, LastUpdated is stored as datetime.)
+
+
+=cut
+
+
+
+sub _CoreAccessible {
+    {
+
+        id =>
+               {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 => ''},
+
+ }
+};
+
+RT::Base->_ImportOverlays();
+
+1;