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