rt/lib/RT/Action/Generic.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Action::Generic - a generic baseclass for RT Actions
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::Action::Generic;
  54
  55 =head1 DESCRIPTION
  56
  57 =head1 METHODS
  58
  59 =begin testing
  60
  61 ok (require RT::Action::Generic);
  62
  63 =end testing
  64
  65 =cut
  66
  67 package RT::Action::Generic;
  68
  69 use strict;
  70 use Scalar::Util;
  71
  72 use base qw/RT::Base/;
  73
  74 # {{{ sub new
  75 sub new  {
  76   my $proto = shift;
  77   my $class = ref($proto) || $proto;
  78   my $self  = {};
  79   bless ($self, $class);
  80   $self->_Init(@_);
  81   return $self;
  82 }
  83 # }}}
  84
  85 # {{{ sub _Init
  86 sub _Init  {
  87   my $self = shift;
  88   my %args = ( Argument => undef,
  89                CurrentUser => undef,
  90                ScripActionObj => undef,
  91                ScripObj => undef,
  92                TemplateObj => undef,
  93                TicketObj => undef,
  94                TransactionObj => undef,
  95                Type => undef,
  96
  97                @_ );
  98
  99   $self->{'Argument'} = $args{'Argument'};
 100   $self->CurrentUser( $args{'CurrentUser'});
 101   $self->{'ScripActionObj'} = $args{'ScripActionObj'};
 102   $self->{'ScripObj'} = $args{'ScripObj'};
 103   $self->{'TemplateObj'} = $args{'TemplateObj'};
 104   $self->{'TicketObj'} = $args{'TicketObj'};
 105   $self->{'TransactionObj'} = $args{'TransactionObj'};
 106   $self->{'Type'} = $args{'Type'};
 107
 108   Scalar::Util::weaken($self->{'ScripActionObj'});
 109   Scalar::Util::weaken($self->{'ScripObj'});
 110   Scalar::Util::weaken($self->{'TemplateObj'});
 111   Scalar::Util::weaken($self->{'TicketObj'});
 112   Scalar::Util::weaken($self->{'TransactionObj'});
 113
 114 }
 115 # }}}
 116
 117 # Access Scripwide data
 118
 119 # {{{ sub Argument
 120 sub Argument  {
 121   my $self = shift;
 122   return($self->{'Argument'});
 123 }
 124 # }}}
 125
 126 # {{{ sub TicketObj
 127 sub TicketObj  {
 128   my $self = shift;
 129   return($self->{'TicketObj'});
 130 }
 131 # }}}
 132
 133 # {{{ sub TransactionObj
 134 sub TransactionObj  {
 135   my $self = shift;
 136   return($self->{'TransactionObj'});
 137 }
 138 # }}}
 139
 140 # {{{ sub TemplateObj
 141 sub TemplateObj  {
 142   my $self = shift;
 143   return($self->{'TemplateObj'});
 144 }
 145 # }}}
 146
 147 # {{{ sub ScripObj
 148 sub ScripObj  {
 149   my $self = shift;
 150   return($self->{'ScripObj'});
 151 }
 152 # }}}
 153
 154 # {{{ sub ScripActionObj
 155 sub ScripActionObj  {
 156   my $self = shift;
 157   return($self->{'ScripActionObj'});
 158 }
 159 # }}}
 160
 161 # {{{ sub Type
 162 sub Type  {
 163   my $self = shift;
 164   return($self->{'Type'});
 165 }
 166 # }}}
 167
 168
 169 # Scrip methods
 170
 171 #Do what we need to do and send it out.
 172
 173 # {{{ sub Commit
 174 sub Commit  {
 175   my $self = shift;
 176   return(0, $self->loc("Commit Stubbed"));
 177 }
 178 # }}}
 179
 180
 181 #What does this type of Action does
 182
 183 # {{{ sub Describe
 184 sub Describe  {
 185   my $self = shift;
 186   return $self->loc("No description for [_1]", ref $self);
 187 }
 188 # }}}
 189
 190
 191 #Parse the templates, get things ready to go.
 192
 193 # {{{ sub Prepare
 194 sub Prepare  {
 195   my $self = shift;
 196   return (0, $self->loc("Prepare Stubbed"));
 197 }
 198 # }}}
 199
 200
 201 #If this rule applies to this transaction, return true.
 202
 203 # {{{ sub IsApplicable
 204 sub IsApplicable  {
 205   my $self = shift;
 206   return(undef);
 207 }
 208 # }}}
 209
 210 # {{{ sub DESTROY
 211 sub DESTROY {
 212     my $self = shift;
 213
 214     # We need to clean up all the references that might maybe get
 215     # oddly circular
 216     $self->{'ScripActionObj'} = undef;
 217     $self->{'ScripObj'} = undef;
 218     $self->{'TemplateObj'} =undef
 219     $self->{'TicketObj'} = undef;
 220     $self->{'TransactionObj'} = undef;
 221 }
 222
 223 # }}}
 224
 225 eval "require RT::Action::Generic_Vendor";
 226 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/Generic_Vendor.pm});
 227 eval "require RT::Action::Generic_Local";
 228 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/Generic_Local.pm});
 229
 230 1;