X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FScrip.pm;h=48547ccfd2316e2bc3590037fd93e90dfc11d206;hp=a69dde04e704ba4b9d9f0792b2d96e200795b895;hb=7322f2afedcc2f427e997d1535a503613a83f088;hpb=0fb307c305e4bc2c9c27dc25a3308beae3a4d33c

diff --git a/rt/lib/RT/Scrip.pm b/rt/lib/RT/Scrip.pm
index a69dde04e..48547ccfd 100755
--- a/rt/lib/RT/Scrip.pm
+++ b/rt/lib/RT/Scrip.pm
@@ -1,418 +1,1070 @@
-# 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-2016 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::Scrip
-
+  RT::Scrip - an RT Scrip object
 
 =head1 SYNOPSIS
 
+  use RT::Scrip;
+
 =head1 DESCRIPTION
 
+
 =head1 METHODS
 
+
 =cut
 
+
 package RT::Scrip;
-use RT::Record; 
+
+use strict;
+use warnings;
+use base 'RT::Record';
+
 use RT::Queue;
 use RT::Template;
 use RT::ScripCondition;
 use RT::ScripAction;
+use RT::Scrips;
+use RT::ObjectScrip;
+
+sub Table {'Scrips'}
+
+# {{{ sub Create
 
+=head2 Create
 
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+Creates a new entry in the Scrips table. Takes a paramhash with:
 
