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:
89 my $val = $repo->command('var', $name);
90 my @field = split(/\s+/, $val);
91 return join(' ', @field[0...(@field-3)]);
94 my ($author) = gitvar_ident
('GIT_AUTHOR_IDENT');
95 my ($committer) = gitvar_ident
('GIT_COMMITTER_IDENT');
98 my @alias_files = $repo->config('sendemail.aliasesfile');
99 my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
101 # multiline formats can be supported in the future
102 mutt
=> sub { my $fh = shift; while (<$fh>) {
103 if (/^alias\s+(\S+)\s+(.*)$/) {
104 my ($alias, $addr) = ($1, $2);
105 $addr =~ s/#.*$//; # mutt allows # comments
106 # commas delimit multiple addresses
107 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
109 mailrc
=> sub { my $fh = shift; while (<$fh>) {
110 if (/^alias\s+(\S+)\s+(.*)$/) {
111 # spaces delimit multiple addresses
112 $aliases{$1} = [ split(/\s+/, $2) ];
114 pine
=> sub { my $fh = shift; while (<$fh>) {
115 if (/^(\S+)\s+(.*)$/) {
116 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
118 gnus
=> sub { my $fh = shift; while (<$fh>) {
119 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
120 $aliases{$1} = [ $2 ];
124 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
125 foreach my $file (@alias_files) {
126 open my $fh, '<', $file or die "opening $file: $!\n";
127 $parse_alias{$aliasfiletype}->($fh);
133 if (!defined $from) {
134 $from = $author || $committer;
136 $_ = $term->readline("Who should the emails appear to be from? ",
138 } while (!defined $_);
141 print "Emails will be sent from: ", $from, "\n";
147 $_ = $term->readline("Who should the emails be sent to? ",
149 } while (!defined $_);
151 push @to, split /,/, $to;
160 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
161 } while (join(',',@cur) ne join(',',@last));
165 @to = expand_aliases
(@to);
166 @initial_cc = expand_aliases
(@initial_cc);
167 @bcclist = expand_aliases
(@bcclist);
169 if (!defined $initial_subject && $compose) {
171 $_ = $term->readline("What subject should the emails start with? ",
173 } while (!defined $_);
174 $initial_subject = $_;
178 if (!defined $initial_reply_to && $prompting) {
180 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
182 } while (!defined $_);
184 $initial_reply_to = $_;
185 $initial_reply_to =~ s/(^\s+|\s+$)//g;
189 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
195 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
199 # Note that this does not need to be secure, but we will make a small
200 # effort to have it be unique
201 open(C
,">",$compose_filename)
202 or die "Failed to open for writing $compose_filename: $!";
203 print C
"From $from # This line is ignored.\n";
204 printf C
"Subject: %s\n\n", $initial_subject;
206 GIT: Please enter your email below.
207 GIT: Lines beginning in "GIT: " will be removed.
208 GIT: Consider including an overall diffstat or table of contents
209 GIT: for the patch you are writing.
214 my $editor = $ENV{EDITOR
};
215 $editor = 'vi' unless defined $editor;
216 system($editor, $compose_filename);
218 open(C2
,">",$compose_filename . ".final")
219 or die "Failed to open $compose_filename.final : " . $!;
221 open(C
,"<",$compose_filename)
222 or die "Failed to open $compose_filename : " . $!;
232 $_ = $term->readline("Send this email? (y|n) ");
233 } while (!defined $_);
235 if (uc substr($_,0,1) ne 'Y') {
236 cleanup_compose_files
();
240 @files = ($compose_filename . ".final");
244 # Now that all the defaults are set, process the rest of the command line
245 # arguments and collect up the files that need to be processed.
249 or die "Failed to opendir $f: $!";
251 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
258 print STDERR
"Skipping $f - not found.\n";
264 print $_,"\n" for (@files);
268 git-send-email [options] <file | directory> [... file | directory ]
270 --from Specify the "From:" line of the email to be sent.
272 --to Specify the primary "To:" line of the email.
274 --cc Specify an initial "Cc:" list for the entire series
277 --bcc Specify a list of email addresses that should be Bcc:
280 --compose Use \$EDITOR to edit an introductory message for the
283 --subject Specify the initial "Subject:" line.
284 Only necessary if --compose is also set. If --compose
285 is not set, this will be prompted for.
287 --in-reply-to Specify the first "In-Reply-To:" header line.
288 Only used if --compose is also set. If --compose is not
289 set, this will be prompted for.
291 --chain-reply-to If set, the replies will all be to the previous
292 email sent, rather than to the first email sent.
295 --no-signed-off-cc Suppress the automatic addition of email addresses
296 that appear in a Signed-off-by: line, to the cc: list.
297 Note: Using this option is not recommended.
299 --smtp-server If set, specifies the outgoing SMTP server to use.
300 Defaults to localhost.
302 --suppress-from Supress sending emails to yourself if your address
303 appears in a From: line.
305 --quiet Make git-send-email less verbose. One line per email should be
308 Error: Please specify a file or a directory on the command line.
313 # Variables we set as part of the loop over files
314 our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message);
316 sub extract_valid_address
{
318 my $local_part_regexp = '[^<>"\s@]+';
319 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
321 # check for a local address:
322 return $address if ($address =~ /^($local_part_regexp)$/);
324 if ($have_email_valid) {
325 return scalar Email
::Valid
->address($address);
327 # less robust/correct than the monster regexp in Email::Valid,
328 # but still does a 99% job, and one less dependency
329 $address =~ /($local_part_regexp\@$domain_regexp)/;
334 # Usually don't need to change anything below here.
336 # we make a "fake" message id by taking the current number
337 # of seconds since the beginning of Unix time and tacking on
338 # a random number to the end, in case we are called quicker than
339 # 1 second since the last time we were called.
341 # We'll setup a template for the message id, using the "from" address:
342 my $message_id_from = extract_valid_address
($from);
343 my $message_id_template = "<%s-git-send-email-$message_id_from>";
348 my $pseudo_rand = int (rand(4200));
349 $message_id = sprintf $message_id_template, "$date$pseudo_rand";
350 #print "new message id = $message_id\n"; # Was useful for debugging
356 $time = time - scalar $#files;
360 my @recipients = unique_email_list
(@to);
361 my $to = join (",\n\t", @recipients);
362 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
363 my $date = strftime
('%a, %d %b %Y %H:%M:%S %z', localtime($time++));
364 my $gitversion = '@@GIT_VERSION@@';
365 if ($gitversion =~ m/..GIT_VERSION../) {
366 $gitversion = Git
::version
();
369 my $header = "From: $from
375 Message-Id: $message_id
376 X-Mailer: git-send-email $gitversion
380 $header .= "In-Reply-To: $reply_to\n";
381 $header .= "References: $references\n";
384 if ($smtp_server =~ m
#^/#) {
385 my $pid = open my $sm, '|-';
386 defined $pid or die $!;
388 exec($smtp_server,'-i',
389 map { extract_valid_address
($_) }
390 @recipients) or die $!;
392 print $sm "$header\n$message";
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;
405 printf "Sent %s\n", $subject;
407 print "OK. Log says:\nDate: $date\n";
409 print "Server: $smtp_server\n";
411 print "Sendmail: $smtp_server\n";
413 print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
415 print "Result: ", $smtp->code, ' ',
416 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
418 print "Result: OK\n";
423 $reply_to = $initial_reply_to;
424 $references = $initial_reply_to || '';
426 $subject = $initial_subject;
428 foreach my $t (@files) {
429 open(F
,"<",$t) or die "can't open file $t";
431 my $author_not_sender = undef;
438 $found_mbox = 1, next if (/^From /);
442 if (/^Subject:\s+(.*)$/) {
445 } elsif (/^(Cc|From):\s+(.*)$/) {
447 next if ($suppress_from);
450 $author_not_sender = $2;
452 printf("(mbox) Adding cc: %s from line '%s'\n",
453 $2, $_) unless $quiet;
459 # "send lots of email" format,
462 # So let's support that, too.
464 printf("(non-mbox) Adding cc: %s from line '%s'\n",
465 $_, $_) unless $quiet;
469 } elsif (!defined $subject) {
474 # A whitespace line will terminate the headers
480 if (/^Signed-off-by: (.*)$/i && !$no_signed_off_cc) {
484 printf("(sob) Adding cc: %s from line '%s'\n",
485 $c, $_) unless $quiet;
490 if (defined $author_not_sender) {
491 $message = "From: $author_not_sender\n\n$message";
494 $cc = join(", ", unique_email_list
(@cc));
498 # set up for the next message
499 if ($chain_reply_to || length($reply_to) == 0) {
500 $reply_to = $message_id;
501 if (length $references > 0) {
502 $references .= " $message_id";
504 $references = "$message_id";
511 cleanup_compose_files
();
514 sub cleanup_compose_files
() {
515 unlink($compose_filename, $compose_filename . ".final");
519 $smtp->quit if $smtp;
521 sub unique_email_list
(@
) {
525 foreach my $entry (@_) {
526 if (my $clean = extract_valid_address
($entry)) {
528 next if $seen{$clean}++;
529 push @emails, $entry;
531 print STDERR
"W: unable to extract a valid address",