summaryrefslogtreecommitdiff
path: root/rt/lib/RT/ScripAction.pm
diff options
context:
space:
mode:
Diffstat (limited to 'rt/lib/RT/ScripAction.pm')
-rwxr-xr-xrt/lib/RT/ScripAction.pm385
1 files changed, 153 insertions, 232 deletions
diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm
index 26824df5d..471ad9191 100755
--- a/rt/lib/RT/ScripAction.pm
+++ b/rt/lib/RT/ScripAction.pm
@@ -1,279 +1,200 @@
-# BEGIN LICENSE BLOCK
-#
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-#
-# (Except where explictly superceded by other copyright notices)
-#
-# 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;
-
+# Copyright 1999-2000 Jesse Vincent <jesse@fsck.com>
+# Released under the terms of the GNU Public License
+# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/ScripAction.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
=head1 NAME
-RT::ScripAction
-
+ RT::ScripAction - RT Action object
=head1 SYNOPSIS
-=head1 DESCRIPTION
-
-=head1 METHODS
-
-=cut
-
-package RT::ScripAction;
-use RT::Record;
-
-
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+ use RT::ScripAction;
-sub _Init {
- my $self = shift;
-
- $self->Table('ScripActions');
- $self->SUPER::_Init(@_);
-}
+=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.
+=begin testing
-=item Create PARAMHASH
+ok (require RT::TestHarness);
+ok (require RT::ScripAction);
-Create takes a hash of values and creates a row in the database:
+=end testing
- varchar(200) 'Name'.
- varchar(255) 'Description'.
- varchar(60) 'ExecModule'.
- varchar(255) 'Argument'.
+=head1 METHODS
=cut
+package RT::ScripAction;
+use RT::Record;
+@ISA= qw(RT::Record);
+
+# {{{ sub _Init
+sub _Init {
+ my $self = shift;
+ $self->{'table'} = "ScripActions";
+ return ($self->SUPER::_Init(@_));
+}
+# }}}
-
-
-sub Create {
+# {{{ sub _Accessible
+sub _Accessible {
my $self = shift;
- my %args = (
- Name => '',
- Description => '',
- ExecModule => '',
- Argument => '',
-
- @_);
- $self->SUPER::Create(
- Name => $args{'Name'},
- Description => $args{'Description'},
- ExecModule => $args{'ExecModule'},
- Argument => $args{'Argument'},
-);
-
+ my %Cols = ( Name => 'read',
+ Description => 'read',
+ ExecModule => 'read',
+ Argument => 'read',
+ Creator => 'read/auto',
+ Created => 'read/auto',
+ LastUpdatedBy => 'read/auto',
+ LastUpdated => 'read/auto'
+ );
+ return($self->SUPER::_Accessible(@_, %Cols));
}
+# }}}
-
-
-=item id
-
-Returns the current value of id.
-(In the database, id is stored as int(11).)
-
-
+# {{{ sub Create
+=head2 Create
+
+ Takes a hash. Creates a new Action entry.
+ should be better documented.
=cut
+sub Create {
+ my $self = shift;
+ #TODO check these args and do smart things.
+ return($self->SUPER::Create(@_));
+}
+# }}}
-=item Name
-
-Returns the current value of Name.
-(In the database, Name is stored as varchar(200).)
-
-
-
-=item 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
-
-
-=item Description
-
-Returns the current value of Description.
-(In the database, Description is stored as varchar(255).)
-
-
-
-=item 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
-
-
-=item ExecModule
-
-Returns the current value of ExecModule.
-(In the database, ExecModule is stored as varchar(60).)
-
-
-
-=item 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
-
-
-=item Argument
-
-Returns the current value of Argument.
-(In the database, Argument is stored as varchar(255).)
-
-
-
-=item 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 varchar(255).)
-
-
-=cut
-
-
-=item Creator
-
-Returns the current value of Creator.
-(In the database, Creator is stored as int(11).)
-
-
-=cut
-
-
-=item Created
-
-Returns the current value of Created.
-(In the database, Created is stored as datetime.)
-
-
-=cut
+# {{{ sub Delete
+sub Delete {
+ my $self = shift;
+
+ return (0, "ScripAction->Delete not implemented");
+}
+# }}}
+# {{{ sub Load
+sub Load {
+ my $self = shift;
+ my $identifier = shift;
+
+ if (!$identifier) {
+ return (0, 'Input error');
+ }
+
+ if ($identifier !~ /\D/) {
+ $self->SUPER::LoadById($identifier);
+ }
+ else {
+ $self->LoadByCol('Name', $identifier);
+
+ }
+
+ if (@_) {
+ # Set the template Id to the passed in template
+ my $template = shift;
+
+ $self->{'Template'} = $template;
+ }
+ return ($self->Id, 'ScripAction loaded');
+}
+# }}}
-=item LastUpdatedBy
+# {{{ sub LoadAction
-Returns the current value of LastUpdatedBy.
-(In the database, LastUpdatedBy is stored as int(11).)
+=head2 LoadAction HASH
+ Takes a hash consisting of TicketObj and TransactionObj. Loads an RT::Action:: module.
=cut
+sub LoadAction {
+ my $self = shift;
+ my %args = ( TransactionObj => undef,
+ TicketObj => undef,
+ @_ );
+
+ #TODO: Put this in an eval
+ $self->ExecModule =~ /^(\w+)$/;
+ my $module = $1;
+ my $type = "RT::Action::". $module;
+
+ $RT::Logger->debug("now requiring $type\n");
+ eval "require $type" || die "Require of $type failed.\n$@\n";
+
+ $self->{'Action'} = $type->new ( 'ScripActionObj' => $self,
+ 'TicketObj' => $args{'TicketObj'},
+ 'TransactionObj' => $args{'TransactionObj'},
+ 'TemplateObj' => $self->TemplateObj,
+ 'Argument' => $self->Argument,
+ );
+}
+# }}}
-=item LastUpdated
+# {{{ sub TemplateObj
-Returns the current value of LastUpdated.
-(In the database, LastUpdated is stored as datetime.)
+=head2 TemplateObj
+Return this action\'s template object
=cut
+sub TemplateObj {
+ my $self = shift;
+ return undef unless $self->{Template};
+ if (!$self->{'TemplateObj'}) {
+ require RT::Template;
+ $self->{'TemplateObj'} = RT::Template->new($self->CurrentUser);
+ $self->{'TemplateObj'}->LoadById($self->{'Template'});
+
+ }
+
+ return ($self->{'TemplateObj'});
+}
+# }}}
+# The following methods call the action object
-sub _ClassAccessible {
- {
-
- 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 => ''},
- 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 => ''},
-
- }
-};
-
-
- eval "require RT::ScripAction_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Overlay.pm}) {
- die $@;
- };
-
- eval "require RT::ScripAction_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Vendor.pm}) {
- die $@;
- };
-
- eval "require RT::ScripAction_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_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.
+# {{{ sub Prepare
-These overlay files can contain new subs or subs to replace existing subs in this module.
+sub Prepare {
+ my $self = shift;
+ return ($self->{'Action'}->Prepare());
+
+}
+# }}}
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
+# {{{ sub Commit
+sub Commit {
+ my $self = shift;
+ return($self->{'Action'}->Commit());
+
+
+}
+# }}}
- no warnings qw(redefine);
+# {{{ sub Describe
+sub Describe {
+ my $self = shift;
+ return ($self->{'Action'}->Describe());
+
+}
+# }}}
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+# {{{ sub DESTROY
+sub DESTROY {
+ my $self=shift;
+ $self->{'Action'} = undef;
+ $self->{'TemplateObj'} = undef;
+}
+# }}}
-RT::ScripAction_Overlay, RT::ScripAction_Vendor, RT::ScripAction_Local
-=cut
+1;
-1;
generated by cgit v1.2.1 (git 2.18.0) at 2025-10-31 00:31:35 +0000