-sub _Init {
-  my $self = shift; 
+        Queue                  => 0,
+        Description            => undef,
+        Template               => undef,
+        ScripAction            => undef,
+        ScripCondition         => undef,
+        CustomPrepareCode      => undef,
+        CustomCommitCode       => undef,
+        CustomIsApplicableCode => undef,
 
-  $self->Table('Scrips');
-  $self->SUPER::_Init(@_);
+
+
+
+Returns (retval, msg);
+retval is 0 for failure or scrip id.  msg is a textual description of what happened.
+
+=cut
+
+sub Create {
+    my $self = shift;
+    my %args = (
+        Queue                  => 0,
+        Template               => undef,                 # name or id
+        ScripAction            => 0,                     # name or id
+        ScripCondition         => 0,                     # name or id
+        Stage                  => 'TransactionCreate',
+        Description            => undef,
+        CustomPrepareCode      => undef,
+        CustomCommitCode       => undef,
+        CustomIsApplicableCode => undef,
+        @_
+    );
+
+    if ($args{CustomPrepareCode} || $args{CustomCommitCode} || $args{CustomIsApplicableCode}) {
+        unless ( $self->CurrentUser->HasRight( Object => $RT::System,
+                                               Right  => 'ExecuteCode' ) )
+        {
+            return ( 0, $self->loc('Permission Denied') );
+        }
+    }
+
+    unless ( $args{'Queue'} ) {
+        unless ( $self->CurrentUser->HasRight( Object => $RT::System,
+                                               Right  => 'ModifyScrips' ) )
+        {
+            return ( 0, $self->loc('Permission Denied') );
+        }
+        $args{'Queue'} = 0;    # avoid undef sneaking in
+    }
+    else {
+        my $QueueObj = RT::Queue->new( $self->CurrentUser );
+        $QueueObj->Load( $args{'Queue'} );
+        unless ( $QueueObj->id ) {
+            return ( 0, $self->loc('Invalid queue') );
+        }
+        unless ( $QueueObj->CurrentUserHasRight('ModifyScrips') ) {
+            return ( 0, $self->loc('Permission Denied') );
+        }
+        $args{'Queue'} = $QueueObj->id;
+    }
+
+    #TODO +++ validate input
+
+    return ( 0, $self->loc("Action is mandatory argument") )
+        unless $args{'ScripAction'};
+    my $action = RT::ScripAction->new( $self->CurrentUser );
+    $action->Load( $args{'ScripAction'} );
+    return ( 0, $self->loc( "Action '[_1]' not found", $args{'ScripAction'} ) ) 
+        unless $action->Id;
+
+    return ( 0, $self->loc("Template is mandatory argument") )
+        unless $args{'Template'};
+    my $template = RT::Template->new( $self->CurrentUser );
+    if ( $args{'Template'} =~ /\D/ ) {
+        $template->LoadByName( Name => $args{'Template'}, Queue => $args{'Queue'} );
+        return ( 0, $self->loc( "Global template '[_1]' not found", $args{'Template'} ) )
+            if !$template->Id && !$args{'Queue'};
+        return ( 0, $self->loc( "Global or queue specific template '[_1]' not found", $args{'Template'} ) )
+            if !$template->Id;
+    } else {
+        $template->Load( $args{'Template'} );
+        return ( 0, $self->loc( "Template '[_1]' not found", $args{'Template'} ) )
+            unless $template->Id;
+
+        return (0, $self->loc( "Template '[_1]' is not global" ))
+            if !$args{'Queue'} && $template->Queue;
+        return (0, $self->loc( "Template '[_1]' is not global nor queue specific" ))
+            if $args{'Queue'} && $template->Queue && $template->Queue != $args{'Queue'};
+    }
+
+    return ( 0, $self->loc("Condition is mandatory argument") )
+        unless $args{'ScripCondition'};
+    my $condition = RT::ScripCondition->new( $self->CurrentUser );
+    $condition->Load( $args{'ScripCondition'} );
+    return ( 0, $self->loc( "Condition '[_1]' not found", $args{'ScripCondition'} ) )
+        unless $condition->Id;
+
+    if ( $args{'Stage'} eq 'Disabled' ) {
+        $RT::Logger->warning("Disabled Stage is deprecated");
+        $args{'Stage'} = 'TransactionCreate';
+        $args{'Disabled'} = 1;
+    }
+    $args{'Disabled'} ||= 0;
+
+    my ( $id, $msg ) = $self->SUPER::Create(
+        Template               => $template->Name,
+        ScripCondition         => $condition->id,
+        ScripAction            => $action->Id,
+        Disabled               => $args{'Disabled'},
+        Description            => $args{'Description'},
+        CustomPrepareCode      => $args{'CustomPrepareCode'},
+        CustomCommitCode       => $args{'CustomCommitCode'},
+        CustomIsApplicableCode => $args{'CustomIsApplicableCode'},
+    );
+    return ( $id, $msg ) unless $id;
+
+    (my $status, $msg) = RT::ObjectScrip->new( $self->CurrentUser )->Add(
+        Scrip    => $self,
+        Stage    => $args{'Stage'},
+        ObjectId => $args{'Queue'},
+    );
+    $RT::Logger->error( "Couldn't add scrip: $msg" ) unless $status;
+
+    return ( $id, $self->loc('Scrip Created') );
 }
 
 
 
+=head2 Delete
+
+Delete this object
+
+=cut
+
+sub Delete {
+    my $self = shift;
+
+    unless ( $self->CurrentUserHasRight('ModifyScrips') ) {
+        return ( 0, $self->loc('Permission Denied') );
+    }
+
+    RT::ObjectScrip->new( $self->CurrentUser )->DeleteAll( Scrip => $self );
+
+    return ( $self->SUPER::Delete(@_) );
+}
+
+sub IsGlobal { return shift->IsAdded(0) }
+
+sub IsAdded {
+    my $self = shift;
+    my $record = RT::ObjectScrip->new( $self->CurrentUser );
+    $record->LoadByCols( Scrip => $self->id, ObjectId => shift || 0 );
+    return undef unless $record->id;
+    return $record;
+}
+
+sub IsAddedToAny {
+    my $self = shift;
+    my $record = RT::ObjectScrip->new( $self->CurrentUser );
+    $record->LoadByCols( Scrip => $self->id );
+    return $record->id ? 1 : 0;
+}
+
+sub AddedTo {
+    my $self = shift;
+    return RT::ObjectScrip->new( $self->CurrentUser )
+        ->AddedTo( Scrip => $self );
+}
+
+sub NotAddedTo {
+    my $self = shift;
+    return RT::ObjectScrip->new( $self->CurrentUser )
+        ->NotAddedTo( Scrip => $self );
+}
+
+=head2 AddToObject
+
+Adds (applies) the current scrip to the provided queue (ObjectId).
+
+Accepts a param hash of:
+
+=over
+
+=item C<ObjectId>
+
+Queue name or id. 0 makes the scrip global.
+
+=item C<Stage>
+
+Stage to run in. Valid stages are TransactionCreate or
+TransactionBatch. Defaults to TransactionCreate. As of RT 4.2, Disabled
+is no longer a stage.
+
+=item C<Template>
+
+Name of global or queue-specific template for the scrip. Use 'Blank' for
+non-notification scrips.
 
+=item C<SortOrder>
 
-=item Create PARAMHASH
+Number indicating the relative order the scrip should run in.
 
-Create takes a hash of values and creates a row in the database:
+=back
 
-  varchar(255) 'Description'.
-  int(11) 'ScripCondition'.
-  int(11) 'ScripAction'.
-  text 'ConditionRules'.
-  text 'ActionRules'.
-  text 'CustomIsApplicableCode'.
-  text 'CustomPrepareCode'.
-  text 'CustomCommitCode'.
-  varchar(32) 'Stage'.
-  int(11) 'Queue'.
-  int(11) 'Template'.
+Returns (val, message). If val is false, the message contains an error
+message.
 
 =cut
 
+sub AddToObject {
+    my $self = shift;
+    my %args = @_%2? (ObjectId => @_) : (@_);
+
+    # Default Stage explicitly rather than in %args assignment to handle
+    # Stage coming in set to undef.
+    $args{'Stage'} //= 'TransactionCreate';
+
+    my $queue;
+    if ( $args{'ObjectId'} ) {
+        $queue = RT::Queue->new( $self->CurrentUser );
+        $queue->Load( $args{'ObjectId'} );
+        return (0, $self->loc('Invalid queue'))
+            unless $queue->id;
+
+        $args{'ObjectId'} = $queue->id;
+    }
+    return ( 0, $self->loc('Permission Denied') )
+        unless $self->CurrentUser->PrincipalObj->HasRight(
+            Object => $queue || $RT::System, Right => 'ModifyScrips',
+        )
+    ;
+
+    my $tname = $self->Template;
+    my $template = RT::Template->new( $self->CurrentUser );
+    $template->LoadByName( Queue => $queue? $queue->id : 0, Name => $tname );
+    unless ( $template->id ) {
+        if ( $queue ) {
+            return (0, $self->loc('No template [_1] in queue [_2] or global',
+                    $tname, $queue->Name||$queue->id));
+        } else {
+            return (0, $self->loc('No global template [_1]', $tname));
+        }
+    }
+
+    my $rec = RT::ObjectScrip->new( $self->CurrentUser );
+    return $rec->Add( %args, Scrip => $self );
+}
 
+=head2 RemoveFromObject
 
+Removes the current scrip to the provided queue (ObjectId).
 
-sub Create {
+Accepts a param hash of:
+
+=over
+
+=item C<ObjectId>
+
+Queue name or id. 0 makes the scrip global.
+
+=back
+
+Returns (val, message). If val is false, the message contains an error
+message.
+
+=cut
+
+sub RemoveFromObject {
+    my $self = shift;
+    my %args = @_%2? (ObjectId => @_) : (@_);
+
+    my $queue;
+    if ( $args{'ObjectId'} ) {
+        $queue = RT::Queue->new( $self->CurrentUser );
+        $queue->Load( $args{'ObjectId'} );
+        return (0, $self->loc('Invalid queue id'))
+            unless $queue->id;
+    }
+    return ( 0, $self->loc('Permission Denied') )
+        unless $self->CurrentUser->PrincipalObj->HasRight(
+            Object => $queue || $RT::System, Right => 'ModifyScrips',
+        )
+    ;
+
+    my $rec = RT::ObjectScrip->new( $self->CurrentUser );
+    $rec->LoadByCols( Scrip => $self->id, ObjectId => $args{'ObjectId'} );
+    return (0, $self->loc('Scrip is not added') ) unless $rec->id;
+    return $rec->Delete;
+}
+
+=head2 ActionObj
+
+Retuns an RT::Action object with this Scrip's Action
+
+=cut
+
+sub ActionObj {
     my $self = shift;
-    my %args = ( 
-                Description => '',
-                ScripCondition => '0',
-                ScripAction => '0',
-                ConditionRules => '',
-                ActionRules => '',
-                CustomIsApplicableCode => '',
-                CustomPrepareCode => '',
-                CustomCommitCode => '',
-                Stage => '',
-                Queue => '0',
-                Template => '0',
-
-		  @_);
-    $self->SUPER::Create(
-                         Description => $args{'Description'},
-                         ScripCondition => $args{'ScripCondition'},
-                         ScripAction => $args{'ScripAction'},
-                         ConditionRules => $args{'ConditionRules'},
-                         ActionRules => $args{'ActionRules'},
-                         CustomIsApplicableCode => $args{'CustomIsApplicableCode'},
-                         CustomPrepareCode => $args{'CustomPrepareCode'},
-                         CustomCommitCode => $args{'CustomCommitCode'},
-                         Stage => $args{'Stage'},
-                         Queue => $args{'Queue'},
-                         Template => $args{'Template'},
-);
 
+    unless ( defined $self->{'ScripActionObj'} ) {
+        require RT::ScripAction;
+        $self->{'ScripActionObj'} = RT::ScripAction->new( $self->CurrentUser );
+        $self->{'ScripActionObj'}->Load( $self->ScripAction );
+    }
+    return ( $self->{'ScripActionObj'} );
 }
 
 
 
-=item id
+=head2 ConditionObj
+
+Retuns an L<RT::ScripCondition> object with this Scrip's IsApplicable
+
+=cut
+
+sub ConditionObj {
+    my $self = shift;
+
+    my $res = RT::ScripCondition->new( $self->CurrentUser );
+    $res->Load( $self->ScripCondition );
+    return $res;
+}
 
-Returns the current value of id. 
-(In the database, id is stored as int(11).)
 
+=head2 LoadModules
+
+Loads scrip's condition and action modules.
 
 =cut
 
+sub LoadModules {
+    my $self = shift;
+
+    $self->ConditionObj->LoadCondition;
+    $self->ActionObj->LoadAction;
+}
 
-=item Description
 
-Returns the current value of Description. 
-(In the database, Description is stored as varchar(255).)
+=head2 TemplateObj
 
+Retuns an RT::Template object with this Scrip's Template
 
+=cut
 
-=item SetDescription VALUE
+sub TemplateObj {
+    my $self = shift;
+    my $queue = shift;
 
+    my $res = RT::Template->new( $self->CurrentUser );
+    $res->LoadByName( Queue => $queue, Name => $self->Template );
+    return $res;
+}
 
-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 Stage
 
+Takes TicketObj named argument and returns scrip's stage when
+added to ticket's queue.
 
 =cut
 
+sub Stage {
+    my $self = shift;
+    my %args = ( TicketObj => undef, @_ );
+
+    my $queue = $args{'TicketObj'}->Queue;
+    my $rec = RT::ObjectScrip->new( $self->CurrentUser );
+    $rec->LoadByCols( Scrip => $self->id, ObjectId => $queue );
+    return $rec->Stage if $rec->id;
 
-=item ScripCondition
+    $rec->LoadByCols( Scrip => $self->id, ObjectId => 0 );
+    return $rec->Stage if $rec->id;
 
-Returns the current value of ScripCondition. 
-(In the database, ScripCondition is stored as int(11).)
+    return undef;
+}
 
+=head2 FriendlyStage($Stage)
 
+Helper function that returns a localized human-readable version of the
+C<$Stage> argument.
 
-=item SetScripCondition VALUE
+=cut
 
+sub FriendlyStage {
+    my ( $class, $stage ) = @_;
+    my $stage_i18n_lookup = {
+        TransactionCreate => 'Normal', # loc
+        TransactionBatch => 'Batch', # loc
+        TransactionBatchDisabled => 'Batch (disabled by config)', # loc
+    };
+    $stage = 'TransactionBatchDisabled'
+        if $stage eq 'TransactionBatch'
+            and not RT->Config->Get('UseTransactionBatch');
+    return $stage_i18n_lookup->{$stage};
+}
 
-Set ScripCondition to VALUE. 
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, ScripCondition will be stored as a int(11).)
+=head2 Apply { TicketObj => undef, TransactionObj => undef}
+
+This method instantiates the ScripCondition and ScripAction objects for a
+single execution of this scrip. it then calls the IsApplicable method of the 
+ScripCondition.
+If that succeeds, it calls the Prepare method of the
+ScripAction. If that succeeds, it calls the Commit method of the ScripAction.
 
+Usually, the ticket and transaction objects passed to this method
+should be loaded by the SuperUser role
 
 =cut
 
 
-=item ScripConditionObj
+# XXX TODO : This code appears to be obsoleted in favor of similar code in Scrips->Apply.
+# Why is this here? Is it still called?
 
-Returns the ScripCondition Object which has the id returned by ScripCondition
+sub Apply {
+    my $self = shift;
+    my %args = ( TicketObj      => undef,
+                 TransactionObj => undef,
+                 @_ );
+
+    $RT::Logger->debug("Now applying scrip ".$self->Id . " for transaction ".$args{'TransactionObj'}->id);
+
+    my $ApplicableTransactionObj = $self->IsApplicable( TicketObj      => $args{'TicketObj'},
+                                                        TransactionObj => $args{'TransactionObj'} );
+    unless ( $ApplicableTransactionObj ) {
+        return undef;
+    }
+
+    if ( $ApplicableTransactionObj->id != $args{'TransactionObj'}->id ) {
+        $RT::Logger->debug("Found an applicable transaction ".$ApplicableTransactionObj->Id . " in the same batch with transaction ".$args{'TransactionObj'}->id);
+    }
+
+    #If it's applicable, prepare and commit it
+    $RT::Logger->debug("Now preparing scrip ".$self->Id . " for transaction ".$ApplicableTransactionObj->id);
+    unless ( $self->Prepare( TicketObj      => $args{'TicketObj'},
+                             TransactionObj => $ApplicableTransactionObj )
+      ) {
+        return undef;
+    }
+
+    $RT::Logger->debug("Now commiting scrip ".$self->Id . " for transaction ".$ApplicableTransactionObj->id);
+    unless ( $self->Commit( TicketObj => $args{'TicketObj'},
+                            TransactionObj => $ApplicableTransactionObj)
+      ) {
+        return undef;
+    }
+
+    $RT::Logger->debug("We actually finished scrip ".$self->Id . " for transaction ".$ApplicableTransactionObj->id);
+    return (1);
 
+}
+
+
+
+=head2 IsApplicable
+
+Calls the  Condition object's IsApplicable method
+
+Upon success, returns the applicable Transaction object.
+Otherwise, undef is returned.
+
+If the Scrip is in the TransactionCreate Stage (the usual case), only test
+the associated Transaction object to see if it is applicable.
+
+For Scrips in the TransactionBatch Stage, test all Transaction objects
+created during the Ticket object's lifetime, and returns the first one
+that is applicable.
 
 =cut
 
-sub ScripConditionObj {
-	my $self = shift;
-	my $ScripCondition =  RT::ScripCondition->new($self->CurrentUser);
-	$ScripCondition->Load($self->__Value('ScripCondition'));
-	return($ScripCondition);
+sub IsApplicable {
+    my $self = shift;
+    my %args = ( TicketObj      => undef,
+                 TransactionObj => undef,
+                 @_ );
+
+    my $return;
+    eval {
+
+        my @Transactions;
+
+        my $stage = $self->Stage( TicketObj => $args{'TicketObj'} );
+        unless ( $stage ) {
+            $RT::Logger->error(
+                "Scrip #". $self->id ." is not applied to"
+                ." queue #". $args{'TicketObj'}->Queue
+            );
+            return (undef);
+        }
+        elsif ( $stage eq 'TransactionCreate') {
+            # Only look at our current Transaction
+            @Transactions = ( $args{'TransactionObj'} );
+        }
+        elsif ( $stage eq 'TransactionBatch') {
+            # Look at all Transactions in this Batch
+            @Transactions = @{ $args{'TicketObj'}->TransactionBatch || [] };
+        }
+        else {
+            $RT::Logger->error( "Unknown Scrip stage: '$stage'" );
+            return (undef);
+        }
+        my $ConditionObj = $self->ConditionObj;
+        foreach my $TransactionObj ( @Transactions ) {
+            # in TxnBatch stage we can select scrips that are not applicable to all txns
+            my $txn_type = $TransactionObj->Type;
+            next unless( $ConditionObj->ApplicableTransTypes =~ /(?:^|,)(?:Any|\Q$txn_type\E)(?:,|$)/i );
+            # Load the scrip's Condition object
+            $ConditionObj->LoadCondition(
+                ScripObj       => $self,
+                TicketObj      => $args{'TicketObj'},
+                TransactionObj => $TransactionObj,
+            );
+
+            if ( $ConditionObj->IsApplicable() ) {
+                # We found an application Transaction -- return it
+                $return = $TransactionObj;
+                last;
+            }
+        }
+    };
+
+    if ($@) {
+        $RT::Logger->error( "Scrip IsApplicable " . $self->Id . " died. - " . $@ );
+        return (undef);
+    }
+
+            return ($return);
+
 }
 
-=item ScripAction
 
-Returns the current value of ScripAction. 
-(In the database, ScripAction is stored as int(11).)
 
+=head2 Prepare
 
+Calls the action object's prepare method
 
-=item SetScripAction VALUE
+=cut
 
+sub Prepare {
+    my $self = shift;
+    my %args = ( TicketObj      => undef,
+                 TransactionObj => undef,
+                 @_ );
+
+    my $return;
+    eval {
+        $self->ActionObj->LoadAction(
+            ScripObj       => $self,
+            TicketObj      => $args{'TicketObj'},
+            TransactionObj => $args{'TransactionObj'},
+            TemplateObj    => $self->TemplateObj( $args{'TicketObj'}->Queue ),
+        );
+
+        $return = $self->ActionObj->Prepare();
+    };
+    if ($@) {
+        $RT::Logger->error( "Scrip Prepare " . $self->Id . " died. - " . $@ );
+        return (undef);
+    }
+        unless ($return) {
+        }
+        return ($return);
+}
 
-Set ScripAction to VALUE. 
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, ScripAction will be stored as a int(11).)
 
 
+=head2 Commit
+
+Calls the action object's commit method
+
 =cut
 
+sub Commit {
+    my $self = shift;
+    my %args = ( TicketObj      => undef,
+                 TransactionObj => undef,
+                 @_ );
 
-=item ScripActionObj
+    my $return;
+    eval {
+        $return = $self->ActionObj->Commit();
+    };
 
-Returns the ScripAction Object which has the id returned by ScripAction
+#Searchbuilder caching isn't perfectly coherent. got to reload the ticket object, since it
+# may have changed
+    $args{'TicketObj'}->Load( $args{'TicketObj'}->Id );
+
+    if ($@) {
+        $RT::Logger->error( "Scrip Commit " . $self->Id . " died. - " . $@ );
+        return (undef);
+    }
+
+    # Not destroying or weakening hte Action and Condition here could cause a
+    # leak
+
+    return ($return);
+}
 
 
+
+
+
+# does an acl check and then passes off the call
+sub _Set {
+    my $self = shift;
+    my %args = (
+        Field => undef,
+        Value => undef,
+        @_,
+    );
+
+    unless ( $self->CurrentUserHasRight('ModifyScrips') ) {
+        $RT::Logger->debug( "CurrentUser can't modify Scrips" );
+        return ( 0, $self->loc('Permission Denied') );
+    }
+
+
+    if (exists $args{Value}) {
+        if ($args{Field} eq 'CustomIsApplicableCode' || $args{Field} eq 'CustomPrepareCode' || $args{Field} eq 'CustomCommitCode') {
+            unless ( $self->CurrentUser->HasRight( Object => $RT::System,
+                                                   Right  => 'ExecuteCode' ) ) {
+                return ( 0, $self->loc('Permission Denied') );
+            }
+        }
+        elsif ($args{Field} eq 'Queue') {
+            if ($args{Value}) {
+                # moving to another queue
+                my $queue = RT::Queue->new( $self->CurrentUser );
+                $queue->Load($args{Value});
+                unless ($queue->Id and $queue->CurrentUserHasRight('ModifyScrips')) {
+                    return ( 0, $self->loc('Permission Denied') );
+                }
+            } else {
+                # moving to global
+                unless ($self->CurrentUser->HasRight( Object => RT->System, Right => 'ModifyScrips' )) {
+                    return ( 0, $self->loc('Permission Denied') );
+                }
+            }
+        }
+        elsif ($args{Field} eq 'Template') {
+            my $template = RT::Template->new( $self->CurrentUser );
+            $template->Load($args{Value});
+            unless ($template->Id and $template->CurrentUserCanRead) {
+                return ( 0, $self->loc('Permission Denied') );
+            }
+        }
+    }
+
+    return $self->SUPER::_Set(@_);
+}
+
+
+# does an acl check and then passes off the call
+sub _Value {
+    my $self = shift;
+
+    return unless $self->CurrentUserHasRight('ShowScrips');
+
+    return $self->__Value(@_);
+}
+
+=head2 ACLEquivalenceObjects
+
+Having rights on any of the queues the scrip applies to is equivalent to
+having rights on the scrip.
+
 =cut
 
-sub ScripActionObj {
-	my $self = shift;
-	my $ScripAction =  RT::ScripAction->new($self->CurrentUser);
-	$ScripAction->Load($self->__Value('ScripAction'));
-	return($ScripAction);
+sub ACLEquivalenceObjects {
+    my $self = shift;
+    return unless $self->id;
+    return @{ $self->AddedTo->ItemsArrayRef };
 }
 
-=item ConditionRules
 
-Returns the current value of ConditionRules. 
-(In the database, ConditionRules is stored as text.)
 
+=head2 CompileCheck
 
+This routine compile-checks the custom prepare, commit, and is-applicable code
+to see if they are syntactically valid Perl. We eval them in a codeblock to
+avoid actually executing the code.
 
-=item SetConditionRules VALUE
+If one of the fields has a compile error, only the first is reported.
 
+Returns an (ok, message) pair.
 
-Set ConditionRules to VALUE. 
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, ConditionRules will be stored as a text.)
+=cut
+
+sub CompileCheck {
+    my $self = shift;
 
+    for my $method (qw/CustomPrepareCode CustomCommitCode CustomIsApplicableCode/) {
+        my $code = $self->$method;
+        next if !defined($code);
+
+        do {
+            no strict 'vars';
+            eval "sub { $code \n }";
+        };
+        next if !$@;
+
+        my $error = $@;
+        return (0, $self->loc("Couldn't compile [_1] codeblock '[_2]': [_3]", $method, $code, $error));
+    }
+}
+
+
+=head2 SetScripAction
 
 =cut
 
+sub SetScripAction {
+    my $self  = shift;
+    my $value = shift;
+
+    return ( 0, $self->loc("Action is mandatory argument") ) unless $value;
+
+    require RT::ScripAction;
+    my $action = RT::ScripAction->new( $self->CurrentUser );
+    $action->Load($value);
+    return ( 0, $self->loc( "Action '[_1]' not found", $value ) )
+      unless $action->Id;
 
-=item ActionRules
+    return $self->_Set( Field => 'ScripAction', Value => $action->Id );
+}
+
+=head2 SetScripCondition
 
-Returns the current value of ActionRules. 
-(In the database, ActionRules is stored as text.)
+=cut
 
+sub SetScripCondition {
+    my $self  = shift;
+    my $value = shift;
 
+    return ( 0, $self->loc("Condition is mandatory argument") )
+      unless $value;
 
-=item SetActionRules VALUE
+    require RT::ScripCondition;
+    my $condition = RT::ScripCondition->new( $self->CurrentUser );
+    $condition->Load($value);
 
+    return ( 0, $self->loc( "Condition '[_1]' not found", $value ) )
+      unless $condition->Id;
 
-Set ActionRules to VALUE. 
-Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, ActionRules will be stored as a text.)
+    return $self->_Set( Field => 'ScripCondition', Value => $condition->Id );
+}
 
