git-send-email.perlon commit t6111: new TREESAME test set (abdea96)
   1#!/usr/bin/perl
   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 5.008;
  20use strict;
  21use warnings;
  22use Term::ReadLine;
  23use Getopt::Long;
  24use Text::ParseWords;
  25use Data::Dumper;
  26use Term::ANSIColor;
  27use File::Temp qw/ tempdir tempfile /;
  28use File::Spec::Functions qw(catfile);
  29use Error qw(:try);
  30use Git;
  31
  32Getopt::Long::Configure qw/ pass_through /;
  33
  34package FakeTerm;
  35sub new {
  36        my ($class, $reason) = @_;
  37        return bless \$reason, shift;
  38}
  39sub readline {
  40        my $self = shift;
  41        die "Cannot use readline on FakeTerm: $$self";
  42}
  43package main;
  44
  45
  46sub usage {
  47        print <<EOT;
  48git send-email [options] <file | directory | rev-list options >
  49
  50  Composing:
  51    --from                  <str>  * Email From:
  52    --[no-]to               <str>  * Email To:
  53    --[no-]cc               <str>  * Email Cc:
  54    --[no-]bcc              <str>  * Email Bcc:
  55    --subject               <str>  * Email "Subject:"
  56    --in-reply-to           <str>  * Email "In-Reply-To:"
  57    --[no-]annotate                * Review each patch that will be sent in an editor.
  58    --compose                      * Open an editor for introduction.
  59    --compose-encoding      <str>  * Encoding to assume for introduction.
  60    --8bit-encoding         <str>  * Encoding to assume 8bit mails if undeclared
  61
  62  Sending:
  63    --envelope-sender       <str>  * Email envelope sender.
  64    --smtp-server       <str:int>  * Outgoing SMTP server to use. The port
  65                                     is optional. Default 'localhost'.
  66    --smtp-server-option    <str>  * Outgoing SMTP server option to use.
  67    --smtp-server-port      <int>  * Outgoing SMTP server port.
  68    --smtp-user             <str>  * Username for SMTP-AUTH.
  69    --smtp-pass             <str>  * Password for SMTP-AUTH; not necessary.
  70    --smtp-encryption       <str>  * tls or ssl; anything else disables.
  71    --smtp-ssl                     * Deprecated. Use '--smtp-encryption ssl'.
  72    --smtp-domain           <str>  * The domain name sent to HELO/EHLO handshake
  73    --smtp-debug            <0|1>  * Disable, enable Net::SMTP debug.
  74
  75  Automating:
  76    --identity              <str>  * Use the sendemail.<id> options.
  77    --to-cmd                <str>  * Email To: via `<str> \$patch_path`
  78    --cc-cmd                <str>  * Email Cc: via `<str> \$patch_path`
  79    --suppress-cc           <str>  * author, self, sob, cc, cccmd, body, bodycc, all.
  80    --[no-]signed-off-by-cc        * Send to Signed-off-by: addresses. Default on.
  81    --[no-]suppress-from           * Send to self. Default off.
  82    --[no-]chain-reply-to          * Chain In-Reply-To: fields. Default off.
  83    --[no-]thread                  * Use In-Reply-To: field. Default on.
  84
  85  Administering:
  86    --confirm               <str>  * Confirm recipients before sending;
  87                                     auto, cc, compose, always, or never.
  88    --quiet                        * Output one line of info per email.
  89    --dry-run                      * Don't actually send the emails.
  90    --[no-]validate                * Perform patch sanity checks. Default on.
  91    --[no-]format-patch            * understand any non optional arguments as
  92                                     `git format-patch` ones.
  93    --force                        * Send even if safety checks would prevent it.
  94
  95EOT
  96        exit(1);
  97}
  98
  99# most mail servers generate the Date: header, but not all...
 100sub format_2822_time {
 101        my ($time) = @_;
 102        my @localtm = localtime($time);
 103        my @gmttm = gmtime($time);
 104        my $localmin = $localtm[1] + $localtm[2] * 60;
 105        my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
 106        if ($localtm[0] != $gmttm[0]) {
 107                die "local zone differs from GMT by a non-minute interval\n";
 108        }
 109        if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
 110                $localmin += 1440;
 111        } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
 112                $localmin -= 1440;
 113        } elsif ($gmttm[6] != $localtm[6]) {
 114                die "local time offset greater than or equal to 24 hours\n";
 115        }
 116        my $offset = $localmin - $gmtmin;
 117        my $offhour = $offset / 60;
 118        my $offmin = abs($offset % 60);
 119        if (abs($offhour) >= 24) {
 120                die ("local time offset greater than or equal to 24 hours\n");
 121        }
 122
 123        return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
 124                       qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
 125                       $localtm[3],
 126                       qw(Jan Feb Mar Apr May Jun
 127                          Jul Aug Sep Oct Nov Dec)[$localtm[4]],
 128                       $localtm[5]+1900,
 129                       $localtm[2],
 130                       $localtm[1],
 131                       $localtm[0],
 132                       ($offset >= 0) ? '+' : '-',
 133                       abs($offhour),
 134                       $offmin,
 135                       );
 136}
 137
 138my $have_email_valid = eval { require Email::Valid; 1 };
 139my $have_mail_address = eval { require Mail::Address; 1 };
 140my $smtp;
 141my $auth;
 142
 143# Variables we fill in automatically, or via prompting:
 144my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
 145        $initial_reply_to,$initial_subject,@files,
 146        $author,$sender,$smtp_authpass,$annotate,$compose,$time);
 147
 148my $envelope_sender;
 149
 150# Example reply to:
 151#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
 152
 153my $repo = eval { Git->repository() };
 154my @repo = $repo ? ($repo) : ();
 155my $term = eval {
 156        $ENV{"GIT_SEND_EMAIL_NOTTY"}
 157                ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
 158                : new Term::ReadLine 'git-send-email';
 159};
 160if ($@) {
 161        $term = new FakeTerm "$@: going non-interactive";
 162}
 163
 164# Behavior modification variables
 165my ($quiet, $dry_run) = (0, 0);
 166my $format_patch;
 167my $compose_filename;
 168my $force = 0;
 169
 170# Handle interactive edition of files.
 171my $multiedit;
 172my $editor;
 173
 174sub do_edit {
 175        if (!defined($editor)) {
 176                $editor = Git::command_oneline('var', 'GIT_EDITOR');
 177        }
 178        if (defined($multiedit) && !$multiedit) {
 179                map {
 180                        system('sh', '-c', $editor.' "$@"', $editor, $_);
 181                        if (($? & 127) || ($? >> 8)) {
 182                                die("the editor exited uncleanly, aborting everything");
 183                        }
 184                } @_;
 185        } else {
 186                system('sh', '-c', $editor.' "$@"', $editor, @_);
 187                if (($? & 127) || ($? >> 8)) {
 188                        die("the editor exited uncleanly, aborting everything");
 189                }
 190        }
 191}
 192
 193# Variables with corresponding config settings
 194my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
 195my ($to_cmd, $cc_cmd);
 196my ($smtp_server, $smtp_server_port, @smtp_server_options);
 197my ($smtp_authuser, $smtp_encryption);
 198my ($identity, $aliasfiletype, @alias_files, $smtp_domain);
 199my ($validate, $confirm);
 200my (@suppress_cc);
 201my ($auto_8bit_encoding);
 202my ($compose_encoding);
 203
 204my ($debug_net_smtp) = 0;               # Net::SMTP, see send_message()
 205
 206my $not_set_by_user = "true but not set by the user";
 207
 208my %config_bool_settings = (
 209    "thread" => [\$thread, 1],
 210    "chainreplyto" => [\$chain_reply_to, $not_set_by_user],
 211    "suppressfrom" => [\$suppress_from, undef],
 212    "signedoffbycc" => [\$signed_off_by_cc, undef],
 213    "signedoffcc" => [\$signed_off_by_cc, undef],      # Deprecated
 214    "validate" => [\$validate, 1],
 215    "multiedit" => [\$multiedit, undef],
 216    "annotate" => [\$annotate, undef]
 217);
 218
 219my %config_settings = (
 220    "smtpserver" => \$smtp_server,
 221    "smtpserverport" => \$smtp_server_port,
 222    "smtpserveroption" => \@smtp_server_options,
 223    "smtpuser" => \$smtp_authuser,
 224    "smtppass" => \$smtp_authpass,
 225    "smtpdomain" => \$smtp_domain,
 226    "to" => \@initial_to,
 227    "tocmd" => \$to_cmd,
 228    "cc" => \@initial_cc,
 229    "cccmd" => \$cc_cmd,
 230    "aliasfiletype" => \$aliasfiletype,
 231    "bcc" => \@bcclist,
 232    "suppresscc" => \@suppress_cc,
 233    "envelopesender" => \$envelope_sender,
 234    "confirm"   => \$confirm,
 235    "from" => \$sender,
 236    "assume8bitencoding" => \$auto_8bit_encoding,
 237    "composeencoding" => \$compose_encoding,
 238);
 239
 240my %config_path_settings = (
 241    "aliasesfile" => \@alias_files,
 242);
 243
 244# Help users prepare for 1.7.0
 245sub chain_reply_to {
 246        if (defined $chain_reply_to &&
 247            $chain_reply_to eq $not_set_by_user) {
 248                print STDERR
 249                    "In git 1.7.0, the default has changed to --no-chain-reply-to\n" .
 250                    "Set sendemail.chainreplyto configuration variable to true if\n" .
 251                    "you want to keep --chain-reply-to as your default.\n";
 252                $chain_reply_to = 0;
 253        }
 254        return $chain_reply_to;
 255}
 256
 257# Handle Uncouth Termination
 258sub signal_handler {
 259
 260        # Make text normal
 261        print color("reset"), "\n";
 262
 263        # SMTP password masked
 264        system "stty echo";
 265
 266        # tmp files from --compose
 267        if (defined $compose_filename) {
 268                if (-e $compose_filename) {
 269                        print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
 270                }
 271                if (-e ($compose_filename . ".final")) {
 272                        print "'$compose_filename.final' contains the composed email.\n"
 273                }
 274        }
 275
 276        exit;
 277};
 278
 279$SIG{TERM} = \&signal_handler;
 280$SIG{INT}  = \&signal_handler;
 281
 282# Begin by accumulating all the variables (defined above), that we will end up
 283# needing, first, from the command line:
 284
 285my $help;
 286my $rc = GetOptions("h" => \$help,
 287                    "sender|from=s" => \$sender,
 288                    "in-reply-to=s" => \$initial_reply_to,
 289                    "subject=s" => \$initial_subject,
 290                    "to=s" => \@initial_to,
 291                    "to-cmd=s" => \$to_cmd,
 292                    "no-to" => \$no_to,
 293                    "cc=s" => \@initial_cc,
 294                    "no-cc" => \$no_cc,
 295                    "bcc=s" => \@bcclist,
 296                    "no-bcc" => \$no_bcc,
 297                    "chain-reply-to!" => \$chain_reply_to,
 298                    "smtp-server=s" => \$smtp_server,
 299                    "smtp-server-option=s" => \@smtp_server_options,
 300                    "smtp-server-port=s" => \$smtp_server_port,
 301                    "smtp-user=s" => \$smtp_authuser,
 302                    "smtp-pass:s" => \$smtp_authpass,
 303                    "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
 304                    "smtp-encryption=s" => \$smtp_encryption,
 305                    "smtp-debug:i" => \$debug_net_smtp,
 306                    "smtp-domain:s" => \$smtp_domain,
 307                    "identity=s" => \$identity,
 308                    "annotate!" => \$annotate,
 309                    "compose" => \$compose,
 310                    "quiet" => \$quiet,
 311                    "cc-cmd=s" => \$cc_cmd,
 312                    "suppress-from!" => \$suppress_from,
 313                    "suppress-cc=s" => \@suppress_cc,
 314                    "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
 315                    "confirm=s" => \$confirm,
 316                    "dry-run" => \$dry_run,
 317                    "envelope-sender=s" => \$envelope_sender,
 318                    "thread!" => \$thread,
 319                    "validate!" => \$validate,
 320                    "format-patch!" => \$format_patch,
 321                    "8bit-encoding=s" => \$auto_8bit_encoding,
 322                    "compose-encoding=s" => \$compose_encoding,
 323                    "force" => \$force,
 324         );
 325
 326usage() if $help;
 327unless ($rc) {
 328    usage();
 329}
 330
 331die "Cannot run git format-patch from outside a repository\n"
 332        if $format_patch and not $repo;
 333
 334# Now, let's fill any that aren't set in with defaults:
 335
 336sub read_config {
 337        my ($prefix) = @_;
 338
 339        foreach my $setting (keys %config_bool_settings) {
 340                my $target = $config_bool_settings{$setting}->[0];
 341                $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
 342        }
 343
 344        foreach my $setting (keys %config_path_settings) {
 345                my $target = $config_path_settings{$setting};
 346                if (ref($target) eq "ARRAY") {
 347                        unless (@$target) {
 348                                my @values = Git::config_path(@repo, "$prefix.$setting");
 349                                @$target = @values if (@values && defined $values[0]);
 350                        }
 351                }
 352                else {
 353                        $$target = Git::config_path(@repo, "$prefix.$setting") unless (defined $$target);
 354                }
 355        }
 356
 357        foreach my $setting (keys %config_settings) {
 358                my $target = $config_settings{$setting};
 359                next if $setting eq "to" and defined $no_to;
 360                next if $setting eq "cc" and defined $no_cc;
 361                next if $setting eq "bcc" and defined $no_bcc;
 362                if (ref($target) eq "ARRAY") {
 363                        unless (@$target) {
 364                                my @values = Git::config(@repo, "$prefix.$setting");
 365                                @$target = @values if (@values && defined $values[0]);
 366                        }
 367                }
 368                else {
 369                        $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
 370                }
 371        }
 372
 373        if (!defined $smtp_encryption) {
 374                my $enc = Git::config(@repo, "$prefix.smtpencryption");
 375                if (defined $enc) {
 376                        $smtp_encryption = $enc;
 377                } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
 378                        $smtp_encryption = 'ssl';
 379                }
 380        }
 381}
 382
 383# read configuration from [sendemail "$identity"], fall back on [sendemail]
 384$identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
 385read_config("sendemail.$identity") if (defined $identity);
 386read_config("sendemail");
 387
 388# fall back on builtin bool defaults
 389foreach my $setting (values %config_bool_settings) {
 390        ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
 391}
 392
 393# 'default' encryption is none -- this only prevents a warning
 394$smtp_encryption = '' unless (defined $smtp_encryption);
 395
 396# Set CC suppressions
 397my(%suppress_cc);
 398if (@suppress_cc) {
 399        foreach my $entry (@suppress_cc) {
 400                die "Unknown --suppress-cc field: '$entry'\n"
 401                        unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
 402                $suppress_cc{$entry} = 1;
 403        }
 404}
 405
 406if ($suppress_cc{'all'}) {
 407        foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
 408                $suppress_cc{$entry} = 1;
 409        }
 410        delete $suppress_cc{'all'};
 411}
 412
 413# If explicit old-style ones are specified, they trump --suppress-cc.
 414$suppress_cc{'self'} = $suppress_from if defined $suppress_from;
 415$suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
 416
 417if ($suppress_cc{'body'}) {
 418        foreach my $entry (qw (sob bodycc)) {
 419                $suppress_cc{$entry} = 1;
 420        }
 421        delete $suppress_cc{'body'};
 422}
 423
 424# Set confirm's default value
 425my $confirm_unconfigured = !defined $confirm;
 426if ($confirm_unconfigured) {
 427        $confirm = scalar %suppress_cc ? 'compose' : 'auto';
 428};
 429die "Unknown --confirm setting: '$confirm'\n"
 430        unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
 431
 432# Debugging, print out the suppressions.
 433if (0) {
 434        print "suppressions:\n";
 435        foreach my $entry (keys %suppress_cc) {
 436                printf "  %-5s -> $suppress_cc{$entry}\n", $entry;
 437        }
 438}
 439
 440my ($repoauthor, $repocommitter);
 441($repoauthor) = Git::ident_person(@repo, 'author');
 442($repocommitter) = Git::ident_person(@repo, 'committer');
 443
 444# Verify the user input
 445
 446foreach my $entry (@initial_to) {
 447        die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
 448}
 449
 450foreach my $entry (@initial_cc) {
 451        die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
 452}
 453
 454foreach my $entry (@bcclist) {
 455        die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
 456}
 457
 458sub parse_address_line {
 459        if ($have_mail_address) {
 460                return map { $_->format } Mail::Address->parse($_[0]);
 461        } else {
 462                return split_addrs($_[0]);
 463        }
 464}
 465
 466sub split_addrs {
 467        return quotewords('\s*,\s*', 1, @_);
 468}
 469
 470my %aliases;
 471my %parse_alias = (
 472        # multiline formats can be supported in the future
 473        mutt => sub { my $fh = shift; while (<$fh>) {
 474                if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
 475                        my ($alias, $addr) = ($1, $2);
 476                        $addr =~ s/#.*$//; # mutt allows # comments
 477                         # commas delimit multiple addresses
 478                        $aliases{$alias} = [ split_addrs($addr) ];
 479                }}},
 480        mailrc => sub { my $fh = shift; while (<$fh>) {
 481                if (/^alias\s+(\S+)\s+(.*)$/) {
 482                        # spaces delimit multiple addresses
 483                        $aliases{$1} = [ quotewords('\s+', 0, $2) ];
 484                }}},
 485        pine => sub { my $fh = shift; my $f='\t[^\t]*';
 486                for (my $x = ''; defined($x); $x = $_) {
 487                        chomp $x;
 488                        $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
 489                        $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
 490                        $aliases{$1} = [ split_addrs($2) ];
 491                }},
 492        elm => sub  { my $fh = shift;
 493                      while (<$fh>) {
 494                          if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
 495                              my ($alias, $addr) = ($1, $2);
 496                               $aliases{$alias} = [ split_addrs($addr) ];
 497                          }
 498                      } },
 499
 500        gnus => sub { my $fh = shift; while (<$fh>) {
 501                if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
 502                        $aliases{$1} = [ $2 ];
 503                }}}
 504);
 505
 506if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
 507        foreach my $file (@alias_files) {
 508                open my $fh, '<', $file or die "opening $file: $!\n";
 509                $parse_alias{$aliasfiletype}->($fh);
 510                close $fh;
 511        }
 512}
 513
 514($sender) = expand_aliases($sender) if defined $sender;
 515
 516# is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
 517# $f is a revision list specification to be passed to format-patch.
 518sub is_format_patch_arg {
 519        return unless $repo;
 520        my $f = shift;
 521        try {
 522                $repo->command('rev-parse', '--verify', '--quiet', $f);
 523                if (defined($format_patch)) {
 524                        return $format_patch;
 525                }
 526                die(<<EOF);
 527File '$f' exists but it could also be the range of commits
 528to produce patches for.  Please disambiguate by...
 529
 530    * Saying "./$f" if you mean a file; or
 531    * Giving --format-patch option if you mean a range.
 532EOF
 533        } catch Git::Error::Command with {
 534                # Not a valid revision.  Treat it as a filename.
 535                return 0;
 536        }
 537}
 538
 539# Now that all the defaults are set, process the rest of the command line
 540# arguments and collect up the files that need to be processed.
 541my @rev_list_opts;
 542while (defined(my $f = shift @ARGV)) {
 543        if ($f eq "--") {
 544                push @rev_list_opts, "--", @ARGV;
 545                @ARGV = ();
 546        } elsif (-d $f and !is_format_patch_arg($f)) {
 547                opendir my $dh, $f
 548                        or die "Failed to opendir $f: $!";
 549
 550                push @files, grep { -f $_ } map { catfile($f, $_) }
 551                                sort readdir $dh;
 552                closedir $dh;
 553        } elsif ((-f $f or -p $f) and !is_format_patch_arg($f)) {
 554                push @files, $f;
 555        } else {
 556                push @rev_list_opts, $f;
 557        }
 558}
 559
 560if (@rev_list_opts) {
 561        die "Cannot run git format-patch from outside a repository\n"
 562                unless $repo;
 563        push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
 564}
 565
 566if ($validate) {
 567        foreach my $f (@files) {
 568                unless (-p $f) {
 569                        my $error = validate_patch($f);
 570                        $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
 571                }
 572        }
 573}
 574
 575if (@files) {
 576        unless ($quiet) {
 577                print $_,"\n" for (@files);
 578        }
 579} else {
 580        print STDERR "\nNo patch files specified!\n\n";
 581        usage();
 582}
 583
 584sub get_patch_subject {
 585        my $fn = shift;
 586        open (my $fh, '<', $fn);
 587        while (my $line = <$fh>) {
 588                next unless ($line =~ /^Subject: (.*)$/);
 589                close $fh;
 590                return "GIT: $1\n";
 591        }
 592        close $fh;
 593        die "No subject line in $fn ?";
 594}
 595
 596if ($compose) {
 597        # Note that this does not need to be secure, but we will make a small
 598        # effort to have it be unique
 599        $compose_filename = ($repo ?
 600                tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
 601                tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
 602        open my $c, ">", $compose_filename
 603                or die "Failed to open for writing $compose_filename: $!";
 604
 605
 606        my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
 607        my $tpl_subject = $initial_subject || '';
 608        my $tpl_reply_to = $initial_reply_to || '';
 609
 610        print $c <<EOT;
 611From $tpl_sender # This line is ignored.
 612GIT: Lines beginning in "GIT:" will be removed.
 613GIT: Consider including an overall diffstat or table of contents
 614GIT: for the patch you are writing.
 615GIT:
 616GIT: Clear the body content if you don't wish to send a summary.
 617From: $tpl_sender
 618Subject: $tpl_subject
 619In-Reply-To: $tpl_reply_to
 620
 621EOT
 622        for my $f (@files) {
 623                print $c get_patch_subject($f);
 624        }
 625        close $c;
 626
 627        if ($annotate) {
 628                do_edit($compose_filename, @files);
 629        } else {
 630                do_edit($compose_filename);
 631        }
 632
 633        open my $c2, ">", $compose_filename . ".final"
 634                or die "Failed to open $compose_filename.final : " . $!;
 635
 636        open $c, "<", $compose_filename
 637                or die "Failed to open $compose_filename : " . $!;
 638
 639        my $need_8bit_cte = file_has_nonascii($compose_filename);
 640        my $in_body = 0;
 641        my $summary_empty = 1;
 642        if (!defined $compose_encoding) {
 643                $compose_encoding = "UTF-8";
 644        }
 645        while(<$c>) {
 646                next if m/^GIT:/;
 647                if ($in_body) {
 648                        $summary_empty = 0 unless (/^\n$/);
 649                } elsif (/^\n$/) {
 650                        $in_body = 1;
 651                        if ($need_8bit_cte) {
 652                                print $c2 "MIME-Version: 1.0\n",
 653                                         "Content-Type: text/plain; ",
 654                                           "charset=$compose_encoding\n",
 655                                         "Content-Transfer-Encoding: 8bit\n";
 656                        }
 657                } elsif (/^MIME-Version:/i) {
 658                        $need_8bit_cte = 0;
 659                } elsif (/^Subject:\s*(.+)\s*$/i) {
 660                        $initial_subject = $1;
 661                        my $subject = $initial_subject;
 662                        $_ = "Subject: " .
 663                                quote_subject($subject, $compose_encoding) .
 664                                "\n";
 665                } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
 666                        $initial_reply_to = $1;
 667                        next;
 668                } elsif (/^From:\s*(.+)\s*$/i) {
 669                        $sender = $1;
 670                        next;
 671                } elsif (/^(?:To|Cc|Bcc):/i) {
 672                        print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
 673                        next;
 674                }
 675                print $c2 $_;
 676        }
 677        close $c;
 678        close $c2;
 679
 680        if ($summary_empty) {
 681                print "Summary email is empty, skipping it\n";
 682                $compose = -1;
 683        }
 684} elsif ($annotate) {
 685        do_edit(@files);
 686}
 687
 688sub ask {
 689        my ($prompt, %arg) = @_;
 690        my $valid_re = $arg{valid_re};
 691        my $default = $arg{default};
 692        my $confirm_only = $arg{confirm_only};
 693        my $resp;
 694        my $i = 0;
 695        return defined $default ? $default : undef
 696                unless defined $term->IN and defined fileno($term->IN) and
 697                       defined $term->OUT and defined fileno($term->OUT);
 698        while ($i++ < 10) {
 699                $resp = $term->readline($prompt);
 700                if (!defined $resp) { # EOF
 701                        print "\n";
 702                        return defined $default ? $default : undef;
 703                }
 704                if ($resp eq '' and defined $default) {
 705                        return $default;
 706                }
 707                if (!defined $valid_re or $resp =~ /$valid_re/) {
 708                        return $resp;
 709                }
 710                if ($confirm_only) {
 711                        my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
 712                        if (defined $yesno && $yesno =~ /y/i) {
 713                                return $resp;
 714                        }
 715                }
 716        }
 717        return;
 718}
 719
 720my %broken_encoding;
 721
 722sub file_declares_8bit_cte {
 723        my $fn = shift;
 724        open (my $fh, '<', $fn);
 725        while (my $line = <$fh>) {
 726                last if ($line =~ /^$/);
 727                return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
 728        }
 729        close $fh;
 730        return 0;
 731}
 732
 733foreach my $f (@files) {
 734        next unless (body_or_subject_has_nonascii($f)
 735                     && !file_declares_8bit_cte($f));
 736        $broken_encoding{$f} = 1;
 737}
 738
 739if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
 740        print "The following files are 8bit, but do not declare " .
 741                "a Content-Transfer-Encoding.\n";
 742        foreach my $f (sort keys %broken_encoding) {
 743                print "    $f\n";
 744        }
 745        $auto_8bit_encoding = ask("Which 8bit encoding should I declare [UTF-8]? ",
 746                                  default => "UTF-8");
 747}
 748
 749if (!$force) {
 750        for my $f (@files) {
 751                if (get_patch_subject($f) =~ /\Q*** SUBJECT HERE ***\E/) {
 752                        die "Refusing to send because the patch\n\t$f\n"
 753                                . "has the template subject '*** SUBJECT HERE ***'. "
 754                                . "Pass --force if you really want to send.\n";
 755                }
 756        }
 757}
 758
 759if (!defined $sender) {
 760        $sender = $repoauthor || $repocommitter || '';
 761}
 762
 763my $prompting = 0;
 764if (!@initial_to && !defined $to_cmd) {
 765        my $to = ask("Who should the emails be sent to (if any)? ",
 766                     default => "",
 767                     valid_re => qr/\@.*\./, confirm_only => 1);
 768        push @initial_to, parse_address_line($to) if defined $to; # sanitized/validated later
 769        $prompting++;
 770}
 771
 772sub expand_aliases {
 773        return map { expand_one_alias($_) } @_;
 774}
 775
 776my %EXPANDED_ALIASES;
 777sub expand_one_alias {
 778        my $alias = shift;
 779        if ($EXPANDED_ALIASES{$alias}) {
 780                die "fatal: alias '$alias' expands to itself\n";
 781        }
 782        local $EXPANDED_ALIASES{$alias} = 1;
 783        return $aliases{$alias} ? expand_aliases(@{$aliases{$alias}}) : $alias;
 784}
 785
 786@initial_to = expand_aliases(@initial_to);
 787@initial_to = validate_address_list(sanitize_address_list(@initial_to));
 788@initial_cc = expand_aliases(@initial_cc);
 789@initial_cc = validate_address_list(sanitize_address_list(@initial_cc));
 790@bcclist = expand_aliases(@bcclist);
 791@bcclist = validate_address_list(sanitize_address_list(@bcclist));
 792
 793if ($thread && !defined $initial_reply_to && $prompting) {
 794        $initial_reply_to = ask(
 795                "Message-ID to be used as In-Reply-To for the first email (if any)? ",
 796                default => "",
 797                valid_re => qr/\@.*\./, confirm_only => 1);
 798}
 799if (defined $initial_reply_to) {
 800        $initial_reply_to =~ s/^\s*<?//;
 801        $initial_reply_to =~ s/>?\s*$//;
 802        $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
 803}
 804
 805if (!defined $smtp_server) {
 806        foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
 807                if (-x $_) {
 808                        $smtp_server = $_;
 809                        last;
 810                }
 811        }
 812        $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
 813}
 814
 815if ($compose && $compose > 0) {
 816        @files = ($compose_filename . ".final", @files);
 817}
 818
 819# Variables we set as part of the loop over files
 820our ($message_id, %mail, $subject, $reply_to, $references, $message,
 821        $needs_confirm, $message_num, $ask_default);
 822
 823sub extract_valid_address {
 824        my $address = shift;
 825        my $local_part_regexp = qr/[^<>"\s@]+/;
 826        my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
 827
 828        # check for a local address:
 829        return $address if ($address =~ /^($local_part_regexp)$/);
 830
 831        $address =~ s/^\s*<(.*)>\s*$/$1/;
 832        if ($have_email_valid) {
 833                return scalar Email::Valid->address($address);
 834        }
 835
 836        # less robust/correct than the monster regexp in Email::Valid,
 837        # but still does a 99% job, and one less dependency
 838        return $1 if $address =~ /($local_part_regexp\@$domain_regexp)/;
 839        return;
 840}
 841
 842sub extract_valid_address_or_die {
 843        my $address = shift;
 844        $address = extract_valid_address($address);
 845        die "error: unable to extract a valid address from: $address\n"
 846                if !$address;
 847        return $address;
 848}
 849
 850sub validate_address {
 851        my $address = shift;
 852        while (!extract_valid_address($address)) {
 853                print STDERR "error: unable to extract a valid address from: $address\n";
 854                $_ = ask("What to do with this address? ([q]uit|[d]rop|[e]dit): ",
 855                        valid_re => qr/^(?:quit|q|drop|d|edit|e)/i,
 856                        default => 'q');
 857                if (/^d/i) {
 858                        return undef;
 859                } elsif (/^q/i) {
 860                        cleanup_compose_files();
 861                        exit(0);
 862                }
 863                $address = ask("Who should the email be sent to (if any)? ",
 864                        default => "",
 865                        valid_re => qr/\@.*\./, confirm_only => 1);
 866        }
 867        return $address;
 868}
 869
 870sub validate_address_list {
 871        return (grep { defined $_ }
 872                map { validate_address($_) } @_);
 873}
 874
 875# Usually don't need to change anything below here.
 876
 877# we make a "fake" message id by taking the current number
 878# of seconds since the beginning of Unix time and tacking on
 879# a random number to the end, in case we are called quicker than
 880# 1 second since the last time we were called.
 881
 882# We'll setup a template for the message id, using the "from" address:
 883
 884my ($message_id_stamp, $message_id_serial);
 885sub make_message_id {
 886        my $uniq;
 887        if (!defined $message_id_stamp) {
 888                $message_id_stamp = sprintf("%s-%s", time, $$);
 889                $message_id_serial = 0;
 890        }
 891        $message_id_serial++;
 892        $uniq = "$message_id_stamp-$message_id_serial";
 893
 894        my $du_part;
 895        for ($sender, $repocommitter, $repoauthor) {
 896                $du_part = extract_valid_address(sanitize_address($_));
 897                last if (defined $du_part and $du_part ne '');
 898        }
 899        if (not defined $du_part or $du_part eq '') {
 900                require Sys::Hostname;
 901                $du_part = 'user@' . Sys::Hostname::hostname();
 902        }
 903        my $message_id_template = "<%s-git-send-email-%s>";
 904        $message_id = sprintf($message_id_template, $uniq, $du_part);
 905        #print "new message id = $message_id\n"; # Was useful for debugging
 906}
 907
 908
 909
 910$time = time - scalar $#files;
 911
 912sub unquote_rfc2047 {
 913        local ($_) = @_;
 914        my $encoding;
 915        s{=\?([^?]+)\?q\?(.*?)\?=}{
 916                $encoding = $1;
 917                my $e = $2;
 918                $e =~ s/_/ /g;
 919                $e =~ s/=([0-9A-F]{2})/chr(hex($1))/eg;
 920                $e;
 921        }eg;
 922        return wantarray ? ($_, $encoding) : $_;
 923}
 924
 925sub quote_rfc2047 {
 926        local $_ = shift;
 927        my $encoding = shift || 'UTF-8';
 928        s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
 929        s/(.*)/=\?$encoding\?q\?$1\?=/;
 930        return $_;
 931}
 932
 933sub is_rfc2047_quoted {
 934        my $s = shift;
 935        my $token = qr/[^][()<>@,;:"\/?.= \000-\037\177-\377]+/;
 936        my $encoded_text = qr/[!->@-~]+/;
 937        length($s) <= 75 &&
 938        $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
 939}
 940
 941sub subject_needs_rfc2047_quoting {
 942        my $s = shift;
 943
 944        return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
 945}
 946
 947sub quote_subject {
 948        local $subject = shift;
 949        my $encoding = shift || 'UTF-8';
 950
 951        if (subject_needs_rfc2047_quoting($subject)) {
 952                return quote_rfc2047($subject, $encoding);
 953        }
 954        return $subject;
 955}
 956
 957# use the simplest quoting being able to handle the recipient
 958sub sanitize_address {
 959        my ($recipient) = @_;
 960
 961        # remove garbage after email address
 962        $recipient =~ s/(.*>).*$/$1/;
 963
 964        my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
 965
 966        if (not $recipient_name) {
 967                return $recipient;
 968        }
 969
 970        # if recipient_name is already quoted, do nothing
 971        if (is_rfc2047_quoted($recipient_name)) {
 972                return $recipient;
 973        }
 974
 975        # rfc2047 is needed if a non-ascii char is included
 976        if ($recipient_name =~ /[^[:ascii:]]/) {
 977                $recipient_name =~ s/^"(.*)"$/$1/;
 978                $recipient_name = quote_rfc2047($recipient_name);
 979        }
 980
 981        # double quotes are needed if specials or CTLs are included
 982        elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
 983                $recipient_name =~ s/(["\\\r])/\\$1/g;
 984                $recipient_name = qq["$recipient_name"];
 985        }
 986
 987        return "$recipient_name $recipient_addr";
 988
 989}
 990
 991sub sanitize_address_list {
 992        return (map { sanitize_address($_) } @_);
 993}
 994
 995# Returns the local Fully Qualified Domain Name (FQDN) if available.
 996#
 997# Tightly configured MTAa require that a caller sends a real DNS
 998# domain name that corresponds the IP address in the HELO/EHLO
 999# handshake. This is used to verify the connection and prevent
1000# spammers from trying to hide their identity. If the DNS and IP don't
1001# match, the receiveing MTA may deny the connection.
1002#
1003# Here is a deny example of Net::SMTP with the default "localhost.localdomain"
1004#
1005# Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
1006# Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
1007#
1008# This maildomain*() code is based on ideas in Perl library Test::Reporter
1009# /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1010
1011sub valid_fqdn {
1012        my $domain = shift;
1013        return defined $domain && !($^O eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
1014}
1015
1016sub maildomain_net {
1017        my $maildomain;
1018
1019        if (eval { require Net::Domain; 1 }) {
1020                my $domain = Net::Domain::domainname();
1021                $maildomain = $domain if valid_fqdn($domain);
1022        }
1023
1024        return $maildomain;
1025}
1026
1027sub maildomain_mta {
1028        my $maildomain;
1029
1030        if (eval { require Net::SMTP; 1 }) {
1031                for my $host (qw(mailhost localhost)) {
1032                        my $smtp = Net::SMTP->new($host);
1033                        if (defined $smtp) {
1034                                my $domain = $smtp->domain;
1035                                $smtp->quit;
1036
1037                                $maildomain = $domain if valid_fqdn($domain);
1038
1039                                last if $maildomain;
1040                        }
1041                }
1042        }
1043
1044        return $maildomain;
1045}
1046
1047sub maildomain {
1048        return maildomain_net() || maildomain_mta() || 'localhost.localdomain';
1049}
1050
1051sub smtp_host_string {
1052        if (defined $smtp_server_port) {
1053                return "$smtp_server:$smtp_server_port";
1054        } else {
1055                return $smtp_server;
1056        }
1057}
1058
1059# Returns 1 if authentication succeeded or was not necessary
1060# (smtp_user was not specified), and 0 otherwise.
1061
1062sub smtp_auth_maybe {
1063        if (!defined $smtp_authuser || $auth) {
1064                return 1;
1065        }
1066
1067        # Workaround AUTH PLAIN/LOGIN interaction defect
1068        # with Authen::SASL::Cyrus
1069        eval {
1070                require Authen::SASL;
1071                Authen::SASL->import(qw(Perl));
1072        };
1073
1074        # TODO: Authentication may fail not because credentials were
1075        # invalid but due to other reasons, in which we should not
1076        # reject credentials.
1077        $auth = Git::credential({
1078                'protocol' => 'smtp',
1079                'host' => smtp_host_string(),
1080                'username' => $smtp_authuser,
1081                # if there's no password, "git credential fill" will
1082                # give us one, otherwise it'll just pass this one.
1083                'password' => $smtp_authpass
1084        }, sub {
1085                my $cred = shift;
1086                return !!$smtp->auth($cred->{'username'}, $cred->{'password'});
1087        });
1088
1089        return $auth;
1090}
1091
1092# Returns 1 if the message was sent, and 0 otherwise.
1093# In actuality, the whole program dies when there
1094# is an error sending a message.
1095
1096sub send_message {
1097        my @recipients = unique_email_list(@to);
1098        @cc = (grep { my $cc = extract_valid_address_or_die($_);
1099                      not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
1100                    }
1101               @cc);
1102        my $to = join (",\n\t", @recipients);
1103        @recipients = unique_email_list(@recipients,@cc,@bcclist);
1104        @recipients = (map { extract_valid_address_or_die($_) } @recipients);
1105        my $date = format_2822_time($time++);
1106        my $gitversion = '@@GIT_VERSION@@';
1107        if ($gitversion =~ m/..GIT_VERSION../) {
1108            $gitversion = Git::version();
1109        }
1110
1111        my $cc = join(",\n\t", unique_email_list(@cc));
1112        my $ccline = "";
1113        if ($cc ne '') {
1114                $ccline = "\nCc: $cc";
1115        }
1116        my $sanitized_sender = sanitize_address($sender);
1117        make_message_id() unless defined($message_id);
1118
1119        my $header = "From: $sanitized_sender
1120To: $to${ccline}
1121Subject: $subject
1122Date: $date
1123Message-Id: $message_id
1124X-Mailer: git-send-email $gitversion
1125";
1126        if ($reply_to) {
1127
1128                $header .= "In-Reply-To: $reply_to\n";
1129                $header .= "References: $references\n";
1130        }
1131        if (@xh) {
1132                $header .= join("\n", @xh) . "\n";
1133        }
1134
1135        my @sendmail_parameters = ('-i', @recipients);
1136        my $raw_from = $sanitized_sender;
1137        if (defined $envelope_sender && $envelope_sender ne "auto") {
1138                $raw_from = $envelope_sender;
1139        }
1140        $raw_from = extract_valid_address($raw_from);
1141        unshift (@sendmail_parameters,
1142                        '-f', $raw_from) if(defined $envelope_sender);
1143
1144        if ($needs_confirm && !$dry_run) {
1145                print "\n$header\n";
1146                if ($needs_confirm eq "inform") {
1147                        $confirm_unconfigured = 0; # squelch this message for the rest of this run
1148                        $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
1149                        print "    The Cc list above has been expanded by additional\n";
1150                        print "    addresses found in the patch commit message. By default\n";
1151                        print "    send-email prompts before sending whenever this occurs.\n";
1152                        print "    This behavior is controlled by the sendemail.confirm\n";
1153                        print "    configuration setting.\n";
1154                        print "\n";
1155                        print "    For additional information, run 'git send-email --help'.\n";
1156                        print "    To retain the current behavior, but squelch this message,\n";
1157                        print "    run 'git config --global sendemail.confirm auto'.\n\n";
1158                }
1159                $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1160                         valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1161                         default => $ask_default);
1162                die "Send this email reply required" unless defined $_;
1163                if (/^n/i) {
1164                        return 0;
1165                } elsif (/^q/i) {
1166                        cleanup_compose_files();
1167                        exit(0);
1168                } elsif (/^a/i) {
1169                        $confirm = 'never';
1170                }
1171        }
1172
1173        unshift (@sendmail_parameters, @smtp_server_options);
1174
1175        if ($dry_run) {
1176                # We don't want to send the email.
1177        } elsif ($smtp_server =~ m#^/#) {
1178                my $pid = open my $sm, '|-';
1179                defined $pid or die $!;
1180                if (!$pid) {
1181                        exec($smtp_server, @sendmail_parameters) or die $!;
1182                }
1183                print $sm "$header\n$message";
1184                close $sm or die $!;
1185        } else {
1186
1187                if (!defined $smtp_server) {
1188                        die "The required SMTP server is not properly defined."
1189                }
1190
1191                if ($smtp_encryption eq 'ssl') {
1192                        $smtp_server_port ||= 465; # ssmtp
1193                        require Net::SMTP::SSL;
1194                        $smtp_domain ||= maildomain();
1195                        $smtp ||= Net::SMTP::SSL->new($smtp_server,
1196                                                      Hello => $smtp_domain,
1197                                                      Port => $smtp_server_port);
1198                }
1199                else {
1200                        require Net::SMTP;
1201                        $smtp_domain ||= maildomain();
1202                        $smtp ||= Net::SMTP->new(smtp_host_string(),
1203                                                 Hello => $smtp_domain,
1204                                                 Debug => $debug_net_smtp);
1205                        if ($smtp_encryption eq 'tls' && $smtp) {
1206                                require Net::SMTP::SSL;
1207                                $smtp->command('STARTTLS');
1208                                $smtp->response();
1209                                if ($smtp->code == 220) {
1210                                        $smtp = Net::SMTP::SSL->start_SSL($smtp)
1211                                                or die "STARTTLS failed! ".$smtp->message;
1212                                        $smtp_encryption = '';
1213                                        # Send EHLO again to receive fresh
1214                                        # supported commands
1215                                        $smtp->hello($smtp_domain);
1216                                } else {
1217                                        die "Server does not support STARTTLS! ".$smtp->message;
1218                                }
1219                        }
1220                }
1221
1222                if (!$smtp) {
1223                        die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1224                            "VALUES: server=$smtp_server ",
1225                            "encryption=$smtp_encryption ",
1226                            "hello=$smtp_domain",
1227                            defined $smtp_server_port ? " port=$smtp_server_port" : "";
1228                }
1229
1230                smtp_auth_maybe or die $smtp->message;
1231
1232                $smtp->mail( $raw_from ) or die $smtp->message;
1233                $smtp->to( @recipients ) or die $smtp->message;
1234                $smtp->data or die $smtp->message;
1235                $smtp->datasend("$header\n$message") or die $smtp->message;
1236                $smtp->dataend() or die $smtp->message;
1237                $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1238        }
1239        if ($quiet) {
1240                printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
1241        } else {
1242                print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
1243                if ($smtp_server !~ m#^/#) {
1244                        print "Server: $smtp_server\n";
1245                        print "MAIL FROM:<$raw_from>\n";
1246                        foreach my $entry (@recipients) {
1247                            print "RCPT TO:<$entry>\n";
1248                        }
1249                } else {
1250                        print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1251                }
1252                print $header, "\n";
1253                if ($smtp) {
1254                        print "Result: ", $smtp->code, ' ',
1255                                ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1256                } else {
1257                        print "Result: OK\n";
1258                }
1259        }
1260
1261        return 1;
1262}
1263
1264$reply_to = $initial_reply_to;
1265$references = $initial_reply_to || '';
1266$subject = $initial_subject;
1267$message_num = 0;
1268
1269foreach my $t (@files) {
1270        open my $fh, "<", $t or die "can't open file $t";
1271
1272        my $author = undef;
1273        my $author_encoding;
1274        my $has_content_type;
1275        my $body_encoding;
1276        @to = ();
1277        @cc = ();
1278        @xh = ();
1279        my $input_format = undef;
1280        my @header = ();
1281        $message = "";
1282        $message_num++;
1283        # First unfold multiline header fields
1284        while(<$fh>) {
1285                last if /^\s*$/;
1286                if (/^\s+\S/ and @header) {
1287                        chomp($header[$#header]);
1288                        s/^\s+/ /;
1289                        $header[$#header] .= $_;
1290            } else {
1291                        push(@header, $_);
1292                }
1293        }
1294        # Now parse the header
1295        foreach(@header) {
1296                if (/^From /) {
1297                        $input_format = 'mbox';
1298                        next;
1299                }
1300                chomp;
1301                if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1302                        $input_format = 'mbox';
1303                }
1304
1305                if (defined $input_format && $input_format eq 'mbox') {
1306                        if (/^Subject:\s+(.*)$/i) {
1307                                $subject = $1;
1308                        }
1309                        elsif (/^From:\s+(.*)$/i) {
1310                                ($author, $author_encoding) = unquote_rfc2047($1);
1311                                next if $suppress_cc{'author'};
1312                                next if $suppress_cc{'self'} and $author eq $sender;
1313                                printf("(mbox) Adding cc: %s from line '%s'\n",
1314                                        $1, $_) unless $quiet;
1315                                push @cc, $1;
1316                        }
1317                        elsif (/^To:\s+(.*)$/i) {
1318                                foreach my $addr (parse_address_line($1)) {
1319                                        printf("(mbox) Adding to: %s from line '%s'\n",
1320                                                $addr, $_) unless $quiet;
1321                                        push @to, $addr;
1322                                }
1323                        }
1324                        elsif (/^Cc:\s+(.*)$/i) {
1325                                foreach my $addr (parse_address_line($1)) {
1326                                        if (unquote_rfc2047($addr) eq $sender) {
1327                                                next if ($suppress_cc{'self'});
1328                                        } else {
1329                                                next if ($suppress_cc{'cc'});
1330                                        }
1331                                        printf("(mbox) Adding cc: %s from line '%s'\n",
1332                                                $addr, $_) unless $quiet;
1333                                        push @cc, $addr;
1334                                }
1335                        }
1336                        elsif (/^Content-type:/i) {
1337                                $has_content_type = 1;
1338                                if (/charset="?([^ "]+)/) {
1339                                        $body_encoding = $1;
1340                                }
1341                                push @xh, $_;
1342                        }
1343                        elsif (/^Message-Id: (.*)/i) {
1344                                $message_id = $1;
1345                        }
1346                        elsif (!/^Date:\s/i && /^[-A-Za-z]+:\s+\S/) {
1347                                push @xh, $_;
1348                        }
1349
1350                } else {
1351                        # In the traditional
1352                        # "send lots of email" format,
1353                        # line 1 = cc
1354                        # line 2 = subject
1355                        # So let's support that, too.
1356                        $input_format = 'lots';
1357                        if (@cc == 0 && !$suppress_cc{'cc'}) {
1358                                printf("(non-mbox) Adding cc: %s from line '%s'\n",
1359                                        $_, $_) unless $quiet;
1360                                push @cc, $_;
1361                        } elsif (!defined $subject) {
1362                                $subject = $_;
1363                        }
1364                }
1365        }
1366        # Now parse the message body
1367        while(<$fh>) {
1368                $message .=  $_;
1369                if (/^(Signed-off-by|Cc): (.*)$/i) {
1370                        chomp;
1371                        my ($what, $c) = ($1, $2);
1372                        chomp $c;
1373                        if ($c eq $sender) {
1374                                next if ($suppress_cc{'self'});
1375                        } else {
1376                                next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1377                                next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1378                        }
1379                        push @cc, $c;
1380                        printf("(body) Adding cc: %s from line '%s'\n",
1381                                $c, $_) unless $quiet;
1382                }
1383        }
1384        close $fh;
1385
1386        push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t)
1387                if defined $to_cmd;
1388        push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t)
1389                if defined $cc_cmd && !$suppress_cc{'cccmd'};
1390
1391        if ($broken_encoding{$t} && !$has_content_type) {
1392                $has_content_type = 1;
1393                push @xh, "MIME-Version: 1.0",
1394                        "Content-Type: text/plain; charset=$auto_8bit_encoding",
1395                        "Content-Transfer-Encoding: 8bit";
1396                $body_encoding = $auto_8bit_encoding;
1397        }
1398
1399        if ($broken_encoding{$t} && !is_rfc2047_quoted($subject)) {
1400                $subject = quote_subject($subject, $auto_8bit_encoding);
1401        }
1402
1403        if (defined $author and $author ne $sender) {
1404                $message = "From: $author\n\n$message";
1405                if (defined $author_encoding) {
1406                        if ($has_content_type) {
1407                                if ($body_encoding eq $author_encoding) {
1408                                        # ok, we already have the right encoding
1409                                }
1410                                else {
1411                                        # uh oh, we should re-encode
1412                                }
1413                        }
1414                        else {
1415                                $has_content_type = 1;
1416                                push @xh,
1417                                  'MIME-Version: 1.0',
1418                                  "Content-Type: text/plain; charset=$author_encoding",
1419                                  'Content-Transfer-Encoding: 8bit';
1420                        }
1421                }
1422        }
1423
1424        $needs_confirm = (
1425                $confirm eq "always" or
1426                ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1427                ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1428        $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1429
1430        @to = validate_address_list(sanitize_address_list(@to));
1431        @cc = validate_address_list(sanitize_address_list(@cc));
1432
1433        @to = (@initial_to, @to);
1434        @cc = (@initial_cc, @cc);
1435
1436        my $message_was_sent = send_message();
1437
1438        # set up for the next message
1439        if ($thread && $message_was_sent &&
1440                (chain_reply_to() || !defined $reply_to || length($reply_to) == 0 ||
1441                $message_num == 1)) {
1442                $reply_to = $message_id;
1443                if (length $references > 0) {
1444                        $references .= "\n $message_id";
1445                } else {
1446                        $references = "$message_id";
1447                }
1448        }
1449        $message_id = undef;
1450}
1451
1452# Execute a command (e.g. $to_cmd) to get a list of email addresses
1453# and return a results array
1454sub recipients_cmd {
1455        my ($prefix, $what, $cmd, $file) = @_;
1456
1457        my $sanitized_sender = sanitize_address($sender);
1458        my @addresses = ();
1459        open my $fh, "-|", "$cmd \Q$file\E"
1460            or die "($prefix) Could not execute '$cmd'";
1461        while (my $address = <$fh>) {
1462                $address =~ s/^\s*//g;
1463                $address =~ s/\s*$//g;
1464                $address = sanitize_address($address);
1465                next if ($address eq $sanitized_sender and $suppress_from);
1466                push @addresses, $address;
1467                printf("($prefix) Adding %s: %s from: '%s'\n",
1468                       $what, $address, $cmd) unless $quiet;
1469                }
1470        close $fh
1471            or die "($prefix) failed to close pipe to '$cmd'";
1472        return @addresses;
1473}
1474
1475cleanup_compose_files();
1476
1477sub cleanup_compose_files {
1478        unlink($compose_filename, $compose_filename . ".final") if $compose;
1479}
1480
1481$smtp->quit if $smtp;
1482
1483sub unique_email_list {
1484        my %seen;
1485        my @emails;
1486
1487        foreach my $entry (@_) {
1488                my $clean = extract_valid_address_or_die($entry);
1489                $seen{$clean} ||= 0;
1490                next if $seen{$clean}++;
1491                push @emails, $entry;
1492        }
1493        return @emails;
1494}
1495
1496sub validate_patch {
1497        my $fn = shift;
1498        open(my $fh, '<', $fn)
1499                or die "unable to open $fn: $!\n";
1500        while (my $line = <$fh>) {
1501                if (length($line) > 998) {
1502                        return "$.: patch contains a line longer than 998 characters";
1503                }
1504        }
1505        return;
1506}
1507
1508sub file_has_nonascii {
1509        my $fn = shift;
1510        open(my $fh, '<', $fn)
1511                or die "unable to open $fn: $!\n";
1512        while (my $line = <$fh>) {
1513                return 1 if $line =~ /[^[:ascii:]]/;
1514        }
1515        return 0;
1516}
1517
1518sub body_or_subject_has_nonascii {
1519        my $fn = shift;
1520        open(my $fh, '<', $fn)
1521                or die "unable to open $fn: $!\n";
1522        while (my $line = <$fh>) {
1523                last if $line =~ /^$/;
1524                return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1525        }
1526        while (my $line = <$fh>) {
1527                return 1 if $line =~ /[^[:ascii:]]/;
1528        }
1529        return 0;
1530}