diff options
Diffstat (limited to 'rt/lib/RT/Scrips_Overlay.pm')
| -rw-r--r-- | rt/lib/RT/Scrips_Overlay.pm | 362 |
1 files changed, 0 insertions, 362 deletions
diff --git a/rt/lib/RT/Scrips_Overlay.pm b/rt/lib/RT/Scrips_Overlay.pm deleted file mode 100644 index 0f606c8..0000000 --- a/rt/lib/RT/Scrips_Overlay.pm +++ /dev/null @@ -1,362 +0,0 @@ -# BEGIN BPS TAGGED BLOCK {{{ -# -# COPYRIGHT: -# -# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC -# <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA. -# -# -# 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 - -=head1 SYNOPSIS - - use RT::Scrips; - -=head1 DESCRIPTION - - -=head1 METHODS - - -=begin testing - -ok (require RT::Scrips); - -=end testing - -=cut - - -package RT::Scrips; - -use strict; -no warnings qw(redefine); - -# {{{ sub LimitToQueue - -=head2 LimitToQueue - -Takes a queue id (numerical) as its only argument. Makes sure that -Scopes it pulls out apply to this queue (or another that you've selected with -another call to this method - -=cut - -sub LimitToQueue { - my $self = shift; - my $queue = shift; - - $self->Limit (ENTRYAGGREGATOR => 'OR', - FIELD => 'Queue', - VALUE => "$queue") - if defined $queue; - -} -# }}} - -# {{{ sub LimitToGlobal - -=head2 LimitToGlobal - -Makes sure that -Scopes it pulls out apply to all queues (or another that you've selected with -another call to this method or LimitToQueue - -=cut - - -sub LimitToGlobal { - my $self = shift; - - $self->Limit (ENTRYAGGREGATOR => 'OR', - FIELD => 'Queue', - VALUE => 0); - -} -# }}} - -# {{{ sub NewItem -sub NewItem { - my $self = shift; - - return(new RT::Scrip($self->CurrentUser)); -} -# }}} - -# {{{ sub Next - -=head2 Next - -Returns the next scrip that this user can see. - -=cut - -sub Next { - my $self = shift; - - - my $Scrip = $self->SUPER::Next(); - if ((defined($Scrip)) and (ref($Scrip))) { - - if ($Scrip->CurrentUserHasRight('ShowScrips')) { - return($Scrip); - } - - #If the user doesn't have the right to show this scrip - else { - return($self->Next()); - } - } - #if there never was any scrip - else { - return(undef); - } - -} -# }}} - -=head2 Apply - -Run through the relevant scrips. - -=cut - -sub Apply { - 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}) { - - $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 - $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() ) { - - next - unless ( $scrip->IsApplicable( - TicketObj => $self->{'TicketObj'}, - TransactionObj => $self->{'TransactionObj'} - ) ); - - #If it's applicable, prepare and commit it - next - unless ( $scrip->Prepare( TicketObj => $self->{'TicketObj'}, - TransactionObj => $self->{'TransactionObj'} - ) ); - push @{$self->{'prepared_scrips'}}, $scrip; - - } - - 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 ( ( $self->{'TicketObj'} = $args{'TicketObj'} ) ) { - $self->{'TicketObj'}->CurrentUser( $self->CurrentUser ); - } - else { - $self->{'TicketObj'} = RT::Ticket->new( $self->CurrentUser ); - $self->{'TicketObj'}->Load( $args{'Ticket'} ) - || $RT::Logger->err("$self couldn't load ticket $args{'Ticket'}\n"); - } - - if ( ( $self->{'TransactionObj'} = $args{'TransactionObj'} ) ) { - $self->{'TransactionObj'}->CurrentUser( $self->CurrentUser ); - } - else { - $self->{'TransactionObj'} = RT::Transaction->new( $self->CurrentUser ); - $self->{'TransactionObj'}->Load( $args{'Transaction'} ) - || $RT::Logger->err( "$self couldn't load transaction $args{'Transaction'}\n"); - } -} - -# }}} - -# {{{ sub _FindScrips; - -=head2 _FindScrips - -Find only the apropriate scrips for whatever we're doing now - -=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'); - - $self->Join( - ALIAS1 => 'main', - FIELD1 => 'ScripCondition', - ALIAS2 => $ConditionsAlias, - FIELD2 => 'id' - ); - - #We only want things where the scrip applies to this sort of transaction - # 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( - ALIAS => $ConditionsAlias, - FIELD => 'ApplicableTransTypes', - OPERATOR => 'LIKE', - VALUE => "Any", - ENTRYAGGREGATOR => 'OR', - ); - - $RT::Logger->debug("Found ".$self->Count. " scrips"); -} - -# }}} - -1; - |