+=head2 SetTemplate
 
 =cut
 
+sub SetTemplate {
+    my $self  = shift;
+    my $value = shift;
+
+    return ( 0, $self->loc("Template is mandatory argument") ) unless $value;
+
+    require RT::Template;
+    my $template = RT::Template->new( $self->CurrentUser );
+    $template->Load($value);
+    return ( 0, $self->loc( "Template '[_1]' not found", $value ) )
+      unless $template->Id;
+
+    return $self->_Set( Field => 'Template', Value => $template->Name );
+}
+
+1;
 
-=item CustomIsApplicableCode
 
-Returns the current value of CustomIsApplicableCode. 
-(In the database, CustomIsApplicableCode is stored as text.)
 
 
 
-=item SetCustomIsApplicableCode VALUE
 
+=head2 id
 
-Set CustomIsApplicableCode to VALUE. 
+Returns the current value of id.
+(In the database, id is stored as int(11).)
+
+
+=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, CustomIsApplicableCode will be stored as a text.)
+(In the database, Description will be stored as a varchar(255).)
 
 
 =cut
 
 
-=item CustomPrepareCode
+=head2 ScripCondition
 
-Returns the current value of CustomPrepareCode. 
-(In the database, CustomPrepareCode is stored as text.)
+Returns the current value of ScripCondition.
+(In the database, ScripCondition is stored as int(11).)
 
 
 
