3 # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4 # Copyright 2005 Ryan Anderson <ryan@michonline.com>
8 # Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
10 # Sends a collection of emails to the given email addresses, disturbingly fast.
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:
15 # first line of the message is who to CC,
16 # and second line is the subject of the message.
26 # most mail servers generate the Date: header, but not all...
28 use POSIX qw
/strftime/;
30 my $have_email_valid = eval { require Email
::Valid
; 1 };
33 sub unique_email_list
(@
);
34 sub cleanup_compose_files
();
36 # Constants (essentially)
37 my $compose_filename = ".msg.$$";
39 # Variables we fill in automatically, or via prompting:
40 my (@to,@cc,@initial_cc,@bcclist,
41 $initial_reply_to,$initial_subject,@files,$from,$compose,$time);
43 # Behavior modification variables
44 my ($chain_reply_to, $quiet, $suppress_from, $no_signed_off_cc) = (1, 0, 0, 0);
48 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
50 my $repo = Git
->repository();
52 my $term = new Term
::ReadLine
'git-send-email';
54 # Begin by accumulating all the variables (defined above), that we will end up
55 # needing, first, from the command line:
57 my $rc = GetOptions
("from=s" => \
$from,
58 "in-reply-to=s" => \
$initial_reply_to,
59 "subject=s" => \
$initial_subject,
61 "cc=s" => \
@initial_cc,
63 "chain-reply-to!" => \
$chain_reply_to,
64 "smtp-server=s" => \
$smtp_server,
65 "compose" => \
$compose,
67 "suppress-from" => \
$suppress_from,
68 "no-signed-off-cc|no-signed-off-by-cc" => \
$no_signed_off_cc,
71 # Verify the user input
73 foreach my $entry (@to) {
74 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
77 foreach my $entry (@initial_cc) {
78 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
81 foreach my $entry (@bcclist) {
82 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
85 # Now, let's fill any that aren't set in with defaults:
87 my ($author) = $repo->ident_person('author');
88 my ($committer) = $repo->ident_person('committer');
91 my @alias_files = $repo->config('sendemail.aliasesfile');
92 my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
94 # multiline formats can be supported in the future
95 mutt
=> sub { my $fh = shift; while (<$fh>) {
96 if (/^alias\s+(\S+)\s+(.*)$/) {
97 my ($alias, $addr) = ($1, $2);
98 $addr =~ s/#.*$//; # mutt allows # comments
99 # commas delimit multiple addresses
100 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
102 mailrc
=> sub { my $fh = shift; while (<$fh>) {
103 if (/^alias\s+(\S+)\s+(.*)$/) {
104 # spaces delimit multiple addresses
105 $aliases{$1} = [ split(/\s+/, $2) ];
107 pine
=> sub { my $fh = shift; while (<$fh>) {
108 if (/^(\S+)\s+(.*)$/) {
109 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
111 gnus
=> sub { my $fh = shift; while (<$fh>) {
112 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
113 $aliases{$1} = [ $2 ];
117 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
118 foreach my $file (@alias_files) {
119 open my $fh, '<', $file or die "opening $file: $!\n";
120 $parse_alias{$aliasfiletype}->($fh);
126 if (!defined $from) {
127 $from = $author || $committer;
129 $_ = $term->readline("Who should the emails appear to be from? ",
131 } while (!defined $_);
134 print "Emails will be sent from: ", $from, "\n";
140 $_ = $term->readline("Who should the emails be sent to? ",
142 } while (!defined $_);
144 push @to, split /,/, $to;
153 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
154 } while (join(',',@cur) ne join(',',@last));
158 @to = expand_aliases
(@to);
159 @initial_cc = expand_aliases
(@initial_cc);
160 @bcclist = expand_aliases
(@bcclist);
162 if (!defined $initial_subject && $compose) {
164 $_ = $term->readline("What subject should the emails start with? ",
166 } while (!defined $_);
167 $initial_subject = $_;
171 if (!defined $initial_reply_to && $prompting) {
173 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
175 } while (!defined $_);
177 $initial_reply_to = $_;
178 $initial_reply_to =~ s/(^\s+|\s+$)//g;
182 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
188 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
192 # Note that this does not need to be secure, but we will make a small
193 # effort to have it be unique
194 open(C
,">",$compose_filename)
195 or die "Failed to open for writing $compose_filename: $!";
196 print C
"From $from # This line is ignored.\n";
197 printf C
"Subject: %s\n\n", $initial_subject;
199 GIT: Please enter your email below.
200 GIT: Lines beginning in "GIT: " will be removed.
201 GIT: Consider including an overall diffstat or table of contents
202 GIT: for the patch you are writing.
207 my $editor = $ENV{EDITOR
};
208 $editor = 'vi' unless defined $editor;
209 system($editor, $compose_filename);
211 open(C2
,">",$compose_filename . ".final")
212 or die "Failed to open $compose_filename.final : " . $!;
214 open(C
,"<",$compose_filename)
215 or die "Failed to open $compose_filename : " . $!;
225 $_ = $term->readline("Send this email? (y|n) ");
226 } while (!defined $_);
228 if (uc substr($_,0,1) ne 'Y') {
229 cleanup_compose_files
();
233 @files = ($compose_filename . ".final");
237 # Now that all the defaults are set, process the rest of the command line
238 # arguments and collect up the files that need to be processed.
242 or die "Failed to opendir $f: $!";
244 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
251 print STDERR
"Skipping $f - not found.\n";
257 print $_,"\n" for (@files);
261 git-send-email [options] <file | directory> [... file | directory ]
263 --from Specify the "From:" line of the email to be sent.
265 --to Specify the primary "To:" line of the email.
267 --cc Specify an initial "Cc:" list for the entire series
270 --bcc Specify a list of email addresses that should be Bcc:
273 --compose Use \$EDITOR to edit an introductory message for the
276 --subject Specify the initial "Subject:" line.
277 Only necessary if --compose is also set. If --compose
278 is not set, this will be prompted for.
280 --in-reply-to Specify the first "In-Reply-To:" header line.
281 Only used if --compose is also set. If --compose is not
282 set, this will be prompted for.
284 --chain-reply-to If set, the replies will all be to the previous
285 email sent, rather than to the first email sent.
288 --no-signed-off-cc Suppress the automatic addition of email addresses
289 that appear in a Signed-off-by: line, to the cc: list.
290 Note: Using this option is not recommended.
292 --smtp-server If set, specifies the outgoing SMTP server to use.
293 Defaults to localhost.
295 --suppress-from Supress sending emails to yourself if your address
296 appears in a From: line.
298 --quiet Make git-send-email less verbose. One line per email should be
301 Error: Please specify a file or a directory on the command line.
306 # Variables we set as part of the loop over files
307 our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message);
309 sub extract_valid_address
{
311 my $local_part_regexp = '[^<>"\s@]+';
312 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
314 # check for a local address:
315 return $address if ($address =~ /^($local_part_regexp)$/);
317 if ($have_email_valid) {
318 return scalar Email
::Valid
->address($address);
320 # less robust/correct than the monster regexp in Email::Valid,
321 # but still does a 99% job, and one less dependency
322 $address =~ /($local_part_regexp\@$domain_regexp)/;
327 # Usually don't need to change anything below here.
329 # we make a "fake" message id by taking the current number
330 # of seconds since the beginning of Unix time and tacking on
331 # a random number to the end, in case we are called quicker than
332 # 1 second since the last time we were called.
334 # We'll setup a template for the message id, using the "from" address:
335 my $message_id_from = extract_valid_address
($from);
336 my $message_id_template = "<%s-git-send-email-$message_id_from>";
341 my $pseudo_rand = int (rand(4200));
342 $message_id = sprintf $message_id_template, "$date$pseudo_rand";
343 #print "new message id = $message_id\n"; # Was useful for debugging
349 $time = time - scalar $#files;
353 my @recipients = unique_email_list
(@to);
354 my $to = join (",\n\t", @recipients);
355 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
356 my $date = strftime
('%a, %d %b %Y %H:%M:%S %z', localtime($time++));
357 my $gitversion = '@@GIT_VERSION@@';
358 if ($gitversion =~ m/..GIT_VERSION../) {
359 $gitversion = Git
::version
();
362 my $header = "From: $from
368 Message-Id: $message_id
369 X-Mailer: git-send-email $gitversion
373 $header .= "In-Reply-To: $reply_to\n";
374 $header .= "References: $references\n";
377 if ($smtp_server =~ m
#^/#) {
378 my $pid = open my $sm, '|-';
379 defined $pid or die $!;
381 exec($smtp_server,'-i',
382 map { extract_valid_address
($_) }
383 @recipients) or die $!;
385 print $sm "$header\n$message";
389 $smtp ||= Net
::SMTP
->new( $smtp_server );
390 $smtp->mail( $from ) or die $smtp->message;
391 $smtp->to( @recipients ) or die $smtp->message;
392 $smtp->data or die $smtp->message;
393 $smtp->datasend("$header\n$message") or die $smtp->message;
394 $smtp->dataend() or die $smtp->message;
395 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
398 printf "Sent %s\n", $subject;
400 print "OK. Log says:\nDate: $date\n";
402 print "Server: $smtp_server\n";
404 print "Sendmail: $smtp_server\n";
406 print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
408 print "Result: ", $smtp->code, ' ',
409 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
411 print "Result: OK\n";
416 $reply_to = $initial_reply_to;
417 $references = $initial_reply_to || '';
419 $subject = $initial_subject;
421 foreach my $t (@files) {
422 open(F
,"<",$t) or die "can't open file $t";
424 my $author_not_sender = undef;
431 $found_mbox = 1, next if (/^From /);
435 if (/^Subject:\s+(.*)$/) {
438 } elsif (/^(Cc|From):\s+(.*)$/) {
440 next if ($suppress_from);
443 $author_not_sender = $2;
445 printf("(mbox) Adding cc: %s from line '%s'\n",
446 $2, $_) unless $quiet;
452 # "send lots of email" format,
455 # So let's support that, too.
457 printf("(non-mbox) Adding cc: %s from line '%s'\n",
458 $_, $_) unless $quiet;
462 } elsif (!defined $subject) {
467 # A whitespace line will terminate the headers
473 if (/^Signed-off-by: (.*)$/i && !$no_signed_off_cc) {
477 printf("(sob) Adding cc: %s from line '%s'\n",
478 $c, $_) unless $quiet;
483 if (defined $author_not_sender) {
484 $message = "From: $author_not_sender\n\n$message";
487 $cc = join(", ", unique_email_list
(@cc));
491 # set up for the next message
492 if ($chain_reply_to || length($reply_to) == 0) {
493 $reply_to = $message_id;
494 if (length $references > 0) {
495 $references .= " $message_id";
497 $references = "$message_id";
504 cleanup_compose_files
();
507 sub cleanup_compose_files
() {
508 unlink($compose_filename, $compose_filename . ".final");
512 $smtp->quit if $smtp;
514 sub unique_email_list
(@
) {
518 foreach my $entry (@_) {
519 if (my $clean = extract_valid_address
($entry)) {
521 next if $seen{$clean}++;
522 push @emails, $entry;
524 print STDERR
"W: unable to extract a valid address",