]> git.ipfire.org Git - thirdparty/git.git/blame - git-send-email.perl
Merge branch 'maint'
[thirdparty/git.git] / git-send-email.perl
CommitLineData
83b24437 1#!/usr/bin/perl -w
83b24437 2#
f3d9f354
RA
3# Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4# Copyright 2005 Ryan Anderson <ryan@michonline.com>
83b24437
RA
5#
6# GPL v2 (See COPYING)
5825e5b2 7#
83b24437
RA
8# Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
9#
f3d9f354 10# Sends a collection of emails to the given email addresses, disturbingly fast.
5825e5b2 11#
f3d9f354
RA
12# Supports two formats:
13# 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches)
14# 2. The original format support by Greg's script:
5825e5b2 15# first line of the message is who to CC,
f3d9f354 16# and second line is the subject of the message.
5825e5b2 17#
83b24437
RA
18
19use strict;
20use warnings;
21use Term::ReadLine;
83b24437
RA
22use Getopt::Long;
23use Data::Dumper;
412876dc 24use Term::ANSIColor;
3cb8caf7 25use Git;
83b24437 26
280242d1
JH
27package FakeTerm;
28sub new {
29 my ($class, $reason) = @_;
30 return bless \$reason, shift;
31}
32sub readline {
33 my $self = shift;
34 die "Cannot use readline on FakeTerm: $$self";
35}
36package main;
37
1b0baf14
MC
38
39sub usage {
40 print <<EOT;
1b1dd23f 41git send-email [options] <file | directory>...
1b0baf14
MC
42Options:
43 --from Specify the "From:" line of the email to be sent.
44
45 --to Specify the primary "To:" line of the email.
46
47 --cc Specify an initial "Cc:" list for the entire series
48 of emails.
49
324a8bd0
JP
50 --cc-cmd Specify a command to execute per file which adds
51 per file specific cc address entries
52
1b0baf14
MC
53 --bcc Specify a list of email addresses that should be Bcc:
54 on all the emails.
55
ef0c2abf
AR
56 --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
57 an introductory message for the patch series.
1b0baf14
MC
58
59 --subject Specify the initial "Subject:" line.
60 Only necessary if --compose is also set. If --compose
61 is not set, this will be prompted for.
62
63 --in-reply-to Specify the first "In-Reply-To:" header line.
64 Only used if --compose is also set. If --compose is not
65 set, this will be prompted for.
66
67 --chain-reply-to If set, the replies will all be to the previous
68 email sent, rather than to the first email sent.
69 Defaults to on.
70
5483c71d
AR
71 --signed-off-cc Automatically add email addresses that appear in
72 Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
1b0baf14 73
34cc60ce
DS
74 --identity The configuration identity, a subsection to prioritise over
75 the default section.
76
1b0baf14 77 --smtp-server If set, specifies the outgoing SMTP server to use.
44b2476a
JH
78 Defaults to localhost. Port number can be specified here with
79 hostname:port format or by using --smtp-server-port option.
80
81 --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
1b0baf14 82
34cc60ce
DS
83 --smtp-user The username for SMTP-AUTH.
84
85 --smtp-pass The password for SMTP-AUTH.
86
f6bebd12
TR
87 --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
88 Any other value disables the feature.
89
90 --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
34cc60ce 91
65648283
DB
92 --suppress-cc Suppress the specified category of auto-CC. The category
93 can be one of 'author' for the patch author, 'self' to
94 avoid copying yourself, 'sob' for Signed-off-by lines,
95 'cccmd' for the output of the cccmd, or 'all' to suppress
96 all of these.
97
620bb245 98 --suppress-from Suppress sending emails to yourself. Defaults to off.
1b0baf14 99
5483c71d 100 --thread Specify that the "In-Reply-To:" header should be set on all
e46f7a0e
AR
101 emails. Defaults to on.
102
1b0baf14
MC
103 --quiet Make git-send-email less verbose. One line per email
104 should be all that is output.
105
238cc635
RJ
106 --dry-run Do everything except actually send the emails.
107
f073a592
RJ
108 --envelope-sender Specify the envelope sender used to send the emails.
109
c764a0c2
JK
110 --no-validate Don't perform any sanity checks on patches.
111
1b0baf14
MC
112EOT
113 exit(1);
114}
115
4bc87a28 116# most mail servers generate the Date: header, but not all...
6bdca890
JN
117sub format_2822_time {
118 my ($time) = @_;
119 my @localtm = localtime($time);
120 my @gmttm = gmtime($time);
121 my $localmin = $localtm[1] + $localtm[2] * 60;
122 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
123 if ($localtm[0] != $gmttm[0]) {
124 die "local zone differs from GMT by a non-minute interval\n";
125 }
126 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
127 $localmin += 1440;
128 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
129 $localmin -= 1440;
130 } elsif ($gmttm[6] != $localtm[6]) {
131 die "local time offset greater than or equal to 24 hours\n";
132 }
133 my $offset = $localmin - $gmtmin;
134 my $offhour = $offset / 60;
135 my $offmin = abs($offset % 60);
136 if (abs($offhour) >= 24) {
137 die ("local time offset greater than or equal to 24 hours\n");
138 }
139
140 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
141 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
142 $localtm[3],
143 qw(Jan Feb Mar Apr May Jun
144 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
145 $localtm[5]+1900,
146 $localtm[2],
147 $localtm[1],
148 $localtm[0],
149 ($offset >= 0) ? '+' : '-',
150 abs($offhour),
151 $offmin,
152 );
153}
4bc87a28 154
567ffeb7 155my $have_email_valid = eval { require Email::Valid; 1 };
4bc87a28 156my $smtp;
5f5b6118 157my $auth;
4bc87a28 158
e205735d 159sub unique_email_list(@);
1f038a0c
RA
160sub cleanup_compose_files();
161
162# Constants (essentially)
163my $compose_filename = ".msg.$$";
e205735d 164
83b24437 165# Variables we fill in automatically, or via prompting:
ce91c2f6 166my (@to,@cc,@initial_cc,@bcclist,@xh,
2363d746 167 $initial_reply_to,$initial_subject,@files,$author,$sender,$smtp_authpass,$compose,$time);
83b24437 168
f073a592 169my $envelope_sender;
78488b2c 170
9133261f 171# Example reply to:
83b24437 172#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
83b24437 173
ad79c024
FL
174my $repo = eval { Git->repository() };
175my @repo = $repo ? ($repo) : ();
280242d1 176my $term = eval {
0fb7fc75
JS
177 $ENV{"GIT_SEND_EMAIL_NOTTY"}
178 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
179 : new Term::ReadLine 'git-send-email';
280242d1
JH
180};
181if ($@) {
182 $term = new FakeTerm "$@: going non-interactive";
183}
83b24437 184
5483c71d
AR
185# Behavior modification variables
186my ($quiet, $dry_run) = (0, 0);
187
188# Variables with corresponding config settings
324a8bd0 189my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
f6bebd12 190my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_encryption);
44b2476a 191my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
c764a0c2 192my ($no_validate);
65648283 193my (@suppress_cc);
5483c71d 194
34cc60ce 195my %config_bool_settings = (
5483c71d
AR
196 "thread" => [\$thread, 1],
197 "chainreplyto" => [\$chain_reply_to, 1],
65648283
DB
198 "suppressfrom" => [\$suppress_from, undef],
199 "signedoffcc" => [\$signed_off_cc, undef],
e46f7a0e
AR
200);
201
34cc60ce
DS
202my %config_settings = (
203 "smtpserver" => \$smtp_server,
44b2476a 204 "smtpserverport" => \$smtp_server_port,
34cc60ce
DS
205 "smtpuser" => \$smtp_authuser,
206 "smtppass" => \$smtp_authpass,
2db9b49c 207 "to" => \@to,
5f8b9fcd 208 "cc" => \@initial_cc,
34cc60ce
DS
209 "cccmd" => \$cc_cmd,
210 "aliasfiletype" => \$aliasfiletype,
211 "bcc" => \@bcclist,
212 "aliasesfile" => \@alias_files,
65648283 213 "suppresscc" => \@suppress_cc,
9f7820ae 214 "envelopesender" => \$envelope_sender,
34cc60ce 215);
4a62d3f5 216
87429976
MW
217# Handle Uncouth Termination
218sub signal_handler {
219
220 # Make text normal
221 print color("reset"), "\n";
222
223 # SMTP password masked
224 system "stty echo";
225
226 # tmp files from --compose
227 if (-e $compose_filename) {
228 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
229 }
230 if (-e ($compose_filename . ".final")) {
231 print "'$compose_filename.final' contains the composed email.\n"
232 }
233
234 exit;
235};
236
237$SIG{TERM} = \&signal_handler;
238$SIG{INT} = \&signal_handler;
239
83b24437
RA
240# Begin by accumulating all the variables (defined above), that we will end up
241# needing, first, from the command line:
242
94638f89 243my $rc = GetOptions("sender|from=s" => \$sender,
83b24437
RA
244 "in-reply-to=s" => \$initial_reply_to,
245 "subject=s" => \$initial_subject,
246 "to=s" => \@to,
da140f8b 247 "cc=s" => \@initial_cc,
58063245 248 "bcc=s" => \@bcclist,
78488b2c 249 "chain-reply-to!" => \$chain_reply_to,
3342d850 250 "smtp-server=s" => \$smtp_server,
44b2476a 251 "smtp-server-port=s" => \$smtp_server_port,
34cc60ce 252 "smtp-user=s" => \$smtp_authuser,
2363d746 253 "smtp-pass:s" => \$smtp_authpass,
f6bebd12
TR
254 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
255 "smtp-encryption=s" => \$smtp_encryption,
34cc60ce 256 "identity=s" => \$identity,
1f038a0c 257 "compose" => \$compose,
30d08b34 258 "quiet" => \$quiet,
324a8bd0 259 "cc-cmd=s" => \$cc_cmd,
5483c71d 260 "suppress-from!" => \$suppress_from,
65648283 261 "suppress-cc=s" => \@suppress_cc,
5483c71d 262 "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
6130259c 263 "dry-run" => \$dry_run,
f073a592 264 "envelope-sender=s" => \$envelope_sender,
5483c71d 265 "thread!" => \$thread,
c764a0c2 266 "no-validate" => \$no_validate,
83b24437
RA
267 );
268
1b0baf14
MC
269unless ($rc) {
270 usage();
271}
272
34cc60ce
DS
273# Now, let's fill any that aren't set in with defaults:
274
275sub read_config {
276 my ($prefix) = @_;
277
278 foreach my $setting (keys %config_bool_settings) {
279 my $target = $config_bool_settings{$setting}->[0];
ad79c024 280 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
34cc60ce
DS
281 }
282
283 foreach my $setting (keys %config_settings) {
284 my $target = $config_settings{$setting};
285 if (ref($target) eq "ARRAY") {
286 unless (@$target) {
ad79c024 287 my @values = Git::config(@repo, "$prefix.$setting");
34cc60ce
DS
288 @$target = @values if (@values && defined $values[0]);
289 }
290 }
291 else {
ad79c024 292 $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
34cc60ce
DS
293 }
294 }
f6bebd12
TR
295
296 if (!defined $smtp_encryption) {
297 my $enc = Git::config(@repo, "$prefix.smtpencryption");
298 if (defined $enc) {
299 $smtp_encryption = $enc;
300 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
301 $smtp_encryption = 'ssl';
302 }
303 }
34cc60ce
DS
304}
305
306# read configuration from [sendemail "$identity"], fall back on [sendemail]
ad79c024 307$identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
34cc60ce
DS
308read_config("sendemail.$identity") if (defined $identity);
309read_config("sendemail");
310
311# fall back on builtin bool defaults
312foreach my $setting (values %config_bool_settings) {
313 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
314}
315
fa835cd5
TR
316# 'default' encryption is none -- this only prevents a warning
317$smtp_encryption = '' unless (defined $smtp_encryption);
318
65648283
DB
319# Set CC suppressions
320my(%suppress_cc);
321if (@suppress_cc) {
322 foreach my $entry (@suppress_cc) {
323 die "Unknown --suppress-cc field: '$entry'\n"
324 unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/;
325 $suppress_cc{$entry} = 1;
326 }
327}
328
329if ($suppress_cc{'all'}) {
330 foreach my $entry (qw (ccmd cc author self sob)) {
331 $suppress_cc{$entry} = 1;
332 }
333 delete $suppress_cc{'all'};
334}
335
336# If explicit old-style ones are specified, they trump --suppress-cc.
337$suppress_cc{'self'} = $suppress_from if defined $suppress_from;
ba51795c 338$suppress_cc{'sob'} = !$signed_off_cc if defined $signed_off_cc;
65648283
DB
339
340# Debugging, print out the suppressions.
341if (0) {
342 print "suppressions:\n";
343 foreach my $entry (keys %suppress_cc) {
344 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
345 }
346}
347
ad79c024
FL
348my ($repoauthor, $repocommitter);
349($repoauthor) = Git::ident_person(@repo, 'author');
350($repocommitter) = Git::ident_person(@repo, 'committer');
34cc60ce 351
79ee555b
EB
352# Verify the user input
353
354foreach my $entry (@to) {
355 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
356}
357
358foreach my $entry (@initial_cc) {
359 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
360}
361
362foreach my $entry (@bcclist) {
363 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
364}
365
994d6c66 366my %aliases;
994d6c66
EW
367my %parse_alias = (
368 # multiline formats can be supported in the future
369 mutt => sub { my $fh = shift; while (<$fh>) {
504ceab6 370 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
994d6c66
EW
371 my ($alias, $addr) = ($1, $2);
372 $addr =~ s/#.*$//; # mutt allows # comments
373 # commas delimit multiple addresses
374 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
375 }}},
376 mailrc => sub { my $fh = shift; while (<$fh>) {
377 if (/^alias\s+(\S+)\s+(.*)$/) {
378 # spaces delimit multiple addresses
379 $aliases{$1} = [ split(/\s+/, $2) ];
380 }}},
381 pine => sub { my $fh = shift; while (<$fh>) {
2d8ae400 382 if (/^(\S+)\t.*\t(.*)$/) {
994d6c66
EW
383 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
384 }}},
385 gnus => sub { my $fh = shift; while (<$fh>) {
386 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
387 $aliases{$1} = [ $2 ];
388 }}}
389);
390
3cb8caf7 391if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
994d6c66
EW
392 foreach my $file (@alias_files) {
393 open my $fh, '<', $file or die "opening $file: $!\n";
394 $parse_alias{$aliasfiletype}->($fh);
395 close $fh;
396 }
397}
398
94638f89 399($sender) = expand_aliases($sender) if defined $sender;
ae740a58 400
aa54892f
JK
401# Now that all the defaults are set, process the rest of the command line
402# arguments and collect up the files that need to be processed.
403for my $f (@ARGV) {
404 if (-d $f) {
405 opendir(DH,$f)
406 or die "Failed to opendir $f: $!";
407
408 push @files, grep { -f $_ } map { +$f . "/" . $_ }
409 sort readdir(DH);
410
300913bd 411 } elsif (-f $f or -p $f) {
aa54892f
JK
412 push @files, $f;
413
414 } else {
415 print STDERR "Skipping $f - not found.\n";
416 }
417}
418
c764a0c2
JK
419if (!$no_validate) {
420 foreach my $f (@files) {
300913bd
KB
421 unless (-p $f) {
422 my $error = validate_patch($f);
423 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
424 }
c764a0c2 425 }
747bbff9
JK
426}
427
aa54892f
JK
428if (@files) {
429 unless ($quiet) {
430 print $_,"\n" for (@files);
431 }
432} else {
433 print STDERR "\nNo patch files specified!\n\n";
434 usage();
435}
436
1f038a0c 437my $prompting = 0;
94638f89 438if (!defined $sender) {
ad79c024 439 $sender = $repoauthor || $repocommitter || '';
8a7c56e1
MW
440
441 while (1) {
94638f89 442 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
8a7c56e1
MW
443 last if defined $_;
444 print "\n";
445 }
8037d1a3 446
94638f89
UKK
447 $sender = $_ if ($_);
448 print "Emails will be sent from: ", $sender, "\n";
1f038a0c 449 $prompting++;
83b24437
RA
450}
451
452if (!@to) {
8a7c56e1
MW
453
454
455 while (1) {
456 $_ = $term->readline("Who should the emails be sent to? ", "");
457 last if defined $_;
458 print "\n";
459 }
460
83b24437 461 my $to = $_;
d1eb35b6 462 push @to, split /,\s*/, $to;
1f038a0c 463 $prompting++;
83b24437
RA
464}
465
994d6c66
EW
466sub expand_aliases {
467 my @cur = @_;
468 my @last;
469 do {
470 @last = @cur;
471 @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
472 } while (join(',',@cur) ne join(',',@last));
473 return @cur;
474}
475
476@to = expand_aliases(@to);
5b56aaa2 477@to = (map { sanitize_address($_) } @to);
994d6c66 478@initial_cc = expand_aliases(@initial_cc);
58063245 479@bcclist = expand_aliases(@bcclist);
994d6c66 480
1f038a0c 481if (!defined $initial_subject && $compose) {
8a7c56e1
MW
482 while (1) {
483 $_ = $term->readline("What subject should the initial email start with? ", $initial_subject);
484 last if defined $_;
485 print "\n";
486 }
487
83b24437 488 $initial_subject = $_;
1f038a0c 489 $prompting++;
83b24437
RA
490}
491
5483c71d 492if ($thread && !defined $initial_reply_to && $prompting) {
8a7c56e1
MW
493 while (1) {
494 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ", $initial_reply_to);
495 last if defined $_;
496 print "\n";
497 }
8037d1a3 498
83b24437
RA
499 $initial_reply_to = $_;
500}
1ca3d6ed 501if (defined $initial_reply_to) {
0fb7fc75
JS
502 $initial_reply_to =~ s/^\s*<?//;
503 $initial_reply_to =~ s/>?\s*$//;
504 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
ace9c2a9 505}
ace72086 506
34cc60ce 507if (!defined $smtp_server) {
aca7ad76
EW
508 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
509 if (-x $_) {
510 $smtp_server = $_;
511 last;
512 }
513 }
514 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
3342d850
RA
515}
516
1f038a0c
RA
517if ($compose) {
518 # Note that this does not need to be secure, but we will make a small
519 # effort to have it be unique
520 open(C,">",$compose_filename)
521 or die "Failed to open for writing $compose_filename: $!";
94638f89 522 print C "From $sender # This line is ignored.\n";
1f038a0c
RA
523 printf C "Subject: %s\n\n", $initial_subject;
524 printf C <<EOT;
525GIT: Please enter your email below.
526GIT: Lines beginning in "GIT: " will be removed.
527GIT: Consider including an overall diffstat or table of contents
528GIT: for the patch you are writing.
529
530EOT
531 close(C);
532
ad79c024 533 my $editor = $ENV{GIT_EDITOR} || Git::config(@repo, "core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi";
065096c2 534 system('sh', '-c', $editor.' "$@"', $editor, $compose_filename);
1f038a0c
RA
535
536 open(C2,">",$compose_filename . ".final")
537 or die "Failed to open $compose_filename.final : " . $!;
538
539 open(C,"<",$compose_filename)
540 or die "Failed to open $compose_filename : " . $!;
541
0706bd19
JK
542 my $need_8bit_cte = file_has_nonascii($compose_filename);
543 my $in_body = 0;
1f038a0c
RA
544 while(<C>) {
545 next if m/^GIT: /;
0706bd19
JK
546 if (!$in_body && /^\n$/) {
547 $in_body = 1;
548 if ($need_8bit_cte) {
549 print C2 "MIME-Version: 1.0\n",
550 "Content-Type: text/plain; ",
551 "charset=utf-8\n",
552 "Content-Transfer-Encoding: 8bit\n";
553 }
554 }
555 if (!$in_body && /^MIME-Version:/i) {
556 $need_8bit_cte = 0;
557 }
d54eaaa2
JK
558 if (!$in_body && /^Subject: ?(.*)/i) {
559 my $subject = $1;
560 $_ = "Subject: " .
561 ($subject =~ /[^[:ascii:]]/ ?
562 quote_rfc2047($subject) :
563 $subject) .
564 "\n";
565 }
1f038a0c
RA
566 print C2 $_;
567 }
568 close(C);
569 close(C2);
570
8a7c56e1 571 while (1) {
1f038a0c 572 $_ = $term->readline("Send this email? (y|n) ");
8a7c56e1
MW
573 last if defined $_;
574 print "\n";
575 }
1f038a0c
RA
576
577 if (uc substr($_,0,1) ne 'Y') {
578 cleanup_compose_files();
579 exit(0);
580 }
581
97394ee4 582 @files = ($compose_filename . ".final", @files);
1f038a0c
RA
583}
584
83b24437 585# Variables we set as part of the loop over files
af068d27 586our ($message_id, %mail, $subject, $reply_to, $references, $message);
83b24437 587
567ffeb7
EW
588sub extract_valid_address {
589 my $address = shift;
ad9c18f5 590 my $local_part_regexp = '[^<>"\s@]+';
09302e17 591 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
db3106b2
EW
592
593 # check for a local address:
ad9c18f5 594 return $address if ($address =~ /^($local_part_regexp)$/);
db3106b2 595
155197e6 596 $address =~ s/^\s*<(.*)>\s*$/$1/;
567ffeb7 597 if ($have_email_valid) {
ad9c18f5 598 return scalar Email::Valid->address($address);
567ffeb7
EW
599 } else {
600 # less robust/correct than the monster regexp in Email::Valid,
601 # but still does a 99% job, and one less dependency
ad9c18f5 602 $address =~ /($local_part_regexp\@$domain_regexp)/;
e96fd305 603 return $1;
567ffeb7
EW
604 }
605}
83b24437
RA
606
607# Usually don't need to change anything below here.
608
609# we make a "fake" message id by taking the current number
610# of seconds since the beginning of Unix time and tacking on
611# a random number to the end, in case we are called quicker than
612# 1 second since the last time we were called.
8037d1a3
RA
613
614# We'll setup a template for the message id, using the "from" address:
8037d1a3 615
be510cfe 616my ($message_id_stamp, $message_id_serial);
83b24437
RA
617sub make_message_id
618{
be510cfe
JH
619 my $uniq;
620 if (!defined $message_id_stamp) {
621 $message_id_stamp = sprintf("%s-%s", time, $$);
622 $message_id_serial = 0;
623 }
624 $message_id_serial++;
625 $uniq = "$message_id_stamp-$message_id_serial";
626
aeb59328 627 my $du_part;
94638f89
UKK
628 for ($sender, $repocommitter, $repoauthor) {
629 $du_part = extract_valid_address(sanitize_address($_));
630 last if (defined $du_part and $du_part ne '');
aeb59328 631 }
94638f89 632 if (not defined $du_part or $du_part eq '') {
aeb59328
JH
633 use Sys::Hostname qw();
634 $du_part = 'user@' . Sys::Hostname::hostname();
635 }
be510cfe
JH
636 my $message_id_template = "<%s-git-send-email-%s>";
637 $message_id = sprintf($message_id_template, $uniq, $du_part);
8037d1a3 638 #print "new message id = $message_id\n"; # Was useful for debugging
83b24437
RA
639}
640
641
642
a5370b16 643$time = time - scalar $#files;
83b24437 644
374c5905
JR
645sub unquote_rfc2047 {
646 local ($_) = @_;
8291db6f
JK
647 my $encoding;
648 if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
649 $encoding = $1;
374c5905
JR
650 s/_/ /g;
651 s/=([0-9A-F]{2})/chr(hex($1))/eg;
652 }
8291db6f 653 return wantarray ? ($_, $encoding) : $_;
374c5905
JR
654}
655
d54eaaa2
JK
656sub quote_rfc2047 {
657 local $_ = shift;
658 my $encoding = shift || 'utf-8';
659 s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
660 s/(.*)/=\?$encoding\?q\?$1\?=/;
661 return $_;
662}
663
5b56aaa2
UKK
664# use the simplest quoting being able to handle the recipient
665sub sanitize_address
732263d4
RJ
666{
667 my ($recipient) = @_;
5b56aaa2
UKK
668 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
669
670 if (not $recipient_name) {
671 return "$recipient";
672 }
673
674 # if recipient_name is already quoted, do nothing
675 if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
676 return $recipient;
677 }
678
679 # rfc2047 is needed if a non-ascii char is included
680 if ($recipient_name =~ /[^[:ascii:]]/) {
d54eaaa2 681 $recipient_name = quote_rfc2047($recipient_name);
732263d4 682 }
5b56aaa2
UKK
683
684 # double quotes are needed if specials or CTLs are included
685 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
18023c20 686 $recipient_name =~ s/(["\\\r])/\\$1/g;
5b56aaa2
UKK
687 $recipient_name = "\"$recipient_name\"";
688 }
689
690 return "$recipient_name $recipient_addr";
691
732263d4
RJ
692}
693
83b24437
RA
694sub send_message
695{
4bc87a28 696 my @recipients = unique_email_list(@to);
7ac17529
ABH
697 @cc = (grep { my $cc = extract_valid_address($_);
698 not grep { $cc eq $_ } @recipients
699 }
700 map { sanitize_address($_) }
701 @cc);
4bc87a28 702 my $to = join (",\n\t", @recipients);
58063245 703 @recipients = unique_email_list(@recipients,@cc,@bcclist);
c38f0247 704 @recipients = (map { extract_valid_address($_) } @recipients);
6bdca890 705 my $date = format_2822_time($time++);
e923effb
ML
706 my $gitversion = '@@GIT_VERSION@@';
707 if ($gitversion =~ m/..GIT_VERSION../) {
3cb8caf7 708 $gitversion = Git::version();
e923effb 709 }
4bc87a28 710
af068d27 711 my $cc = join(", ", unique_email_list(@cc));
f06a6a49
JH
712 my $ccline = "";
713 if ($cc ne '') {
714 $ccline = "\nCc: $cc";
715 }
94638f89 716 my $sanitized_sender = sanitize_address($sender);
4f3d3703 717 make_message_id() unless defined($message_id);
aeb59328 718
94638f89 719 my $header = "From: $sanitized_sender
f06a6a49 720To: $to${ccline}
4bc87a28 721Subject: $subject
4bc87a28
EW
722Date: $date
723Message-Id: $message_id
e923effb 724X-Mailer: git-send-email $gitversion
4bc87a28 725";
5483c71d 726 if ($thread && $reply_to) {
7ccf7927
RA
727
728 $header .= "In-Reply-To: $reply_to\n";
729 $header .= "References: $references\n";
730 }
ce91c2f6
JH
731 if (@xh) {
732 $header .= join("\n", @xh) . "\n";
733 }
4bc87a28 734
c38f0247 735 my @sendmail_parameters = ('-i', @recipients);
94638f89 736 my $raw_from = $sanitized_sender;
f073a592
RJ
737 $raw_from = $envelope_sender if (defined $envelope_sender);
738 $raw_from = extract_valid_address($raw_from);
739 unshift (@sendmail_parameters,
740 '-f', $raw_from) if(defined $envelope_sender);
8e3d436b 741
6130259c
MW
742 if ($dry_run) {
743 # We don't want to send the email.
744 } elsif ($smtp_server =~ m#^/#) {
aca7ad76
EW
745 my $pid = open my $sm, '|-';
746 defined $pid or die $!;
747 if (!$pid) {
8e3d436b 748 exec($smtp_server, @sendmail_parameters) or die $!;
aca7ad76
EW
749 }
750 print $sm "$header\n$message";
751 close $sm or die $?;
752 } else {
44b2476a
JH
753
754 if (!defined $smtp_server) {
755 die "The required SMTP server is not properly defined."
756 }
757
f6bebd12 758 if ($smtp_encryption eq 'ssl') {
44b2476a 759 $smtp_server_port ||= 465; # ssmtp
34cc60ce 760 require Net::SMTP::SSL;
44b2476a 761 $smtp ||= Net::SMTP::SSL->new($smtp_server, Port => $smtp_server_port);
34cc60ce
DS
762 }
763 else {
764 require Net::SMTP;
44b2476a
JH
765 $smtp ||= Net::SMTP->new((defined $smtp_server_port)
766 ? "$smtp_server:$smtp_server_port"
767 : $smtp_server);
f6bebd12
TR
768 if ($smtp_encryption eq 'tls') {
769 require Net::SMTP::SSL;
770 $smtp->command('STARTTLS');
771 $smtp->response();
772 if ($smtp->code == 220) {
773 $smtp = Net::SMTP::SSL->start_SSL($smtp)
774 or die "STARTTLS failed! ".$smtp->message;
6cbf8b00 775 $smtp_encryption = '';
9d1ccf5e
RS
776 # Send EHLO again to receive fresh
777 # supported commands
778 $smtp->hello();
f6bebd12
TR
779 } else {
780 die "Server does not support STARTTLS! ".$smtp->message;
781 }
782 }
44b2476a
JH
783 }
784
785 if (!$smtp) {
786 die "Unable to initialize SMTP properly. Is there something wrong with your config?";
787 }
788
2363d746
MW
789 if (defined $smtp_authuser) {
790
791 if (!defined $smtp_authpass) {
792
793 system "stty -echo";
794
795 do {
796 print "Password: ";
797 $_ = <STDIN>;
798 print "\n";
799 } while (!defined $_);
800
801 chomp($smtp_authpass = $_);
802
803 system "stty echo";
804 }
805
5f5b6118 806 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
34cc60ce 807 }
2363d746 808
2b69bfc2 809 $smtp->mail( $raw_from ) or die $smtp->message;
aca7ad76
EW
810 $smtp->to( @recipients ) or die $smtp->message;
811 $smtp->data or die $smtp->message;
812 $smtp->datasend("$header\n$message") or die $smtp->message;
813 $smtp->dataend() or die $smtp->message;
814 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
815 }
2718435b 816 if ($quiet) {
71c7da94 817 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
2718435b 818 } else {
b7f30e0a 819 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
2b69bfc2 820 if ($smtp_server !~ m#^/#) {
aca7ad76 821 print "Server: $smtp_server\n";
2b69bfc2
RJ
822 print "MAIL FROM:<$raw_from>\n";
823 print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
aca7ad76 824 } else {
8e3d436b 825 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
aca7ad76 826 }
b7f30e0a 827 print $header, "\n";
aca7ad76
EW
828 if ($smtp) {
829 print "Result: ", $smtp->code, ' ',
830 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
831 } else {
832 print "Result: OK\n";
833 }
30d08b34 834 }
83b24437
RA
835}
836
83b24437 837$reply_to = $initial_reply_to;
2186d566 838$references = $initial_reply_to || '';
83b24437
RA
839$subject = $initial_subject;
840
841foreach my $t (@files) {
83b24437
RA
842 open(F,"<",$t) or die "can't open file $t";
843
94638f89 844 my $author = undef;
8291db6f
JK
845 my $author_encoding;
846 my $has_content_type;
847 my $body_encoding;
da140f8b 848 @cc = @initial_cc;
ce91c2f6 849 @xh = ();
e6b0964a 850 my $input_format = undef;
83b24437
RA
851 my $header_done = 0;
852 $message = "";
853 while(<F>) {
854 if (!$header_done) {
e6b0964a
JH
855 if (/^From /) {
856 $input_format = 'mbox';
857 next;
858 }
83b24437 859 chomp;
e6b0964a
JH
860 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
861 $input_format = 'mbox';
862 }
83b24437 863
e6b0964a 864 if (defined $input_format && $input_format eq 'mbox') {
83b24437
RA
865 if (/^Subject:\s+(.*)$/) {
866 $subject = $1;
867
868 } elsif (/^(Cc|From):\s+(.*)$/) {
94638f89 869 if (unquote_rfc2047($2) eq $sender) {
65648283 870 next if ($suppress_cc{'self'});
8a8e6235 871 }
68d42c41 872 elsif ($1 eq 'From') {
8291db6f
JK
873 ($author, $author_encoding)
874 = unquote_rfc2047($2);
65648283
DB
875 next if ($suppress_cc{'author'});
876 } else {
877 next if ($suppress_cc{'cc'});
8a8e6235 878 }
83b24437 879 printf("(mbox) Adding cc: %s from line '%s'\n",
2718435b 880 $2, $_) unless $quiet;
83b24437
RA
881 push @cc, $2;
882 }
8291db6f
JK
883 elsif (/^Content-type:/i) {
884 $has_content_type = 1;
8892048d 885 if (/charset="?([^ "]+)/) {
8291db6f
JK
886 $body_encoding = $1;
887 }
888 push @xh, $_;
889 }
4f3d3703
JK
890 elsif (/^Message-Id: (.*)/i) {
891 $message_id = $1;
892 }
1d6a003a 893 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
ce91c2f6
JH
894 push @xh, $_;
895 }
83b24437
RA
896
897 } else {
898 # In the traditional
899 # "send lots of email" format,
900 # line 1 = cc
901 # line 2 = subject
902 # So let's support that, too.
e6b0964a 903 $input_format = 'lots';
65648283 904 if (@cc == 0 && !$suppress_cc{'cc'}) {
83b24437 905 printf("(non-mbox) Adding cc: %s from line '%s'\n",
2718435b 906 $_, $_) unless $quiet;
83b24437
RA
907
908 push @cc, $_;
909
910 } elsif (!defined $subject) {
911 $subject = $_;
912 }
913 }
5825e5b2 914
83b24437
RA
915 # A whitespace line will terminate the headers
916 if (m/^\s*$/) {
917 $header_done = 1;
918 }
919 } else {
920 $message .= $_;
65648283
DB
921 if (/^(Signed-off-by|Cc): (.*)$/i) {
922 next if ($suppress_cc{'sob'});
ba51795c 923 chomp;
abec100c 924 my $c = $2;
83b24437 925 chomp $c;
65648283 926 next if ($c eq $sender and $suppress_cc{'self'});
83b24437
RA
927 push @cc, $c;
928 printf("(sob) Adding cc: %s from line '%s'\n",
2718435b 929 $c, $_) unless $quiet;
83b24437
RA
930 }
931 }
932 }
933 close F;
324a8bd0 934
65648283 935 if (defined $cc_cmd && !$suppress_cc{'cccmd'}) {
324a8bd0
JP
936 open(F, "$cc_cmd $t |")
937 or die "(cc-cmd) Could not execute '$cc_cmd'";
938 while(<F>) {
939 my $c = $_;
940 $c =~ s/^\s*//g;
941 $c =~ s/\n$//g;
620bb245 942 next if ($c eq $sender and $suppress_from);
324a8bd0
JP
943 push @cc, $c;
944 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
945 $c, $cc_cmd) unless $quiet;
946 }
947 close F
948 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
949 }
950
94638f89
UKK
951 if (defined $author) {
952 $message = "From: $author\n\n$message";
8291db6f
JK
953 if (defined $author_encoding) {
954 if ($has_content_type) {
955 if ($body_encoding eq $author_encoding) {
956 # ok, we already have the right encoding
957 }
958 else {
959 # uh oh, we should re-encode
960 }
961 }
962 else {
963 push @xh,
964 'MIME-Version: 1.0',
8641ee3d
JK
965 "Content-Type: text/plain; charset=$author_encoding",
966 'Content-Transfer-Encoding: 8bit';
8291db6f
JK
967 }
968 }
8a8e6235 969 }
83b24437 970
83b24437
RA
971 send_message();
972
973 # set up for the next message
bc108f63 974 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
78488b2c 975 $reply_to = $message_id;
7ccf7927 976 if (length $references > 0) {
a925b89c 977 $references .= "\n $message_id";
7ccf7927
RA
978 } else {
979 $references = "$message_id";
980 }
78488b2c 981 }
4f3d3703 982 $message_id = undef;
83b24437 983}
e205735d 984
1f038a0c
RA
985if ($compose) {
986 cleanup_compose_files();
987}
988
989sub cleanup_compose_files() {
990 unlink($compose_filename, $compose_filename . ".final");
991
992}
993
4bc87a28 994$smtp->quit if $smtp;
e205735d
RA
995
996sub unique_email_list(@) {
997 my %seen;
998 my @emails;
999
1000 foreach my $entry (@_) {
db3106b2
EW
1001 if (my $clean = extract_valid_address($entry)) {
1002 $seen{$clean} ||= 0;
1003 next if $seen{$clean}++;
1004 push @emails, $entry;
1005 } else {
1006 print STDERR "W: unable to extract a valid address",
1007 " from: $entry\n";
1008 }
e205735d
RA
1009 }
1010 return @emails;
1011}
747bbff9
JK
1012
1013sub validate_patch {
1014 my $fn = shift;
1015 open(my $fh, '<', $fn)
1016 or die "unable to open $fn: $!\n";
1017 while (my $line = <$fh>) {
1018 if (length($line) > 998) {
1019 return "$.: patch contains a line longer than 998 characters";
1020 }
1021 }
1022 return undef;
1023}
0706bd19
JK
1024
1025sub file_has_nonascii {
1026 my $fn = shift;
1027 open(my $fh, '<', $fn)
1028 or die "unable to open $fn: $!\n";
1029 while (my $line = <$fh>) {
1030 return 1 if $line =~ /[^[:ascii:]]/;
1031 }
1032 return 0;
1033}