Code

Merge branch 'gb/am-foreign'
[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 #
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;
30 Getopt::Long::Configure qw/ pass_through /;
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;
44 sub usage {
45         print <<EOT;
46 git send-email [options] <file | directory | rev-list options >
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.
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'.
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.
77   Administering:
78     --confirm               <str>  * Confirm recipients before sending;
79                                      auto, cc, compose, always, or never.
80     --quiet                        * Output one line of info per email.
81     --dry-run                      * Don't actually send the emails.
82     --[no-]validate                * Perform patch sanity checks. Default on.
83     --[no-]format-patch            * understand any non optional arguments as
84                                      `git format-patch` ones.
86 EOT
87         exit(1);
88 }
90 # most mail servers generate the Date: header, but not all...
91 sub format_2822_time {
92         my ($time) = @_;
93         my @localtm = localtime($time);
94         my @gmttm = gmtime($time);
95         my $localmin = $localtm[1] + $localtm[2] * 60;
96         my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
97         if ($localtm[0] != $gmttm[0]) {
98                 die "local zone differs from GMT by a non-minute interval\n";
99         }
100         if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
101                 $localmin += 1440;
102         } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
103                 $localmin -= 1440;
104         } elsif ($gmttm[6] != $localtm[6]) {
105                 die "local time offset greater than or equal to 24 hours\n";
106         }
107         my $offset = $localmin - $gmtmin;
108         my $offhour = $offset / 60;
109         my $offmin = abs($offset % 60);
110         if (abs($offhour) >= 24) {
111                 die ("local time offset greater than or equal to 24 hours\n");
112         }
114         return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
115                        qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
116                        $localtm[3],
117                        qw(Jan Feb Mar Apr May Jun
118                           Jul Aug Sep Oct Nov Dec)[$localtm[4]],
119                        $localtm[5]+1900,
120                        $localtm[2],
121                        $localtm[1],
122                        $localtm[0],
123                        ($offset >= 0) ? '+' : '-',
124                        abs($offhour),
125                        $offmin,
126                        );
129 my $have_email_valid = eval { require Email::Valid; 1 };
130 my $have_mail_address = eval { require Mail::Address; 1 };
131 my $smtp;
132 my $auth;
134 sub unique_email_list(@);
135 sub cleanup_compose_files();
137 # Variables we fill in automatically, or via prompting:
138 my (@to,@cc,@initial_cc,@bcclist,@xh,
139         $initial_reply_to,$initial_subject,@files,
140         $author,$sender,$smtp_authpass,$annotate,$compose,$time);
142 my $envelope_sender;
144 # Example reply to:
145 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
147 my $repo = eval { Git->repository() };
148 my @repo = $repo ? ($repo) : ();
149 my $term = eval {
150         $ENV{"GIT_SEND_EMAIL_NOTTY"}
151                 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
152                 : new Term::ReadLine 'git-send-email';
153 };
154 if ($@) {
155         $term = new FakeTerm "$@: going non-interactive";
158 # Behavior modification variables
159 my ($quiet, $dry_run) = (0, 0);
160 my $format_patch;
161 my $compose_filename;
163 # Handle interactive edition of files.
164 my $multiedit;
165 my $editor = $ENV{GIT_EDITOR} || Git::config(@repo, "core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi";
166 sub do_edit {
167         if (defined($multiedit) && !$multiedit) {
168                 map {
169                         system('sh', '-c', $editor.' "$@"', $editor, $_);
170                         if (($? & 127) || ($? >> 8)) {
171                                 die("the editor exited uncleanly, aborting everything");
172                         }
173                 } @_;
174         } else {
175                 system('sh', '-c', $editor.' "$@"', $editor, @_);
176                 if (($? & 127) || ($? >> 8)) {
177                         die("the editor exited uncleanly, aborting everything");
178                 }
179         }
182 # Variables with corresponding config settings
183 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc, $cc_cmd);
184 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_encryption);
185 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
186 my ($validate, $confirm);
187 my (@suppress_cc);
189 my %config_bool_settings = (
190     "thread" => [\$thread, 1],
191     "chainreplyto" => [\$chain_reply_to, 1],
192     "suppressfrom" => [\$suppress_from, undef],
193     "signedoffbycc" => [\$signed_off_by_cc, undef],
194     "signedoffcc" => [\$signed_off_by_cc, undef],      # Deprecated
195     "validate" => [\$validate, 1],
196 );
198 my %config_settings = (
199     "smtpserver" => \$smtp_server,
200     "smtpserverport" => \$smtp_server_port,
201     "smtpuser" => \$smtp_authuser,
202     "smtppass" => \$smtp_authpass,
203     "to" => \@to,
204     "cc" => \@initial_cc,
205     "cccmd" => \$cc_cmd,
206     "aliasfiletype" => \$aliasfiletype,
207     "bcc" => \@bcclist,
208     "aliasesfile" => \@alias_files,
209     "suppresscc" => \@suppress_cc,
210     "envelopesender" => \$envelope_sender,
211     "multiedit" => \$multiedit,
212     "confirm"   => \$confirm,
213     "from" => \$sender,
214 );
216 # Handle Uncouth Termination
217 sub signal_handler {
219         # Make text normal
220         print color("reset"), "\n";
222         # SMTP password masked
223         system "stty echo";
225         # tmp files from --compose
226         if (defined $compose_filename) {
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         }
235         exit;
236 };
238 $SIG{TERM} = \&signal_handler;
239 $SIG{INT}  = \&signal_handler;
241 # Begin by accumulating all the variables (defined above), that we will end up
242 # needing, first, from the command line:
244 my $rc = GetOptions("sender|from=s" => \$sender,
245                     "in-reply-to=s" => \$initial_reply_to,
246                     "subject=s" => \$initial_subject,
247                     "to=s" => \@to,
248                     "cc=s" => \@initial_cc,
249                     "bcc=s" => \@bcclist,
250                     "chain-reply-to!" => \$chain_reply_to,
251                     "smtp-server=s" => \$smtp_server,
252                     "smtp-server-port=s" => \$smtp_server_port,
253                     "smtp-user=s" => \$smtp_authuser,
254                     "smtp-pass:s" => \$smtp_authpass,
255                     "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
256                     "smtp-encryption=s" => \$smtp_encryption,
257                     "identity=s" => \$identity,
258                     "annotate" => \$annotate,
259                     "compose" => \$compose,
260                     "quiet" => \$quiet,
261                     "cc-cmd=s" => \$cc_cmd,
262                     "suppress-from!" => \$suppress_from,
263                     "suppress-cc=s" => \@suppress_cc,
264                     "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
265                     "confirm=s" => \$confirm,
266                     "dry-run" => \$dry_run,
267                     "envelope-sender=s" => \$envelope_sender,
268                     "thread!" => \$thread,
269                     "validate!" => \$validate,
270                     "format-patch!" => \$format_patch,
271          );
273 unless ($rc) {
274     usage();
277 die "Cannot run git format-patch from outside a repository\n"
278         if $format_patch and not $repo;
280 # Now, let's fill any that aren't set in with defaults:
282 sub read_config {
283         my ($prefix) = @_;
285         foreach my $setting (keys %config_bool_settings) {
286                 my $target = $config_bool_settings{$setting}->[0];
287                 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
288         }
290         foreach my $setting (keys %config_settings) {
291                 my $target = $config_settings{$setting};
292                 if (ref($target) eq "ARRAY") {
293                         unless (@$target) {
294                                 my @values = Git::config(@repo, "$prefix.$setting");
295                                 @$target = @values if (@values && defined $values[0]);
296                         }
297                 }
298                 else {
299                         $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
300                 }
301         }
303         if (!defined $smtp_encryption) {
304                 my $enc = Git::config(@repo, "$prefix.smtpencryption");
305                 if (defined $enc) {
306                         $smtp_encryption = $enc;
307                 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
308                         $smtp_encryption = 'ssl';
309                 }
310         }
313 # read configuration from [sendemail "$identity"], fall back on [sendemail]
314 $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
315 read_config("sendemail.$identity") if (defined $identity);
316 read_config("sendemail");
318 # fall back on builtin bool defaults
319 foreach my $setting (values %config_bool_settings) {
320         ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
323 # 'default' encryption is none -- this only prevents a warning
324 $smtp_encryption = '' unless (defined $smtp_encryption);
326 # Set CC suppressions
327 my(%suppress_cc);
328 if (@suppress_cc) {
329         foreach my $entry (@suppress_cc) {
330                 die "Unknown --suppress-cc field: '$entry'\n"
331                         unless $entry =~ /^(all|cccmd|cc|author|self|sob|body|bodycc)$/;
332                 $suppress_cc{$entry} = 1;
333         }
336 if ($suppress_cc{'all'}) {
337         foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
338                 $suppress_cc{$entry} = 1;
339         }
340         delete $suppress_cc{'all'};
343 # If explicit old-style ones are specified, they trump --suppress-cc.
344 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
345 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
347 if ($suppress_cc{'body'}) {
348         foreach my $entry (qw (sob bodycc)) {
349                 $suppress_cc{$entry} = 1;
350         }
351         delete $suppress_cc{'body'};
354 # Set confirm's default value
355 my $confirm_unconfigured = !defined $confirm;
356 if ($confirm_unconfigured) {
357         $confirm = scalar %suppress_cc ? 'compose' : 'auto';
358 };
359 die "Unknown --confirm setting: '$confirm'\n"
360         unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
362 # Debugging, print out the suppressions.
363 if (0) {
364         print "suppressions:\n";
365         foreach my $entry (keys %suppress_cc) {
366                 printf "  %-5s -> $suppress_cc{$entry}\n", $entry;
367         }
370 my ($repoauthor, $repocommitter);
371 ($repoauthor) = Git::ident_person(@repo, 'author');
372 ($repocommitter) = Git::ident_person(@repo, 'committer');
374 # Verify the user input
376 foreach my $entry (@to) {
377         die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
380 foreach my $entry (@initial_cc) {
381         die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
384 foreach my $entry (@bcclist) {
385         die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
388 sub parse_address_line {
389         if ($have_mail_address) {
390                 return map { $_->format } Mail::Address->parse($_[0]);
391         } else {
392                 return split_addrs($_[0]);
393         }
396 sub split_addrs {
397         return quotewords('\s*,\s*', 1, @_);
400 my %aliases;
401 my %parse_alias = (
402         # multiline formats can be supported in the future
403         mutt => sub { my $fh = shift; while (<$fh>) {
404                 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
405                         my ($alias, $addr) = ($1, $2);
406                         $addr =~ s/#.*$//; # mutt allows # comments
407                          # commas delimit multiple addresses
408                         $aliases{$alias} = [ split_addrs($addr) ];
409                 }}},
410         mailrc => sub { my $fh = shift; while (<$fh>) {
411                 if (/^alias\s+(\S+)\s+(.*)$/) {
412                         # spaces delimit multiple addresses
413                         $aliases{$1} = [ quotewords('\s+', 0, $2) ];
414                 }}},
415         pine => sub { my $fh = shift; my $f='\t[^\t]*';
416                 for (my $x = ''; defined($x); $x = $_) {
417                         chomp $x;
418                         $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
419                         $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
420                         $aliases{$1} = [ split_addrs($2) ];
421                 }},
422         elm => sub  { my $fh = shift;
423                       while (<$fh>) {
424                           if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
425                               my ($alias, $addr) = ($1, $2);
426                                $aliases{$alias} = [ split_addrs($addr) ];
427                           }
428                       } },
430         gnus => sub { my $fh = shift; while (<$fh>) {
431                 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
432                         $aliases{$1} = [ $2 ];
433                 }}}
434 );
436 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
437         foreach my $file (@alias_files) {
438                 open my $fh, '<', $file or die "opening $file: $!\n";
439                 $parse_alias{$aliasfiletype}->($fh);
440                 close $fh;
441         }
444 ($sender) = expand_aliases($sender) if defined $sender;
446 # returns 1 if the conflict must be solved using it as a format-patch argument
447 sub check_file_rev_conflict($) {
448         return unless $repo;
449         my $f = shift;
450         try {
451                 $repo->command('rev-parse', '--verify', '--quiet', $f);
452                 if (defined($format_patch)) {
453                         print "foo\n";
454                         return $format_patch;
455                 }
456                 die(<<EOF);
457 File '$f' exists but it could also be the range of commits
458 to produce patches for.  Please disambiguate by...
460     * Saying "./$f" if you mean a file; or
461     * Giving --format-patch option if you mean a range.
462 EOF
463         } catch Git::Error::Command with {
464                 return 0;
465         }
468 # Now that all the defaults are set, process the rest of the command line
469 # arguments and collect up the files that need to be processed.
470 my @rev_list_opts;
471 while (defined(my $f = shift @ARGV)) {
472         if ($f eq "--") {
473                 push @rev_list_opts, "--", @ARGV;
474                 @ARGV = ();
475         } elsif (-d $f and !check_file_rev_conflict($f)) {
476                 opendir(DH,$f)
477                         or die "Failed to opendir $f: $!";
479                 push @files, grep { -f $_ } map { +$f . "/" . $_ }
480                                 sort readdir(DH);
481                 closedir(DH);
482         } elsif ((-f $f or -p $f) and !check_file_rev_conflict($f)) {
483                 push @files, $f;
484         } else {
485                 push @rev_list_opts, $f;
486         }
489 if (@rev_list_opts) {
490         die "Cannot run git format-patch from outside a repository\n"
491                 unless $repo;
492         push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
495 if ($validate) {
496         foreach my $f (@files) {
497                 unless (-p $f) {
498                         my $error = validate_patch($f);
499                         $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
500                 }
501         }
504 if (@files) {
505         unless ($quiet) {
506                 print $_,"\n" for (@files);
507         }
508 } else {
509         print STDERR "\nNo patch files specified!\n\n";
510         usage();
513 sub get_patch_subject($) {
514         my $fn = shift;
515         open (my $fh, '<', $fn);
516         while (my $line = <$fh>) {
517                 next unless ($line =~ /^Subject: (.*)$/);
518                 close $fh;
519                 return "GIT: $1\n";
520         }
521         close $fh;
522         die "No subject line in $fn ?";
525 if ($compose) {
526         # Note that this does not need to be secure, but we will make a small
527         # effort to have it be unique
528         $compose_filename = ($repo ?
529                 tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
530                 tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
531         open(C,">",$compose_filename)
532                 or die "Failed to open for writing $compose_filename: $!";
535         my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
536         my $tpl_subject = $initial_subject || '';
537         my $tpl_reply_to = $initial_reply_to || '';
539         print C <<EOT;
540 From $tpl_sender # This line is ignored.
541 GIT: Lines beginning in "GIT:" will be removed.
542 GIT: Consider including an overall diffstat or table of contents
543 GIT: for the patch you are writing.
544 GIT:
545 GIT: Clear the body content if you don't wish to send a summary.
546 From: $tpl_sender
547 Subject: $tpl_subject
548 In-Reply-To: $tpl_reply_to
550 EOT
551         for my $f (@files) {
552                 print C get_patch_subject($f);
553         }
554         close(C);
556         if ($annotate) {
557                 do_edit($compose_filename, @files);
558         } else {
559                 do_edit($compose_filename);
560         }
562         open(C2,">",$compose_filename . ".final")
563                 or die "Failed to open $compose_filename.final : " . $!;
565         open(C,"<",$compose_filename)
566                 or die "Failed to open $compose_filename : " . $!;
568         my $need_8bit_cte = file_has_nonascii($compose_filename);
569         my $in_body = 0;
570         my $summary_empty = 1;
571         while(<C>) {
572                 next if m/^GIT:/;
573                 if ($in_body) {
574                         $summary_empty = 0 unless (/^\n$/);
575                 } elsif (/^\n$/) {
576                         $in_body = 1;
577                         if ($need_8bit_cte) {
578                                 print C2 "MIME-Version: 1.0\n",
579                                          "Content-Type: text/plain; ",
580                                            "charset=UTF-8\n",
581                                          "Content-Transfer-Encoding: 8bit\n";
582                         }
583                 } elsif (/^MIME-Version:/i) {
584                         $need_8bit_cte = 0;
585                 } elsif (/^Subject:\s*(.+)\s*$/i) {
586                         $initial_subject = $1;
587                         my $subject = $initial_subject;
588                         $_ = "Subject: " .
589                                 ($subject =~ /[^[:ascii:]]/ ?
590                                  quote_rfc2047($subject) :
591                                  $subject) .
592                                 "\n";
593                 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
594                         $initial_reply_to = $1;
595                         next;
596                 } elsif (/^From:\s*(.+)\s*$/i) {
597                         $sender = $1;
598                         next;
599                 } elsif (/^(?:To|Cc|Bcc):/i) {
600                         print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
601                         next;
602                 }
603                 print C2 $_;
604         }
605         close(C);
606         close(C2);
608         if ($summary_empty) {
609                 print "Summary email is empty, skipping it\n";
610                 $compose = -1;
611         }
612 } elsif ($annotate) {
613         do_edit(@files);
616 sub ask {
617         my ($prompt, %arg) = @_;
618         my $valid_re = $arg{valid_re};
619         my $default = $arg{default};
620         my $resp;
621         my $i = 0;
622         return defined $default ? $default : undef
623                 unless defined $term->IN and defined fileno($term->IN) and
624                        defined $term->OUT and defined fileno($term->OUT);
625         while ($i++ < 10) {
626                 $resp = $term->readline($prompt);
627                 if (!defined $resp) { # EOF
628                         print "\n";
629                         return defined $default ? $default : undef;
630                 }
631                 if ($resp eq '' and defined $default) {
632                         return $default;
633                 }
634                 if (!defined $valid_re or $resp =~ /$valid_re/) {
635                         return $resp;
636                 }
637         }
638         return undef;
641 my $prompting = 0;
642 if (!defined $sender) {
643         $sender = $repoauthor || $repocommitter || '';
644         $sender = ask("Who should the emails appear to be from? [$sender] ",
645                       default => $sender);
646         print "Emails will be sent from: ", $sender, "\n";
647         $prompting++;
650 if (!@to) {
651         my $to = ask("Who should the emails be sent to? ");
652         push @to, parse_address_line($to) if defined $to; # sanitized/validated later
653         $prompting++;
656 sub expand_aliases {
657         my @cur = @_;
658         my @last;
659         do {
660                 @last = @cur;
661                 @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
662         } while (join(',',@cur) ne join(',',@last));
663         return @cur;
666 @to = expand_aliases(@to);
667 @to = (map { sanitize_address($_) } @to);
668 @initial_cc = expand_aliases(@initial_cc);
669 @bcclist = expand_aliases(@bcclist);
671 if ($thread && !defined $initial_reply_to && $prompting) {
672         $initial_reply_to = ask(
673                 "Message-ID to be used as In-Reply-To for the first email? ");
675 if (defined $initial_reply_to) {
676         $initial_reply_to =~ s/^\s*<?//;
677         $initial_reply_to =~ s/>?\s*$//;
678         $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
681 if (!defined $smtp_server) {
682         foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
683                 if (-x $_) {
684                         $smtp_server = $_;
685                         last;
686                 }
687         }
688         $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
691 if ($compose && $compose > 0) {
692         @files = ($compose_filename . ".final", @files);
695 # Variables we set as part of the loop over files
696 our ($message_id, %mail, $subject, $reply_to, $references, $message,
697         $needs_confirm, $message_num, $ask_default);
699 sub extract_valid_address {
700         my $address = shift;
701         my $local_part_regexp = '[^<>"\s@]+';
702         my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
704         # check for a local address:
705         return $address if ($address =~ /^($local_part_regexp)$/);
707         $address =~ s/^\s*<(.*)>\s*$/$1/;
708         if ($have_email_valid) {
709                 return scalar Email::Valid->address($address);
710         } else {
711                 # less robust/correct than the monster regexp in Email::Valid,
712                 # but still does a 99% job, and one less dependency
713                 $address =~ /($local_part_regexp\@$domain_regexp)/;
714                 return $1;
715         }
718 # Usually don't need to change anything below here.
720 # we make a "fake" message id by taking the current number
721 # of seconds since the beginning of Unix time and tacking on
722 # a random number to the end, in case we are called quicker than
723 # 1 second since the last time we were called.
725 # We'll setup a template for the message id, using the "from" address:
727 my ($message_id_stamp, $message_id_serial);
728 sub make_message_id
730         my $uniq;
731         if (!defined $message_id_stamp) {
732                 $message_id_stamp = sprintf("%s-%s", time, $$);
733                 $message_id_serial = 0;
734         }
735         $message_id_serial++;
736         $uniq = "$message_id_stamp-$message_id_serial";
738         my $du_part;
739         for ($sender, $repocommitter, $repoauthor) {
740                 $du_part = extract_valid_address(sanitize_address($_));
741                 last if (defined $du_part and $du_part ne '');
742         }
743         if (not defined $du_part or $du_part eq '') {
744                 use Sys::Hostname qw();
745                 $du_part = 'user@' . Sys::Hostname::hostname();
746         }
747         my $message_id_template = "<%s-git-send-email-%s>";
748         $message_id = sprintf($message_id_template, $uniq, $du_part);
749         #print "new message id = $message_id\n"; # Was useful for debugging
754 $time = time - scalar $#files;
756 sub unquote_rfc2047 {
757         local ($_) = @_;
758         my $encoding;
759         if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
760                 $encoding = $1;
761                 s/_/ /g;
762                 s/=([0-9A-F]{2})/chr(hex($1))/eg;
763         }
764         return wantarray ? ($_, $encoding) : $_;
767 sub quote_rfc2047 {
768         local $_ = shift;
769         my $encoding = shift || 'UTF-8';
770         s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
771         s/(.*)/=\?$encoding\?q\?$1\?=/;
772         return $_;
775 sub is_rfc2047_quoted {
776         my $s = shift;
777         my $token = '[^][()<>@,;:"\/?.= \000-\037\177-\377]+';
778         my $encoded_text = '[!->@-~]+';
779         length($s) <= 75 &&
780         $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
783 # use the simplest quoting being able to handle the recipient
784 sub sanitize_address
786         my ($recipient) = @_;
787         my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
789         if (not $recipient_name) {
790                 return "$recipient";
791         }
793         # if recipient_name is already quoted, do nothing
794         if (is_rfc2047_quoted($recipient_name)) {
795                 return $recipient;
796         }
798         # rfc2047 is needed if a non-ascii char is included
799         if ($recipient_name =~ /[^[:ascii:]]/) {
800                 $recipient_name =~ s/^"(.*)"$/$1/;
801                 $recipient_name = quote_rfc2047($recipient_name);
802         }
804         # double quotes are needed if specials or CTLs are included
805         elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
806                 $recipient_name =~ s/(["\\\r])/\\$1/g;
807                 $recipient_name = "\"$recipient_name\"";
808         }
810         return "$recipient_name $recipient_addr";
814 # Returns 1 if the message was sent, and 0 otherwise.
815 # In actuality, the whole program dies when there
816 # is an error sending a message.
818 sub send_message
820         my @recipients = unique_email_list(@to);
821         @cc = (grep { my $cc = extract_valid_address($_);
822                       not grep { $cc eq $_ } @recipients
823                     }
824                map { sanitize_address($_) }
825                @cc);
826         my $to = join (",\n\t", @recipients);
827         @recipients = unique_email_list(@recipients,@cc,@bcclist);
828         @recipients = (map { extract_valid_address($_) } @recipients);
829         my $date = format_2822_time($time++);
830         my $gitversion = '@@GIT_VERSION@@';
831         if ($gitversion =~ m/..GIT_VERSION../) {
832             $gitversion = Git::version();
833         }
835         my $cc = join(", ", unique_email_list(@cc));
836         my $ccline = "";
837         if ($cc ne '') {
838                 $ccline = "\nCc: $cc";
839         }
840         my $sanitized_sender = sanitize_address($sender);
841         make_message_id() unless defined($message_id);
843         my $header = "From: $sanitized_sender
844 To: $to${ccline}
845 Subject: $subject
846 Date: $date
847 Message-Id: $message_id
848 X-Mailer: git-send-email $gitversion
849 ";
850         if ($reply_to) {
852                 $header .= "In-Reply-To: $reply_to\n";
853                 $header .= "References: $references\n";
854         }
855         if (@xh) {
856                 $header .= join("\n", @xh) . "\n";
857         }
859         my @sendmail_parameters = ('-i', @recipients);
860         my $raw_from = $sanitized_sender;
861         $raw_from = $envelope_sender if (defined $envelope_sender);
862         $raw_from = extract_valid_address($raw_from);
863         unshift (@sendmail_parameters,
864                         '-f', $raw_from) if(defined $envelope_sender);
866         if ($needs_confirm && !$dry_run) {
867                 print "\n$header\n";
868                 if ($needs_confirm eq "inform") {
869                         $confirm_unconfigured = 0; # squelch this message for the rest of this run
870                         $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
871                         print "    The Cc list above has been expanded by additional\n";
872                         print "    addresses found in the patch commit message. By default\n";
873                         print "    send-email prompts before sending whenever this occurs.\n";
874                         print "    This behavior is controlled by the sendemail.confirm\n";
875                         print "    configuration setting.\n";
876                         print "\n";
877                         print "    For additional information, run 'git send-email --help'.\n";
878                         print "    To retain the current behavior, but squelch this message,\n";
879                         print "    run 'git config --global sendemail.confirm auto'.\n\n";
880                 }
881                 $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
882                          valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
883                          default => $ask_default);
884                 die "Send this email reply required" unless defined $_;
885                 if (/^n/i) {
886                         return 0;
887                 } elsif (/^q/i) {
888                         cleanup_compose_files();
889                         exit(0);
890                 } elsif (/^a/i) {
891                         $confirm = 'never';
892                 }
893         }
895         if ($dry_run) {
896                 # We don't want to send the email.
897         } elsif ($smtp_server =~ m#^/#) {
898                 my $pid = open my $sm, '|-';
899                 defined $pid or die $!;
900                 if (!$pid) {
901                         exec($smtp_server, @sendmail_parameters) or die $!;
902                 }
903                 print $sm "$header\n$message";
904                 close $sm or die $?;
905         } else {
907                 if (!defined $smtp_server) {
908                         die "The required SMTP server is not properly defined."
909                 }
911                 if ($smtp_encryption eq 'ssl') {
912                         $smtp_server_port ||= 465; # ssmtp
913                         require Net::SMTP::SSL;
914                         $smtp ||= Net::SMTP::SSL->new($smtp_server, Port => $smtp_server_port);
915                 }
916                 else {
917                         require Net::SMTP;
918                         $smtp ||= Net::SMTP->new((defined $smtp_server_port)
919                                                  ? "$smtp_server:$smtp_server_port"
920                                                  : $smtp_server);
921                         if ($smtp_encryption eq 'tls') {
922                                 require Net::SMTP::SSL;
923                                 $smtp->command('STARTTLS');
924                                 $smtp->response();
925                                 if ($smtp->code == 220) {
926                                         $smtp = Net::SMTP::SSL->start_SSL($smtp)
927                                                 or die "STARTTLS failed! ".$smtp->message;
928                                         $smtp_encryption = '';
929                                         # Send EHLO again to receive fresh
930                                         # supported commands
931                                         $smtp->hello();
932                                 } else {
933                                         die "Server does not support STARTTLS! ".$smtp->message;
934                                 }
935                         }
936                 }
938                 if (!$smtp) {
939                         die "Unable to initialize SMTP properly.  Is there something wrong with your config?";
940                 }
942                 if (defined $smtp_authuser) {
944                         if (!defined $smtp_authpass) {
946                                 system "stty -echo";
948                                 do {
949                                         print "Password: ";
950                                         $_ = <STDIN>;
951                                         print "\n";
952                                 } while (!defined $_);
954                                 chomp($smtp_authpass = $_);
956                                 system "stty echo";
957                         }
959                         $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
960                 }
962                 $smtp->mail( $raw_from ) or die $smtp->message;
963                 $smtp->to( @recipients ) or die $smtp->message;
964                 $smtp->data or die $smtp->message;
965                 $smtp->datasend("$header\n$message") or die $smtp->message;
966                 $smtp->dataend() or die $smtp->message;
967                 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
968         }
969         if ($quiet) {
970                 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
971         } else {
972                 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
973                 if ($smtp_server !~ m#^/#) {
974                         print "Server: $smtp_server\n";
975                         print "MAIL FROM:<$raw_from>\n";
976                         print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
977                 } else {
978                         print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
979                 }
980                 print $header, "\n";
981                 if ($smtp) {
982                         print "Result: ", $smtp->code, ' ',
983                                 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
984                 } else {
985                         print "Result: OK\n";
986                 }
987         }
989         return 1;
992 $reply_to = $initial_reply_to;
993 $references = $initial_reply_to || '';
994 $subject = $initial_subject;
995 $message_num = 0;
997 foreach my $t (@files) {
998         open(F,"<",$t) or die "can't open file $t";
1000         my $author = undef;
1001         my $author_encoding;
1002         my $has_content_type;
1003         my $body_encoding;
1004         @cc = ();
1005         @xh = ();
1006         my $input_format = undef;
1007         my @header = ();
1008         $message = "";
1009         $message_num++;
1010         # First unfold multiline header fields
1011         while(<F>) {
1012                 last if /^\s*$/;
1013                 if (/^\s+\S/ and @header) {
1014                         chomp($header[$#header]);
1015                         s/^\s+/ /;
1016                         $header[$#header] .= $_;
1017             } else {
1018                         push(@header, $_);
1019                 }
1020         }
1021         # Now parse the header
1022         foreach(@header) {
1023                 if (/^From /) {
1024                         $input_format = 'mbox';
1025                         next;
1026                 }
1027                 chomp;
1028                 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1029                         $input_format = 'mbox';
1030                 }
1032                 if (defined $input_format && $input_format eq 'mbox') {
1033                         if (/^Subject:\s+(.*)$/) {
1034                                 $subject = $1;
1035                         }
1036                         elsif (/^From:\s+(.*)$/) {
1037                                 ($author, $author_encoding) = unquote_rfc2047($1);
1038                                 next if $suppress_cc{'author'};
1039                                 next if $suppress_cc{'self'} and $author eq $sender;
1040                                 printf("(mbox) Adding cc: %s from line '%s'\n",
1041                                         $1, $_) unless $quiet;
1042                                 push @cc, $1;
1043                         }
1044                         elsif (/^Cc:\s+(.*)$/) {
1045                                 foreach my $addr (parse_address_line($1)) {
1046                                         if (unquote_rfc2047($addr) eq $sender) {
1047                                                 next if ($suppress_cc{'self'});
1048                                         } else {
1049                                                 next if ($suppress_cc{'cc'});
1050                                         }
1051                                         printf("(mbox) Adding cc: %s from line '%s'\n",
1052                                                 $addr, $_) unless $quiet;
1053                                         push @cc, $addr;
1054                                 }
1055                         }
1056                         elsif (/^Content-type:/i) {
1057                                 $has_content_type = 1;
1058                                 if (/charset="?([^ "]+)/) {
1059                                         $body_encoding = $1;
1060                                 }
1061                                 push @xh, $_;
1062                         }
1063                         elsif (/^Message-Id: (.*)/i) {
1064                                 $message_id = $1;
1065                         }
1066                         elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
1067                                 push @xh, $_;
1068                         }
1070                 } else {
1071                         # In the traditional
1072                         # "send lots of email" format,
1073                         # line 1 = cc
1074                         # line 2 = subject
1075                         # So let's support that, too.
1076                         $input_format = 'lots';
1077                         if (@cc == 0 && !$suppress_cc{'cc'}) {
1078                                 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1079                                         $_, $_) unless $quiet;
1080                                 push @cc, $_;
1081                         } elsif (!defined $subject) {
1082                                 $subject = $_;
1083                         }
1084                 }
1085         }
1086         # Now parse the message body
1087         while(<F>) {
1088                 $message .=  $_;
1089                 if (/^(Signed-off-by|Cc): (.*)$/i) {
1090                         chomp;
1091                         my ($what, $c) = ($1, $2);
1092                         chomp $c;
1093                         if ($c eq $sender) {
1094                                 next if ($suppress_cc{'self'});
1095                         } else {
1096                                 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1097                                 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1098                         }
1099                         push @cc, $c;
1100                         printf("(body) Adding cc: %s from line '%s'\n",
1101                                 $c, $_) unless $quiet;
1102                 }
1103         }
1104         close F;
1106         if (defined $cc_cmd && !$suppress_cc{'cccmd'}) {
1107                 open(F, "$cc_cmd \Q$t\E |")
1108                         or die "(cc-cmd) Could not execute '$cc_cmd'";
1109                 while(<F>) {
1110                         my $c = $_;
1111                         $c =~ s/^\s*//g;
1112                         $c =~ s/\n$//g;
1113                         next if ($c eq $sender and $suppress_from);
1114                         push @cc, $c;
1115                         printf("(cc-cmd) Adding cc: %s from: '%s'\n",
1116                                 $c, $cc_cmd) unless $quiet;
1117                 }
1118                 close F
1119                         or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
1120         }
1122         if (defined $author and $author ne $sender) {
1123                 $message = "From: $author\n\n$message";
1124                 if (defined $author_encoding) {
1125                         if ($has_content_type) {
1126                                 if ($body_encoding eq $author_encoding) {
1127                                         # ok, we already have the right encoding
1128                                 }
1129                                 else {
1130                                         # uh oh, we should re-encode
1131                                 }
1132                         }
1133                         else {
1134                                 push @xh,
1135                                   'MIME-Version: 1.0',
1136                                   "Content-Type: text/plain; charset=$author_encoding",
1137                                   'Content-Transfer-Encoding: 8bit';
1138                         }
1139                 }
1140         }
1142         $needs_confirm = (
1143                 $confirm eq "always" or
1144                 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1145                 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1146         $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1148         @cc = (@initial_cc, @cc);
1150         my $message_was_sent = send_message();
1152         # set up for the next message
1153         if ($thread && $message_was_sent &&
1154                 ($chain_reply_to || !defined $reply_to || length($reply_to) == 0)) {
1155                 $reply_to = $message_id;
1156                 if (length $references > 0) {
1157                         $references .= "\n $message_id";
1158                 } else {
1159                         $references = "$message_id";
1160                 }
1161         }
1162         $message_id = undef;
1165 cleanup_compose_files();
1167 sub cleanup_compose_files() {
1168         unlink($compose_filename, $compose_filename . ".final") if $compose;
1171 $smtp->quit if $smtp;
1173 sub unique_email_list(@) {
1174         my %seen;
1175         my @emails;
1177         foreach my $entry (@_) {
1178                 if (my $clean = extract_valid_address($entry)) {
1179                         $seen{$clean} ||= 0;
1180                         next if $seen{$clean}++;
1181                         push @emails, $entry;
1182                 } else {
1183                         print STDERR "W: unable to extract a valid address",
1184                                         " from: $entry\n";
1185                 }
1186         }
1187         return @emails;
1190 sub validate_patch {
1191         my $fn = shift;
1192         open(my $fh, '<', $fn)
1193                 or die "unable to open $fn: $!\n";
1194         while (my $line = <$fh>) {
1195                 if (length($line) > 998) {
1196                         return "$.: patch contains a line longer than 998 characters";
1197                 }
1198         }
1199         return undef;
1202 sub file_has_nonascii {
1203         my $fn = shift;
1204         open(my $fh, '<', $fn)
1205                 or die "unable to open $fn: $!\n";
1206         while (my $line = <$fh>) {
1207                 return 1 if $line =~ /[^[:ascii:]]/;
1208         }
1209         return 0;