X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=rt%2Flib%2FRT%2FScripCondition.pm;h=46110a9cc07806b8f6ab2cde3ff8c116f40d5981;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hp=253502bd4436bd85b094c2527f0d99496b552948;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d;p=freeside.git diff --git a/rt/lib/RT/ScripCondition.pm b/rt/lib/RT/ScripCondition.pm index 253502bd4..46110a9cc 100755 --- a/rt/lib/RT/ScripCondition.pm +++ b/rt/lib/RT/ScripCondition.pm @@ -1,6 +1,50 @@ -# Copyright 1999-2000 Jesse Vincent -# Released under the terms of the GNU Public License -# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/ScripCondition.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 +# +# +# (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 @@ -17,47 +61,39 @@ 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. -=begin testing - -ok (require RT::TestHarness); -ok (require RT::ScripCondition); - -=end testing =head1 METHODS =cut + package RT::ScripCondition; -use RT::Record; -@ISA= qw(RT::Record); - -# {{{ sub _Init -sub _Init { - my $self = shift; - $self->{'table'} = "ScripConditions"; - return ($self->SUPER::_Init(@_)); -} -# }}} -# {{{ sub _Accessible +use strict; +use warnings; + + +use base 'RT::Record'; + + +sub Table {'ScripConditions'} + + sub _Accessible { my $self = shift; my %Cols = ( Name => 'read', - Description => 'read', - ApplicableTransTypes => 'read', - ExecModule => 'read', - Argument => 'read', - Creator => 'read/auto', - Created => 'read/auto', - LastUpdatedBy => 'read/auto', - LastUpdated => 'read/auto' - ); + Description => 'read', + ApplicableTransTypes => 'read', + ExecModule => 'read', + Argument => 'read', + Creator => 'read/auto', + Created => 'read/auto', + LastUpdatedBy => 'read/auto', + LastUpdated => 'read/auto' + ); return($self->SUPER::_Accessible(@_, %Cols)); } -# }}} -# {{{ sub Create =head2 Create @@ -70,9 +106,7 @@ sub Create { my $self = shift; return($self->SUPER::Create(@_)); } -# }}} -# {{{ sub Delete =head2 Delete @@ -82,11 +116,9 @@ No API available for deleting things just yet. sub Delete { my $self = shift; - return(0,'Unimplemented'); + return(0, $self->loc('Unimplemented')); } -# }}} -# {{{ sub Load =head2 Load IDENTIFIER @@ -97,21 +129,19 @@ Loads a condition takes a name or ScripCondition id. sub Load { my $self = shift; my $identifier = shift; - + unless (defined $identifier) { - return (undef); - } - + return (undef); + } + if ($identifier !~ /\D/) { - return ($self->SUPER::LoadById($identifier)); + return ($self->SUPER::LoadById($identifier)); } else { - return ($self->LoadByCol('Name', $identifier)); + return ($self->LoadByCol('Name', $identifier)); } } -# }}} -# {{{ sub LoadCondition =head2 LoadCondition HASH @@ -124,34 +154,32 @@ Loads the Condition module in question. sub LoadCondition { my $self = shift; my %args = ( TransactionObj => undef, - TicketObj => undef, - @_ ); - - #TODO: Put this in an eval + TicketObj => undef, + @_ ); + + #TODO: Put this in an eval $self->ExecModule =~ /^(\w+)$/; my $module = $1; my $type = "RT::Condition::". $module; - - $RT::Logger->debug("now requiring $type\n"); - eval "require $type" || die "Require of $type failed.\n$@\n"; - - $self->{'Condition'} = $type->new ( 'ScripConditionObj' => $self, - 'TicketObj' => $args{'TicketObj'}, - 'TransactionObj' => $args{'TransactionObj'}, - 'Argument' => $self->Argument, - 'ApplicableTransTypes' => $self->ApplicableTransTypes, - ); + + $type->require or die "Require of $type condition module failed.\n$@\n"; + + $self->{'Condition'} = $type->new ( 'ScripConditionObj' => $self, + 'TicketObj' => $args{'TicketObj'}, + 'ScripObj' => $args{'ScripObj'}, + 'TransactionObj' => $args{'TransactionObj'}, + 'Argument' => $self->Argument, + 'ApplicableTransTypes' => $self->ApplicableTransTypes, + CurrentUser => $self->CurrentUser + ); } -# }}} -# {{{ The following methods call the Condition object -# {{{ sub Describe =head2 Describe -Helper method to call the condition module\'s Describe method. +Helper method to call the condition module's Describe method. =cut @@ -160,13 +188,11 @@ sub Describe { return ($self->{'Condition'}->Describe()); } -# }}} -# {{{ sub IsApplicable =head2 IsApplicable -Helper method to call the condition module\'s IsApplicable method. +Helper method to call the condition module's IsApplicable method. =cut @@ -175,18 +201,203 @@ sub IsApplicable { return ($self->{'Condition'}->IsApplicable()); } -# }}} -# }}} -# {{{ sub DESTROY -sub DESTROY { - my $self=shift; - $self->{'Condition'} = undef; -} -# }}} +=head2 id -1; +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 ApplicableTransTypes + +Returns the current value of ApplicableTransTypes. +(In the database, ApplicableTransTypes is stored as varchar(60).) + + + +=head2 SetApplicableTransTypes VALUE + + +Set ApplicableTransTypes to VALUE. +Returns (1, 'Status message') on success and (0, 'Error Message') on failure. +(In the database, ApplicableTransTypes will be stored as a varchar(60).) + + +=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 => ''}, + ApplicableTransTypes => + {read => 1, write => 1, sql_type => 12, length => 60, is_blob => 0, is_numeric => 0, type => 'varchar(60)', 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) = @_; + + $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 => 'ScripCondition', VALUE => $self->Id ); + $deps->_PushDependencies( + BaseObject => $self, + Flags => RT::Shredder::Constants::DEPENDS_ON, + TargetObjects => $objs, + Shredder => $args{'Shredder'} + ); + + return $self->SUPER::__DependsOn( %args ); +} + +RT::Base->_ImportOverlays(); + +1;