lib/PublicInbox/Import.pm

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