-=item SetCustomPrepareCode VALUE
+=head2 SetScripCondition VALUE
 
 
-Set CustomPrepareCode to VALUE. 
+Set ScripCondition to VALUE.
 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, CustomPrepareCode will be stored as a text.)
+(In the database, ScripCondition will be stored as a int(11).)
 
 
 =cut
 
 
-=item CustomCommitCode
+=head2 ScripConditionObj
 
-Returns the current value of CustomCommitCode. 
-(In the database, CustomCommitCode is stored as text.)
+Returns the ScripCondition Object which has the id returned by ScripCondition
+
+
+=cut
+
+sub ScripConditionObj {
+        my $self = shift;
+        my $ScripCondition =  RT::ScripCondition->new($self->CurrentUser);
+        $ScripCondition->Load($self->__Value('ScripCondition'));
+        return($ScripCondition);
+}
+
+=head2 ScripAction
+
+Returns the current value of ScripAction.
+(In the database, ScripAction is stored as int(11).)
 
 
 
-=item SetCustomCommitCode VALUE
+=head2 SetScripAction VALUE
 
 
-Set CustomCommitCode to VALUE. 
+Set ScripAction to VALUE.
 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, CustomCommitCode will be stored as a text.)
+(In the database, ScripAction will be stored as a int(11).)
 
 
 =cut
 
 
