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