X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FScrips_Overlay.pm;h=eecf2935277d6039516994cb1182725ece948486;hb=074464a707b2c8b83cc50cd0bb067660ef4d0f9f;hp=d201480846a71102c2d463aab1ed68ebc6a5d60d;hpb=5fc8c5edf574ab024d4646914b6432d458e2ffbd;p=freeside.git diff --git a/rt/lib/RT/Scrips_Overlay.pm b/rt/lib/RT/Scrips_Overlay.pm index d20148084..eecf29352 100644 --- a/rt/lib/RT/Scrips_Overlay.pm +++ b/rt/lib/RT/Scrips_Overlay.pm @@ -1,26 +1,51 @@ -# 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-2011 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 +# +# 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::Scrips - a collection of RT Scrip objects @@ -35,13 +60,11 @@ =head1 METHODS -=begin testing -ok (require RT::Scrips); +=cut -=end testing -=cut +package RT::Scrips; use strict; no warnings qw(redefine); @@ -129,40 +152,190 @@ sub Next { } # }}} +=head2 Apply + +Run through the relevant scrips. Scrips will run in order based on +description. (Most common use case is to prepend a number to the description, +forcing the scrips to run in ascending alphanumerical order.) + +=cut + sub Apply { - my ($self, %args) = @_; + my $self = shift; + + my %args = ( TicketObj => undef, + Ticket => undef, + Transaction => undef, + TransactionObj => undef, + Stage => undef, + Type => undef, + @_ ); + + $self->Prepare(%args); + $self->Commit(); + +} + +=head2 Commit + +Commit all of this object's prepared scrips + +=cut + +sub Commit { + my $self = shift; + + + foreach my $scrip (@{$self->Prepared}) { + $RT::Logger->debug( + "Committing scrip #". $scrip->id + ." on txn #". $self->{'TransactionObj'}->id + ." of ticket #". $self->{'TicketObj'}->id + ); + + $scrip->Commit( TicketObj => $self->{'TicketObj'}, + TransactionObj => $self->{'TransactionObj'} ); + } +} + + +=head2 Prepare + +Only prepare the scrips, returning an array of the scrips we're interested in +in order of preparation, not execution + +=cut + +sub Prepare { + my $self = shift; + my %args = ( TicketObj => undef, + Ticket => undef, + Transaction => undef, + TransactionObj => undef, + Stage => undef, + Type => undef, + @_ ); #We're really going to need a non-acled ticket for the scrips to work - my ($TicketObj, $TransactionObj); + $self->_SetupSourceObjects( TicketObj => $args{'TicketObj'}, + Ticket => $args{'Ticket'}, + TransactionObj => $args{'TransactionObj'}, + Transaction => $args{'Transaction'} ); + + + $self->_FindScrips( Stage => $args{'Stage'}, Type => $args{'Type'} ); + + + #Iterate through each script and check it's applicability. + while ( my $scrip = $self->Next() ) { + + unless ( $scrip->IsApplicable( + TicketObj => $self->{'TicketObj'}, + TransactionObj => $self->{'TransactionObj'} + ) ) { + $RT::Logger->debug("Skipping Scrip #".$scrip->Id." because it isn't applicable"); + next; + } + + #If it's applicable, prepare and commit it + unless ( $scrip->Prepare( TicketObj => $self->{'TicketObj'}, + TransactionObj => $self->{'TransactionObj'} + ) ) { + $RT::Logger->debug("Skipping Scrip #".$scrip->Id." because it didn't Prepare"); + next; + } + push @{$self->{'prepared_scrips'}}, $scrip; - if ( ($TicketObj = $args{'TicketObj'}) ) { - $TicketObj->CurrentUser($self->CurrentUser); + } + + return (@{$self->Prepared}); + +}; + +=head2 Prepared + +Returns an arrayref of the scrips this object has prepared + + +=cut + +sub Prepared { + my $self = shift; + return ($self->{'prepared_scrips'} || []); +} + + +# {{{ sup _SetupSourceObjects + +=head2 _SetupSourceObjects { TicketObj , Ticket, Transaction, TransactionObj } + +Setup a ticket and transaction for this Scrip collection to work with as it runs through the +relevant scrips. (Also to figure out which scrips apply) + +Returns: nothing + +=cut + + +sub _SetupSourceObjects { + + my $self = shift; + my %args = ( + TicketObj => undef, + Ticket => undef, + Transaction => undef, + TransactionObj => undef, + @_ ); + + + if ( $args{'TicketObj'} ) { + # clone the ticket here as we need to change CurrentUser + $self->{'TicketObj'} = bless { %{$args{'TicketObj'} } }, 'RT::Ticket'; + $self->{'TicketObj'}->CurrentUser( $self->CurrentUser ); } else { - $TicketObj = RT::Ticket->new($self->CurrentUser); - $TicketObj->Load( $args{'Ticket'} ) - || $RT::Logger->err("$self couldn't load ticket $args{'Ticket'}\n"); + $self->{'TicketObj'} = RT::Ticket->new( $self->CurrentUser ); + $self->{'TicketObj'}->Load( $args{'Ticket'} ) + || $RT::Logger->err("$self couldn't load ticket $args{'Ticket'}"); } - if ( ($TransactionObj = $args{'TransactionObj'}) ) { - $TransactionObj->CurrentUser($self->CurrentUser); + if ( ( $self->{'TransactionObj'} = $args{'TransactionObj'} ) ) { + $self->{'TransactionObj'}->CurrentUser( $self->CurrentUser ); } else { - $TransactionObj = RT::Transaction->new($self->CurrentUser); - $TransactionObj->Load( $args{'Transaction'} ) - || $RT::Logger->err("$self couldn't load transaction $args{'Transaction'}\n"); + $self->{'TransactionObj'} = RT::Transaction->new( $self->CurrentUser ); + $self->{'TransactionObj'}->Load( $args{'Transaction'} ) + || $RT::Logger->err( "$self couldn't load transaction $args{'Transaction'}"); } +} - # {{{ Deal with Scrips +# }}} - $self->LimitToQueue( $TicketObj->QueueObj->Id ) - ; #Limit it to $Ticket->QueueObj->Id - $self->LimitToGlobal() - unless $TicketObj->QueueObj->Disabled; # or to "global" +# {{{ sub _FindScrips; +=head2 _FindScrips - $self->Limit(FIELD => "Stage", VALUE => $args{'Stage'}); +Find only the apropriate scrips for whatever we're doing now. Order them +by their description. (Most common use case is to prepend a number to the +description, forcing the scrips to display and run in ascending alphanumerical +order.) +=cut + +sub _FindScrips { + my $self = shift; + my %args = ( + Stage => undef, + Type => undef, + @_ ); + + + $self->LimitToQueue( $self->{'TicketObj'}->QueueObj->Id ) + ; #Limit it to $Ticket->QueueObj->Id + $self->LimitToGlobal(); + # or to "global" + + $self->Limit( FIELD => "Stage", VALUE => $args{'Stage'} ); my $ConditionsAlias = $self->NewAlias('ScripConditions'); @@ -174,13 +347,16 @@ sub Apply { ); #We only want things where the scrip applies to this sort of transaction - $self->Limit( - ALIAS => $ConditionsAlias, - FIELD => 'ApplicableTransTypes', - OPERATOR => 'LIKE', - VALUE => $args{'Type'}, - ENTRYAGGREGATOR => 'OR', - ) if $args{'Type'}; + # TransactionBatch stage can define list of transaction + foreach( split /\s*,\s*/, ($args{'Type'} || '') ) { + $self->Limit( + ALIAS => $ConditionsAlias, + FIELD => 'ApplicableTransTypes', + OPERATOR => 'LIKE', + VALUE => $_, + ENTRYAGGREGATOR => 'OR', + ) + } # Or where the scrip applies to any transaction $self->Limit( @@ -191,18 +367,22 @@ sub Apply { ENTRYAGGREGATOR => 'OR', ); - #Iterate through each script and check it's applicability. - while ( my $Scrip = $self->Next() ) { - $Scrip->Apply (TicketObj => $TicketObj, - TransactionObj => $TransactionObj); - } + # Promise some kind of ordering + $self->OrderBy( FIELD => 'Description' ); - $TicketObj->CurrentUser( $TicketObj->OriginalUser ); - $TransactionObj->CurrentUser( $TransactionObj->OriginalUser ); + # we call Count below, but later we always do search + # so just do search and get count from results + $self->_DoSearch if $self->{'must_redo_search'}; - # }}} + $RT::Logger->debug( + "Found ". $self->Count ." scrips for $args{'Stage'} stage" + ." with applicable type(s) $args{'Type'}" + ." for txn #".$self->{TransactionObj}->Id + ." on ticket #".$self->{TicketObj}->Id + ); } +# }}} 1;