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