1 # Copyright (C) 2018-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # This interface wraps and mimics PublicInbox::Import
5 # Used to write to V2 inboxes (see L<public-inbox-v2-format(5)>).
6 package PublicInbox::V2Writable;
9 use parent qw(PublicInbox::Lock);
10 use PublicInbox::SearchIdxShard;
13 use PublicInbox::Import;
14 use PublicInbox::MID qw(mids references);
15 use PublicInbox::ContentHash qw(content_hash content_digest);
16 use PublicInbox::InboxWritable;
17 use PublicInbox::OverIdx;
18 use PublicInbox::Msgmap;
19 use PublicInbox::Spawn qw(spawn popen_rd);
20 use PublicInbox::SearchIdx qw(log2stack crlf_adjust is_ancestor check_size
22 use IO::Handle; # ->autoflush
25 my $OID = qr/[a-f0-9]{40,}/;
26 # an estimate of the post-packed size to the raw uncompressed size
27 our $PACKING_FACTOR = 0.4;
29 # SATA storage lags behind what CPUs are capable of, so relying on
30 # nproc(1) can be misleading and having extra Xapian shards is a
31 # waste of FDs and space. It can also lead to excessive IO latency
32 # and slow things down. Users on NVME or other fast storage can
33 # use the NPROC env or switches in our script/public-inbox-* programs
34 # to increase Xapian shards
35 our $NPROC_MAX_DEFAULT = 4;
38 # getconf(1) is POSIX, but *NPROCESSORS* vars are not
39 for (qw(_NPROCESSORS_ONLN NPROCESSORS_ONLN)) {
40 `getconf $_ 2>/dev/null` =~ /^(\d+)$/ and return $1;
42 for my $nproc (qw(nproc gnproc)) { # GNU coreutils nproc
43 `$nproc 2>/dev/null` =~ /^(\d+)$/ and return $1;
46 # should we bother with `sysctl hw.ncpu`? Those only give
47 # us total processor count, not online processor count.
51 sub nproc_shards ($) {
53 my $n = $creat_opt->{nproc} if ref($creat_opt) eq 'HASH';
56 # assume 2 cores if not detectable or zero
57 state $NPROC_DETECTED = detect_nproc() || 2;
59 $n = $NPROC_MAX_DEFAULT if $n > $NPROC_MAX_DEFAULT;
62 # subtract for the main process and git-fast-import
67 sub count_shards ($) {
69 if (my $ibx = $self->{ibx}) {
70 # always load existing shards in case core count changes:
71 # Also, shard count may change while -watch is running
72 my $srch = $ibx->search or return 0;
73 delete $ibx->{search};
75 } else { # ExtSearchIdx
76 $self->{nshard} ||= scalar($self->xdb_shards_flat);
81 # $creat may be any true value, or 0/undef. A hashref is true,
82 # and $creat->{nproc} may be set to an integer
83 my ($class, $v2ibx, $creat) = @_;
84 $v2ibx = PublicInbox::InboxWritable->new($v2ibx);
85 my $dir = $v2ibx->assert_usable_dir;
89 File::Path::mkpath($dir);
91 die "$dir does not exist\n";
94 my $xpfx = "$dir/xap" . PublicInbox::Search::SCHEMA_VERSION;
97 im => undef, # PublicInbox::Import
103 oidx => PublicInbox::OverIdx->new("$xpfx/over.sqlite3"),
104 lock_path => "$dir/inbox.lock",
105 # limit each git repo (epoch) to 1GB or so
106 rotate_bytes => int((1024 * 1024 * 1024) / $PACKING_FACTOR),
107 last_commit => [], # git epoch -> commit
109 $self->{oidx}->{-no_fsync} = 1 if $v2ibx->{-no_fsync};
110 $self->{shards} = count_shards($self) || nproc_shards($creat);
116 my ($self, $shards, $skip_epoch, $skip_artnum) = @_;
117 if (defined $shards) {
118 $self->{parallel} = 0 if $shards == 0;
119 $self->{shards} = $shards if $shards > 0;
122 $self->{mm}->skip_artnum($skip_artnum) if defined $skip_artnum;
123 my $max = $self->{ibx}->max_git_epoch;
124 $max = $skip_epoch if (defined($skip_epoch) && !defined($max));
125 $self->git_init($max // 0);
129 # returns undef on duplicate or spam
130 # mimics Import::add and wraps it for v2
132 my ($self, $eml, $check_cb) = @_;
133 $self->{ibx}->with_umask(\&_add, $self, $eml, $check_cb);
137 my ($self, $num) = @_;
138 $self->{idx_shards}->[$num % scalar(@{$self->{idx_shards}})];
141 # indexes a message, returns true if checkpointing is needed
143 my ($self, $msgref, $mime, $smsg) = @_;
144 $smsg->{bytes} = $smsg->{raw_bytes} + crlf_adjust($$msgref);
145 $self->{oidx}->add_overview($mime, $smsg);
146 my $idx = idx_shard($self, $smsg->{num});
147 $idx->index_raw($msgref, $mime, $smsg);
148 my $n = $self->{transact_bytes} += $smsg->{raw_bytes};
149 $n >= $self->{batch_bytes};
153 my ($self, $mime, $check_cb) = @_;
157 $mime = $check_cb->($mime, $self->{ibx}) or return;
160 # All pipes (> $^F) known to Perl 5.6+ have FD_CLOEXEC set,
161 # as does SQLite 3.4.1+ (released in 2007-07-20), and
162 # Xapian 1.3.2+ (released 2015-03-15).
163 # For the most part, we can spawn git-fast-import without
164 # leaking FDs to it...
167 my ($num, $mid0) = v2_num_for($self, $mime);
168 defined $num or return; # duplicate
169 defined $mid0 or die "BUG: \$mid0 undefined\n";
170 my $im = $self->importer;
171 my $smsg = bless { mid => $mid0, num => $num }, 'PublicInbox::Smsg';
172 my $cmt = $im->add($mime, undef, $smsg); # sets $smsg->{ds|ts|blob}
173 $cmt = $im->get_mark($cmt);
174 $self->{last_commit}->[$self->{epoch_max}] = $cmt;
176 my $msgref = delete $smsg->{-raw_email};
177 if (do_idx($self, $msgref, $mime, $smsg)) {
185 my ($self, $mime) = @_;
186 my $mids = mids($mime);
188 my $mid = $mids->[0];
189 my $num = $self->{mm}->mid_insert($mid);
190 if (defined $num) { # common case
194 # crap, Message-ID is already known, hope somebody just resent:
195 foreach my $m (@$mids) {
196 # read-only lookup now safe to do after above barrier
197 # easy, don't store duplicates
198 # note: do not add more diagnostic info here since
199 # it gets noisy on public-inbox-watch restarts
200 return () if content_exists($self, $mime, $m);
203 # AltId may pre-populate article numbers (e.g. X-Mail-Count
204 # or NNTP article number), use that article number if it's
206 my $altid = $self->{ibx}->{altid};
207 if ($altid && grep(/:file=msgmap\.sqlite3\z/, @$altid)) {
208 my $num = $self->{mm}->num_for($mid);
210 if (defined $num && !$self->{oidx}->get_art($num)) {
216 warn "<$mid> reused for mismatched content\n";
218 # try the rest of the mids
219 for(my $i = $#$mids; $i >= 1; $i--) {
221 $num = $self->{mm}->mid_insert($m);
223 warn "alternative <$m> for <$mid> found\n";
228 # none of the existing Message-IDs are good, generate a new one:
229 v2_num_for_harder($self, $mime);
232 sub v2_num_for_harder {
233 my ($self, $eml) = @_;
235 my $dig = content_digest($eml);
236 my $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
237 my $num = $self->{mm}->mid_insert($mid0);
238 unless (defined $num) {
239 # it's hard to spoof the last Received: header
240 my @recvd = $eml->header_raw('Received');
241 $dig->add("Received: $_") foreach (@recvd);
242 $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
243 $num = $self->{mm}->mid_insert($mid0);
245 # fall back to a random Message-ID and give up determinism:
246 until (defined($num)) {
248 $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
249 warn "using random Message-ID <$mid0> as fallback\n";
250 $num = $self->{mm}->mid_insert($mid0);
253 PublicInbox::Import::append_mid($eml, $mid0);
257 sub _idx_init { # with_umask callback
258 my ($self, $opt) = @_;
259 $self->lock_acquire unless $opt && $opt->{-skip_lock};
260 $self->{oidx}->create;
262 # xcpdb can change shard count while -watch is idle
263 my $nshards = count_shards($self);
264 $self->{shards} = $nshards if $nshards && $nshards != $self->{shards};
265 $self->{batch_bytes} = $opt->{batch_size} //
266 $PublicInbox::SearchIdx::BATCH_BYTES;
268 # need to create all shards before initializing msgmap FD
269 # idx_shards must be visible to all forked processes
270 my $max = $self->{shards} - 1;
271 my $idx = $self->{idx_shards} = [];
272 push @$idx, PublicInbox::SearchIdxShard->new($self, $_) for (0..$max);
274 # SearchIdxShard may do their own flushing, so don't scale
275 # until after forking
276 $self->{batch_bytes} *= $self->{shards} if $self->{parallel};
278 my $ibx = $self->{ibx} or return; # ExtIdxSearch
280 # Now that all subprocesses are up, we can open the FDs
282 my $mm = $self->{mm} = PublicInbox::Msgmap->new_file(
283 "$ibx->{inboxdir}/msgmap.sqlite3",
284 $ibx->{-no_fsync} ? 2 : 1);
285 $mm->{dbh}->begin_work;
288 sub parallel_init ($$) {
289 my ($self, $indexlevel) = @_;
290 if (($indexlevel // 'full') eq 'basic') {
291 $self->{parallel} = 0;
293 pipe(my ($r, $w)) or die "pipe failed: $!";
294 # pipe for barrier notifications doesn't need to be big,
296 fcntl($w, 1031, 4096) if $^O eq 'linux';
297 $self->{bnote} = [ $r, $w ];
304 my ($self, $opt) = @_;
305 return if $self->{idx_shards};
306 my $ibx = $self->{ibx};
308 # do not leak read-only FDs to child processes, we only have these
309 # FDs for duplicate detection so they should not be
310 # frequently activated.
311 delete @$ibx{qw(mm search)};
314 parallel_init($self, $ibx->{indexlevel});
315 $ibx->with_umask(\&_idx_init, $self, $opt);
318 # returns an array mapping [ epoch => latest_commit ]
319 # latest_commit may be undef if nothing was done to that epoch
320 # $replace_map = { $object_id => $strref, ... }
321 sub _replace_oids ($$$) {
322 my ($self, $mime, $replace_map) = @_;
324 my $ibx = $self->{ibx};
325 my $pfx = "$ibx->{inboxdir}/git";
326 my $rewrites = []; # epoch => commit
327 my $max = $self->{epoch_max} //= $ibx->max_git_epoch // return;
329 foreach my $i (0..$max) {
330 my $git_dir = "$pfx/$i.git";
332 my $git = PublicInbox::Git->new($git_dir);
333 my $im = $self->import_init($git, 0, 1);
334 $rewrites->[$i] = $im->replace_oids($mime, $replace_map);
340 sub content_hashes ($) {
342 my @chashes = ( content_hash($mime) );
344 # We still support Email::MIME, here, and
345 # Email::MIME->as_string doesn't always round-trip, so we may
346 # use a second content_hash
347 my $rt = content_hash(PublicInbox::Eml->new(\($mime->as_string)));
348 push @chashes, $rt if $chashes[0] ne $rt;
352 sub content_matches ($$) {
353 my ($chashes, $existing) = @_;
354 my $chash = content_hash($existing);
355 foreach (@$chashes) {
356 return 1 if $_ eq $chash
361 # used for removing or replacing (purging)
362 sub rewrite_internal ($$;$$$) {
363 my ($self, $old_eml, $cmt_msg, $new_eml, $sref) = @_;
365 my ($im, $need_reindex, $replace_map);
367 $replace_map = {}; # oid => sref
368 $need_reindex = [] if $new_eml;
370 $im = $self->importer;
372 my $oidx = $self->{oidx};
373 my $chashes = content_hashes($old_eml);
375 my $mids = mids($old_eml);
377 # We avoid introducing new blobs into git since the raw content
378 # can be slightly different, so we do not need the user-supplied
379 # message now that we have the mids and content_hash
383 foreach my $mid (@$mids) {
384 my %gone; # num => [ smsg, $mime, raw ]
386 while (my $smsg = $oidx->next_by_mid($mid, \$id, \$prev)) {
387 my $msg = get_blob($self, $smsg);
388 if (!defined($msg)) {
389 warn "broken smsg for $mid\n";
393 my $cur = PublicInbox::Eml->new($msg);
394 if (content_matches($chashes, $cur)) {
395 $gone{$smsg->{num}} = [ $smsg, $cur, \$orig ];
398 my $n = scalar keys %gone;
401 warn "BUG: multiple articles linked to <$mid>\n",
402 join(',', sort keys %gone), "\n";
404 foreach my $num (keys %gone) {
405 my ($smsg, $mime, $orig) = @{$gone{$num}};
406 # $removed should only be set once assuming
407 # no bugs in our deduplication code:
408 $removed = [ undef, $mime, $smsg ];
409 my $oid = $smsg->{blob};
411 $replace_map->{$oid} = $sref;
413 ($mark, undef) = $im->remove($orig, $cmt_msg);
414 $removed->[0] = $mark;
417 if ($need_reindex) { # ->replace
418 push @$need_reindex, $smsg;
419 } else { # ->purge or ->remove
420 $self->{mm}->num_delete($num);
422 unindex_oid_aux($self, $oid, $mid);
427 my $cmt = $im->get_mark($mark);
428 $self->{last_commit}->[$self->{epoch_max}] = $cmt;
430 if ($replace_map && scalar keys %$replace_map) {
431 my $rewrites = _replace_oids($self, $new_eml, $replace_map);
432 return { rewrites => $rewrites, need_reindex => $need_reindex };
434 defined($mark) ? $removed : undef;
437 # public (see PublicInbox::Import->remove), but note the 3rd element
438 # (retval[2]) is not part of the stable API shared with Import->remove
440 my ($self, $eml, $cmt_msg) = @_;
441 my $r = $self->{ibx}->with_umask(\&rewrite_internal,
442 $self, $eml, $cmt_msg);
443 defined($r) && defined($r->[0]) ? @$r: undef;
446 sub _replace ($$;$$) {
447 my ($self, $old_eml, $new_eml, $sref) = @_;
448 my $arg = [ $self, $old_eml, undef, $new_eml, $sref ];
449 my $rewritten = $self->{ibx}->with_umask(\&rewrite_internal,
450 $self, $old_eml, undef, $new_eml, $sref) or return;
452 my $rewrites = $rewritten->{rewrites};
453 # ->done is called if there are rewrites since we gc+prune from git
454 $self->idx_init if @$rewrites;
456 for my $i (0..$#$rewrites) {
457 defined(my $cmt = $rewrites->[$i]) or next;
458 $self->{last_commit}->[$i] = $cmt;
465 my ($self, $mime) = @_;
466 my $rewritten = _replace($self, $mime, undef, \'') or return;
467 $rewritten->{rewrites}
470 # returns the git object_id of $fh, does not write the object to FS
471 sub git_hash_raw ($$) {
472 my ($self, $raw) = @_;
473 # grab the expected OID we have to reindex:
474 pipe(my($in, $w)) or die "pipe: $!";
475 my $git_dir = $self->git->{git_dir};
476 my $cmd = ['git', "--git-dir=$git_dir", qw(hash-object --stdin)];
477 my $r = popen_rd($cmd, undef, { 0 => $in });
478 print $w $$raw or die "print \$w: $!";
479 close $w or die "close \$w: $!";
481 chomp(my $oid = <$r>);
482 close $r or die "git hash-object failed: $?";
483 $oid =~ /\A$OID\z/ or die "OID not expected: $oid";
487 sub _check_mids_match ($$$) {
488 my ($old_list, $new_list, $hdrs) = @_;
489 my %old_mids = map { $_ => 1 } @$old_list;
490 my %new_mids = map { $_ => 1 } @$new_list;
491 my @old = keys %old_mids;
492 my @new = keys %new_mids;
493 my $err = "$hdrs may not be changed when replacing\n";
494 die $err if scalar(@old) != scalar(@new);
495 delete @new_mids{@old};
496 delete @old_mids{@new};
497 die $err if (scalar(keys %old_mids) || scalar(keys %new_mids));
500 # Changing Message-IDs or References with ->replace isn't supported.
501 # The rules for dealing with messages with multiple or conflicting
502 # Message-IDs are pretty complex and rethreading hasn't been fully
504 sub check_mids_match ($$) {
505 my ($old, $new) = @_;
506 _check_mids_match(mids($old), mids($new), 'Message-ID(s)');
507 _check_mids_match(references($old), references($new),
508 'References/In-Reply-To');
513 my ($self, $old_mime, $new_mime) = @_;
515 check_mids_match($old_mime, $new_mime);
517 # mutt will always add Content-Length:, Status:, Lines: when editing
518 PublicInbox::Import::drop_unwanted_headers($new_mime);
520 my $raw = $new_mime->as_string;
521 my $expect_oid = git_hash_raw($self, \$raw);
522 my $rewritten = _replace($self, $old_mime, $new_mime, \$raw) or return;
523 my $need_reindex = $rewritten->{need_reindex};
525 # just in case we have bugs in deduplication code:
526 my $n = scalar(@$need_reindex);
528 my $list = join(', ', map {
529 "$_->{num}: <$_->{mid}>"
532 W: rewritten $n messages matching content of original message (expected: 1).
533 W: possible bug in public-inbox, NNTP article IDs and Message-IDs follow:
538 # make sure we really got the OID:
539 my ($blob, $type, $bytes) = $self->git->check($expect_oid);
540 $blob eq $expect_oid or die "BUG: $expect_oid not found after replace";
542 # don't leak FDs to Xapian:
545 # reindex modified messages:
546 for my $smsg (@$need_reindex) {
547 my $new_smsg = bless {
552 }, 'PublicInbox::Smsg';
553 my $sync = { autime => $smsg->{ds}, cotime => $smsg->{ts} };
554 $new_smsg->populate($new_mime, $sync);
555 do_idx($self, \$raw, $new_mime, $new_smsg);
557 $rewritten->{rewrites};
560 sub last_epoch_commit ($$;$) {
561 my ($self, $i, $cmt) = @_;
562 my $v = PublicInbox::Search::SCHEMA_VERSION();
563 $self->{mm}->last_commit_xap($v, $i, $cmt);
566 sub set_last_commits ($) { # this is NOT for ExtSearchIdx
568 defined(my $epoch_max = $self->{epoch_max}) or return;
569 my $last_commit = $self->{last_commit};
570 foreach my $i (0..$epoch_max) {
571 defined(my $cmt = $last_commit->[$i]) or next;
572 $last_commit->[$i] = undef;
573 last_epoch_commit($self, $i, $cmt);
579 $self->{bnote} or return;
581 my $barrier = { map { $_ => 1 } (0..$n) };
585 my ($self, $barrier) = @_;
586 my $bnote = $self->{bnote} or return;
588 while (scalar keys %$barrier) {
589 defined(my $l = readline($r)) or die "EOF on barrier_wait: $!";
590 $l =~ /\Abarrier (\d+)/ or die "bad line on barrier_wait: $l";
591 delete $barrier->{$1} or die "bad shard[$1] on barrier wait";
596 sub checkpoint ($;$) {
597 my ($self, $wait) = @_;
599 if (my $im = $self->{im}) {
606 my $shards = $self->{idx_shards};
608 my $mm = $self->{mm};
609 my $dbh = $mm->{dbh} if $mm;
611 # SQLite msgmap data is second in importance
612 $dbh->commit if $dbh;
614 # SQLite overview is third
615 $self->{oidx}->commit_lazy;
617 # Now deal with Xapian
619 my $barrier = barrier_init($self, scalar @$shards);
621 # each shard needs to issue a barrier command
622 $_->shard_barrier for @$shards;
624 # wait for each Xapian shard
625 barrier_wait($self, $barrier);
627 $_->shard_commit for @$shards;
630 my $midx = $self->{midx}; # misc index
631 $midx->commit_txn if $midx;
633 # last_commit is special, don't commit these until
634 # Xapian shards are done:
635 $dbh->begin_work if $dbh;
636 set_last_commits($self);
641 $midx->begin_txn if $midx;
643 $self->{total_bytes} += $self->{transact_bytes};
644 $self->{transact_bytes} = 0;
647 # issue a write barrier to ensure all data is visible to other processes
648 # and read-only ops. Order of data importance is: git > SQLite > Xapian
650 sub barrier { checkpoint($_[0], 1) };
652 # true if locked and active
653 sub active { !!$_[0]->{im} }
659 if (my $im = delete $self->{im}) {
660 eval { $im->done }; # PublicInbox::Import::done
661 $err .= "import done: $@\n" if $@;
664 eval { checkpoint($self) };
665 $err .= "checkpoint: $@\n" if $@;
667 if (my $mm = delete $self->{mm}) {
668 my $m = $err ? 'rollback' : 'commit';
669 eval { $mm->{dbh}->$m };
670 $err .= "msgmap $m: $@\n" if $@;
672 my $shards = delete $self->{idx_shards};
675 eval { $_->shard_close };
676 $err .= "shard close: $@\n" if $@;
679 eval { $self->{oidx}->dbh_close };
680 $err .= "over close: $@\n" if $@;
681 delete $self->{midx};
682 delete $self->{bnote};
683 my $nbytes = $self->{total_bytes};
684 $self->{total_bytes} = 0;
685 $self->lock_release(!!$nbytes) if $shards;
690 sub write_alternates ($$$) {
691 my ($info_dir, $mode, $out) = @_;
692 my $fh = File::Temp->new(TEMPLATE => 'alt-XXXXXXXX', DIR => $info_dir);
693 my $tmp = $fh->filename;
694 print $fh @$out or die "print $tmp: $!\n";
695 chmod($mode, $fh) or die "fchmod $tmp: $!\n";
696 close $fh or die "close $tmp $!\n";
697 my $alt = "$info_dir/alternates";
698 rename($tmp, $alt) or die "rename $tmp => $alt: $!\n";
699 $fh->unlink_on_destroy(0);
702 sub fill_alternates ($$) {
703 my ($self, $epoch) = @_;
705 my $pfx = "$self->{ibx}->{inboxdir}/git";
706 my $all = "$self->{ibx}->{inboxdir}/all.git";
707 PublicInbox::Import::init_bare($all) unless -d $all;
708 my $info_dir = "$all/objects/info";
709 my $alt = "$info_dir/alternates";
713 open(my $fh, '<', $alt) or die "open < $alt: $!\n";
714 $mode = (stat($fh))[2] & 07777;
716 # we assign a sort score to every alternate and favor
717 # the newest (highest numbered) one because loose objects
718 # require scanning epochs and only the latest epoch is
719 # expected to see loose objects
721 my $other = 0; # in case admin adds non-epoch repos
723 if (m!\A\Q../../\E([0-9]+)\.git/objects\z!) {
729 } split(/\n+/, do { local $/; <$fh> });
732 foreach my $i (0..$epoch) {
733 my $dir = "../../git/$i.git/objects";
734 if (!exists($alt{$dir}) && -d "$pfx/$i.git") {
740 write_alternates($info_dir, $mode,
741 [join("\n", sort { $alt{$b} <=> $alt{$a} } keys %alt), "\n"]);
745 my ($self, $epoch) = @_;
746 my $git_dir = "$self->{ibx}->{inboxdir}/git/$epoch.git";
747 PublicInbox::Import::init_bare($git_dir);
748 my @cmd = (qw/git config/, "--file=$git_dir/config",
749 'include.path', '../../all.git/config');
750 PublicInbox::Import::run_die(\@cmd);
751 fill_alternates($self, $epoch);
757 my $im = $self->{im};
759 if ($im->{bytes_added} < $self->{rotate_bytes}) {
766 my $git_dir = $self->git_init(++$self->{epoch_max});
767 my $git = PublicInbox::Git->new($git_dir);
768 return $self->import_init($git, 0);
773 my $latest = $self->{ibx}->git_dir_latest(\$max);
774 if (defined $latest) {
775 my $git = PublicInbox::Git->new($latest);
776 my $packed_bytes = $git->packed_bytes;
777 my $unpacked_bytes = $packed_bytes / $PACKING_FACTOR;
779 if ($unpacked_bytes >= $self->{rotate_bytes}) {
782 $self->{epoch_max} = $max;
783 return $self->import_init($git, $packed_bytes);
786 $self->{epoch_max} = $epoch;
787 $latest = $self->git_init($epoch);
788 $self->import_init(PublicInbox::Git->new($latest), 0);
792 my ($self, $git, $packed_bytes, $tmp) = @_;
793 my $im = PublicInbox::Import->new($git, undef, undef, $self->{ibx});
794 $im->{bytes_added} = int($packed_bytes / $PACKING_FACTOR);
795 $im->{lock_path} = undef;
796 $im->{path_type} = 'v2';
797 $self->{im} = $im unless $tmp;
803 my ($mid, $cur, $new) = @_;
805 my $ah = File::Temp->new(TEMPLATE => 'email-cur-XXXXXXXX', TMPDIR => 1);
806 print $ah $cur->as_string or die "print: $!";
807 $ah->flush or die "flush: $!";
808 PublicInbox::Import::drop_unwanted_headers($new);
809 my $bh = File::Temp->new(TEMPLATE => 'email-new-XXXXXXXX', TMPDIR => 1);
810 print $bh $new->as_string or die "print: $!";
811 $bh->flush or die "flush: $!";
812 my $cmd = [ qw(diff -u), $ah->filename, $bh->filename ];
813 print STDERR "# MID conflict <$mid>\n";
814 my $pid = spawn($cmd, undef, { 1 => 2 });
815 waitpid($pid, 0) == $pid or die "diff did not finish";
819 my ($self, $smsg) = @_;
820 if (my $im = $self->{im}) {
821 my $msg = $im->cat_blob($smsg->{blob});
824 # older message, should be in alternates
825 $self->{ibx}->msg_by_smsg($smsg);
828 sub content_exists ($$$) {
829 my ($self, $mime, $mid) = @_;
830 my $oidx = $self->{oidx};
831 my $chashes = content_hashes($mime);
833 while (my $smsg = $oidx->next_by_mid($mid, \$id, \$prev)) {
834 my $msg = get_blob($self, $smsg);
835 if (!defined($msg)) {
836 warn "broken smsg for $mid\n";
839 my $cur = PublicInbox::Eml->new($msg);
840 return 1 if content_matches($chashes, $cur);
842 # XXX DEBUG_DIFF is experimental and may be removed
843 diff($mid, $cur, $mime) if $ENV{DEBUG_DIFF};
850 if (my $shards = $self->{idx_shards}) {
851 $_->atfork_child foreach @$shards;
853 if (my $im = $self->{im}) {
856 die "unexpected mm" if $self->{mm};
857 close $self->{bnote}->[0] or die "close bnote[0]: $!\n";
861 sub reindex_checkpoint ($$) {
862 my ($self, $sync) = @_;
864 $self->git->async_wait_all;
865 $self->update_last_commit($sync);
866 ${$sync->{need_checkpoint}} = 0;
867 my $mm_tmp = $sync->{mm_tmp};
868 $mm_tmp->atfork_prepare if $mm_tmp;
869 die 'BUG: {im} during reindex' if $self->{im};
870 if ($self->{ibx_map} && !$sync->{checkpoint_unlocks}) {
871 checkpoint($self, 1); # no need to release lock on pure index
873 $self->done; # release lock
876 if (my $pr = $sync->{-regen_fmt} ? $sync->{-opt}->{-progress} : undef) {
877 $pr->(sprintf($sync->{-regen_fmt}, ${$sync->{nr}}));
880 # allow -watch or -mda to write...
881 $self->idx_init($sync->{-opt}); # reacquire lock
882 if (my $intvl = $sync->{check_intvl}) { # eidx
883 $sync->{next_check} = PublicInbox::DS::now() + $intvl;
885 $mm_tmp->atfork_parent if $mm_tmp;
888 sub index_finalize ($$) {
889 my ($arg, $index) = @_;
890 ++$arg->{self}->{nidx};
891 if (defined(my $cur = $arg->{cur_cmt})) {
892 ${$arg->{latest_cmt}} = $cur;
894 die 'BUG: {cur_cmt} missing';
895 } # else { unindexing @leftovers doesn't set {cur_cmt}
898 sub index_oid { # cat_async callback
899 my ($bref, $oid, $type, $size, $arg) = @_;
900 is_bad_blob($oid, $type, $size, $arg->{oid}) and
901 return index_finalize($arg, 1); # size == 0 purged returns here
902 my $self = $arg->{self};
903 local $self->{current_info} = "$self->{current_info} $oid";
905 my $eml = PublicInbox::Eml->new($$bref);
906 my $mids = mids($eml);
907 my $chash = content_hash($eml);
909 if (scalar(@$mids) == 0) {
910 warn "E: $oid has no Message-ID, skipping\n";
914 # {unindexed} is unlikely
915 if ((my $unindexed = $arg->{unindexed}) && scalar(@$mids) == 1) {
916 $num = delete($unindexed->{$mids->[0]});
919 $self->{mm}->mid_set($num, $mid0);
920 delete($arg->{unindexed}) if !keys(%$unindexed);
923 if (!defined($num)) { # reuse if reindexing (or duplicates)
924 my $oidx = $self->{oidx};
925 for my $mid (@$mids) {
926 ($num, $mid0) = $oidx->num_mid0_for_oid($oid, $mid);
927 last if defined $num;
930 $mid0 //= do { # is this a number we got before?
931 $num = $arg->{mm_tmp}->num_for($mids->[0]);
932 defined($num) ? $mids->[0] : undef;
934 if (!defined($num)) {
935 for (my $i = $#$mids; $i >= 1; $i--) {
936 $num = $arg->{mm_tmp}->num_for($mids->[$i]);
944 $arg->{mm_tmp}->num_delete($num);
945 } else { # never seen
946 $num = $self->{mm}->mid_insert($mids->[0]);
949 } else { # rare, try the rest of them, backwards
950 for (my $i = $#$mids; $i >= 1; $i--) {
951 $num = $self->{mm}->mid_insert($mids->[$i]);
959 if (!defined($num)) {
960 warn "E: $oid <", join('> <', @$mids), "> is a duplicate\n";
969 }, 'PublicInbox::Smsg';
970 $smsg->populate($eml, $arg);
971 if (do_idx($self, $bref, $eml, $smsg)) {
972 ${$arg->{need_checkpoint}} = 1;
974 index_finalize($arg, 1);
977 # only update last_commit for $i on reindex iff newer than current
978 sub update_last_commit {
979 my ($self, $sync, $stk) = @_;
980 my $unit = $sync->{unit} // return;
981 my $latest_cmt = $stk ? $stk->{latest_cmt} : ${$sync->{latest_cmt}};
982 defined($latest_cmt) or return;
983 my $last = last_epoch_commit($self, $unit->{epoch});
984 if (defined $last && is_ancestor($self->git, $last, $latest_cmt)) {
985 my @cmd = (qw(rev-list --count), "$last..$latest_cmt");
986 chomp(my $n = $unit->{git}->qx(@cmd));
987 return if $n ne '' && $n == 0;
989 last_epoch_commit($self, $unit->{epoch}, $latest_cmt);
993 my ($self, $sync) = @_;
995 for (my $i = $sync->{epoch_max}; $i >= 0; $i--) {
996 $heads->[$i] = last_epoch_commit($self, $i);
1001 # returns a revision range for git-log(1)
1002 sub log_range ($$$) {
1003 my ($sync, $unit, $tip) = @_;
1004 my $opt = $sync->{-opt};
1005 my $pr = $opt->{-progress} if (($opt->{verbose} || 0) > 1);
1006 my $i = $unit->{epoch};
1007 my $cur = $sync->{ranges}->[$i] or do {
1008 $pr->("$i.git indexing all of $tip\n") if $pr;
1009 return $tip; # all of it
1012 # fast equality check to avoid (v)fork+execve overhead
1014 $sync->{ranges}->[$i] = undef;
1018 my $range = "$cur..$tip";
1019 $pr->("$i.git checking contiguity... ") if $pr;
1020 my $git = $unit->{git};
1021 if (is_ancestor($sync->{self}->git, $cur, $tip)) { # common case
1022 $pr->("OK\n") if $pr;
1023 my $n = $git->qx(qw(rev-list --count), $range);
1026 $sync->{ranges}->[$i] = undef;
1027 $pr->("$i.git has nothing new\n") if $pr;
1028 return; # nothing to do
1030 $pr->("$i.git has $n changes since $cur\n") if $pr;
1032 $pr->("FAIL\n") if $pr;
1034 discontiguous range: $range
1035 Rewritten history? (in $git->{git_dir})
1037 chomp(my $base = $git->qx('merge-base', $tip, $cur));
1039 $range = "$base..$tip";
1040 warn "found merge-base: $base\n"
1043 warn "discarding history at $cur\n";
1046 reindexing $git->{git_dir}
1049 # $cur^0 may no longer exist if pruned by git
1050 if ($git->qx(qw(rev-parse -q --verify), "$cur^0")) {
1051 $unit->{unindex_range} = "$base..$cur";
1052 } elsif ($base && $git->qx(qw(rev-parse -q --verify), $base)) {
1053 $unit->{unindex_range} = "$base..";
1055 warn "W: unable to unindex before $range\n";
1061 # overridden by ExtSearchIdx
1062 sub artnum_max { $_[0]->{mm}->num_highwater }
1064 sub sync_prepare ($$) {
1065 my ($self, $sync) = @_;
1066 $sync->{ranges} = sync_ranges($self, $sync);
1067 my $pr = $sync->{-opt}->{-progress};
1069 my $head = $sync->{ibx}->{ref_head} || 'HEAD';
1072 ($pfx) = ($sync->{ibx}->{inboxdir} =~ m!([^/]+)\z!g);
1073 $pfx //= $sync->{ibx}->{inboxdir};
1077 if ($self->{ibx_map}) {
1078 # ExtSearchIdx won't index messages unless they're in
1079 # over.sqlite3 for a given inbox, so don't read beyond
1080 # what's in the per-inbox index.
1081 $reindex_heads = [];
1082 my $v = PublicInbox::Search::SCHEMA_VERSION;
1083 my $mm = $sync->{ibx}->mm;
1084 for my $i (0..$sync->{epoch_max}) {
1085 $reindex_heads->[$i] = $mm->last_commit_xap($v, $i);
1087 } elsif ($sync->{reindex}) { # V2 inbox
1088 # reindex stops at the current heads and we later
1089 # rerun index_sync without {reindex}
1090 $reindex_heads = $self->last_commits($sync);
1092 if ($sync->{max_size} = $sync->{-opt}->{max_size}) {
1093 $sync->{index_oid} = $self->can('index_oid');
1095 my $git_pfx = "$sync->{ibx}->{inboxdir}/git";
1096 for (my $i = $sync->{epoch_max}; $i >= 0; $i--) {
1097 my $git_dir = "$git_pfx/$i.git";
1098 -d $git_dir or next; # missing epochs are fine
1099 my $git = PublicInbox::Git->new($git_dir);
1100 my $unit = { git => $git, epoch => $i };
1102 if ($reindex_heads) {
1103 $tip = $head = $reindex_heads->[$i] or next;
1105 $tip = $git->qx(qw(rev-parse -q --verify), $head);
1106 next if $?; # new repo
1109 my $range = log_range($sync, $unit, $tip) or next;
1110 # can't use 'rev-list --count' if we use --diff-filter
1111 $pr->("$pfx $i.git counting $range ... ") if $pr;
1112 # Don't bump num_highwater on --reindex by using {D}.
1113 # We intentionally do NOT use {D} in the non-reindex case
1114 # because we want NNTP article number gaps from unindexed
1115 # messages to show up in mirrors, too.
1116 $sync->{D} //= $sync->{reindex} ? {} : undef; # OID_BIN => NR
1117 my $stk = log2stack($sync, $git, $range);
1118 return 0 if $sync->{quit};
1119 my $nr = $stk ? $stk->num_records : 0;
1120 $pr->("$nr\n") if $pr;
1121 $unit->{stack} = $stk; # may be undef
1122 unshift @{$sync->{todo}}, $unit;
1125 return 0 if $sync->{quit};
1127 # XXX this should not happen unless somebody bypasses checks in
1128 # our code and blindly injects "d" file history into git repos
1129 if (my @leftovers = keys %{delete($sync->{D}) // {}}) {
1130 warn('W: unindexing '.scalar(@leftovers)." leftovers\n");
1131 local $self->{current_info} = 'leftover ';
1132 my $unindex_oid = $self->can('unindex_oid');
1133 for my $oid (@leftovers) {
1134 last if $sync->{quit};
1135 $oid = unpack('H*', $oid);
1136 my $req = { %$sync, oid => $oid };
1137 $self->git->cat_async($oid, $unindex_oid, $req);
1139 $self->git->cat_async_wait;
1141 return 0 if $sync->{quit};
1143 $sync->{-regen_fmt} = "%u/?\n";
1147 # reindex should NOT see new commits anymore, if we do,
1148 # it's a problem and we need to notice it via die()
1149 my $pad = length($regen_max) + 1;
1150 $sync->{-regen_fmt} = "% ${pad}u/$regen_max\n";
1151 $sync->{nr} = \(my $nr = 0);
1152 return -1 if $sync->{reindex};
1153 $regen_max + $self->artnum_max || 0;
1156 sub unindex_oid_aux ($$$) {
1157 my ($self, $oid, $mid) = @_;
1158 my @removed = $self->{oidx}->remove_oid($oid, $mid);
1159 for my $num (@removed) {
1160 my $idx = idx_shard($self, $num);
1161 $idx->shard_remove($num);
1165 sub unindex_oid ($$;$) { # git->cat_async callback
1166 my ($bref, $oid, $type, $size, $arg) = @_;
1167 is_bad_blob($oid, $type, $size, $arg->{oid}) and
1168 return index_finalize($arg, 0);
1169 my $self = $arg->{self};
1170 local $self->{current_info} = "$self->{current_info} $oid";
1171 my $unindexed = $arg->{in_unindex} ? $arg->{unindexed} : undef;
1172 my $mm = $self->{mm};
1173 my $mids = mids(PublicInbox::Eml->new($bref));
1175 my $oidx = $self->{oidx};
1176 foreach my $mid (@$mids) {
1179 while (my $smsg = $oidx->next_by_mid($mid, \$id, \$prev)) {
1180 $gone{$smsg->{num}} = 1 if $oid eq $smsg->{blob};
1182 my $n = scalar(keys(%gone)) or next;
1184 warn "BUG: multiple articles linked to $oid\n",
1185 join(',',sort keys %gone), "\n";
1187 foreach my $num (keys %gone) {
1189 my $mid0 = $mm->mid_for($num);
1190 $unindexed->{$mid0} = $num;
1192 $mm->num_delete($num);
1194 unindex_oid_aux($self, $oid, $mid);
1196 index_finalize($arg, 0);
1199 sub git { $_[0]->{ibx}->git }
1201 # this is rare, it only happens when we get discontiguous history in
1202 # a mirror because the source used -purge or -edit
1203 sub unindex_todo ($$$) {
1204 my ($self, $sync, $unit) = @_;
1205 my $unindex_range = delete($unit->{unindex_range}) // return;
1206 my $unindexed = $sync->{unindexed} //= {}; # $mid0 => $num
1207 my $before = scalar keys %$unindexed;
1208 # order does not matter, here:
1209 my $fh = $unit->{git}->popen(qw(log --raw -r --no-notes --no-color
1210 --no-abbrev --no-renames), $unindex_range);
1211 local $sync->{in_unindex} = 1;
1212 my $unindex_oid = $self->can('unindex_oid');
1214 /\A:\d{6} 100644 $OID ($OID) [AM]\tm$/o or next;
1215 $self->git->cat_async($1, $unindex_oid, { %$sync, oid => $1 });
1217 close $fh or die "git log failed: \$?=$?";
1218 $self->git->cat_async_wait;
1220 return unless $sync->{-opt}->{prune};
1221 my $after = scalar keys %$unindexed;
1222 return if $before == $after;
1224 # ensure any blob can not longer be accessed via dumb HTTP
1225 PublicInbox::Import::run_die(['git',
1226 "--git-dir=$unit->{git}->{git_dir}",
1227 qw(-c gc.reflogExpire=now gc --prune=all --quiet)]);
1230 sub sync_ranges ($$) {
1231 my ($self, $sync) = @_;
1232 my $reindex = $sync->{reindex};
1233 return $self->last_commits($sync) unless $reindex;
1234 return [] if ref($reindex) ne 'HASH';
1236 my $ranges = $reindex->{from}; # arrayref;
1237 if (ref($ranges) ne 'ARRAY') {
1238 die 'BUG: $reindex->{from} not an ARRAY';
1243 sub index_xap_only { # git->cat_async callback
1244 my ($bref, $oid, $type, $size, $smsg) = @_;
1245 my $self = $smsg->{self};
1246 my $idx = idx_shard($self, $smsg->{num});
1247 $smsg->{raw_bytes} = $size;
1248 $idx->index_raw($bref, undef, $smsg);
1249 $self->{transact_bytes} += $size;
1252 sub index_xap_step ($$$;$) {
1253 my ($self, $sync, $beg, $step) = @_;
1254 my $end = $sync->{art_end};
1255 return if $beg > $end; # nothing to do
1257 $step //= $self->{shards};
1258 my $ibx = $self->{ibx};
1259 if (my $pr = $sync->{-opt}->{-progress}) {
1260 $pr->("Xapian indexlevel=$ibx->{indexlevel} ".
1261 "$beg..$end (% $step)\n");
1263 for (my $num = $beg; $num <= $end; $num += $step) {
1264 last if $sync->{quit};
1265 my $smsg = $ibx->over->get_art($num) or next;
1266 $smsg->{self} = $self;
1267 $ibx->git->cat_async($smsg->{blob}, \&index_xap_only, $smsg);
1268 if ($self->{transact_bytes} >= $self->{batch_bytes}) {
1269 ${$sync->{nr}} = $num;
1270 reindex_checkpoint($self, $sync);
1275 sub index_todo ($$$) {
1276 my ($self, $sync, $unit) = @_;
1277 return if $sync->{quit};
1278 unindex_todo($self, $sync, $unit);
1279 my $stk = delete($unit->{stack}) or return;
1280 my $all = $self->git;
1281 my $index_oid = $self->can('index_oid');
1282 my $unindex_oid = $self->can('unindex_oid');
1284 if ($unit->{git}->{git_dir} =~ m!/([^/]+)/git/([0-9]+\.git)\z!) {
1285 $pfx = "$1 $2"; # v2
1287 ($pfx) = ($unit->{git}->{git_dir} =~ m!/([^/]+)\z!g);
1288 $pfx //= $unit->{git}->{git_dir};
1290 local $self->{current_info} = "$pfx ";
1291 local $sync->{latest_cmt} = \(my $latest_cmt);
1292 local $sync->{unit} = $unit;
1293 while (my ($f, $at, $ct, $oid, $cmt) = $stk->pop_rec) {
1294 if ($sync->{quit}) {
1295 warn "waiting to quit...\n";
1296 $all->async_wait_all;
1297 $self->update_last_commit($sync);
1308 if ($sync->{max_size}) {
1309 $all->check_async($oid, \&check_size, $req);
1311 $all->cat_async($oid, $index_oid, $req);
1313 } elsif ($f eq 'd') {
1314 $all->cat_async($oid, $unindex_oid, $req);
1316 if (${$sync->{need_checkpoint}}) {
1317 reindex_checkpoint($self, $sync);
1320 $all->async_wait_all;
1321 $self->update_last_commit($sync, $stk);
1325 my ($self, $opt, $sync, $art_beg) = @_;
1326 my $seq = $opt->{sequential_shard};
1328 local $self->{parallel} = 0 if $seq;
1329 $self->idx_init($opt); # acquire lock
1330 if (my $art_end = $self->{ibx}->mm->max) {
1332 need_checkpoint => \(my $bool = 0),
1335 nr => \(my $nr = 0),
1336 -regen_fmt => "%u/?\n",
1338 $sync->{art_end} = $art_end;
1339 if ($seq || !$self->{parallel}) {
1340 my $shard_end = $self->{shards} - 1;
1341 for my $i (0..$shard_end) {
1342 last if $sync->{quit};
1343 index_xap_step($self, $sync, $art_beg + $i);
1344 if ($i != $shard_end) {
1345 reindex_checkpoint($self, $sync);
1348 } else { # parallel (maybe)
1349 index_xap_step($self, $sync, $art_beg, 1);
1352 $self->git->cat_async_wait;
1356 # public, called by public-inbox-index
1358 my ($self, $opt) = @_;
1360 return xapian_only($self, $opt) if $opt->{xapian_only};
1363 my $latest = $self->{ibx}->git_dir_latest(\$epoch_max) // return;
1364 if ($opt->{'fast-noop'}) { # nanosecond (st_ctim) comparison
1365 use Time::HiRes qw(stat);
1366 if (my @mm = stat("$self->{ibx}->{inboxdir}/msgmap.sqlite3")) {
1367 my $c = $mm[10]; # 10 = ctime (nsec NV)
1368 my @hd = stat("$latest/refs/heads");
1369 my @pr = stat("$latest/packed-refs");
1370 return if $c > ($hd[10] // 0) && $c > ($pr[10] // 0);
1374 my $pr = $opt->{-progress};
1375 my $seq = $opt->{sequential_shard};
1376 my $art_beg; # the NNTP article number we start xapian_only at
1377 my $idxlevel = $self->{ibx}->{indexlevel};
1378 local $self->{ibx}->{indexlevel} = 'basic' if $seq;
1380 $self->idx_init($opt); # acquire lock
1381 fill_alternates($self, $epoch_max);
1382 $self->{oidx}->rethread_prepare($opt);
1384 need_checkpoint => \(my $bool = 0),
1385 reindex => $opt->{reindex},
1388 ibx => $self->{ibx},
1389 epoch_max => $epoch_max,
1391 my $quit = PublicInbox::SearchIdx::quit_cb($sync);
1392 local $SIG{QUIT} = $quit;
1393 local $SIG{INT} = $quit;
1394 local $SIG{TERM} = $quit;
1396 if (sync_prepare($self, $sync)) {
1397 # tmp_clone seems to fail if inside a transaction, so
1398 # we rollback here (because we opened {mm} for reading)
1399 # Note: we do NOT rely on DBI transactions for atomicity;
1400 # only for batch performance.
1401 $self->{mm}->{dbh}->rollback;
1402 $self->{mm}->{dbh}->begin_work;
1404 $self->{mm}->tmp_clone($self->{ibx}->{inboxdir});
1406 # xapian_only works incrementally w/o --reindex
1407 if ($seq && !$opt->{reindex}) {
1408 $art_beg = $sync->{mm_tmp}->max || -1;
1412 # work forwards through history
1413 index_todo($self, $sync, $_) for @{delete($sync->{todo}) // []};
1414 $self->{oidx}->rethread_done($opt) unless $sync->{quit};
1417 if (my $nr = $sync->{nr}) {
1418 my $pr = $sync->{-opt}->{-progress};
1419 $pr->('all.git '.sprintf($sync->{-regen_fmt}, $$nr)) if $pr;
1423 # deal with Xapian shards sequentially
1424 if ($seq && delete($sync->{mm_tmp})) {
1425 if ($sync->{quit}) {
1428 $self->{ibx}->{indexlevel} = $idxlevel;
1429 xapian_only($self, $opt, $sync, $art_beg);
1430 $quit_warn = 1 if $sync->{quit};
1434 # --reindex on the command-line
1435 if (!$sync->{quit} && $opt->{reindex} &&
1436 !ref($opt->{reindex}) && $idxlevel ne 'basic') {
1437 $self->lock_acquire;
1438 my $s0 = PublicInbox::SearchIdx->new($self->{ibx}, 0, 0);
1439 if (my $xdb = $s0->idx_acquire) {
1440 my $n = $xdb->get_metadata('has_threadid');
1441 $xdb->set_metadata('has_threadid', '1') if $n ne '1';
1444 $self->lock_release;
1447 # reindex does not pick up new changes, so we rerun w/o it:
1448 if ($opt->{reindex} && !$sync->{quit}) {
1451 delete @again{qw(rethread reindex -skip_lock)};
1452 index_sync($self, \%again);
1453 $opt->{quit} = $again{quit}; # propagate to caller
1455 warn <<EOF if $quit_warn;
1456 W: interrupted, --xapian-only --reindex required upon restart