]> git.ipfire.org Git - thirdparty/git.git/blame - git-send-email.perl
git-send-email: delay creation of MIME headers
[thirdparty/git.git] / git-send-email.perl
CommitLineData
3328aced 1#!/usr/bin/perl
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 18
d48b2841 19use 5.008;
83b24437
RA
20use strict;
21use warnings;
22use Term::ReadLine;
83b24437 23use Getopt::Long;
0e73b3ee 24use Text::ParseWords;
83b24437 25use Data::Dumper;
412876dc 26use Term::ANSIColor;
eed6ca7c 27use File::Temp qw/ tempdir tempfile /;
89bf1bac 28use File::Spec::Functions qw(catfile);
5df9fcf6 29use Error qw(:try);
3cb8caf7 30use Git;
83b24437 31
5df9fcf6
PH
32Getopt::Long::Configure qw/ pass_through /;
33
280242d1
JH
34package FakeTerm;
35sub new {
36 my ($class, $reason) = @_;
37 return bless \$reason, shift;
38}
39sub readline {
40 my $self = shift;
41 die "Cannot use readline on FakeTerm: $$self";
42}
43package main;
44
1b0baf14
MC
45
46sub usage {
47 print <<EOT;
5df9fcf6 48git send-email [options] <file | directory | rev-list options >
4ed62b03
MW
49
50 Composing:
51 --from <str> * Email From:
f434c083
SB
52 --[no-]to <str> * Email To:
53 --[no-]cc <str> * Email Cc:
54 --[no-]bcc <str> * Email Bcc:
4ed62b03
MW
55 --subject <str> * Email "Subject:"
56 --in-reply-to <str> * Email "In-Reply-To:"
402596aa 57 --[no-]annotate * Review each patch that will be sent in an editor.
4ed62b03 58 --compose * Open an editor for introduction.
62e00690 59 --compose-encoding <str> * Encoding to assume for introduction.
3cae7e5b 60 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
4ed62b03
MW
61
62 Sending:
63 --envelope-sender <str> * Email envelope sender.
64 --smtp-server <str:int> * Outgoing SMTP server to use. The port
65 is optional. Default 'localhost'.
052fbea2 66 --smtp-server-option <str> * Outgoing SMTP server option to use.
4ed62b03
MW
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'.
35035bbf
RR
72 --smtp-ssl-cert-path <str> * Path to ca-certificates (either directory or file).
73 Pass an empty string to disable certificate
74 verification.
134550fe 75 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
f60812ef 76 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
4ed62b03
MW
77
78 Automating:
79 --identity <str> * Use the sendemail.<id> options.
6e74e075 80 --to-cmd <str> * Email To: via `<str> \$patch_path`
4ed62b03 81 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
3531e270 82 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
f515c904
MT
83 --[no-]cc-cover * Email Cc: addresses in the cover letter.
84 --[no-]to-cover * Email To: addresses in the cover letter.
3531e270 85 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
4ed62b03 86 --[no-]suppress-from * Send to self. Default off.
41fe87fa 87 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
4ed62b03
MW
88 --[no-]thread * Use In-Reply-To: field. Default on.
89
90 Administering:
c1f2aa45
JS
91 --confirm <str> * Confirm recipients before sending;
92 auto, cc, compose, always, or never.
4ed62b03
MW
93 --quiet * Output one line of info per email.
94 --dry-run * Don't actually send the emails.
95 --[no-]validate * Perform patch sanity checks. Default on.
5df9fcf6
PH
96 --[no-]format-patch * understand any non optional arguments as
97 `git format-patch` ones.
a03bc5b6 98 --force * Send even if safety checks would prevent it.
c764a0c2 99
1b0baf14
MC
100EOT
101 exit(1);
102}
103
4bc87a28 104# most mail servers generate the Date: header, but not all...
6bdca890
JN
105sub format_2822_time {
106 my ($time) = @_;
107 my @localtm = localtime($time);
108 my @gmttm = gmtime($time);
109 my $localmin = $localtm[1] + $localtm[2] * 60;
110 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
111 if ($localtm[0] != $gmttm[0]) {
112 die "local zone differs from GMT by a non-minute interval\n";
113 }
114 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
115 $localmin += 1440;
116 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
117 $localmin -= 1440;
118 } elsif ($gmttm[6] != $localtm[6]) {
119 die "local time offset greater than or equal to 24 hours\n";
120 }
121 my $offset = $localmin - $gmtmin;
122 my $offhour = $offset / 60;
123 my $offmin = abs($offset % 60);
124 if (abs($offhour) >= 24) {
125 die ("local time offset greater than or equal to 24 hours\n");
126 }
127
128 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
129 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
130 $localtm[3],
131 qw(Jan Feb Mar Apr May Jun
132 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
133 $localtm[5]+1900,
134 $localtm[2],
135 $localtm[1],
136 $localtm[0],
137 ($offset >= 0) ? '+' : '-',
138 abs($offhour),
139 $offmin,
140 );
141}
4bc87a28 142
567ffeb7 143my $have_email_valid = eval { require Email::Valid; 1 };
5012699d 144my $have_mail_address = eval { require Mail::Address; 1 };
4bc87a28 145my $smtp;
5f5b6118 146my $auth;
4bc87a28 147
83b24437 148# Variables we fill in automatically, or via prompting:
3c3bb51c 149my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
8fd5bb7f
PH
150 $initial_reply_to,$initial_subject,@files,
151 $author,$sender,$smtp_authpass,$annotate,$compose,$time);
83b24437 152
f073a592 153my $envelope_sender;
78488b2c 154
9133261f 155# Example reply to:
83b24437 156#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
83b24437 157
ad79c024
FL
158my $repo = eval { Git->repository() };
159my @repo = $repo ? ($repo) : ();
280242d1 160my $term = eval {
0fb7fc75
JS
161 $ENV{"GIT_SEND_EMAIL_NOTTY"}
162 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
163 : new Term::ReadLine 'git-send-email';
280242d1
JH
164};
165if ($@) {
166 $term = new FakeTerm "$@: going non-interactive";
167}
83b24437 168
5483c71d
AR
169# Behavior modification variables
170my ($quiet, $dry_run) = (0, 0);
5df9fcf6 171my $format_patch;
afe756c9 172my $compose_filename;
a03bc5b6 173my $force = 0;
5483c71d 174
8fd5bb7f
PH
175# Handle interactive edition of files.
176my $multiedit;
0ce142c9 177my $editor;
b4479f07 178
8fd5bb7f 179sub do_edit {
0ce142c9
MG
180 if (!defined($editor)) {
181 $editor = Git::command_oneline('var', 'GIT_EDITOR');
182 }
8fd5bb7f 183 if (defined($multiedit) && !$multiedit) {
beece9da
PH
184 map {
185 system('sh', '-c', $editor.' "$@"', $editor, $_);
186 if (($? & 127) || ($? >> 8)) {
187 die("the editor exited uncleanly, aborting everything");
188 }
189 } @_;
8fd5bb7f
PH
190 } else {
191 system('sh', '-c', $editor.' "$@"', $editor, @_);
beece9da
PH
192 if (($? & 127) || ($? >> 8)) {
193 die("the editor exited uncleanly, aborting everything");
194 }
8fd5bb7f
PH
195 }
196}
5483c71d
AR
197
198# Variables with corresponding config settings
6e74e075 199my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
f515c904 200my ($cover_cc, $cover_to);
6e74e075 201my ($to_cmd, $cc_cmd);
052fbea2 202my ($smtp_server, $smtp_server_port, @smtp_server_options);
35035bbf 203my ($smtp_authuser, $smtp_encryption, $smtp_ssl_cert_path);
1d02a005 204my ($identity, $aliasfiletype, @alias_files, $smtp_domain);
c1f2aa45 205my ($validate, $confirm);
65648283 206my (@suppress_cc);
3cae7e5b 207my ($auto_8bit_encoding);
62e00690 208my ($compose_encoding);
5483c71d 209
f60812ef
JA
210my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
211
34cc60ce 212my %config_bool_settings = (
5483c71d 213 "thread" => [\$thread, 1],
b99d22f2 214 "chainreplyto" => [\$chain_reply_to, 0],
65648283 215 "suppressfrom" => [\$suppress_from, undef],
ddc3d4fe 216 "signedoffbycc" => [\$signed_off_by_cc, undef],
f515c904
MT
217 "cccover" => [\$cover_cc, undef],
218 "tocover" => [\$cover_to, undef],
ddc3d4fe 219 "signedoffcc" => [\$signed_off_by_cc, undef], # Deprecated
dbf5e1e9 220 "validate" => [\$validate, 1],
402596aa
FC
221 "multiedit" => [\$multiedit, undef],
222 "annotate" => [\$annotate, undef]
e46f7a0e
AR
223);
224
34cc60ce
DS
225my %config_settings = (
226 "smtpserver" => \$smtp_server,
44b2476a 227 "smtpserverport" => \$smtp_server_port,
052fbea2 228 "smtpserveroption" => \@smtp_server_options,
34cc60ce
DS
229 "smtpuser" => \$smtp_authuser,
230 "smtppass" => \$smtp_authpass,
35035bbf 231 "smtpsslcertpath" => \$smtp_ssl_cert_path,
e1e9115d 232 "smtpdomain" => \$smtp_domain,
3c3bb51c 233 "to" => \@initial_to,
6e74e075 234 "tocmd" => \$to_cmd,
5f8b9fcd 235 "cc" => \@initial_cc,
34cc60ce
DS
236 "cccmd" => \$cc_cmd,
237 "aliasfiletype" => \$aliasfiletype,
238 "bcc" => \@bcclist,
65648283 239 "suppresscc" => \@suppress_cc,
9f7820ae 240 "envelopesender" => \$envelope_sender,
c1f2aa45 241 "confirm" => \$confirm,
09caa24f 242 "from" => \$sender,
3cae7e5b 243 "assume8bitencoding" => \$auto_8bit_encoding,
62e00690 244 "composeencoding" => \$compose_encoding,
34cc60ce 245);
4a62d3f5 246
cec5dae8
CS
247my %config_path_settings = (
248 "aliasesfile" => \@alias_files,
249);
250
87429976
MW
251# Handle Uncouth Termination
252sub signal_handler {
253
254 # Make text normal
255 print color("reset"), "\n";
256
257 # SMTP password masked
258 system "stty echo";
259
260 # tmp files from --compose
afe756c9
JS
261 if (defined $compose_filename) {
262 if (-e $compose_filename) {
263 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
264 }
265 if (-e ($compose_filename . ".final")) {
266 print "'$compose_filename.final' contains the composed email.\n"
267 }
87429976
MW
268 }
269
270 exit;
271};
272
273$SIG{TERM} = \&signal_handler;
274$SIG{INT} = \&signal_handler;
275
83b24437
RA
276# Begin by accumulating all the variables (defined above), that we will end up
277# needing, first, from the command line:
278
c5978246
CB
279my $help;
280my $rc = GetOptions("h" => \$help,
281 "sender|from=s" => \$sender,
83b24437
RA
282 "in-reply-to=s" => \$initial_reply_to,
283 "subject=s" => \$initial_subject,
3c3bb51c 284 "to=s" => \@initial_to,
6e74e075 285 "to-cmd=s" => \$to_cmd,
f434c083 286 "no-to" => \$no_to,
da140f8b 287 "cc=s" => \@initial_cc,
f434c083 288 "no-cc" => \$no_cc,
58063245 289 "bcc=s" => \@bcclist,
f434c083 290 "no-bcc" => \$no_bcc,
78488b2c 291 "chain-reply-to!" => \$chain_reply_to,
3342d850 292 "smtp-server=s" => \$smtp_server,
052fbea2 293 "smtp-server-option=s" => \@smtp_server_options,
44b2476a 294 "smtp-server-port=s" => \$smtp_server_port,
34cc60ce 295 "smtp-user=s" => \$smtp_authuser,
2363d746 296 "smtp-pass:s" => \$smtp_authpass,
f6bebd12
TR
297 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
298 "smtp-encryption=s" => \$smtp_encryption,
979e652a 299 "smtp-ssl-cert-path=s" => \$smtp_ssl_cert_path,
f60812ef 300 "smtp-debug:i" => \$debug_net_smtp,
69cf7bfd 301 "smtp-domain:s" => \$smtp_domain,
34cc60ce 302 "identity=s" => \$identity,
402596aa 303 "annotate!" => \$annotate,
1f038a0c 304 "compose" => \$compose,
30d08b34 305 "quiet" => \$quiet,
324a8bd0 306 "cc-cmd=s" => \$cc_cmd,
5483c71d 307 "suppress-from!" => \$suppress_from,
65648283 308 "suppress-cc=s" => \@suppress_cc,
ddc3d4fe 309 "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
f515c904
MT
310 "cc-cover|cc-cover!" => \$cover_cc,
311 "to-cover|to-cover!" => \$cover_to,
c1f2aa45 312 "confirm=s" => \$confirm,
6130259c 313 "dry-run" => \$dry_run,
f073a592 314 "envelope-sender=s" => \$envelope_sender,
5483c71d 315 "thread!" => \$thread,
dbf5e1e9 316 "validate!" => \$validate,
5df9fcf6 317 "format-patch!" => \$format_patch,
3cae7e5b 318 "8bit-encoding=s" => \$auto_8bit_encoding,
62e00690 319 "compose-encoding=s" => \$compose_encoding,
a03bc5b6 320 "force" => \$force,
83b24437
RA
321 );
322
c5978246 323usage() if $help;
1b0baf14
MC
324unless ($rc) {
325 usage();
326}
327
eed6ca7c
JS
328die "Cannot run git format-patch from outside a repository\n"
329 if $format_patch and not $repo;
330
34cc60ce
DS
331# Now, let's fill any that aren't set in with defaults:
332
333sub read_config {
334 my ($prefix) = @_;
335
336 foreach my $setting (keys %config_bool_settings) {
337 my $target = $config_bool_settings{$setting}->[0];
ad79c024 338 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
34cc60ce
DS
339 }
340
cec5dae8 341 foreach my $setting (keys %config_path_settings) {
463b0ea2
CS
342 my $target = $config_path_settings{$setting};
343 if (ref($target) eq "ARRAY") {
344 unless (@$target) {
345 my @values = Git::config_path(@repo, "$prefix.$setting");
346 @$target = @values if (@values && defined $values[0]);
347 }
348 }
349 else {
350 $$target = Git::config_path(@repo, "$prefix.$setting") unless (defined $$target);
351 }
cec5dae8
CS
352 }
353
34cc60ce
DS
354 foreach my $setting (keys %config_settings) {
355 my $target = $config_settings{$setting};
f434c083
SB
356 next if $setting eq "to" and defined $no_to;
357 next if $setting eq "cc" and defined $no_cc;
358 next if $setting eq "bcc" and defined $no_bcc;
34cc60ce
DS
359 if (ref($target) eq "ARRAY") {
360 unless (@$target) {
ad79c024 361 my @values = Git::config(@repo, "$prefix.$setting");
34cc60ce
DS
362 @$target = @values if (@values && defined $values[0]);
363 }
364 }
365 else {
ad79c024 366 $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
34cc60ce
DS
367 }
368 }
f6bebd12
TR
369
370 if (!defined $smtp_encryption) {
371 my $enc = Git::config(@repo, "$prefix.smtpencryption");
372 if (defined $enc) {
373 $smtp_encryption = $enc;
374 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
375 $smtp_encryption = 'ssl';
376 }
377 }
34cc60ce
DS
378}
379
380# read configuration from [sendemail "$identity"], fall back on [sendemail]
ad79c024 381$identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
34cc60ce
DS
382read_config("sendemail.$identity") if (defined $identity);
383read_config("sendemail");
384
385# fall back on builtin bool defaults
386foreach my $setting (values %config_bool_settings) {
387 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
388}
389
fa835cd5
TR
390# 'default' encryption is none -- this only prevents a warning
391$smtp_encryption = '' unless (defined $smtp_encryption);
392
65648283
DB
393# Set CC suppressions
394my(%suppress_cc);
395if (@suppress_cc) {
396 foreach my $entry (@suppress_cc) {
397 die "Unknown --suppress-cc field: '$entry'\n"
e9bf741b 398 unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
65648283
DB
399 $suppress_cc{$entry} = 1;
400 }
401}
402
403if ($suppress_cc{'all'}) {
cb8a9bd5 404 foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
65648283
DB
405 $suppress_cc{$entry} = 1;
406 }
407 delete $suppress_cc{'all'};
408}
409
410# If explicit old-style ones are specified, they trump --suppress-cc.
411$suppress_cc{'self'} = $suppress_from if defined $suppress_from;
ddc3d4fe 412$suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
65648283 413
3531e270
JS
414if ($suppress_cc{'body'}) {
415 foreach my $entry (qw (sob bodycc)) {
416 $suppress_cc{$entry} = 1;
417 }
418 delete $suppress_cc{'body'};
419}
420
c1f2aa45
JS
421# Set confirm's default value
422my $confirm_unconfigured = !defined $confirm;
423if ($confirm_unconfigured) {
424 $confirm = scalar %suppress_cc ? 'compose' : 'auto';
425};
426die "Unknown --confirm setting: '$confirm'\n"
427 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
428
65648283
DB
429# Debugging, print out the suppressions.
430if (0) {
431 print "suppressions:\n";
432 foreach my $entry (keys %suppress_cc) {
433 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
434 }
435}
436
ad79c024
FL
437my ($repoauthor, $repocommitter);
438($repoauthor) = Git::ident_person(@repo, 'author');
439($repocommitter) = Git::ident_person(@repo, 'committer');
34cc60ce 440
79ee555b
EB
441# Verify the user input
442
3c3bb51c 443foreach my $entry (@initial_to) {
79ee555b
EB
444 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
445}
446
447foreach my $entry (@initial_cc) {
448 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
449}
450
451foreach my $entry (@bcclist) {
452 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
453}
454
5012699d
JS
455sub parse_address_line {
456 if ($have_mail_address) {
457 return map { $_->format } Mail::Address->parse($_[0]);
458 } else {
459 return split_addrs($_[0]);
460 }
461}
462
0e73b3ee 463sub split_addrs {
2f0e7cbb 464 return quotewords('\s*,\s*', 1, @_);
0e73b3ee
WF
465}
466
994d6c66 467my %aliases;
994d6c66
EW
468my %parse_alias = (
469 # multiline formats can be supported in the future
470 mutt => sub { my $fh = shift; while (<$fh>) {
ffc01f9b 471 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
994d6c66
EW
472 my ($alias, $addr) = ($1, $2);
473 $addr =~ s/#.*$//; # mutt allows # comments
474 # commas delimit multiple addresses
0e73b3ee 475 $aliases{$alias} = [ split_addrs($addr) ];
994d6c66
EW
476 }}},
477 mailrc => sub { my $fh = shift; while (<$fh>) {
478 if (/^alias\s+(\S+)\s+(.*)$/) {
479 # spaces delimit multiple addresses
fe87c921 480 $aliases{$1} = [ quotewords('\s+', 0, $2) ];
994d6c66 481 }}},
73c427eb
TP
482 pine => sub { my $fh = shift; my $f='\t[^\t]*';
483 for (my $x = ''; defined($x); $x = $_) {
484 chomp $x;
485 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
486 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
0e73b3ee 487 $aliases{$1} = [ split_addrs($2) ];
73c427eb 488 }},
7613ea35
BP
489 elm => sub { my $fh = shift;
490 while (<$fh>) {
491 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
492 my ($alias, $addr) = ($1, $2);
493 $aliases{$alias} = [ split_addrs($addr) ];
494 }
495 } },
496
994d6c66
EW
497 gnus => sub { my $fh = shift; while (<$fh>) {
498 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
499 $aliases{$1} = [ $2 ];
500 }}}
501);
502
3cb8caf7 503if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
994d6c66
EW
504 foreach my $file (@alias_files) {
505 open my $fh, '<', $file or die "opening $file: $!\n";
506 $parse_alias{$aliasfiletype}->($fh);
507 close $fh;
508 }
509}
510
94638f89 511($sender) = expand_aliases($sender) if defined $sender;
ae740a58 512
9b397039
RR
513# is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
514# $f is a revision list specification to be passed to format-patch.
515sub is_format_patch_arg {
eed6ca7c 516 return unless $repo;
5df9fcf6
PH
517 my $f = shift;
518 try {
519 $repo->command('rev-parse', '--verify', '--quiet', $f);
520 if (defined($format_patch)) {
5df9fcf6
PH
521 return $format_patch;
522 }
523 die(<<EOF);
524File '$f' exists but it could also be the range of commits
525to produce patches for. Please disambiguate by...
526
527 * Saying "./$f" if you mean a file; or
528 * Giving --format-patch option if you mean a range.
529EOF
530 } catch Git::Error::Command with {
9b397039 531 # Not a valid revision. Treat it as a filename.
5df9fcf6
PH
532 return 0;
533 }
534}
535
aa54892f
JK
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.
5df9fcf6 538my @rev_list_opts;
69f4ce55 539while (defined(my $f = shift @ARGV)) {
5df9fcf6
PH
540 if ($f eq "--") {
541 push @rev_list_opts, "--", @ARGV;
542 @ARGV = ();
9b397039 543 } elsif (-d $f and !is_format_patch_arg($f)) {
c6038169 544 opendir my $dh, $f
aa54892f
JK
545 or die "Failed to opendir $f: $!";
546
89bf1bac 547 push @files, grep { -f $_ } map { catfile($f, $_) }
c6038169
ÆAB
548 sort readdir $dh;
549 closedir $dh;
9b397039 550 } elsif ((-f $f or -p $f) and !is_format_patch_arg($f)) {
aa54892f 551 push @files, $f;
aa54892f 552 } else {
5df9fcf6 553 push @rev_list_opts, $f;
aa54892f
JK
554 }
555}
556
5df9fcf6 557if (@rev_list_opts) {
eed6ca7c
JS
558 die "Cannot run git format-patch from outside a repository\n"
559 unless $repo;
5df9fcf6
PH
560 push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
561}
562
dbf5e1e9 563if ($validate) {
c764a0c2 564 foreach my $f (@files) {
300913bd
KB
565 unless (-p $f) {
566 my $error = validate_patch($f);
567 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
568 }
c764a0c2 569 }
747bbff9
JK
570}
571
aa54892f
JK
572if (@files) {
573 unless ($quiet) {
574 print $_,"\n" for (@files);
575 }
576} else {
577 print STDERR "\nNo patch files specified!\n\n";
578 usage();
579}
580
acf071b0 581sub get_patch_subject {
beece9da
PH
582 my $fn = shift;
583 open (my $fh, '<', $fn);
584 while (my $line = <$fh>) {
585 next unless ($line =~ /^Subject: (.*)$/);
586 close $fh;
587 return "GIT: $1\n";
588 }
589 close $fh;
590 die "No subject line in $fn ?";
591}
592
593if ($compose) {
594 # Note that this does not need to be secure, but we will make a small
595 # effort to have it be unique
afe756c9
JS
596 $compose_filename = ($repo ?
597 tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
598 tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
fe0f944f 599 open my $c, ">", $compose_filename
beece9da
PH
600 or die "Failed to open for writing $compose_filename: $!";
601
602
603 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
604 my $tpl_subject = $initial_subject || '';
605 my $tpl_reply_to = $initial_reply_to || '';
606
fe0f944f 607 print $c <<EOT;
beece9da 608From $tpl_sender # This line is ignored.
40e6e8a0 609GIT: Lines beginning in "GIT:" will be removed.
beece9da
PH
610GIT: Consider including an overall diffstat or table of contents
611GIT: for the patch you are writing.
612GIT:
613GIT: Clear the body content if you don't wish to send a summary.
614From: $tpl_sender
615Subject: $tpl_subject
616In-Reply-To: $tpl_reply_to
617
618EOT
619 for my $f (@files) {
fe0f944f 620 print $c get_patch_subject($f);
beece9da 621 }
fe0f944f 622 close $c;
beece9da 623
beece9da
PH
624 if ($annotate) {
625 do_edit($compose_filename, @files);
626 } else {
627 do_edit($compose_filename);
628 }
629
fe0f944f 630 open my $c2, ">", $compose_filename . ".final"
beece9da
PH
631 or die "Failed to open $compose_filename.final : " . $!;
632
fe0f944f 633 open $c, "<", $compose_filename
beece9da
PH
634 or die "Failed to open $compose_filename : " . $!;
635
636 my $need_8bit_cte = file_has_nonascii($compose_filename);
637 my $in_body = 0;
638 my $summary_empty = 1;
4a47a4dd
KM
639 if (!defined $compose_encoding) {
640 $compose_encoding = "UTF-8";
641 }
fe0f944f 642 while(<$c>) {
40e6e8a0 643 next if m/^GIT:/;
beece9da
PH
644 if ($in_body) {
645 $summary_empty = 0 unless (/^\n$/);
646 } elsif (/^\n$/) {
647 $in_body = 1;
648 if ($need_8bit_cte) {
fe0f944f 649 print $c2 "MIME-Version: 1.0\n",
beece9da 650 "Content-Type: text/plain; ",
62e00690 651 "charset=$compose_encoding\n",
beece9da
PH
652 "Content-Transfer-Encoding: 8bit\n";
653 }
654 } elsif (/^MIME-Version:/i) {
655 $need_8bit_cte = 0;
656 } elsif (/^Subject:\s*(.+)\s*$/i) {
657 $initial_subject = $1;
658 my $subject = $initial_subject;
659 $_ = "Subject: " .
ce547800 660 quote_subject($subject, $compose_encoding) .
beece9da
PH
661 "\n";
662 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
663 $initial_reply_to = $1;
664 next;
665 } elsif (/^From:\s*(.+)\s*$/i) {
666 $sender = $1;
667 next;
668 } elsif (/^(?:To|Cc|Bcc):/i) {
669 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
670 next;
671 }
fe0f944f 672 print $c2 $_;
beece9da 673 }
fe0f944f
ÆAB
674 close $c;
675 close $c2;
beece9da
PH
676
677 if ($summary_empty) {
678 print "Summary email is empty, skipping it\n";
679 $compose = -1;
680 }
681} elsif ($annotate) {
682 do_edit(@files);
683}
684
6e182518
JS
685sub ask {
686 my ($prompt, %arg) = @_;
0da43a68 687 my $valid_re = $arg{valid_re};
6e182518 688 my $default = $arg{default};
51bbccfd 689 my $confirm_only = $arg{confirm_only};
6e182518
JS
690 my $resp;
691 my $i = 0;
5906f54e
JS
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);
6e182518
JS
695 while ($i++ < 10) {
696 $resp = $term->readline($prompt);
697 if (!defined $resp) { # EOF
698 print "\n";
699 return defined $default ? $default : undef;
700 }
701 if ($resp eq '' and defined $default) {
702 return $default;
703 }
0da43a68 704 if (!defined $valid_re or $resp =~ /$valid_re/) {
6e182518
JS
705 return $resp;
706 }
51bbccfd
JH
707 if ($confirm_only) {
708 my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
709 if (defined $yesno && $yesno =~ /y/i) {
710 return $resp;
711 }
712 }
6e182518 713 }
622bc930 714 return;
6e182518
JS
715}
716
3cae7e5b
TR
717my %broken_encoding;
718
1d50bfd9 719sub file_declares_8bit_cte {
3cae7e5b
TR
720 my $fn = shift;
721 open (my $fh, '<', $fn);
722 while (my $line = <$fh>) {
723 last if ($line =~ /^$/);
724 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
725 }
726 close $fh;
727 return 0;
728}
729
730foreach my $f (@files) {
731 next unless (body_or_subject_has_nonascii($f)
732 && !file_declares_8bit_cte($f));
733 $broken_encoding{$f} = 1;
734}
735
736if (!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) {
740 print " $f\n";
741 }
742 $auto_8bit_encoding = ask("Which 8bit encoding should I declare [UTF-8]? ",
743 default => "UTF-8");
744}
745
a03bc5b6
TR
746if (!$force) {
747 for my $f (@files) {
0d290a46 748 if (get_patch_subject($f) =~ /\Q*** SUBJECT HERE ***\E/) {
a03bc5b6
TR
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";
752 }
753 }
754}
755
94638f89 756if (!defined $sender) {
ad79c024 757 $sender = $repoauthor || $repocommitter || '';
83b24437
RA
758}
759
da18759e
MT
760# $sender could be an already sanitized address
761# (e.g. sendemail.from could be manually sanitized by user).
762# But it's a no-op to run sanitize_address on an already sanitized address.
763$sender = sanitize_address($sender);
764
8cac13dc 765my $prompting = 0;
8796ff7f 766if (!@initial_to && !defined $to_cmd) {
61837493
SB
767 my $to = ask("Who should the emails be sent to (if any)? ",
768 default => "",
51bbccfd 769 valid_re => qr/\@.*\./, confirm_only => 1);
3c3bb51c 770 push @initial_to, parse_address_line($to) if defined $to; # sanitized/validated later
1f038a0c 771 $prompting++;
83b24437
RA
772}
773
994d6c66 774sub expand_aliases {
302e04ea
JK
775 return map { expand_one_alias($_) } @_;
776}
777
778my %EXPANDED_ALIASES;
779sub expand_one_alias {
780 my $alias = shift;
781 if ($EXPANDED_ALIASES{$alias}) {
782 die "fatal: alias '$alias' expands to itself\n";
783 }
784 local $EXPANDED_ALIASES{$alias} = 1;
785 return $aliases{$alias} ? expand_aliases(@{$aliases{$alias}}) : $alias;
994d6c66
EW
786}
787
3c3bb51c 788@initial_to = expand_aliases(@initial_to);
e4312255 789@initial_to = validate_address_list(sanitize_address_list(@initial_to));
994d6c66 790@initial_cc = expand_aliases(@initial_cc);
e4312255 791@initial_cc = validate_address_list(sanitize_address_list(@initial_cc));
58063245 792@bcclist = expand_aliases(@bcclist);
e4312255 793@bcclist = validate_address_list(sanitize_address_list(@bcclist));
994d6c66 794
5483c71d 795if ($thread && !defined $initial_reply_to && $prompting) {
6e182518 796 $initial_reply_to = ask(
61837493
SB
797 "Message-ID to be used as In-Reply-To for the first email (if any)? ",
798 default => "",
51bbccfd 799 valid_re => qr/\@.*\./, confirm_only => 1);
83b24437 800}
1ca3d6ed 801if (defined $initial_reply_to) {
0fb7fc75
JS
802 $initial_reply_to =~ s/^\s*<?//;
803 $initial_reply_to =~ s/>?\s*$//;
804 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
ace9c2a9 805}
ace72086 806
34cc60ce 807if (!defined $smtp_server) {
aca7ad76
EW
808 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
809 if (-x $_) {
810 $smtp_server = $_;
811 last;
812 }
813 }
814 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
3342d850
RA
815}
816
c1f2aa45
JS
817if ($compose && $compose > 0) {
818 @files = ($compose_filename . ".final", @files);
1f038a0c
RA
819}
820
83b24437 821# Variables we set as part of the loop over files
c1f2aa45 822our ($message_id, %mail, $subject, $reply_to, $references, $message,
dc1460aa 823 $needs_confirm, $message_num, $ask_default);
83b24437 824
567ffeb7
EW
825sub extract_valid_address {
826 my $address = shift;
35b6ab95
ÆAB
827 my $local_part_regexp = qr/[^<>"\s@]+/;
828 my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
db3106b2
EW
829
830 # check for a local address:
ad9c18f5 831 return $address if ($address =~ /^($local_part_regexp)$/);
db3106b2 832
155197e6 833 $address =~ s/^\s*<(.*)>\s*$/$1/;
567ffeb7 834 if ($have_email_valid) {
ad9c18f5 835 return scalar Email::Valid->address($address);
567ffeb7 836 }
95c0d4b6
KM
837
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)/;
622bc930 841 return;
567ffeb7 842}
83b24437 843
e4312255
KM
844sub extract_valid_address_or_die {
845 my $address = shift;
846 $address = extract_valid_address($address);
847 die "error: unable to extract a valid address from: $address\n"
848 if !$address;
849 return $address;
850}
851
852sub validate_address {
853 my $address = shift;
d0e98107 854 while (!extract_valid_address($address)) {
5c80afed 855 print STDERR "error: unable to extract a valid address from: $address\n";
d0e98107
KM
856 $_ = ask("What to do with this address? ([q]uit|[d]rop|[e]dit): ",
857 valid_re => qr/^(?:quit|q|drop|d|edit|e)/i,
5c80afed
KM
858 default => 'q');
859 if (/^d/i) {
860 return undef;
861 } elsif (/^q/i) {
862 cleanup_compose_files();
863 exit(0);
864 }
d0e98107
KM
865 $address = ask("Who should the email be sent to (if any)? ",
866 default => "",
867 valid_re => qr/\@.*\./, confirm_only => 1);
e4312255
KM
868 }
869 return $address;
870}
871
872sub validate_address_list {
873 return (grep { defined $_ }
874 map { validate_address($_) } @_);
567ffeb7 875}
83b24437
RA
876
877# Usually don't need to change anything below here.
878
879# we make a "fake" message id by taking the current number
880# of seconds since the beginning of Unix time and tacking on
881# a random number to the end, in case we are called quicker than
882# 1 second since the last time we were called.
8037d1a3
RA
883
884# We'll setup a template for the message id, using the "from" address:
8037d1a3 885
be510cfe 886my ($message_id_stamp, $message_id_serial);
68ce9330 887sub make_message_id {
be510cfe
JH
888 my $uniq;
889 if (!defined $message_id_stamp) {
890 $message_id_stamp = sprintf("%s-%s", time, $$);
891 $message_id_serial = 0;
892 }
893 $message_id_serial++;
894 $uniq = "$message_id_stamp-$message_id_serial";
895
aeb59328 896 my $du_part;
94638f89
UKK
897 for ($sender, $repocommitter, $repoauthor) {
898 $du_part = extract_valid_address(sanitize_address($_));
899 last if (defined $du_part and $du_part ne '');
aeb59328 900 }
94638f89 901 if (not defined $du_part or $du_part eq '') {
529dd386 902 require Sys::Hostname;
aeb59328
JH
903 $du_part = 'user@' . Sys::Hostname::hostname();
904 }
be510cfe
JH
905 my $message_id_template = "<%s-git-send-email-%s>";
906 $message_id = sprintf($message_id_template, $uniq, $du_part);
8037d1a3 907 #print "new message id = $message_id\n"; # Was useful for debugging
83b24437
RA
908}
909
910
911
a5370b16 912$time = time - scalar $#files;
83b24437 913
374c5905
JR
914sub unquote_rfc2047 {
915 local ($_) = @_;
8291db6f 916 my $encoding;
b622d4d1 917 s{=\?([^?]+)\?q\?(.*?)\?=}{
8291db6f 918 $encoding = $1;
b622d4d1
TR
919 my $e = $2;
920 $e =~ s/_/ /g;
921 $e =~ s/=([0-9A-F]{2})/chr(hex($1))/eg;
922 $e;
923 }eg;
8291db6f 924 return wantarray ? ($_, $encoding) : $_;
374c5905
JR
925}
926
d54eaaa2
JK
927sub quote_rfc2047 {
928 local $_ = shift;
d1fff6fc 929 my $encoding = shift || 'UTF-8';
d54eaaa2
JK
930 s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
931 s/(.*)/=\?$encoding\?q\?$1\?=/;
932 return $_;
933}
934
a3a8262b
BC
935sub is_rfc2047_quoted {
936 my $s = shift;
49f73852
ÆAB
937 my $token = qr/[^][()<>@,;:"\/?.= \000-\037\177-\377]+/;
938 my $encoded_text = qr/[!->@-~]+/;
a3a8262b
BC
939 length($s) <= 75 &&
940 $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
941}
942
ce547800
KM
943sub subject_needs_rfc2047_quoting {
944 my $s = shift;
945
ce1459f7 946 return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
ce547800
KM
947}
948
949sub quote_subject {
950 local $subject = shift;
951 my $encoding = shift || 'UTF-8';
952
953 if (subject_needs_rfc2047_quoting($subject)) {
954 return quote_rfc2047($subject, $encoding);
955 }
956 return $subject;
957}
958
5b56aaa2 959# use the simplest quoting being able to handle the recipient
68ce9330 960sub sanitize_address {
732263d4 961 my ($recipient) = @_;
831a488b
KM
962
963 # remove garbage after email address
964 $recipient =~ s/(.*>).*$/$1/;
965
5b56aaa2
UKK
966 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
967
968 if (not $recipient_name) {
ff483897 969 return $recipient;
5b56aaa2
UKK
970 }
971
972 # if recipient_name is already quoted, do nothing
a3a8262b 973 if (is_rfc2047_quoted($recipient_name)) {
5b56aaa2
UKK
974 return $recipient;
975 }
976
977 # rfc2047 is needed if a non-ascii char is included
978 if ($recipient_name =~ /[^[:ascii:]]/) {
a61c0ffa 979 $recipient_name =~ s/^"(.*)"$/$1/;
d54eaaa2 980 $recipient_name = quote_rfc2047($recipient_name);
732263d4 981 }
5b56aaa2
UKK
982
983 # double quotes are needed if specials or CTLs are included
984 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
18023c20 985 $recipient_name =~ s/(["\\\r])/\\$1/g;
d5c7d69d 986 $recipient_name = qq["$recipient_name"];
5b56aaa2
UKK
987 }
988
989 return "$recipient_name $recipient_addr";
990
732263d4
RJ
991}
992
e4312255
KM
993sub sanitize_address_list {
994 return (map { sanitize_address($_) } @_);
995}
996
134550fe
JA
997# Returns the local Fully Qualified Domain Name (FQDN) if available.
998#
999# Tightly configured MTAa require that a caller sends a real DNS
1000# domain name that corresponds the IP address in the HELO/EHLO
1001# handshake. This is used to verify the connection and prevent
1002# spammers from trying to hide their identity. If the DNS and IP don't
1003# match, the receiveing MTA may deny the connection.
1004#
1005# Here is a deny example of Net::SMTP with the default "localhost.localdomain"
1006#
1007# Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
1008# Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
1009#
1010# This maildomain*() code is based on ideas in Perl library Test::Reporter
1011# /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1012
59a86303
BG
1013sub valid_fqdn {
1014 my $domain = shift;
61ef5e9b 1015 return defined $domain && !($^O eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
59a86303
BG
1016}
1017
68ce9330 1018sub maildomain_net {
134550fe
JA
1019 my $maildomain;
1020
1021 if (eval { require Net::Domain; 1 }) {
1022 my $domain = Net::Domain::domainname();
59a86303 1023 $maildomain = $domain if valid_fqdn($domain);
134550fe
JA
1024 }
1025
1026 return $maildomain;
1027}
1028
68ce9330 1029sub maildomain_mta {
134550fe
JA
1030 my $maildomain;
1031
1032 if (eval { require Net::SMTP; 1 }) {
1033 for my $host (qw(mailhost localhost)) {
1034 my $smtp = Net::SMTP->new($host);
1035 if (defined $smtp) {
1036 my $domain = $smtp->domain;
1037 $smtp->quit;
1038
59a86303 1039 $maildomain = $domain if valid_fqdn($domain);
134550fe
JA
1040
1041 last if $maildomain;
1042 }
1043 }
1044 }
1045
1046 return $maildomain;
1047}
1048
68ce9330 1049sub maildomain {
69cf7bfd 1050 return maildomain_net() || maildomain_mta() || 'localhost.localdomain';
134550fe
JA
1051}
1052
4d31a44a
MN
1053sub smtp_host_string {
1054 if (defined $smtp_server_port) {
1055 return "$smtp_server:$smtp_server_port";
1056 } else {
1057 return $smtp_server;
1058 }
1059}
1060
1061# Returns 1 if authentication succeeded or was not necessary
1062# (smtp_user was not specified), and 0 otherwise.
1063
1064sub smtp_auth_maybe {
1065 if (!defined $smtp_authuser || $auth) {
1066 return 1;
1067 }
1068
1069 # Workaround AUTH PLAIN/LOGIN interaction defect
1070 # with Authen::SASL::Cyrus
1071 eval {
1072 require Authen::SASL;
1073 Authen::SASL->import(qw(Perl));
1074 };
1075
1076 # TODO: Authentication may fail not because credentials were
1077 # invalid but due to other reasons, in which we should not
1078 # reject credentials.
1079 $auth = Git::credential({
1080 'protocol' => 'smtp',
1081 'host' => smtp_host_string(),
1082 'username' => $smtp_authuser,
1083 # if there's no password, "git credential fill" will
1084 # give us one, otherwise it'll just pass this one.
1085 'password' => $smtp_authpass
1086 }, sub {
1087 my $cred = shift;
1088 return !!$smtp->auth($cred->{'username'}, $cred->{'password'});
1089 });
1090
1091 return $auth;
1092}
1093
35035bbf
RR
1094sub ssl_verify_params {
1095 eval {
1096 require IO::Socket::SSL;
1097 IO::Socket::SSL->import(qw/SSL_VERIFY_PEER SSL_VERIFY_NONE/);
1098 };
1099 if ($@) {
1100 print STDERR "Not using SSL_VERIFY_PEER due to out-of-date IO::Socket::SSL.\n";
1101 return;
1102 }
1103
1104 if (!defined $smtp_ssl_cert_path) {
01645b74
RK
1105 # use the OpenSSL defaults
1106 return (SSL_verify_mode => SSL_VERIFY_PEER());
35035bbf
RR
1107 }
1108
1109 if ($smtp_ssl_cert_path eq "") {
1110 return (SSL_verify_mode => SSL_VERIFY_NONE());
1111 } elsif (-d $smtp_ssl_cert_path) {
1112 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1113 SSL_ca_path => $smtp_ssl_cert_path);
1114 } elsif (-f $smtp_ssl_cert_path) {
1115 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1116 SSL_ca_file => $smtp_ssl_cert_path);
1117 } else {
1118 print STDERR "Not using SSL_VERIFY_PEER because the CA path does not exist.\n";
1119 return (SSL_verify_mode => SSL_VERIFY_NONE());
1120 }
1121}
1122
cb005c1f
EFL
1123sub file_name_is_absolute {
1124 my ($path) = @_;
1125
1126 # msys does not grok DOS drive-prefixes
1127 if ($^O eq 'msys') {
f24ecf59 1128 return ($path =~ m#^/# || $path =~ m#^[a-zA-Z]\:#)
cb005c1f
EFL
1129 }
1130
1131 require File::Spec::Functions;
1132 return File::Spec::Functions::file_name_is_absolute($path);
1133}
1134
15da1084 1135# Returns 1 if the message was sent, and 0 otherwise.
a1b5b371 1136# In actuality, the whole program dies when there
15da1084
MW
1137# is an error sending a message.
1138
68ce9330 1139sub send_message {
4bc87a28 1140 my @recipients = unique_email_list(@to);
e4312255 1141 @cc = (grep { my $cc = extract_valid_address_or_die($_);
83acaaec 1142 not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
7ac17529 1143 }
7ac17529 1144 @cc);
4bc87a28 1145 my $to = join (",\n\t", @recipients);
58063245 1146 @recipients = unique_email_list(@recipients,@cc,@bcclist);
e4312255 1147 @recipients = (map { extract_valid_address_or_die($_) } @recipients);
6bdca890 1148 my $date = format_2822_time($time++);
e923effb
ML
1149 my $gitversion = '@@GIT_VERSION@@';
1150 if ($gitversion =~ m/..GIT_VERSION../) {
3cb8caf7 1151 $gitversion = Git::version();
e923effb 1152 }
4bc87a28 1153
02461e0e 1154 my $cc = join(",\n\t", unique_email_list(@cc));
f06a6a49
JH
1155 my $ccline = "";
1156 if ($cc ne '') {
1157 $ccline = "\nCc: $cc";
1158 }
4f3d3703 1159 make_message_id() unless defined($message_id);
aeb59328 1160
da18759e 1161 my $header = "From: $sender
f06a6a49 1162To: $to${ccline}
4bc87a28 1163Subject: $subject
4bc87a28
EW
1164Date: $date
1165Message-Id: $message_id
e923effb 1166X-Mailer: git-send-email $gitversion
4bc87a28 1167";
3e0c4ffd 1168 if ($reply_to) {
7ccf7927
RA
1169
1170 $header .= "In-Reply-To: $reply_to\n";
1171 $header .= "References: $references\n";
1172 }
ce91c2f6
JH
1173 if (@xh) {
1174 $header .= join("\n", @xh) . "\n";
1175 }
4bc87a28 1176
c38f0247 1177 my @sendmail_parameters = ('-i', @recipients);
da18759e 1178 my $raw_from = $sender;
c89e3241
FC
1179 if (defined $envelope_sender && $envelope_sender ne "auto") {
1180 $raw_from = $envelope_sender;
1181 }
f073a592
RJ
1182 $raw_from = extract_valid_address($raw_from);
1183 unshift (@sendmail_parameters,
1184 '-f', $raw_from) if(defined $envelope_sender);
8e3d436b 1185
c1f2aa45
JS
1186 if ($needs_confirm && !$dry_run) {
1187 print "\n$header\n";
1188 if ($needs_confirm eq "inform") {
1189 $confirm_unconfigured = 0; # squelch this message for the rest of this run
6e182518 1190 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
c1f2aa45
JS
1191 print " The Cc list above has been expanded by additional\n";
1192 print " addresses found in the patch commit message. By default\n";
1193 print " send-email prompts before sending whenever this occurs.\n";
1194 print " This behavior is controlled by the sendemail.confirm\n";
1195 print " configuration setting.\n";
1196 print "\n";
1197 print " For additional information, run 'git send-email --help'.\n";
1198 print " To retain the current behavior, but squelch this message,\n";
1199 print " run 'git config --global sendemail.confirm auto'.\n\n";
1200 }
6e182518
JS
1201 $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1202 valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1203 default => $ask_default);
1204 die "Send this email reply required" unless defined $_;
c1f2aa45 1205 if (/^n/i) {
15da1084 1206 return 0;
c1f2aa45
JS
1207 } elsif (/^q/i) {
1208 cleanup_compose_files();
1209 exit(0);
1210 } elsif (/^a/i) {
1211 $confirm = 'never';
1212 }
1213 }
1214
052fbea2
PO
1215 unshift (@sendmail_parameters, @smtp_server_options);
1216
6130259c
MW
1217 if ($dry_run) {
1218 # We don't want to send the email.
cb005c1f 1219 } elsif (file_name_is_absolute($smtp_server)) {
aca7ad76
EW
1220 my $pid = open my $sm, '|-';
1221 defined $pid or die $!;
1222 if (!$pid) {
8e3d436b 1223 exec($smtp_server, @sendmail_parameters) or die $!;
aca7ad76
EW
1224 }
1225 print $sm "$header\n$message";
5e2c2ab1 1226 close $sm or die $!;
aca7ad76 1227 } else {
44b2476a
JH
1228
1229 if (!defined $smtp_server) {
1230 die "The required SMTP server is not properly defined."
1231 }
1232
f6bebd12 1233 if ($smtp_encryption eq 'ssl') {
44b2476a 1234 $smtp_server_port ||= 465; # ssmtp
34cc60ce 1235 require Net::SMTP::SSL;
69cf7bfd 1236 $smtp_domain ||= maildomain();
5508f3ed
TR
1237 require IO::Socket::SSL;
1238 # Net::SMTP::SSL->new() does not forward any SSL options
1239 IO::Socket::SSL::set_client_defaults(
1240 ssl_verify_params());
134550fe 1241 $smtp ||= Net::SMTP::SSL->new($smtp_server,
69cf7bfd 1242 Hello => $smtp_domain,
35035bbf 1243 Port => $smtp_server_port,
5508f3ed 1244 Debug => $debug_net_smtp);
34cc60ce
DS
1245 }
1246 else {
1247 require Net::SMTP;
69cf7bfd 1248 $smtp_domain ||= maildomain();
1a741bf7 1249 $smtp_server_port ||= 25;
1250 $smtp ||= Net::SMTP->new($smtp_server,
69cf7bfd 1251 Hello => $smtp_domain,
1a741bf7 1252 Debug => $debug_net_smtp,
1253 Port => $smtp_server_port);
fb3650ed 1254 if ($smtp_encryption eq 'tls' && $smtp) {
f6bebd12
TR
1255 require Net::SMTP::SSL;
1256 $smtp->command('STARTTLS');
1257 $smtp->response();
1258 if ($smtp->code == 220) {
35035bbf
RR
1259 $smtp = Net::SMTP::SSL->start_SSL($smtp,
1260 ssl_verify_params())
6cb0c883 1261 or die "STARTTLS failed! ".IO::Socket::SSL::errstr();
6cbf8b00 1262 $smtp_encryption = '';
9d1ccf5e
RS
1263 # Send EHLO again to receive fresh
1264 # supported commands
155b940f 1265 $smtp->hello($smtp_domain);
f6bebd12
TR
1266 } else {
1267 die "Server does not support STARTTLS! ".$smtp->message;
1268 }
1269 }
44b2476a
JH
1270 }
1271
1272 if (!$smtp) {
f60812ef 1273 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
e5afb3a6
JA
1274 "VALUES: server=$smtp_server ",
1275 "encryption=$smtp_encryption ",
69cf7bfd 1276 "hello=$smtp_domain",
a1dd7e16 1277 defined $smtp_server_port ? " port=$smtp_server_port" : "";
44b2476a
JH
1278 }
1279
4d31a44a 1280 smtp_auth_maybe or die $smtp->message;
2363d746 1281
2b69bfc2 1282 $smtp->mail( $raw_from ) or die $smtp->message;
aca7ad76
EW
1283 $smtp->to( @recipients ) or die $smtp->message;
1284 $smtp->data or die $smtp->message;
1285 $smtp->datasend("$header\n$message") or die $smtp->message;
1286 $smtp->dataend() or die $smtp->message;
15da1084 1287 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
aca7ad76 1288 }
2718435b 1289 if ($quiet) {
71c7da94 1290 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
2718435b 1291 } else {
b7f30e0a 1292 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
cb005c1f 1293 if (!file_name_is_absolute($smtp_server)) {
aca7ad76 1294 print "Server: $smtp_server\n";
2b69bfc2 1295 print "MAIL FROM:<$raw_from>\n";
02461e0e
JP
1296 foreach my $entry (@recipients) {
1297 print "RCPT TO:<$entry>\n";
1298 }
aca7ad76 1299 } else {
8e3d436b 1300 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
aca7ad76 1301 }
b7f30e0a 1302 print $header, "\n";
aca7ad76
EW
1303 if ($smtp) {
1304 print "Result: ", $smtp->code, ' ',
1305 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1306 } else {
1307 print "Result: OK\n";
1308 }
30d08b34 1309 }
15da1084
MW
1310
1311 return 1;
83b24437
RA
1312}
1313
83b24437 1314$reply_to = $initial_reply_to;
2186d566 1315$references = $initial_reply_to || '';
83b24437 1316$subject = $initial_subject;
c1f2aa45 1317$message_num = 0;
83b24437
RA
1318
1319foreach my $t (@files) {
f9237e61 1320 open my $fh, "<", $t or die "can't open file $t";
83b24437 1321
94638f89 1322 my $author = undef;
4cb46bdd 1323 my $sauthor = undef;
8291db6f
JK
1324 my $author_encoding;
1325 my $has_content_type;
1326 my $body_encoding;
bb29456c
PB
1327 my $xfer_encoding;
1328 my $has_mime_version;
3c3bb51c 1329 @to = ();
c1f2aa45 1330 @cc = ();
ce91c2f6 1331 @xh = ();
e6b0964a 1332 my $input_format = undef;
5012699d 1333 my @header = ();
83b24437 1334 $message = "";
c1f2aa45 1335 $message_num++;
5012699d 1336 # First unfold multiline header fields
f9237e61 1337 while(<$fh>) {
5012699d
JS
1338 last if /^\s*$/;
1339 if (/^\s+\S/ and @header) {
1340 chomp($header[$#header]);
1341 s/^\s+/ /;
1342 $header[$#header] .= $_;
1343 } else {
1344 push(@header, $_);
1345 }
1346 }
1347 # Now parse the header
1348 foreach(@header) {
1349 if (/^From /) {
1350 $input_format = 'mbox';
1351 next;
1352 }
1353 chomp;
1354 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1355 $input_format = 'mbox';
1356 }
1357
1358 if (defined $input_format && $input_format eq 'mbox') {
6310071a 1359 if (/^Subject:\s+(.*)$/i) {
5012699d 1360 $subject = $1;
e6b0964a 1361 }
6310071a 1362 elsif (/^From:\s+(.*)$/i) {
5012699d 1363 ($author, $author_encoding) = unquote_rfc2047($1);
4cb46bdd 1364 $sauthor = sanitize_address($author);
5012699d 1365 next if $suppress_cc{'author'};
da18759e 1366 next if $suppress_cc{'self'} and $sauthor eq $sender;
5012699d
JS
1367 printf("(mbox) Adding cc: %s from line '%s'\n",
1368 $1, $_) unless $quiet;
1369 push @cc, $1;
e6b0964a 1370 }
6310071a 1371 elsif (/^To:\s+(.*)$/i) {
21802cd3
SB
1372 foreach my $addr (parse_address_line($1)) {
1373 printf("(mbox) Adding to: %s from line '%s'\n",
1374 $addr, $_) unless $quiet;
e4312255 1375 push @to, $addr;
21802cd3
SB
1376 }
1377 }
6310071a 1378 elsif (/^Cc:\s+(.*)$/i) {
5012699d 1379 foreach my $addr (parse_address_line($1)) {
da18759e
MT
1380 my $qaddr = unquote_rfc2047($addr);
1381 my $saddr = sanitize_address($qaddr);
1382 if ($saddr eq $sender) {
65648283 1383 next if ($suppress_cc{'self'});
65648283
DB
1384 } else {
1385 next if ($suppress_cc{'cc'});
8a8e6235 1386 }
83b24437 1387 printf("(mbox) Adding cc: %s from line '%s'\n",
5012699d
JS
1388 $addr, $_) unless $quiet;
1389 push @cc, $addr;
83b24437 1390 }
5012699d
JS
1391 }
1392 elsif (/^Content-type:/i) {
1393 $has_content_type = 1;
1394 if (/charset="?([^ "]+)/) {
1395 $body_encoding = $1;
83b24437 1396 }
5012699d 1397 push @xh, $_;
83b24437 1398 }
bb29456c
PB
1399 elsif (/^MIME-Version/i) {
1400 $has_mime_version = 1;
1401 push @xh, $_;
1402 }
5012699d
JS
1403 elsif (/^Message-Id: (.*)/i) {
1404 $message_id = $1;
83b24437 1405 }
bb29456c
PB
1406 elsif (/^Content-Transfer-Encoding: (.*)/i) {
1407 $xfer_encoding = $1 if not defined $xfer_encoding;
1408 }
6310071a 1409 elsif (!/^Date:\s/i && /^[-A-Za-z]+:\s+\S/) {
5012699d
JS
1410 push @xh, $_;
1411 }
1412
83b24437 1413 } else {
5012699d
JS
1414 # In the traditional
1415 # "send lots of email" format,
1416 # line 1 = cc
1417 # line 2 = subject
1418 # So let's support that, too.
1419 $input_format = 'lots';
1420 if (@cc == 0 && !$suppress_cc{'cc'}) {
1421 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1422 $_, $_) unless $quiet;
1423 push @cc, $_;
1424 } elsif (!defined $subject) {
1425 $subject = $_;
83b24437
RA
1426 }
1427 }
1428 }
5012699d 1429 # Now parse the message body
f9237e61 1430 while(<$fh>) {
5012699d
JS
1431 $message .= $_;
1432 if (/^(Signed-off-by|Cc): (.*)$/i) {
5012699d 1433 chomp;
3531e270 1434 my ($what, $c) = ($1, $2);
5012699d 1435 chomp $c;
da18759e
MT
1436 my $sc = sanitize_address($c);
1437 if ($sc eq $sender) {
3531e270
JS
1438 next if ($suppress_cc{'self'});
1439 } else {
1440 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1441 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1442 }
5012699d 1443 push @cc, $c;
3531e270 1444 printf("(body) Adding cc: %s from line '%s'\n",
5012699d
JS
1445 $c, $_) unless $quiet;
1446 }
1447 }
f9237e61 1448 close $fh;
324a8bd0 1449
6e74e075
JP
1450 push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t)
1451 if defined $to_cmd;
1452 push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t)
1453 if defined $cc_cmd && !$suppress_cc{'cccmd'};
324a8bd0 1454
3cae7e5b 1455 if ($broken_encoding{$t} && !$has_content_type) {
bb29456c 1456 $xfer_encoding = '8bit' if not defined $xfer_encoding;
3cae7e5b 1457 $has_content_type = 1;
bb29456c 1458 push @xh, "Content-Type: text/plain; charset=$auto_8bit_encoding";
3cae7e5b
TR
1459 $body_encoding = $auto_8bit_encoding;
1460 }
1461
ce547800
KM
1462 if ($broken_encoding{$t} && !is_rfc2047_quoted($subject)) {
1463 $subject = quote_subject($subject, $auto_8bit_encoding);
3cae7e5b
TR
1464 }
1465
4cb46bdd 1466 if (defined $sauthor and $sauthor ne $sender) {
94638f89 1467 $message = "From: $author\n\n$message";
8291db6f
JK
1468 if (defined $author_encoding) {
1469 if ($has_content_type) {
1470 if ($body_encoding eq $author_encoding) {
1471 # ok, we already have the right encoding
1472 }
1473 else {
1474 # uh oh, we should re-encode
1475 }
1476 }
1477 else {
bb29456c 1478 $xfer_encoding = '8bit' if not defined $xfer_encoding;
3cae7e5b 1479 $has_content_type = 1;
8291db6f 1480 push @xh,
bb29456c 1481 "Content-Type: text/plain; charset=$author_encoding";
8291db6f
JK
1482 }
1483 }
8a8e6235 1484 }
bb29456c
PB
1485 if (defined $xfer_encoding) {
1486 push @xh, "Content-Transfer-Encoding: $xfer_encoding";
1487 }
1488 if (defined $xfer_encoding or $has_content_type) {
1489 unshift @xh, 'MIME-Version: 1.0' unless $has_mime_version;
1490 }
83b24437 1491
c1f2aa45
JS
1492 $needs_confirm = (
1493 $confirm eq "always" or
1494 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1495 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1496 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1497
e4312255
KM
1498 @to = validate_address_list(sanitize_address_list(@to));
1499 @cc = validate_address_list(sanitize_address_list(@cc));
1500
3c3bb51c 1501 @to = (@initial_to, @to);
c1f2aa45
JS
1502 @cc = (@initial_cc, @cc);
1503
f515c904
MT
1504 if ($message_num == 1) {
1505 if (defined $cover_cc and $cover_cc) {
1506 @initial_cc = @cc;
1507 }
1508 if (defined $cover_to and $cover_to) {
1509 @initial_to = @to;
1510 }
1511 }
1512
15da1084 1513 my $message_was_sent = send_message();
83b24437
RA
1514
1515 # set up for the next message
95a877a3 1516 if ($thread && $message_was_sent &&
b99d22f2 1517 ($chain_reply_to || !defined $reply_to || length($reply_to) == 0 ||
db54c8e7 1518 $message_num == 1)) {
78488b2c 1519 $reply_to = $message_id;
7ccf7927 1520 if (length $references > 0) {
a925b89c 1521 $references .= "\n $message_id";
7ccf7927
RA
1522 } else {
1523 $references = "$message_id";
1524 }
78488b2c 1525 }
4f3d3703 1526 $message_id = undef;
83b24437 1527}
e205735d 1528
6e74e075
JP
1529# Execute a command (e.g. $to_cmd) to get a list of email addresses
1530# and return a results array
1531sub recipients_cmd {
1532 my ($prefix, $what, $cmd, $file) = @_;
1533
6e74e075 1534 my @addresses = ();
a47eab03 1535 open my $fh, "-|", "$cmd \Q$file\E"
6e74e075 1536 or die "($prefix) Could not execute '$cmd'";
7ebee441 1537 while (my $address = <$fh>) {
6e74e075
JP
1538 $address =~ s/^\s*//g;
1539 $address =~ s/\s*$//g;
1540 $address = sanitize_address($address);
da18759e 1541 next if ($address eq $sender and $suppress_cc{'self'});
6e74e075
JP
1542 push @addresses, $address;
1543 printf("($prefix) Adding %s: %s from: '%s'\n",
1544 $what, $address, $cmd) unless $quiet;
1545 }
7ebee441 1546 close $fh
6e74e075
JP
1547 or die "($prefix) failed to close pipe to '$cmd'";
1548 return @addresses;
1549}
1550
c1f2aa45 1551cleanup_compose_files();
1f038a0c 1552
4bf597ee 1553sub cleanup_compose_files {
c1f2aa45 1554 unlink($compose_filename, $compose_filename . ".final") if $compose;
1f038a0c
RA
1555}
1556
4bc87a28 1557$smtp->quit if $smtp;
e205735d 1558
c438ea2a 1559sub unique_email_list {
e205735d
RA
1560 my %seen;
1561 my @emails;
1562
1563 foreach my $entry (@_) {
e4312255
KM
1564 my $clean = extract_valid_address_or_die($entry);
1565 $seen{$clean} ||= 0;
1566 next if $seen{$clean}++;
1567 push @emails, $entry;
e205735d
RA
1568 }
1569 return @emails;
1570}
747bbff9
JK
1571
1572sub validate_patch {
1573 my $fn = shift;
1574 open(my $fh, '<', $fn)
1575 or die "unable to open $fn: $!\n";
1576 while (my $line = <$fh>) {
1577 if (length($line) > 998) {
1578 return "$.: patch contains a line longer than 998 characters";
1579 }
1580 }
622bc930 1581 return;
747bbff9 1582}
0706bd19
JK
1583
1584sub file_has_nonascii {
1585 my $fn = shift;
1586 open(my $fh, '<', $fn)
1587 or die "unable to open $fn: $!\n";
1588 while (my $line = <$fh>) {
1589 return 1 if $line =~ /[^[:ascii:]]/;
1590 }
1591 return 0;
1592}
3cae7e5b
TR
1593
1594sub body_or_subject_has_nonascii {
1595 my $fn = shift;
1596 open(my $fh, '<', $fn)
1597 or die "unable to open $fn: $!\n";
1598 while (my $line = <$fh>) {
1599 last if $line =~ /^$/;
1600 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1601 }
1602 while (my $line = <$fh>) {
1603 return 1 if $line =~ /[^[:ascii:]]/;
1604 }
1605 return 0;
1606}