lib/PublicInbox/Import.pm

   1 # Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3 #
   4 # git fast-import-based ssoma-mda MDA replacement
   5 # This is only ever run by public-inbox-mda, public-inbox-learn
   6 # and public-inbox-watch. Not the WWW or NNTP code which only
   7 # requires read-only access.
   8 package PublicInbox::Import;
   9 use strict;
  10 use parent qw(PublicInbox::Lock);
  11 use v5.10.1;
  12 use PublicInbox::Spawn qw(run_die popen_rd);
  13 use PublicInbox::MID qw(mids mid2path);
  14 use PublicInbox::Address;
  15 use PublicInbox::Smsg;
  16 use PublicInbox::MsgTime qw(msg_datestamp);
  17 use PublicInbox::ContentHash qw(content_digest);
  18 use PublicInbox::MDA;
  19 use PublicInbox::Eml;
  20 use POSIX qw(strftime);
  21
  22 sub default_branch () {
  23         state $default_branch = do {
  24                 delete local $ENV{GIT_CONFIG};
  25                 my $r = popen_rd([qw(git config --global init.defaultBranch)]);
  26                 chomp(my $h = <$r> // '');
  27                 close $r;
  28                 $h eq '' ? 'refs/heads/master' : $h;
  29         }
  30 }
  31
  32 sub new {
  33         # we can't change arg order, this is documented in POD
  34         # and external projects may rely on it:
  35         my ($class, $git, $name, $email, $ibx) = @_;
  36         my $ref;
  37         if ($ibx) {
  38                 $ref = $ibx->{ref_head};
  39                 $name //= $ibx->{name};
  40                 $email //= $ibx->{-primary_address};
  41                 $git //= $ibx->git;
  42         }
  43         bless {
  44                 git => $git,
  45                 ident => "$name <$email>",
  46                 mark => 1,
  47                 ref => $ref // default_branch,
  48                 ibx => $ibx,
  49                 path_type => '2/38', # or 'v2'
  50                 lock_path => "$git->{git_dir}/ssoma.lock", # v2 changes this
  51                 bytes_added => 0,
  52         }, $class
  53 }
  54
  55 # idempotent start function
  56 sub gfi_start {
  57         my ($self) = @_;
  58
  59         return ($self->{in}, $self->{out}) if $self->{in};
  60
  61         my ($in_r, $out_r, $out_w);
  62         pipe($out_r, $out_w) or die "pipe failed: $!";
  63
  64         $self->lock_acquire;
  65         eval {
  66                 my ($git, $ref) = @$self{qw(git ref)};
  67                 local $/ = "\n";
  68                 chomp($self->{tip} = $git->qx(qw(rev-parse --revs-only), $ref));
  69                 die "fatal: rev-parse --revs-only $ref: \$?=$?" if $?;
  70                 if ($self->{path_type} ne '2/38' && $self->{tip}) {
  71                         local $/ = "\0";
  72                         my @t = $git->qx(qw(ls-tree -r -z --name-only), $ref);
  73                         die "fatal: ls-tree -r -z --name-only $ref: \$?=$?" if $?;
  74                         chomp @t;
  75                         $self->{-tree} = { map { $_ => 1 } @t };
  76                 }
  77                 $in_r = $self->{in} = $git->popen(qw(fast-import
  78                                         --quiet --done --date-format=raw),
  79                                         undef, { 0 => $out_r });
  80                 $out_w->autoflush(1);
  81                 $self->{out} = $out_w;
  82                 $self->{nchg} = 0;
  83         };
  84         if ($@) {
  85                 $self->lock_release;
  86                 die $@;
  87         }
  88         ($in_r, $out_w);
  89 }
  90
  91 sub wfail () { die "write to fast-import failed: $!" }
  92
  93 sub now_raw () { time . ' +0000' }
  94
  95 sub norm_body ($) {
  96         my ($mime) = @_;
  97         my $b = $mime->body_raw;
  98         $b =~ s/(\r?\n)+\z//s;
  99         $b
 100 }
 101
 102 # only used for v1 (ssoma) inboxes
 103 sub _check_path ($$$$) {
 104         my ($r, $w, $tip, $path) = @_;
 105         return if $tip eq '';
 106         print $w "ls $tip $path\n" or wfail;
 107         local $/ = "\n";
 108         defined(my $info = <$r>) or die "EOF from fast-import: $!";
 109         $info =~ /\Amissing / ? undef : $info;
 110 }
 111
 112 sub _cat_blob ($$$) {
 113         my ($r, $w, $oid) = @_;
 114         print $w "cat-blob $oid\n" or wfail;
 115         local $/ = "\n";
 116         my $info = <$r>;
 117         defined $info or die "EOF from fast-import / cat-blob: $!";
 118         $info =~ /\A[a-f0-9]{40,} blob ([0-9]+)\n\z/ or return;
 119         my $left = $1;
 120         my $offset = 0;
 121         my $buf = '';
 122         my $n;
 123         while ($left > 0) {
 124                 $n = read($r, $buf, $left, $offset);
 125                 defined($n) or die "read cat-blob failed: $!";
 126                 $n == 0 and die 'fast-export (cat-blob) died';
 127                 $left -= $n;
 128                 $offset += $n;
 129         }
 130         $n = read($r, my $lf, 1);
 131         defined($n) or die "read final byte of cat-blob failed: $!";
 132         die "bad read on final byte: <$lf>" if $lf ne "\n";
 133
 134         # fixup some bugginess in old versions:
 135         $buf =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
 136         \$buf;
 137 }
 138
 139 sub cat_blob {
 140         my ($self, $oid) = @_;
 141         my ($r, $w) = $self->gfi_start;
 142         _cat_blob($r, $w, $oid);
 143 }
 144
 145 sub check_remove_v1 {
 146         my ($r, $w, $tip, $path, $mime) = @_;
 147
 148         my $info = _check_path($r, $w, $tip, $path) or return ('MISSING',undef);
 149         $info =~ m!\A100644 blob ([a-f0-9]{40,})\t!s or die "not blob: $info";
 150         my $oid = $1;
 151         my $msg = _cat_blob($r, $w, $oid) or die "BUG: cat-blob $1 failed";
 152         my $cur = PublicInbox::Eml->new($msg);
 153         my $cur_s = $cur->header('Subject');
 154         $cur_s = '' unless defined $cur_s;
 155         my $cur_m = $mime->header('Subject');
 156         $cur_m = '' unless defined $cur_m;
 157         if ($cur_s ne $cur_m || norm_body($cur) ne norm_body($mime)) {
 158                 return ('MISMATCH', $cur);
 159         }
 160         (undef, $cur);
 161 }
 162
 163 sub checkpoint {
 164         my ($self) = @_;
 165         return unless $self->{in};
 166         print { $self->{out} } "checkpoint\n" or wfail;
 167         undef;
 168 }
 169
 170 sub progress {
 171         my ($self, $msg) = @_;
 172         return unless $self->{in};
 173         print { $self->{out} } "progress $msg\n" or wfail;
 174         readline($self->{in}) eq "progress $msg\n" or die
 175                 "progress $msg not received\n";
 176         undef;
 177 }
 178
 179 sub _update_git_info ($$) {
 180         my ($self, $do_gc) = @_;
 181         # for compatibility with existing ssoma installations
 182         # we can probably remove this entirely by 2020
 183         my $git_dir = $self->{git}->{git_dir};
 184         my @cmd = ('git', "--git-dir=$git_dir");
 185         my $index = "$git_dir/ssoma.index";
 186         if (-e $index && !$ENV{FAST}) {
 187                 my $env = { GIT_INDEX_FILE => $index };
 188                 run_die([@cmd, qw(read-tree -m -v -i), $self->{ref}], $env);
 189         }
 190         eval { run_die([@cmd, 'update-server-info']) };
 191         my $ibx = $self->{ibx};
 192         if ($ibx && $ibx->version == 1 && -d "$ibx->{inboxdir}/public-inbox" &&
 193                                 eval { require PublicInbox::SearchIdx }) {
 194                 eval {
 195                         my $s = PublicInbox::SearchIdx->new($ibx);
 196                         $s->index_sync({ ref => $self->{ref} });
 197                 };
 198                 warn "$ibx->{inboxdir} index failed: $@\n" if $@;
 199         }
 200         eval { run_die([@cmd, qw(gc --auto)]) } if $do_gc;
 201 }
 202
 203 sub barrier {
 204         my ($self) = @_;
 205
 206         # For safety, we ensure git checkpoint is complete before because
 207         # the data in git is still more important than what is in Xapian
 208         # in v2.  Performance may be gained by delaying the ->progress
 209         # call but we lose safety
 210         if ($self->{nchg}) {
 211                 $self->checkpoint;
 212                 $self->progress('checkpoint');
 213                 _update_git_info($self, 0);
 214                 $self->{nchg} = 0;
 215         }
 216 }
 217
 218 # used for v2
 219 sub get_mark {
 220         my ($self, $mark) = @_;
 221         die "not active\n" unless $self->{in};
 222         my ($r, $w) = $self->gfi_start;
 223         print $w "get-mark $mark\n" or wfail;
 224         defined(my $oid = <$r>) or die "get-mark failed, need git 2.6.0+\n";
 225         chomp($oid);
 226         $oid;
 227 }
 228
 229 # returns undef on non-existent
 230 # ('MISMATCH', PublicInbox::Eml) on mismatch
 231 # (:MARK, PublicInbox::Eml) on success
 232 #
 233 # v2 callers should check with Xapian before calling this as
 234 # it is not idempotent.
 235 sub remove {
 236         my ($self, $mime, $msg) = @_; # mime = PublicInbox::Eml or Email::MIME
 237
 238         my $path_type = $self->{path_type};
 239         my ($path, $err, $cur, $blob);
 240
 241         my ($r, $w) = $self->gfi_start;
 242         my $tip = $self->{tip};
 243         if ($path_type eq '2/38') {
 244                 $path = mid2path(v1_mid0($mime));
 245                 ($err, $cur) = check_remove_v1($r, $w, $tip, $path, $mime);
 246                 return ($err, $cur) if $err;
 247         } else {
 248                 my $sref;
 249                 if (ref($mime) eq 'SCALAR') { # optimization used by V2Writable
 250                         $sref = $mime;
 251                 } else { # XXX should not be necessary:
 252                         my $str = $mime->as_string;
 253                         $sref = \$str;
 254                 }
 255                 my $len = length($$sref);
 256                 $blob = $self->{mark}++;
 257                 print $w "blob\nmark :$blob\ndata $len\n",
 258                         $$sref, "\n" or wfail;
 259         }
 260
 261         my $ref = $self->{ref};
 262         my $commit = $self->{mark}++;
 263         my $parent = $tip =~ /\A:/ ? $tip : undef;
 264         unless ($parent) {
 265                 print $w "reset $ref\n" or wfail;
 266         }
 267         my $ident = $self->{ident};
 268         my $now = now_raw();
 269         $msg //= 'rm';
 270         my $len = length($msg) + 1;
 271         print $w "commit $ref\nmark :$commit\n",
 272                 "author $ident $now\n",
 273                 "committer $ident $now\n",
 274                 "data $len\n$msg\n\n",
 275                 'from ', ($parent ? $parent : $tip), "\n" or wfail;
 276         if (defined $path) {
 277                 print $w "D $path\n\n" or wfail;
 278         } else {
 279                 clean_tree_v2($self, $w, 'd');
 280                 print $w "M 100644 :$blob d\n\n" or wfail;
 281         }
 282         $self->{nchg}++;
 283         (($self->{tip} = ":$commit"), $cur);
 284 }
 285
 286 sub git_timestamp ($) {
 287         my ($ts, $zone) = @{$_[0]};
 288         $ts = 0 if $ts < 0; # git uses unsigned times
 289         "$ts $zone";
 290 }
 291
 292 sub extract_cmt_info ($;$) {
 293         my ($mime, $smsg) = @_;
 294         # $mime is PublicInbox::Eml, but remains Email::MIME-compatible
 295         $smsg //= bless {}, 'PublicInbox::Smsg';
 296
 297         $smsg->populate($mime);
 298
 299         my $sender = '';
 300         my $from = delete($smsg->{From}) // '';
 301         my ($email) = PublicInbox::Address::emails($from);
 302         my ($name) = PublicInbox::Address::names($from);
 303         if (!defined($name) || !defined($email)) {
 304                 $sender = $mime->header('Sender') // '';
 305                 $name //= (PublicInbox::Address::names($sender))[0];
 306                 $email //= (PublicInbox::Address::emails($sender))[0];
 307         }
 308         if (defined $email) {
 309                 # Email::Address::XS may leave quoted '<' in addresses,
 310                 # which git-fast-import doesn't like
 311                 $email =~ tr/<>//d;
 312
 313                 # quiet down wide character warnings with utf8::encode
 314                 utf8::encode($email);
 315         } else {
 316                 $email = '';
 317                 warn "no email in From: $from or Sender: $sender\n";
 318         }
 319
 320         # git gets confused with:
 321         #  "'A U Thor <u@example.com>' via foo" <foo@example.com>
 322         # ref:
 323         # <CAD0k6qSUYANxbjjbE4jTW4EeVwOYgBD=bXkSu=akiYC_CB7Ffw@mail.gmail.com>
 324         if (defined $name) {
 325                 $name =~ tr/<>//d;
 326                 utf8::encode($name);
 327         } else {
 328                 $name = '';
 329                 warn "no name in From: $from or Sender: $sender\n";
 330         }
 331
 332         my $subject = delete($smsg->{Subject}) // '(no subject)';
 333         utf8::encode($subject);
 334         my $at = git_timestamp(delete $smsg->{-ds});
 335         my $ct = git_timestamp(delete $smsg->{-ts});
 336         ("$name <$email>", $at, $ct, $subject);
 337 }
 338
 339 # kill potentially confusing/misleading headers
 340 our @UNWANTED_HEADERS = (qw(Bytes Lines Content-Length),
 341                         qw(Status X-Status));
 342 sub drop_unwanted_headers ($) {
 343         my ($eml) = @_;
 344         for (@UNWANTED_HEADERS, @PublicInbox::MDA::BAD_HEADERS) {
 345                 $eml->header_set($_);
 346         }
 347 }
 348
 349 # used by V2Writable, too
 350 sub append_mid ($$) {
 351         my ($hdr, $mid0) = @_;
 352         # @cur is likely empty if we need to call this sub, but it could
 353         # have random unparseable crap which we'll preserve, too.
 354         my @cur = $hdr->header_raw('Message-ID');
 355         $hdr->header_set('Message-ID', @cur, "<$mid0>");
 356 }
 357
 358 sub v1_mid0 ($) {
 359         my ($eml) = @_;
 360         my $mids = mids($eml);
 361
 362         if (!scalar(@$mids)) { # spam often has no Message-ID
 363                 my $mid0 = digest2mid(content_digest($eml), $eml);
 364                 append_mid($eml, $mid0);
 365                 return $mid0;
 366         }
 367         $mids->[0];
 368 }
 369 sub clean_tree_v2 ($$$) {
 370         my ($self, $w, $keep) = @_;
 371         my $tree = $self->{-tree} or return; #v2 only
 372         delete $tree->{$keep};
 373         foreach (keys %$tree) {
 374                 print $w "D $_\n" or wfail;
 375         }
 376         %$tree = ($keep => 1);
 377 }
 378
 379 # returns undef on duplicate
 380 # returns the :MARK of the most recent commit
 381 sub add {
 382         my ($self, $mime, $check_cb, $smsg) = @_;
 383
 384         my ($author, $at, $ct, $subject) = extract_cmt_info($mime, $smsg);
 385         my $path_type = $self->{path_type};
 386         my $path;
 387         if ($path_type eq '2/38') {
 388                 $path = mid2path(v1_mid0($mime));
 389         } else { # v2 layout, one file:
 390                 $path = 'm';
 391         }
 392
 393         my ($r, $w) = $self->gfi_start;
 394         my $tip = $self->{tip};
 395         if ($path_type eq '2/38') {
 396                 _check_path($r, $w, $tip, $path) and return;
 397         }
 398
 399         drop_unwanted_headers($mime);
 400
 401         # spam check:
 402         if ($check_cb) {
 403                 $mime = $check_cb->($mime, $self->{ibx}) or return;
 404         }
 405
 406         my $blob = $self->{mark}++;
 407         my $raw_email = $mime->{-public_inbox_raw} // $mime->as_string;
 408         my $n = length($raw_email);
 409         $self->{bytes_added} += $n;
 410         print $w "blob\nmark :$blob\ndata ", $n, "\n" or wfail;
 411         print $w $raw_email, "\n" or wfail;
 412
 413         # v2: we need this for Xapian
 414         if ($smsg) {
 415                 $smsg->{blob} = $self->get_mark(":$blob");
 416                 $smsg->set_bytes($raw_email, $n);
 417                 if (my $oidx = delete $smsg->{-oidx}) { # used by LeiStore
 418                         return if $oidx->blob_exists($smsg->{blob});
 419                 }
 420         }
 421         my $ref = $self->{ref};
 422         my $commit = $self->{mark}++;
 423         my $parent = $tip =~ /\A:/ ? $tip : undef;
 424
 425         unless ($parent) {
 426                 print $w "reset $ref\n" or wfail;
 427         }
 428
 429         print $w "commit $ref\nmark :$commit\n",
 430                 "author $author $at\n",
 431                 "committer $self->{ident} $ct\n" or wfail;
 432         print $w "data ", (length($subject) + 1), "\n",
 433                 $subject, "\n\n" or wfail;
 434         if ($tip ne '') {
 435                 print $w 'from ', ($parent ? $parent : $tip), "\n" or wfail;
 436         }
 437         clean_tree_v2($self, $w, $path);
 438         print $w "M 100644 :$blob $path\n\n" or wfail;
 439         $self->{nchg}++;
 440         $self->{tip} = ":$commit";
 441 }
 442
 443 my @INIT_FILES = ('HEAD' => undef, # filled in at runtime
 444                 'description' => <<EOD,
 445 Unnamed repository; edit this file 'description' to name the repository.
 446 EOD
 447                 'config' => <<EOC);
 448 [core]
 449         repositoryFormatVersion = 0
 450         filemode = true
 451         bare = true
 452 [repack]
 453         writeBitmaps = true
 454 EOC
 455
 456 sub init_bare {
 457         my ($dir, $head) = @_; # or self
 458         $dir = $dir->{git}->{git_dir} if ref($dir);
 459         require File::Path;
 460         File::Path::mkpath([ map { "$dir/$_" } qw(objects/info refs/heads) ]);
 461         $INIT_FILES[1] //= 'ref: '.default_branch."\n";
 462         my @fn_contents = @INIT_FILES;
 463         $fn_contents[1] = "ref: refs/heads/$head\n" if defined $head;
 464         while (my ($fn, $contents) = splice(@fn_contents, 0, 2)) {
 465                 my $f = $dir.'/'.$fn;
 466                 next if -f $f;
 467                 open my $fh, '>', $f or die "open $f: $!";
 468                 print $fh $contents or die "print $f: $!";
 469                 close $fh or die "close $f: $!";
 470         }
 471 }
 472
 473 # true if locked and active
 474 sub active { !!$_[0]->{out} }
 475
 476 sub done {
 477         my ($self) = @_;
 478         my $w = delete $self->{out} or return;
 479         eval {
 480                 my $r = delete $self->{in} or die 'BUG: missing {in} when done';
 481                 print $w "done\n" or wfail;
 482                 close $r or die "fast-import failed: $?"; # ProcessPipe::CLOSE
 483         };
 484         my $wait_err = $@;
 485         my $nchg = delete $self->{nchg};
 486         if ($nchg && !$wait_err) {
 487                 eval { _update_git_info($self, 1) };
 488                 warn "E: $self->{git}->{git_dir} update info: $@\n" if $@;
 489         }
 490         $self->lock_release(!!$nchg);
 491         $self->{git}->cleanup;
 492         die $wait_err if $wait_err;
 493 }
 494
 495 sub atfork_child {
 496         my ($self) = @_;
 497         foreach my $f (qw(in out)) {
 498                 next unless defined($self->{$f});
 499                 close $self->{$f} or die "failed to close import[$f]: $!\n";
 500         }
 501 }
 502
 503 sub digest2mid ($$) {
 504         my ($dig, $hdr) = @_;
 505         my $b64 = $dig->clone->b64digest;
 506         # Make our own URLs nicer:
 507         # See "Base 64 Encoding with URL and Filename Safe Alphabet" in RFC4648
 508         $b64 =~ tr!+/=!-_!d;
 509
 510         # Add a date prefix to prevent a leading '-' in case that trips
 511         # up some tools (e.g. if a Message-ID were a expected as a
 512         # command-line arg)
 513         my $dt = msg_datestamp($hdr);
 514         $dt = POSIX::strftime('%Y%m%d%H%M%S', gmtime($dt));
 515         "$dt.$b64" . '@z';
 516 }
 517
 518 sub rewrite_commit ($$$$) {
 519         my ($self, $oids, $buf, $mime) = @_;
 520         my ($author, $at, $ct, $subject);
 521         if ($mime) {
 522                 ($author, $at, $ct, $subject) = extract_cmt_info($mime);
 523         } else {
 524                 $author = '<>';
 525                 $subject = 'purged '.join(' ', @$oids);
 526         }
 527         @$oids = ();
 528         $subject .= "\n";
 529         foreach my $i (0..$#$buf) {
 530                 my $l = $buf->[$i];
 531                 if ($l =~ /^author .* ([0-9]+ [\+-]?[0-9]+)$/) {
 532                         $at //= $1;
 533                         $buf->[$i] = "author $author $at\n";
 534                 } elsif ($l =~ /^committer .* ([0-9]+ [\+-]?[0-9]+)$/) {
 535                         $ct //= $1;
 536                         $buf->[$i] = "committer $self->{ident} $ct\n";
 537                 } elsif ($l =~ /^data ([0-9]+)/) {
 538                         $buf->[$i++] = "data " . length($subject) . "\n";
 539                         $buf->[$i] = $subject;
 540                         last;
 541                 }
 542         }
 543 }
 544
 545 # returns the new commit OID if a replacement was done
 546 # returns undef if nothing was done
 547 sub replace_oids {
 548         my ($self, $mime, $replace_map) = @_; # oid => raw string
 549         my $tmp = "refs/heads/replace-".((keys %$replace_map)[0]);
 550         my $old = $self->{'ref'};
 551         my $git = $self->{git};
 552         my @export = (qw(fast-export --no-data --use-done-feature), $old);
 553         my $rd = $git->popen(@export);
 554         my ($r, $w) = $self->gfi_start;
 555         my @buf;
 556         my $nreplace = 0;
 557         my @oids;
 558         my ($done, $mark);
 559         my $tree = $self->{-tree};
 560         while (<$rd>) {
 561                 if (/^reset (?:.+)/) {
 562                         push @buf, "reset $tmp\n";
 563                 } elsif (/^commit (?:.+)/) {
 564                         if (@buf) {
 565                                 print $w @buf or wfail;
 566                                 @buf = ();
 567                         }
 568                         push @buf, "commit $tmp\n";
 569                 } elsif (/^data ([0-9]+)/) {
 570                         # only commit message, so $len is small:
 571                         my $len = $1; # + 1 for trailing "\n"
 572                         push @buf, $_;
 573                         my $n = read($rd, my $buf, $len) or die "read: $!";
 574                         $len == $n or die "short read ($n < $len)";
 575                         push @buf, $buf;
 576                 } elsif (/^M 100644 ([a-f0-9]+) (\w+)/) {
 577                         my ($oid, $path) = ($1, $2);
 578                         $tree->{$path} = 1;
 579                         my $sref = $replace_map->{$oid};
 580                         if (defined $sref) {
 581                                 push @oids, $oid;
 582                                 my $n = length($$sref);
 583                                 push @buf, "M 100644 inline $path\ndata $n\n";
 584                                 push @buf, $$sref; # hope CoW works...
 585                                 push @buf, "\n";
 586                         } else {
 587                                 push @buf, $_;
 588                         }
 589                 } elsif (/^D (\w+)/) {
 590                         my $path = $1;
 591                         push @buf, $_ if $tree->{$path};
 592                 } elsif ($_ eq "\n") {
 593                         if (@oids) {
 594                                 if (!$mime) {
 595                                         my $out = join('', @buf);
 596                                         $out =~ s/^/# /sgm;
 597                                         warn "purge rewriting\n", $out, "\n";
 598                                 }
 599                                 rewrite_commit($self, \@oids, \@buf, $mime);
 600                                 $nreplace++;
 601                         }
 602                         print $w @buf, "\n" or wfail;
 603                         @buf = ();
 604                 } elsif ($_ eq "done\n") {
 605                         $done = 1;
 606                 } elsif (/^mark :([0-9]+)$/) {
 607                         push @buf, $_;
 608                         $mark = $1;
 609                 } else {
 610                         push @buf, $_;
 611                 }
 612         }
 613         close $rd or die "close fast-export failed: $?";
 614         if (@buf) {
 615                 print $w @buf or wfail;
 616         }
 617         die 'done\n not seen from fast-export' unless $done;
 618         chomp(my $cmt = $self->get_mark(":$mark")) if $nreplace;
 619         $self->{nchg} = 0; # prevent _update_git_info until update-ref:
 620         $self->done;
 621         my @git = ('git', "--git-dir=$git->{git_dir}");
 622
 623         run_die([@git, qw(update-ref), $old, $tmp]) if $nreplace;
 624
 625         run_die([@git, qw(update-ref -d), $tmp]);
 626
 627         return if $nreplace == 0;
 628
 629         run_die([@git, qw(-c gc.reflogExpire=now gc --prune=all --quiet)]);
 630
 631         # check that old OIDs are gone
 632         my $err = 0;
 633         foreach my $oid (keys %$replace_map) {
 634                 my @info = $git->check($oid);
 635                 if (@info) {
 636                         warn "$oid not replaced\n";
 637                         $err++;
 638                 }
 639         }
 640         _update_git_info($self, 0);
 641         die "Failed to replace $err object(s)\n" if $err;
 642         $cmt;
 643 }
 644
 645 1;
 646 __END__
 647 =pod
 648
 649 =head1 NAME
 650
 651 PublicInbox::Import - message importer for public-inbox v1 inboxes
 652
 653 =head1 VERSION
 654
 655 version 1.0
 656
 657 =head1 SYNOPSIS
 658
 659         use PublicInbox::Eml;
 660         # PublicInbox::Eml exists as of public-inbox 1.5.0,
 661         # Email::MIME was used in older versions
 662
 663         use PublicInbox::Git;
 664         use PublicInbox::Import;
 665
 666         chomp(my $git_dir = `git rev-parse --git-dir`);
 667         $git_dir or die "GIT_DIR= must be specified\n";
 668         my $git = PublicInbox::Git->new($git_dir);
 669         my @committer = ('inbox', 'inbox@example.org');
 670         my $im = PublicInbox::Import->new($git, @committer);
 671
 672         # to add a message:
 673         my $message = "From: <u\@example.org>\n".
 674                 "Subject: test message \n" .
 675                 "Date: Thu, 01 Jan 1970 00:00:00 +0000\n" .
 676                 "Message-ID: <m\@example.org>\n".
 677                 "\ntest message";
 678         my $parsed = PublicInbox::Eml->new($message);
 679         my $ret = $im->add($parsed);
 680         if (!defined $ret) {
 681                 warn "duplicate: ", $parsed->header_raw('Message-ID'), "\n";
 682         } else {
 683                 print "imported at mark $ret\n";
 684         }
 685         $im->done;
 686
 687         # to remove a message
 688         my $junk = PublicInbox::Eml->new($message);
 689         my ($mark, $orig) = $im->remove($junk);
 690         if ($mark eq 'MISSING') {
 691                 print "not found\n";
 692         } elsif ($mark eq 'MISMATCH') {
 693                 print "Message exists but does not match\n\n",
 694                         $orig->as_string, "\n",;
 695         } else {
 696                 print "removed at mark $mark\n\n",
 697                         $orig->as_string, "\n";
 698         }
 699         $im->done;
 700
 701 =head1 DESCRIPTION
 702
 703 An importer and remover for public-inboxes which takes C<PublicInbox::Eml>
 704 or L<Email::MIME> messages as input and stores them in a git repository as
 705 documented in L<https://public-inbox.org/public-inbox-v1-format.txt>,
 706 except it does not allow duplicate Message-IDs.
 707
 708 It requires L<git(1)> and L<git-fast-import(1)> to be installed.
 709
 710 =head1 METHODS
 711
 712 =cut
 713
 714 =head2 new
 715
 716         my $im = PublicInbox::Import->new($git, @committer);
 717
 718 Initialize a new PublicInbox::Import object.
 719
 720 =head2 add
 721
 722         my $parsed = PublicInbox::Eml->new($message);
 723         $im->add($parsed);
 724
 725 Adds a message to to the git repository.  This will acquire
 726 C<$GIT_DIR/ssoma.lock> and start L<git-fast-import(1)> if necessary.
 727
 728 Messages added will not be visible to other processes until L</done>
 729 is called, but L</remove> may be called on them.
 730
 731 =head2 remove
 732
 733         my $junk = PublicInbox::Eml->new($message);
 734         my ($code, $orig) = $im->remove($junk);
 735
 736 Removes a message from the repository.  On success, it returns
 737 a ':'-prefixed numeric code representing the git-fast-import
 738 mark and the original messages as a PublicInbox::Eml
 739 (or Email::MIME) object.
 740 If the message could not be found, the code is "MISSING"
 741 and the original message is undef.  If there is a mismatch where
 742 the "Message-ID" is matched but the subject and body do not match,
 743 the returned code is "MISMATCH" and the conflicting message
 744 is returned as orig.
 745
 746 =head2 done
 747
 748 Finalizes the L<git-fast-import(1)> and unlocks the repository.
 749 Calling this is required to finalize changes to a repository.
 750
 751 =head1 SEE ALSO
 752
 753 L<Email::MIME>
 754
 755 =head1 CONTACT
 756
 757 All feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 758
 759 The mail archives are hosted at L<https://public-inbox.org/meta/>
 760
 761 =head1 COPYRIGHT
 762
 763 Copyright (C) 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 764
 765 License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>
 766
 767 =cut