X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=rt%2Flib%2FRT%2FInterface%2FEmail.pm;h=de125f560f2100ca6b42909c9b6f2b83adf21a8f;hb=9c68254528b6f2c7d8c1921b452fa56064783782;hp=52542a14929c97b4ea137718219b92ba2c4dab1f;hpb=c582e92888b4a5553e1b4e5214cf35217e4a0cf0;p=freeside.git diff --git a/rt/lib/RT/Interface/Email.pm b/rt/lib/RT/Interface/Email.pm index 52542a149..de125f560 100755 --- a/rt/lib/RT/Interface/Email.pm +++ b/rt/lib/RT/Interface/Email.pm @@ -1,26 +1,48 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC +# +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have # been provided with this software, but in any event can be snarfed # from www.gnu.org. -# +# # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. -# -# Unless otherwise specified, all modifications, corrections or -# extensions to this work which alter its source code become the -# property of Best Practical Solutions, LLC when submitted for -# inclusion in the work. -# -# -# END LICENSE BLOCK +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} package RT::Interface::Email; use strict; @@ -28,30 +50,32 @@ use Mail::Address; use MIME::Entity; use RT::EmailParser; use File::Temp; +use UNIVERSAL::require; BEGIN { use Exporter (); - use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); - + use vars qw ( @ISA @EXPORT_OK); + # set the version for version checking - $VERSION = do { my @r = (q$Revision: 1.1.1.3 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; # must be all one line, for MakeMaker - - @ISA = qw(Exporter); - + our $VERSION = 2.0; + + @ISA = qw(Exporter); + # your exported package globals go here, # as well as any optionally exported functions - @EXPORT_OK = qw( - &CreateUser - &GetMessageContent - &CheckForLoops - &CheckForSuspiciousSender - &CheckForAutoGenerated - &MailError - &ParseCcAddressesFromHead - &ParseSenderAddressFromHead - &ParseErrorsToAddressFromHead - &ParseAddressFromHeader - &Gateway); + @EXPORT_OK = qw( + &CreateUser + &GetMessageContent + &CheckForLoops + &CheckForSuspiciousSender + &CheckForAutoGenerated + &CheckForBounce + &MailError + &ParseCcAddressesFromHead + &ParseSenderAddressFromHead + &ParseErrorsToAddressFromHead + &ParseAddressFromHeader + &Gateway); } @@ -80,19 +104,18 @@ ok(require RT::Interface::Email); =cut +# {{{ sub CheckForLoops -# {{{ sub CheckForLoops - -sub CheckForLoops { +sub CheckForLoops { my $head = shift; - + #If this instance of RT sent it our, we don't want to take it in my $RTLoop = $head->get("X-RT-Loop-Prevention") || ""; - chomp ($RTLoop); #remove that newline - if ($RTLoop eq "$RT::rtname") { - return (1); + chomp($RTLoop); #remove that newline + if ( $RTLoop eq "$RT::rtname" ) { + return (1); } - + # TODO: We might not trap the case where RT instance A sends a mail # to RT instance B which sends a mail to ... return (undef); @@ -106,23 +129,24 @@ sub CheckForSuspiciousSender { my $head = shift; #if it's from a postmaster or mailer daemon, it's likely a bounce. - + #TODO: better algorithms needed here - there is no standards for #bounces, so it's very difficult to separate them from anything #else. At the other hand, the Return-To address is only ment to be #used as an error channel, we might want to put up a separate #Return-To address which is treated differently. - + #TODO: search through the whole email and find the right Ticket ID. - my ($From, $junk) = ParseSenderAddressFromHead($head); - - if (($From =~ /^mailer-daemon/i) or - ($From =~ /^postmaster/i)){ - return (1); - + my ( $From, $junk ) = ParseSenderAddressFromHead($head); + + if ( ( $From =~ /^mailer-daemon\@/i ) + or ( $From =~ /^postmaster\@/i ) ) + { + return (1); + } - + return (undef); } @@ -132,63 +156,124 @@ sub CheckForSuspiciousSender { # {{{ sub CheckForAutoGenerated sub CheckForAutoGenerated { my $head = shift; - - my $Precedence = $head->get("Precedence") || "" ; - if ($Precedence =~ /^(bulk|junk)/i) { - return (1); + + my $Precedence = $head->get("Precedence") || ""; + if ( $Precedence =~ /^(bulk|junk)/i ) { + return (1); } - else { - return (0); + + # First Class mailer uses this as a clue. + my $FCJunk = $head->get("X-FC-Machinegenerated") || ""; + if ( $FCJunk =~ /^true/i ) { + return (1); } + + return (0); +} + +# }}} + +# {{{ sub CheckForBounce +sub CheckForBounce { + my $head = shift; + + my $ReturnPath = $head->get("Return-path") || ""; + return ( $ReturnPath =~ /<>/ ); } # }}} +# {{{ IsRTAddress + +=head2 IsRTAddress ADDRESS + +Takes a single parameter, an email address. +Returns true if that address matches the $RTAddressRegexp. +Returns false, otherwise. + +=cut + +sub IsRTAddress { + my $address = shift || ''; + + # Example: the following rule would tell RT not to Cc + # "tickets@noc.example.com" + if ( defined($RT::RTAddressRegexp) + && $address =~ /$RT::RTAddressRegexp/i ) + { + return (1); + } else { + return (undef); + } +} -# {{{ sub MailError +# }}} + +# {{{ CullRTAddresses + +=head2 CullRTAddresses ARRAY + +Takes a single argument, an array of email addresses. +Returns the same array with any IsRTAddress()es weeded out. + +=cut + +sub CullRTAddresses { + return ( grep { IsRTAddress($_) } @_ ); +} + +# }}} + +# {{{ sub MailError sub MailError { - my %args = (To => $RT::OwnerEmail, - Bcc => undef, - From => $RT::CorrespondAddress, - Subject => 'There has been an error', - Explanation => 'Unexplained error', - MIMEObj => undef, - Attach => undef, - LogLevel => 'crit', - @_); - - - $RT::Logger->log(level => $args{'LogLevel'}, - message => $args{'Explanation'} - ); - my $entity = MIME::Entity->build( Type =>"multipart/mixed", - From => $args{'From'}, - Bcc => $args{'Bcc'}, - To => $args{'To'}, - Subject => $args{'Subject'}, - 'X-RT-Loop-Prevention' => $RT::rtname, - ); - - $entity->attach( Data => $args{'Explanation'}."\n"); - + my %args = ( + To => $RT::OwnerEmail, + Bcc => undef, + From => $RT::CorrespondAddress, + Subject => 'There has been an error', + Explanation => 'Unexplained error', + MIMEObj => undef, + Attach => undef, + LogLevel => 'crit', + @_ + ); + + $RT::Logger->log( + level => $args{'LogLevel'}, + message => $args{'Explanation'} + ); + my $entity = MIME::Entity->build( + Type => "multipart/mixed", + From => $args{'From'}, + Bcc => $args{'Bcc'}, + To => $args{'To'}, + Subject => $args{'Subject'}, + Precedence => 'bulk', + 'X-RT-Loop-Prevention' => $RT::rtname, + ); + + $entity->attach( Data => $args{'Explanation'} . "\n" ); + my $mimeobj = $args{'MIMEObj'}; if ($mimeobj) { $mimeobj->sync_headers(); $entity->add_part($mimeobj); } - - if ($args{'Attach'}) { - $entity->attach(Data => $args{'Attach'}, Type => 'message/rfc822'); + + if ( $args{'Attach'} ) { + $entity->attach( Data => $args{'Attach'}, Type => 'message/rfc822' ); } - if ($RT::MailCommand eq 'sendmailpipe') { - open (MAIL, "|$RT::SendmailPath $RT::SendmailArguments") || return(0); + if ( $RT::MailCommand eq 'sendmailpipe' ) { + open( MAIL, + "|$RT::SendmailPath $RT::SendmailBounceArguments $RT::SendmailArguments" + ) + || return (0); print MAIL $entity->as_string; close(MAIL); - } - else { - $entity->send($RT::MailCommand, $RT::MailParams); + } else { + $entity->send( $RT::MailCommand, $RT::MailParams ); } } @@ -197,37 +282,39 @@ sub MailError { # {{{ Create User sub CreateUser { - my ($Username, $Address, $Name, $ErrorsTo, $entity) = @_; + my ( $Username, $Address, $Name, $ErrorsTo, $entity ) = @_; my $NewUser = RT::User->new($RT::SystemUser); - my ($Val, $Message) = - $NewUser->Create(Name => ($Username || $Address), - EmailAddress => $Address, - RealName => $Name, - Password => undef, - Privileged => 0, - Comments => 'Autocreated on ticket submission' - ); - + my ( $Val, $Message ) = $NewUser->Create( + Name => ( $Username || $Address ), + EmailAddress => $Address, + RealName => $Name, + Password => undef, + Privileged => 0, + Comments => 'Autocreated on ticket submission' + ); + unless ($Val) { - + # Deal with the race condition of two account creations at once # if ($Username) { $NewUser->LoadByName($Username); } - - unless ($NewUser->Id) { + + unless ( $NewUser->Id ) { $NewUser->LoadByEmail($Address); } - - unless ($NewUser->Id) { - MailError( To => $ErrorsTo, - Subject => "User could not be created", - Explanation => "User creation failed in mailgateway: $Message", - MIMEObj => $entity, - LogLevel => 'crit' - ); + + unless ( $NewUser->Id ) { + MailError( + To => $ErrorsTo, + Subject => "User could not be created", + Explanation => + "User creation failed in mailgateway: $Message", + MIMEObj => $entity, + LogLevel => 'crit' + ); } } @@ -235,20 +322,25 @@ sub CreateUser { my $CurrentUser = RT::CurrentUser->new(); $CurrentUser->LoadByEmail($Address); - unless ($CurrentUser->id) { - $RT::Logger->warning("Couldn't load user '$Address'.". "giving up"); - MailError( To => $ErrorsTo, - Subject => "User could not be loaded", - Explanation => "User '$Address' could not be loaded in the mail gateway", - MIMEObj => $entity, - LogLevel => 'crit' - ); + unless ( $CurrentUser->id ) { + $RT::Logger->warning( + "Couldn't load user '$Address'." . "giving up" ); + MailError( + To => $ErrorsTo, + Subject => "User could not be loaded", + Explanation => + "User '$Address' could not be loaded in the mail gateway", + MIMEObj => $entity, + LogLevel => 'crit' + ); } return $CurrentUser; } -# }}} -# {{{ ParseCcAddressesFromHead + +# }}} + +# {{{ ParseCcAddressesFromHead =head2 ParseCcAddressesFromHead HASHREF @@ -258,32 +350,34 @@ headers b the current Queue\'s email addresses, the CurrentUser\'s email address and anything that the configuration sub RT::IsRTAddress matches. =cut - + sub ParseCcAddressesFromHead { - my %args = ( Head => undef, - QueueObj => undef, - CurrentUser => undef, - @_ ); - + my %args = ( + Head => undef, + QueueObj => undef, + CurrentUser => undef, + @_ + ); + my (@Addresses); - - my @ToObjs = Mail::Address->parse($args{'Head'}->get('To')); - my @CcObjs = Mail::Address->parse($args{'Head'}->get('Cc')); - - foreach my $AddrObj (@ToObjs, @CcObjs) { - my $Address = $AddrObj->address; - $Address = $args{'CurrentUser'}->UserObj->CanonicalizeEmailAddress($Address); - next if ($args{'CurrentUser'}->EmailAddress =~ /^$Address$/i); - next if ($args{'QueueObj'}->CorrespondAddress =~ /^$Address$/i); - next if ($args{'QueueObj'}->CommentAddress =~ /^$Address$/i); - next if (RT::EmailParser::IsRTAddress(undef, $Address)); - - push (@Addresses, $Address); + + my @ToObjs = Mail::Address->parse( $args{'Head'}->get('To') ); + my @CcObjs = Mail::Address->parse( $args{'Head'}->get('Cc') ); + + foreach my $AddrObj ( @ToObjs, @CcObjs ) { + my $Address = $AddrObj->address; + $Address = $args{'CurrentUser'} + ->UserObj->CanonicalizeEmailAddress($Address); + next if ( $args{'CurrentUser'}->EmailAddress =~ /^\Q$Address\E$/i ); + next if ( $args{'QueueObj'}->CorrespondAddress =~ /^\Q$Address\E$/i ); + next if ( $args{'QueueObj'}->CommentAddress =~ /^\Q$Address\E$/i ); + next if ( RT::EmailParser->IsRTAddress($Address) ); + + push( @Addresses, $Address ); } return (@Addresses); } - # }}} # {{{ ParseSenderAdddressFromHead @@ -297,12 +391,14 @@ of the From (evaluated in order of Reply-To:, From:, Sender) sub ParseSenderAddressFromHead { my $head = shift; + #Figure out who's sending this message. - my $From = $head->get('Reply-To') || - $head->get('From') || - $head->get('Sender'); - return (ParseAddressFromHeader($From)); + my $From = $head->get('Reply-To') + || $head->get('From') + || $head->get('Sender'); + return ( ParseAddressFromHeader($From) ); } + # }}} # {{{ ParseErrorsToAdddressFromHead @@ -310,24 +406,29 @@ sub ParseSenderAddressFromHead { =head2 ParseErrorsToAddressFromHead Takes a MIME::Header object. Return a single value : user@host -of the From (evaluated in order of Errors-To:,Reply-To:, From:, Sender) +of the From (evaluated in order of Return-path:,Errors-To:,Reply-To:, +From:, Sender) =cut sub ParseErrorsToAddressFromHead { my $head = shift; + #Figure out who's sending this message. - foreach my $header ('Errors-To' , 'Reply-To', 'From', 'Sender' ) { - # If there's a header of that name - my $headerobj = $head->get($header); - if ($headerobj) { - my ($addr, $name ) = ParseAddressFromHeader($headerobj); - # If it's got actual useful content... - return ($addr) if ($addr); - } + foreach my $header ( 'Errors-To', 'Reply-To', 'From', 'Sender' ) { + + # If there's a header of that name + my $headerobj = $head->get($header); + if ($headerobj) { + my ( $addr, $name ) = ParseAddressFromHeader($headerobj); + + # If it's got actual useful content... + return ($addr) if ($addr); + } } } + # }}} # {{{ ParseAddressFromHeader @@ -338,28 +439,45 @@ Takes an address from $head->get('Line') and returns a tuple: user@host, friendl =cut - -sub ParseAddressFromHeader{ +sub ParseAddressFromHeader { my $Addr = shift; - + my @Addresses = Mail::Address->parse($Addr); - + my $AddrObj = $Addresses[0]; - unless (ref($AddrObj)) { - return(undef,undef); + unless ( ref($AddrObj) ) { + return ( undef, undef ); } - - my $Name = ($AddrObj->phrase || $AddrObj->comment || $AddrObj->address); - + + my $Name = ( $AddrObj->phrase || $AddrObj->comment || $AddrObj->address ); + #Lets take the from and load a user object. my $Address = $AddrObj->address; - return ($Address, $Name); + return ( $Address, $Name ); } + # }}} +# {{{ sub ParseTicketId + +sub ParseTicketId { + my $Subject = shift; + my $id; + my $test_name = $RT::EmailSubjectTagRegex || qr/\Q$RT::rtname\E/i; + + if ( $Subject =~ s/\[$test_name\s+\#(\d+)\s*\]//i ) { + my $id = $1; + $RT::Logger->debug("Found a ticket ID. It's $id"); + return ($id); + } else { + return (undef); + } +} + +# }}} =head2 Gateway ARGSREF @@ -386,11 +504,12 @@ Returns: status code is a numeric value. - for temporary failures, status code should be -75 + for temporary failures, the status code should be -75 - for permanent failures which are handled by RT, status code should be 0 + for permanent failures which are handled by RT, the status code + should be 0 - for succces, the status code should be 1 + for succces, the status code should be 1 @@ -398,89 +517,66 @@ Returns: sub Gateway { my $argsref = shift; + my %args = ( + action => 'correspond', + queue => '1', + ticket => undef, + message => undef, + %$argsref + ); - my %args = %$argsref; - - # Set some reasonable defaults - $args{'action'} = 'correspond' unless ( $args{'action'} ); - $args{'queue'} = '1' unless ( $args{'queue'} ); + my $SystemTicket; + my $Right; # Validate the action - unless ( $args{'action'} =~ /^(comment|correspond|action)$/ ) { - - # Can't safely loc this. What object do we loc around? - $RT::Logger->crit("Mail gateway called with an invalid action paramenter '".$args{'action'}."' for queue '".$args{'queue'}."'"); - - return ( -75, "Invalid 'action' parameter", undef ); + my ( $status, @actions ) = IsCorrectAction( $args{'action'} ); + unless ($status) { + return ( + -75, + "Invalid 'action' parameter " + . $actions[0] + . " for queue " + . $args{'queue'}, + undef + ); } my $parser = RT::EmailParser->new(); - my ( $fh, $temp_file ); - for ( 1 .. 10 ) { - - # on NFS and NTFS, it is possible that tempfile() conflicts - # with other processes, causing a race condition. we try to - # accommodate this by pausing and retrying. - last if ( $fh, $temp_file ) = eval { File::Temp::tempfile(undef, UNLINK => 0) }; - sleep 1; - } - if ($fh) { - binmode $fh; #thank you, windows - $fh->autoflush(1); - print $fh $args{'message'}; - close($fh); - - if ( -f $temp_file ) { - $parser->ParseMIMEEntityFromFile($temp_file); - unlink( $temp_file ); - if ($parser->Entity) { - delete $args{'message'}; - } - } - - } - - #If for some reason we weren't able to parse the message using a temp file - # try it with a scalar - if ($args{'message'}) { - $parser->ParseMIMEEntityFromScalar($args{'message'}); - - } + $parser->SmartParseMIMEEntityFromScalar( Message => $args{'message'} ); + my $Message = $parser->Entity(); - if (!$parser->Entity()) { + unless ($Message) { MailError( To => $RT::OwnerEmail, Subject => "RT Bounce: Unparseable message", Explanation => "RT couldn't process the message below", - Attach => $args{'message'} + Attach => $args{'message'} ); - return(0,"Failed to parse this message. Something is likely badly wrong with the message"); + return ( 0, + "Failed to parse this message. Something is likely badly wrong with the message" + ); } - my $Message = $parser->Entity(); - my $head = $Message->head; - - my ( $CurrentUser, $AuthStat, $status, $error ); - - # Initalize AuthStat so comparisons work correctly - $AuthStat = -9999999; + my $head = $Message->head; my $ErrorsTo = ParseErrorsToAddressFromHead($head); - my $MessageId = $head->get('Message-Id') - || ""; + my $MessageId = $head->get('Message-ID') + || ""; #Pull apart the subject line my $Subject = $head->get('Subject') || ''; chomp $Subject; - $args{'ticket'} ||= $parser->ParseTicketId($Subject); + $args{'ticket'} ||= ParseTicketId($Subject); - my $SystemTicket; - if ( $args{'ticket'} ) { - $SystemTicket = RT::Ticket->new($RT::SystemUser); - $SystemTicket->Load( $args{'ticket'} ); + $SystemTicket = RT::Ticket->new($RT::SystemUser); + $SystemTicket->Load( $args{'ticket'} ) if ( $args{'ticket'} ) ; + if ( $SystemTicket->id ) { + $Right = 'ReplyToTicket'; + } else { + $Right = 'CreateTicket'; } #Set up a queue object @@ -488,175 +584,124 @@ sub Gateway { $SystemQueueObj->Load( $args{'queue'} ); # We can safely have no queue of we have a known-good ticket - unless ( $args{'ticket'} || $SystemQueueObj->id ) { + unless ( $SystemTicket->id || $SystemQueueObj->id ) { return ( -75, "RT couldn't find the queue: " . $args{'queue'}, undef ); } - # Authentication Level + # Authentication Level ($AuthStat) # -1 - Get out. this user has been explicitly declined # 0 - User may not do anything (Not used at the moment) # 1 - Normal user # 2 - User is allowed to specify status updates etc. a la enhanced-mailgate + my ( $CurrentUser, $AuthStat, $error ); + + # Initalize AuthStat so comparisons work correctly + $AuthStat = -9999999; push @RT::MailPlugins, "Auth::MailFrom" unless @RT::MailPlugins; - # Since this needs loading, no matter what + # if plugin returns AuthStat -2 we skip action + # NOTE: this is experimental API and it would be changed + my %skip_action = (); - for (@RT::MailPlugins) { - my $Code; - my $NewAuthStat; + # Since this needs loading, no matter what + foreach (@RT::MailPlugins) { + my ($Code, $NewAuthStat); if ( ref($_) eq "CODE" ) { $Code = $_; - } - else { - $_ = "RT::Interface::Email::$_" unless /^RT::Interface::Email::/; - eval "require $_;"; - if ($@) { - die ("Couldn't load module $_: $@"); - next; - } + } else { + my $Class = $_; + $Class = "RT::Interface::Email::" . $Class + unless $Class =~ /^RT::Interface::Email::/; + $Class->require or + do { $RT::Logger->error("Couldn't load $Class: $@"); next }; + no strict 'refs'; - if ( !defined( $Code = *{ $_ . "::GetCurrentUser" }{CODE} ) ) { - die ("No GetCurrentUser code found in $_ module"); + unless ( defined( $Code = *{ $Class . "::GetCurrentUser" }{CODE} ) ) { + $RT::Logger->crit( "No 'GetCurrentUser' function found in '$Class' module"); next; } } - ( $CurrentUser, $NewAuthStat ) = $Code->( - Message => $Message, - CurrentUser => $CurrentUser, - AuthLevel => $AuthStat, - Action => $args{'action'}, - Ticket => $SystemTicket, - Queue => $SystemQueueObj - ); + foreach my $action (@actions) { + ( $CurrentUser, $NewAuthStat ) = $Code->( + Message => $Message, + RawMessageRef => \$args{'message'}, + CurrentUser => $CurrentUser, + AuthLevel => $AuthStat, + Action => $action, + Ticket => $SystemTicket, + Queue => $SystemQueueObj + ); - # If a module returns a "-1" then we discard the ticket, so. - $AuthStat = -1 if $NewAuthStat == -1; +# You get the highest level of authentication you were assigned, unless you get the magic -1 +# If a module returns a "-1" then we discard the ticket, so. + $AuthStat = $NewAuthStat + if ( $NewAuthStat > $AuthStat or $NewAuthStat == -1 or $NewAuthStat == -2 ); + + last if $AuthStat == -1; + $skip_action{$action}++ if $AuthStat == -2; + } - # You get the highest level of authentication you were assigned. - $AuthStat = $NewAuthStat if $NewAuthStat > $AuthStat; last if $AuthStat == -1; } - # {{{ If authentication fails and no new user was created, get out. - if ( !$CurrentUser or !$CurrentUser->Id or $AuthStat == -1 ) { + if ( !$CurrentUser || !$CurrentUser->id || $AuthStat == -1 ) { # If the plugins refused to create one, they lose. unless ( $AuthStat == -1 ) { - - # Notify the RT Admin of the failure. - # XXX Should this be configurable? - MailError( - To => $RT::OwnerEmail, - Subject => "Could not load a valid user", - Explanation => < $Message, - LogLevel => 'error' + _NoAuthorizedUserFound( + Right => $Right, + Message => $Message, + Requestor => $ErrorsTo, + Queue => $args{'queue'} ); - # Also notify the requestor that his request has been dropped. - MailError( - To => $ErrorsTo, - Subject => "Could not load a valid user", - Explanation => < $Message, - LogLevel => 'error' - ); } return ( 0, "Could not load a valid user", undef ); } - # }}} - - # {{{ Lets check for mail loops of various sorts. - my $IsAutoGenerated = CheckForAutoGenerated($head); - - my $IsSuspiciousSender = CheckForSuspiciousSender($head); - - my $IsALoop = CheckForLoops($head); - - my $SquelchReplies = 0; - - #If the message is autogenerated, we need to know, so we can not - # send mail to the sender - if ( $IsSuspiciousSender || $IsAutoGenerated || $IsALoop ) { - $SquelchReplies = 1; - $ErrorsTo = $RT::OwnerEmail; - } - - # }}} - - # {{{ Drop it if it's disallowed + # If we got a user, but they don't have the right to say things if ( $AuthStat == 0 ) { MailError( To => $ErrorsTo, Subject => "Permission Denied", - Explanation => "You do not have permission to communicate with RT", - MIMEObj => $Message + Explanation => + "You do not have permission to communicate with RT", + MIMEObj => $Message ); - } - - # }}} - # {{{ Warn someone if it's a loop - - # Warn someone if it's a loop, before we drop it on the ground - if ($IsALoop) { - $RT::Logger->crit("RT Recieved mail ($MessageId) from itself."); - - #Should we mail it to RTOwner? - if ($RT::LoopsToRTOwner) { - MailError( - To => $RT::OwnerEmail, - Subject => "RT Bounce: $Subject", - Explanation => "RT thinks this message may be a bounce", - MIMEObj => $Message - ); - - #Do we actually want to store it? - return ( 0, "Message Bounced", undef ) unless ($RT::StoreLoops); - } - } - - # }}} - - # {{{ Squelch replies if necessary - # Don't let the user stuff the RT-Squelch-Replies-To header. - if ( $head->get('RT-Squelch-Replies-To') ) { - $head->add( - 'RT-Relocated-Squelch-Replies-To', - $head->get('RT-Squelch-Replies-To') + return ( + 0, + "$ErrorsTo tried to submit a message to " + . $args{'Queue'} + . " without permission.", + undef ); - $head->delete('RT-Squelch-Replies-To'); } - if ($SquelchReplies) { - ## TODO: This is a hack. It should be some other way to - ## indicate that the transaction should be "silent". - - my ( $Sender, $junk ) = ParseSenderAddressFromHead($head); - $head->add( 'RT-Squelch-Replies-To', $Sender ); + # {{{ Lets check for mail loops of various sorts. + my ($continue, $result); + ( $continue, $ErrorsTo, $result ) = _HandleMachineGeneratedMail( + Message => $Message, + ErrorsTo => $ErrorsTo, + Subject => $Subject, + MessageId => $MessageId + ); + + unless ($continue) { + return ( 0, $result, undef ); } + + # strip actions we should skip + @actions = grep !$skip_action{$_}, @actions; - # }}} + # if plugin's updated SystemTicket then update arguments + $args{'ticket'} = $SystemTicket->Id if $SystemTicket && $SystemTicket->Id; my $Ticket = RT::Ticket->new($CurrentUser); - # {{{ If we don't have a ticket Id, we're creating a new ticket - if ( !$args{'ticket'} ) { - - # {{{ Create a new ticket + if ( !$args{'ticket'} && grep /^(comment|correspond)$/, @actions ) + { my @Cc; my @Requestors = ( $CurrentUser->id ); @@ -683,80 +728,241 @@ EOT Explanation => $ErrStr, MIMEObj => $Message ); - $RT::Logger->error("Create failed: $id / $Transaction / $ErrStr "); - return ( 0, "Ticket creation failed", $Ticket ); + return ( 0, "Ticket creation failed: $ErrStr", $Ticket ); } - # }}} - } + # strip comments&corresponds from the actions we don't need + # to record them if we've created the ticket just now + @actions = grep !/^(comment|correspond)$/, @actions; + $args{'ticket'} = $id; - # }}} + } else { - # If the action is comment, add a comment. - elsif ( $args{'action'} =~ /^(comment|correspond)$/i ) { $Ticket->Load( $args{'ticket'} ); unless ( $Ticket->Id ) { - my $message = "Could not find a ticket with id " . $args{'ticket'}; + my $error = "Could not find a ticket with id " . $args{'ticket'}; MailError( To => $ErrorsTo, Subject => "Message not recorded", - Explanation => $message, + Explanation => $error, MIMEObj => $Message ); - return ( 0, $message ); + return ( 0, $error ); } + } - my ( $status, $msg ); - if ( $args{'action'} =~ /^correspond$/ ) { - ( $status, $msg ) = $Ticket->Correspond( MIMEObj => $Message ); + # }}} + foreach my $action (@actions) { + + # If the action is comment, add a comment. + if ( $action =~ /^(?:comment|correspond)$/i ) { + my $method = ucfirst lc $action; + my ( $status, $msg ) = $Ticket->$method( MIMEObj => $Message ); + unless ($status) { + + #Warn the sender that we couldn't actually submit the comment. + MailError( + To => $ErrorsTo, + Subject => "Message not recorded", + Explanation => $msg, + MIMEObj => $Message + ); + return ( 0, "Message not recorded: $msg", $Ticket ); + } + } elsif ($RT::UnsafeEmailCommands) { + my ( $status, $msg ) = _RunUnsafeAction( + Action => $action, + ErrorsTo => $ErrorsTo, + Message => $Message, + Ticket => $Ticket, + CurrentUser => $CurrentUser, + ); + return ($status, $msg, $Ticket) unless $status == 1; } - else { - ( $status, $msg ) = $Ticket->Comment( MIMEObj => $Message ); + } + return ( 1, "Success", $Ticket ); +} + +sub _RunUnsafeAction { + my %args = ( + Action => undef, + ErrorsTo => undef, + Message => undef, + Ticket => undef, + CurrentUser => undef, + @_ + ); + + if ( $args{'Action'} =~ /^take$/i ) { + my ( $status, $msg ) = $args{'Ticket'}->SetOwner( $args{'CurrentUser'}->id ); + unless ($status) { + MailError( + To => $args{'ErrorsTo'}, + Subject => "Ticket not taken", + Explanation => $msg, + MIMEObj => $args{'Message'} + ); + return ( 0, "Ticket not taken" ); } + } elsif ( $args{'Action'} =~ /^resolve$/i ) { + my ( $status, $msg ) = $args{'Ticket'}->SetStatus('resolved'); unless ($status) { #Warn the sender that we couldn't actually submit the comment. MailError( - To => $ErrorsTo, - Subject => "Message not recorded", + To => $args{'ErrorsTo'}, + Subject => "Ticket not resolved", Explanation => $msg, - MIMEObj => $Message + MIMEObj => $args{'Message'} ); - return ( 0, "Message not recorded", $Ticket ); + return ( 0, "Ticket not resolved" ); } + } else { + return ( 0, "Not supported unsafe action $args{'Action'}", $args{'Ticket'} ); } + return ( 1, "Success" ); +} - else { +=head2 _NoAuthorizedUserFound - #Return mail to the sender with an error - MailError( - To => $ErrorsTo, - Subject => "RT Configuration error", - Explanation => "'" - . $args{'action'} - . "' not a recognized action." - . " Your RT administrator has misconfigured " - . "the mail aliases which invoke RT", - MIMEObj => $Message - ); - $RT::Logger->crit( $args{'action'} . " type unknown for $MessageId" ); - return ( - -75, - "Configuration error: " - . $args{'action'} - . " not a recognized action", - $Ticket +Emails the RT Owner and the requestor when the auth plugins return "No auth user found" + +=cut + +sub _NoAuthorizedUserFound { + my %args = ( + Right => undef, + Message => undef, + Requestor => undef, + Queue => undef, + @_ + ); + + # Notify the RT Admin of the failure. + MailError( + To => $RT::OwnerEmail, + Subject => "Could not load a valid user", + Explanation => < $args{'Message'}, + LogLevel => 'error' + ); + + # Also notify the requestor that his request has been dropped. + MailError( + To => $args{'Requestor'}, + Subject => "Could not load a valid user", + Explanation => < $args{'Message'}, + LogLevel => 'error' + ); +} + +=head2 _HandleMachineGeneratedMail + +Takes named params: + Message + ErrorsTo + Subject + +Checks the message to see if it's a bounce, if it looks like a loop, if it's autogenerated, etc. +Returns a triple of ("Should we continue (boolean)", "New value for $ErrorsTo", "Status message"); + +=cut + +sub _HandleMachineGeneratedMail { + my %args = ( Message => undef, ErrorsTo => undef, Subject => undef, MessageId => undef, @_ ); + my $head = $args{'Message'}->head; + my $ErrorsTo = $args{'ErrorsTo'}; + + my $IsBounce = CheckForBounce($head); + + my $IsAutoGenerated = CheckForAutoGenerated($head); + + my $IsSuspiciousSender = CheckForSuspiciousSender($head); + + my $IsALoop = CheckForLoops($head); + + my $SquelchReplies = 0; + + #If the message is autogenerated, we need to know, so we can not + # send mail to the sender + if ( $IsBounce || $IsSuspiciousSender || $IsAutoGenerated || $IsALoop ) { + $SquelchReplies = 1; + $ErrorsTo = $RT::OwnerEmail; + } + + # Warn someone if it's a loop, before we drop it on the ground + if ($IsALoop) { + $RT::Logger->crit("RT Recieved mail (".$args{MessageId}.") from itself."); + + #Should we mail it to RTOwner? + if ($RT::LoopsToRTOwner) { + MailError( + To => $RT::OwnerEmail, + Subject => "RT Bounce: ".$args{'Subject'}, + Explanation => "RT thinks this message may be a bounce", + MIMEObj => $args{Message} + ); + } + + #Do we actually want to store it? + return ( 0, $ErrorsTo, "Message Bounced" ) unless ($RT::StoreLoops); + } + + # Squelch replies if necessary + # Don't let the user stuff the RT-Squelch-Replies-To header. + if ( $head->get('RT-Squelch-Replies-To') ) { + $head->add( + 'RT-Relocated-Squelch-Replies-To', + $head->get('RT-Squelch-Replies-To') ); + $head->delete('RT-Squelch-Replies-To'); + } + + if ($SquelchReplies) { + # Squelch replies to the sender, and also leave a clue to + # allow us to squelch ALL outbound messages. This way we + # can punt the logic of "what to do when we get a bounce" + # to the scrip. We might want to notify nobody. Or just + # the RT Owner. Or maybe all Privileged watchers. + my ( $Sender, $junk ) = ParseSenderAddressFromHead($head); + $head->add( 'RT-Squelch-Replies-To', $Sender ); + $head->add( 'RT-DetectedAutoGenerated', 'true' ); } + return ( 1, $ErrorsTo, "Handled machine detection" ); +} - return ( 1, "Success", $Ticket ); +=head2 IsCorrectAction + +Returns a list of valid actions we've found for this message + +=cut + +sub IsCorrectAction { + my $action = shift; + my @actions = split /-/, $action; + foreach (@actions) { + return ( 0, $_ ) unless /^(?:comment|correspond|take|resolve)$/; + } + return ( 1, @actions ); } eval "require RT::Interface::Email_Vendor"; -die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email_Vendor.pm}); +die $@ if ( $@ && $@ !~ qr{^Can't locate RT/Interface/Email_Vendor.pm} ); eval "require RT::Interface::Email_Local"; -die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email_Local.pm}); +die $@ if ( $@ && $@ !~ qr{^Can't locate RT/Interface/Email_Local.pm} ); 1;