]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Import.pm
import: fall back to Sender for extracting name and email
[public-inbox.git] / lib / PublicInbox / Import.pm
index ff5b3f38460fedf8bf0853517ca22923dcf09f05..664bec6910e5f4d70c6c10e21a1ff2de2da6bd09 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # git fast-import-based ssoma-mda MDA replacement
@@ -10,14 +10,27 @@ use warnings;
 use Fcntl qw(:flock :DEFAULT);
 use PublicInbox::Spawn qw(spawn);
 use PublicInbox::MID qw(mid_mime mid2path);
+use PublicInbox::Address;
+use PublicInbox::ContentId qw(content_id);
+use PublicInbox::MsgTime qw(msg_timestamp);
 
 sub new {
-       my ($class, $git, $name, $email) = @_;
+       my ($class, $git, $name, $email, $ibx) = @_;
+       my $ref = 'refs/heads/master';
+       if ($ibx) {
+               $ref = $ibx->{ref_head} || 'refs/heads/master';
+               $name ||= $ibx->{name};
+               $email ||= $ibx->{-primary_address};
+       }
        bless {
                git => $git,
                ident => "$name <$email>",
                mark => 1,
-               ref => 'refs/heads/master',
+               ref => $ref,
+               inbox => $ibx,
+               path_type => '2/38', # or 'v2'
+               ssoma_lock => 1, # disable for v2
+               bytes_added => 0,
        }, $class
 }
 
@@ -32,17 +45,21 @@ sub gfi_start {
        pipe($out_r, $out_w) or die "pipe failed: $!";
        my $git = $self->{git};
        my $git_dir = $git->{git_dir};
-       my $lockpath = "$git_dir/ssoma.lock";
-       sysopen(my $lockfh, $lockpath, O_WRONLY|O_CREAT) or
-               die "failed to open lock $lockpath: $!";
 
-       # wait for other processes to be done
-       flock($lockfh, LOCK_EX) or die "lock failed: $!\n";
+       my $lockfh;
+       if ($self->{ssoma_lock}) {
+               my $lockpath = "$git_dir/ssoma.lock";
+               sysopen($lockfh, $lockpath, O_WRONLY|O_CREAT) or
+                       die "failed to open lock $lockpath: $!";
+               # wait for other processes to be done
+               flock($lockfh, LOCK_EX) or die "lock failed: $!\n";
+       }
+
        local $/ = "\n";
        chomp($self->{tip} = $git->qx(qw(rev-parse --revs-only), $self->{ref}));
 
        my @cmd = ('git', "--git-dir=$git_dir", qw(fast-import
-                       --quiet --done --date-format=rfc2822));
+                       --quiet --done --date-format=raw));
        my $rdr = { 0 => fileno($out_r), 1 => fileno($in_w) };
        my $pid = spawn(\@cmd, undef, $rdr);
        die "spawn fast-import failed: $!" unless defined $pid;
@@ -52,19 +69,14 @@ sub gfi_start {
        $self->{lockfh} = $lockfh;
        $self->{pid} = $pid;
        $self->{nchg} = 0;
+       binmode $out_w, ':raw' or die "binmode :raw failed: $!";
+       binmode $in_r, ':raw' or die "binmode :raw failed: $!";
        ($in_r, $out_w);
 }
 
 sub wfail () { die "write to fast-import failed: $!" }
 
