]> asedeno.scripts.mit.edu Git - git.git/blob - git-send-email.perl
send-email: --suppress-cc improvements
[git.git] / git-send-email.perl
1 #!/usr/bin/perl -w
2 #
3 # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4 # Copyright 2005 Ryan Anderson <ryan@michonline.com>
5 #
6 # GPL v2 (See COPYING)
7 #
8 # Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
9 #
10 # Sends a collection of emails to the given email addresses, disturbingly fast.
11 #
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:
15 #    first line of the message is who to CC,
16 #    and second line is the subject of the message.
17 #
18
19 use strict;
20 use warnings;
21 use Term::ReadLine;
22 use Getopt::Long;
23 use Text::ParseWords;
24 use Data::Dumper;
25 use Term::ANSIColor;
26 use File::Temp qw/ tempdir tempfile /;
27 use Error qw(:try);
28 use Git;
29
30 Getopt::Long::Configure qw/ pass_through /;
31
32 package FakeTerm;
33 sub new {
34         my ($class, $reason) = @_;
35         return bless \$reason, shift;
36 }
37 sub readline {
38         my $self = shift;
39         die "Cannot use readline on FakeTerm: $$self";
40 }
41 package main;
42
43
44 sub usage {
45         print <<EOT;
46 git send-email [options] <file | directory | rev-list options >
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:"
55     --annotate                     * Review each patch that will be sent in an editor.
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`
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.
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.
81     --[no-]format-patch            * understand any non optional arguments as
82                                      `git format-patch` ones.
83
84 EOT
85         exit(1);
86 }
87
88 # most mail servers generate the Date: header, but not all...
89 sub 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 }
126
127 my $have_email_valid = eval { require Email::Valid; 1 };
128 my $have_mail_address = eval { require Mail::Address; 1 };
129 my $smtp;
130 my $auth;
131
132 sub unique_email_list(@);
133 sub cleanup_compose_files();
134
135 # Variables we fill in automatically, or via prompting:
136 my (@to,@cc,@initial_cc,@bcclist,@xh,
137         $initial_reply_to,$initial_subject,@files,
138         $author,$sender,$smtp_authpass,$annotate,$compose,$time);
139
140 my $envelope_sender;
141
142 # Example reply to:
143 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
144
145 my $repo = eval { Git->repository() };
146 my @repo = $repo ? ($repo) : ();
147 my $term = eval {
148         $ENV{"GIT_SEND_EMAIL_NOTTY"}
149                 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
150                 : new Term::ReadLine 'git-send-email';
151 };
152 if ($@) {
153         $term = new FakeTerm "$@: going non-interactive";
154 }
155
156 # Behavior modification variables
157 my ($quiet, $dry_run) = (0, 0);
158 my $format_patch;
159 my $compose_filename = ($repo ?
160         tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
161         tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
162
163
164 # Handle interactive edition of files.
165 my $multiedit;
166 my $editor = $ENV{GIT_EDITOR} || Git::config(@repo, "core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi";
167 sub do_edit {
168         if (defined($multiedit) && !$multiedit) {
169                 map {
170                         system('sh', '-c', $editor.' "$@"', $editor, $_);
171                         if (($? & 127) || ($? >> 8)) {
172                                 die("the editor exited uncleanly, aborting everything");
173                         }
174                 } @_;
175         } else {
176                 system('sh', '-c', $editor.' "$@"', $editor, @_);
177                 if (($? & 127) || ($? >> 8)) {
178                         die("the editor exited uncleanly, aborting everything");
179                 }
180         }
181 }
182
183 # Variables with corresponding config settings
184 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc, $cc_cmd);
185 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_encryption);
186 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
187 my ($validate);
188 my (@suppress_cc);
189
190 my %config_bool_settings = (
191     "thread" => [\$thread, 1],
192     "chainreplyto" => [\$chain_reply_to, 1],
193     "suppressfrom" => [\$suppress_from, undef],
194     "signedoffbycc" => [\$signed_off_by_cc, undef],
195     "signedoffcc" => [\$signed_off_by_cc, undef],      # Deprecated
196     "validate" => [\$validate, 1],
197 );
198
199 my %config_settings = (
200     "smtpserver" => \$smtp_server,
201     "smtpserverport" => \$smtp_server_port,
202     "smtpuser" => \$smtp_authuser,
203     "smtppass" => \$smtp_authpass,
204     "to" => \@to,
205     "cc" => \@initial_cc,
206     "cccmd" => \$cc_cmd,
207     "aliasfiletype" => \$aliasfiletype,
208     "bcc" => \@bcclist,
209     "aliasesfile" => \@alias_files,
210     "suppresscc" => \@suppress_cc,
211     "envelopesender" => \$envelope_sender,
212     "multiedit" => \$multiedit,
213 );
214
215 # Handle Uncouth Termination
216 sub 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
238 # Begin by accumulating all the variables (defined above), that we will end up
239 # needing, first, from the command line:
240
241 my $rc = GetOptions("sender|from=s" => \$sender,
242                     "in-reply-to=s" => \$initial_reply_to,
243                     "subject=s" => \$initial_subject,
244                     "to=s" => \@to,
245                     "cc=s" => \@initial_cc,
246                     "bcc=s" => \@bcclist,
247                     "chain-reply-to!" => \$chain_reply_to,
248                     "smtp-server=s" => \$smtp_server,
249                     "smtp-server-port=s" => \$smtp_server_port,
250                     "smtp-user=s" => \$smtp_authuser,
251                     "smtp-pass:s" => \$smtp_authpass,
252                     "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
253                     "smtp-encryption=s" => \$smtp_encryption,
254                     "identity=s" => \$identity,
255                     "annotate" => \$annotate,
256                     "compose" => \$compose,
257                     "quiet" => \$quiet,
258                     "cc-cmd=s" => \$cc_cmd,
259                     "suppress-from!" => \$suppress_from,
260                     "suppress-cc=s" => \@suppress_cc,
261                     "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
262                     "dry-run" => \$dry_run,
263                     "envelope-sender=s" => \$envelope_sender,
264                     "thread!" => \$thread,
265                     "validate!" => \$validate,
266                     "format-patch!" => \$format_patch,
267          );
268
269 unless ($rc) {
270     usage();
271 }
272
273 die "Cannot run git format-patch from outside a repository\n"
274         if $format_patch and not $repo;
275
276 # Now, let's fill any that aren't set in with defaults:
277
278 sub read_config {
279         my ($prefix) = @_;
280
281         foreach my $setting (keys %config_bool_settings) {
282                 my $target = $config_bool_settings{$setting}->[0];
283                 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
284         }
285
286         foreach my $setting (keys %config_settings) {
287                 my $target = $config_settings{$setting};
288                 if (ref($target) eq "ARRAY") {
289                         unless (@$target) {
290                                 my @values = Git::config(@repo, "$prefix.$setting");
291                                 @$target = @values if (@values && defined $values[0]);
292                         }
293                 }
294                 else {
295                         $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
296                 }
297         }
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         }
307 }
308
309 # read configuration from [sendemail "$identity"], fall back on [sendemail]
310 $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
311 read_config("sendemail.$identity") if (defined $identity);
312 read_config("sendemail");
313
314 # fall back on builtin bool defaults
315 foreach my $setting (values %config_bool_settings) {
316         ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
317 }
318
319 # 'default' encryption is none -- this only prevents a warning
320 $smtp_encryption = '' unless (defined $smtp_encryption);
321
322 # Set CC suppressions
323 my(%suppress_cc);
324 if (@suppress_cc) {
325         foreach my $entry (@suppress_cc) {
326                 die "Unknown --suppress-cc field: '$entry'\n"
327                         unless $entry =~ /^(all|cccmd|cc|author|self|sob|body|bodycc)$/;
328                 $suppress_cc{$entry} = 1;
329         }
330 }
331
332 if ($suppress_cc{'all'}) {
333         foreach my $entry (qw (ccmd cc author self sob body bodycc)) {
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;
341 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
342
343 if ($suppress_cc{'body'}) {
344         foreach my $entry (qw (sob bodycc)) {
345                 $suppress_cc{$entry} = 1;
346         }
347         delete $suppress_cc{'body'};
348 }
349
350 # Debugging, print out the suppressions.
351 if (0) {
352         print "suppressions:\n";
353         foreach my $entry (keys %suppress_cc) {
354                 printf "  %-5s -> $suppress_cc{$entry}\n", $entry;
355         }
356 }
357
358 my ($repoauthor, $repocommitter);
359 ($repoauthor) = Git::ident_person(@repo, 'author');
360 ($repocommitter) = Git::ident_person(@repo, 'committer');
361
362 # Verify the user input
363
364 foreach my $entry (@to) {
365         die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
366 }
367
368 foreach my $entry (@initial_cc) {
369         die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
370 }
371
372 foreach my $entry (@bcclist) {
373         die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
374 }
375
376 sub 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
384 sub split_addrs {
385         return quotewords('\s*,\s*', 1, @_);
386 }
387
388 my %aliases;
389 my %parse_alias = (
390         # multiline formats can be supported in the future
391         mutt => sub { my $fh = shift; while (<$fh>) {
392                 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
393                         my ($alias, $addr) = ($1, $2);
394                         $addr =~ s/#.*$//; # mutt allows # comments
395                          # commas delimit multiple addresses
396                         $aliases{$alias} = [ split_addrs($addr) ];
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                 }}},
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;
408                         $aliases{$1} = [ split_addrs($2) ];
409                 }},
410         gnus => sub { my $fh = shift; while (<$fh>) {
411                 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
412                         $aliases{$1} = [ $2 ];
413                 }}}
414 );
415
416 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
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
424 ($sender) = expand_aliases($sender) if defined $sender;
425
426 # returns 1 if the conflict must be solved using it as a format-patch argument
427 sub check_file_rev_conflict($) {
428         return unless $repo;
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);
437 File '$f' exists but it could also be the range of commits
438 to 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.
442 EOF
443         } catch Git::Error::Command with {
444                 return 0;
445         }
446 }
447
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.
450 my @rev_list_opts;
451 while (defined(my $f = shift @ARGV)) {
452         if ($f eq "--") {
453                 push @rev_list_opts, "--", @ARGV;
454                 @ARGV = ();
455         } elsif (-d $f and !check_file_rev_conflict($f)) {
456                 opendir(DH,$f)
457                         or die "Failed to opendir $f: $!";
458
459                 push @files, grep { -f $_ } map { +$f . "/" . $_ }
460                                 sort readdir(DH);
461                 closedir(DH);
462         } elsif ((-f $f or -p $f) and !check_file_rev_conflict($f)) {
463                 push @files, $f;
464         } else {
465                 push @rev_list_opts, $f;
466         }
467 }
468
469 if (@rev_list_opts) {
470         die "Cannot run git format-patch from outside a repository\n"
471                 unless $repo;
472         push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
473 }
474
475 if ($validate) {
476         foreach my $f (@files) {
477                 unless (-p $f) {
478                         my $error = validate_patch($f);
479                         $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
480                 }
481         }
482 }
483
484 if (@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
493 sub 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
505 if ($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;
517 From $tpl_sender # This line is ignored.
518 GIT: Lines beginning in "GIT: " will be removed.
519 GIT: Consider including an overall diffstat or table of contents
520 GIT: for the patch you are writing.
521 GIT:
522 GIT: Clear the body content if you don't wish to send a summary.
523 From: $tpl_sender
524 Subject: $tpl_subject
525 In-Reply-To: $tpl_reply_to
526
527 EOT
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
595 my $prompting = 0;
596 if (!defined $sender) {
597         $sender = $repoauthor || $repocommitter || '';
598
599         while (1) {
600                 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
601                 last if defined $_;
602                 print "\n";
603         }
604
605         $sender = $_ if ($_);
606         print "Emails will be sent from: ", $sender, "\n";
607         $prompting++;
608 }
609
610 if (!@to) {
611
612
613         while (1) {
614                 $_ = $term->readline("Who should the emails be sent to? ", "");
615                 last if defined $_;
616                 print "\n";
617         }
618
619         my $to = $_;
620         push @to, parse_address_line($to);
621         $prompting++;
622 }
623
624 sub 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);
635 @to = (map { sanitize_address($_) } @to);
636 @initial_cc = expand_aliases(@initial_cc);
637 @bcclist = expand_aliases(@bcclist);
638
639 if ($thread && !defined $initial_reply_to && $prompting) {
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         }
645
646         $initial_reply_to = $_;
647 }
648 if (defined $initial_reply_to) {
649         $initial_reply_to =~ s/^\s*<?//;
650         $initial_reply_to =~ s/>?\s*$//;
651         $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
652 }
653
654 if (!defined $smtp_server) {
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*
662 }
663
664 if ($compose) {
665         while (1) {
666                 $_ = $term->readline("Send this email? (y|n) ");
667                 last if defined $_;
668                 print "\n";
669         }
670
671         if (uc substr($_,0,1) ne 'Y') {
672                 cleanup_compose_files();
673                 exit(0);
674         }
675
676         if ($compose > 0) {
677                 @files = ($compose_filename . ".final", @files);
678         }
679 }
680
681 # Variables we set as part of the loop over files
682 our ($message_id, %mail, $subject, $reply_to, $references, $message);
683
684 sub extract_valid_address {
685         my $address = shift;
686         my $local_part_regexp = '[^<>"\s@]+';
687         my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
688
689         # check for a local address:
690         return $address if ($address =~ /^($local_part_regexp)$/);
691
692         $address =~ s/^\s*<(.*)>\s*$/$1/;
693         if ($have_email_valid) {
694                 return scalar Email::Valid->address($address);
695         } else {
696                 # less robust/correct than the monster regexp in Email::Valid,
697                 # but still does a 99% job, and one less dependency
698                 $address =~ /($local_part_regexp\@$domain_regexp)/;
699                 return $1;
700         }
701 }
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.
709
710 # We'll setup a template for the message id, using the "from" address:
711
712 my ($message_id_stamp, $message_id_serial);
713 sub make_message_id
714 {
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
723         my $du_part;
724         for ($sender, $repocommitter, $repoauthor) {
725                 $du_part = extract_valid_address(sanitize_address($_));
726                 last if (defined $du_part and $du_part ne '');
727         }
728         if (not defined $du_part or $du_part eq '') {
729                 use Sys::Hostname qw();
730                 $du_part = 'user@' . Sys::Hostname::hostname();
731         }
732         my $message_id_template = "<%s-git-send-email-%s>";
733         $message_id = sprintf($message_id_template, $uniq, $du_part);
734         #print "new message id = $message_id\n"; # Was useful for debugging
735 }
736
737
738
739 $time = time - scalar $#files;
740
741 sub unquote_rfc2047 {
742         local ($_) = @_;
743         my $encoding;
744         if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
745                 $encoding = $1;
746                 s/_/ /g;
747                 s/=([0-9A-F]{2})/chr(hex($1))/eg;
748         }
749         return wantarray ? ($_, $encoding) : $_;
750 }
751
752 sub 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
760 # use the simplest quoting being able to handle the recipient
761 sub sanitize_address
762 {
763         my ($recipient) = @_;
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:]]/) {
777                 $recipient_name = quote_rfc2047($recipient_name);
778         }
779
780         # double quotes are needed if specials or CTLs are included
781         elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
782                 $recipient_name =~ s/(["\\\r])/\\$1/g;
783                 $recipient_name = "\"$recipient_name\"";
784         }
785
786         return "$recipient_name $recipient_addr";
787
788 }
789
790 sub send_message
791 {
792         my @recipients = unique_email_list(@to);
793         @cc = (grep { my $cc = extract_valid_address($_);
794                       not grep { $cc eq $_ } @recipients
795                     }
796                map { sanitize_address($_) }
797                @cc);
798         my $to = join (",\n\t", @recipients);
799         @recipients = unique_email_list(@recipients,@cc,@bcclist);
800         @recipients = (map { extract_valid_address($_) } @recipients);
801         my $date = format_2822_time($time++);
802         my $gitversion = '@@GIT_VERSION@@';
803         if ($gitversion =~ m/..GIT_VERSION../) {
804             $gitversion = Git::version();
805         }
806
807         my $cc = join(", ", unique_email_list(@cc));
808         my $ccline = "";
809         if ($cc ne '') {
810                 $ccline = "\nCc: $cc";
811         }
812         my $sanitized_sender = sanitize_address($sender);
813         make_message_id() unless defined($message_id);
814
815         my $header = "From: $sanitized_sender
816 To: $to${ccline}
817 Subject: $subject
818 Date: $date
819 Message-Id: $message_id
820 X-Mailer: git-send-email $gitversion
821 ";
822         if ($thread && $reply_to) {
823
824                 $header .= "In-Reply-To: $reply_to\n";
825                 $header .= "References: $references\n";
826         }
827         if (@xh) {
828                 $header .= join("\n", @xh) . "\n";
829         }
830
831         my @sendmail_parameters = ('-i', @recipients);
832         my $raw_from = $sanitized_sender;
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);
837
838         if ($dry_run) {
839                 # We don't want to send the email.
840         } elsif ($smtp_server =~ m#^/#) {
841                 my $pid = open my $sm, '|-';
842                 defined $pid or die $!;
843                 if (!$pid) {
844                         exec($smtp_server, @sendmail_parameters) or die $!;
845                 }
846                 print $sm "$header\n$message";
847                 close $sm or die $?;
848         } else {
849
850                 if (!defined $smtp_server) {
851                         die "The required SMTP server is not properly defined."
852                 }
853
854                 if ($smtp_encryption eq 'ssl') {
855                         $smtp_server_port ||= 465; # ssmtp
856                         require Net::SMTP::SSL;
857                         $smtp ||= Net::SMTP::SSL->new($smtp_server, Port => $smtp_server_port);
858                 }
859                 else {
860                         require Net::SMTP;
861                         $smtp ||= Net::SMTP->new((defined $smtp_server_port)
862                                                  ? "$smtp_server:$smtp_server_port"
863                                                  : $smtp_server);
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;
871                                         $smtp_encryption = '';
872                                         # Send EHLO again to receive fresh
873                                         # supported commands
874                                         $smtp->hello();
875                                 } else {
876                                         die "Server does not support STARTTLS! ".$smtp->message;
877                                 }
878                         }
879                 }
880
881                 if (!$smtp) {
882                         die "Unable to initialize SMTP properly.  Is there something wrong with your config?";
883                 }
884
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
902                         $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
903                 }
904
905                 $smtp->mail( $raw_from ) or die $smtp->message;
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         }
912         if ($quiet) {
913                 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
914         } else {
915                 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
916                 if ($smtp_server !~ m#^/#) {
917                         print "Server: $smtp_server\n";
918                         print "MAIL FROM:<$raw_from>\n";
919                         print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
920                 } else {
921                         print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
922                 }
923                 print $header, "\n";
924                 if ($smtp) {
925                         print "Result: ", $smtp->code, ' ',
926                                 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
927                 } else {
928                         print "Result: OK\n";
929                 }
930         }
931 }
932
933 $reply_to = $initial_reply_to;
934 $references = $initial_reply_to || '';
935 $subject = $initial_subject;
936
937 foreach my $t (@files) {
938         open(F,"<",$t) or die "can't open file $t";
939
940         my $author = undef;
941         my $author_encoding;
942         my $has_content_type;
943         my $body_encoding;
944         @cc = @initial_cc;
945         @xh = ();
946         my $input_format = undef;
947         my @header = ();
948         $message = "";
949         # First unfold multiline header fields
950         while(<F>) {
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;
974                         }
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;
982                         }
983                         elsif (/^Cc:\s+(.*)$/) {
984                                 foreach my $addr (parse_address_line($1)) {
985                                         if (unquote_rfc2047($addr) eq $sender) {
986                                                 next if ($suppress_cc{'self'});
987                                         } else {
988                                                 next if ($suppress_cc{'cc'});
989                                         }
990                                         printf("(mbox) Adding cc: %s from line '%s'\n",
991                                                 $addr, $_) unless $quiet;
992                                         push @cc, $addr;
993                                 }
994                         }
995                         elsif (/^Content-type:/i) {
996                                 $has_content_type = 1;
997                                 if (/charset="?([^ "]+)/) {
998                                         $body_encoding = $1;
999                                 }
1000                                 push @xh, $_;
1001                         }
1002                         elsif (/^Message-Id: (.*)/i) {
1003                                 $message_id = $1;
1004                         }
1005                         elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
1006                                 push @xh, $_;
1007                         }
1008
1009                 } else {
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 = $_;
1022                         }
1023                 }
1024         }
1025         # Now parse the message body
1026         while(<F>) {
1027                 $message .=  $_;
1028                 if (/^(Signed-off-by|Cc): (.*)$/i) {
1029                         chomp;
1030                         my ($what, $c) = ($1, $2);
1031                         chomp $c;
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                         }
1038                         push @cc, $c;
1039                         printf("(body) Adding cc: %s from line '%s'\n",
1040                                 $c, $_) unless $quiet;
1041                 }
1042         }
1043         close F;
1044
1045         if (defined $cc_cmd && !$suppress_cc{'cccmd'}) {
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;
1052                         next if ($c eq $sender and $suppress_from);
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
1061         if (defined $author and $author ne $sender) {
1062                 $message = "From: $author\n\n$message";
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',
1075                                   "Content-Type: text/plain; charset=$author_encoding",
1076                                   'Content-Transfer-Encoding: 8bit';
1077                         }
1078                 }
1079         }
1080
1081         send_message();
1082
1083         # set up for the next message
1084         if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
1085                 $reply_to = $message_id;
1086                 if (length $references > 0) {
1087                         $references .= "\n $message_id";
1088                 } else {
1089                         $references = "$message_id";
1090                 }
1091         }
1092         $message_id = undef;
1093 }
1094
1095 if ($compose) {
1096         cleanup_compose_files();
1097 }
1098
1099 sub cleanup_compose_files() {
1100         unlink($compose_filename, $compose_filename . ".final");
1101
1102 }
1103
1104 $smtp->quit if $smtp;
1105
1106 sub unique_email_list(@) {
1107         my %seen;
1108         my @emails;
1109
1110         foreach my $entry (@_) {
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                 }
1119         }
1120         return @emails;
1121 }
1122
1123 sub 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 }
1134
1135 sub 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 }