rt/lib/RT/Action/RecordComment.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 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 # BEGIN LICENSE BLOCK
  47 #
  48 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
  49 #
  50 # (Except where explictly superceded by other copyright notices)
  51 #
  52 # This work is made available to you under the terms of Version 2 of
  53 # the GNU General Public License. A copy of that license should have
  54 # been provided with this software, but in any event can be snarfed
  55 # from www.gnu.org.
  56 #
  57 # This work is distributed in the hope that it will be useful, but
  58 # WITHOUT ANY WARRANTY; without even the implied warranty of
  59 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  60 # General Public License for more details.
  61 #
  62 # Unless otherwise specified, all modifications, corrections or
  63 # extensions to this work which alter its source code become the
  64 # property of Best Practical Solutions, LLC when submitted for
  65 # inclusion in the work.
  66 #
  67 #
  68 # END LICENSE BLOCK
  69 #
  70 package RT::Action::RecordComment;
  71 require RT::Action::Generic;
  72 use strict;
  73 use vars qw/@ISA/;
  74 @ISA = qw(RT::Action::Generic);
  75
  76 =head1 NAME
  77
  78 RT::Action::RecordComment - An Action which can be used from an
  79 external tool, or in any situation where a ticket transaction has not
  80 been started, to make a comment on the ticket.
  81
  82 =head1 SYNOPSIS
  83
  84 my $action_obj = RT::Action::RecordComment->new('TicketObj'   => $ticket_obj,
  85                                                 'TemplateObj' => $template_obj,
  86                                                 );
  87 my $result = $action_obj->Prepare();
  88 $action_obj->Commit() if $result;
  89
  90 =head1 METHODS
  91
  92 =head2 Prepare
  93
  94 Check for the existence of a Transaction.  If a Transaction already
  95 exists, and is of type "Comment" or "Correspond", abort because that
  96 will give us a loop.
  97
  98 =cut
  99
 100
 101 sub Prepare {
 102     my $self = shift;
 103     if (defined $self->{'TransactionObj'} &&
 104         $self->{'TransactionObj'}->Type =~ /^(Comment|Correspond)$/) {
 105         return undef;
 106     }
 107     return 1;
 108 }
 109
 110 =head2 Commit
 111
 112 Create a Transaction by calling the ticket's Comment method on our
 113 parsed Template, which may have an RT-Send-Cc or RT-Send-Bcc header.
 114 The Transaction will be of type Comment.  This Transaction can then be
 115 used by the scrips that actually send the email.
 116
 117 =cut
 118
 119 sub Commit {
 120     my $self = shift;
 121     $self->CreateTransaction();
 122 }
 123
 124 sub CreateTransaction {
 125     my $self = shift;
 126
 127     my ($result, $msg) = $self->{'TemplateObj'}->Parse(
 128         TicketObj => $self->{'TicketObj'});
 129     return undef unless $result;
 130
 131     my ($trans, $desc, $transaction) = $self->{'TicketObj'}->Comment(
 132         MIMEObj => $self->TemplateObj->MIMEObj);
 133     $self->{'TransactionObj'} = $transaction;
 134 }
 135
 136
 137 eval "require RT::Action::RecordComment_Vendor";
 138 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/RecordComment_Vendor.pm});
 139 eval "require RT::Action::RecordComment_Local";
 140 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Action/RecordComment_Local.pm});
 141
 142 1;