Add git-init documentation.
[git/git.git] / git-send-email.perl
CommitLineData
83b24437 1#!/usr/bin/perl -w
83b24437 2#
f3d9f354
RA
3# Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4# Copyright 2005 Ryan Anderson <ryan@michonline.com>
83b24437
RA
5#
6# GPL v2 (See COPYING)
5825e5b2 7#
83b24437
RA
8# Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
9#
f3d9f354 10# Sends a collection of emails to the given email addresses, disturbingly fast.
5825e5b2 11#
f3d9f354
RA
12# Supports two formats:
13# 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches)
14# 2. The original format support by Greg's script:
5825e5b2 15# first line of the message is who to CC,
f3d9f354 16# and second line is the subject of the message.
5825e5b2 17#
83b24437
RA
18
19use strict;
20use warnings;
21use Term::ReadLine;
83b24437
RA
22use Getopt::Long;
23use Data::Dumper;
3cb8caf7 24use Git;
83b24437 25
280242d1
JH
26package FakeTerm;
27sub new {
28 my ($class, $reason) = @_;
29 return bless \$reason, shift;
30}
31sub readline {
32 my $self = shift;
33 die "Cannot use readline on FakeTerm: $$self";
34}
35package main;
36
4bc87a28 37# most mail servers generate the Date: header, but not all...
6bdca890
JN
38sub format_2822_time {
39 my ($time) = @_;
40 my @localtm = localtime($time);
41 my @gmttm = gmtime($time);
42 my $localmin = $localtm[1] + $localtm[2] * 60;
43 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
44 if ($localtm[0] != $gmttm[0]) {
45 die "local zone differs from GMT by a non-minute interval\n";
46 }
47 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
48 $localmin += 1440;
49 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
50 $localmin -= 1440;
51 } elsif ($gmttm[6] != $localtm[6]) {
52 die "local time offset greater than or equal to 24 hours\n";
53 }
54 my $offset = $localmin - $gmtmin;
55 my $offhour = $offset / 60;
56 my $offmin = abs($offset % 60);
57 if (abs($offhour) >= 24) {
58 die ("local time offset greater than or equal to 24 hours\n");
59 }
60
61 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
62 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
63 $localtm[3],
64 qw(Jan Feb Mar Apr May Jun
65 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
66 $localtm[5]+1900,
67 $localtm[2],
68 $localtm[1],
69 $localtm[0],
70 ($offset >= 0) ? '+' : '-',
71 abs($offhour),
72 $offmin,
73 );
74}
4bc87a28 75
567ffeb7 76my $have_email_valid = eval { require Email::Valid; 1 };
4bc87a28
EW
77my $smtp;
78
e205735d 79sub unique_email_list(@);
1f038a0c
RA
80sub cleanup_compose_files();
81
82# Constants (essentially)
83my $compose_filename = ".msg.$$";
e205735d 84
83b24437 85# Variables we fill in automatically, or via prompting:
ce91c2f6 86my (@to,@cc,@initial_cc,@bcclist,@xh,
58063245 87 $initial_reply_to,$initial_subject,@files,$from,$compose,$time);
83b24437 88
78488b2c 89# Behavior modification variables
6130259c
MW
90my ($chain_reply_to, $quiet, $suppress_from, $no_signed_off_cc,
91 $dry_run) = (1, 0, 0, 0, 0);
aca7ad76 92my $smtp_server;
78488b2c 93
9133261f 94# Example reply to:
83b24437 95#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
83b24437 96
3cb8caf7 97my $repo = Git->repository();
280242d1
JH
98my $term = eval {
99 new Term::ReadLine 'git-send-email';
100};
101if ($@) {
102 $term = new FakeTerm "$@: going non-interactive";
103}
83b24437
RA
104
105# Begin by accumulating all the variables (defined above), that we will end up
106# needing, first, from the command line:
107
108my $rc = GetOptions("from=s" => \$from,
109 "in-reply-to=s" => \$initial_reply_to,
110 "subject=s" => \$initial_subject,
111 "to=s" => \@to,
da140f8b 112 "cc=s" => \@initial_cc,
58063245 113 "bcc=s" => \@bcclist,
78488b2c 114 "chain-reply-to!" => \$chain_reply_to,
3342d850 115 "smtp-server=s" => \$smtp_server,
1f038a0c 116 "compose" => \$compose,
30d08b34 117 "quiet" => \$quiet,
a985d595 118 "suppress-from" => \$suppress_from,
8e69b31e 119 "no-signed-off-cc|no-signed-off-by-cc" => \$no_signed_off_cc,
6130259c 120 "dry-run" => \$dry_run,
83b24437
RA
121 );
122
79ee555b
EB
123# Verify the user input
124
125foreach my $entry (@to) {
126 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
127}
128
129foreach my $entry (@initial_cc) {
130 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
131}
132
133foreach my $entry (@bcclist) {
134 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
135}
136
83b24437
RA
137# Now, let's fill any that aren't set in with defaults:
138
c7a30e56
PB
139my ($author) = $repo->ident_person('author');
140my ($committer) = $repo->ident_person('committer');
83b24437 141
994d6c66 142my %aliases;
3cb8caf7
PB
143my @alias_files = $repo->config('sendemail.aliasesfile');
144my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
994d6c66
EW
145my %parse_alias = (
146 # multiline formats can be supported in the future
147 mutt => sub { my $fh = shift; while (<$fh>) {
148 if (/^alias\s+(\S+)\s+(.*)$/) {
149 my ($alias, $addr) = ($1, $2);
150 $addr =~ s/#.*$//; # mutt allows # comments
151 # commas delimit multiple addresses
152 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
153 }}},
154 mailrc => sub { my $fh = shift; while (<$fh>) {
155 if (/^alias\s+(\S+)\s+(.*)$/) {
156 # spaces delimit multiple addresses
157 $aliases{$1} = [ split(/\s+/, $2) ];
158 }}},
159 pine => sub { my $fh = shift; while (<$fh>) {
160 if (/^(\S+)\s+(.*)$/) {
161 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
162 }}},
163 gnus => sub { my $fh = shift; while (<$fh>) {
164 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
165 $aliases{$1} = [ $2 ];
166 }}}
167);
168
3cb8caf7 169if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
994d6c66
EW
170 foreach my $file (@alias_files) {
171 open my $fh, '<', $file or die "opening $file: $!\n";
172 $parse_alias{$aliasfiletype}->($fh);
173 close $fh;
174 }
175}
176
1f038a0c 177my $prompting = 0;
83b24437
RA
178if (!defined $from) {
179 $from = $author || $committer;
8037d1a3 180 do {
2ef58055 181 $_ = $term->readline("Who should the emails appear to be from? [$from] ");
ca9a7d65 182 } while (!defined $_);
8037d1a3 183
2ef58055 184 $from = $_ if ($_);
83b24437 185 print "Emails will be sent from: ", $from, "\n";
1f038a0c 186 $prompting++;
83b24437
RA
187}
188
189if (!@to) {
8037d1a3 190 do {
5825e5b2 191 $_ = $term->readline("Who should the emails be sent to? ",
8037d1a3
RA
192 "");
193 } while (!defined $_);
83b24437
RA
194 my $to = $_;
195 push @to, split /,/, $to;
1f038a0c 196 $prompting++;
83b24437
RA
197}
198
994d6c66
EW
199sub expand_aliases {
200 my @cur = @_;
201 my @last;
202 do {
203 @last = @cur;
204 @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
205 } while (join(',',@cur) ne join(',',@last));
206 return @cur;
207}
208
209@to = expand_aliases(@to);
210@initial_cc = expand_aliases(@initial_cc);
58063245 211@bcclist = expand_aliases(@bcclist);
994d6c66 212
1f038a0c 213if (!defined $initial_subject && $compose) {
8037d1a3 214 do {
5825e5b2 215 $_ = $term->readline("What subject should the emails start with? ",
8037d1a3
RA
216 $initial_subject);
217 } while (!defined $_);
83b24437 218 $initial_subject = $_;
1f038a0c 219 $prompting++;
83b24437
RA
220}
221
1f038a0c 222if (!defined $initial_reply_to && $prompting) {
8037d1a3 223 do {
1f038a0c 224 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
8037d1a3
RA
225 $initial_reply_to);
226 } while (!defined $_);
227
83b24437 228 $initial_reply_to = $_;
78488b2c 229 $initial_reply_to =~ s/(^\s+|\s+$)//g;
83b24437
RA
230}
231
6dcfa306
SV
232if (!$smtp_server) {
233 $smtp_server = $repo->config('sendemail.smtpserver');
234}
aca7ad76
EW
235if (!$smtp_server) {
236 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
237 if (-x $_) {
238 $smtp_server = $_;
239 last;
240 }
241 }
242 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
3342d850
RA
243}
244
1f038a0c
RA
245if ($compose) {
246 # Note that this does not need to be secure, but we will make a small
247 # effort to have it be unique
248 open(C,">",$compose_filename)
249 or die "Failed to open for writing $compose_filename: $!";
d366c703 250 print C "From $from # This line is ignored.\n";
1f038a0c
RA
251 printf C "Subject: %s\n\n", $initial_subject;
252 printf C <<EOT;
253GIT: Please enter your email below.
254GIT: Lines beginning in "GIT: " will be removed.
255GIT: Consider including an overall diffstat or table of contents
256GIT: for the patch you are writing.
257
258EOT
259 close(C);
260
261 my $editor = $ENV{EDITOR};
262 $editor = 'vi' unless defined $editor;
263 system($editor, $compose_filename);
264
265 open(C2,">",$compose_filename . ".final")
266 or die "Failed to open $compose_filename.final : " . $!;
267
268 open(C,"<",$compose_filename)
269 or die "Failed to open $compose_filename : " . $!;
270
271 while(<C>) {
272 next if m/^GIT: /;
273 print C2 $_;
274 }
275 close(C);
276 close(C2);
277
278 do {
279 $_ = $term->readline("Send this email? (y|n) ");
280 } while (!defined $_);
281
282 if (uc substr($_,0,1) ne 'Y') {
283 cleanup_compose_files();
284 exit(0);
285 }
286
287 @files = ($compose_filename . ".final");
288}
289
290
83b24437
RA
291# Now that all the defaults are set, process the rest of the command line
292# arguments and collect up the files that need to be processed.
293for my $f (@ARGV) {
294 if (-d $f) {
295 opendir(DH,$f)
296 or die "Failed to opendir $f: $!";
297
5825e5b2 298 push @files, grep { -f $_ } map { +$f . "/" . $_ }
8037d1a3
RA
299 sort readdir(DH);
300
83b24437
RA
301 } elsif (-f $f) {
302 push @files, $f;
303
304 } else {
305 print STDERR "Skipping $f - not found.\n";
306 }
307}
308
309if (@files) {
2718435b
RA
310 unless ($quiet) {
311 print $_,"\n" for (@files);
312 }
83b24437
RA
313} else {
314 print <<EOT;
215a7ad1 315git-send-email [options] <file | directory> [... file | directory ]
83b24437
RA
316Options:
317 --from Specify the "From:" line of the email to be sent.
1f038a0c 318
5825e5b2 319 --to Specify the primary "To:" line of the email.
1f038a0c 320
da140f8b
RA
321 --cc Specify an initial "Cc:" list for the entire series
322 of emails.
323
58063245
RA
324 --bcc Specify a list of email addresses that should be Bcc:
325 on all the emails.
326
1f038a0c
RA
327 --compose Use \$EDITOR to edit an introductory message for the
328 patch series.
329
83b24437 330 --subject Specify the initial "Subject:" line.
1f038a0c
RA
331 Only necessary if --compose is also set. If --compose
332 is not set, this will be prompted for.
333
83b24437 334 --in-reply-to Specify the first "In-Reply-To:" header line.
1f038a0c
RA
335 Only used if --compose is also set. If --compose is not
336 set, this will be prompted for.
337
e205735d 338 --chain-reply-to If set, the replies will all be to the previous
5825e5b2
JH
339 email sent, rather than to the first email sent.
340 Defaults to on.
1f038a0c 341
a985d595
RA
342 --no-signed-off-cc Suppress the automatic addition of email addresses
343 that appear in a Signed-off-by: line, to the cc: list.
344 Note: Using this option is not recommended.
345
3342d850
RA
346 --smtp-server If set, specifies the outgoing SMTP server to use.
347 Defaults to localhost.
83b24437 348
82e5a82f 349 --suppress-from Suppress sending emails to yourself if your address
a985d595
RA
350 appears in a From: line.
351
2718435b
RA
352 --quiet Make git-send-email less verbose. One line per email should be
353 all that is output.
354
83b24437
RA
355Error: Please specify a file or a directory on the command line.
356EOT
357 exit(1);
358}
359
360# Variables we set as part of the loop over files
7ccf7927 361our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message);
83b24437 362
567ffeb7
EW
363sub extract_valid_address {
364 my $address = shift;
ad9c18f5 365 my $local_part_regexp = '[^<>"\s@]+';
09302e17 366 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
db3106b2
EW
367
368 # check for a local address:
ad9c18f5 369 return $address if ($address =~ /^($local_part_regexp)$/);
db3106b2 370
567ffeb7 371 if ($have_email_valid) {
ad9c18f5 372 return scalar Email::Valid->address($address);
567ffeb7
EW
373 } else {
374 # less robust/correct than the monster regexp in Email::Valid,
375 # but still does a 99% job, and one less dependency
ad9c18f5 376 $address =~ /($local_part_regexp\@$domain_regexp)/;
e96fd305 377 return $1;
567ffeb7
EW
378 }
379}
83b24437
RA
380
381# Usually don't need to change anything below here.
382
383# we make a "fake" message id by taking the current number
384# of seconds since the beginning of Unix time and tacking on
385# a random number to the end, in case we are called quicker than
386# 1 second since the last time we were called.
8037d1a3
RA
387
388# We'll setup a template for the message id, using the "from" address:
567ffeb7 389my $message_id_from = extract_valid_address($from);
e205735d 390my $message_id_template = "<%s-git-send-email-$message_id_from>";
8037d1a3 391
83b24437
RA
392sub make_message_id
393{
72095d5c 394 my $date = time;
83b24437 395 my $pseudo_rand = int (rand(4200));
8037d1a3
RA
396 $message_id = sprintf $message_id_template, "$date$pseudo_rand";
397 #print "new message id = $message_id\n"; # Was useful for debugging
83b24437
RA
398}
399
400
401
402$cc = "";
a5370b16 403$time = time - scalar $#files;
83b24437
RA
404
405sub send_message
406{
4bc87a28
EW
407 my @recipients = unique_email_list(@to);
408 my $to = join (",\n\t", @recipients);
58063245 409 @recipients = unique_email_list(@recipients,@cc,@bcclist);
6bdca890 410 my $date = format_2822_time($time++);
e923effb
ML
411 my $gitversion = '@@GIT_VERSION@@';
412 if ($gitversion =~ m/..GIT_VERSION../) {
3cb8caf7 413 $gitversion = Git::version();
e923effb 414 }
4bc87a28 415
7a2a0d21 416 my ($author_name) = ($from =~ /^(.*?)\s+</);
7768e27e 417 if ($author_name && $author_name =~ /\./ && $author_name !~ /^".*"$/) {
7a2a0d21
JH
418 my ($name, $addr) = ($from =~ /^(.*?)(\s+<.*)/);
419 $from = "\"$name\"$addr";
420 }
4bc87a28
EW
421 my $header = "From: $from
422To: $to
423Cc: $cc
424Subject: $subject
4bc87a28
EW
425Date: $date
426Message-Id: $message_id
e923effb 427X-Mailer: git-send-email $gitversion
4bc87a28 428";
7ccf7927
RA
429 if ($reply_to) {
430
431 $header .= "In-Reply-To: $reply_to\n";
432 $header .= "References: $references\n";
433 }
ce91c2f6
JH
434 if (@xh) {
435 $header .= join("\n", @xh) . "\n";
436 }
4bc87a28 437
6130259c
MW
438 if ($dry_run) {
439 # We don't want to send the email.
440 } elsif ($smtp_server =~ m#^/#) {
aca7ad76
EW
441 my $pid = open my $sm, '|-';
442 defined $pid or die $!;
443 if (!$pid) {
2186d566 444 exec($smtp_server,'-i',
ad9c18f5 445 map { extract_valid_address($_) }
2186d566 446 @recipients) or die $!;
aca7ad76
EW
447 }
448 print $sm "$header\n$message";
449 close $sm or die $?;
450 } else {
87840620 451 require Net::SMTP;
aca7ad76
EW
452 $smtp ||= Net::SMTP->new( $smtp_server );
453 $smtp->mail( $from ) or die $smtp->message;
454 $smtp->to( @recipients ) or die $smtp->message;
455 $smtp->data or die $smtp->message;
456 $smtp->datasend("$header\n$message") or die $smtp->message;
457 $smtp->dataend() or die $smtp->message;
458 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
459 }
2718435b
RA
460 if ($quiet) {
461 printf "Sent %s\n", $subject;
462 } else {
aca7ad76
EW
463 print "OK. Log says:\nDate: $date\n";
464 if ($smtp) {
465 print "Server: $smtp_server\n";
466 } else {
467 print "Sendmail: $smtp_server\n";
468 }
469 print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
470 if ($smtp) {
471 print "Result: ", $smtp->code, ' ',
472 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
473 } else {
474 print "Result: OK\n";
475 }
30d08b34 476 }
83b24437
RA
477}
478
83b24437 479$reply_to = $initial_reply_to;
2186d566 480$references = $initial_reply_to || '';
83b24437
RA
481make_message_id();
482$subject = $initial_subject;
483
484foreach my $t (@files) {
83b24437
RA
485 open(F,"<",$t) or die "can't open file $t";
486
8a8e6235 487 my $author_not_sender = undef;
da140f8b 488 @cc = @initial_cc;
ce91c2f6 489 @xh = ();
e6b0964a 490 my $input_format = undef;
83b24437
RA
491 my $header_done = 0;
492 $message = "";
493 while(<F>) {
494 if (!$header_done) {
e6b0964a
JH
495 if (/^From /) {
496 $input_format = 'mbox';
497 next;
498 }
83b24437 499 chomp;
e6b0964a
JH
500 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
501 $input_format = 'mbox';
502 }
83b24437 503
e6b0964a 504 if (defined $input_format && $input_format eq 'mbox') {
83b24437
RA
505 if (/^Subject:\s+(.*)$/) {
506 $subject = $1;
507
508 } elsif (/^(Cc|From):\s+(.*)$/) {
8a8e6235
JH
509 if ($2 eq $from) {
510 next if ($suppress_from);
511 }
68d42c41 512 elsif ($1 eq 'From') {
8a8e6235
JH
513 $author_not_sender = $2;
514 }
83b24437 515 printf("(mbox) Adding cc: %s from line '%s'\n",
2718435b 516 $2, $_) unless $quiet;
83b24437
RA
517 push @cc, $2;
518 }
1d6a003a 519 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
ce91c2f6
JH
520 push @xh, $_;
521 }
83b24437
RA
522
523 } else {
524 # In the traditional
525 # "send lots of email" format,
526 # line 1 = cc
527 # line 2 = subject
528 # So let's support that, too.
e6b0964a 529 $input_format = 'lots';
83b24437
RA
530 if (@cc == 0) {
531 printf("(non-mbox) Adding cc: %s from line '%s'\n",
2718435b 532 $_, $_) unless $quiet;
83b24437
RA
533
534 push @cc, $_;
535
536 } elsif (!defined $subject) {
537 $subject = $_;
538 }
539 }
5825e5b2 540
83b24437
RA
541 # A whitespace line will terminate the headers
542 if (m/^\s*$/) {
543 $header_done = 1;
544 }
545 } else {
546 $message .= $_;
a985d595 547 if (/^Signed-off-by: (.*)$/i && !$no_signed_off_cc) {
83b24437
RA
548 my $c = $1;
549 chomp $c;
550 push @cc, $c;
551 printf("(sob) Adding cc: %s from line '%s'\n",
2718435b 552 $c, $_) unless $quiet;
83b24437
RA
553 }
554 }
555 }
556 close F;
8a8e6235
JH
557 if (defined $author_not_sender) {
558 $message = "From: $author_not_sender\n\n$message";
559 }
83b24437 560
e205735d 561 $cc = join(", ", unique_email_list(@cc));
83b24437
RA
562
563 send_message();
564
565 # set up for the next message
bc108f63 566 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
78488b2c 567 $reply_to = $message_id;
7ccf7927
RA
568 if (length $references > 0) {
569 $references .= " $message_id";
570 } else {
571 $references = "$message_id";
572 }
78488b2c 573 }
83b24437 574 make_message_id();
83b24437 575}
e205735d 576
1f038a0c
RA
577if ($compose) {
578 cleanup_compose_files();
579}
580
581sub cleanup_compose_files() {
582 unlink($compose_filename, $compose_filename . ".final");
583
584}
585
4bc87a28 586$smtp->quit if $smtp;
e205735d
RA
587
588sub unique_email_list(@) {
589 my %seen;
590 my @emails;
591
592 foreach my $entry (@_) {
db3106b2
EW
593 if (my $clean = extract_valid_address($entry)) {
594 $seen{$clean} ||= 0;
595 next if $seen{$clean}++;
596 push @emails, $entry;
597 } else {
598 print STDERR "W: unable to extract a valid address",
599 " from: $entry\n";
600 }
e205735d
RA
601 }
602 return @emails;
603}