rt/lib/RT/Action/UserDefined.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
  48 package RT::Action::UserDefined;
  49 use RT::Action::Generic;
  50
  51 use strict;
  52 use vars qw/@ISA/;
  53 @ISA = qw(RT::Action::Generic);
  54
  55 =head2 Prepare
  56
  57 This happens on every transaction. it's always applicable
  58
  59 =cut
  60
  61 sub Prepare {
  62     my $self = shift;
  63     my $retval = eval $self->ScripObj->CustomPrepareCode;
  64     if ($@) {
  65         $RT::Logger->error("Scrip ".$self->ScripObj->Id. " Prepare failed: ".$@);
  66         return (undef);
  67     }
  68     return ($retval);
  69 }
  70
  71 =head2 Commit
  72
  73 This happens on every transaction. it's always applicable
  74
  75 =cut
  76
  77 sub Commit {
  78     my $self = shift;
  79     my $retval = eval $self->ScripObj->CustomCommitCode;
  80     if ($@) {
  81         $RT::Logger->error("Scrip ".$self->ScripObj->Id. " Commit failed: ".$@);
  82         return (undef);
  83     }
  84     return ($retval);
  85 }
  86
  87 eval "require RT::Action::UserDefined_Vendor";
  88 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/UserDefined_Vendor.pm});
  89 eval "require RT::Action::UserDefined_Local";
  90 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/UserDefined_Local.pm});
  91
  92 1;
  93