]>
Commit | Line | Data |
---|---|---|
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 | |
19 | use strict; | |
20 | use warnings; | |
21 | use Term::ReadLine; | |
83b24437 RA |
22 | use Getopt::Long; |
23 | use Data::Dumper; | |
83b24437 | 24 | |
4bc87a28 EW |
25 | # most mail servers generate the Date: header, but not all... |
26 | $ENV{LC_ALL} = 'C'; | |
27 | use POSIX qw/strftime/; | |
28 | ||
567ffeb7 | 29 | my $have_email_valid = eval { require Email::Valid; 1 }; |
4bc87a28 EW |
30 | my $smtp; |
31 | ||
e205735d | 32 | sub unique_email_list(@); |
1f038a0c RA |
33 | sub cleanup_compose_files(); |
34 | ||
35 | # Constants (essentially) | |
36 | my $compose_filename = ".msg.$$"; | |
e205735d | 37 | |
83b24437 | 38 | # Variables we fill in automatically, or via prompting: |
58063245 RA |
39 | my (@to,@cc,@initial_cc,@bcclist, |
40 | $initial_reply_to,$initial_subject,@files,$from,$compose,$time); | |
83b24437 | 41 | |
78488b2c | 42 | # Behavior modification variables |
aca7ad76 EW |
43 | my ($chain_reply_to, $quiet, $suppress_from, $no_signed_off_cc) = (1, 0, 0, 0); |
44 | my $smtp_server; | |
78488b2c | 45 | |
9133261f | 46 | # Example reply to: |
83b24437 | 47 | #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>'; |
83b24437 RA |
48 | |
49 | my $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 | ||
54 | my $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 |
70 | sub 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 |
84 | sub 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 | |
91 | my ($author) = gitvar_ident('GIT_AUTHOR_IDENT'); | |
92 | my ($committer) = gitvar_ident('GIT_COMMITTER_IDENT'); | |
83b24437 | 93 | |
994d6c66 EW |
94 | my %aliases; |
95 | chomp(my @alias_files = `git-repo-config --get-all sendemail.aliasesfile`); | |
96 | chomp(my $aliasfiletype = `git-repo-config sendemail.aliasfiletype`); | |
97 | my %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 | ||
121 | if (@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 | 129 | my $prompting = 0; |
83b24437 RA |
130 | if (!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 | ||
142 | if (!@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 |
152 | sub 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 | 166 | if (!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 | 175 | if (!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 |
185 | if (!$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 |
195 | if ($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; | |
203 | GIT: Please enter your email below. | |
204 | GIT: Lines beginning in "GIT: " will be removed. | |
205 | GIT: Consider including an overall diffstat or table of contents | |
206 | GIT: for the patch you are writing. | |
207 | ||
208 | EOT | |
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. | |
243 | for 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 | ||
259 | if (@files) { | |
2718435b RA |
260 | unless ($quiet) { |
261 | print $_,"\n" for (@files); | |
262 | } | |
83b24437 RA |
263 | } else { |
264 | print <<EOT; | |
215a7ad1 | 265 | git-send-email [options] <file | directory> [... file | directory ] |
83b24437 RA |
266 | Options: |
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 |
305 | Error: Please specify a file or a directory on the command line. |
306 | EOT | |
307 | exit(1); | |
308 | } | |
309 | ||
310 | # Variables we set as part of the loop over files | |
7ccf7927 | 311 | our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message); |
83b24437 | 312 | |
567ffeb7 EW |
313 | sub extract_valid_address { |
314 | my $address = shift; | |
db3106b2 EW |
315 | |
316 | # check for a local address: | |
e96fd305 | 317 | return $address if ($address =~ /^([\w\-.]+)$/); |
db3106b2 | 318 | |
567ffeb7 EW |
319 | if ($have_email_valid) { |
320 | return Email::Valid->address($address); | |
321 | } else { | |
322 | # less robust/correct than the monster regexp in Email::Valid, | |
323 | # but still does a 99% job, and one less dependency | |
e96fd305 HB |
324 | $address =~ /([\w\-.]+@[\w\-.]+)/; |
325 | return $1; | |
567ffeb7 EW |
326 | } |
327 | } | |
83b24437 RA |
328 | |
329 | # Usually don't need to change anything below here. | |
330 | ||
331 | # we make a "fake" message id by taking the current number | |
332 | # of seconds since the beginning of Unix time and tacking on | |
333 | # a random number to the end, in case we are called quicker than | |
334 | # 1 second since the last time we were called. | |
8037d1a3 RA |
335 | |
336 | # We'll setup a template for the message id, using the "from" address: | |
567ffeb7 | 337 | my $message_id_from = extract_valid_address($from); |
e205735d | 338 | my $message_id_template = "<%s-git-send-email-$message_id_from>"; |
8037d1a3 | 339 | |
83b24437 RA |
340 | sub make_message_id |
341 | { | |
72095d5c | 342 | my $date = time; |
83b24437 | 343 | my $pseudo_rand = int (rand(4200)); |
8037d1a3 RA |
344 | $message_id = sprintf $message_id_template, "$date$pseudo_rand"; |
345 | #print "new message id = $message_id\n"; # Was useful for debugging | |
83b24437 RA |
346 | } |
347 | ||
348 | ||
349 | ||
350 | $cc = ""; | |
a5370b16 | 351 | $time = time - scalar $#files; |
83b24437 RA |
352 | |
353 | sub send_message | |
354 | { | |
4bc87a28 EW |
355 | my @recipients = unique_email_list(@to); |
356 | my $to = join (",\n\t", @recipients); | |
58063245 | 357 | @recipients = unique_email_list(@recipients,@cc,@bcclist); |
a5370b16 | 358 | my $date = strftime('%a, %d %b %Y %H:%M:%S %z', localtime($time++)); |
e923effb ML |
359 | my $gitversion = '@@GIT_VERSION@@'; |
360 | if ($gitversion =~ m/..GIT_VERSION../) { | |
361 | $gitversion = `git --version`; | |
362 | chomp $gitversion; | |
363 | # keep only what's after the last space | |
364 | $gitversion =~ s/^.* //; | |
365 | } | |
4bc87a28 EW |
366 | |
367 | my $header = "From: $from | |
368 | To: $to | |
369 | Cc: $cc | |
370 | Subject: $subject | |
371 | Reply-To: $from | |
372 | Date: $date | |
373 | Message-Id: $message_id | |
e923effb | 374 | X-Mailer: git-send-email $gitversion |
4bc87a28 | 375 | "; |
7ccf7927 RA |
376 | if ($reply_to) { |
377 | ||
378 | $header .= "In-Reply-To: $reply_to\n"; | |
379 | $header .= "References: $references\n"; | |
380 | } | |
4bc87a28 | 381 | |
aca7ad76 EW |
382 | if ($smtp_server =~ m#^/#) { |
383 | my $pid = open my $sm, '|-'; | |
384 | defined $pid or die $!; | |
385 | if (!$pid) { | |
2186d566 JH |
386 | exec($smtp_server,'-i', |
387 | map { scalar extract_valid_address($_) } | |
388 | @recipients) or die $!; | |
aca7ad76 EW |
389 | } |
390 | print $sm "$header\n$message"; | |
391 | close $sm or die $?; | |
392 | } else { | |
87840620 | 393 | require Net::SMTP; |
aca7ad76 EW |
394 | $smtp ||= Net::SMTP->new( $smtp_server ); |
395 | $smtp->mail( $from ) or die $smtp->message; | |
396 | $smtp->to( @recipients ) or die $smtp->message; | |
397 | $smtp->data or die $smtp->message; | |
398 | $smtp->datasend("$header\n$message") or die $smtp->message; | |
399 | $smtp->dataend() or die $smtp->message; | |
400 | $smtp->ok or die "Failed to send $subject\n".$smtp->message; | |
401 | } | |
2718435b RA |
402 | if ($quiet) { |
403 | printf "Sent %s\n", $subject; | |
404 | } else { | |
aca7ad76 EW |
405 | print "OK. Log says:\nDate: $date\n"; |
406 | if ($smtp) { | |
407 | print "Server: $smtp_server\n"; | |
408 | } else { | |
409 | print "Sendmail: $smtp_server\n"; | |
410 | } | |
411 | print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n"; | |
412 | if ($smtp) { | |
413 | print "Result: ", $smtp->code, ' ', | |
414 | ($smtp->message =~ /\n([^\n]+\n)$/s), "\n"; | |
415 | } else { | |
416 | print "Result: OK\n"; | |
417 | } | |
30d08b34 | 418 | } |
83b24437 RA |
419 | } |
420 | ||
83b24437 | 421 | $reply_to = $initial_reply_to; |
2186d566 | 422 | $references = $initial_reply_to || ''; |
83b24437 RA |
423 | make_message_id(); |
424 | $subject = $initial_subject; | |
425 | ||
426 | foreach my $t (@files) { | |
83b24437 RA |
427 | open(F,"<",$t) or die "can't open file $t"; |
428 | ||
8a8e6235 | 429 | my $author_not_sender = undef; |
da140f8b | 430 | @cc = @initial_cc; |
83b24437 RA |
431 | my $found_mbox = 0; |
432 | my $header_done = 0; | |
433 | $message = ""; | |
434 | while(<F>) { | |
435 | if (!$header_done) { | |
436 | $found_mbox = 1, next if (/^From /); | |
437 | chomp; | |
438 | ||
439 | if ($found_mbox) { | |
440 | if (/^Subject:\s+(.*)$/) { | |
441 | $subject = $1; | |
442 | ||
443 | } elsif (/^(Cc|From):\s+(.*)$/) { | |
8a8e6235 JH |
444 | if ($2 eq $from) { |
445 | next if ($suppress_from); | |
446 | } | |
447 | else { | |
448 | $author_not_sender = $2; | |
449 | } | |
83b24437 | 450 | printf("(mbox) Adding cc: %s from line '%s'\n", |
2718435b | 451 | $2, $_) unless $quiet; |
83b24437 RA |
452 | push @cc, $2; |
453 | } | |
454 | ||
455 | } else { | |
456 | # In the traditional | |
457 | # "send lots of email" format, | |
458 | # line 1 = cc | |
459 | # line 2 = subject | |
460 | # So let's support that, too. | |
461 | if (@cc == 0) { | |
462 | printf("(non-mbox) Adding cc: %s from line '%s'\n", | |
2718435b | 463 | $_, $_) unless $quiet; |
83b24437 RA |
464 | |
465 | push @cc, $_; | |
466 | ||
467 | } elsif (!defined $subject) { | |
468 | $subject = $_; | |
469 | } | |
470 | } | |
5825e5b2 | 471 | |
83b24437 RA |
472 | # A whitespace line will terminate the headers |
473 | if (m/^\s*$/) { | |
474 | $header_done = 1; | |
475 | } | |
476 | } else { | |
477 | $message .= $_; | |
a985d595 | 478 | if (/^Signed-off-by: (.*)$/i && !$no_signed_off_cc) { |
83b24437 RA |
479 | my $c = $1; |
480 | chomp $c; | |
481 | push @cc, $c; | |
482 | printf("(sob) Adding cc: %s from line '%s'\n", | |
2718435b | 483 | $c, $_) unless $quiet; |
83b24437 RA |
484 | } |
485 | } | |
486 | } | |
487 | close F; | |
8a8e6235 JH |
488 | if (defined $author_not_sender) { |
489 | $message = "From: $author_not_sender\n\n$message"; | |
490 | } | |
83b24437 | 491 | |
e205735d | 492 | $cc = join(", ", unique_email_list(@cc)); |
83b24437 RA |
493 | |
494 | send_message(); | |
495 | ||
496 | # set up for the next message | |
78488b2c RA |
497 | if ($chain_reply_to || length($reply_to) == 0) { |
498 | $reply_to = $message_id; | |
7ccf7927 RA |
499 | if (length $references > 0) { |
500 | $references .= " $message_id"; | |
501 | } else { | |
502 | $references = "$message_id"; | |
503 | } | |
78488b2c | 504 | } |
83b24437 | 505 | make_message_id(); |
83b24437 | 506 | } |
e205735d | 507 | |
1f038a0c RA |
508 | if ($compose) { |
509 | cleanup_compose_files(); | |
510 | } | |
511 | ||
512 | sub cleanup_compose_files() { | |
513 | unlink($compose_filename, $compose_filename . ".final"); | |
514 | ||
515 | } | |
516 | ||
4bc87a28 | 517 | $smtp->quit if $smtp; |
e205735d RA |
518 | |
519 | sub unique_email_list(@) { | |
520 | my %seen; | |
521 | my @emails; | |
522 | ||
523 | foreach my $entry (@_) { | |
db3106b2 EW |
524 | if (my $clean = extract_valid_address($entry)) { |
525 | $seen{$clean} ||= 0; | |
526 | next if $seen{$clean}++; | |
527 | push @emails, $entry; | |
528 | } else { | |
529 | print STDERR "W: unable to extract a valid address", | |
530 | " from: $entry\n"; | |
531 | } | |
e205735d RA |
532 | } |
533 | return @emails; | |
534 | } |