diff options
Diffstat (limited to 'rt/lib/RT/ScripAction.pm')
| -rwxr-xr-x | rt/lib/RT/ScripAction.pm | 293 |
1 files changed, 211 insertions, 82 deletions
diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm index 21a8a0ea1..13ab47e03 100755 --- a/rt/lib/RT/ScripAction.pm +++ b/rt/lib/RT/ScripAction.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC # <sales@bestpractical.com> # # (Except where explicitly superseded by other copyright notices) @@ -46,83 +46,231 @@ # # END BPS TAGGED 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 !! -# +=head1 NAME -use strict; + RT::ScripAction - RT Action object +=head1 SYNOPSIS -=head1 NAME + use RT::ScripAction; -RT::ScripAction +=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 SYNOPSIS -=head1 DESCRIPTION =head1 METHODS =cut + package RT::ScripAction; -use RT::Record; +use strict; +use warnings; + +use base 'RT::Record'; + +sub Table {'ScripActions'} -use vars qw( @ISA ); -@ISA= qw( RT::Record ); -sub _Init { - my $self = shift; - $self->Table('ScripActions'); - $self->SUPER::_Init(@_); +use RT::Template; + +sub _Accessible { + my $self = shift; + 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)); } +=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(@_)); +} + +sub Delete { + my $self = shift; + + return (0, "ScripAction->Delete not implemented"); +} + + +=head2 Load IDENTIFIER + +Loads an action by its Name. + +Returns: Id, Error Message + +=cut + +sub Load { + my $self = shift; + my $identifier = shift; + + if (!$identifier) { + return (0, $self->loc('Input error')); + } + + my ($ok, $msg); + if ($identifier !~ /\D/) { + ($ok, $msg) = $self->SUPER::Load($identifier); + } + else { + ($ok, $msg) = $self->LoadByCol('Name', $identifier); + + } + + if (@_) { + # Set the template Id to the passed in template + my $template = shift; + + $self->{'Template'} = $template; + } + + return ($ok, $msg); +} + + +=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, + @_ ); + + $self->{_TicketObj} = $args{TicketObj}; + + #TODO: Put this in an eval + $self->ExecModule =~ /^(\w+)$/; + my $module = $1; + my $type = "RT::Action::". $module; + + eval "require $type" || die "Require of $type failed.\n$@\n"; + + $self->{'Action'} = $type->new ( Argument => $self->Argument, + CurrentUser => $self->CurrentUser, + ScripActionObj => $self, + ScripObj => $args{'ScripObj'}, + TemplateObj => $self->TemplateObj, + TicketObj => $args{'TicketObj'}, + TransactionObj => $args{'TransactionObj'}, + ); +} -=head2 Create PARAMHASH +=head2 TemplateObj -Create takes a hash of values and creates a row in the database: +Return this action's template object + +TODO: Why are we not using the Scrip's template object? - varchar(200) 'Name'. - varchar(255) 'Description'. - varchar(60) 'ExecModule'. - varchar(255) 'Argument'. =cut +sub TemplateObj { + my $self = shift; + return undef unless $self->{Template}; + if ( !$self->{'TemplateObj'} ) { + $self->{'TemplateObj'} = RT::Template->new( $self->CurrentUser ); + $self->{'TemplateObj'}->LoadById( $self->{'Template'} ); + + if ( ( $self->{'TemplateObj'}->__Value('Queue') == 0 ) + && $self->{'_TicketObj'} ) { + my $tmptemplate = RT::Template->new( $self->CurrentUser ); + my ( $ok, $err ) = $tmptemplate->LoadQueueTemplate( + Queue => $self->{'_TicketObj'}->QueueObj->id, + Name => $self->{'TemplateObj'}->Name); + + if ( $tmptemplate->id ) { + # found the queue-specific template with the same name + $self->{'TemplateObj'} = $tmptemplate; + } + } + + } + + return ( $self->{'TemplateObj'} ); +} +# The following methods call the action object -sub Create { +sub Prepare { my $self = shift; - my %args = ( - Name => '', - Description => '', - ExecModule => '', - Argument => '', - - @_); - $self->SUPER::Create( - Name => $args{'Name'}, - Description => $args{'Description'}, - ExecModule => $args{'ExecModule'}, - Argument => $args{'Argument'}, -); + $self->{_Message_ID} = 0; + return ($self->Action->Prepare()); + +} +sub Commit { + my $self = shift; + return($self->Action->Commit()); + + } +sub Describe { + my $self = shift; + return ($self->Action->Describe()); + +} + +=head2 Action + +Return the actual RT::Action object for this scrip. + +=cut + +sub Action { + my $self = shift; + return ($self->{'Action'}); +} + +sub DESTROY { + my $self=shift; + $self->{'_TicketObj'} = undef; + $self->{'Action'} = undef; + $self->{'TemplateObj'} = undef; +} + +=head2 TODO + +Between this, RT::Scrip and RT::Action::*, we need to be able to get rid of a +class. This just reeks of too much complexity -- jesse + +=cut + + =head2 id -Returns the current value of id. +Returns the current value of id. (In the database, id is stored as int(11).) @@ -131,7 +279,7 @@ Returns the current value of id. =head2 Name -Returns the current value of Name. +Returns the current value of Name. (In the database, Name is stored as varchar(200).) @@ -139,7 +287,7 @@ Returns the current value of Name. =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).) @@ -149,7 +297,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Description -Returns the current value of Description. +Returns the current value of Description. (In the database, Description is stored as varchar(255).) @@ -157,7 +305,7 @@ Returns the current value of Description. =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).) @@ -167,7 +315,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 ExecModule -Returns the current value of ExecModule. +Returns the current value of ExecModule. (In the database, ExecModule is stored as varchar(60).) @@ -175,7 +323,7 @@ Returns the current value of ExecModule. =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).) @@ -185,17 +333,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =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).) =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 @@ -203,7 +351,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Creator -Returns the current value of Creator. +Returns the current value of Creator. (In the database, Creator is stored as int(11).) @@ -212,7 +360,7 @@ Returns the current value of Creator. =head2 Created -Returns the current value of Created. +Returns the current value of Created. (In the database, Created is stored as datetime.) @@ -221,7 +369,7 @@ Returns the current value of Created. =head2 LastUpdatedBy -Returns the current value of LastUpdatedBy. +Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).) @@ -230,7 +378,7 @@ Returns the current value of LastUpdatedBy. =head2 LastUpdated -Returns the current value of LastUpdated. +Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.) @@ -240,24 +388,24 @@ Returns the current value of LastUpdated. sub _CoreAccessible { { - + id => {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, - Name => + Name => {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''}, - Description => + Description => {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, - ExecModule => + 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 => 'varchar(255)', default => ''}, - Creator => + Argument => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varbinary(255)', default => ''}, + Creator => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - Created => + Created => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, - LastUpdatedBy => + LastUpdatedBy => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - LastUpdated => + LastUpdated => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, } @@ -265,23 +413,4 @@ sub _CoreAccessible { RT::Base->_ImportOverlays(); -=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. - -These overlay files can contain new subs or subs to replace existing subs in this module. - -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::ScripAction_Overlay, RT::ScripAction_Vendor, RT::ScripAction_Local - -=cut - - 1; |