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.
27 use File
::Temp qw
/ tempdir tempfile /;
28 use File
::Spec
::Functions
qw(catfile);
32 Getopt
::Long
::Configure qw
/ pass_through /;
36 my ($class, $reason) = @_;
37 return bless \
$reason, shift;
41 die "Cannot use readline on FakeTerm: $$self";
48 git send-email [options] <file | directory | rev-list options >
51 --from <str> * Email From:
52 --[no-]to <str> * Email To:
53 --[no-]cc <str> * Email Cc:
54 --[no-]bcc <str> * Email Bcc:
55 --subject <str> * Email "Subject:"
56 --in-reply-to <str> * Email "In-Reply-To:"
57 --annotate * Review each patch that will be sent in an editor.
58 --compose * Open an editor for introduction.
59 --compose-encoding <str> * Encoding to assume for introduction.
60 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
63 --envelope-sender <str> * Email envelope sender.
64 --smtp-server <str:int> * Outgoing SMTP server to use. The port
65 is optional. Default 'localhost'.
66 --smtp-server-option <str> * Outgoing SMTP server option to use.
67 --smtp-server-port <int> * Outgoing SMTP server port.
68 --smtp-user <str> * Username for SMTP-AUTH.
69 --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
70 --smtp-encryption <str> * tls or ssl; anything else disables.
71 --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
72 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
73 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
76 --identity <str> * Use the sendemail.<id> options.
77 --to-cmd <str> * Email To: via `<str> \$patch_path`
78 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
79 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
80 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
81 --[no-]suppress-from * Send to self. Default off.
82 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
83 --[no-]thread * Use In-Reply-To: field. Default on.
86 --confirm <str> * Confirm recipients before sending;
87 auto, cc, compose, always, or never.
88 --quiet * Output one line of info per email.
89 --dry-run * Don't actually send the emails.
90 --[no-]validate * Perform patch sanity checks. Default on.
91 --[no-]format-patch * understand any non optional arguments as
92 `git format-patch` ones.
93 --force * Send even if safety checks would prevent it.
99 # most mail servers generate the Date: header, but not all...
100 sub format_2822_time
{
102 my @localtm = localtime($time);
103 my @gmttm = gmtime($time);
104 my $localmin = $localtm[1] + $localtm[2] * 60;
105 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
106 if ($localtm[0] != $gmttm[0]) {
107 die "local zone differs from GMT by a non-minute interval\n";
109 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
111 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
113 } elsif ($gmttm[6] != $localtm[6]) {
114 die "local time offset greater than or equal to 24 hours\n";
116 my $offset = $localmin - $gmtmin;
117 my $offhour = $offset / 60;
118 my $offmin = abs($offset % 60);
119 if (abs($offhour) >= 24) {
120 die ("local time offset greater than or equal to 24 hours\n");
123 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
124 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
126 qw(Jan Feb Mar Apr May Jun
127 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
132 ($offset >= 0) ?
'+' : '-',
138 my $have_email_valid = eval { require Email
::Valid
; 1 };
139 my $have_mail_address = eval { require Mail
::Address
; 1 };
143 # Variables we fill in automatically, or via prompting:
144 my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
145 $initial_reply_to,$initial_subject,@files,
146 $author,$sender,$smtp_authpass,$annotate,$compose,$time);
151 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
153 my $repo = eval { Git
->repository() };
154 my @repo = $repo ?
($repo) : ();
156 $ENV{"GIT_SEND_EMAIL_NOTTY"}
157 ? new Term
::ReadLine
'git-send-email', \
*STDIN
, \
*STDOUT
158 : new Term
::ReadLine
'git-send-email';
161 $term = new FakeTerm
"$@: going non-interactive";
164 # Behavior modification variables
165 my ($quiet, $dry_run) = (0, 0);
167 my $compose_filename;
170 # Handle interactive edition of files.
175 if (!defined($editor)) {
176 $editor = Git
::command_oneline
('var', 'GIT_EDITOR');
178 if (defined($multiedit) && !$multiedit) {
180 system('sh', '-c', $editor.' "$@"', $editor, $_);
181 if (($?
& 127) || ($?
>> 8)) {
182 die("the editor exited uncleanly, aborting everything");
186 system('sh', '-c', $editor.' "$@"', $editor, @_);
187 if (($?
& 127) || ($?
>> 8)) {
188 die("the editor exited uncleanly, aborting everything");
193 # Variables with corresponding config settings
194 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
195 my ($to_cmd, $cc_cmd);
196 my ($smtp_server, $smtp_server_port, @smtp_server_options);
197 my ($smtp_authuser, $smtp_encryption);
198 my ($identity, $aliasfiletype, @alias_files, $smtp_domain);
199 my ($validate, $confirm);
201 my ($auto_8bit_encoding);
202 my ($compose_encoding);
204 my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
206 my $not_set_by_user = "true but not set by the user";
208 my %config_bool_settings = (
209 "thread" => [\
$thread, 1],
210 "chainreplyto" => [\
$chain_reply_to, $not_set_by_user],
211 "suppressfrom" => [\
$suppress_from, undef],
212 "signedoffbycc" => [\
$signed_off_by_cc, undef],
213 "signedoffcc" => [\
$signed_off_by_cc, undef], # Deprecated
214 "validate" => [\
$validate, 1],
215 "multiedit" => [\
$multiedit, undef]
218 my %config_settings = (
219 "smtpserver" => \
$smtp_server,
220 "smtpserverport" => \
$smtp_server_port,
221 "smtpserveroption" => \
@smtp_server_options,
222 "smtpuser" => \
$smtp_authuser,
223 "smtppass" => \
$smtp_authpass,
224 "smtpdomain" => \
$smtp_domain,
225 "to" => \
@initial_to,
227 "cc" => \
@initial_cc,
229 "aliasfiletype" => \
$aliasfiletype,
231 "suppresscc" => \
@suppress_cc,
232 "envelopesender" => \
$envelope_sender,
233 "confirm" => \
$confirm,
235 "assume8bitencoding" => \
$auto_8bit_encoding,
236 "composeencoding" => \
$compose_encoding,
239 my %config_path_settings = (
240 "aliasesfile" => \
@alias_files,
243 # Help users prepare for 1.7.0
245 if (defined $chain_reply_to &&
246 $chain_reply_to eq $not_set_by_user) {
248 "In git 1.7.0, the default has changed to --no-chain-reply-to\n" .
249 "Set sendemail.chainreplyto configuration variable to true if\n" .
250 "you want to keep --chain-reply-to as your default.\n";
253 return $chain_reply_to;
256 # Handle Uncouth Termination
260 print color
("reset"), "\n";
262 # SMTP password masked
265 # tmp files from --compose
266 if (defined $compose_filename) {
267 if (-e
$compose_filename) {
268 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
270 if (-e
($compose_filename . ".final")) {
271 print "'$compose_filename.final' contains the composed email.\n"
278 $SIG{TERM
} = \
&signal_handler
;
279 $SIG{INT
} = \
&signal_handler
;
281 # Begin by accumulating all the variables (defined above), that we will end up
282 # needing, first, from the command line:
285 my $rc = GetOptions
("h" => \
$help,
286 "sender|from=s" => \
$sender,
287 "in-reply-to=s" => \
$initial_reply_to,
288 "subject=s" => \
$initial_subject,
289 "to=s" => \
@initial_to,
290 "to-cmd=s" => \
$to_cmd,
292 "cc=s" => \
@initial_cc,
294 "bcc=s" => \
@bcclist,
295 "no-bcc" => \
$no_bcc,
296 "chain-reply-to!" => \
$chain_reply_to,
297 "smtp-server=s" => \
$smtp_server,
298 "smtp-server-option=s" => \
@smtp_server_options,
299 "smtp-server-port=s" => \
$smtp_server_port,
300 "smtp-user=s" => \
$smtp_authuser,
301 "smtp-pass:s" => \
$smtp_authpass,
302 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
303 "smtp-encryption=s" => \
$smtp_encryption,
304 "smtp-debug:i" => \
$debug_net_smtp,
305 "smtp-domain:s" => \
$smtp_domain,
306 "identity=s" => \
$identity,
307 "annotate" => \
$annotate,
308 "compose" => \
$compose,
310 "cc-cmd=s" => \
$cc_cmd,
311 "suppress-from!" => \
$suppress_from,
312 "suppress-cc=s" => \
@suppress_cc,
313 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_by_cc,
314 "confirm=s" => \
$confirm,
315 "dry-run" => \
$dry_run,
316 "envelope-sender=s" => \
$envelope_sender,
317 "thread!" => \
$thread,
318 "validate!" => \
$validate,
319 "format-patch!" => \
$format_patch,
320 "8bit-encoding=s" => \
$auto_8bit_encoding,
321 "compose-encoding=s" => \
$compose_encoding,
330 die "Cannot run git format-patch from outside a repository\n"
331 if $format_patch and not $repo;
333 # Now, let's fill any that aren't set in with defaults:
338 foreach my $setting (keys %config_bool_settings) {
339 my $target = $config_bool_settings{$setting}->[0];
340 $$target = Git
::config_bool
(@repo, "$prefix.$setting") unless (defined $$target);
343 foreach my $setting (keys %config_path_settings) {
344 my $target = $config_path_settings{$setting};
345 if (ref($target) eq "ARRAY") {
347 my @values = Git
::config_path
(@repo, "$prefix.$setting");
348 @
$target = @values if (@values && defined $values[0]);
352 $$target = Git
::config_path
(@repo, "$prefix.$setting") unless (defined $$target);
356 foreach my $setting (keys %config_settings) {
357 my $target = $config_settings{$setting};
358 next if $setting eq "to" and defined $no_to;
359 next if $setting eq "cc" and defined $no_cc;
360 next if $setting eq "bcc" and defined $no_bcc;
361 if (ref($target) eq "ARRAY") {
363 my @values = Git
::config
(@repo, "$prefix.$setting");
364 @
$target = @values if (@values && defined $values[0]);
368 $$target = Git
::config
(@repo, "$prefix.$setting") unless (defined $$target);
372 if (!defined $smtp_encryption) {
373 my $enc = Git
::config
(@repo, "$prefix.smtpencryption");
375 $smtp_encryption = $enc;
376 } elsif (Git
::config_bool
(@repo, "$prefix.smtpssl")) {
377 $smtp_encryption = 'ssl';
382 # read configuration from [sendemail "$identity"], fall back on [sendemail]
383 $identity = Git
::config
(@repo, "sendemail.identity") unless (defined $identity);
384 read_config
("sendemail.$identity") if (defined $identity);
385 read_config
("sendemail");
387 # fall back on builtin bool defaults
388 foreach my $setting (values %config_bool_settings) {
389 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
392 # 'default' encryption is none -- this only prevents a warning
393 $smtp_encryption = '' unless (defined $smtp_encryption);
395 # Set CC suppressions
398 foreach my $entry (@suppress_cc) {
399 die "Unknown --suppress-cc field: '$entry'\n"
400 unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
401 $suppress_cc{$entry} = 1;
405 if ($suppress_cc{'all'}) {
406 foreach my $entry (qw
(cccmd cc author self sob body bodycc
)) {
407 $suppress_cc{$entry} = 1;
409 delete $suppress_cc{'all'};
412 # If explicit old-style ones are specified, they trump --suppress-cc.
413 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
414 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
416 if ($suppress_cc{'body'}) {
417 foreach my $entry (qw
(sob bodycc
)) {
418 $suppress_cc{$entry} = 1;
420 delete $suppress_cc{'body'};
423 # Set confirm's default value
424 my $confirm_unconfigured = !defined $confirm;
425 if ($confirm_unconfigured) {
426 $confirm = scalar %suppress_cc ?
'compose' : 'auto';
428 die "Unknown --confirm setting: '$confirm'\n"
429 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
431 # Debugging, print out the suppressions.
433 print "suppressions:\n";
434 foreach my $entry (keys %suppress_cc) {
435 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
439 my ($repoauthor, $repocommitter);
440 ($repoauthor) = Git
::ident_person
(@repo, 'author');
441 ($repocommitter) = Git
::ident_person
(@repo, 'committer');
443 # Verify the user input
445 foreach my $entry (@initial_to) {
446 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
449 foreach my $entry (@initial_cc) {
450 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
453 foreach my $entry (@bcclist) {
454 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
457 sub parse_address_line
{
458 if ($have_mail_address) {
459 return map { $_->format } Mail
::Address
->parse($_[0]);
461 return split_addrs
($_[0]);
466 return quotewords
('\s*,\s*', 1, @_);
471 # multiline formats can be supported in the future
472 mutt
=> sub { my $fh = shift; while (<$fh>) {
473 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
474 my ($alias, $addr) = ($1, $2);
475 $addr =~ s/#.*$//; # mutt allows # comments
476 # commas delimit multiple addresses
477 $aliases{$alias} = [ split_addrs
($addr) ];
479 mailrc
=> sub { my $fh = shift; while (<$fh>) {
480 if (/^alias\s+(\S+)\s+(.*)$/) {
481 # spaces delimit multiple addresses
482 $aliases{$1} = [ quotewords
('\s+', 0, $2) ];
484 pine
=> sub { my $fh = shift; my $f='\t[^\t]*';
485 for (my $x = ''; defined($x); $x = $_) {
487 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
488 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
489 $aliases{$1} = [ split_addrs
($2) ];
491 elm
=> sub { my $fh = shift;
493 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
494 my ($alias, $addr) = ($1, $2);
495 $aliases{$alias} = [ split_addrs
($addr) ];
499 gnus
=> sub { my $fh = shift; while (<$fh>) {
500 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
501 $aliases{$1} = [ $2 ];
505 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
506 foreach my $file (@alias_files) {
507 open my $fh, '<', $file or die "opening $file: $!\n";
508 $parse_alias{$aliasfiletype}->($fh);
513 ($sender) = expand_aliases
($sender) if defined $sender;
515 # returns 1 if the conflict must be solved using it as a format-patch argument
516 sub check_file_rev_conflict
($) {
520 $repo->command('rev-parse', '--verify', '--quiet', $f);
521 if (defined($format_patch)) {
522 return $format_patch;
525 File '$f' exists but it could also be the range of commits
526 to produce patches for. Please disambiguate by...
528 * Saying "./$f" if you mean a file; or
529 * Giving --format-patch option if you mean a range.
531 } catch Git
::Error
::Command with
{
536 # Now that all the defaults are set, process the rest of the command line
537 # arguments and collect up the files that need to be processed.
539 while (defined(my $f = shift @ARGV)) {
541 push @rev_list_opts, "--", @ARGV;
543 } elsif (-d
$f and !check_file_rev_conflict
($f)) {
545 or die "Failed to opendir $f: $!";
547 push @files, grep { -f
$_ } map { catfile
($f, $_) }
550 } elsif ((-f
$f or -p
$f) and !check_file_rev_conflict
($f)) {
553 push @rev_list_opts, $f;
557 if (@rev_list_opts) {
558 die "Cannot run git format-patch from outside a repository\n"
560 push @files, $repo->command('format-patch', '-o', tempdir
(CLEANUP
=> 1), @rev_list_opts);
564 foreach my $f (@files) {
566 my $error = validate_patch
($f);
567 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
574 print $_,"\n" for (@files);
577 print STDERR
"\nNo patch files specified!\n\n";
581 sub get_patch_subject
{
583 open (my $fh, '<', $fn);
584 while (my $line = <$fh>) {
585 next unless ($line =~ /^Subject: (.*)$/);
590 die "No subject line in $fn ?";
594 # Note that this does not need to be secure, but we will make a small
595 # effort to have it be unique
596 $compose_filename = ($repo ?
597 tempfile
(".gitsendemail.msg.XXXXXX", DIR
=> $repo->repo_path()) :
598 tempfile
(".gitsendemail.msg.XXXXXX", DIR
=> "."))[1];
599 open my $c, ">", $compose_filename
600 or die "Failed to open for writing $compose_filename: $!";
603 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
604 my $tpl_subject = $initial_subject || '';
605 my $tpl_reply_to = $initial_reply_to || '';
608 From $tpl_sender # This line is ignored.
609 GIT: Lines beginning in "GIT:" will be removed.
610 GIT: Consider including an overall diffstat or table of contents
611 GIT: for the patch you are writing.
613 GIT: Clear the body content if you don't wish to send a summary.
615 Subject: $tpl_subject
616 In-Reply-To: $tpl_reply_to
620 print $c get_patch_subject
($f);
625 do_edit
($compose_filename, @files);
627 do_edit
($compose_filename);
630 open my $c2, ">", $compose_filename . ".final"
631 or die "Failed to open $compose_filename.final : " . $!;
633 open $c, "<", $compose_filename
634 or die "Failed to open $compose_filename : " . $!;
636 my $need_8bit_cte = file_has_nonascii
($compose_filename);
638 my $summary_empty = 1;
639 if (!defined $compose_encoding) {
640 $compose_encoding = "UTF-8";
645 $summary_empty = 0 unless (/^\n$/);
648 if ($need_8bit_cte) {
649 print $c2 "MIME-Version: 1.0\n",
650 "Content-Type: text/plain; ",
651 "charset=$compose_encoding\n",
652 "Content-Transfer-Encoding: 8bit\n";
654 } elsif (/^MIME-Version:/i) {
656 } elsif (/^Subject:\s*(.+)\s*$/i) {
657 $initial_subject = $1;
658 my $subject = $initial_subject;
660 quote_subject
($subject, $compose_encoding) .
662 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
663 $initial_reply_to = $1;
665 } elsif (/^From:\s*(.+)\s*$/i) {
668 } elsif (/^(?:To|Cc|Bcc):/i) {
669 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
677 if ($summary_empty) {
678 print "Summary email is empty, skipping it\n";
681 } elsif ($annotate) {
686 my ($prompt, %arg) = @_;
687 my $valid_re = $arg{valid_re
};
688 my $default = $arg{default};
689 my $confirm_only = $arg{confirm_only
};
692 return defined $default ?
$default : undef
693 unless defined $term->IN and defined fileno($term->IN) and
694 defined $term->OUT and defined fileno($term->OUT);
696 $resp = $term->readline($prompt);
697 if (!defined $resp) { # EOF
699 return defined $default ?
$default : undef;
701 if ($resp eq '' and defined $default) {
704 if (!defined $valid_re or $resp =~ /$valid_re/) {
708 my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
709 if (defined $yesno && $yesno =~ /y/i) {
719 sub file_declares_8bit_cte
{
721 open (my $fh, '<', $fn);
722 while (my $line = <$fh>) {
723 last if ($line =~ /^$/);
724 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
730 foreach my $f (@files) {
731 next unless (body_or_subject_has_nonascii
($f)
732 && !file_declares_8bit_cte
($f));
733 $broken_encoding{$f} = 1;
736 if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
737 print "The following files are 8bit, but do not declare " .
738 "a Content-Transfer-Encoding.\n";
739 foreach my $f (sort keys %broken_encoding) {
742 $auto_8bit_encoding = ask
("Which 8bit encoding should I declare [UTF-8]? ",
748 if (get_patch_subject
($f) =~ /\Q*** SUBJECT HERE ***\E/) {
749 die "Refusing to send because the patch\n\t$f\n"
750 . "has the template subject '*** SUBJECT HERE ***'. "
751 . "Pass --force if you really want to send.\n";
757 if (!defined $sender) {
758 $sender = $repoauthor || $repocommitter || '';
759 $sender = ask
("Who should the emails appear to be from? [$sender] ",
761 valid_re
=> qr/\@.*\./, confirm_only
=> 1);
762 print "Emails will be sent from: ", $sender, "\n";
766 if (!@initial_to && !defined $to_cmd) {
767 my $to = ask
("Who should the emails be sent to (if any)? ",
769 valid_re
=> qr/\@.*\./, confirm_only
=> 1);
770 push @initial_to, parse_address_line
($to) if defined $to; # sanitized/validated later
775 return map { expand_one_alias
($_) } @_;
778 my %EXPANDED_ALIASES;
779 sub expand_one_alias
{
781 if ($EXPANDED_ALIASES{$alias}) {
782 die "fatal: alias '$alias' expands to itself\n";
784 local $EXPANDED_ALIASES{$alias} = 1;
785 return $aliases{$alias} ? expand_aliases
(@
{$aliases{$alias}}) : $alias;
788 @initial_to = expand_aliases
(@initial_to);
789 @initial_to = validate_address_list
(sanitize_address_list
(@initial_to));
790 @initial_cc = expand_aliases
(@initial_cc);
791 @initial_cc = validate_address_list
(sanitize_address_list
(@initial_cc));
792 @bcclist = expand_aliases
(@bcclist);
793 @bcclist = validate_address_list
(sanitize_address_list
(@bcclist));
795 if ($thread && !defined $initial_reply_to && $prompting) {
796 $initial_reply_to = ask
(
797 "Message-ID to be used as In-Reply-To for the first email (if any)? ",
799 valid_re
=> qr/\@.*\./, confirm_only
=> 1);
801 if (defined $initial_reply_to) {
802 $initial_reply_to =~ s/^\s*<?//;
803 $initial_reply_to =~ s/>?\s*$//;
804 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
807 if (!defined $smtp_server) {
808 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
814 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
817 if ($compose && $compose > 0) {
818 @files = ($compose_filename . ".final", @files);
821 # Variables we set as part of the loop over files
822 our ($message_id, %mail, $subject, $reply_to, $references, $message,
823 $needs_confirm, $message_num, $ask_default);
825 sub extract_valid_address
{
827 my $local_part_regexp = qr/[^<>"\s@]+/;
828 my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
830 # check for a local address:
831 return $address if ($address =~ /^($local_part_regexp)$/);
833 $address =~ s/^\s*<(.*)>\s*$/$1/;
834 if ($have_email_valid) {
835 return scalar Email
::Valid
->address($address);
838 # less robust/correct than the monster regexp in Email::Valid,
839 # but still does a 99% job, and one less dependency
840 return $1 if $address =~ /($local_part_regexp\@$domain_regexp)/;
844 sub extract_valid_address_or_die
{
846 $address = extract_valid_address
($address);
847 die "error: unable to extract a valid address from: $address\n"
852 sub validate_address
{
854 if (!extract_valid_address
($address)) {
855 print STDERR
"W: unable to extract a valid address from: $address\n";
861 sub validate_address_list
{
862 return (grep { defined $_ }
863 map { validate_address
($_) } @_);
866 # Usually don't need to change anything below here.
868 # we make a "fake" message id by taking the current number
869 # of seconds since the beginning of Unix time and tacking on
870 # a random number to the end, in case we are called quicker than
871 # 1 second since the last time we were called.
873 # We'll setup a template for the message id, using the "from" address:
875 my ($message_id_stamp, $message_id_serial);
876 sub make_message_id
{
878 if (!defined $message_id_stamp) {
879 $message_id_stamp = sprintf("%s-%s", time, $$);
880 $message_id_serial = 0;
882 $message_id_serial++;
883 $uniq = "$message_id_stamp-$message_id_serial";
886 for ($sender, $repocommitter, $repoauthor) {
887 $du_part = extract_valid_address
(sanitize_address
($_));
888 last if (defined $du_part and $du_part ne '');
890 if (not defined $du_part or $du_part eq '') {
891 require Sys
::Hostname
;
892 $du_part = 'user@' . Sys
::Hostname
::hostname
();
894 my $message_id_template = "<%s-git-send-email-%s>";
895 $message_id = sprintf($message_id_template, $uniq, $du_part);
896 #print "new message id = $message_id\n"; # Was useful for debugging
901 $time = time - scalar $#files;
903 sub unquote_rfc2047
{
906 s
{=\?([^?
]+)\?q
\?(.*?
)\?=}{
910 $e =~ s/=([0-9A-F]{2})/chr(hex($1))/eg;
913 return wantarray ?
($_, $encoding) : $_;
918 my $encoding = shift || 'UTF-8';
919 s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
920 s/(.*)/=\?$encoding\?q\?$1\?=/;
924 sub is_rfc2047_quoted
{
926 my $token = qr/[^][()<>@,;:"\/?
.= \000-\037\177-\377]+/;
927 my $encoded_text = qr/[!->@-~]+/;
929 $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
932 sub subject_needs_rfc2047_quoting
{
935 return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
939 local $subject = shift;
940 my $encoding = shift || 'UTF-8';
942 if (subject_needs_rfc2047_quoting
($subject)) {
943 return quote_rfc2047
($subject, $encoding);
948 # use the simplest quoting being able to handle the recipient
949 sub sanitize_address
{
950 my ($recipient) = @_;
952 # remove garbage after email address
953 $recipient =~ s/(.*>).*$/$1/;
955 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
957 if (not $recipient_name) {
961 # if recipient_name is already quoted, do nothing
962 if (is_rfc2047_quoted
($recipient_name)) {
966 # rfc2047 is needed if a non-ascii char is included
967 if ($recipient_name =~ /[^[:ascii:]]/) {
968 $recipient_name =~ s/^"(.*)"$/$1/;
969 $recipient_name = quote_rfc2047
($recipient_name);
972 # double quotes are needed if specials or CTLs are included
973 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
974 $recipient_name =~ s/(["\\\r])/\\$1/g;
975 $recipient_name = qq["$recipient_name"];
978 return "$recipient_name $recipient_addr";
982 sub sanitize_address_list
{
983 return (map { sanitize_address
($_) } @_);
986 # Returns the local Fully Qualified Domain Name (FQDN) if available.
988 # Tightly configured MTAa require that a caller sends a real DNS
989 # domain name that corresponds the IP address in the HELO/EHLO
990 # handshake. This is used to verify the connection and prevent
991 # spammers from trying to hide their identity. If the DNS and IP don't
992 # match, the receiveing MTA may deny the connection.
994 # Here is a deny example of Net::SMTP with the default "localhost.localdomain"
996 # Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
997 # Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
999 # This maildomain*() code is based on ideas in Perl library Test::Reporter
1000 # /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1004 return defined $domain && !($^O
eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
1007 sub maildomain_net
{
1010 if (eval { require Net
::Domain
; 1 }) {
1011 my $domain = Net
::Domain
::domainname
();
1012 $maildomain = $domain if valid_fqdn
($domain);
1018 sub maildomain_mta
{
1021 if (eval { require Net
::SMTP
; 1 }) {
1022 for my $host (qw(mailhost localhost)) {
1023 my $smtp = Net
::SMTP
->new($host);
1024 if (defined $smtp) {
1025 my $domain = $smtp->domain;
1028 $maildomain = $domain if valid_fqdn
($domain);
1030 last if $maildomain;
1039 return maildomain_net
() || maildomain_mta
() || 'localhost.localdomain';
1042 # Returns 1 if the message was sent, and 0 otherwise.
1043 # In actuality, the whole program dies when there
1044 # is an error sending a message.
1047 my @recipients = unique_email_list
(@to);
1048 @cc = (grep { my $cc = extract_valid_address_or_die
($_);
1049 not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
1052 my $to = join (",\n\t", @recipients);
1053 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
1054 @recipients = (map { extract_valid_address_or_die
($_) } @recipients);
1055 my $date = format_2822_time
($time++);
1056 my $gitversion = '@@GIT_VERSION@@';
1057 if ($gitversion =~ m/..GIT_VERSION../) {
1058 $gitversion = Git
::version
();
1061 my $cc = join(",\n\t", unique_email_list
(@cc));
1064 $ccline = "\nCc: $cc";
1066 my $sanitized_sender = sanitize_address
($sender);
1067 make_message_id
() unless defined($message_id);
1069 my $header = "From: $sanitized_sender
1073 Message-Id: $message_id
1074 X-Mailer: git-send-email $gitversion
1078 $header .= "In-Reply-To: $reply_to\n";
1079 $header .= "References: $references\n";
1082 $header .= join("\n", @xh) . "\n";
1085 my @sendmail_parameters = ('-i', @recipients);
1086 my $raw_from = $sanitized_sender;
1087 if (defined $envelope_sender && $envelope_sender ne "auto") {
1088 $raw_from = $envelope_sender;
1090 $raw_from = extract_valid_address
($raw_from);
1091 unshift (@sendmail_parameters,
1092 '-f', $raw_from) if(defined $envelope_sender);
1094 if ($needs_confirm && !$dry_run) {
1095 print "\n$header\n";
1096 if ($needs_confirm eq "inform") {
1097 $confirm_unconfigured = 0; # squelch this message for the rest of this run
1098 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
1099 print " The Cc list above has been expanded by additional\n";
1100 print " addresses found in the patch commit message. By default\n";
1101 print " send-email prompts before sending whenever this occurs.\n";
1102 print " This behavior is controlled by the sendemail.confirm\n";
1103 print " configuration setting.\n";
1105 print " For additional information, run 'git send-email --help'.\n";
1106 print " To retain the current behavior, but squelch this message,\n";
1107 print " run 'git config --global sendemail.confirm auto'.\n\n";
1109 $_ = ask
("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1110 valid_re
=> qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1111 default => $ask_default);
1112 die "Send this email reply required" unless defined $_;
1116 cleanup_compose_files
();
1123 unshift (@sendmail_parameters, @smtp_server_options);
1126 # We don't want to send the email.
1127 } elsif ($smtp_server =~ m
#^/#) {
1128 my $pid = open my $sm, '|-';
1129 defined $pid or die $!;
1131 exec($smtp_server, @sendmail_parameters) or die $!;
1133 print $sm "$header\n$message";
1134 close $sm or die $!;
1137 if (!defined $smtp_server) {
1138 die "The required SMTP server is not properly defined."
1141 if ($smtp_encryption eq 'ssl') {
1142 $smtp_server_port ||= 465; # ssmtp
1143 require Net
::SMTP
::SSL
;
1144 $smtp_domain ||= maildomain
();
1145 $smtp ||= Net
::SMTP
::SSL
->new($smtp_server,
1146 Hello
=> $smtp_domain,
1147 Port
=> $smtp_server_port);
1151 $smtp_domain ||= maildomain
();
1152 $smtp ||= Net
::SMTP
->new((defined $smtp_server_port)
1153 ?
"$smtp_server:$smtp_server_port"
1155 Hello
=> $smtp_domain,
1156 Debug
=> $debug_net_smtp);
1157 if ($smtp_encryption eq 'tls' && $smtp) {
1158 require Net
::SMTP
::SSL
;
1159 $smtp->command('STARTTLS');
1161 if ($smtp->code == 220) {
1162 $smtp = Net
::SMTP
::SSL
->start_SSL($smtp)
1163 or die "STARTTLS failed! ".$smtp->message;
1164 $smtp_encryption = '';
1165 # Send EHLO again to receive fresh
1166 # supported commands
1167 $smtp->hello($smtp_domain);
1169 die "Server does not support STARTTLS! ".$smtp->message;
1175 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1176 "VALUES: server=$smtp_server ",
1177 "encryption=$smtp_encryption ",
1178 "hello=$smtp_domain",
1179 defined $smtp_server_port ?
" port=$smtp_server_port" : "";
1182 if (defined $smtp_authuser) {
1183 # Workaround AUTH PLAIN/LOGIN interaction defect
1184 # with Authen::SASL::Cyrus
1186 require Authen
::SASL
;
1187 Authen
::SASL
->import(qw(Perl));
1190 if (!defined $smtp_authpass) {
1192 system "stty -echo";
1198 } while (!defined $_);
1200 chomp($smtp_authpass = $_);
1205 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
1208 $smtp->mail( $raw_from ) or die $smtp->message;
1209 $smtp->to( @recipients ) or die $smtp->message;
1210 $smtp->data or die $smtp->message;
1211 $smtp->datasend("$header\n$message") or die $smtp->message;
1212 $smtp->dataend() or die $smtp->message;
1213 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1216 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
1218 print (($dry_run ?
"Dry-" : "")."OK. Log says:\n");
1219 if ($smtp_server !~ m
#^/#) {
1220 print "Server: $smtp_server\n";
1221 print "MAIL FROM:<$raw_from>\n";
1222 foreach my $entry (@recipients) {
1223 print "RCPT TO:<$entry>\n";
1226 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1228 print $header, "\n";
1230 print "Result: ", $smtp->code, ' ',
1231 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1233 print "Result: OK\n";
1240 $reply_to = $initial_reply_to;
1241 $references = $initial_reply_to || '';
1242 $subject = $initial_subject;
1245 foreach my $t (@files) {
1246 open my $fh, "<", $t or die "can't open file $t";
1249 my $author_encoding;
1250 my $has_content_type;
1255 my $input_format = undef;
1259 # First unfold multiline header fields
1262 if (/^\s+\S/ and @header) {
1263 chomp($header[$#header]);
1265 $header[$#header] .= $_;
1270 # Now parse the header
1273 $input_format = 'mbox';
1277 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1278 $input_format = 'mbox';
1281 if (defined $input_format && $input_format eq 'mbox') {
1282 if (/^Subject:\s+(.*)$/) {
1285 elsif (/^From:\s+(.*)$/) {
1286 ($author, $author_encoding) = unquote_rfc2047
($1);
1287 next if $suppress_cc{'author'};
1288 next if $suppress_cc{'self'} and $author eq $sender;
1289 printf("(mbox) Adding cc: %s from line '%s'\n",
1290 $1, $_) unless $quiet;
1293 elsif (/^To:\s+(.*)$/) {
1294 foreach my $addr (parse_address_line
($1)) {
1295 printf("(mbox) Adding to: %s from line '%s'\n",
1296 $addr, $_) unless $quiet;
1300 elsif (/^Cc:\s+(.*)$/) {
1301 foreach my $addr (parse_address_line
($1)) {
1302 if (unquote_rfc2047
($addr) eq $sender) {
1303 next if ($suppress_cc{'self'});
1305 next if ($suppress_cc{'cc'});
1307 printf("(mbox) Adding cc: %s from line '%s'\n",
1308 $addr, $_) unless $quiet;
1312 elsif (/^Content-type:/i) {
1313 $has_content_type = 1;
1314 if (/charset="?([^ "]+)/) {
1315 $body_encoding = $1;
1319 elsif (/^Message-Id: (.*)/i) {
1322 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
1327 # In the traditional
1328 # "send lots of email" format,
1331 # So let's support that, too.
1332 $input_format = 'lots';
1333 if (@cc == 0 && !$suppress_cc{'cc'}) {
1334 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1335 $_, $_) unless $quiet;
1337 } elsif (!defined $subject) {
1342 # Now parse the message body
1345 if (/^(Signed-off-by|Cc): (.*)$/i) {
1347 my ($what, $c) = ($1, $2);
1349 if ($c eq $sender) {
1350 next if ($suppress_cc{'self'});
1352 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1353 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1356 printf("(body) Adding cc: %s from line '%s'\n",
1357 $c, $_) unless $quiet;
1362 push @to, recipients_cmd
("to-cmd", "to", $to_cmd, $t)
1364 push @cc, recipients_cmd
("cc-cmd", "cc", $cc_cmd, $t)
1365 if defined $cc_cmd && !$suppress_cc{'cccmd'};
1367 if ($broken_encoding{$t} && !$has_content_type) {
1368 $has_content_type = 1;
1369 push @xh, "MIME-Version: 1.0",
1370 "Content-Type: text/plain; charset=$auto_8bit_encoding",
1371 "Content-Transfer-Encoding: 8bit";
1372 $body_encoding = $auto_8bit_encoding;
1375 if ($broken_encoding{$t} && !is_rfc2047_quoted
($subject)) {
1376 $subject = quote_subject
($subject, $auto_8bit_encoding);
1379 if (defined $author and $author ne $sender) {
1380 $message = "From: $author\n\n$message";
1381 if (defined $author_encoding) {
1382 if ($has_content_type) {
1383 if ($body_encoding eq $author_encoding) {
1384 # ok, we already have the right encoding
1387 # uh oh, we should re-encode
1391 $has_content_type = 1;
1393 'MIME-Version: 1.0',
1394 "Content-Type: text/plain; charset=$author_encoding",
1395 'Content-Transfer-Encoding: 8bit';
1401 $confirm eq "always" or
1402 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1403 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1404 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1406 @to = validate_address_list
(sanitize_address_list
(@to));
1407 @cc = validate_address_list
(sanitize_address_list
(@cc));
1409 @to = (@initial_to, @to);
1410 @cc = (@initial_cc, @cc);
1412 my $message_was_sent = send_message
();
1414 # set up for the next message
1415 if ($thread && $message_was_sent &&
1416 (chain_reply_to
() || !defined $reply_to || length($reply_to) == 0 ||
1417 $message_num == 1)) {
1418 $reply_to = $message_id;
1419 if (length $references > 0) {
1420 $references .= "\n $message_id";
1422 $references = "$message_id";
1425 $message_id = undef;
1428 # Execute a command (e.g. $to_cmd) to get a list of email addresses
1429 # and return a results array
1430 sub recipients_cmd
{
1431 my ($prefix, $what, $cmd, $file) = @_;
1433 my $sanitized_sender = sanitize_address
($sender);
1435 open my $fh, "$cmd \Q$file\E |"
1436 or die "($prefix) Could not execute '$cmd'";
1437 while (my $address = <$fh>) {
1438 $address =~ s/^\s*//g;
1439 $address =~ s/\s*$//g;
1440 $address = sanitize_address
($address);
1441 next if ($address eq $sanitized_sender and $suppress_from);
1442 push @addresses, $address;
1443 printf("($prefix) Adding %s: %s from: '%s'\n",
1444 $what, $address, $cmd) unless $quiet;
1447 or die "($prefix) failed to close pipe to '$cmd'";
1451 cleanup_compose_files
();
1453 sub cleanup_compose_files
{
1454 unlink($compose_filename, $compose_filename . ".final") if $compose;
1457 $smtp->quit if $smtp;
1459 sub unique_email_list
{
1463 foreach my $entry (@_) {
1464 my $clean = extract_valid_address_or_die
($entry);
1465 $seen{$clean} ||= 0;
1466 next if $seen{$clean}++;
1467 push @emails, $entry;
1472 sub validate_patch
{
1474 open(my $fh, '<', $fn)
1475 or die "unable to open $fn: $!\n";
1476 while (my $line = <$fh>) {
1477 if (length($line) > 998) {
1478 return "$.: patch contains a line longer than 998 characters";
1484 sub file_has_nonascii
{
1486 open(my $fh, '<', $fn)
1487 or die "unable to open $fn: $!\n";
1488 while (my $line = <$fh>) {
1489 return 1 if $line =~ /[^[:ascii:]]/;
1494 sub body_or_subject_has_nonascii
{
1496 open(my $fh, '<', $fn)
1497 or die "unable to open $fn: $!\n";
1498 while (my $line = <$fh>) {
1499 last if $line =~ /^$/;
1500 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1502 while (my $line = <$fh>) {
1503 return 1 if $line =~ /[^[:ascii:]]/;