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