-=item Stage
+=head2 ScripActionObj
 
-Returns the current value of Stage. 
-(In the database, Stage is stored as varchar(32).)
+Returns the ScripAction Object which has the id returned by ScripAction
+
+
+=cut
+
+sub ScripActionObj {
+        my $self = shift;
+        my $ScripAction =  RT::ScripAction->new($self->CurrentUser);
+        $ScripAction->Load($self->__Value('ScripAction'));
+        return($ScripAction);
+}
+
+=head2 CustomIsApplicableCode
+
+Returns the current value of CustomIsApplicableCode.
+(In the database, CustomIsApplicableCode is stored as text.)
 
 
 
-=item SetStage VALUE
+=head2 SetCustomIsApplicableCode VALUE
 
 
-Set Stage to VALUE. 
+Set CustomIsApplicableCode to VALUE.
 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Stage will be stored as a varchar(32).)
+(In the database, CustomIsApplicableCode will be stored as a text.)
 
 
 =cut
 
 
-=item Queue
+=head2 CustomPrepareCode
 
-Returns the current value of Queue. 
-(In the database, Queue is stored as int(11).)
+Returns the current value of CustomPrepareCode.
+(In the database, CustomPrepareCode is stored as text.)
 
 
 
-=item SetQueue VALUE
+=head2 SetCustomPrepareCode VALUE
 
 
-Set Queue to VALUE. 
+Set CustomPrepareCode to VALUE.
 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Queue will be stored as a int(11).)
