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