]>
Commit | Line | Data |
---|---|---|
83b24437 | 1 | #!/usr/bin/perl -w |
83b24437 | 2 | # |
f3d9f354 RA |
3 | # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com> |
4 | # Copyright 2005 Ryan Anderson <ryan@michonline.com> | |
83b24437 RA |
5 | # |
6 | # GPL v2 (See COPYING) | |
5825e5b2 | 7 | # |
83b24437 RA |
8 | # Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com> |
9 | # | |
f3d9f354 | 10 | # Sends a collection of emails to the given email addresses, disturbingly fast. |
5825e5b2 | 11 | # |
f3d9f354 RA |
12 | # Supports two formats: |
13 | # 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches) | |
14 | # 2. The original format support by Greg's script: | |
5825e5b2 | 15 | # first line of the message is who to CC, |
f3d9f354 | 16 | # and second line is the subject of the message. |
5825e5b2 | 17 | # |
83b24437 RA |
18 | |
19 | use strict; | |
20 | use warnings; | |
21 | use Term::ReadLine; | |
83b24437 RA |
22 | use Getopt::Long; |
23 | use Data::Dumper; | |
412876dc | 24 | use Term::ANSIColor; |
3cb8caf7 | 25 | use Git; |
83b24437 | 26 | |
280242d1 JH |
27 | package FakeTerm; |
28 | sub new { | |
29 | my ($class, $reason) = @_; | |
30 | return bless \$reason, shift; | |
31 | } | |
32 | sub readline { | |
33 | my $self = shift; | |
34 | die "Cannot use readline on FakeTerm: $$self"; | |
35 | } | |
36 | package main; | |
37 | ||
1b0baf14 MC |
38 | |
39 | sub usage { | |
40 | print <<EOT; | |
41 | git-send-email [options] <file | directory>... | |
42 | Options: | |
43 | --from Specify the "From:" line of the email to be sent. | |
44 | ||
45 | --to Specify the primary "To:" line of the email. | |
46 | ||
47 | --cc Specify an initial "Cc:" list for the entire series | |
48 | of emails. | |
49 | ||
324a8bd0 JP |
50 | --cc-cmd Specify a command to execute per file which adds |
51 | per file specific cc address entries | |
52 | ||
1b0baf14 MC |
53 | --bcc Specify a list of email addresses that should be Bcc: |
54 | on all the emails. | |
55 | ||
ef0c2abf AR |
56 | --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit |
57 | an introductory message for the patch series. | |
1b0baf14 MC |
58 | |
59 | --subject Specify the initial "Subject:" line. | |
60 | Only necessary if --compose is also set. If --compose | |
61 | is not set, this will be prompted for. | |
62 | ||
63 | --in-reply-to Specify the first "In-Reply-To:" header line. | |
64 | Only used if --compose is also set. If --compose is not | |
65 | set, this will be prompted for. | |
66 | ||
67 | --chain-reply-to If set, the replies will all be to the previous | |
68 | email sent, rather than to the first email sent. | |
69 | Defaults to on. | |
70 | ||
5483c71d AR |
71 | --signed-off-cc Automatically add email addresses that appear in |
72 | Signed-off-by: or Cc: lines to the cc: list. Defaults to on. | |
1b0baf14 | 73 | |
34cc60ce DS |
74 | --identity The configuration identity, a subsection to prioritise over |
75 | the default section. | |
76 | ||
1b0baf14 | 77 | --smtp-server If set, specifies the outgoing SMTP server to use. |
44b2476a JH |
78 | Defaults to localhost. Port number can be specified here with |
79 | hostname:port format or by using --smtp-server-port option. | |
80 | ||
81 | --smtp-server-port Specify a port on the outgoing SMTP server to connect to. | |
1b0baf14 | 82 | |
34cc60ce DS |
83 | --smtp-user The username for SMTP-AUTH. |
84 | ||
85 | --smtp-pass The password for SMTP-AUTH. | |
86 | ||
87 | --smtp-ssl If set, connects to the SMTP server using SSL. | |
88 | ||
65648283 DB |
89 | --suppress-cc Suppress the specified category of auto-CC. The category |
90 | can be one of 'author' for the patch author, 'self' to | |
91 | avoid copying yourself, 'sob' for Signed-off-by lines, | |
92 | 'cccmd' for the output of the cccmd, or 'all' to suppress | |
93 | all of these. | |
94 | ||
620bb245 | 95 | --suppress-from Suppress sending emails to yourself. Defaults to off. |
1b0baf14 | 96 | |
5483c71d | 97 | --thread Specify that the "In-Reply-To:" header should be set on all |
e46f7a0e AR |
98 | emails. Defaults to on. |
99 | ||
1b0baf14 MC |
100 | --quiet Make git-send-email less verbose. One line per email |
101 | should be all that is output. | |
102 | ||
238cc635 RJ |
103 | --dry-run Do everything except actually send the emails. |
104 | ||
f073a592 RJ |
105 | --envelope-sender Specify the envelope sender used to send the emails. |
106 | ||
c764a0c2 JK |
107 | --no-validate Don't perform any sanity checks on patches. |
108 | ||
1b0baf14 MC |
109 | EOT |
110 | exit(1); | |
111 | } | |
112 | ||
4bc87a28 | 113 | # most mail servers generate the Date: header, but not all... |
6bdca890 JN |
114 | sub format_2822_time { |
115 | my ($time) = @_; | |
116 | my @localtm = localtime($time); | |
117 | my @gmttm = gmtime($time); | |
118 | my $localmin = $localtm[1] + $localtm[2] * 60; | |
119 | my $gmtmin = $gmttm[1] + $gmttm[2] * 60; | |
120 | if ($localtm[0] != $gmttm[0]) { | |
121 | die "local zone differs from GMT by a non-minute interval\n"; | |
122 | } | |
123 | if ((($gmttm[6] + 1) % 7) == $localtm[6]) { | |
124 | $localmin += 1440; | |
125 | } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) { | |
126 | $localmin -= 1440; | |
127 | } elsif ($gmttm[6] != $localtm[6]) { | |
128 | die "local time offset greater than or equal to 24 hours\n"; | |
129 | } | |
130 | my $offset = $localmin - $gmtmin; | |
131 | my $offhour = $offset / 60; | |
132 | my $offmin = abs($offset % 60); | |
133 | if (abs($offhour) >= 24) { | |
134 | die ("local time offset greater than or equal to 24 hours\n"); | |
135 | } | |
136 | ||
137 | return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d", | |
138 | qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]], | |
139 | $localtm[3], | |
140 | qw(Jan Feb Mar Apr May Jun | |
141 | Jul Aug Sep Oct Nov Dec)[$localtm[4]], | |
142 | $localtm[5]+1900, | |
143 | $localtm[2], | |
144 | $localtm[1], | |
145 | $localtm[0], | |
146 | ($offset >= 0) ? '+' : '-', | |
147 | abs($offhour), | |
148 | $offmin, | |
149 | ); | |
150 | } | |
4bc87a28 | 151 | |
567ffeb7 | 152 | my $have_email_valid = eval { require Email::Valid; 1 }; |
4bc87a28 | 153 | my $smtp; |
5f5b6118 | 154 | my $auth; |
4bc87a28 | 155 | |
e205735d | 156 | sub unique_email_list(@); |
1f038a0c RA |
157 | sub cleanup_compose_files(); |
158 | ||
159 | # Constants (essentially) | |
160 | my $compose_filename = ".msg.$$"; | |
e205735d | 161 | |
83b24437 | 162 | # Variables we fill in automatically, or via prompting: |
ce91c2f6 | 163 | my (@to,@cc,@initial_cc,@bcclist,@xh, |
2363d746 | 164 | $initial_reply_to,$initial_subject,@files,$author,$sender,$smtp_authpass,$compose,$time); |
83b24437 | 165 | |
f073a592 | 166 | my $envelope_sender; |
78488b2c | 167 | |
9133261f | 168 | # Example reply to: |
83b24437 | 169 | #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>'; |
83b24437 | 170 | |
ad79c024 FL |
171 | my $repo = eval { Git->repository() }; |
172 | my @repo = $repo ? ($repo) : (); | |
280242d1 | 173 | my $term = eval { |
0fb7fc75 JS |
174 | $ENV{"GIT_SEND_EMAIL_NOTTY"} |
175 | ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT | |
176 | : new Term::ReadLine 'git-send-email'; | |
280242d1 JH |
177 | }; |
178 | if ($@) { | |
179 | $term = new FakeTerm "$@: going non-interactive"; | |
180 | } | |
83b24437 | 181 | |
5483c71d AR |
182 | # Behavior modification variables |
183 | my ($quiet, $dry_run) = (0, 0); | |
184 | ||
185 | # Variables with corresponding config settings | |
324a8bd0 | 186 | my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd); |
2363d746 | 187 | my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_ssl); |
44b2476a | 188 | my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts); |
c764a0c2 | 189 | my ($no_validate); |
65648283 | 190 | my (@suppress_cc); |
5483c71d | 191 | |
34cc60ce | 192 | my %config_bool_settings = ( |
5483c71d AR |
193 | "thread" => [\$thread, 1], |
194 | "chainreplyto" => [\$chain_reply_to, 1], | |
65648283 DB |
195 | "suppressfrom" => [\$suppress_from, undef], |
196 | "signedoffcc" => [\$signed_off_cc, undef], | |
34cc60ce | 197 | "smtpssl" => [\$smtp_ssl, 0], |
e46f7a0e AR |
198 | ); |
199 | ||
34cc60ce DS |
200 | my %config_settings = ( |
201 | "smtpserver" => \$smtp_server, | |
44b2476a | 202 | "smtpserverport" => \$smtp_server_port, |
34cc60ce DS |
203 | "smtpuser" => \$smtp_authuser, |
204 | "smtppass" => \$smtp_authpass, | |
2db9b49c | 205 | "to" => \@to, |
5f8b9fcd | 206 | "cc" => \@initial_cc, |
34cc60ce DS |
207 | "cccmd" => \$cc_cmd, |
208 | "aliasfiletype" => \$aliasfiletype, | |
209 | "bcc" => \@bcclist, | |
210 | "aliasesfile" => \@alias_files, | |
65648283 | 211 | "suppresscc" => \@suppress_cc, |
34cc60ce | 212 | ); |
4a62d3f5 | 213 | |
87429976 MW |
214 | # Handle Uncouth Termination |
215 | sub signal_handler { | |
216 | ||
217 | # Make text normal | |
218 | print color("reset"), "\n"; | |
219 | ||
220 | # SMTP password masked | |
221 | system "stty echo"; | |
222 | ||
223 | # tmp files from --compose | |
224 | if (-e $compose_filename) { | |
225 | print "'$compose_filename' contains an intermediate version of the email you were composing.\n"; | |
226 | } | |
227 | if (-e ($compose_filename . ".final")) { | |
228 | print "'$compose_filename.final' contains the composed email.\n" | |
229 | } | |
230 | ||
231 | exit; | |
232 | }; | |
233 | ||
234 | $SIG{TERM} = \&signal_handler; | |
235 | $SIG{INT} = \&signal_handler; | |
236 | ||
83b24437 RA |
237 | # Begin by accumulating all the variables (defined above), that we will end up |
238 | # needing, first, from the command line: | |
239 | ||
94638f89 | 240 | my $rc = GetOptions("sender|from=s" => \$sender, |
83b24437 RA |
241 | "in-reply-to=s" => \$initial_reply_to, |
242 | "subject=s" => \$initial_subject, | |
243 | "to=s" => \@to, | |
da140f8b | 244 | "cc=s" => \@initial_cc, |
58063245 | 245 | "bcc=s" => \@bcclist, |
78488b2c | 246 | "chain-reply-to!" => \$chain_reply_to, |
3342d850 | 247 | "smtp-server=s" => \$smtp_server, |
44b2476a | 248 | "smtp-server-port=s" => \$smtp_server_port, |
34cc60ce | 249 | "smtp-user=s" => \$smtp_authuser, |
2363d746 | 250 | "smtp-pass:s" => \$smtp_authpass, |
34cc60ce DS |
251 | "smtp-ssl!" => \$smtp_ssl, |
252 | "identity=s" => \$identity, | |
1f038a0c | 253 | "compose" => \$compose, |
30d08b34 | 254 | "quiet" => \$quiet, |
324a8bd0 | 255 | "cc-cmd=s" => \$cc_cmd, |
5483c71d | 256 | "suppress-from!" => \$suppress_from, |
65648283 | 257 | "suppress-cc=s" => \@suppress_cc, |
5483c71d | 258 | "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc, |
6130259c | 259 | "dry-run" => \$dry_run, |
f073a592 | 260 | "envelope-sender=s" => \$envelope_sender, |
5483c71d | 261 | "thread!" => \$thread, |
c764a0c2 | 262 | "no-validate" => \$no_validate, |
83b24437 RA |
263 | ); |
264 | ||
1b0baf14 MC |
265 | unless ($rc) { |
266 | usage(); | |
267 | } | |
268 | ||
34cc60ce DS |
269 | # Now, let's fill any that aren't set in with defaults: |
270 | ||
271 | sub read_config { | |
272 | my ($prefix) = @_; | |
273 | ||
274 | foreach my $setting (keys %config_bool_settings) { | |
275 | my $target = $config_bool_settings{$setting}->[0]; | |
ad79c024 | 276 | $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target); |
34cc60ce DS |
277 | } |
278 | ||
279 | foreach my $setting (keys %config_settings) { | |
280 | my $target = $config_settings{$setting}; | |
281 | if (ref($target) eq "ARRAY") { | |
282 | unless (@$target) { | |
ad79c024 | 283 | my @values = Git::config(@repo, "$prefix.$setting"); |
34cc60ce DS |
284 | @$target = @values if (@values && defined $values[0]); |
285 | } | |
286 | } | |
287 | else { | |
ad79c024 | 288 | $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target); |
34cc60ce DS |
289 | } |
290 | } | |
291 | } | |
292 | ||
293 | # read configuration from [sendemail "$identity"], fall back on [sendemail] | |
ad79c024 | 294 | $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity); |
34cc60ce DS |
295 | read_config("sendemail.$identity") if (defined $identity); |
296 | read_config("sendemail"); | |
297 | ||
298 | # fall back on builtin bool defaults | |
299 | foreach my $setting (values %config_bool_settings) { | |
300 | ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]})); | |
301 | } | |
302 | ||
65648283 DB |
303 | # Set CC suppressions |
304 | my(%suppress_cc); | |
305 | if (@suppress_cc) { | |
306 | foreach my $entry (@suppress_cc) { | |
307 | die "Unknown --suppress-cc field: '$entry'\n" | |
308 | unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/; | |
309 | $suppress_cc{$entry} = 1; | |
310 | } | |
311 | } | |
312 | ||
313 | if ($suppress_cc{'all'}) { | |
314 | foreach my $entry (qw (ccmd cc author self sob)) { | |
315 | $suppress_cc{$entry} = 1; | |
316 | } | |
317 | delete $suppress_cc{'all'}; | |
318 | } | |
319 | ||
320 | # If explicit old-style ones are specified, they trump --suppress-cc. | |
321 | $suppress_cc{'self'} = $suppress_from if defined $suppress_from; | |
ba51795c | 322 | $suppress_cc{'sob'} = !$signed_off_cc if defined $signed_off_cc; |
65648283 DB |
323 | |
324 | # Debugging, print out the suppressions. | |
325 | if (0) { | |
326 | print "suppressions:\n"; | |
327 | foreach my $entry (keys %suppress_cc) { | |
328 | printf " %-5s -> $suppress_cc{$entry}\n", $entry; | |
329 | } | |
330 | } | |
331 | ||
ad79c024 FL |
332 | my ($repoauthor, $repocommitter); |
333 | ($repoauthor) = Git::ident_person(@repo, 'author'); | |
334 | ($repocommitter) = Git::ident_person(@repo, 'committer'); | |
34cc60ce | 335 | |
79ee555b EB |
336 | # Verify the user input |
337 | ||
338 | foreach my $entry (@to) { | |
339 | die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/; | |
340 | } | |
341 | ||
342 | foreach my $entry (@initial_cc) { | |
343 | die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/; | |
344 | } | |
345 | ||
346 | foreach my $entry (@bcclist) { | |
347 | die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/; | |
348 | } | |
349 | ||
994d6c66 | 350 | my %aliases; |
994d6c66 EW |
351 | my %parse_alias = ( |
352 | # multiline formats can be supported in the future | |
353 | mutt => sub { my $fh = shift; while (<$fh>) { | |
504ceab6 | 354 | if (/^\s*alias\s+(\S+)\s+(.*)$/) { |
994d6c66 EW |
355 | my ($alias, $addr) = ($1, $2); |
356 | $addr =~ s/#.*$//; # mutt allows # comments | |
357 | # commas delimit multiple addresses | |
358 | $aliases{$alias} = [ split(/\s*,\s*/, $addr) ]; | |
359 | }}}, | |
360 | mailrc => sub { my $fh = shift; while (<$fh>) { | |
361 | if (/^alias\s+(\S+)\s+(.*)$/) { | |
362 | # spaces delimit multiple addresses | |
363 | $aliases{$1} = [ split(/\s+/, $2) ]; | |
364 | }}}, | |
365 | pine => sub { my $fh = shift; while (<$fh>) { | |
2d8ae400 | 366 | if (/^(\S+)\t.*\t(.*)$/) { |
994d6c66 EW |
367 | $aliases{$1} = [ split(/\s*,\s*/, $2) ]; |
368 | }}}, | |
369 | gnus => sub { my $fh = shift; while (<$fh>) { | |
370 | if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) { | |
371 | $aliases{$1} = [ $2 ]; | |
372 | }}} | |
373 | ); | |
374 | ||
3cb8caf7 | 375 | if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) { |
994d6c66 EW |
376 | foreach my $file (@alias_files) { |
377 | open my $fh, '<', $file or die "opening $file: $!\n"; | |
378 | $parse_alias{$aliasfiletype}->($fh); | |
379 | close $fh; | |
380 | } | |
381 | } | |
382 | ||
94638f89 | 383 | ($sender) = expand_aliases($sender) if defined $sender; |
ae740a58 | 384 | |
aa54892f JK |
385 | # Now that all the defaults are set, process the rest of the command line |
386 | # arguments and collect up the files that need to be processed. | |
387 | for my $f (@ARGV) { | |
388 | if (-d $f) { | |
389 | opendir(DH,$f) | |
390 | or die "Failed to opendir $f: $!"; | |
391 | ||
392 | push @files, grep { -f $_ } map { +$f . "/" . $_ } | |
393 | sort readdir(DH); | |
394 | ||
395 | } elsif (-f $f) { | |
396 | push @files, $f; | |
397 | ||
398 | } else { | |
399 | print STDERR "Skipping $f - not found.\n"; | |
400 | } | |
401 | } | |
402 | ||
c764a0c2 JK |
403 | if (!$no_validate) { |
404 | foreach my $f (@files) { | |
405 | my $error = validate_patch($f); | |
406 | $error and die "fatal: $f: $error\nwarning: no patches were sent\n"; | |
407 | } | |
747bbff9 JK |
408 | } |
409 | ||
aa54892f JK |
410 | if (@files) { |
411 | unless ($quiet) { | |
412 | print $_,"\n" for (@files); | |
413 | } | |
414 | } else { | |
415 | print STDERR "\nNo patch files specified!\n\n"; | |
416 | usage(); | |
417 | } | |
418 | ||
1f038a0c | 419 | my $prompting = 0; |
94638f89 | 420 | if (!defined $sender) { |
ad79c024 | 421 | $sender = $repoauthor || $repocommitter || ''; |
8a7c56e1 MW |
422 | |
423 | while (1) { | |
94638f89 | 424 | $_ = $term->readline("Who should the emails appear to be from? [$sender] "); |
8a7c56e1 MW |
425 | last if defined $_; |
426 | print "\n"; | |
427 | } | |
8037d1a3 | 428 | |
94638f89 UKK |
429 | $sender = $_ if ($_); |
430 | print "Emails will be sent from: ", $sender, "\n"; | |
1f038a0c | 431 | $prompting++; |
83b24437 RA |
432 | } |
433 | ||
434 | if (!@to) { | |
8a7c56e1 MW |
435 | |
436 | ||
437 | while (1) { | |
438 | $_ = $term->readline("Who should the emails be sent to? ", ""); | |
439 | last if defined $_; | |
440 | print "\n"; | |
441 | } | |
442 | ||
83b24437 RA |
443 | my $to = $_; |
444 | push @to, split /,/, $to; | |
1f038a0c | 445 | $prompting++; |
83b24437 RA |
446 | } |
447 | ||
994d6c66 EW |
448 | sub expand_aliases { |
449 | my @cur = @_; | |
450 | my @last; | |
451 | do { | |
452 | @last = @cur; | |
453 | @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last; | |
454 | } while (join(',',@cur) ne join(',',@last)); | |
455 | return @cur; | |
456 | } | |
457 | ||
458 | @to = expand_aliases(@to); | |
5b56aaa2 | 459 | @to = (map { sanitize_address($_) } @to); |
994d6c66 | 460 | @initial_cc = expand_aliases(@initial_cc); |
58063245 | 461 | @bcclist = expand_aliases(@bcclist); |
994d6c66 | 462 | |
1f038a0c | 463 | if (!defined $initial_subject && $compose) { |
8a7c56e1 MW |
464 | while (1) { |
465 | $_ = $term->readline("What subject should the initial email start with? ", $initial_subject); | |
466 | last if defined $_; | |
467 | print "\n"; | |
468 | } | |
469 | ||
83b24437 | 470 | $initial_subject = $_; |
1f038a0c | 471 | $prompting++; |
83b24437 RA |
472 | } |
473 | ||
5483c71d | 474 | if ($thread && !defined $initial_reply_to && $prompting) { |
8a7c56e1 MW |
475 | while (1) { |
476 | $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ", $initial_reply_to); | |
477 | last if defined $_; | |
478 | print "\n"; | |
479 | } | |
8037d1a3 | 480 | |
83b24437 RA |
481 | $initial_reply_to = $_; |
482 | } | |
1ca3d6ed | 483 | if (defined $initial_reply_to) { |
0fb7fc75 JS |
484 | $initial_reply_to =~ s/^\s*<?//; |
485 | $initial_reply_to =~ s/>?\s*$//; | |
486 | $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne ''; | |
ace9c2a9 | 487 | } |
ace72086 | 488 | |
34cc60ce | 489 | if (!defined $smtp_server) { |
aca7ad76 EW |
490 | foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) { |
491 | if (-x $_) { | |
492 | $smtp_server = $_; | |
493 | last; | |
494 | } | |
495 | } | |
496 | $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug* | |
3342d850 RA |
497 | } |
498 | ||
1f038a0c RA |
499 | if ($compose) { |
500 | # Note that this does not need to be secure, but we will make a small | |
501 | # effort to have it be unique | |
502 | open(C,">",$compose_filename) | |
503 | or die "Failed to open for writing $compose_filename: $!"; | |
94638f89 | 504 | print C "From $sender # This line is ignored.\n"; |
1f038a0c RA |
505 | printf C "Subject: %s\n\n", $initial_subject; |
506 | printf C <<EOT; | |
507 | GIT: Please enter your email below. | |
508 | GIT: Lines beginning in "GIT: " will be removed. | |
509 | GIT: Consider including an overall diffstat or table of contents | |
510 | GIT: for the patch you are writing. | |
511 | ||
512 | EOT | |
513 | close(C); | |
514 | ||
ad79c024 | 515 | my $editor = $ENV{GIT_EDITOR} || Git::config(@repo, "core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi"; |
065096c2 | 516 | system('sh', '-c', $editor.' "$@"', $editor, $compose_filename); |
1f038a0c RA |
517 | |
518 | open(C2,">",$compose_filename . ".final") | |
519 | or die "Failed to open $compose_filename.final : " . $!; | |
520 | ||
521 | open(C,"<",$compose_filename) | |
522 | or die "Failed to open $compose_filename : " . $!; | |
523 | ||
0706bd19 JK |
524 | my $need_8bit_cte = file_has_nonascii($compose_filename); |
525 | my $in_body = 0; | |
1f038a0c RA |
526 | while(<C>) { |
527 | next if m/^GIT: /; | |
0706bd19 JK |
528 | if (!$in_body && /^\n$/) { |
529 | $in_body = 1; | |
530 | if ($need_8bit_cte) { | |
531 | print C2 "MIME-Version: 1.0\n", | |
532 | "Content-Type: text/plain; ", | |
533 | "charset=utf-8\n", | |
534 | "Content-Transfer-Encoding: 8bit\n"; | |
535 | } | |
536 | } | |
537 | if (!$in_body && /^MIME-Version:/i) { | |
538 | $need_8bit_cte = 0; | |
539 | } | |
d54eaaa2 JK |
540 | if (!$in_body && /^Subject: ?(.*)/i) { |
541 | my $subject = $1; | |
542 | $_ = "Subject: " . | |
543 | ($subject =~ /[^[:ascii:]]/ ? | |
544 | quote_rfc2047($subject) : | |
545 | $subject) . | |
546 | "\n"; | |
547 | } | |
1f038a0c RA |
548 | print C2 $_; |
549 | } | |
550 | close(C); | |
551 | close(C2); | |
552 | ||
8a7c56e1 | 553 | while (1) { |
1f038a0c | 554 | $_ = $term->readline("Send this email? (y|n) "); |
8a7c56e1 MW |
555 | last if defined $_; |
556 | print "\n"; | |
557 | } | |
1f038a0c RA |
558 | |
559 | if (uc substr($_,0,1) ne 'Y') { | |
560 | cleanup_compose_files(); | |
561 | exit(0); | |
562 | } | |
563 | ||
97394ee4 | 564 | @files = ($compose_filename . ".final", @files); |
1f038a0c RA |
565 | } |
566 | ||
83b24437 | 567 | # Variables we set as part of the loop over files |
af068d27 | 568 | our ($message_id, %mail, $subject, $reply_to, $references, $message); |
83b24437 | 569 | |
567ffeb7 EW |
570 | sub extract_valid_address { |
571 | my $address = shift; | |
ad9c18f5 | 572 | my $local_part_regexp = '[^<>"\s@]+'; |
09302e17 | 573 | my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+'; |
db3106b2 EW |
574 | |
575 | # check for a local address: | |
ad9c18f5 | 576 | return $address if ($address =~ /^($local_part_regexp)$/); |
db3106b2 | 577 | |
155197e6 | 578 | $address =~ s/^\s*<(.*)>\s*$/$1/; |
567ffeb7 | 579 | if ($have_email_valid) { |
ad9c18f5 | 580 | return scalar Email::Valid->address($address); |
567ffeb7 EW |
581 | } else { |
582 | # less robust/correct than the monster regexp in Email::Valid, | |
583 | # but still does a 99% job, and one less dependency | |
ad9c18f5 | 584 | $address =~ /($local_part_regexp\@$domain_regexp)/; |
e96fd305 | 585 | return $1; |
567ffeb7 EW |
586 | } |
587 | } | |
83b24437 RA |
588 | |
589 | # Usually don't need to change anything below here. | |
590 | ||
591 | # we make a "fake" message id by taking the current number | |
592 | # of seconds since the beginning of Unix time and tacking on | |
593 | # a random number to the end, in case we are called quicker than | |
594 | # 1 second since the last time we were called. | |
8037d1a3 RA |
595 | |
596 | # We'll setup a template for the message id, using the "from" address: | |
8037d1a3 | 597 | |
be510cfe | 598 | my ($message_id_stamp, $message_id_serial); |
83b24437 RA |
599 | sub make_message_id |
600 | { | |
be510cfe JH |
601 | my $uniq; |
602 | if (!defined $message_id_stamp) { | |
603 | $message_id_stamp = sprintf("%s-%s", time, $$); | |
604 | $message_id_serial = 0; | |
605 | } | |
606 | $message_id_serial++; | |
607 | $uniq = "$message_id_stamp-$message_id_serial"; | |
608 | ||
aeb59328 | 609 | my $du_part; |
94638f89 UKK |
610 | for ($sender, $repocommitter, $repoauthor) { |
611 | $du_part = extract_valid_address(sanitize_address($_)); | |
612 | last if (defined $du_part and $du_part ne ''); | |
aeb59328 | 613 | } |
94638f89 | 614 | if (not defined $du_part or $du_part eq '') { |
aeb59328 JH |
615 | use Sys::Hostname qw(); |
616 | $du_part = 'user@' . Sys::Hostname::hostname(); | |
617 | } | |
be510cfe JH |
618 | my $message_id_template = "<%s-git-send-email-%s>"; |
619 | $message_id = sprintf($message_id_template, $uniq, $du_part); | |
8037d1a3 | 620 | #print "new message id = $message_id\n"; # Was useful for debugging |
83b24437 RA |
621 | } |
622 | ||
623 | ||
624 | ||
a5370b16 | 625 | $time = time - scalar $#files; |
83b24437 | 626 | |
374c5905 JR |
627 | sub unquote_rfc2047 { |
628 | local ($_) = @_; | |
8291db6f JK |
629 | my $encoding; |
630 | if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) { | |
631 | $encoding = $1; | |
374c5905 JR |
632 | s/_/ /g; |
633 | s/=([0-9A-F]{2})/chr(hex($1))/eg; | |
634 | } | |
8291db6f | 635 | return wantarray ? ($_, $encoding) : $_; |
374c5905 JR |
636 | } |
637 | ||
d54eaaa2 JK |
638 | sub quote_rfc2047 { |
639 | local $_ = shift; | |
640 | my $encoding = shift || 'utf-8'; | |
641 | s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg; | |
642 | s/(.*)/=\?$encoding\?q\?$1\?=/; | |
643 | return $_; | |
644 | } | |
645 | ||
5b56aaa2 UKK |
646 | # use the simplest quoting being able to handle the recipient |
647 | sub sanitize_address | |
732263d4 RJ |
648 | { |
649 | my ($recipient) = @_; | |
5b56aaa2 UKK |
650 | my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/); |
651 | ||
652 | if (not $recipient_name) { | |
653 | return "$recipient"; | |
654 | } | |
655 | ||
656 | # if recipient_name is already quoted, do nothing | |
657 | if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) { | |
658 | return $recipient; | |
659 | } | |
660 | ||
661 | # rfc2047 is needed if a non-ascii char is included | |
662 | if ($recipient_name =~ /[^[:ascii:]]/) { | |
d54eaaa2 | 663 | $recipient_name = quote_rfc2047($recipient_name); |
732263d4 | 664 | } |
5b56aaa2 UKK |
665 | |
666 | # double quotes are needed if specials or CTLs are included | |
667 | elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) { | |
18023c20 | 668 | $recipient_name =~ s/(["\\\r])/\\$1/g; |
5b56aaa2 UKK |
669 | $recipient_name = "\"$recipient_name\""; |
670 | } | |
671 | ||
672 | return "$recipient_name $recipient_addr"; | |
673 | ||
732263d4 RJ |
674 | } |
675 | ||
83b24437 RA |
676 | sub send_message |
677 | { | |
4bc87a28 | 678 | my @recipients = unique_email_list(@to); |
7ac17529 ABH |
679 | @cc = (grep { my $cc = extract_valid_address($_); |
680 | not grep { $cc eq $_ } @recipients | |
681 | } | |
682 | map { sanitize_address($_) } | |
683 | @cc); | |
4bc87a28 | 684 | my $to = join (",\n\t", @recipients); |
58063245 | 685 | @recipients = unique_email_list(@recipients,@cc,@bcclist); |
c38f0247 | 686 | @recipients = (map { extract_valid_address($_) } @recipients); |
6bdca890 | 687 | my $date = format_2822_time($time++); |
e923effb ML |
688 | my $gitversion = '@@GIT_VERSION@@'; |
689 | if ($gitversion =~ m/..GIT_VERSION../) { | |
3cb8caf7 | 690 | $gitversion = Git::version(); |
e923effb | 691 | } |
4bc87a28 | 692 | |
af068d27 | 693 | my $cc = join(", ", unique_email_list(@cc)); |
f06a6a49 JH |
694 | my $ccline = ""; |
695 | if ($cc ne '') { | |
696 | $ccline = "\nCc: $cc"; | |
697 | } | |
94638f89 | 698 | my $sanitized_sender = sanitize_address($sender); |
4f3d3703 | 699 | make_message_id() unless defined($message_id); |
aeb59328 | 700 | |
94638f89 | 701 | my $header = "From: $sanitized_sender |
f06a6a49 | 702 | To: $to${ccline} |
4bc87a28 | 703 | Subject: $subject |
4bc87a28 EW |
704 | Date: $date |
705 | Message-Id: $message_id | |
e923effb | 706 | X-Mailer: git-send-email $gitversion |
4bc87a28 | 707 | "; |
5483c71d | 708 | if ($thread && $reply_to) { |
7ccf7927 RA |
709 | |
710 | $header .= "In-Reply-To: $reply_to\n"; | |
711 | $header .= "References: $references\n"; | |
712 | } | |
ce91c2f6 JH |
713 | if (@xh) { |
714 | $header .= join("\n", @xh) . "\n"; | |
715 | } | |
4bc87a28 | 716 | |
c38f0247 | 717 | my @sendmail_parameters = ('-i', @recipients); |
94638f89 | 718 | my $raw_from = $sanitized_sender; |
f073a592 RJ |
719 | $raw_from = $envelope_sender if (defined $envelope_sender); |
720 | $raw_from = extract_valid_address($raw_from); | |
721 | unshift (@sendmail_parameters, | |
722 | '-f', $raw_from) if(defined $envelope_sender); | |
8e3d436b | 723 | |
6130259c MW |
724 | if ($dry_run) { |
725 | # We don't want to send the email. | |
726 | } elsif ($smtp_server =~ m#^/#) { | |
aca7ad76 EW |
727 | my $pid = open my $sm, '|-'; |
728 | defined $pid or die $!; | |
729 | if (!$pid) { | |
8e3d436b | 730 | exec($smtp_server, @sendmail_parameters) or die $!; |
aca7ad76 EW |
731 | } |
732 | print $sm "$header\n$message"; | |
733 | close $sm or die $?; | |
734 | } else { | |
44b2476a JH |
735 | |
736 | if (!defined $smtp_server) { | |
737 | die "The required SMTP server is not properly defined." | |
738 | } | |
739 | ||
34cc60ce | 740 | if ($smtp_ssl) { |
44b2476a | 741 | $smtp_server_port ||= 465; # ssmtp |
34cc60ce | 742 | require Net::SMTP::SSL; |
44b2476a | 743 | $smtp ||= Net::SMTP::SSL->new($smtp_server, Port => $smtp_server_port); |
34cc60ce DS |
744 | } |
745 | else { | |
746 | require Net::SMTP; | |
44b2476a JH |
747 | $smtp ||= Net::SMTP->new((defined $smtp_server_port) |
748 | ? "$smtp_server:$smtp_server_port" | |
749 | : $smtp_server); | |
750 | } | |
751 | ||
752 | if (!$smtp) { | |
753 | die "Unable to initialize SMTP properly. Is there something wrong with your config?"; | |
754 | } | |
755 | ||
2363d746 MW |
756 | if (defined $smtp_authuser) { |
757 | ||
758 | if (!defined $smtp_authpass) { | |
759 | ||
760 | system "stty -echo"; | |
761 | ||
762 | do { | |
763 | print "Password: "; | |
764 | $_ = <STDIN>; | |
765 | print "\n"; | |
766 | } while (!defined $_); | |
767 | ||
768 | chomp($smtp_authpass = $_); | |
769 | ||
770 | system "stty echo"; | |
771 | } | |
772 | ||
5f5b6118 | 773 | $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message; |
34cc60ce | 774 | } |
2363d746 | 775 | |
2b69bfc2 | 776 | $smtp->mail( $raw_from ) or die $smtp->message; |
aca7ad76 EW |
777 | $smtp->to( @recipients ) or die $smtp->message; |
778 | $smtp->data or die $smtp->message; | |
779 | $smtp->datasend("$header\n$message") or die $smtp->message; | |
780 | $smtp->dataend() or die $smtp->message; | |
781 | $smtp->ok or die "Failed to send $subject\n".$smtp->message; | |
782 | } | |
2718435b | 783 | if ($quiet) { |
71c7da94 | 784 | printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject); |
2718435b | 785 | } else { |
b7f30e0a | 786 | print (($dry_run ? "Dry-" : "")."OK. Log says:\n"); |
2b69bfc2 | 787 | if ($smtp_server !~ m#^/#) { |
aca7ad76 | 788 | print "Server: $smtp_server\n"; |
2b69bfc2 RJ |
789 | print "MAIL FROM:<$raw_from>\n"; |
790 | print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n"; | |
aca7ad76 | 791 | } else { |
8e3d436b | 792 | print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n"; |
aca7ad76 | 793 | } |
b7f30e0a | 794 | print $header, "\n"; |
aca7ad76 EW |
795 | if ($smtp) { |
796 | print "Result: ", $smtp->code, ' ', | |
797 | ($smtp->message =~ /\n([^\n]+\n)$/s), "\n"; | |
798 | } else { | |
799 | print "Result: OK\n"; | |
800 | } | |
30d08b34 | 801 | } |
83b24437 RA |
802 | } |
803 | ||
83b24437 | 804 | $reply_to = $initial_reply_to; |
2186d566 | 805 | $references = $initial_reply_to || ''; |
83b24437 RA |
806 | $subject = $initial_subject; |
807 | ||
808 | foreach my $t (@files) { | |
83b24437 RA |
809 | open(F,"<",$t) or die "can't open file $t"; |
810 | ||
94638f89 | 811 | my $author = undef; |
8291db6f JK |
812 | my $author_encoding; |
813 | my $has_content_type; | |
814 | my $body_encoding; | |
da140f8b | 815 | @cc = @initial_cc; |
ce91c2f6 | 816 | @xh = (); |
e6b0964a | 817 | my $input_format = undef; |
83b24437 RA |
818 | my $header_done = 0; |
819 | $message = ""; | |
820 | while(<F>) { | |
821 | if (!$header_done) { | |
e6b0964a JH |
822 | if (/^From /) { |
823 | $input_format = 'mbox'; | |
824 | next; | |
825 | } | |
83b24437 | 826 | chomp; |
e6b0964a JH |
827 | if (!defined $input_format && /^[-A-Za-z]+:\s/) { |
828 | $input_format = 'mbox'; | |
829 | } | |
83b24437 | 830 | |
e6b0964a | 831 | if (defined $input_format && $input_format eq 'mbox') { |
83b24437 RA |
832 | if (/^Subject:\s+(.*)$/) { |
833 | $subject = $1; | |
834 | ||
835 | } elsif (/^(Cc|From):\s+(.*)$/) { | |
94638f89 | 836 | if (unquote_rfc2047($2) eq $sender) { |
65648283 | 837 | next if ($suppress_cc{'self'}); |
8a8e6235 | 838 | } |
68d42c41 | 839 | elsif ($1 eq 'From') { |
8291db6f JK |
840 | ($author, $author_encoding) |
841 | = unquote_rfc2047($2); | |
65648283 DB |
842 | next if ($suppress_cc{'author'}); |
843 | } else { | |
844 | next if ($suppress_cc{'cc'}); | |
8a8e6235 | 845 | } |
83b24437 | 846 | printf("(mbox) Adding cc: %s from line '%s'\n", |
2718435b | 847 | $2, $_) unless $quiet; |
83b24437 RA |
848 | push @cc, $2; |
849 | } | |
8291db6f JK |
850 | elsif (/^Content-type:/i) { |
851 | $has_content_type = 1; | |
852 | if (/charset="?[^ "]+/) { | |
853 | $body_encoding = $1; | |
854 | } | |
855 | push @xh, $_; | |
856 | } | |
4f3d3703 JK |
857 | elsif (/^Message-Id: (.*)/i) { |
858 | $message_id = $1; | |
859 | } | |
1d6a003a | 860 | elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) { |
ce91c2f6 JH |
861 | push @xh, $_; |
862 | } | |
83b24437 RA |
863 | |
864 | } else { | |
865 | # In the traditional | |
866 | # "send lots of email" format, | |
867 | # line 1 = cc | |
868 | # line 2 = subject | |
869 | # So let's support that, too. | |
e6b0964a | 870 | $input_format = 'lots'; |
65648283 | 871 | if (@cc == 0 && !$suppress_cc{'cc'}) { |
83b24437 | 872 | printf("(non-mbox) Adding cc: %s from line '%s'\n", |
2718435b | 873 | $_, $_) unless $quiet; |
83b24437 RA |
874 | |
875 | push @cc, $_; | |
876 | ||
877 | } elsif (!defined $subject) { | |
878 | $subject = $_; | |
879 | } | |
880 | } | |
5825e5b2 | 881 | |
83b24437 RA |
882 | # A whitespace line will terminate the headers |
883 | if (m/^\s*$/) { | |
884 | $header_done = 1; | |
885 | } | |
886 | } else { | |
887 | $message .= $_; | |
65648283 DB |
888 | if (/^(Signed-off-by|Cc): (.*)$/i) { |
889 | next if ($suppress_cc{'sob'}); | |
ba51795c | 890 | chomp; |
abec100c | 891 | my $c = $2; |
83b24437 | 892 | chomp $c; |
65648283 | 893 | next if ($c eq $sender and $suppress_cc{'self'}); |
83b24437 RA |
894 | push @cc, $c; |
895 | printf("(sob) Adding cc: %s from line '%s'\n", | |
2718435b | 896 | $c, $_) unless $quiet; |
83b24437 RA |
897 | } |
898 | } | |
899 | } | |
900 | close F; | |
324a8bd0 | 901 | |
65648283 | 902 | if (defined $cc_cmd && !$suppress_cc{'cccmd'}) { |
324a8bd0 JP |
903 | open(F, "$cc_cmd $t |") |
904 | or die "(cc-cmd) Could not execute '$cc_cmd'"; | |
905 | while(<F>) { | |
906 | my $c = $_; | |
907 | $c =~ s/^\s*//g; | |
908 | $c =~ s/\n$//g; | |
620bb245 | 909 | next if ($c eq $sender and $suppress_from); |
324a8bd0 JP |
910 | push @cc, $c; |
911 | printf("(cc-cmd) Adding cc: %s from: '%s'\n", | |
912 | $c, $cc_cmd) unless $quiet; | |
913 | } | |
914 | close F | |
915 | or die "(cc-cmd) failed to close pipe to '$cc_cmd'"; | |
916 | } | |
917 | ||
94638f89 UKK |
918 | if (defined $author) { |
919 | $message = "From: $author\n\n$message"; | |
8291db6f JK |
920 | if (defined $author_encoding) { |
921 | if ($has_content_type) { | |
922 | if ($body_encoding eq $author_encoding) { | |
923 | # ok, we already have the right encoding | |
924 | } | |
925 | else { | |
926 | # uh oh, we should re-encode | |
927 | } | |
928 | } | |
929 | else { | |
930 | push @xh, | |
931 | 'MIME-Version: 1.0', | |
8641ee3d JK |
932 | "Content-Type: text/plain; charset=$author_encoding", |
933 | 'Content-Transfer-Encoding: 8bit'; | |
8291db6f JK |
934 | } |
935 | } | |
8a8e6235 | 936 | } |
83b24437 | 937 | |
83b24437 RA |
938 | send_message(); |
939 | ||
940 | # set up for the next message | |
bc108f63 | 941 | if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) { |
78488b2c | 942 | $reply_to = $message_id; |
7ccf7927 | 943 | if (length $references > 0) { |
a925b89c | 944 | $references .= "\n $message_id"; |
7ccf7927 RA |
945 | } else { |
946 | $references = "$message_id"; | |
947 | } | |
78488b2c | 948 | } |
4f3d3703 | 949 | $message_id = undef; |
83b24437 | 950 | } |
e205735d | 951 | |
1f038a0c RA |
952 | if ($compose) { |
953 | cleanup_compose_files(); | |
954 | } | |
955 | ||
956 | sub cleanup_compose_files() { | |
957 | unlink($compose_filename, $compose_filename . ".final"); | |
958 | ||
959 | } | |
960 | ||
4bc87a28 | 961 | $smtp->quit if $smtp; |
e205735d RA |
962 | |
963 | sub unique_email_list(@) { | |
964 | my %seen; | |
965 | my @emails; | |
966 | ||
967 | foreach my $entry (@_) { | |
db3106b2 EW |
968 | if (my $clean = extract_valid_address($entry)) { |
969 | $seen{$clean} ||= 0; | |
970 | next if $seen{$clean}++; | |
971 | push @emails, $entry; | |
972 | } else { | |
973 | print STDERR "W: unable to extract a valid address", | |
974 | " from: $entry\n"; | |
975 | } | |
e205735d RA |
976 | } |
977 | return @emails; | |
978 | } | |
747bbff9 JK |
979 | |
980 | sub validate_patch { | |
981 | my $fn = shift; | |
982 | open(my $fh, '<', $fn) | |
983 | or die "unable to open $fn: $!\n"; | |
984 | while (my $line = <$fh>) { | |
985 | if (length($line) > 998) { | |
986 | return "$.: patch contains a line longer than 998 characters"; | |
987 | } | |
988 | } | |
989 | return undef; | |
990 | } | |
0706bd19 JK |
991 | |
992 | sub file_has_nonascii { | |
993 | my $fn = shift; | |
994 | open(my $fh, '<', $fn) | |
995 | or die "unable to open $fn: $!\n"; | |
996 | while (my $line = <$fh>) { | |
997 | return 1 if $line =~ /[^[:ascii:]]/; | |
998 | } | |
999 | return 0; | |
1000 | } |