+(In the database, CustomPrepareCode will be stored as a text.)
 
 
 =cut
 
 
-=item QueueObj
+=head2 CustomCommitCode
+
+Returns the current value of CustomCommitCode.
+(In the database, CustomCommitCode is stored as text.)
+
+
+
+=head2 SetCustomCommitCode VALUE
 
-Returns the Queue Object which has the id returned by Queue
+
+Set CustomCommitCode to VALUE.
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, CustomCommitCode will be stored as a text.)
 
 
 =cut
 
-sub QueueObj {
-	my $self = shift;
-	my $Queue =  RT::Queue->new($self->CurrentUser);
-	$Queue->Load($self->__Value('Queue'));
-	return($Queue);
-}
 
-=item Template
+=head2 Disabled
 
-Returns the current value of Template. 
-(In the database, Template is stored as int(11).)
+Returns the current value of Disabled.
+(In the database, Disabled is stored as smallint(6).)
 
 
 
-=item SetTemplate VALUE
+=head2 SetDisabled VALUE
 
 
-Set Template to VALUE. 
+Set Disabled to VALUE.
 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
-(In the database, Template will be stored as a int(11).)
+(In the database, Disabled will be stored as a smallint(6).)
 
 
 =cut
 
 
-=item TemplateObj
+=head2 Template
+
+Returns the current value of Template.
+(In the database, Template is stored as varchar(200).)
+
 
