-
Notifications
You must be signed in to change notification settings - Fork 255
/
Email.pm
1739 lines (1379 loc) · 51.4 KB
/
Email.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (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.
#
# 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., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# 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;
use warnings;
use Email::Address;
use MIME::Entity;
use RT::EmailParser;
use File::Temp;
use UNIVERSAL::require;
use Mail::Mailer ();
use Text::ParseWords qw/shellwords/;
BEGIN {
use base 'Exporter';
use vars qw ( @EXPORT_OK);
# set the version for version checking
our $VERSION = 2.0;
# your exported package globals go here,
# as well as any optionally exported functions
@EXPORT_OK = qw(
&CreateUser
&GetMessageContent
&CheckForLoops
&CheckForSuspiciousSender
&CheckForAutoGenerated
&CheckForBounce
&MailError
&ParseCcAddressesFromHead
&ParseSenderAddressFromHead
&ParseErrorsToAddressFromHead
&ParseAddressFromHeader
&Gateway);
}
=head1 NAME
RT::Interface::Email - helper functions for parsing email sent to RT
=head1 SYNOPSIS
use lib "!!RT_LIB_PATH!!";
use lib "!!RT_ETC_PATH!!";
use RT::Interface::Email qw(Gateway CreateUser);
=head1 DESCRIPTION
=head1 METHODS
=head2 CheckForLoops HEAD
Takes a HEAD object of L<MIME::Head> class and returns true if the
message's been sent by this RT instance. Uses "X-RT-Loop-Prevention"
field of the head for test.
=cut
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->Config->Get('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;
}
=head2 CheckForSuspiciousSender HEAD
Takes a HEAD object of L<MIME::Head> class and returns true if sender
is suspicious. Suspicious means mailer daemon.
See also L</ParseSenderAddressFromHead>.
=cut
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 )
or ( $From eq "" ))
{
return (1);
}
return undef;
}
=head2 CheckForAutoGenerated HEAD
Takes a HEAD object of L<MIME::Head> class and returns true if message
is autogenerated. Checks 'Precedence' and 'X-FC-Machinegenerated'
fields of the head in tests.
=cut
sub CheckForAutoGenerated {
my $head = shift;
my $Precedence = $head->get("Precedence") || "";
if ( $Precedence =~ /^(bulk|junk)/i ) {
return (1);
}
# Per RFC3834, any Auto-Submitted header which is not "no" means
# it is auto-generated.
my $AutoSubmitted = $head->get("Auto-Submitted") || "";
if ( length $AutoSubmitted and $AutoSubmitted ne "no" ) {
return (1);
}
# 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 {
my $head = shift;
my $ReturnPath = $head->get("Return-path") || "";
return ( $ReturnPath =~ /<>/ );
}
=head2 MailError PARAM HASH
Sends an error message. Takes a param hash:
=over 4
=item From - sender's address, by default is 'CorrespondAddress';
=item To - recipient, by default is 'OwnerEmail';
=item Bcc - optional Bcc recipients;
=item Subject - subject of the message, default is 'There has been an error';
=item Explanation - main content of the error, default value is 'Unexplained error';
=item MIMEObj - optional MIME entity that's attached to the error mail, as well we
add 'In-Reply-To' field to the error that points to this message.
=item Attach - optional text that attached to the error as 'message/rfc822' part.
=item LogLevel - log level under which we should write explanation message into the
log, by default we log it as critical.
=back
=cut
sub MailError {
my %args = (
To => RT->Config->Get('OwnerEmail'),
Bcc => undef,
From => RT->Config->Get('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'}
) if $args{'LogLevel'};
# the colons are necessary to make ->build include non-standard headers
my %entity_args = (
Type => "multipart/mixed",
From => $args{'From'},
Bcc => $args{'Bcc'},
To => $args{'To'},
Subject => $args{'Subject'},
'X-RT-Loop-Prevention:' => RT->Config->Get('rtname'),
);
# only set precedence if the sysadmin wants us to
if (defined(RT->Config->Get('DefaultErrorMailPrecedence'))) {
$entity_args{'Precedence:'} = RT->Config->Get('DefaultErrorMailPrecedence');
}
my $entity = MIME::Entity->build(%entity_args);
SetInReplyTo( Message => $entity, InReplyTo => $args{'MIMEObj'} );
$entity->attach( Data => $args{'Explanation'} . "\n" );
if ( $args{'MIMEObj'} ) {
$args{'MIMEObj'}->sync_headers;
$entity->add_part( $args{'MIMEObj'} );
}
if ( $args{'Attach'} ) {
$entity->attach( Data => $args{'Attach'}, Type => 'message/rfc822' );
}
SendEmail( Entity => $entity, Bounce => 1 );
}
=head2 SendEmail Entity => undef, [ Bounce => 0, Ticket => undef, Transaction => undef ]
Sends an email (passed as a L<MIME::Entity> object C<ENTITY>) using
RT's outgoing mail configuration. If C<BOUNCE> is passed, and is a
true value, the message will be marked as an autogenerated error, if
possible. Sets Date field of the head to now if it's not set.
If the C<X-RT-Squelch> header is set to any true value, the mail will
not be sent. One use is to let extensions easily cancel outgoing mail.
Ticket and Transaction arguments are optional. If Transaction is
specified and Ticket is not then ticket of the transaction is
used, but only if the transaction belongs to a ticket.
Returns 1 on success, 0 on error or -1 if message has no recipients
and hasn't been sent.
=head3 Signing and Encrypting
This function as well signs and/or encrypts the message according to
headers of a transaction's attachment or properties of a ticket's queue.
To get full access to the configuration Ticket and/or Transaction
arguments must be provided, but you can force behaviour using Sign
and/or Encrypt arguments.
The following precedence of arguments are used to figure out if
the message should be encrypted and/or signed:
* if Sign or Encrypt argument is defined then its value is used
* else if Transaction's first attachment has X-RT-Sign or X-RT-Encrypt
header field then it's value is used
* else properties of a queue of the Ticket are used.
=cut
sub SendEmail {
my (%args) = (
Entity => undef,
Bounce => 0,
Ticket => undef,
Transaction => undef,
@_,
);
my $TicketObj = $args{'Ticket'};
my $TransactionObj = $args{'Transaction'};
foreach my $arg( qw(Entity Bounce) ) {
next unless defined $args{ lc $arg };
$RT::Logger->warning("'". lc($arg) ."' argument is deprecated, use '$arg' instead");
$args{ $arg } = delete $args{ lc $arg };
}
unless ( $args{'Entity'} ) {
$RT::Logger->crit( "Could not send mail without 'Entity' object" );
return 0;
}
my $msgid = $args{'Entity'}->head->get('Message-ID') || '';
chomp $msgid;
# If we don't have any recipients to send to, don't send a message;
unless ( $args{'Entity'}->head->get('To')
|| $args{'Entity'}->head->get('Cc')
|| $args{'Entity'}->head->get('Bcc') )
{
$RT::Logger->info( $msgid . " No recipients found. Not sending." );
return -1;
}
if ($args{'Entity'}->head->get('X-RT-Squelch')) {
$RT::Logger->info( $msgid . " Squelch header found. Not sending." );
return -1;
}
if ( $TransactionObj && !$TicketObj
&& $TransactionObj->ObjectType eq 'RT::Ticket' )
{
$TicketObj = $TransactionObj->Object;
}
if ( RT->Config->Get('GnuPG')->{'Enable'} ) {
my %crypt;
my $attachment;
$attachment = $TransactionObj->Attachments->First
if $TransactionObj;
foreach my $argument ( qw(Sign Encrypt) ) {
next if defined $args{ $argument };
if ( $attachment && defined $attachment->GetHeader("X-RT-$argument") ) {
$crypt{$argument} = $attachment->GetHeader("X-RT-$argument");
} elsif ( $TicketObj ) {
$crypt{$argument} = $TicketObj->QueueObj->$argument();
}
}
my $res = SignEncrypt( %args, %crypt );
return $res unless $res > 0;
}
unless ( $args{'Entity'}->head->get('Date') ) {
require RT::Date;
my $date = RT::Date->new( RT->SystemUser );
$date->SetToNow;
$args{'Entity'}->head->set( 'Date', $date->RFC2822( Timezone => 'server' ) );
}
my $mail_command = RT->Config->Get('MailCommand');
if ($mail_command eq 'testfile' and not $Mail::Mailer::testfile::config{outfile}) {
$Mail::Mailer::testfile::config{outfile} = File::Temp->new;
$RT::Logger->info("Storing outgoing emails in $Mail::Mailer::testfile::config{outfile}");
}
# if it is a sub routine, we just return it;
return $mail_command->($args{'Entity'}) if UNIVERSAL::isa( $mail_command, 'CODE' );
if ( $mail_command eq 'sendmailpipe' ) {
my $path = RT->Config->Get('SendmailPath');
my @args = shellwords(RT->Config->Get('SendmailArguments'));
# SetOutgoingMailFrom and bounces conflict, since they both want -f
if ( $args{'Bounce'} ) {
push @args, shellwords(RT->Config->Get('SendmailBounceArguments'));
} elsif ( RT->Config->Get('SetOutgoingMailFrom') ) {
my $OutgoingMailAddress;
if ($TicketObj) {
my $QueueName = $TicketObj->QueueObj->Name;
my $QueueAddressOverride = RT->Config->Get('OverrideOutgoingMailFrom')->{$QueueName};
if ($QueueAddressOverride) {
$OutgoingMailAddress = $QueueAddressOverride;
} else {
$OutgoingMailAddress = $TicketObj->QueueObj->CorrespondAddress;
}
}
$OutgoingMailAddress ||= RT->Config->Get('OverrideOutgoingMailFrom')->{'Default'};
push @args, "-f", $OutgoingMailAddress
if $OutgoingMailAddress;
}
# VERP
if ( $TransactionObj and
my $prefix = RT->Config->Get('VERPPrefix') and
my $domain = RT->Config->Get('VERPDomain') )
{
my $from = $TransactionObj->CreatorObj->EmailAddress;
$from =~ s/@/=/g;
$from =~ s/\s//g;
push @args, "-f", "$prefix$from\@$domain";
}
eval {
# don't ignore CHLD signal to get proper exit code
local $SIG{'CHLD'} = 'DEFAULT';
# if something wrong with $mail->print we will get PIPE signal, handle it
local $SIG{'PIPE'} = sub { die "program unexpectedly closed pipe" };
require IPC::Open2;
my ($mail, $stdout);
my $pid = IPC::Open2::open2( $stdout, $mail, $path, @args )
or die "couldn't execute program: $!";
$args{'Entity'}->print($mail);
close $mail or die "close pipe failed: $!";
waitpid($pid, 0);
if ($?) {
# sendmail exit statuses mostly errors with data not software
# TODO: status parsing: core dump, exit on signal or EX_*
my $msg = "$msgid: `$path @args` exited with code ". ($?>>8);
$msg = ", interrupted by signal ". ($?&127) if $?&127;
$RT::Logger->error( $msg );
die $msg;
}
};
if ( $@ ) {
$RT::Logger->crit( "$msgid: Could not send mail with command `$path @args`: " . $@ );
if ( $TicketObj ) {
_RecordSendEmailFailure( $TicketObj );
}
return 0;
}
}
elsif ( $mail_command eq 'smtp' ) {
require Net::SMTP;
my $smtp = do { local $@; eval { Net::SMTP->new(
Host => RT->Config->Get('SMTPServer'),
Debug => RT->Config->Get('SMTPDebug'),
) } };
unless ( $smtp ) {
$RT::Logger->crit( "Could not connect to SMTP server.");
if ($TicketObj) {
_RecordSendEmailFailure( $TicketObj );
}
return 0;
}
# duplicate head as we want drop Bcc field
my $head = $args{'Entity'}->head->dup;
my @recipients = map $_->address, map
Email::Address->parse($head->get($_)), qw(To Cc Bcc);
$head->delete('Bcc');
my $sender = RT->Config->Get('SMTPFrom')
|| $args{'Entity'}->head->get('From');
chomp $sender;
my $status = $smtp->mail( $sender )
&& $smtp->recipient( @recipients );
if ( $status ) {
$smtp->data;
my $fh = $smtp->tied_fh;
$head->print( $fh );
print $fh "\n";
$args{'Entity'}->print_body( $fh );
$smtp->dataend;
}
$smtp->quit;
unless ( $status ) {
$RT::Logger->crit( "$msgid: Could not send mail via SMTP." );
if ( $TicketObj ) {
_RecordSendEmailFailure( $TicketObj );
}
return 0;
}
}
else {
local ($ENV{'MAILADDRESS'}, $ENV{'PERL_MAILERS'});
my @mailer_args = ($mail_command);
if ( $mail_command eq 'sendmail' ) {
$ENV{'PERL_MAILERS'} = RT->Config->Get('SendmailPath');
push @mailer_args, split(/\s+/, RT->Config->Get('SendmailArguments'));
}
else {
push @mailer_args, RT->Config->Get('MailParams');
}
unless ( $args{'Entity'}->send( @mailer_args ) ) {
$RT::Logger->crit( "$msgid: Could not send mail." );
if ( $TicketObj ) {
_RecordSendEmailFailure( $TicketObj );
}
return 0;
}
}
return 1;
}
=head2 PrepareEmailUsingTemplate Template => '', Arguments => {}
Loads a template. Parses it using arguments if it's not empty.
Returns a tuple (L<RT::Template> object, error message).
Note that even if a template object is returned MIMEObj method
may return undef for empty templates.
=cut
sub PrepareEmailUsingTemplate {
my %args = (
Template => '',
Arguments => {},
@_
);
my $template = RT::Template->new( RT->SystemUser );
$template->LoadGlobalTemplate( $args{'Template'} );
unless ( $template->id ) {
return (undef, "Couldn't load template '". $args{'Template'} ."'");
}
return $template if $template->IsEmpty;
my ($status, $msg) = $template->Parse( %{ $args{'Arguments'} } );
return (undef, $msg) unless $status;
return $template;
}
=head2 SendEmailUsingTemplate Template => '', Arguments => {}, From => CorrespondAddress, To => '', Cc => '', Bcc => ''
Sends email using a template, takes name of template, arguments for it and recipients.
=cut
sub SendEmailUsingTemplate {
my %args = (
Template => '',
Arguments => {},
To => undef,
Cc => undef,
Bcc => undef,
From => RT->Config->Get('CorrespondAddress'),
InReplyTo => undef,
ExtraHeaders => {},
@_
);
my ($template, $msg) = PrepareEmailUsingTemplate( %args );
return (0, $msg) unless $template;
my $mail = $template->MIMEObj;
unless ( $mail ) {
$RT::Logger->info("Message is not sent as template #". $template->id ." is empty");
return -1;
}
$mail->head->set( $_ => Encode::encode_utf8( $args{ $_ } ) )
foreach grep defined $args{$_}, qw(To Cc Bcc From);
$mail->head->set( $_ => $args{ExtraHeaders}{$_} )
foreach keys %{ $args{ExtraHeaders} };
SetInReplyTo( Message => $mail, InReplyTo => $args{'InReplyTo'} );
return SendEmail( Entity => $mail );
}
=head2 GetForwardFrom Ticket => undef, Transaction => undef
Resolve the From field to use in forward mail
=cut
sub GetForwardFrom {
my %args = ( Ticket => undef, Transaction => undef, @_ );
my $txn = $args{Transaction};
my $ticket = $args{Ticket} || $txn->Object;
if ( RT->Config->Get('ForwardFromUser') ) {
return ( $txn || $ticket )->CurrentUser->EmailAddress;
}
else {
return $ticket->QueueObj->CorrespondAddress
|| RT->Config->Get('CorrespondAddress');
}
}
=head2 GetForwardAttachments Ticket => undef, Transaction => undef
Resolve the Attachments to forward
=cut
sub GetForwardAttachments {
my %args = ( Ticket => undef, Transaction => undef, @_ );
my $txn = $args{Transaction};
my $ticket = $args{Ticket} || $txn->Object;
my $attachments = RT::Attachments->new( $ticket->CurrentUser );
if ($txn) {
$attachments->Limit( FIELD => 'TransactionId', VALUE => $txn->id );
}
else {
my $txns = $ticket->Transactions;
$txns->Limit(
FIELD => 'Type',
VALUE => $_,
) for qw(Create Correspond);
while ( my $txn = $txns->Next ) {
$attachments->Limit( FIELD => 'TransactionId', VALUE => $txn->id );
}
}
return $attachments;
}
=head2 SignEncrypt Entity => undef, Sign => 0, Encrypt => 0
Signs and encrypts message using L<RT::Crypt::GnuPG>, but as well
handle errors with users' keys.
If a recipient has no key or has other problems with it, then the
unction sends a error to him using 'Error: public key' template.
Also, notifies RT's owner using template 'Error to RT owner: public key'
to inform that there are problems with users' keys. Then we filter
all bad recipients and retry.
Returns 1 on success, 0 on error and -1 if all recipients are bad and
had been filtered out.
=cut
sub SignEncrypt {
my %args = (
Entity => undef,
Sign => 0,
Encrypt => 0,
@_
);
return 1 unless $args{'Sign'} || $args{'Encrypt'};
my $msgid = $args{'Entity'}->head->get('Message-ID') || '';
chomp $msgid;
$RT::Logger->debug("$msgid Signing message") if $args{'Sign'};
$RT::Logger->debug("$msgid Encrypting message") if $args{'Encrypt'};
require RT::Crypt::GnuPG;
my %res = RT::Crypt::GnuPG::SignEncrypt( %args );
return 1 unless $res{'exit_code'};
my @status = RT::Crypt::GnuPG::ParseStatus( $res{'status'} );
my @bad_recipients;
foreach my $line ( @status ) {
# if the passphrase fails, either you have a bad passphrase
# or gpg-agent has died. That should get caught in Create and
# Update, but at least throw an error here
if (($line->{'Operation'}||'') eq 'PassphraseCheck'
&& $line->{'Status'} =~ /^(?:BAD|MISSING)$/ ) {
$RT::Logger->error( "$line->{'Status'} PASSPHRASE: $line->{'Message'}" );
return 0;
}
next unless ($line->{'Operation'}||'') eq 'RecipientsCheck';
next if $line->{'Status'} eq 'DONE';
$RT::Logger->error( $line->{'Message'} );
push @bad_recipients, $line;
}
return 0 unless @bad_recipients;
$_->{'AddressObj'} = (Email::Address->parse( $_->{'Recipient'} ))[0]
foreach @bad_recipients;
foreach my $recipient ( @bad_recipients ) {
my $status = SendEmailUsingTemplate(
To => $recipient->{'AddressObj'}->address,
Template => 'Error: public key',
Arguments => {
%$recipient,
TicketObj => $args{'Ticket'},
TransactionObj => $args{'Transaction'},
},
);
unless ( $status ) {
$RT::Logger->error("Couldn't send 'Error: public key'");
}
}
my $status = SendEmailUsingTemplate(
To => RT->Config->Get('OwnerEmail'),
Template => 'Error to RT owner: public key',
Arguments => {
BadRecipients => \@bad_recipients,
TicketObj => $args{'Ticket'},
TransactionObj => $args{'Transaction'},
},
);
unless ( $status ) {
$RT::Logger->error("Couldn't send 'Error to RT owner: public key'");
}
DeleteRecipientsFromHead(
$args{'Entity'}->head,
map $_->{'AddressObj'}->address, @bad_recipients
);
unless ( $args{'Entity'}->head->get('To')
|| $args{'Entity'}->head->get('Cc')
|| $args{'Entity'}->head->get('Bcc') )
{
$RT::Logger->debug("$msgid No recipients that have public key, not sending");
return -1;
}
# redo without broken recipients
%res = RT::Crypt::GnuPG::SignEncrypt( %args );
return 0 if $res{'exit_code'};
return 1;
}
use MIME::Words ();
=head2 EncodeToMIME
Takes a hash with a String and a Charset. Returns the string encoded
according to RFC2047, using B (base64 based) encoding.
String must be a perl string, octets are returned.
If Charset is not provided then $EmailOutputEncoding config option
is used, or "latin-1" if that is not set.
=cut
sub EncodeToMIME {
my %args = (
String => undef,
Charset => undef,
@_
);
my $value = $args{'String'};
return $value unless $value; # 0 is perfect ascii
my $charset = $args{'Charset'} || RT->Config->Get('EmailOutputEncoding');
my $encoding = 'B';
# using RFC2047 notation, sec 2.
# encoded-word = "=?" charset "?" encoding "?" encoded-text "?="
# An 'encoded-word' may not be more than 75 characters long
#
# MIME encoding increases 4/3*(number of bytes), and always in multiples
# of 4. Thus we have to find the best available value of bytes available
# for each chunk.
#
# First we get the integer max which max*4/3 would fit on space.
# Then we find the greater multiple of 3 lower or equal than $max.
my $max = int(
( ( 75 - length( '=?' . $charset . '?' . $encoding . '?' . '?=' ) )
* 3
) / 4
);
$max = int( $max / 3 ) * 3;
chomp $value;
if ( $max <= 0 ) {
# gives an error...
$RT::Logger->crit("Can't encode! Charset or encoding too big.");
return ($value);
}
return ($value) if $value =~ /^(?:[\t\x20-\x7e]|\x0D*\x0A[ \t])+$/s;
$value =~ s/\s+$//;
# we need perl string to split thing char by char
Encode::_utf8_on($value) unless Encode::is_utf8($value);
my ( $tmp, @chunks ) = ( '', () );
while ( length $value ) {
my $char = substr( $value, 0, 1, '' );
my $octets = Encode::encode( $charset, $char );
if ( length($tmp) + length($octets) > $max ) {
push @chunks, $tmp;
$tmp = '';
}
$tmp .= $octets;
}
push @chunks, $tmp if length $tmp;
# encode an join chuncks
$value = join "\n ",
map MIME::Words::encode_mimeword( $_, $encoding, $charset ),
@chunks;
return ($value);
}
sub CreateUser {
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',
);
unless ($Val) {
# Deal with the race condition of two account creations at once
if ($Username) {
$NewUser->LoadByName($Username);
}
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',
);
}
}
#Load the new user object
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'
);
}
return $CurrentUser;
}
=head2 ParseCcAddressesFromHead HASH
Takes a hash containing QueueObj, Head and CurrentUser objects.
Returns a list of all email addresses in the To and Cc
headers b<except> 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 $current_address = lc $args{'CurrentUser'}->EmailAddress;
my $user = $args{'CurrentUser'}->UserObj;
return
grep $_ ne $current_address && !RT::EmailParser->IsRTAddress( $_ ),
map lc $user->CanonicalizeEmailAddress( $_->address ),
map Email::Address->parse( $args{'Head'}->get( $_ ) ),
qw(To Cc);
}
=head2 ParseSenderAddressFromHead HEAD
Takes a MIME::Header object. Returns a tuple: (user@host, friendly name)
of the From (evaluated in order of Reply-To:, From:, Sender)
=cut
sub ParseSenderAddressFromHead {
my $head = shift;
#Figure out who's sending this message.
foreach my $header ('Reply-To', 'From', 'Sender') {
my $addr_line = $head->get($header) || next;
my ($addr, $name) = ParseAddressFromHeader( $addr_line );
# only return if the address is not empty
return ($addr, $name) if $addr;
}
return (undef, undef);
}
=head2 ParseErrorsToAddressFromHead HEAD
Takes a MIME::Header object. Return a single value : user@host
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);
}
}
}
=head2 ParseAddressFromHeader ADDRESS
Takes an address from C<$head->get('Line')> and returns a tuple: user@host, friendly name
=cut
sub ParseAddressFromHeader {
my $Addr = shift;
# Some broken mailers send: ""Vincent, Jesse"" <jesse@fsck.com>. Hate
$Addr =~ s/\"\"(.*?)\"\"/\"$1\"/g;
my @Addresses = RT::EmailParser->ParseEmailAddress($Addr);
my ($AddrObj) = grep ref $_, @Addresses;
unless ( $AddrObj ) {
return ( undef, undef );
}