rt/lib/RT/Action/UserDefined.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49
  50 package RT::Action::UserDefined;
  51 use RT::Action::Generic;
  52
  53 use strict;
  54 use vars qw/@ISA/;
  55 @ISA = qw(RT::Action::Generic);
  56
  57 =head2 Prepare
  58
  59 This happens on every transaction. it's always applicable
  60
  61 =cut
  62
  63 sub Prepare {
  64     my $self = shift;
  65     my $retval = eval $self->ScripObj->CustomPrepareCode;
  66     if ($@) {
  67         $RT::Logger->error("Scrip ".$self->ScripObj->Id. " Prepare failed: ".$@);
  68         return (undef);
  69     }
  70     return ($retval);
  71 }
  72
  73 =head2 Commit
  74
  75 This happens on every transaction. it's always applicable
  76
  77 =cut
  78
  79 sub Commit {
  80     my $self = shift;
  81     my $retval = eval $self->ScripObj->CustomCommitCode;
  82     if ($@) {
  83         $RT::Logger->error("Scrip ".$self->ScripObj->Id. " Commit failed: ".$@);
  84         return (undef);
  85     }
  86     return ($retval);
  87 }
  88
  89 eval "require RT::Action::UserDefined_Vendor";
  90 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/UserDefined_Vendor.pm});
  91 eval "require RT::Action::UserDefined_Local";
  92 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/UserDefined_Local.pm});
  93
  94 1;
  95