-Returns the Template Object which has the id returned by Template
+
+=head2 SetTemplate VALUE
+
+
+Set Template to VALUE.
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Template will be stored as a varchar(200).)
 
 
 =cut
 
-sub TemplateObj {
-	my $self = shift;
-	my $Template =  RT::Template->new($self->CurrentUser);
-	$Template->Load($self->__Value('Template'));
-	return($Template);
-}
 
-=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.)
 
 
@@ -420,81 +1072,89 @@ Returns the current value of LastUpdated.
 
 
 
-sub _ClassAccessible {
+sub _CoreAccessible {
     {
-     
+
         id =>
-		{read => 1, type => 'int(11)', default => ''},
-        Description => 
-		{read => 1, write => 1, type => 'varchar(255)', default => ''},
-        ScripCondition => 
-		{read => 1, write => 1, type => 'int(11)', default => '0'},
-        ScripAction => 
-		{read => 1, write => 1, type => 'int(11)', default => '0'},
-        ConditionRules => 
-		{read => 1, write => 1, type => 'text', default => ''},
-        ActionRules => 
-		{read => 1, write => 1, type => 'text', default => ''},
-        CustomIsApplicableCode => 
-		{read => 1, write => 1, type => 'text', default => ''},
-        CustomPrepareCode => 
-		{read => 1, write => 1, type => 'text', default => ''},
-        CustomCommitCode => 
-		{read => 1, write => 1, type => 'text', default => ''},
-        Stage => 
-		{read => 1, write => 1, type => 'varchar(32)', default => ''},
-        Queue => 
-		{read => 1, write => 1, type => 'int(11)', default => '0'},
-        Template => 
-		{read => 1, write => 1, type => 'int(11)', default => '0'},
-        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 => ''},
+        Description =>
+                {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
+        ScripCondition =>
+                {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        ScripAction =>
+                {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        CustomIsApplicableCode =>
+                {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'text', default => ''},
+        CustomPrepareCode =>
+                {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'text', default => ''},
+        CustomCommitCode =>
+                {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'text', default => ''},
+        Disabled =>
+                {read => 1, write => 1, sql_type => 5, length => 6,  is_blob => 0,  is_numeric => 1,  type => 'smallint(6)', default => '0'},
+        Template =>
+                {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => 'Blank'},
+        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 FindDependencies {
+    my $self = shift;
+    my ($walker, $deps) = @_;
 
-        eval "require RT::Scrip_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/Scrip_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::Scrip_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/Scrip_Vendor.pm}) {
-            die $@;
-        };
-
-        eval "require RT::Scrip_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/Scrip_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.  
+    $self->SUPER::FindDependencies($walker, $deps);
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+    my $applied = RT::ObjectScrips->new( $self->CurrentUser );
+    $applied->LimitToScrip( $self->id );
+    $deps->Add( in => $applied );
 
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
+    $deps->Add( out => $self->ScripConditionObj );
+    $deps->Add( out => $self->ScripActionObj );
+    $deps->Add( out => $self->TemplateObj );
+}
 
-   no warnings qw(redefine);
+sub __DependsOn {
+    my $self = shift;
+    my %args = (
+        Shredder => undef,
+        Dependencies => undef,
+        @_,
+    );
+    my $deps = $args{'Dependencies'};
+    my $list = [];
+
+    my $objs = RT::ObjectScrips->new( $self->CurrentUser );
+    $objs->LimitToScrip( $self->Id );
+    push @$list, $objs;
+
+    $deps->_PushDependencies(
+        BaseObject    => $self,
+        Flags         => RT::Shredder::Constants::DEPENDS_ON,
+        TargetObjects => $list,
+        Shredder      => $args{'Shredder'}
+    );
+
+    return $self->SUPER::__DependsOn( %args );
+}
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+sub Serialize {
+    my $self = shift;
+    my %args = (@_);
+    my %store = $self->SUPER::Serialize(@_);
 
-RT::Scrip_Overlay, RT::Scrip_Vendor, RT::Scrip_Local
+    # Store the string, not a reference to the object
+    $store{Template} = $self->Template;
 
-=cut
+    return %store;
+}
 
+RT::Base->_ImportOverlays();
 
 1;