Code

Fix a test failure (t9500-*.sh) on cygwin
[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 Data::Dumper;
24 use Term::ANSIColor;
25 use Git;
27 $SIG{INT} = sub { print color("reset"), "\n"; exit };
29 package FakeTerm;
30 sub new {
31         my ($class, $reason) = @_;
32         return bless \$reason, shift;
33 }
34 sub readline {
35         my $self = shift;
36         die "Cannot use readline on FakeTerm: $$self";
37 }
38 package main;
41 sub usage {
42         print <<EOT;
43 git-send-email [options] <file | directory>...
44 Options:
45    --from         Specify the "From:" line of the email to be sent.
47    --to           Specify the primary "To:" line of the email.
49    --cc           Specify an initial "Cc:" list for the entire series
50                   of emails.
52    --cc-cmd       Specify a command to execute per file which adds
53                   per file specific cc address entries
55    --bcc          Specify a list of email addresses that should be Bcc:
56                   on all the emails.
58    --compose      Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
59                   an introductory message for the patch series.
61    --subject      Specify the initial "Subject:" line.
62                   Only necessary if --compose is also set.  If --compose
63                   is not set, this will be prompted for.
65    --in-reply-to  Specify the first "In-Reply-To:" header line.
66                   Only used if --compose is also set.  If --compose is not
67                   set, this will be prompted for.
69    --chain-reply-to If set, the replies will all be to the previous
70                   email sent, rather than to the first email sent.
71                   Defaults to on.
73    --signed-off-cc Automatically add email addresses that appear in
74                  Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
76    --smtp-server  If set, specifies the outgoing SMTP server to use.
77                   Defaults to localhost.
79    --suppress-from Suppress sending emails to yourself if your address
80                   appears in a From: line. Defaults to off.
82    --thread       Specify that the "In-Reply-To:" header should be set on all
83                   emails. Defaults to on.
85    --quiet        Make git-send-email less verbose.  One line per email
86                   should be all that is output.
88    --dry-run      Do everything except actually send the emails.
90    --envelope-sender    Specify the envelope sender used to send the emails.
92 EOT
93         exit(1);
94 }
96 # most mail servers generate the Date: header, but not all...
97 sub format_2822_time {
98         my ($time) = @_;
99         my @localtm = localtime($time);
100         my @gmttm = gmtime($time);
101         my $localmin = $localtm[1] + $localtm[2] * 60;
102         my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
103         if ($localtm[0] != $gmttm[0]) {
104                 die "local zone differs from GMT by a non-minute interval\n";
105         }
106         if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
107                 $localmin += 1440;
108         } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
109                 $localmin -= 1440;
110         } elsif ($gmttm[6] != $localtm[6]) {
111                 die "local time offset greater than or equal to 24 hours\n";
112         }
113         my $offset = $localmin - $gmtmin;
114         my $offhour = $offset / 60;
115         my $offmin = abs($offset % 60);
116         if (abs($offhour) >= 24) {
117                 die ("local time offset greater than or equal to 24 hours\n");
118         }
120         return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
121                        qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
122                        $localtm[3],
123                        qw(Jan Feb Mar Apr May Jun
124                           Jul Aug Sep Oct Nov Dec)[$localtm[4]],
125                        $localtm[5]+1900,
126                        $localtm[2],
127                        $localtm[1],
128                        $localtm[0],
129                        ($offset >= 0) ? '+' : '-',
130                        abs($offhour),
131                        $offmin,
132                        );
135 my $have_email_valid = eval { require Email::Valid; 1 };
136 my $smtp;
138 sub unique_email_list(@);
139 sub cleanup_compose_files();
141 # Constants (essentially)
142 my $compose_filename = ".msg.$$";
144 # Variables we fill in automatically, or via prompting:
145 my (@to,@cc,@initial_cc,@bcclist,@xh,
146         $initial_reply_to,$initial_subject,@files,$author,$sender,$compose,$time);
148 my $smtp_server;
149 my $envelope_sender;
151 # Example reply to:
152 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
154 my $repo = Git->repository();
155 my $term = eval {
156         new Term::ReadLine 'git-send-email';
157 };
158 if ($@) {
159         $term = new FakeTerm "$@: going non-interactive";
162 # Behavior modification variables
163 my ($quiet, $dry_run) = (0, 0);
165 # Variables with corresponding config settings
166 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
168 my %config_settings = (
169     "thread" => [\$thread, 1],
170     "chainreplyto" => [\$chain_reply_to, 1],
171     "suppressfrom" => [\$suppress_from, 0],
172     "signedoffcc" => [\$signed_off_cc, 1],
173     "cccmd" => [\$cc_cmd, ""],
174 );
176 foreach my $setting (keys %config_settings) {
177     my $config = $repo->config_bool("sendemail.$setting");
178     ${$config_settings{$setting}->[0]} = (defined $config) ? $config : $config_settings{$setting}->[1];
181 @bcclist = $repo->config('sendemail.bcc');
182 if (!@bcclist or !$bcclist[0]) {
183     @bcclist = ();
186 # Begin by accumulating all the variables (defined above), that we will end up
187 # needing, first, from the command line:
189 my $rc = GetOptions("sender|from=s" => \$sender,
190                     "in-reply-to=s" => \$initial_reply_to,
191                     "subject=s" => \$initial_subject,
192                     "to=s" => \@to,
193                     "cc=s" => \@initial_cc,
194                     "bcc=s" => \@bcclist,
195                     "chain-reply-to!" => \$chain_reply_to,
196                     "smtp-server=s" => \$smtp_server,
197                     "compose" => \$compose,
198                     "quiet" => \$quiet,
199                     "cc-cmd=s" => \$cc_cmd,
200                     "suppress-from!" => \$suppress_from,
201                     "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
202                     "dry-run" => \$dry_run,
203                     "envelope-sender=s" => \$envelope_sender,
204                     "thread!" => \$thread,
205          );
207 unless ($rc) {
208     usage();
211 # Verify the user input
213 foreach my $entry (@to) {
214         die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
217 foreach my $entry (@initial_cc) {
218         die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
221 foreach my $entry (@bcclist) {
222         die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
225 # Now, let's fill any that aren't set in with defaults:
227 my ($repoauthor) = $repo->ident_person('author');
228 my ($repocommitter) = $repo->ident_person('committer');
230 my %aliases;
231 my @alias_files = $repo->config('sendemail.aliasesfile');
232 my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
233 my %parse_alias = (
234         # multiline formats can be supported in the future
235         mutt => sub { my $fh = shift; while (<$fh>) {
236                 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
237                         my ($alias, $addr) = ($1, $2);
238                         $addr =~ s/#.*$//; # mutt allows # comments
239                          # commas delimit multiple addresses
240                         $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
241                 }}},
242         mailrc => sub { my $fh = shift; while (<$fh>) {
243                 if (/^alias\s+(\S+)\s+(.*)$/) {
244                         # spaces delimit multiple addresses
245                         $aliases{$1} = [ split(/\s+/, $2) ];
246                 }}},
247         pine => sub { my $fh = shift; while (<$fh>) {
248                 if (/^(\S+)\t.*\t(.*)$/) {
249                         $aliases{$1} = [ split(/\s*,\s*/, $2) ];
250                 }}},
251         gnus => sub { my $fh = shift; while (<$fh>) {
252                 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
253                         $aliases{$1} = [ $2 ];
254                 }}}
255 );
257 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
258         foreach my $file (@alias_files) {
259                 open my $fh, '<', $file or die "opening $file: $!\n";
260                 $parse_alias{$aliasfiletype}->($fh);
261                 close $fh;
262         }
265 ($sender) = expand_aliases($sender) if defined $sender;
267 my $prompting = 0;
268 if (!defined $sender) {
269         $sender = $repoauthor || $repocommitter;
270         do {
271                 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
272         } while (!defined $_);
274         $sender = $_ if ($_);
275         print "Emails will be sent from: ", $sender, "\n";
276         $prompting++;
279 if (!@to) {
280         do {
281                 $_ = $term->readline("Who should the emails be sent to? ",
282                                 "");
283         } while (!defined $_);
284         my $to = $_;
285         push @to, split /,/, $to;
286         $prompting++;
289 sub expand_aliases {
290         my @cur = @_;
291         my @last;
292         do {
293                 @last = @cur;
294                 @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
295         } while (join(',',@cur) ne join(',',@last));
296         return @cur;
299 @to = expand_aliases(@to);
300 @to = (map { sanitize_address($_) } @to);
301 @initial_cc = expand_aliases(@initial_cc);
302 @bcclist = expand_aliases(@bcclist);
304 if (!defined $initial_subject && $compose) {
305         do {
306                 $_ = $term->readline("What subject should the emails start with? ",
307                         $initial_subject);
308         } while (!defined $_);
309         $initial_subject = $_;
310         $prompting++;
313 if ($thread && !defined $initial_reply_to && $prompting) {
314         do {
315                 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
316                         $initial_reply_to);
317         } while (!defined $_);
319         $initial_reply_to = $_;
320         $initial_reply_to =~ s/(^\s+|\s+$)//g;
323 if (!$smtp_server) {
324         $smtp_server = $repo->config('sendemail.smtpserver');
326 if (!$smtp_server) {
327         foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
328                 if (-x $_) {
329                         $smtp_server = $_;
330                         last;
331                 }
332         }
333         $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
336 if ($compose) {
337         # Note that this does not need to be secure, but we will make a small
338         # effort to have it be unique
339         open(C,">",$compose_filename)
340                 or die "Failed to open for writing $compose_filename: $!";
341         print C "From $sender # This line is ignored.\n";
342         printf C "Subject: %s\n\n", $initial_subject;
343         printf C <<EOT;
344 GIT: Please enter your email below.
345 GIT: Lines beginning in "GIT: " will be removed.
346 GIT: Consider including an overall diffstat or table of contents
347 GIT: for the patch you are writing.
349 EOT
350         close(C);
352         my $editor = $ENV{GIT_EDITOR} || $repo->config("core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi";
353         system($editor, $compose_filename);
355         open(C2,">",$compose_filename . ".final")
356                 or die "Failed to open $compose_filename.final : " . $!;
358         open(C,"<",$compose_filename)
359                 or die "Failed to open $compose_filename : " . $!;
361         while(<C>) {
362                 next if m/^GIT: /;
363                 print C2 $_;
364         }
365         close(C);
366         close(C2);
368         do {
369                 $_ = $term->readline("Send this email? (y|n) ");
370         } while (!defined $_);
372         if (uc substr($_,0,1) ne 'Y') {
373                 cleanup_compose_files();
374                 exit(0);
375         }
377         @files = ($compose_filename . ".final");
381 # Now that all the defaults are set, process the rest of the command line
382 # arguments and collect up the files that need to be processed.
383 for my $f (@ARGV) {
384         if (-d $f) {
385                 opendir(DH,$f)
386                         or die "Failed to opendir $f: $!";
388                 push @files, grep { -f $_ } map { +$f . "/" . $_ }
389                                 sort readdir(DH);
391         } elsif (-f $f) {
392                 push @files, $f;
394         } else {
395                 print STDERR "Skipping $f - not found.\n";
396         }
399 if (@files) {
400         unless ($quiet) {
401                 print $_,"\n" for (@files);
402         }
403 } else {
404         print STDERR "\nNo patch files specified!\n\n";
405         usage();
408 # Variables we set as part of the loop over files
409 our ($message_id, %mail, $subject, $reply_to, $references, $message);
411 sub extract_valid_address {
412         my $address = shift;
413         my $local_part_regexp = '[^<>"\s@]+';
414         my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
416         # check for a local address:
417         return $address if ($address =~ /^($local_part_regexp)$/);
419         $address =~ s/^\s*<(.*)>\s*$/$1/;
420         if ($have_email_valid) {
421                 return scalar Email::Valid->address($address);
422         } else {
423                 # less robust/correct than the monster regexp in Email::Valid,
424                 # but still does a 99% job, and one less dependency
425                 $address =~ /($local_part_regexp\@$domain_regexp)/;
426                 return $1;
427         }
430 # Usually don't need to change anything below here.
432 # we make a "fake" message id by taking the current number
433 # of seconds since the beginning of Unix time and tacking on
434 # a random number to the end, in case we are called quicker than
435 # 1 second since the last time we were called.
437 # We'll setup a template for the message id, using the "from" address:
439 sub make_message_id
441         my $date = time;
442         my $pseudo_rand = int (rand(4200));
443         my $du_part;
444         for ($sender, $repocommitter, $repoauthor) {
445                 $du_part = extract_valid_address(sanitize_address($_));
446                 last if (defined $du_part and $du_part ne '');
447         }
448         if (not defined $du_part or $du_part eq '') {
449                 use Sys::Hostname qw();
450                 $du_part = 'user@' . Sys::Hostname::hostname();
451         }
452         my $message_id_template = "<%s-git-send-email-$du_part>";
453         $message_id = sprintf $message_id_template, "$date$pseudo_rand";
454         #print "new message id = $message_id\n"; # Was useful for debugging
459 $time = time - scalar $#files;
461 sub unquote_rfc2047 {
462         local ($_) = @_;
463         if (s/=\?utf-8\?q\?(.*)\?=/$1/g) {
464                 s/_/ /g;
465                 s/=([0-9A-F]{2})/chr(hex($1))/eg;
466         }
467         return "$_";
470 # use the simplest quoting being able to handle the recipient
471 sub sanitize_address
473         my ($recipient) = @_;
474         my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
476         if (not $recipient_name) {
477                 return "$recipient";
478         }
480         # if recipient_name is already quoted, do nothing
481         if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
482                 return $recipient;
483         }
485         # rfc2047 is needed if a non-ascii char is included
486         if ($recipient_name =~ /[^[:ascii:]]/) {
487                 $recipient_name =~ s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
488                 $recipient_name =~ s/(.*)/=\?utf-8\?q\?$1\?=/;
489         }
491         # double quotes are needed if specials or CTLs are included
492         elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
493                 $recipient_name =~ s/(["\\\r])/\\$1/;
494                 $recipient_name = "\"$recipient_name\"";
495         }
497         return "$recipient_name $recipient_addr";
501 sub send_message
503         my @recipients = unique_email_list(@to);
504         @cc = (map { sanitize_address($_) } @cc);
505         my $to = join (",\n\t", @recipients);
506         @recipients = unique_email_list(@recipients,@cc,@bcclist);
507         @recipients = (map { extract_valid_address($_) } @recipients);
508         my $date = format_2822_time($time++);
509         my $gitversion = '@@GIT_VERSION@@';
510         if ($gitversion =~ m/..GIT_VERSION../) {
511             $gitversion = Git::version();
512         }
514         my $cc = join(", ", unique_email_list(@cc));
515         my $ccline = "";
516         if ($cc ne '') {
517                 $ccline = "\nCc: $cc";
518         }
519         my $sanitized_sender = sanitize_address($sender);
520         make_message_id();
522         my $header = "From: $sanitized_sender
523 To: $to${ccline}
524 Subject: $subject
525 Date: $date
526 Message-Id: $message_id
527 X-Mailer: git-send-email $gitversion
528 ";
529         if ($thread && $reply_to) {
531                 $header .= "In-Reply-To: $reply_to\n";
532                 $header .= "References: $references\n";
533         }
534         if (@xh) {
535                 $header .= join("\n", @xh) . "\n";
536         }
538         my @sendmail_parameters = ('-i', @recipients);
539         my $raw_from = $sanitized_sender;
540         $raw_from = $envelope_sender if (defined $envelope_sender);
541         $raw_from = extract_valid_address($raw_from);
542         unshift (@sendmail_parameters,
543                         '-f', $raw_from) if(defined $envelope_sender);
545         if ($dry_run) {
546                 # We don't want to send the email.
547         } elsif ($smtp_server =~ m#^/#) {
548                 my $pid = open my $sm, '|-';
549                 defined $pid or die $!;
550                 if (!$pid) {
551                         exec($smtp_server, @sendmail_parameters) or die $!;
552                 }
553                 print $sm "$header\n$message";
554                 close $sm or die $?;
555         } else {
556                 require Net::SMTP;
557                 $smtp ||= Net::SMTP->new( $smtp_server );
558                 $smtp->mail( $raw_from ) or die $smtp->message;
559                 $smtp->to( @recipients ) or die $smtp->message;
560                 $smtp->data or die $smtp->message;
561                 $smtp->datasend("$header\n$message") or die $smtp->message;
562                 $smtp->dataend() or die $smtp->message;
563                 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
564         }
565         if ($quiet) {
566                 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
567         } else {
568                 print (($dry_run ? "Dry-" : "")."OK. Log says:\nDate: $date\n");
569                 if ($smtp_server !~ m#^/#) {
570                         print "Server: $smtp_server\n";
571                         print "MAIL FROM:<$raw_from>\n";
572                         print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
573                 } else {
574                         print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
575                 }
576                 print "From: $sanitized_sender\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
577                 if ($smtp) {
578                         print "Result: ", $smtp->code, ' ',
579                                 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
580                 } else {
581                         print "Result: OK\n";
582                 }
583         }
586 $reply_to = $initial_reply_to;
587 $references = $initial_reply_to || '';
588 $subject = $initial_subject;
590 foreach my $t (@files) {
591         open(F,"<",$t) or die "can't open file $t";
593         my $author = undef;
594         @cc = @initial_cc;
595         @xh = ();
596         my $input_format = undef;
597         my $header_done = 0;
598         $message = "";
599         while(<F>) {
600                 if (!$header_done) {
601                         if (/^From /) {
602                                 $input_format = 'mbox';
603                                 next;
604                         }
605                         chomp;
606                         if (!defined $input_format && /^[-A-Za-z]+:\s/) {
607                                 $input_format = 'mbox';
608                         }
610                         if (defined $input_format && $input_format eq 'mbox') {
611                                 if (/^Subject:\s+(.*)$/) {
612                                         $subject = $1;
614                                 } elsif (/^(Cc|From):\s+(.*)$/) {
615                                         if (unquote_rfc2047($2) eq $sender) {
616                                                 next if ($suppress_from);
617                                         }
618                                         elsif ($1 eq 'From') {
619                                                 $author = unquote_rfc2047($2);
620                                         }
621                                         printf("(mbox) Adding cc: %s from line '%s'\n",
622                                                 $2, $_) unless $quiet;
623                                         push @cc, $2;
624                                 }
625                                 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
626                                         push @xh, $_;
627                                 }
629                         } else {
630                                 # In the traditional
631                                 # "send lots of email" format,
632                                 # line 1 = cc
633                                 # line 2 = subject
634                                 # So let's support that, too.
635                                 $input_format = 'lots';
636                                 if (@cc == 0) {
637                                         printf("(non-mbox) Adding cc: %s from line '%s'\n",
638                                                 $_, $_) unless $quiet;
640                                         push @cc, $_;
642                                 } elsif (!defined $subject) {
643                                         $subject = $_;
644                                 }
645                         }
647                         # A whitespace line will terminate the headers
648                         if (m/^\s*$/) {
649                                 $header_done = 1;
650                         }
651                 } else {
652                         $message .=  $_;
653                         if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
654                                 my $c = $2;
655                                 chomp $c;
656                                 push @cc, $c;
657                                 printf("(sob) Adding cc: %s from line '%s'\n",
658                                         $c, $_) unless $quiet;
659                         }
660                 }
661         }
662         close F;
664         if ($cc_cmd ne "") {
665                 open(F, "$cc_cmd $t |")
666                         or die "(cc-cmd) Could not execute '$cc_cmd'";
667                 while(<F>) {
668                         my $c = $_;
669                         $c =~ s/^\s*//g;
670                         $c =~ s/\n$//g;
671                         push @cc, $c;
672                         printf("(cc-cmd) Adding cc: %s from: '%s'\n",
673                                 $c, $cc_cmd) unless $quiet;
674                 }
675                 close F
676                         or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
677         }
679         if (defined $author) {
680                 $message = "From: $author\n\n$message";
681         }
683         send_message();
685         # set up for the next message
686         if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
687                 $reply_to = $message_id;
688                 if (length $references > 0) {
689                         $references .= "\n $message_id";
690                 } else {
691                         $references = "$message_id";
692                 }
693         }
696 if ($compose) {
697         cleanup_compose_files();
700 sub cleanup_compose_files() {
701         unlink($compose_filename, $compose_filename . ".final");
705 $smtp->quit if $smtp;
707 sub unique_email_list(@) {
708         my %seen;
709         my @emails;
711         foreach my $entry (@_) {
712                 if (my $clean = extract_valid_address($entry)) {
713                         $seen{$clean} ||= 0;
714                         next if $seen{$clean}++;
715                         push @emails, $entry;
716                 } else {
717                         print STDERR "W: unable to extract a valid address",
718                                         " from: $entry\n";
719                 }
720         }
721         return @emails;