git-send-email.perlon commit Merge branch 'master' of git://git.kernel.org/pub/scm/gitk/gitk (f8db788)
   1#!/usr/bin/perl -w
   2#
   3# Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
   4# Copyright 2005 Ryan Anderson <ryan@michonline.com>
   5#
   6# GPL v2 (See COPYING)
   7#
   8# Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
   9#
  10# Sends a collection of emails to the given email addresses, disturbingly fast.
  11#
  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.
  17#
  18
  19use strict;
  20use warnings;
  21use Term::ReadLine;
  22use Getopt::Long;
  23use Data::Dumper;
  24use Git;
  25
  26package FakeTerm;
  27sub new {
  28        my ($class, $reason) = @_;
  29        return bless \$reason, shift;
  30}
  31sub readline {
  32        my $self = shift;
  33        die "Cannot use readline on FakeTerm: $$self";
  34}
  35package main;
  36
  37
  38sub usage {
  39        print <<EOT;
  40git-send-email [options] <file | directory>...
  41Options:
  42   --from         Specify the "From:" line of the email to be sent.
  43
  44   --to           Specify the primary "To:" line of the email.
  45
  46   --cc           Specify an initial "Cc:" list for the entire series
  47                  of emails.
  48
  49   --bcc          Specify a list of email addresses that should be Bcc:
  50                  on all the emails.
  51
  52   --compose      Use \$EDITOR to edit an introductory message for the
  53                  patch series.
  54
  55   --subject      Specify the initial "Subject:" line.
  56                  Only necessary if --compose is also set.  If --compose
  57                  is not set, this will be prompted for.
  58
  59   --in-reply-to  Specify the first "In-Reply-To:" header line.
  60                  Only used if --compose is also set.  If --compose is not
  61                  set, this will be prompted for.
  62
  63   --chain-reply-to If set, the replies will all be to the previous
  64                  email sent, rather than to the first email sent.
  65                  Defaults to on.
  66
  67   --signed-off-cc Automatically add email addresses that appear in
  68                 Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
  69
  70   --smtp-server  If set, specifies the outgoing SMTP server to use.
  71                  Defaults to localhost.
  72
  73   --suppress-from Suppress sending emails to yourself if your address
  74                  appears in a From: line. Defaults to off.
  75
  76   --thread       Specify that the "In-Reply-To:" header should be set on all
  77                  emails. Defaults to on.
  78
  79   --quiet        Make git-send-email less verbose.  One line per email
  80                  should be all that is output.
  81
  82   --dry-run      Do everything except actually send the emails.
  83
  84   --envelope-sender    Specify the envelope sender used to send the emails.
  85
  86EOT
  87        exit(1);
  88}
  89
  90# most mail servers generate the Date: header, but not all...
  91sub format_2822_time {
  92        my ($time) = @_;
  93        my @localtm = localtime($time);
  94        my @gmttm = gmtime($time);
  95        my $localmin = $localtm[1] + $localtm[2] * 60;
  96        my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
  97        if ($localtm[0] != $gmttm[0]) {
  98                die "local zone differs from GMT by a non-minute interval\n";
  99        }
 100        if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
 101                $localmin += 1440;
 102        } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
 103                $localmin -= 1440;
 104        } elsif ($gmttm[6] != $localtm[6]) {
 105                die "local time offset greater than or equal to 24 hours\n";
 106        }
 107        my $offset = $localmin - $gmtmin;
 108        my $offhour = $offset / 60;
 109        my $offmin = abs($offset % 60);
 110        if (abs($offhour) >= 24) {
 111                die ("local time offset greater than or equal to 24 hours\n");
 112        }
 113
 114        return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
 115                       qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
 116                       $localtm[3],
 117                       qw(Jan Feb Mar Apr May Jun
 118                          Jul Aug Sep Oct Nov Dec)[$localtm[4]],
 119                       $localtm[5]+1900,
 120                       $localtm[2],
 121                       $localtm[1],
 122                       $localtm[0],
 123                       ($offset >= 0) ? '+' : '-',
 124                       abs($offhour),
 125                       $offmin,
 126                       );
 127}
 128
 129my $have_email_valid = eval { require Email::Valid; 1 };
 130my $smtp;
 131
 132sub unique_email_list(@);
 133sub cleanup_compose_files();
 134
 135# Constants (essentially)
 136my $compose_filename = ".msg.$$";
 137
 138# Variables we fill in automatically, or via prompting:
 139my (@to,@cc,@initial_cc,@bcclist,@xh,
 140        $initial_reply_to,$initial_subject,@files,$from,$compose,$time);
 141
 142my $smtp_server;
 143my $envelope_sender;
 144
 145# Example reply to:
 146#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
 147
 148my $repo = Git->repository();
 149my $term = eval {
 150        new Term::ReadLine 'git-send-email';
 151};
 152if ($@) {
 153        $term = new FakeTerm "$@: going non-interactive";
 154}
 155
 156# Behavior modification variables
 157my ($quiet, $dry_run) = (0, 0);
 158
 159# Variables with corresponding config settings
 160my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc);
 161
 162my %config_settings = (
 163    "thread" => [\$thread, 1],
 164    "chainreplyto" => [\$chain_reply_to, 1],
 165    "suppressfrom" => [\$suppress_from, 0],
 166    "signedoffcc" => [\$signed_off_cc, 1],
 167);
 168
 169foreach my $setting (keys %config_settings) {
 170    my $config = $repo->config_bool("sendemail.$setting");
 171    ${$config_settings{$setting}->[0]} = (defined $config) ? $config : $config_settings{$setting}->[1];
 172}
 173
 174@bcclist = $repo->config('sendemail.bcc');
 175if (!@bcclist or !$bcclist[0]) {
 176    @bcclist = ();
 177}
 178
 179# Begin by accumulating all the variables (defined above), that we will end up
 180# needing, first, from the command line:
 181
 182my $rc = GetOptions("from=s" => \$from,
 183                    "in-reply-to=s" => \$initial_reply_to,
 184                    "subject=s" => \$initial_subject,
 185                    "to=s" => \@to,
 186                    "cc=s" => \@initial_cc,
 187                    "bcc=s" => \@bcclist,
 188                    "chain-reply-to!" => \$chain_reply_to,
 189                    "smtp-server=s" => \$smtp_server,
 190                    "compose" => \$compose,
 191                    "quiet" => \$quiet,
 192                    "suppress-from!" => \$suppress_from,
 193                    "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
 194                    "dry-run" => \$dry_run,
 195                    "envelope-sender=s" => \$envelope_sender,
 196                    "thread!" => \$thread,
 197         );
 198
 199unless ($rc) {
 200    usage();
 201}
 202
 203# Verify the user input
 204
 205foreach my $entry (@to) {
 206        die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
 207}
 208
 209foreach my $entry (@initial_cc) {
 210        die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
 211}
 212
 213foreach my $entry (@bcclist) {
 214        die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
 215}
 216
 217# Now, let's fill any that aren't set in with defaults:
 218
 219my ($author) = $repo->ident_person('author');
 220my ($committer) = $repo->ident_person('committer');
 221
 222my %aliases;
 223my @alias_files = $repo->config('sendemail.aliasesfile');
 224my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
 225my %parse_alias = (
 226        # multiline formats can be supported in the future
 227        mutt => sub { my $fh = shift; while (<$fh>) {
 228                if (/^\s*alias\s+(\S+)\s+(.*)$/) {
 229                        my ($alias, $addr) = ($1, $2);
 230                        $addr =~ s/#.*$//; # mutt allows # comments
 231                         # commas delimit multiple addresses
 232                        $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
 233                }}},
 234        mailrc => sub { my $fh = shift; while (<$fh>) {
 235                if (/^alias\s+(\S+)\s+(.*)$/) {
 236                        # spaces delimit multiple addresses
 237                        $aliases{$1} = [ split(/\s+/, $2) ];
 238                }}},
 239        pine => sub { my $fh = shift; while (<$fh>) {
 240                if (/^(\S+)\s+(.*)$/) {
 241                        $aliases{$1} = [ split(/\s*,\s*/, $2) ];
 242                }}},
 243        gnus => sub { my $fh = shift; while (<$fh>) {
 244                if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
 245                        $aliases{$1} = [ $2 ];
 246                }}}
 247);
 248
 249if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
 250        foreach my $file (@alias_files) {
 251                open my $fh, '<', $file or die "opening $file: $!\n";
 252                $parse_alias{$aliasfiletype}->($fh);
 253                close $fh;
 254        }
 255}
 256
 257($from) = expand_aliases($from) if defined $from;
 258
 259my $prompting = 0;
 260if (!defined $from) {
 261        $from = $author || $committer;
 262        do {
 263                $_ = $term->readline("Who should the emails appear to be from? [$from] ");
 264        } while (!defined $_);
 265
 266        $from = $_ if ($_);
 267        print "Emails will be sent from: ", $from, "\n";
 268        $prompting++;
 269}
 270
 271if (!@to) {
 272        do {
 273                $_ = $term->readline("Who should the emails be sent to? ",
 274                                "");
 275        } while (!defined $_);
 276        my $to = $_;
 277        push @to, split /,/, $to;
 278        $prompting++;
 279}
 280
 281sub expand_aliases {
 282        my @cur = @_;
 283        my @last;
 284        do {
 285                @last = @cur;
 286                @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
 287        } while (join(',',@cur) ne join(',',@last));
 288        return @cur;
 289}
 290
 291@to = expand_aliases(@to);
 292@to = (map { sanitize_address_rfc822($_) } @to);
 293@initial_cc = expand_aliases(@initial_cc);
 294@bcclist = expand_aliases(@bcclist);
 295
 296if (!defined $initial_subject && $compose) {
 297        do {
 298                $_ = $term->readline("What subject should the emails start with? ",
 299                        $initial_subject);
 300        } while (!defined $_);
 301        $initial_subject = $_;
 302        $prompting++;
 303}
 304
 305if ($thread && !defined $initial_reply_to && $prompting) {
 306        do {
 307                $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
 308                        $initial_reply_to);
 309        } while (!defined $_);
 310
 311        $initial_reply_to = $_;
 312        $initial_reply_to =~ s/(^\s+|\s+$)//g;
 313}
 314
 315if (!$smtp_server) {
 316        $smtp_server = $repo->config('sendemail.smtpserver');
 317}
 318if (!$smtp_server) {
 319        foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
 320                if (-x $_) {
 321                        $smtp_server = $_;
 322                        last;
 323                }
 324        }
 325        $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
 326}
 327
 328if ($compose) {
 329        # Note that this does not need to be secure, but we will make a small
 330        # effort to have it be unique
 331        open(C,">",$compose_filename)
 332                or die "Failed to open for writing $compose_filename: $!";
 333        print C "From $from # This line is ignored.\n";
 334        printf C "Subject: %s\n\n", $initial_subject;
 335        printf C <<EOT;
 336GIT: Please enter your email below.
 337GIT: Lines beginning in "GIT: " will be removed.
 338GIT: Consider including an overall diffstat or table of contents
 339GIT: for the patch you are writing.
 340
 341EOT
 342        close(C);
 343
 344        my $editor = $ENV{EDITOR};
 345        $editor = 'vi' unless defined $editor;
 346        system($editor, $compose_filename);
 347
 348        open(C2,">",$compose_filename . ".final")
 349                or die "Failed to open $compose_filename.final : " . $!;
 350
 351        open(C,"<",$compose_filename)
 352                or die "Failed to open $compose_filename : " . $!;
 353
 354        while(<C>) {
 355                next if m/^GIT: /;
 356                print C2 $_;
 357        }
 358        close(C);
 359        close(C2);
 360
 361        do {
 362                $_ = $term->readline("Send this email? (y|n) ");
 363        } while (!defined $_);
 364
 365        if (uc substr($_,0,1) ne 'Y') {
 366                cleanup_compose_files();
 367                exit(0);
 368        }
 369
 370        @files = ($compose_filename . ".final");
 371}
 372
 373
 374# Now that all the defaults are set, process the rest of the command line
 375# arguments and collect up the files that need to be processed.
 376for my $f (@ARGV) {
 377        if (-d $f) {
 378                opendir(DH,$f)
 379                        or die "Failed to opendir $f: $!";
 380
 381                push @files, grep { -f $_ } map { +$f . "/" . $_ }
 382                                sort readdir(DH);
 383
 384        } elsif (-f $f) {
 385                push @files, $f;
 386
 387        } else {
 388                print STDERR "Skipping $f - not found.\n";
 389        }
 390}
 391
 392if (@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
 401# Variables we set as part of the loop over files
 402our ($message_id, %mail, $subject, $reply_to, $references, $message);
 403
 404sub extract_valid_address {
 405        my $address = shift;
 406        my $local_part_regexp = '[^<>"\s@]+';
 407        my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
 408
 409        # check for a local address:
 410        return $address if ($address =~ /^($local_part_regexp)$/);
 411
 412        if ($have_email_valid) {
 413                return scalar Email::Valid->address($address);
 414        } else {
 415                # less robust/correct than the monster regexp in Email::Valid,
 416                # but still does a 99% job, and one less dependency
 417                $address =~ /($local_part_regexp\@$domain_regexp)/;
 418                return $1;
 419        }
 420}
 421
 422# Usually don't need to change anything below here.
 423
 424# we make a "fake" message id by taking the current number
 425# of seconds since the beginning of Unix time and tacking on
 426# a random number to the end, in case we are called quicker than
 427# 1 second since the last time we were called.
 428
 429# We'll setup a template for the message id, using the "from" address:
 430
 431sub make_message_id
 432{
 433        my $date = time;
 434        my $pseudo_rand = int (rand(4200));
 435        my $du_part;
 436        for ($from, $committer, $author) {
 437                $du_part = extract_valid_address($_);
 438                last if ($du_part ne '');
 439        }
 440        if ($du_part eq '') {
 441                use Sys::Hostname qw();
 442                $du_part = 'user@' . Sys::Hostname::hostname();
 443        }
 444        my $message_id_template = "<%s-git-send-email-$du_part>";
 445        $message_id = sprintf $message_id_template, "$date$pseudo_rand";
 446        #print "new message id = $message_id\n"; # Was useful for debugging
 447}
 448
 449
 450
 451$time = time - scalar $#files;
 452
 453sub unquote_rfc2047 {
 454        local ($_) = @_;
 455        if (s/=\?utf-8\?q\?(.*)\?=/$1/g) {
 456                s/_/ /g;
 457                s/=([0-9A-F]{2})/chr(hex($1))/eg;
 458        }
 459        return "$_";
 460}
 461
 462# If an address contains a . in the name portion, the name must be quoted.
 463sub sanitize_address_rfc822
 464{
 465        my ($recipient) = @_;
 466        my ($recipient_name) = ($recipient =~ /^(.*?)\s+</);
 467        if ($recipient_name && $recipient_name =~ /\./ && $recipient_name !~ /^".*"$/) {
 468                my ($name, $addr) = ($recipient =~ /^(.*?)(\s+<.*)/);
 469                $recipient = "\"$name\"$addr";
 470        }
 471        return $recipient;
 472}
 473
 474sub send_message
 475{
 476        my @recipients = unique_email_list(@to);
 477        @cc = (map { sanitize_address_rfc822($_) } @cc);
 478        my $to = join (",\n\t", @recipients);
 479        @recipients = unique_email_list(@recipients,@cc,@bcclist);
 480        @recipients = (map { extract_valid_address($_) } @recipients);
 481        my $date = format_2822_time($time++);
 482        my $gitversion = '@@GIT_VERSION@@';
 483        if ($gitversion =~ m/..GIT_VERSION../) {
 484            $gitversion = Git::version();
 485        }
 486
 487        my $cc = join(", ", unique_email_list(@cc));
 488        my $ccline = "";
 489        if ($cc ne '') {
 490                $ccline = "\nCc: $cc";
 491        }
 492        $from = sanitize_address_rfc822($from);
 493        make_message_id();
 494
 495        my $header = "From: $from
 496To: $to${ccline}
 497Subject: $subject
 498Date: $date
 499Message-Id: $message_id
 500X-Mailer: git-send-email $gitversion
 501";
 502        if ($thread && $reply_to) {
 503
 504                $header .= "In-Reply-To: $reply_to\n";
 505                $header .= "References: $references\n";
 506        }
 507        if (@xh) {
 508                $header .= join("\n", @xh) . "\n";
 509        }
 510
 511        my @sendmail_parameters = ('-i', @recipients);
 512        my $raw_from = $from;
 513        $raw_from = $envelope_sender if (defined $envelope_sender);
 514        $raw_from = extract_valid_address($raw_from);
 515        unshift (@sendmail_parameters,
 516                        '-f', $raw_from) if(defined $envelope_sender);
 517
 518        if ($dry_run) {
 519                # We don't want to send the email.
 520        } elsif ($smtp_server =~ m#^/#) {
 521                my $pid = open my $sm, '|-';
 522                defined $pid or die $!;
 523                if (!$pid) {
 524                        exec($smtp_server, @sendmail_parameters) or die $!;
 525                }
 526                print $sm "$header\n$message";
 527                close $sm or die $?;
 528        } else {
 529                require Net::SMTP;
 530                $smtp ||= Net::SMTP->new( $smtp_server );
 531                $smtp->mail( $raw_from ) or die $smtp->message;
 532                $smtp->to( @recipients ) or die $smtp->message;
 533                $smtp->data or die $smtp->message;
 534                $smtp->datasend("$header\n$message") or die $smtp->message;
 535                $smtp->dataend() or die $smtp->message;
 536                $smtp->ok or die "Failed to send $subject\n".$smtp->message;
 537        }
 538        if ($quiet) {
 539                printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
 540        } else {
 541                print (($dry_run ? "Dry-" : "")."OK. Log says:\nDate: $date\n");
 542                if ($smtp_server !~ m#^/#) {
 543                        print "Server: $smtp_server\n";
 544                        print "MAIL FROM:<$raw_from>\n";
 545                        print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
 546                } else {
 547                        print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
 548                }
 549                print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
 550                if ($smtp) {
 551                        print "Result: ", $smtp->code, ' ',
 552                                ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
 553                } else {
 554                        print "Result: OK\n";
 555                }
 556        }
 557}
 558
 559$reply_to = $initial_reply_to;
 560$references = $initial_reply_to || '';
 561$subject = $initial_subject;
 562
 563foreach my $t (@files) {
 564        open(F,"<",$t) or die "can't open file $t";
 565
 566        my $author_not_sender = undef;
 567        @cc = @initial_cc;
 568        @xh = ();
 569        my $input_format = undef;
 570        my $header_done = 0;
 571        $message = "";
 572        while(<F>) {
 573                if (!$header_done) {
 574                        if (/^From /) {
 575                                $input_format = 'mbox';
 576                                next;
 577                        }
 578                        chomp;
 579                        if (!defined $input_format && /^[-A-Za-z]+:\s/) {
 580                                $input_format = 'mbox';
 581                        }
 582
 583                        if (defined $input_format && $input_format eq 'mbox') {
 584                                if (/^Subject:\s+(.*)$/) {
 585                                        $subject = $1;
 586
 587                                } elsif (/^(Cc|From):\s+(.*)$/) {
 588                                        if (unquote_rfc2047($2) eq $from) {
 589                                                $from = $2;
 590                                                next if ($suppress_from);
 591                                        }
 592                                        elsif ($1 eq 'From') {
 593                                                $author_not_sender = $2;
 594                                        }
 595                                        printf("(mbox) Adding cc: %s from line '%s'\n",
 596                                                $2, $_) unless $quiet;
 597                                        push @cc, $2;
 598                                }
 599                                elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
 600                                        push @xh, $_;
 601                                }
 602
 603                        } else {
 604                                # In the traditional
 605                                # "send lots of email" format,
 606                                # line 1 = cc
 607                                # line 2 = subject
 608                                # So let's support that, too.
 609                                $input_format = 'lots';
 610                                if (@cc == 0) {
 611                                        printf("(non-mbox) Adding cc: %s from line '%s'\n",
 612                                                $_, $_) unless $quiet;
 613
 614                                        push @cc, $_;
 615
 616                                } elsif (!defined $subject) {
 617                                        $subject = $_;
 618                                }
 619                        }
 620
 621                        # A whitespace line will terminate the headers
 622                        if (m/^\s*$/) {
 623                                $header_done = 1;
 624                        }
 625                } else {
 626                        $message .=  $_;
 627                        if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
 628                                my $c = $2;
 629                                chomp $c;
 630                                push @cc, $c;
 631                                printf("(sob) Adding cc: %s from line '%s'\n",
 632                                        $c, $_) unless $quiet;
 633                        }
 634                }
 635        }
 636        close F;
 637        if (defined $author_not_sender) {
 638                $author_not_sender = unquote_rfc2047($author_not_sender);
 639                $message = "From: $author_not_sender\n\n$message";
 640        }
 641
 642
 643        send_message();
 644
 645        # set up for the next message
 646        if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
 647                $reply_to = $message_id;
 648                if (length $references > 0) {
 649                        $references .= "\n $message_id";
 650                } else {
 651                        $references = "$message_id";
 652                }
 653        }
 654}
 655
 656if ($compose) {
 657        cleanup_compose_files();
 658}
 659
 660sub cleanup_compose_files() {
 661        unlink($compose_filename, $compose_filename . ".final");
 662
 663}
 664
 665$smtp->quit if $smtp;
 666
 667sub unique_email_list(@) {
 668        my %seen;
 669        my @emails;
 670
 671        foreach my $entry (@_) {
 672                if (my $clean = extract_valid_address($entry)) {
 673                        $seen{$clean} ||= 0;
 674                        next if $seen{$clean}++;
 675                        push @emails, $entry;
 676                } else {
 677                        print STDERR "W: unable to extract a valid address",
 678                                        " from: $entry\n";
 679                }
 680        }
 681        return @emails;
 682}