Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / ScripCondition.pm
index fe0aa2d..46110a9 100755 (executable)
-# 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-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.
-# 
-# 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::ScripCondition
-
+  RT::ScripCondition - RT scrip conditional
 
 =head1 SYNOPSIS
 
+  use RT::ScripCondition;
+
+
 =head1 DESCRIPTION
 
+This module should never be called directly by client code. it's an internal module which
+should only be accessed through exported APIs in other modules.
+
+
+
 =head1 METHODS
 
 =cut
 
+
 package RT::ScripCondition;
-use RT::Record; 
 
+use strict;
+use warnings;
+
+
+use base 'RT::Record';
 
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
 
-sub _Init {
-  my $self = shift; 
+sub Table {'ScripConditions'}
 
-  $self->Table('ScripConditions');
-  $self->SUPER::_Init(@_);
+
+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'
+               );
+    return($self->SUPER::_Accessible(@_, %Cols));
 }
 
 
+=head2 Create
+  
+  Takes a hash. Creates a new Condition entry.
+  should be better documented.
 
+=cut
 
+sub Create  {
+    my $self = shift;
+    return($self->SUPER::Create(@_));
+}
 
-=item Create PARAMHASH
 
-Create takes a hash of values and creates a row in the database:
+=head2 Delete
 
-  varchar(200) 'Name'.
-  varchar(255) 'Description'.
-  varchar(60) 'ExecModule'.
-  varchar(255) 'Argument'.
-  varchar(60) 'ApplicableTransTypes'.
+No API available for deleting things just yet.
 
 =cut
 
+sub Delete  {
+    my $self = shift;
+    return(0, $self->loc('Unimplemented'));
+}
+
 
+=head2 Load IDENTIFIER
 
+Loads a condition takes a name or ScripCondition id.
+
+=cut
 
-sub Create {
+sub Load  {
     my $self = shift;
-    my %args = ( 
-                Name => '',
-                Description => '',
-                ExecModule => '',
-                Argument => '',
-                ApplicableTransTypes => '',
-
-                 @_);
-    $self->SUPER::Create(
-                         Name => $args{'Name'},
-                         Description => $args{'Description'},
-                         ExecModule => $args{'ExecModule'},
-                         Argument => $args{'Argument'},
-                         ApplicableTransTypes => $args{'ApplicableTransTypes'},
-);
+    my $identifier = shift;
+
+    unless (defined $identifier) {
+        return (undef);
+    }
+
+    if ($identifier !~ /\D/) {
+        return ($self->SUPER::LoadById($identifier));
+    }
+    else {
+        return ($self->LoadByCol('Name', $identifier));
+    }
+}
+
+
+=head2 LoadCondition  HASH
+
+takes a hash which has the following elements:  TransactionObj and TicketObj.
+Loads the Condition module in question.
 
+=cut
+
+
+sub LoadCondition  {
+    my $self = shift;
+    my %args = ( TransactionObj => undef,
+                 TicketObj => undef,
+                 @_ );
+
+    #TODO: Put this in an eval
+    $self->ExecModule =~ /^(\w+)$/;
+    my $module = $1;
+    my $type = "RT::Condition::". $module;
+
+    $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
+                                       );
+}
+
+
+
+
+=head2 Describe 
+
+Helper method to call the condition module's Describe method.
+
+=cut
+
+sub Describe  {
+    my $self = shift;
+    return ($self->{'Condition'}->Describe());
+    
+}
+
+
+=head2 IsApplicable
+
+Helper method to call the condition module's IsApplicable method.
+
+=cut
+
+sub IsApplicable  {
+    my $self = shift;
+    return ($self->{'Condition'}->IsApplicable());
+    
 }
 
 
 
-=item id
+=head2 id
 
-Returns the current value of id. 
+Returns the current value of id.
 (In the database, id is stored as int(11).)
 
 
 =cut
 
 
-=item Name
+=head2 Name
 
-Returns the current value of Name. 
+Returns the current value of Name.
 (In the database, Name is stored as varchar(200).)
 
 
 
-=item SetName VALUE
+=head2 SetName VALUE
 
 
-Set Name to 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).)
 
@@ -125,17 +231,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item Description
+=head2 Description
 
-Returns the current value of Description. 
+Returns the current value of Description.
 (In the database, Description is stored as varchar(255).)
 
 
 
-=item SetDescription VALUE
+=head2 SetDescription VALUE
 
 
-Set Description to 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).)
 
@@ -143,17 +249,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item ExecModule
+=head2 ExecModule
 
-Returns the current value of ExecModule. 
+Returns the current value of ExecModule.
 (In the database, ExecModule is stored as varchar(60).)
 
 
 
-=item SetExecModule VALUE
+=head2 SetExecModule VALUE
 
 
-Set ExecModule to 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).)
 
@@ -161,35 +267,35 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item Argument
+=head2 Argument
 
-Returns the current value of Argument. 
-(In the database, Argument is stored as varchar(255).)
+Returns the current value of Argument.
+(In the database, Argument is stored as varbinary(255).)
 
 
 
-=item SetArgument VALUE
+=head2 SetArgument VALUE
 
 
-Set Argument to 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 varchar(255).)
+(In the database, Argument will be stored as a varbinary(255).)
 
 
 =cut
 
 
-=item ApplicableTransTypes
+=head2 ApplicableTransTypes
 
-Returns the current value of ApplicableTransTypes. 
+Returns the current value of ApplicableTransTypes.
 (In the database, ApplicableTransTypes is stored as varchar(60).)
 
 
 
-=item SetApplicableTransTypes VALUE
+=head2 SetApplicableTransTypes VALUE
 
 
-Set ApplicableTransTypes to 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).)
 
@@ -197,36 +303,36 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=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.)
 
 
@@ -234,69 +340,64 @@ Returns the current value of LastUpdated.
 
 
 
-sub _ClassAccessible {
+sub _CoreAccessible {
     {
-     
+
         id =>
-               {read => 1, type => 'int(11)', default => ''},
-        Name => 
-               {read => 1, write => 1, type => 'varchar(200)', default => ''},
-        Description => 
-               {read => 1, write => 1, type => 'varchar(255)', default => ''},
-        ExecModule => 
-               {read => 1, write => 1, type => 'varchar(60)', default => ''},
-        Argument => 
-               {read => 1, write => 1, type => 'varchar(255)', default => ''},
-        ApplicableTransTypes => 
-               {read => 1, write => 1, type => 'varchar(60)', default => ''},
-        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 => ''},
+        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) = @_;
 
-        eval "require RT::ScripCondition_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::ScripCondition_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Vendor.pm}) {
-            die $@;
-        };
-
-        eval "require RT::ScripCondition_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Local.pm}) {
-            die $@;
-        };
-
-
-
-
-=head1 SEE ALSO
+    $class->SUPER::PreInflate( $importer, $uid, $data );
 
-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.  
-
-These overlay files can contain new subs or subs to replace existing subs in this module.
-
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
-
-   no warnings qw(redefine);
-
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
-
-RT::ScripCondition_Overlay, RT::ScripCondition_Vendor, RT::ScripCondition_Local
+    return not $importer->SkipBy( "Name", $class, $uid, $data );
+}
 
-=cut
+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;