]>
git.ipfire.org Git - thirdparty/git.git/blob - git-send-email.perl
3 # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4 # Copyright 2005 Ryan Anderson <ryan@michonline.com>
8 # Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
10 # Sends a collection of emails to the given email addresses, disturbingly fast.
12 # Supports two formats:
13 # 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches)
14 # 2. The original format support by Greg's script:
15 # first line of the message is who to CC,
16 # and second line is the subject of the message.
29 my ($class, $reason) = @_;
30 return bless \
$reason, shift;
34 die "Cannot use readline on FakeTerm: $$self";
41 git-send-email [options] <file | directory>...
43 --from Specify the "From:" line of the email to be sent.
45 --to Specify the primary "To:" line of the email.
47 --cc Specify an initial "Cc:" list for the entire series
50 --cc-cmd Specify a command to execute per file which adds
51 per file specific cc address entries
53 --bcc Specify a list of email addresses that should be Bcc:
56 --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
57 an introductory message for the patch series.
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.
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.
67 --chain-reply-to If set, the replies will all be to the previous
68 email sent, rather than to the first email sent.
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.
74 --identity The configuration identity, a subsection to prioritise over
77 --smtp-server If set, specifies the outgoing SMTP server to use.
78 Defaults to localhost. Port number can be specified here with
79 hostname:port format or by using --smtp-server-port option.
81 --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
83 --smtp-user The username for SMTP-AUTH.
85 --smtp-pass The password for SMTP-AUTH.
87 --smtp-ssl If set, connects to the SMTP server using SSL.
89 --suppress-from Suppress sending emails to yourself. Defaults to off.
91 --thread Specify that the "In-Reply-To:" header should be set on all
92 emails. Defaults to on.
94 --quiet Make git-send-email less verbose. One line per email
95 should be all that is output.
97 --dry-run Do everything except actually send the emails.
99 --envelope-sender Specify the envelope sender used to send the emails.
101 --no-validate Don't perform any sanity checks on patches.
107 # most mail servers generate the Date: header, but not all...
108 sub format_2822_time
{
110 my @localtm = localtime($time);
111 my @gmttm = gmtime($time);
112 my $localmin = $localtm[1] + $localtm[2] * 60;
113 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
114 if ($localtm[0] != $gmttm[0]) {
115 die "local zone differs from GMT by a non-minute interval\n";
117 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
119 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
121 } elsif ($gmttm[6] != $localtm[6]) {
122 die "local time offset greater than or equal to 24 hours\n";
124 my $offset = $localmin - $gmtmin;
125 my $offhour = $offset / 60;
126 my $offmin = abs($offset % 60);
127 if (abs($offhour) >= 24) {
128 die ("local time offset greater than or equal to 24 hours\n");
131 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
132 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
134 qw(Jan Feb Mar Apr May Jun
135 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
140 ($offset >= 0) ?
'+' : '-',
146 my $have_email_valid = eval { require Email
::Valid
; 1 };
150 sub unique_email_list
(@
);
151 sub cleanup_compose_files
();
153 # Constants (essentially)
154 my $compose_filename = ".msg.$$";
156 # Variables we fill in automatically, or via prompting:
157 my (@to,@cc,@initial_cc,@bcclist,@xh,
158 $initial_reply_to,$initial_subject,@files,$author,$sender,$smtp_authpass,$compose,$time);
163 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
165 my $repo = Git
->repository();
167 new Term
::ReadLine
'git-send-email';
170 $term = new FakeTerm
"$@: going non-interactive";
173 # Behavior modification variables
174 my ($quiet, $dry_run) = (0, 0);
176 # Variables with corresponding config settings
177 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
178 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_ssl);
179 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
182 my %config_bool_settings = (
183 "thread" => [\
$thread, 1],
184 "chainreplyto" => [\
$chain_reply_to, 1],
185 "suppressfrom" => [\
$suppress_from, 0],
186 "signedoffcc" => [\
$signed_off_cc, 1],
187 "smtpssl" => [\
$smtp_ssl, 0],
190 my %config_settings = (
191 "smtpserver" => \
$smtp_server,
192 "smtpserverport" => \
$smtp_server_port,
193 "smtpuser" => \
$smtp_authuser,
194 "smtppass" => \
$smtp_authpass,
197 "aliasfiletype" => \
$aliasfiletype,
199 "aliasesfile" => \
@alias_files,
202 # Handle Uncouth Termination
206 print color
("reset"), "\n";
208 # SMTP password masked
211 # tmp files from --compose
212 if (-e
$compose_filename) {
213 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
215 if (-e
($compose_filename . ".final")) {
216 print "'$compose_filename.final' contains the composed email.\n"
222 $SIG{TERM
} = \
&signal_handler
;
223 $SIG{INT
} = \
&signal_handler
;
225 # Begin by accumulating all the variables (defined above), that we will end up
226 # needing, first, from the command line:
228 my $rc = GetOptions
("sender|from=s" => \
$sender,
229 "in-reply-to=s" => \
$initial_reply_to,
230 "subject=s" => \
$initial_subject,
232 "cc=s" => \
@initial_cc,
233 "bcc=s" => \
@bcclist,
234 "chain-reply-to!" => \
$chain_reply_to,
235 "smtp-server=s" => \
$smtp_server,
236 "smtp-server-port=s" => \
$smtp_server_port,
237 "smtp-user=s" => \
$smtp_authuser,
238 "smtp-pass:s" => \
$smtp_authpass,
239 "smtp-ssl!" => \
$smtp_ssl,
240 "identity=s" => \
$identity,
241 "compose" => \
$compose,
243 "cc-cmd=s" => \
$cc_cmd,
244 "suppress-from!" => \
$suppress_from,
245 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_cc,
246 "dry-run" => \
$dry_run,
247 "envelope-sender=s" => \
$envelope_sender,
248 "thread!" => \
$thread,
249 "no-validate" => \
$no_validate,
256 # Now, let's fill any that aren't set in with defaults:
261 foreach my $setting (keys %config_bool_settings) {
262 my $target = $config_bool_settings{$setting}->[0];
263 $$target = $repo->config_bool("$prefix.$setting") unless (defined $$target);
266 foreach my $setting (keys %config_settings) {
267 my $target = $config_settings{$setting};
268 if (ref($target) eq "ARRAY") {
270 my @values = $repo->config("$prefix.$setting");
271 @
$target = @values if (@values && defined $values[0]);
275 $$target = $repo->config("$prefix.$setting") unless (defined $$target);
280 # read configuration from [sendemail "$identity"], fall back on [sendemail]
281 $identity = $repo->config("sendemail.identity") unless (defined $identity);
282 read_config
("sendemail.$identity") if (defined $identity);
283 read_config
("sendemail");
285 # fall back on builtin bool defaults
286 foreach my $setting (values %config_bool_settings) {
287 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
290 my ($repoauthor) = $repo->ident_person('author');
291 my ($repocommitter) = $repo->ident_person('committer');
293 # Verify the user input
295 foreach my $entry (@to) {
296 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
299 foreach my $entry (@initial_cc) {
300 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
303 foreach my $entry (@bcclist) {
304 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
309 # multiline formats can be supported in the future
310 mutt
=> sub { my $fh = shift; while (<$fh>) {
311 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
312 my ($alias, $addr) = ($1, $2);
313 $addr =~ s/#.*$//; # mutt allows # comments
314 # commas delimit multiple addresses
315 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
317 mailrc
=> sub { my $fh = shift; while (<$fh>) {
318 if (/^alias\s+(\S+)\s+(.*)$/) {
319 # spaces delimit multiple addresses
320 $aliases{$1} = [ split(/\s+/, $2) ];
322 pine
=> sub { my $fh = shift; while (<$fh>) {
323 if (/^(\S+)\t.*\t(.*)$/) {
324 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
326 gnus
=> sub { my $fh = shift; while (<$fh>) {
327 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
328 $aliases{$1} = [ $2 ];
332 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
333 foreach my $file (@alias_files) {
334 open my $fh, '<', $file or die "opening $file: $!\n";
335 $parse_alias{$aliasfiletype}->($fh);
340 ($sender) = expand_aliases
($sender) if defined $sender;
342 # Now that all the defaults are set, process the rest of the command line
343 # arguments and collect up the files that need to be processed.
347 or die "Failed to opendir $f: $!";
349 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
356 print STDERR
"Skipping $f - not found.\n";
361 foreach my $f (@files) {
362 my $error = validate_patch
($f);
363 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
369 print $_,"\n" for (@files);
372 print STDERR
"\nNo patch files specified!\n\n";
377 if (!defined $sender) {
378 $sender = $repoauthor || $repocommitter;
381 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
386 $sender = $_ if ($_);
387 print "Emails will be sent from: ", $sender, "\n";
395 $_ = $term->readline("Who should the emails be sent to? ", "");
401 push @to, split /,/, $to;
410 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
411 } while (join(',',@cur) ne join(',',@last));
415 @to = expand_aliases
(@to);
416 @to = (map { sanitize_address
($_) } @to);
417 @initial_cc = expand_aliases
(@initial_cc);
418 @bcclist = expand_aliases
(@bcclist);
420 if (!defined $initial_subject && $compose) {
422 $_ = $term->readline("What subject should the initial email start with? ", $initial_subject);
427 $initial_subject = $_;
431 if ($thread && !defined $initial_reply_to && $prompting) {
433 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ", $initial_reply_to);
438 $initial_reply_to = $_;
440 if (defined $initial_reply_to && $_ ne "") {
441 $initial_reply_to =~ s/^\s*<?/</;
442 $initial_reply_to =~ s/>?\s*$/>/;
445 if (!defined $smtp_server) {
446 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
452 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
456 # Note that this does not need to be secure, but we will make a small
457 # effort to have it be unique
458 open(C
,">",$compose_filename)
459 or die "Failed to open for writing $compose_filename: $!";
460 print C
"From $sender # This line is ignored.\n";
461 printf C
"Subject: %s\n\n", $initial_subject;
463 GIT: Please enter your email below.
464 GIT: Lines beginning in "GIT: " will be removed.
465 GIT: Consider including an overall diffstat or table of contents
466 GIT: for the patch you are writing.
471 my $editor = $ENV{GIT_EDITOR
} || $repo->config("core.editor") || $ENV{VISUAL
} || $ENV{EDITOR
} || "vi";
472 system('sh', '-c', '$0 $@', $editor, $compose_filename);
474 open(C2
,">",$compose_filename . ".final")
475 or die "Failed to open $compose_filename.final : " . $!;
477 open(C
,"<",$compose_filename)
478 or die "Failed to open $compose_filename : " . $!;
488 $_ = $term->readline("Send this email? (y|n) ");
493 if (uc substr($_,0,1) ne 'Y') {
494 cleanup_compose_files
();
498 @files = ($compose_filename . ".final", @files);
501 # Variables we set as part of the loop over files
502 our ($message_id, %mail, $subject, $reply_to, $references, $message);
504 sub extract_valid_address
{
506 my $local_part_regexp = '[^<>"\s@]+';
507 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
509 # check for a local address:
510 return $address if ($address =~ /^($local_part_regexp)$/);
512 $address =~ s/^\s*<(.*)>\s*$/$1/;
513 if ($have_email_valid) {
514 return scalar Email
::Valid
->address($address);
516 # less robust/correct than the monster regexp in Email::Valid,
517 # but still does a 99% job, and one less dependency
518 $address =~ /($local_part_regexp\@$domain_regexp)/;
523 # Usually don't need to change anything below here.
525 # we make a "fake" message id by taking the current number
526 # of seconds since the beginning of Unix time and tacking on
527 # a random number to the end, in case we are called quicker than
528 # 1 second since the last time we were called.
530 # We'll setup a template for the message id, using the "from" address:
532 my ($message_id_stamp, $message_id_serial);
536 if (!defined $message_id_stamp) {
537 $message_id_stamp = sprintf("%s-%s", time, $$);
538 $message_id_serial = 0;
540 $message_id_serial++;
541 $uniq = "$message_id_stamp-$message_id_serial";
544 for ($sender, $repocommitter, $repoauthor) {
545 $du_part = extract_valid_address
(sanitize_address
($_));
546 last if (defined $du_part and $du_part ne '');
548 if (not defined $du_part or $du_part eq '') {
549 use Sys
::Hostname
qw();
550 $du_part = 'user@' . Sys
::Hostname
::hostname
();
552 my $message_id_template = "<%s-git-send-email-%s>";
553 $message_id = sprintf($message_id_template, $uniq, $du_part);
554 #print "new message id = $message_id\n"; # Was useful for debugging
559 $time = time - scalar $#files;
561 sub unquote_rfc2047
{
564 if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
567 s/=([0-9A-F]{2})/chr(hex($1))/eg;
569 return wantarray ?
($_, $encoding) : $_;
572 # use the simplest quoting being able to handle the recipient
575 my ($recipient) = @_;
576 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
578 if (not $recipient_name) {
582 # if recipient_name is already quoted, do nothing
583 if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
587 # rfc2047 is needed if a non-ascii char is included
588 if ($recipient_name =~ /[^[:ascii:]]/) {
589 $recipient_name =~ s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
590 $recipient_name =~ s/(.*)/=\?utf-8\?q\?$1\?=/;
593 # double quotes are needed if specials or CTLs are included
594 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
595 $recipient_name =~ s/(["\\\r])/\\$1/;
596 $recipient_name = "\"$recipient_name\"";
599 return "$recipient_name $recipient_addr";
605 my @recipients = unique_email_list
(@to);
606 @cc = (grep { my $cc = extract_valid_address
($_);
607 not grep { $cc eq $_ } @recipients
609 map { sanitize_address
($_) }
611 my $to = join (",\n\t", @recipients);
612 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
613 @recipients = (map { extract_valid_address
($_) } @recipients);
614 my $date = format_2822_time
($time++);
615 my $gitversion = '@@GIT_VERSION@@';
616 if ($gitversion =~ m/..GIT_VERSION../) {
617 $gitversion = Git
::version
();
620 my $cc = join(", ", unique_email_list
(@cc));
623 $ccline = "\nCc: $cc";
625 my $sanitized_sender = sanitize_address
($sender);
626 make_message_id
() unless defined($message_id);
628 my $header = "From: $sanitized_sender
632 Message-Id: $message_id
633 X-Mailer: git-send-email $gitversion
635 if ($thread && $reply_to) {
637 $header .= "In-Reply-To: $reply_to\n";
638 $header .= "References: $references\n";
641 $header .= join("\n", @xh) . "\n";
644 my @sendmail_parameters = ('-i', @recipients);
645 my $raw_from = $sanitized_sender;
646 $raw_from = $envelope_sender if (defined $envelope_sender);
647 $raw_from = extract_valid_address
($raw_from);
648 unshift (@sendmail_parameters,
649 '-f', $raw_from) if(defined $envelope_sender);
652 # We don't want to send the email.
653 } elsif ($smtp_server =~ m
#^/#) {
654 my $pid = open my $sm, '|-';
655 defined $pid or die $!;
657 exec($smtp_server, @sendmail_parameters) or die $!;
659 print $sm "$header\n$message";
663 if (!defined $smtp_server) {
664 die "The required SMTP server is not properly defined."
668 $smtp_server_port ||= 465; # ssmtp
669 require Net
::SMTP
::SSL
;
670 $smtp ||= Net
::SMTP
::SSL
->new($smtp_server, Port
=> $smtp_server_port);
674 $smtp ||= Net
::SMTP
->new((defined $smtp_server_port)
675 ?
"$smtp_server:$smtp_server_port"
680 die "Unable to initialize SMTP properly. Is there something wrong with your config?";
683 if (defined $smtp_authuser) {
685 if (!defined $smtp_authpass) {
693 } while (!defined $_);
695 chomp($smtp_authpass = $_);
700 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
703 $smtp->mail( $raw_from ) or die $smtp->message;
704 $smtp->to( @recipients ) or die $smtp->message;
705 $smtp->data or die $smtp->message;
706 $smtp->datasend("$header\n$message") or die $smtp->message;
707 $smtp->dataend() or die $smtp->message;
708 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
711 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
713 print (($dry_run ?
"Dry-" : "")."OK. Log says:\n");
714 if ($smtp_server !~ m
#^/#) {
715 print "Server: $smtp_server\n";
716 print "MAIL FROM:<$raw_from>\n";
717 print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
719 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
723 print "Result: ", $smtp->code, ' ',
724 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
726 print "Result: OK\n";
731 $reply_to = $initial_reply_to;
732 $references = $initial_reply_to || '';
733 $subject = $initial_subject;
735 foreach my $t (@files) {
736 open(F
,"<",$t) or die "can't open file $t";
740 my $has_content_type;
744 my $input_format = undef;
750 $input_format = 'mbox';
754 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
755 $input_format = 'mbox';
758 if (defined $input_format && $input_format eq 'mbox') {
759 if (/^Subject:\s+(.*)$/) {
762 } elsif (/^(Cc|From):\s+(.*)$/) {
763 if (unquote_rfc2047
($2) eq $sender) {
764 next if ($suppress_from);
766 elsif ($1 eq 'From') {
767 ($author, $author_encoding)
768 = unquote_rfc2047
($2);
770 printf("(mbox) Adding cc: %s from line '%s'\n",
771 $2, $_) unless $quiet;
774 elsif (/^Content-type:/i) {
775 $has_content_type = 1;
776 if (/charset="?[^ "]+/) {
781 elsif (/^Message-Id: (.*)/i) {
784 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
790 # "send lots of email" format,
793 # So let's support that, too.
794 $input_format = 'lots';
796 printf("(non-mbox) Adding cc: %s from line '%s'\n",
797 $_, $_) unless $quiet;
801 } elsif (!defined $subject) {
806 # A whitespace line will terminate the headers
812 if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
815 next if ($c eq $sender and $suppress_from);
817 printf("(sob) Adding cc: %s from line '%s'\n",
818 $c, $_) unless $quiet;
824 if (defined $cc_cmd) {
825 open(F
, "$cc_cmd $t |")
826 or die "(cc-cmd) Could not execute '$cc_cmd'";
831 next if ($c eq $sender and $suppress_from);
833 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
834 $c, $cc_cmd) unless $quiet;
837 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
840 if (defined $author) {
841 $message = "From: $author\n\n$message";
842 if (defined $author_encoding) {
843 if ($has_content_type) {
844 if ($body_encoding eq $author_encoding) {
845 # ok, we already have the right encoding
848 # uh oh, we should re-encode
854 "Content-Type: text/plain; charset=$author_encoding",
855 'Content-Transfer-Encoding: 8bit';
862 # set up for the next message
863 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
864 $reply_to = $message_id;
865 if (length $references > 0) {
866 $references .= "\n $message_id";
868 $references = "$message_id";
875 cleanup_compose_files
();
878 sub cleanup_compose_files
() {
879 unlink($compose_filename, $compose_filename . ".final");
883 $smtp->quit if $smtp;
885 sub unique_email_list
(@
) {
889 foreach my $entry (@_) {
890 if (my $clean = extract_valid_address
($entry)) {
892 next if $seen{$clean}++;
893 push @emails, $entry;
895 print STDERR
"W: unable to extract a valid address",
904 open(my $fh, '<', $fn)
905 or die "unable to open $fn: $!\n";
906 while (my $line = <$fh>) {
907 if (length($line) > 998) {
908 return "$.: patch contains a line longer than 998 characters";