-sub now2822 () {
-       my @t = gmtime(time);
-       my $day = qw(Sun Mon Tue Wed Thu Fri Sat)[$t[6]];
-       my $mon = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)[$t[4]];
-
-       sprintf('%s, %2d %s %d %02d:%02d:%02d +0000',
-               $day, $t[3], $mon, $t[5] + 1900, $t[2], $t[1], $t[0]);
-}
+sub now_raw () { time . ' +0000' }
 
 sub norm_body ($) {
        my ($mime) = @_;
@@ -73,31 +85,29 @@ sub norm_body ($) {
        $b
 }
 
-# returns undef on non-existent
-# ('MISMATCH', msg) on mismatch
-# (:MARK, msg) on success
-sub remove {
-       my ($self, $mime) = @_; # mime = Email::MIME
-
-       my $mid = mid_mime($mime);
-       my $path = mid2path($mid);
-
-       my ($r, $w) = $self->gfi_start;
-       my $tip = $self->{tip};
-       return ('MISSING', undef) if $tip eq '';
-
+# only used for v1 (ssoma) inboxes
+sub _check_path ($$$$) {
+       my ($r, $w, $tip, $path) = @_;
+       return if $tip eq '';
        print $w "ls $tip $path\n" or wfail;
        local $/ = "\n";
-       my $check = <$r>;
-       defined $check or die "EOF from fast-import / ls: $!";
-       return ('MISSING', undef) if $check =~ /\Amissing /;
-       $check =~ m!\A100644 blob ([a-f0-9]{40})\t!s or die "not blob: $check";
+       defined(my $info = <$r>) or die "EOF from fast-import: $!";
+       $info =~ /\Amissing / ? undef : $info;
+}
+
+sub check_remove_v1 {
+       my ($r, $w, $tip, $path, $mime) = @_;
+
+       my $info = _check_path($r, $w, $tip, $path) or return ('MISSING',undef);
+       $info =~ m!\A100644 blob ([a-f0-9]{40})\t!s or die "not blob: $info";
        my $blob = $1;
+
        print $w "cat-blob $blob\n" or wfail;
-       $check = <$r>;
-       defined $check or die "EOF from fast-import / cat-blob: $!";
-       $check =~ /\A[a-f0-9]{40} blob (\d+)\n\z/ or
-                               die "unexpected cat-blob response: $check";
+       local $/ = "\n";
+       $info = <$r>;
+       defined $info or die "EOF from fast-import / cat-blob: $!";
+       $info =~ /\A[a-f0-9]{40} blob (\d+)\n\z/ or
+                               die "unexpected cat-blob response: $info";
        my $left = $1;
        my $offset = 0;
        my $buf = '';
@@ -112,7 +122,7 @@ sub remove {
        $n = read($r, my $lf, 1);
        defined($n) or die "read final byte of cat-blob failed: $!";
        die "bad read on final byte: <$lf>" if $lf ne "\n";
-       my $cur = Email::MIME->new($buf);
+       my $cur = PublicInbox::MIME->new($buf);
        my $cur_s = $cur->header('Subject');
        $cur_s = '' unless defined $cur_s;
        my $cur_m = $mime->header('Subject');
@@ -120,6 +130,52 @@ sub remove {
        if ($cur_s ne $cur_m || norm_body($cur) ne norm_body($mime)) {
                return ('MISMATCH', $cur);
        }
+       (undef, $cur);
+}
+
+# used for v2 (maybe)
+sub checkpoint {
+       my ($self) = @_;
+       return unless $self->{pid};
+       print { $self->{out} } "checkpoint\n" or wfail;
+       undef;
+}
+
+# used for v2
+sub get_mark {
+       my ($self, $mark) = @_;
+       die "not active\n" unless $self->{pid};
+       my ($r, $w) = $self->gfi_start;
+       print $w "get-mark $mark\n" or wfail;
+       defined(my $oid = <$r>) or die "get-mark failed, need git 2.6.0+\n";
+       $oid;
+}
+
+# returns undef on non-existent
+# ('MISMATCH', Email::MIME) on mismatch
+# (:MARK, Email::MIME) on success
+#
+# For v2 inboxes, the content_id is returned instead of the msg
+# v2 callers should check with Xapian before calling this as
+# it is not idempotent.
+sub remove {
+       my ($self, $mime, $msg) = @_; # mime = Email::MIME
+
+       my $path_type = $self->{path_type};
+       my ($path, $err, $cur, $blob);
+
+       my ($r, $w) = $self->gfi_start;
+       my $tip = $self->{tip};
+       if ($path_type eq '2/38') {
+               $path = mid2path(mid_mime($mime));
+               ($err, $cur) = check_remove_v1($r, $w, $tip, $path, $mime);
+               return ($err, $cur) if $err;
+       } else {
+               $cur = content_id($mime);
+               my $len = length($cur);
+               $blob = $self->{mark}++;
+               print $w "blob\nmark :$blob\ndata $len\n$cur\n" or wfail;
+       }
 
        my $ref = $self->{ref};
        my $commit = $self->{mark}++;
@@ -128,57 +184,112 @@ sub remove {
                print $w "reset $ref\n" or wfail;
        }
        my $ident = $self->{ident};
-       my $now = now2822();
+       my $now = now_raw();
+       $msg ||= 'rm';
+       my $len = length($msg) + 1;
        print $w "commit $ref\nmark :$commit\n",
                "author $ident $now\n",
                "committer $ident $now\n",
-               "data 3\nrm\n\n",
+               "data $len\n$msg\n\n",
                'from ', ($parent ? $parent : $tip), "\n" or wfail;
-       print $w "D $path\n\n" or wfail;
+       if (defined $path) {
+               print $w "D $path\n\n" or wfail;
+       } else {
+               print $w "M 100644 :$blob d\n\n" or wfail;
+       }
        $self->{nchg}++;
        (($self->{tip} = ":$commit"), $cur);
 }
 
-# returns undef on duplicate
-sub add {
-       my ($self, $mime, $check_cb) = @_; # mime = Email::MIME
+sub parse_date ($) {
+       my ($mime) = @_;
+       my ($ts, $zone) = msg_timestamp($mime->header_obj);
+       $ts = 0 if $ts < 0; # git uses unsigned times
+       "$ts $zone";
+}
+
+sub extract_author_info ($) {
+       my ($mime) = @_;
 
+       my $sender = '';
        my $from = $mime->header('From');
-       my ($email) = ($from =~ /([^<\s]+\@[^>\s]+)/g);
-       my $name = $from;
-       $name =~ s/\s*\S+\@\S+\s*\z//;
+       my ($email) = PublicInbox::Address::emails($from);
+       my ($name) = PublicInbox::Address::names($from);
+       if (!defined($name) || !defined($email)) {
+               $sender = $mime->header('Sender');
+               if (!defined($name)) {
+                       ($name) = PublicInbox::Address::names($sender);
+               }
+               if (!defined($email)) {
+                       ($email) = PublicInbox::Address::emails($sender);
+               }
+       }
+       if (defined $email) {
+               # quiet down wide character warnings with utf8::encode
+               utf8::encode($email);
+       } else {
+               $email = '';
+               warn "no email in From: $from or Sender: $sender\n";
+       }
+
        # git gets confused with:
        #  "'A U Thor <u@example.com>' via foo" <foo@example.com>
        # ref:
        # <CAD0k6qSUYANxbjjbE4jTW4EeVwOYgBD=bXkSu=akiYC_CB7Ffw@mail.gmail.com>
-       $name =~ tr/<>// and $name = $email;
+       if (defined $name) {
+               $name =~ tr/<>//d;
+               utf8::encode($name);
+       } else {
+               $name = '';
+               warn "no name in From: $from or Sender: $sender\n";
+       }
+       ($name, $email);
+}
+
+# returns undef on duplicate
+# returns the :MARK of the most recent commit
+sub add {
+       my ($self, $mime, $check_cb) = @_; # mime = Email::MIME
 
-       my $date = $mime->header('Date');
+       my ($name, $email) = extract_author_info($mime);
+       my $date_raw = parse_date($mime);
        my $subject = $mime->header('Subject');
        $subject = '(no subject)' unless defined $subject;
-       my $mid = mid_mime($mime);
-       my $path = mid2path($mid);
+       my $path_type = $self->{path_type};
+
+       my $path;
+       if ($path_type eq '2/38') {
+               $path = mid2path(mid_mime($mime));
+       } else { # v2 layout, one file:
+               $path = 'm';
+       }
 
        my ($r, $w) = $self->gfi_start;
        my $tip = $self->{tip};
-       if ($tip ne '') {
-               print $w "ls $tip $path\n" or wfail;
-               local $/ = "\n";
-               my $check = <$r>;
-               defined $check or die "EOF from fast-import: $!";
-               return unless $check =~ /\Amissing /;
+       if ($path_type eq '2/38') {
+               _check_path($r, $w, $tip, $path) and return;
        }
 
        # kill potentially confusing/misleading headers
        $mime->header_set($_) for qw(bytes lines content-length status);
+
+       # spam check:
        if ($check_cb) {
                $mime = $check_cb->($mime) or return;
        }
 
-       $mime = $mime->as_string;
        my $blob = $self->{mark}++;
-       print $w "blob\nmark :$blob\ndata ", length($mime), "\n" or wfail;
-       print $w $mime, "\n" or wfail;
+       my $str = $mime->as_string;
+       my $n = length($str);
+       $self->{bytes_added} += $n;
+       print $w "blob\nmark :$blob\ndata ", $n, "\n" or wfail;
+       print $w $str, "\n" or wfail;
+
+       # v2: we need this for Xapian
+       if ($self->{want_object_info}) {
+               chomp(my $oid = $self->get_mark(":$blob"));
+               $self->{last_object} = [ $oid, $n, \$str ];
+       }
        my $ref = $self->{ref};
        my $commit = $self->{mark}++;
        my $parent = $tip =~ /\A:/ ? $tip : undef;
@@ -187,15 +298,12 @@ sub add {
                print $w "reset $ref\n" or wfail;
        }
 
-       # quiet down wide character warnings:
-       binmode $w, ':utf8' or die "binmode :utf8 failed: $!";
+       utf8::encode($subject);
        print $w "commit $ref\nmark :$commit\n",
-               "author $name <$email> $date\n",
-               "committer $self->{ident} ", now2822(), "\n",
-               "data ", (bytes::length($subject) + 1), "\n",
+               "author $name <$email> $date_raw\n",
+               "committer $self->{ident} ", now_raw(), "\n" or wfail;
+       print $w "data ", (length($subject) + 1), "\n",
                $subject, "\n\n" or wfail;
-       binmode $w, ':raw' or die "binmode :raw failed: $!";
-
        if ($tip ne '') {
                print $w 'from ', ($parent ? $parent : $tip), "\n" or wfail;
        }
@@ -204,6 +312,14 @@ sub add {
        $self->{tip} = ":$commit";
 }
 
+sub run_die ($;$) {
+       my ($cmd, $env) = @_;
+       my $pid = spawn($cmd, $env, undef);
+       defined $pid or die "spawning ".join(' ', @$cmd)." failed: $!";
+       waitpid($pid, 0) == $pid or die join(' ', @$cmd) .' did not finish';
+       $? == 0 or die join(' ', @$cmd) . " failed: $?\n";
+}
+
 sub done {
        my ($self) = @_;
        my $w = delete $self->{out} or return;
@@ -217,36 +333,37 @@ sub done {
        # for compatibility with existing ssoma installations
        # we can probably remove this entirely by 2020
        my $git_dir = $self->{git}->{git_dir};
-       # XXX: change the following scope to: if (-e $index) # in 2018 or so..
        my @cmd = ('git', "--git-dir=$git_dir");
-       if ($nchg && !$ENV{FAST}) {
-               my $index = "$git_dir/ssoma.index";
+       my $index = "$git_dir/ssoma.index";
+       if ($nchg && -e $index && !$ENV{FAST}) {
                my $env = { GIT_INDEX_FILE => $index };
-               my @rt = (@cmd, qw(read-tree -m -v -i), $self->{ref});
-               $pid = spawn(\@rt, $env, undef);
-               defined $pid or die "spawn read-tree failed: $!";
-               waitpid($pid, 0) == $pid or die 'read-tree did not finish';
-               $? == 0 or die "failed to update $git_dir/ssoma.index: $?\n";
+               run_die([@cmd, qw(read-tree -m -v -i), $self->{ref}], $env);
        }
        if ($nchg) {
-               $pid = spawn([@cmd, 'update-server-info'], undef, undef);
-               defined $pid or die "spawn update-server-info failed: $!\n";
-               waitpid($pid, 0) == $pid or
-                       die 'update-server-info did not finish';
-               $? == 0 or die "failed to update-server-info: $?\n";
-
-               eval {
+               run_die([@cmd, 'update-server-info'], undef);
+               ($self->{path_type} eq '2/38') and eval {
                        require PublicInbox::SearchIdx;
-                       my $s = PublicInbox::SearchIdx->new($git_dir);
+                       my $inbox = $self->{inbox} || $git_dir;
+                       my $s = PublicInbox::SearchIdx->new($inbox);
                        $s->index_sync({ ref => $self->{ref} });
                };
+
+               eval { run_die([@cmd, qw(gc --auto)], undef) };
        }
 
+       $self->{ssoma_lock} or return;
        my $lockfh = delete $self->{lockfh} or die "BUG: not locked: $!";
        flock($lockfh, LOCK_UN) or die "unlock failed: $!";
        close $lockfh or die "close lock failed: $!";
 }
 
+sub atfork_child {
+       my ($self) = @_;
+       foreach my $f (qw(in out)) {
+               close $self->{$f} or die "failed to close import[$f]: $!\n";
+       }
+}
+
 1;
 __END__
 =pod