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