git-send-email.perlon commit Merge branch 'jc/sha1' (b296990)
   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;
  24
  25package FakeTerm;
  26sub new {
  27        my ($class, $reason) = @_;
  28        return bless \$reason, shift;
  29}
  30sub readline {
  31        my $self = shift;
  32        die "Cannot use readline on FakeTerm: $$self";
  33}
  34package main;
  35
  36# most mail servers generate the Date: header, but not all...
  37$ENV{LC_ALL} = 'C';
  38use POSIX qw/strftime/;
  39
  40my $have_email_valid = eval { require Email::Valid; 1 };
  41my $smtp;
  42
  43sub unique_email_list(@);
  44sub cleanup_compose_files();
  45
  46# Constants (essentially)
  47my $compose_filename = ".msg.$$";
  48
  49# Variables we fill in automatically, or via prompting:
  50my (@to,@cc,@initial_cc,@bcclist,
  51        $initial_reply_to,$initial_subject,@files,$from,$compose,$time);
  52
  53# Behavior modification variables
  54my ($chain_reply_to, $quiet, $suppress_from, $no_signed_off_cc) = (1, 0, 0, 0);
  55my $smtp_server;
  56
  57# Example reply to:
  58#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
  59
  60my $term = eval {
  61        new Term::ReadLine 'git-send-email';
  62};
  63if ($@) {
  64        $term = new FakeTerm "$@: going non-interactive";
  65}
  66
  67# Begin by accumulating all the variables (defined above), that we will end up
  68# needing, first, from the command line:
  69
  70my $rc = GetOptions("from=s" => \$from,
  71                    "in-reply-to=s" => \$initial_reply_to,
  72                    "subject=s" => \$initial_subject,
  73                    "to=s" => \@to,
  74                    "cc=s" => \@initial_cc,
  75                    "bcc=s" => \@bcclist,
  76                    "chain-reply-to!" => \$chain_reply_to,
  77                    "smtp-server=s" => \$smtp_server,
  78                    "compose" => \$compose,
  79                    "quiet" => \$quiet,
  80                    "suppress-from" => \$suppress_from,
  81                    "no-signed-off-cc|no-signed-off-by-cc" => \$no_signed_off_cc,
  82         );
  83
  84# Verify the user input
  85
  86foreach my $entry (@to) {
  87        die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
  88}
  89
  90foreach my $entry (@initial_cc) {
  91        die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
  92}
  93
  94foreach my $entry (@bcclist) {
  95        die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
  96}
  97
  98# Now, let's fill any that aren't set in with defaults:
  99
 100sub gitvar {
 101    my ($var) = @_;
 102    my $fh;
 103    my $pid = open($fh, '-|');
 104    die "$!" unless defined $pid;
 105    if (!$pid) {
 106        exec('git-var', $var) or die "$!";
 107    }
 108    my ($val) = <$fh>;
 109    close $fh or die "$!";
 110    chomp($val);
 111    return $val;
 112}
 113
 114sub gitvar_ident {
 115    my ($name) = @_;
 116    my $val = gitvar($name);
 117    my @field = split(/\s+/, $val);
 118    return join(' ', @field[0...(@field-3)]);
 119}
 120
 121my ($author) = gitvar_ident('GIT_AUTHOR_IDENT');
 122my ($committer) = gitvar_ident('GIT_COMMITTER_IDENT');
 123
 124my %aliases;
 125chomp(my @alias_files = `git-repo-config --get-all sendemail.aliasesfile`);
 126chomp(my $aliasfiletype = `git-repo-config sendemail.aliasfiletype`);
 127my %parse_alias = (
 128        # multiline formats can be supported in the future
 129        mutt => sub { my $fh = shift; while (<$fh>) {
 130                if (/^alias\s+(\S+)\s+(.*)$/) {
 131                        my ($alias, $addr) = ($1, $2);
 132                        $addr =~ s/#.*$//; # mutt allows # comments
 133                         # commas delimit multiple addresses
 134                        $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
 135                }}},
 136        mailrc => sub { my $fh = shift; while (<$fh>) {
 137                if (/^alias\s+(\S+)\s+(.*)$/) {
 138                        # spaces delimit multiple addresses
 139                        $aliases{$1} = [ split(/\s+/, $2) ];
 140                }}},
 141        pine => sub { my $fh = shift; while (<$fh>) {
 142                if (/^(\S+)\s+(.*)$/) {
 143                        $aliases{$1} = [ split(/\s*,\s*/, $2) ];
 144                }}},
 145        gnus => sub { my $fh = shift; while (<$fh>) {
 146                if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
 147                        $aliases{$1} = [ $2 ];
 148                }}}
 149);
 150
 151if (@alias_files && defined $parse_alias{$aliasfiletype}) {
 152        foreach my $file (@alias_files) {
 153                open my $fh, '<', $file or die "opening $file: $!\n";
 154                $parse_alias{$aliasfiletype}->($fh);
 155                close $fh;
 156        }
 157}
 158
 159my $prompting = 0;
 160if (!defined $from) {
 161        $from = $author || $committer;
 162        do {
 163                $_ = $term->readline("Who should the emails appear to be from? ",
 164                        $from);
 165        } while (!defined $_);
 166
 167        $from = $_;
 168        print "Emails will be sent from: ", $from, "\n";
 169        $prompting++;
 170}
 171
 172if (!@to) {
 173        do {
 174                $_ = $term->readline("Who should the emails be sent to? ",
 175                                "");
 176        } while (!defined $_);
 177        my $to = $_;
 178        push @to, split /,/, $to;
 179        $prompting++;
 180}
 181
 182sub expand_aliases {
 183        my @cur = @_;
 184        my @last;
 185        do {
 186                @last = @cur;
 187                @cur = map { $aliases{$_} ? @{$aliases{$_}} : $_ } @last;
 188        } while (join(',',@cur) ne join(',',@last));
 189        return @cur;
 190}
 191
 192@to = expand_aliases(@to);
 193@initial_cc = expand_aliases(@initial_cc);
 194@bcclist = expand_aliases(@bcclist);
 195
 196if (!defined $initial_subject && $compose) {
 197        do {
 198                $_ = $term->readline("What subject should the emails start with? ",
 199                        $initial_subject);
 200        } while (!defined $_);
 201        $initial_subject = $_;
 202        $prompting++;
 203}
 204
 205if (!defined $initial_reply_to && $prompting) {
 206        do {
 207                $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
 208                        $initial_reply_to);
 209        } while (!defined $_);
 210
 211        $initial_reply_to = $_;
 212        $initial_reply_to =~ s/(^\s+|\s+$)//g;
 213}
 214
 215if (!$smtp_server) {
 216        foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
 217                if (-x $_) {
 218                        $smtp_server = $_;
 219                        last;
 220                }
 221        }
 222        $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
 223}
 224
 225if ($compose) {
 226        # Note that this does not need to be secure, but we will make a small
 227        # effort to have it be unique
 228        open(C,">",$compose_filename)
 229                or die "Failed to open for writing $compose_filename: $!";
 230        print C "From $from # This line is ignored.\n";
 231        printf C "Subject: %s\n\n", $initial_subject;
 232        printf C <<EOT;
 233GIT: Please enter your email below.
 234GIT: Lines beginning in "GIT: " will be removed.
 235GIT: Consider including an overall diffstat or table of contents
 236GIT: for the patch you are writing.
 237
 238EOT
 239        close(C);
 240
 241        my $editor = $ENV{EDITOR};
 242        $editor = 'vi' unless defined $editor;
 243        system($editor, $compose_filename);
 244
 245        open(C2,">",$compose_filename . ".final")
 246                or die "Failed to open $compose_filename.final : " . $!;
 247
 248        open(C,"<",$compose_filename)
 249                or die "Failed to open $compose_filename : " . $!;
 250
 251        while(<C>) {
 252                next if m/^GIT: /;
 253                print C2 $_;
 254        }
 255        close(C);
 256        close(C2);
 257
 258        do {
 259                $_ = $term->readline("Send this email? (y|n) ");
 260        } while (!defined $_);
 261
 262        if (uc substr($_,0,1) ne 'Y') {
 263                cleanup_compose_files();
 264                exit(0);
 265        }
 266
 267        @files = ($compose_filename . ".final");
 268}
 269
 270
 271# Now that all the defaults are set, process the rest of the command line
 272# arguments and collect up the files that need to be processed.
 273for my $f (@ARGV) {
 274        if (-d $f) {
 275                opendir(DH,$f)
 276                        or die "Failed to opendir $f: $!";
 277
 278                push @files, grep { -f $_ } map { +$f . "/" . $_ }
 279                                sort readdir(DH);
 280
 281        } elsif (-f $f) {
 282                push @files, $f;
 283
 284        } else {
 285                print STDERR "Skipping $f - not found.\n";
 286        }
 287}
 288
 289if (@files) {
 290        unless ($quiet) {
 291                print $_,"\n" for (@files);
 292        }
 293} else {
 294        print <<EOT;
 295git-send-email [options] <file | directory> [... file | directory ]
 296Options:
 297   --from         Specify the "From:" line of the email to be sent.
 298
 299   --to           Specify the primary "To:" line of the email.
 300
 301   --cc           Specify an initial "Cc:" list for the entire series
 302                  of emails.
 303
 304   --bcc          Specify a list of email addresses that should be Bcc:
 305                  on all the emails.
 306
 307   --compose      Use \$EDITOR to edit an introductory message for the
 308                  patch series.
 309
 310   --subject      Specify the initial "Subject:" line.
 311                  Only necessary if --compose is also set.  If --compose
 312                  is not set, this will be prompted for.
 313
 314   --in-reply-to  Specify the first "In-Reply-To:" header line.
 315                  Only used if --compose is also set.  If --compose is not
 316                  set, this will be prompted for.
 317
 318   --chain-reply-to If set, the replies will all be to the previous
 319                  email sent, rather than to the first email sent.
 320                  Defaults to on.
 321
 322   --no-signed-off-cc Suppress the automatic addition of email addresses
 323                 that appear in a Signed-off-by: line, to the cc: list.
 324                 Note: Using this option is not recommended.
 325
 326   --smtp-server  If set, specifies the outgoing SMTP server to use.
 327                  Defaults to localhost.
 328
 329  --suppress-from Supress sending emails to yourself if your address
 330                  appears in a From: line.
 331
 332   --quiet      Make git-send-email less verbose.  One line per email should be
 333                all that is output.
 334
 335Error: Please specify a file or a directory on the command line.
 336EOT
 337        exit(1);
 338}
 339
 340# Variables we set as part of the loop over files
 341our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message);
 342
 343sub extract_valid_address {
 344        my $address = shift;
 345        my $local_part_regexp = '[^<>"\s@]+';
 346        my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
 347
 348        # check for a local address:
 349        return $address if ($address =~ /^($local_part_regexp)$/);
 350
 351        if ($have_email_valid) {
 352                return scalar Email::Valid->address($address);
 353        } else {
 354                # less robust/correct than the monster regexp in Email::Valid,
 355                # but still does a 99% job, and one less dependency
 356                $address =~ /($local_part_regexp\@$domain_regexp)/;
 357                return $1;
 358        }
 359}
 360
 361# Usually don't need to change anything below here.
 362
 363# we make a "fake" message id by taking the current number
 364# of seconds since the beginning of Unix time and tacking on
 365# a random number to the end, in case we are called quicker than
 366# 1 second since the last time we were called.
 367
 368# We'll setup a template for the message id, using the "from" address:
 369my $message_id_from = extract_valid_address($from);
 370my $message_id_template = "<%s-git-send-email-$message_id_from>";
 371
 372sub make_message_id
 373{
 374        my $date = time;
 375        my $pseudo_rand = int (rand(4200));
 376        $message_id = sprintf $message_id_template, "$date$pseudo_rand";
 377        #print "new message id = $message_id\n"; # Was useful for debugging
 378}
 379
 380
 381
 382$cc = "";
 383$time = time - scalar $#files;
 384
 385sub send_message
 386{
 387        my @recipients = unique_email_list(@to);
 388        my $to = join (",\n\t", @recipients);
 389        @recipients = unique_email_list(@recipients,@cc,@bcclist);
 390        my $date = strftime('%a, %d %b %Y %H:%M:%S %z', localtime($time++));
 391        my $gitversion = '@@GIT_VERSION@@';
 392        if ($gitversion =~ m/..GIT_VERSION../) {
 393            $gitversion = `git --version`;
 394            chomp $gitversion;
 395            # keep only what's after the last space
 396            $gitversion =~ s/^.* //;
 397        }
 398
 399        my $header = "From: $from
 400To: $to
 401Cc: $cc
 402Subject: $subject
 403Reply-To: $from
 404Date: $date
 405Message-Id: $message_id
 406X-Mailer: git-send-email $gitversion
 407";
 408        if ($reply_to) {
 409
 410                $header .= "In-Reply-To: $reply_to\n";
 411                $header .= "References: $references\n";
 412        }
 413
 414        if ($smtp_server =~ m#^/#) {
 415                my $pid = open my $sm, '|-';
 416                defined $pid or die $!;
 417                if (!$pid) {
 418                        exec($smtp_server,'-i',
 419                             map { extract_valid_address($_) }
 420                             @recipients) or die $!;
 421                }
 422                print $sm "$header\n$message";
 423                close $sm or die $?;
 424        } else {
 425                require Net::SMTP;
 426                $smtp ||= Net::SMTP->new( $smtp_server );
 427                $smtp->mail( $from ) or die $smtp->message;
 428                $smtp->to( @recipients ) or die $smtp->message;
 429                $smtp->data or die $smtp->message;
 430                $smtp->datasend("$header\n$message") or die $smtp->message;
 431                $smtp->dataend() or die $smtp->message;
 432                $smtp->ok or die "Failed to send $subject\n".$smtp->message;
 433        }
 434        if ($quiet) {
 435                printf "Sent %s\n", $subject;
 436        } else {
 437                print "OK. Log says:\nDate: $date\n";
 438                if ($smtp) {
 439                        print "Server: $smtp_server\n";
 440                } else {
 441                        print "Sendmail: $smtp_server\n";
 442                }
 443                print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
 444                if ($smtp) {
 445                        print "Result: ", $smtp->code, ' ',
 446                                ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
 447                } else {
 448                        print "Result: OK\n";
 449                }
 450        }
 451}
 452
 453$reply_to = $initial_reply_to;
 454$references = $initial_reply_to || '';
 455make_message_id();
 456$subject = $initial_subject;
 457
 458foreach my $t (@files) {
 459        open(F,"<",$t) or die "can't open file $t";
 460
 461        my $author_not_sender = undef;
 462        @cc = @initial_cc;
 463        my $found_mbox = 0;
 464        my $header_done = 0;
 465        $message = "";
 466        while(<F>) {
 467                if (!$header_done) {
 468                        $found_mbox = 1, next if (/^From /);
 469                        chomp;
 470
 471                        if ($found_mbox) {
 472                                if (/^Subject:\s+(.*)$/) {
 473                                        $subject = $1;
 474
 475                                } elsif (/^(Cc|From):\s+(.*)$/) {
 476                                        if ($2 eq $from) {
 477                                                next if ($suppress_from);
 478                                        }
 479                                        else {
 480                                                $author_not_sender = $2;
 481                                        }
 482                                        printf("(mbox) Adding cc: %s from line '%s'\n",
 483                                                $2, $_) unless $quiet;
 484                                        push @cc, $2;
 485                                }
 486
 487                        } else {
 488                                # In the traditional
 489                                # "send lots of email" format,
 490                                # line 1 = cc
 491                                # line 2 = subject
 492                                # So let's support that, too.
 493                                if (@cc == 0) {
 494                                        printf("(non-mbox) Adding cc: %s from line '%s'\n",
 495                                                $_, $_) unless $quiet;
 496
 497                                        push @cc, $_;
 498
 499                                } elsif (!defined $subject) {
 500                                        $subject = $_;
 501                                }
 502                        }
 503
 504                        # A whitespace line will terminate the headers
 505                        if (m/^\s*$/) {
 506                                $header_done = 1;
 507                        }
 508                } else {
 509                        $message .=  $_;
 510                        if (/^Signed-off-by: (.*)$/i && !$no_signed_off_cc) {
 511                                my $c = $1;
 512                                chomp $c;
 513                                push @cc, $c;
 514                                printf("(sob) Adding cc: %s from line '%s'\n",
 515                                        $c, $_) unless $quiet;
 516                        }
 517                }
 518        }
 519        close F;
 520        if (defined $author_not_sender) {
 521                $message = "From: $author_not_sender\n\n$message";
 522        }
 523
 524        $cc = join(", ", unique_email_list(@cc));
 525
 526        send_message();
 527
 528        # set up for the next message
 529        if ($chain_reply_to || length($reply_to) == 0) {
 530                $reply_to = $message_id;
 531                if (length $references > 0) {
 532                        $references .= " $message_id";
 533                } else {
 534                        $references = "$message_id";
 535                }
 536        }
 537        make_message_id();
 538}
 539
 540if ($compose) {
 541        cleanup_compose_files();
 542}
 543
 544sub cleanup_compose_files() {
 545        unlink($compose_filename, $compose_filename . ".final");
 546
 547}
 548
 549$smtp->quit if $smtp;
 550
 551sub unique_email_list(@) {
 552        my %seen;
 553        my @emails;
 554
 555        foreach my $entry (@_) {
 556                if (my $clean = extract_valid_address($entry)) {
 557                        $seen{$clean} ||= 0;
 558                        next if $seen{$clean}++;
 559                        push @emails, $entry;
 560                } else {
 561                        print STDERR "W: unable to extract a valid address",
 562                                        " from: $entry\n";
 563                }
 564        }
 565        return @emails;
 566}