]>
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, |
9f7820ae | 212 | "envelopesender" => \$envelope_sender, |
34cc60ce | 213 | ); |
4a62d3f5 | 214 | |
87429976 MW |
215 | # Handle Uncouth Termination |
216 | sub signal_handler { | |
217 | ||
218 | # Make text normal | |
219 | print color("reset"), "\n"; | |
220 | ||
221 | # SMTP password masked | |
222 | system "stty echo"; | |
223 | ||
224 | # tmp files from --compose | |
225 | if (-e $compose_filename) { | |
226 | print "'$compose_filename' contains an intermediate version of the email you were composing.\n"; | |
227 | } | |
228 | if (-e ($compose_filename . ".final")) { | |
229 | print "'$compose_filename.final' contains the composed email.\n" | |
230 | } | |
231 | ||
232 | exit; | |
233 | }; | |
234 | ||
235 | $SIG{TERM} = \&signal_handler; | |
236 | $SIG{INT} = \&signal_handler; | |
237 | ||
83b24437 RA |
238 | # Begin by accumulating all the variables (defined above), that we will end up |
239 | # needing, first, from the command line: | |
240 | ||
94638f89 | 241 | my $rc = GetOptions("sender|from=s" => \$sender, |
83b24437 RA |
242 | "in-reply-to=s" => \$initial_reply_to, |
243 | "subject=s" => \$initial_subject, | |
244 | "to=s" => \@to, | |
da140f8b | 245 | "cc=s" => \@initial_cc, |
58063245 | 246 | "bcc=s" => \@bcclist, |
78488b2c | 247 | "chain-reply-to!" => \$chain_reply_to, |
3342d850 | 248 | "smtp-server=s" => \$smtp_server, |
44b2476a | 249 | "smtp-server-port=s" => \$smtp_server_port, |
34cc60ce | 250 | "smtp-user=s" => \$smtp_authuser, |
2363d746 | 251 | "smtp-pass:s" => \$smtp_authpass, |
34cc60ce DS |
252 | "smtp-ssl!" => \$smtp_ssl, |
253 | "identity=s" => \$identity, | |
1f038a0c | 254 | "compose" => \$compose, |
30d08b34 | 255 | "quiet" => \$quiet, |
324a8bd0 | 256 | "cc-cmd=s" => \$cc_cmd, |
5483c71d | 257 | "suppress-from!" => \$suppress_from, |
65648283 | 258 | "suppress-cc=s" => \@suppress_cc, |
5483c71d | 259 | "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc, |
6130259c | 260 | "dry-run" => \$dry_run, |
f073a592 | 261 | "envelope-sender=s" => \$envelope_sender, |
5483c71d | 262 | "thread!" => \$thread, |
c764a0c2 | 263 | "no-validate" => \$no_validate, |
83b24437 RA |
264 | ); |
265 | ||
1b0baf14 MC |
266 | unless ($rc) { |
267 | usage(); | |
268 | } | |
269 | ||
34cc60ce DS |
270 | # Now, let's fill any that aren't set in with defaults: |
271 | ||
272 | sub read_config { | |
273 | my ($prefix) = @_; | |
274 | ||
275 | foreach my $setting (keys %config_bool_settings) { | |
276 | my $target = $config_bool_settings{$setting}->[0]; | |
ad79c024 | 277 | $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target); |
34cc60ce DS |
278 | } |
279 | ||
280 | foreach my $setting (keys %config_settings) { | |
281 | my $target = $config_settings{$setting}; | |
282 | if (ref($target) eq "ARRAY") { | |
283 | unless (@$target) { | |
ad79c024 | 284 | my @values = Git::config(@repo, "$prefix.$setting"); |
34cc60ce DS |
285 | @$target = @values if (@values && defined $values[0]); |
286 | } | |
287 | } | |
288 | else { | |
ad79c024 | 289 | $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target); |
34cc60ce DS |
290 | } |
291 | } | |
292 | } | |
293 | ||
294 | # read configuration from [sendemail "$identity"], fall back on [sendemail] | |
ad79c024 | 295 | $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity); |
34cc60ce DS |
296 | read_config("sendemail.$identity") if (defined $identity); |
297 | read_config("sendemail"); | |
298 | ||
299 | # fall back on builtin bool defaults | |
300 | foreach my $setting (values %config_bool_settings) { | |
301 | ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]})); | |
302 | } | |
303 | ||
65648283 DB |
304 | # Set CC suppressions |
305 | my(%suppress_cc); | |
306 | if (@suppress_cc) { | |
307 | foreach my $entry (@suppress_cc) { | |
308 | die "Unknown --suppress-cc field: '$entry'\n" | |
309 | unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/; | |
310 | $suppress_cc{$entry} = 1; | |
311 | } | |
312 | } | |
313 | ||
314 | if ($suppress_cc{'all'}) { | |
315 | foreach my $entry (qw (ccmd cc author self sob)) { | |
316 | $suppress_cc{$entry} = 1; | |
317 | } | |
318 | delete $suppress_cc{'all'}; | |
319 | } | |
320 | ||
321 | # If explicit old-style ones are specified, they trump --suppress-cc. | |
322 | $suppress_cc{'self'} = $suppress_from if defined $suppress_from; | |
ba51795c | 323 | $suppress_cc{'sob'} = !$signed_off_cc if defined $signed_off_cc; |
65648283 DB |
324 | |
325 | # Debugging, print out the suppressions. | |
326 | if (0) { | |
327 | print "suppressions:\n"; | |
328 | foreach my $entry (keys %suppress_cc) { | |
329 | printf " %-5s -> $suppress_cc{$entry}\n", $entry; | |
330 | } | |
331 | } | |
332 | ||
ad79c024 FL |
333 | my ($repoauthor, $repocommitter); |
334 | ($repoauthor) = Git::ident_person(@repo, 'author'); | |
335 | ($repocommitter) = Git::ident_person(@repo, 'committer'); | |
34cc60ce | 336 | |
79ee555b EB |
337 | # Verify the user input |
338 | ||
339 | foreach my $entry (@to) { | |
340 | die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/; | |
341 | } | |
342 | ||
343 | foreach my $entry (@initial_cc) { | |
344 | die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/; | |
345 | } | |
346 | ||
347 | foreach my $entry (@bcclist) { | |
348 | die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/; | |
349 | } | |
350 | ||
994d6c66 | 351 | my %aliases; |
994d6c66 EW |
352 | my %parse_alias = ( |
353 | # multiline formats can be supported in the future | |
354 | mutt => sub { my $fh = shift; while (<$fh>) { | |
504ceab6 | 355 | if (/^\s*alias\s+(\S+)\s+(.*)$/) { |
994d6c66 EW |
356 | my ($alias, $addr) = ($1, $2); |
357 | $addr =~ s/#.*$//; # mutt allows # comments | |
358 | # commas delimit multiple addresses | |
359 | $aliases{$alias} = [ split(/\s*,\s*/, $addr) ]; | |
360 | }}}, | |
361 | mailrc => sub { my $fh = shift; while (<$fh>) { | |
362 | if (/^alias\s+(\S+)\s+(.*)$/) { | |
363 | # spaces delimit multiple addresses | |
364 | $aliases{$1} = [ split(/\s+/, $2) ]; | |
365 | }}}, | |
366 | pine => sub { my $fh = shift; while (<$fh>) { | |
2d8ae400 | 367 | if (/^(\S+)\t.*\t(.*)$/) { |
994d6c66 EW |
368 | $aliases{$1} = [ split(/\s*,\s*/, $2) ]; |
369 | }}}, | |
370 | gnus => sub { my $fh = shift; while (<$fh>) { | |
371 | if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) { | |
372 | $aliases{$1} = [ $2 ]; | |
373 | }}} | |
374 | ); | |
375 | ||
3cb8caf7 | 376 | if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) { |
994d6c66 EW |
377 | foreach my $file (@alias_files) { |
378 | open my $fh, '<', $file or die "opening $file: $!\n"; | |
379 | $parse_alias{$aliasfiletype}->($fh); | |
380 | close $fh; | |
381 | } | |
382 | } | |
383 | ||
94638f89 | 384 | ($sender) = expand_aliases($sender) if defined $sender; |
ae740a58 | 385 | |
aa54892f JK |
386 | # Now that all the defaults are set, process the rest of the command line |
387 | # arguments and collect up the files that need to be processed. | |
388 | for my $f (@ARGV) { | |
389 | if (-d $f) { | |
390 | opendir(DH,$f) | |
391 | or die "Failed to opendir $f: $!"; | |
392 | ||
393 | push @files, grep { -f $_ } map { +$f . "/" . $_ } | |
394 | sort readdir(DH); | |
395 | ||
396 | } elsif (-f $f) { | |
397 | push @files, $f; | |
398 | ||
399 | } else { | |
400 | print STDERR "Skipping $f - not found.\n"; | |
401 | } | |
402 | } | |
403 | ||
c764a0c2 JK |
404 | if (!$no_validate) { |
405 | foreach my $f (@files) { | |
406 | my $error = validate_patch($f); | |
407 | $error and die "fatal: $f: $error\nwarning: no patches were sent\n"; | |
408 | } | |
747bbff9 JK |
409 | } |
410 | ||
aa54892f JK |
411 | if (@files) { |
412 | unless ($quiet) { | |
413 | print $_,"\n" for (@files); | |
414 | } | |
415 | } else { | |
416 | print STDERR "\nNo patch files specified!\n\n"; | |
417 | usage(); | |
418 | } | |
419 | ||
1f038a0c | 420 | my $prompting = 0; |
94638f89 | 421 | if (!defined $sender) { |
ad79c024 | 422 | $sender = $repoauthor || $repocommitter || ''; |
8a7c56e1 MW |
423 | |
424 | while (1) { | |
94638f89 | 425 | $_ = $term->readline("Who should the emails appear to be from? [$sender] "); |
8a7c56e1 MW |
426 | last if defined $_; |
427 | print "\n"; | |
428 | } | |
8037d1a3 | 429 | |
94638f89 UKK |
430 | $sender = $_ if ($_); |
431 | print "Emails will be sent from: ", $sender, "\n"; | |
1f038a0c | 432 | $prompting++; |
83b24437 RA |
433 | } |
434 | ||
435 | if (!@to) { | |
8a7c56e1 MW |
436 | |
437 | ||
438 | while (1) { | |
439 | $_ = $term->readline("Who should the emails be sent to? ", ""); | |
440 | last if defined $_; | |
441 | print "\n"; | |
442 | } | |
443 | ||
83b24437 | 444 | my $to = $_; |
d1eb35b6 | 445 | push @to, split /,\s*/, $to; |
1f038a0c | 446 | $prompting++; |
83b24437 RA |
447 | } |
448 | ||
994d6c66 EW |
449 | sub expand_aliases { |
450 | my @cur = @_; | |
451 | my @last; | |
452 | do { | |
453 | @last = @cur; | |
454 | @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last; | |
455 | } while (join(',',@cur) ne join(',',@last)); | |
456 | return @cur; | |
457 | } | |
458 | ||
459 | @to = expand_aliases(@to); | |
5b56aaa2 | 460 | @to = (map { sanitize_address($_) } @to); |
994d6c66 | 461 | @initial_cc = expand_aliases(@initial_cc); |
58063245 | 462 | @bcclist = expand_aliases(@bcclist); |
994d6c66 | 463 | |
1f038a0c | 464 | if (!defined $initial_subject && $compose) { |
8a7c56e1 MW |
465 | while (1) { |
466 | $_ = $term->readline("What subject should the initial email start with? ", $initial_subject); | |
467 | last if defined $_; | |
468 | print "\n"; | |
469 | } | |
470 | ||
83b24437 | 471 | $initial_subject = $_; |
1f038a0c | 472 | $prompting++; |
83b24437 RA |
473 | } |
474 | ||
5483c71d | 475 | if ($thread && !defined $initial_reply_to && $prompting) { |
8a7c56e1 MW |
476 | while (1) { |
477 | $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ", $initial_reply_to); | |
478 | last if defined $_; | |
479 | print "\n"; | |
480 | } | |
8037d1a3 | 481 | |
83b24437 RA |
482 | $initial_reply_to = $_; |
483 | } | |
1ca3d6ed | 484 | if (defined $initial_reply_to) { |
0fb7fc75 JS |
485 | $initial_reply_to =~ s/^\s*<?//; |
486 | $initial_reply_to =~ s/>?\s*$//; | |
487 | $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne ''; | |
ace9c2a9 | 488 | } |
ace72086 | 489 | |
34cc60ce | 490 | if (!defined $smtp_server) { |
aca7ad76 EW |
491 | foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) { |
492 | if (-x $_) { | |
493 | $smtp_server = $_; | |
494 | last; | |
495 | } | |
496 | } | |
497 | $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug* | |
3342d850 RA |
498 | } |
499 | ||
1f038a0c RA |
500 | if ($compose) { |
501 | # Note that this does not need to be secure, but we will make a small | |
502 | # effort to have it be unique | |
503 | open(C,">",$compose_filename) | |
504 | or die "Failed to open for writing $compose_filename: $!"; | |
94638f89 | 505 | print C "From $sender # This line is ignored.\n"; |
1f038a0c RA |
506 | printf C "Subject: %s\n\n", $initial_subject; |
507 | printf C <<EOT; | |
508 | GIT: Please enter your email below. | |
509 | GIT: Lines beginning in "GIT: " will be removed. | |
510 | GIT: Consider including an overall diffstat or table of contents | |
511 | GIT: for the patch you are writing. | |
512 | ||
513 | EOT | |
514 | close(C); | |
515 | ||
ad79c024 | 516 | my $editor = $ENV{GIT_EDITOR} || Git::config(@repo, "core.editor") || $ENV{VISUAL} || $ENV{EDITOR} || "vi"; |
065096c2 | 517 | system('sh', '-c', $editor.' "$@"', $editor, $compose_filename); |
1f038a0c RA |
518 | |
519 | open(C2,">",$compose_filename . ".final") | |
520 | or die "Failed to open $compose_filename.final : " . $!; | |
521 | ||
522 | open(C,"<",$compose_filename) | |
523 | or die "Failed to open $compose_filename : " . $!; | |
524 | ||
0706bd19 JK |
525 | my $need_8bit_cte = file_has_nonascii($compose_filename); |
526 | my $in_body = 0; | |
1f038a0c RA |
527 | while(<C>) { |
528 | next if m/^GIT: /; | |
0706bd19 JK |
529 | if (!$in_body && /^\n$/) { |
530 | $in_body = 1; | |
531 | if ($need_8bit_cte) { | |
532 | print C2 "MIME-Version: 1.0\n", | |
533 | "Content-Type: text/plain; ", | |
534 | "charset=utf-8\n", | |
535 | "Content-Transfer-Encoding: 8bit\n"; | |
536 | } | |
537 | } | |
538 | if (!$in_body && /^MIME-Version:/i) { | |
539 | $need_8bit_cte = 0; | |
540 | } | |
d54eaaa2 JK |
541 | if (!$in_body && /^Subject: ?(.*)/i) { |
542 | my $subject = $1; | |
543 | $_ = "Subject: " . | |
544 | ($subject =~ /[^[:ascii:]]/ ? | |
545 | quote_rfc2047($subject) : | |
546 | $subject) . | |
547 | "\n"; | |
548 | } | |
1f038a0c RA |
549 | print C2 $_; |
550 | } | |
551 | close(C); | |
552 | close(C2); | |
553 | ||
8a7c56e1 | 554 | while (1) { |
1f038a0c | 555 | $_ = $term->readline("Send this email? (y|n) "); |
8a7c56e1 MW |
556 | last if defined $_; |
557 | print "\n"; | |
558 | } | |
1f038a0c RA |
559 | |
560 | if (uc substr($_,0,1) ne 'Y') { | |
561 | cleanup_compose_files(); | |
562 | exit(0); | |
563 | } | |
564 | ||
97394ee4 | 565 | @files = ($compose_filename . ".final", @files); |
1f038a0c RA |
566 | } |
567 | ||
83b24437 | 568 | # Variables we set as part of the loop over files |
af068d27 | 569 | our ($message_id, %mail, $subject, $reply_to, $references, $message); |
83b24437 | 570 | |
567ffeb7 EW |
571 | sub extract_valid_address { |
572 | my $address = shift; | |
ad9c18f5 | 573 | my $local_part_regexp = '[^<>"\s@]+'; |
09302e17 | 574 | my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+'; |
db3106b2 EW |
575 | |
576 | # check for a local address: | |
ad9c18f5 | 577 | return $address if ($address =~ /^($local_part_regexp)$/); |
db3106b2 | 578 | |
155197e6 | 579 | $address =~ s/^\s*<(.*)>\s*$/$1/; |
567ffeb7 | 580 | if ($have_email_valid) { |
ad9c18f5 | 581 | return scalar Email::Valid->address($address); |
567ffeb7 EW |
582 | } else { |
583 | # less robust/correct than the monster regexp in Email::Valid, | |
584 | # but still does a 99% job, and one less dependency | |
ad9c18f5 | 585 | $address =~ /($local_part_regexp\@$domain_regexp)/; |
e96fd305 | 586 | return $1; |
567ffeb7 EW |
587 | } |
588 | } | |
83b24437 RA |
589 | |
590 | # Usually don't need to change anything below here. | |
591 | ||
592 | # we make a "fake" message id by taking the current number | |
593 | # of seconds since the beginning of Unix time and tacking on | |
594 | # a random number to the end, in case we are called quicker than | |
595 | # 1 second since the last time we were called. | |
8037d1a3 RA |
596 | |
597 | # We'll setup a template for the message id, using the "from" address: | |
8037d1a3 | 598 | |
be510cfe | 599 | my ($message_id_stamp, $message_id_serial); |
83b24437 RA |
600 | sub make_message_id |
601 | { | |
be510cfe JH |
602 | my $uniq; |
603 | if (!defined $message_id_stamp) { | |
604 | $message_id_stamp = sprintf("%s-%s", time, $$); | |
605 | $message_id_serial = 0; | |
606 | } | |
607 | $message_id_serial++; | |
608 | $uniq = "$message_id_stamp-$message_id_serial"; | |
609 | ||
aeb59328 | 610 | my $du_part; |
94638f89 UKK |
611 | for ($sender, $repocommitter, $repoauthor) { |
612 | $du_part = extract_valid_address(sanitize_address($_)); | |
613 | last if (defined $du_part and $du_part ne ''); | |
aeb59328 | 614 | } |
94638f89 | 615 | if (not defined $du_part or $du_part eq '') { |
aeb59328 JH |
616 | use Sys::Hostname qw(); |
617 | $du_part = 'user@' . Sys::Hostname::hostname(); | |
618 | } | |
be510cfe JH |
619 | my $message_id_template = "<%s-git-send-email-%s>"; |
620 | $message_id = sprintf($message_id_template, $uniq, $du_part); | |
8037d1a3 | 621 | #print "new message id = $message_id\n"; # Was useful for debugging |
83b24437 RA |
622 | } |
623 | ||
624 | ||
625 | ||
a5370b16 | 626 | $time = time - scalar $#files; |
83b24437 | 627 | |
374c5905 JR |
628 | sub unquote_rfc2047 { |
629 | local ($_) = @_; | |
8291db6f JK |
630 | my $encoding; |
631 | if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) { | |
632 | $encoding = $1; | |
374c5905 JR |
633 | s/_/ /g; |
634 | s/=([0-9A-F]{2})/chr(hex($1))/eg; | |
635 | } | |
8291db6f | 636 | return wantarray ? ($_, $encoding) : $_; |
374c5905 JR |
637 | } |
638 | ||
d54eaaa2 JK |
639 | sub quote_rfc2047 { |
640 | local $_ = shift; | |
641 | my $encoding = shift || 'utf-8'; | |
642 | s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg; | |
643 | s/(.*)/=\?$encoding\?q\?$1\?=/; | |
644 | return $_; | |
645 | } | |
646 | ||
5b56aaa2 UKK |
647 | # use the simplest quoting being able to handle the recipient |
648 | sub sanitize_address | |
732263d4 RJ |
649 | { |
650 | my ($recipient) = @_; | |
5b56aaa2 UKK |
651 | my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/); |
652 | ||
653 | if (not $recipient_name) { | |
654 | return "$recipient"; | |
655 | } | |
656 | ||
657 | # if recipient_name is already quoted, do nothing | |
658 | if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) { | |
659 | return $recipient; | |
660 | } | |
661 | ||
662 | # rfc2047 is needed if a non-ascii char is included | |
663 | if ($recipient_name =~ /[^[:ascii:]]/) { | |
d54eaaa2 | 664 | $recipient_name = quote_rfc2047($recipient_name); |
732263d4 | 665 | } |
5b56aaa2 UKK |
666 | |
667 | # double quotes are needed if specials or CTLs are included | |
668 | elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) { | |
18023c20 | 669 | $recipient_name =~ s/(["\\\r])/\\$1/g; |
5b56aaa2 UKK |
670 | $recipient_name = "\"$recipient_name\""; |
671 | } | |
672 | ||
673 | return "$recipient_name $recipient_addr"; | |
674 | ||
732263d4 RJ |
675 | } |
676 | ||
83b24437 RA |
677 | sub send_message |
678 | { | |
4bc87a28 | 679 | my @recipients = unique_email_list(@to); |
7ac17529 ABH |
680 | @cc = (grep { my $cc = extract_valid_address($_); |
681 | not grep { $cc eq $_ } @recipients | |
682 | } | |
683 | map { sanitize_address($_) } | |
684 | @cc); | |
4bc87a28 | 685 | my $to = join (",\n\t", @recipients); |
58063245 | 686 | @recipients = unique_email_list(@recipients,@cc,@bcclist); |
c38f0247 | 687 | @recipients = (map { extract_valid_address($_) } @recipients); |
6bdca890 | 688 | my $date = format_2822_time($time++); |
e923effb ML |
689 | my $gitversion = '@@GIT_VERSION@@'; |
690 | if ($gitversion =~ m/..GIT_VERSION../) { | |
3cb8caf7 | 691 | $gitversion = Git::version(); |
e923effb | 692 | } |
4bc87a28 | 693 | |
af068d27 | 694 | my $cc = join(", ", unique_email_list(@cc)); |
f06a6a49 JH |
695 | my $ccline = ""; |
696 | if ($cc ne '') { | |
697 | $ccline = "\nCc: $cc"; | |
698 | } | |
94638f89 | 699 | my $sanitized_sender = sanitize_address($sender); |
4f3d3703 | 700 | make_message_id() unless defined($message_id); |
aeb59328 | 701 | |
94638f89 | 702 | my $header = "From: $sanitized_sender |
f06a6a49 | 703 | To: $to${ccline} |
4bc87a28 | 704 | Subject: $subject |
4bc87a28 EW |
705 | Date: $date |
706 | Message-Id: $message_id | |
e923effb | 707 | X-Mailer: git-send-email $gitversion |
4bc87a28 | 708 | "; |
5483c71d | 709 | if ($thread && $reply_to) { |
7ccf7927 RA |
710 | |
711 | $header .= "In-Reply-To: $reply_to\n"; | |
712 | $header .= "References: $references\n"; | |
713 | } | |
ce91c2f6 JH |
714 | if (@xh) { |
715 | $header .= join("\n", @xh) . "\n"; | |
716 | } | |
4bc87a28 | 717 | |
c38f0247 | 718 | my @sendmail_parameters = ('-i', @recipients); |
94638f89 | 719 | my $raw_from = $sanitized_sender; |
f073a592 RJ |
720 | $raw_from = $envelope_sender if (defined $envelope_sender); |
721 | $raw_from = extract_valid_address($raw_from); | |
722 | unshift (@sendmail_parameters, | |
723 | '-f', $raw_from) if(defined $envelope_sender); | |
8e3d436b | 724 | |
6130259c MW |
725 | if ($dry_run) { |
726 | # We don't want to send the email. | |
727 | } elsif ($smtp_server =~ m#^/#) { | |
aca7ad76 EW |
728 | my $pid = open my $sm, '|-'; |
729 | defined $pid or die $!; | |
730 | if (!$pid) { | |
8e3d436b | 731 | exec($smtp_server, @sendmail_parameters) or die $!; |
aca7ad76 EW |
732 | } |
733 | print $sm "$header\n$message"; | |
734 | close $sm or die $?; | |
735 | } else { | |
44b2476a JH |
736 | |
737 | if (!defined $smtp_server) { | |
738 | die "The required SMTP server is not properly defined." | |
739 | } | |
740 | ||
34cc60ce | 741 | if ($smtp_ssl) { |
44b2476a | 742 | $smtp_server_port ||= 465; # ssmtp |
34cc60ce | 743 | require Net::SMTP::SSL; |
44b2476a | 744 | $smtp ||= Net::SMTP::SSL->new($smtp_server, Port => $smtp_server_port); |
34cc60ce DS |
745 | } |
746 | else { | |
747 | require Net::SMTP; | |
44b2476a JH |
748 | $smtp ||= Net::SMTP->new((defined $smtp_server_port) |
749 | ? "$smtp_server:$smtp_server_port" | |
750 | : $smtp_server); | |
751 | } | |
752 | ||
753 | if (!$smtp) { | |
754 | die "Unable to initialize SMTP properly. Is there something wrong with your config?"; | |
755 | } | |
756 | ||
2363d746 MW |
757 | if (defined $smtp_authuser) { |
758 | ||
759 | if (!defined $smtp_authpass) { | |
760 | ||
761 | system "stty -echo"; | |
762 | ||
763 | do { | |
764 | print "Password: "; | |
765 | $_ = <STDIN>; | |
766 | print "\n"; | |
767 | } while (!defined $_); | |
768 | ||
769 | chomp($smtp_authpass = $_); | |
770 | ||
771 | system "stty echo"; | |
772 | } | |
773 | ||
5f5b6118 | 774 | $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message; |
34cc60ce | 775 | } |
2363d746 | 776 | |
2b69bfc2 | 777 | $smtp->mail( $raw_from ) or die $smtp->message; |
aca7ad76 EW |
778 | $smtp->to( @recipients ) or die $smtp->message; |
779 | $smtp->data or die $smtp->message; | |
780 | $smtp->datasend("$header\n$message") or die $smtp->message; | |
781 | $smtp->dataend() or die $smtp->message; | |
782 | $smtp->ok or die "Failed to send $subject\n".$smtp->message; | |
783 | } | |
2718435b | 784 | if ($quiet) { |
71c7da94 | 785 | printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject); |
2718435b | 786 | } else { |
b7f30e0a | 787 | print (($dry_run ? "Dry-" : "")."OK. Log says:\n"); |
2b69bfc2 | 788 | if ($smtp_server !~ m#^/#) { |
aca7ad76 | 789 | print "Server: $smtp_server\n"; |
2b69bfc2 RJ |
790 | print "MAIL FROM:<$raw_from>\n"; |
791 | print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n"; | |
aca7ad76 | 792 | } else { |
8e3d436b | 793 | print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n"; |
aca7ad76 | 794 | } |
b7f30e0a | 795 | print $header, "\n"; |
aca7ad76 EW |
796 | if ($smtp) { |
797 | print "Result: ", $smtp->code, ' ', | |
798 | ($smtp->message =~ /\n([^\n]+\n)$/s), "\n"; | |
799 | } else { | |
800 | print "Result: OK\n"; | |
801 | } | |
30d08b34 | 802 | } |
83b24437 RA |
803 | } |
804 | ||
83b24437 | 805 | $reply_to = $initial_reply_to; |
2186d566 | 806 | $references = $initial_reply_to || ''; |
83b24437 RA |
807 | $subject = $initial_subject; |
808 | ||
809 | foreach my $t (@files) { | |
83b24437 RA |
810 | open(F,"<",$t) or die "can't open file $t"; |
811 | ||
94638f89 | 812 | my $author = undef; |
8291db6f JK |
813 | my $author_encoding; |
814 | my $has_content_type; | |
815 | my $body_encoding; | |
da140f8b | 816 | @cc = @initial_cc; |
ce91c2f6 | 817 | @xh = (); |
e6b0964a | 818 | my $input_format = undef; |
83b24437 RA |
819 | my $header_done = 0; |
820 | $message = ""; | |
821 | while(<F>) { | |
822 | if (!$header_done) { | |
e6b0964a JH |
823 | if (/^From /) { |
824 | $input_format = 'mbox'; | |
825 | next; | |
826 | } | |
83b24437 | 827 | chomp; |
e6b0964a JH |
828 | if (!defined $input_format && /^[-A-Za-z]+:\s/) { |
829 | $input_format = 'mbox'; | |
830 | } | |
83b24437 | 831 | |
e6b0964a | 832 | if (defined $input_format && $input_format eq 'mbox') { |
83b24437 RA |
833 | if (/^Subject:\s+(.*)$/) { |
834 | $subject = $1; | |
835 | ||
836 | } elsif (/^(Cc|From):\s+(.*)$/) { | |
94638f89 | 837 | if (unquote_rfc2047($2) eq $sender) { |
65648283 | 838 | next if ($suppress_cc{'self'}); |
8a8e6235 | 839 | } |
68d42c41 | 840 | elsif ($1 eq 'From') { |
8291db6f JK |
841 | ($author, $author_encoding) |
842 | = unquote_rfc2047($2); | |
65648283 DB |
843 | next if ($suppress_cc{'author'}); |
844 | } else { | |
845 | next if ($suppress_cc{'cc'}); | |
8a8e6235 | 846 | } |
83b24437 | 847 | printf("(mbox) Adding cc: %s from line '%s'\n", |
2718435b | 848 | $2, $_) unless $quiet; |
83b24437 RA |
849 | push @cc, $2; |
850 | } | |
8291db6f JK |
851 | elsif (/^Content-type:/i) { |
852 | $has_content_type = 1; | |
8892048d | 853 | if (/charset="?([^ "]+)/) { |
8291db6f JK |
854 | $body_encoding = $1; |
855 | } | |
856 | push @xh, $_; | |
857 | } | |
4f3d3703 JK |
858 | elsif (/^Message-Id: (.*)/i) { |
859 | $message_id = $1; | |
860 | } | |
1d6a003a | 861 | elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) { |
ce91c2f6 JH |
862 | push @xh, $_; |
863 | } | |
83b24437 RA |
864 | |
865 | } else { | |
866 | # In the traditional | |
867 | # "send lots of email" format, | |
868 | # line 1 = cc | |
869 | # line 2 = subject | |
870 | # So let's support that, too. | |
e6b0964a | 871 | $input_format = 'lots'; |
65648283 | 872 | if (@cc == 0 && !$suppress_cc{'cc'}) { |
83b24437 | 873 | printf("(non-mbox) Adding cc: %s from line '%s'\n", |
2718435b | 874 | $_, $_) unless $quiet; |
83b24437 RA |
875 | |
876 | push @cc, $_; | |
877 | ||
878 | } elsif (!defined $subject) { | |
879 | $subject = $_; | |
880 | } | |
881 | } | |
5825e5b2 | 882 | |
83b24437 RA |
883 | # A whitespace line will terminate the headers |
884 | if (m/^\s*$/) { | |
885 | $header_done = 1; | |
886 | } | |
887 | } else { | |
888 | $message .= $_; | |
65648283 DB |
889 | if (/^(Signed-off-by|Cc): (.*)$/i) { |
890 | next if ($suppress_cc{'sob'}); | |
ba51795c | 891 | chomp; |
abec100c | 892 | my $c = $2; |
83b24437 | 893 | chomp $c; |
65648283 | 894 | next if ($c eq $sender and $suppress_cc{'self'}); |
83b24437 RA |
895 | push @cc, $c; |
896 | printf("(sob) Adding cc: %s from line '%s'\n", | |
2718435b | 897 | $c, $_) unless $quiet; |
83b24437 RA |
898 | } |
899 | } | |
900 | } | |
901 | close F; | |
324a8bd0 | 902 | |
65648283 | 903 | if (defined $cc_cmd && !$suppress_cc{'cccmd'}) { |
324a8bd0 JP |
904 | open(F, "$cc_cmd $t |") |
905 | or die "(cc-cmd) Could not execute '$cc_cmd'"; | |
906 | while(<F>) { | |
907 | my $c = $_; | |
908 | $c =~ s/^\s*//g; | |
909 | $c =~ s/\n$//g; | |
620bb245 | 910 | next if ($c eq $sender and $suppress_from); |
324a8bd0 JP |
911 | push @cc, $c; |
912 | printf("(cc-cmd) Adding cc: %s from: '%s'\n", | |
913 | $c, $cc_cmd) unless $quiet; | |
914 | } | |
915 | close F | |
916 | or die "(cc-cmd) failed to close pipe to '$cc_cmd'"; | |
917 | } | |
918 | ||
94638f89 UKK |
919 | if (defined $author) { |
920 | $message = "From: $author\n\n$message"; | |
8291db6f JK |
921 | if (defined $author_encoding) { |
922 | if ($has_content_type) { | |
923 | if ($body_encoding eq $author_encoding) { | |
924 | # ok, we already have the right encoding | |
925 | } | |
926 | else { | |
927 | # uh oh, we should re-encode | |
928 | } | |
929 | } | |
930 | else { | |
931 | push @xh, | |
932 | 'MIME-Version: 1.0', | |
8641ee3d JK |
933 | "Content-Type: text/plain; charset=$author_encoding", |
934 | 'Content-Transfer-Encoding: 8bit'; | |
8291db6f JK |
935 | } |
936 | } | |
8a8e6235 | 937 | } |
83b24437 | 938 | |
83b24437 RA |
939 | send_message(); |
940 | ||
941 | # set up for the next message | |
bc108f63 | 942 | if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) { |
78488b2c | 943 | $reply_to = $message_id; |
7ccf7927 | 944 | if (length $references > 0) { |
a925b89c | 945 | $references .= "\n $message_id"; |
7ccf7927 RA |
946 | } else { |
947 | $references = "$message_id"; | |
948 | } | |
78488b2c | 949 | } |
4f3d3703 | 950 | $message_id = undef; |
83b24437 | 951 | } |
e205735d | 952 | |
1f038a0c RA |
953 | if ($compose) { |
954 | cleanup_compose_files(); | |
955 | } | |
956 | ||
957 | sub cleanup_compose_files() { | |
958 | unlink($compose_filename, $compose_filename . ".final"); | |
959 | ||
960 | } | |
961 | ||
4bc87a28 | 962 | $smtp->quit if $smtp; |
e205735d RA |
963 | |
964 | sub unique_email_list(@) { | |
965 | my %seen; | |
966 | my @emails; | |
967 | ||
968 | foreach my $entry (@_) { | |
db3106b2 EW |
969 | if (my $clean = extract_valid_address($entry)) { |
970 | $seen{$clean} ||= 0; | |
971 | next if $seen{$clean}++; | |
972 | push @emails, $entry; | |
973 | } else { | |
974 | print STDERR "W: unable to extract a valid address", | |
975 | " from: $entry\n"; | |
976 | } | |
e205735d RA |
977 | } |
978 | return @emails; | |
979 | } | |
747bbff9 JK |
980 | |
981 | sub validate_patch { | |
982 | my $fn = shift; | |
983 | open(my $fh, '<', $fn) | |
984 | or die "unable to open $fn: $!\n"; | |
985 | while (my $line = <$fh>) { | |
986 | if (length($line) > 998) { | |
987 | return "$.: patch contains a line longer than 998 characters"; | |
988 | } | |
989 | } | |
990 | return undef; | |
991 | } | |
0706bd19 JK |
992 | |
993 | sub file_has_nonascii { | |
994 | my $fn = shift; | |
995 | open(my $fh, '<', $fn) | |
996 | or die "unable to open $fn: $!\n"; | |
997 | while (my $line = <$fh>) { | |
998 | return 1 if $line =~ /[^[:ascii:]]/; | |
999 | } | |
1000 | return 0; | |
1001 | } |