Commit 897de845 authored by Junio C Hamano's avatar Junio C Hamano

Merge branch 'mm/send-email-fallback-to-local-mail-address'

Instead of maintaining home-grown email address parsing code, ship
a copy of reasonably recent Mail::Address to be used as a fallback
in 'git send-email' when the platform lacks it.

* mm/send-email-fallback-to-local-mail-address:
  send-email: add test for Linux's get_maintainer.pl
  perl/Git: remove now useless email-address parsing code
  send-email: add and use a local copy of Mail::Address
parents 93a622f4 d60be8ac
......@@ -30,6 +30,7 @@
use Cwd qw(abs_path cwd);
use Git;
use Git::I18N;
use Git::Mail::Address;
Getopt::Long::Configure qw/ pass_through /;
......@@ -489,7 +490,7 @@ sub read_config {
($repocommitter) = Git::ident_person(@repo, 'committer');
sub parse_address_line {
return Git::parse_mailboxes($_[0]);
return map { $_->format } Mail::Address->parse($_[0]);
}
sub split_addrs {
......
......@@ -880,77 +880,6 @@ sub ident_person {
return "$ident[0] <$ident[1]>";
}
=item parse_mailboxes
Return an array of mailboxes extracted from a string.
=cut
# Very close to Mail::Address's parser, but we still have minor
# differences in some cases (see t9000 for examples).
sub parse_mailboxes {
my $re_comment = qr/\((?:[^)]*)\)/;
my $re_quote = qr/"(?:[^\"\\]|\\.)*"/;
my $re_word = qr/(?:[^]["\s()<>:;@\\,.]|\\.)+/;
# divide the string in tokens of the above form
my $re_token = qr/(?:$re_quote|$re_word|$re_comment|\S)/;
my @tokens = map { $_ =~ /\s*($re_token)\s*/g } @_;
my $end_of_addr_seen = 0;
# add a delimiter to simplify treatment for the last mailbox
push @tokens, ",";
my (@addr_list, @phrase, @address, @comment, @buffer) = ();
foreach my $token (@tokens) {
if ($token =~ /^[,;]$/) {
# if buffer still contains undeterminated strings
# append it at the end of @address or @phrase
if ($end_of_addr_seen) {
push @phrase, @buffer;
} else {
push @address, @buffer;
}
my $str_phrase = join ' ', @phrase;
my $str_address = join '', @address;
my $str_comment = join ' ', @comment;
# quote are necessary if phrase contains
# special characters
if ($str_phrase =~ /[][()<>:;@\\,.\000-\037\177]/) {
$str_phrase =~ s/(^|[^\\])"/$1/g;
$str_phrase = qq["$str_phrase"];
}
# add "<>" around the address if necessary
if ($str_address ne "" && $str_phrase ne "") {
$str_address = qq[<$str_address>];
}
my $str_mailbox = "$str_phrase $str_address $str_comment";
$str_mailbox =~ s/^\s*|\s*$//g;
push @addr_list, $str_mailbox if ($str_mailbox);
@phrase = @address = @comment = @buffer = ();
$end_of_addr_seen = 0;
} elsif ($token =~ /^\(/) {
push @comment, $token;
} elsif ($token eq "<") {
push @phrase, (splice @address), (splice @buffer);
} elsif ($token eq ">") {
$end_of_addr_seen = 1;
push @address, (splice @buffer);
} elsif ($token eq "@" && !$end_of_addr_seen) {
push @address, (splice @buffer), "@";
} else {
push @buffer, $token;
}
}
return @addr_list;
}
=item hash_object ( TYPE, FILENAME )
Compute the SHA1 object id of the given C<FILENAME> considering it is
......
# Copyrights 1995-2017 by [Mark Overmeer <perl@overmeer.net>].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.02.
package Mail::Address;
use vars '$VERSION';
$VERSION = '2.19';
use strict;
use Carp;
# use locale; removed in version 1.78, because it causes taint problems
sub Version { our $VERSION }
# given a comment, attempt to extract a person's name
sub _extract_name
{ # This function can be called as method as well
my $self = @_ && ref $_[0] ? shift : undef;
local $_ = shift
or return '';
# Using encodings, too hard. See Mail::Message::Field::Full.
return '' if m/\=\?.*?\?\=/;
# trim whitespace
s/^\s+//;
s/\s+$//;
s/\s+/ /;
# Disregard numeric names (e.g. 123456.1234@compuserve.com)
return "" if /^[\d ]+$/;
s/^\((.*)\)$/$1/; # remove outermost parenthesis
s/^"(.*)"$/$1/; # remove outer quotation marks
s/\(.*?\)//g; # remove minimal embedded comments
s/\\//g; # remove all escapes
s/^"(.*)"$/$1/; # remove internal quotation marks
s/^([^\s]+) ?, ?(.*)$/$2 $1/; # reverse "Last, First M." if applicable
s/,.*//;
# Change casing only when the name contains only upper or only
# lower cased characters.
unless( m/[A-Z]/ && m/[a-z]/ )
{ # Set the case of the name to first char upper rest lower
s/\b(\w+)/\L\u$1/igo; # Upcase first letter on name
s/\bMc(\w)/Mc\u$1/igo; # Scottish names such as 'McLeod'
s/\bo'(\w)/O'\u$1/igo; # Irish names such as 'O'Malley, O'Reilly'
s/\b(x*(ix)?v*(iv)?i*)\b/\U$1/igo; # Roman numerals, eg 'Level III Support'
}
# some cleanup
s/\[[^\]]*\]//g;
s/(^[\s'"]+|[\s'"]+$)//g;
s/\s{2,}/ /g;
$_;
}
sub _tokenise
{ local $_ = join ',', @_;
my (@words,$snippet,$field);
s/\A\s+//;
s/[\r\n]+/ /g;
while ($_ ne '')
{ $field = '';
if(s/^\s*\(/(/ ) # (...)
{ my $depth = 0;
PAREN: while(s/^(\(([^\(\)\\]|\\.)*)//)
{ $field .= $1;
$depth++;
while(s/^(([^\(\)\\]|\\.)*\)\s*)//)
{ $field .= $1;
last PAREN unless --$depth;
$field .= $1 if s/^(([^\(\)\\]|\\.)+)//;
}
}
carp "Unmatched () '$field' '$_'"
if $depth;
$field =~ s/\s+\Z//;
push @words, $field;
next;
}
if( s/^("(?:[^"\\]+|\\.)*")\s*// # "..."
|| s/^(\[(?:[^\]\\]+|\\.)*\])\s*// # [...]
|| s/^([^\s()<>\@,;:\\".[\]]+)\s*//
|| s/^([()<>\@,;:\\".[\]])\s*//
)
{ push @words, $1;
next;
}
croak "Unrecognised line: $_";
}
push @words, ",";
\@words;
}
sub _find_next
{ my ($idx, $tokens, $len) = @_;
while($idx < $len)
{ my $c = $tokens->[$idx];
return $c if $c eq ',' || $c eq ';' || $c eq '<';
$idx++;
}
"";
}
sub _complete
{ my ($class, $phrase, $address, $comment) = @_;
@$phrase || @$comment || @$address
or return undef;
my $o = $class->new(join(" ",@$phrase), join("",@$address), join(" ",@$comment));
@$phrase = @$address = @$comment = ();
$o;
}
#------------
sub new(@)
{ my $class = shift;
bless [@_], $class;
}
sub parse(@)
{ my $class = shift;
my @line = grep {defined} @_;
my $line = join '', @line;
my (@phrase, @comment, @address, @objs);
my ($depth, $idx) = (0, 0);
my $tokens = _tokenise @line;
my $len = @$tokens;
my $next = _find_next $idx, $tokens, $len;
local $_;
for(my $idx = 0; $idx < $len; $idx++)
{ $_ = $tokens->[$idx];
if(substr($_,0,1) eq '(') { push @comment, $_ }
elsif($_ eq '<') { $depth++ }
elsif($_ eq '>') { $depth-- if $depth }
elsif($_ eq ',' || $_ eq ';')
{ warn "Unmatched '<>' in $line" if $depth;
my $o = $class->_complete(\@phrase, \@address, \@comment);
push @objs, $o if defined $o;
$depth = 0;
$next = _find_next $idx+1, $tokens, $len;
}
elsif($depth) { push @address, $_ }
elsif($next eq '<') { push @phrase, $_ }
elsif( /^[.\@:;]$/ || !@address || $address[-1] =~ /^[.\@:;]$/ )
{ push @address, $_ }
else
{ warn "Unmatched '<>' in $line" if $depth;
my $o = $class->_complete(\@phrase, \@address, \@comment);
push @objs, $o if defined $o;
$depth = 0;
push @address, $_;
}
}
@objs;
}
#------------
sub phrase { shift->set_or_get(0, @_) }
sub address { shift->set_or_get(1, @_) }
sub comment { shift->set_or_get(2, @_) }
sub set_or_get($)
{ my ($self, $i) = (shift, shift);
@_ or return $self->[$i];
my $val = $self->[$i];
$self->[$i] = shift if @_;
$val;
}
my $atext = '[\-\w !#$%&\'*+/=?^`{|}~]';
sub format
{ my @addrs;
foreach (@_)
{ my ($phrase, $email, $comment) = @$_;
my @addr;
if(defined $phrase && length $phrase)
{ push @addr
, $phrase =~ /^(?:\s*$atext\s*)+$/o ? $phrase
: $phrase =~ /(?<!\\)"/ ? $phrase
: qq("$phrase");
push @addr, "<$email>"
if defined $email && length $email;
}
elsif(defined $email && length $email)
{ push @addr, $email;
}
if(defined $comment && $comment =~ /\S/)
{ $comment =~ s/^\s*\(?/(/;
$comment =~ s/\)?\s*$/)/;
}
push @addr, $comment
if defined $comment && length $comment;
push @addrs, join(" ", @addr)
if @addr;
}
join ", ", @addrs;
}
#------------
sub name
{ my $self = shift;
my $phrase = $self->phrase;
my $addr = $self->address;
$phrase = $self->comment
unless defined $phrase && length $phrase;
my $name = $self->_extract_name($phrase);
# first.last@domain address
if($name eq '' && $addr =~ /([^\%\.\@_]+([\._][^\%\.\@_]+)+)[\@\%]/)
{ ($name = $1) =~ s/[\._]+/ /g;
$name = _extract_name $name;
}
if($name eq '' && $addr =~ m#/g=#i) # X400 style address
{ my ($f) = $addr =~ m#g=([^/]*)#i;
my ($l) = $addr =~ m#s=([^/]*)#i;
$name = _extract_name "$f $l";
}
length $name ? $name : undef;
}
sub host
{ my $addr = shift->address || '';
my $i = rindex $addr, '@';
$i >= 0 ? substr($addr, $i+1) : undef;
}
sub user
{ my $addr = shift->address || '';
my $i = rindex $addr, '@';
$i >= 0 ? substr($addr,0,$i) : $addr;
}
1;
package Git::Mail::Address;
use 5.008;
use strict;
use warnings;
=head1 NAME
Git::Mail::Address - Wrapper for the L<Mail::Address> module, in case it's not installed
=head1 DESCRIPTION
This module is only intended to be used for code shipping in the
C<git.git> repository. Use it for anything else at your peril!
=cut
eval {
require Mail::Address;
1;
} or do {
require Git::FromCPAN::Mail::Address;
};
1;
#!/bin/sh
test_description='compare address parsing with and without Mail::Address'
. ./test-lib.sh
if ! test_have_prereq PERL; then
skip_all='skipping perl interface tests, perl not available'
test_done
fi
perl -MTest::More -e 0 2>/dev/null || {
skip_all="Perl Test::More unavailable, skipping test"
test_done
}
perl -MMail::Address -e 0 2>/dev/null || {
skip_all="Perl Mail::Address unavailable, skipping test"
test_done
}
test_external_has_tap=1
test_external_without_stderr \
'Perl address parsing function' \
perl "$TEST_DIRECTORY"/t9000/test.pl
test_done
#!/usr/bin/perl
use lib (split(/:/, $ENV{GITPERLLIB}));
use 5.008;
use warnings;
use strict;
use Test::More qw(no_plan);
use Mail::Address;
BEGIN { use_ok('Git') }
my @success_list = (q[Jane],
q[jdoe@example.com],
q[<jdoe@example.com>],
q[Jane <jdoe@example.com>],
q[Jane Doe <jdoe@example.com>],
q["Jane" <jdoe@example.com>],
q["Doe, Jane" <jdoe@example.com>],
q["Jane@:;\>.,()<Doe" <jdoe@example.com>],
q[Jane!#$%&'*+-/=?^_{|}~Doe' <jdoe@example.com>],
q["<jdoe@example.com>"],
q["Jane jdoe@example.com"],
q[Jane Doe <jdoe @ example.com >],
q[Jane Doe < jdoe@example.com >],
q[Jane @ Doe @ Jane @ Doe],
q["Jane, 'Doe'" <jdoe@example.com>],
q['Doe, "Jane' <jdoe@example.com>],
q["Jane" "Do"e <jdoe@example.com>],
q["Jane' Doe" <jdoe@example.com>],
q["Jane Doe <jdoe@example.com>" <jdoe@example.com>],
q["Jane\" Doe" <jdoe@example.com>],
q[Doe, jane <jdoe@example.com>],
q["Jane Doe <jdoe@example.com>],
q['Jane 'Doe' <jdoe@example.com>],
q[Jane@:;\.,()<>Doe <jdoe@example.com>],
q[Jane <jdoe@example.com> Doe],
q[<jdoe@example.com> Jane Doe]);
my @known_failure_list = (q[Jane\ Doe <jdoe@example.com>],
q["Doe, Ja"ne <jdoe@example.com>],
q["Doe, Katarina" Jane <jdoe@example.com>],
q[Jane jdoe@example.com],
q["Jane "Kat"a" ri"na" ",Doe" <jdoe@example.com>],
q[Jane Doe],
q[Jane "Doe <jdoe@example.com>"],
q[\"Jane Doe <jdoe@example.com>],
q[Jane\"\" Doe <jdoe@example.com>],
q['Jane "Katarina\" \' Doe' <jdoe@example.com>]);
foreach my $str (@success_list) {
my @expected = map { $_->format } Mail::Address->parse("$str");
my @actual = Git::parse_mailboxes("$str");
is_deeply(\@expected, \@actual, qq[same output : $str]);
}
TODO: {
local $TODO = "known breakage";
foreach my $str (@known_failure_list) {
my @expected = map { $_->format } Mail::Address->parse("$str");
my @actual = Git::parse_mailboxes("$str");
is_deeply(\@expected, \@actual, qq[same output : $str]);
}
}
my $is_passing = eval { Test::More->is_passing };
exit($is_passing ? 0 : 1) unless $@ =~ /Can't locate object method/;
......@@ -172,6 +172,25 @@ test_expect_success $PREREQ 'cc trailer with various syntax' '
test_cmp expected-cc commandline1
'
test_expect_success $PREREQ 'setup fake get_maintainer.pl script for cc trailer' "
write_script expected-cc-script.sh <<-EOF
echo 'One Person <one@example.com> (supporter:THIS (FOO/bar))'
echo 'Two Person <two@example.com> (maintainer:THIS THING)'
echo 'Third List <three@example.com> (moderated list:THIS THING (FOO/bar))'
echo '<four@example.com> (moderated list:FOR THING)'
echo 'five@example.com (open list:FOR THING (FOO/bar))'
echo 'six@example.com (open list)'
EOF
"
test_expect_success $PREREQ 'cc trailer with get_maintainer.pl output' '
clean_fake_sendmail &&
git send-email -1 --to=recipient@example.com \
--cc-cmd=./expected-cc-script.sh \
--smtp-server="$(pwd)/fake.sendmail" &&
test_cmp expected-cc commandline1
'
test_expect_success $PREREQ 'setup expect' "
cat >expected-show-all-headers <<\EOF
0001-Second.patch
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment