1 # Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 # based on notmuch, but with no concept of folders, files or flags
5 # Indexes mail with Xapian and our (SQLite-based) ::Msgmap for use
6 # with the web and NNTP interfaces. This index maintains thread
7 # relationships for use by PublicInbox::SearchThread.
8 # This writes to the search index.
9 package PublicInbox::SearchIdx;
12 use parent qw(PublicInbox::Search PublicInbox::Lock Exporter);
14 use PublicInbox::InboxWritable;
15 use PublicInbox::MID qw(mid_mime mids_for_index mids);
16 use PublicInbox::MsgIter;
17 use PublicInbox::IdxStack;
19 use POSIX qw(strftime);
20 use PublicInbox::OverIdx;
21 use PublicInbox::Spawn qw(spawn);
22 use PublicInbox::Git qw(git_unquote);
23 use PublicInbox::MsgTime qw(msg_timestamp msg_datestamp);
24 our @EXPORT_OK = qw(too_big crlf_adjust log2stack is_ancestor);
25 my $X = \%PublicInbox::Search::X;
26 my ($DB_CREATE_OR_OPEN, $DB_OPEN);
28 our $BATCH_BYTES = defined($ENV{XAPIAN_FLUSH_THRESHOLD}) ?
29 0x7fffffff : 1_000_000;
30 use constant DEBUG => !!$ENV{DEBUG};
32 my $xapianlevels = qr/\A(?:full|medium)\z/;
34 my $OID = $hex .'{40,}';
37 my ($class, $ibx, $creat, $shard) = @_;
38 ref $ibx or die "BUG: expected PublicInbox::Inbox object: $ibx";
39 my $levels = qr/\A(?:full|medium|basic)\z/;
40 my $inboxdir = $ibx->{inboxdir};
41 my $version = $ibx->version;
42 my $indexlevel = 'full';
43 my $altid = $ibx->{altid};
45 require PublicInbox::AltId;
46 $altid = [ map { PublicInbox::AltId->new($ibx, $_); } @$altid ];
48 if ($ibx->{indexlevel}) {
49 if ($ibx->{indexlevel} =~ $levels) {
50 $indexlevel = $ibx->{indexlevel};
52 die("Invalid indexlevel $ibx->{indexlevel}\n");
55 $ibx = PublicInbox::InboxWritable->new($ibx);
58 xpfx => $inboxdir, # for xpfx_init
61 indexlevel => $indexlevel,
64 $self->{-set_indexlevel_once} = 1 if $indexlevel eq 'medium';
67 $self->{lock_path} = "$inboxdir/ssoma.lock";
68 my $dir = $self->xdir;
69 $self->{over} = PublicInbox::OverIdx->new("$dir/over.sqlite3");
70 $self->{over}->{-no_sync} = 1 if $ibx->{-no_sync};
71 $self->{index_max_size} = $ibx->{index_max_size};
72 } elsif ($version == 2) {
73 defined $shard or die "shard is required for v2\n";
75 $self->{shard} = $shard;
76 $self->{lock_path} = undef;
78 die "unsupported inbox version=$version\n";
80 $self->{creat} = ($creat || 0) == 1;
84 sub need_xapian ($) { $_[0]->{indexlevel} =~ $xapianlevels }
87 my ($self, $wake) = @_;
88 if (need_xapian($self)) {
89 my $xdb = delete $self->{xdb} or croak 'not acquired';
92 $self->lock_release($wake) if $self->{creat};
96 sub load_xapian_writable () {
97 return 1 if $X->{WritableDatabase};
98 PublicInbox::Search::load_xapian() or return;
99 my $xap = $PublicInbox::Search::Xap;
100 for (qw(Document TermGenerator WritableDatabase)) {
101 $X->{$_} = $xap.'::'.$_;
103 eval 'require '.$X->{WritableDatabase} or die;
104 *sortable_serialise = $xap.'::sortable_serialise';
105 $DB_CREATE_OR_OPEN = eval($xap.'::DB_CREATE_OR_OPEN()');
106 $DB_OPEN = eval($xap.'::DB_OPEN()');
107 my $ver = (eval($xap.'::major_version()') << 16) |
108 (eval($xap.'::minor_version()') << 8);
109 $DB_NO_SYNC = 0x4 if $ver >= 0x10400;
116 my $dir = $self->xdir;
117 if (need_xapian($self)) {
118 croak 'already acquired' if $self->{xdb};
119 load_xapian_writable();
120 $flag = $self->{creat} ? $DB_CREATE_OR_OPEN : $DB_OPEN;
122 if ($self->{creat}) {
126 # don't create empty Xapian directories if we don't need Xapian
127 my $is_shard = defined($self->{shard});
128 if (!$is_shard || ($is_shard && need_xapian($self))) {
129 File::Path::mkpath($dir);
132 return unless defined $flag;
133 $flag |= $DB_NO_SYNC if $self->{ibx}->{-no_sync};
134 my $xdb = eval { ($X->{WritableDatabase})->new($dir, $flag) };
136 die "Failed opening $dir: ", $@;
142 my ($doc, $col, $num) = @_;
143 $num = sortable_serialise($num);
144 $doc->add_value($col, $num);
147 sub term_generator ($) { # write-only
150 $self->{term_generator} //= do {
151 my $tg = $X->{TermGenerator}->new;
152 $tg->set_stemmer($self->stemmer);
157 sub index_text ($$$$) {
158 my ($self, $text, $wdf_inc, $prefix) = @_;
159 my $tg = term_generator($self); # man Search::Xapian::TermGenerator
161 if ($self->{indexlevel} eq 'full') {
162 $tg->index_text($text, $wdf_inc, $prefix);
163 $tg->increase_termpos;
165 $tg->index_text_without_positions($text, $wdf_inc, $prefix);
169 sub index_headers ($$) {
170 my ($self, $smsg) = @_;
171 my @x = (from => 'A', # Author
172 subject => 'S', to => 'XTO', cc => 'XCC');
173 while (my ($field, $pfx) = splice(@x, 0, 2)) {
174 my $val = $smsg->{$field};
175 index_text($self, $val, 1, $pfx) if $val ne '';
179 sub index_diff_inc ($$$$) {
180 my ($self, $text, $pfx, $xnq) = @_;
182 index_text($self, join("\n", @$xnq), 1, 'XNQ');
185 index_text($self, $text, 1, $pfx);
188 sub index_old_diff_fn {
189 my ($self, $seen, $fa, $fb, $xnq) = @_;
191 # no renames or space support for traditional diffs,
192 # find the number of leading common paths to strip:
193 my @fa = split('/', $fa);
194 my @fb = split('/', $fb);
195 while (scalar(@fa) && scalar(@fb)) {
196 $fa = join('/', @fa);
197 $fb = join('/', @fb);
199 unless ($seen->{$fa}++) {
200 index_diff_inc($self, $fa, 'XDFN', $xnq);
210 sub index_diff ($$$) {
211 my ($self, $txt, $doc) = @_;
216 foreach (split(/\n/, $txt)) {
217 if ($in_diff && s/^ //) { # diff context
218 index_diff_inc($self, $_, 'XDFCTX', $xnq);
219 } elsif (/^-- $/) { # email signature begins
221 } elsif (m!^diff --git "?[^/]+/.+ "?[^/]+/.+\z!) {
222 # wait until "---" and "+++" to capture filenames
225 } elsif (m/^diff -(.+) (\S+) (\S+)$/) {
226 my ($opt, $fa, $fb) = ($1, $2, $3);
228 # only support unified:
229 next unless $opt =~ /[uU]/;
230 $in_diff = index_old_diff_fn($self, \%seen, $fa, $fb,
232 } elsif (m!^--- ("?[^/]+/.+)!) {
234 $fn = (split('/', git_unquote($fn), 2))[1];
235 $seen{$fn}++ or index_diff_inc($self, $fn, 'XDFN', $xnq);
237 } elsif (m!^\+\+\+ ("?[^/]+/.+)!) {
239 $fn = (split('/', git_unquote($fn), 2))[1];
240 $seen{$fn}++ or index_diff_inc($self, $fn, 'XDFN', $xnq);
242 } elsif (/^--- (\S+)/) {
245 } elsif (defined $in_diff && /^\+\+\+ (\S+)/) {
246 $in_diff = index_old_diff_fn($self, \%seen, $in_diff,
248 } elsif ($in_diff && s/^\+//) { # diff added
249 index_diff_inc($self, $_, 'XDFB', $xnq);
250 } elsif ($in_diff && s/^-//) { # diff removed
251 index_diff_inc($self, $_, 'XDFA', $xnq);
252 } elsif (m!^index ([a-f0-9]+)\.\.([a-f0-9]+)!) {
253 my ($ba, $bb) = ($1, $2);
254 index_git_blob_id($doc, 'XDFPRE', $ba);
255 index_git_blob_id($doc, 'XDFPOST', $bb);
257 } elsif (/^@@ (?:\S+) (?:\S+) @@\s*$/) {
258 # traditional diff w/o -p
259 } elsif (/^@@ (?:\S+) (?:\S+) @@\s*(\S+.*)$/) {
260 # hunk header context
261 index_diff_inc($self, $1, 'XDFHH', $xnq);
262 # ignore the following lines:
263 } elsif (/^(?:dis)similarity index/ ||
264 /^(?:old|new) mode/ ||
265 /^(?:deleted|new) file mode/ ||
266 /^(?:copy|rename) (?:from|to) / ||
267 /^(?:dis)?similarity index / ||
268 /^\\ No newline at end of file/ ||
269 /^Binary files .* differ/) {
272 # possible to be in diff context, some mail may be
273 # stripped by MUA or even GNU diff(1). "git apply"
274 # treats a bare "\n" as diff context, too
277 warn "non-diff line: $_\n" if DEBUG && $_ ne '';
282 index_text($self, join("\n", @xnq), 1, 'XNQ');
285 sub index_xapian { # msg_iter callback
286 my $part = $_[0]->[0]; # ignore $depth and $idx
287 my ($self, $doc) = @{$_[1]};
288 my $ct = $part->content_type || 'text/plain';
289 my $fn = $part->filename;
290 if (defined $fn && $fn ne '') {
291 index_text($self, $fn, 1, 'XFN');
293 if ($part->{is_submsg}) {
294 my $mids = mids_for_index($part);
295 index_ids($self, $doc, $part, $mids);
296 my $smsg = bless {}, 'PublicInbox::Smsg';
297 $smsg->populate($part);
298 index_headers($self, $smsg);
301 my ($s, undef) = msg_part_text($part, $ct);
302 defined $s or return;
303 $_[0]->[0] = $part = undef; # free memory
305 # split off quoted and unquoted blocks:
306 my @sections = PublicInbox::MsgIter::split_quotes($s);
307 undef $s; # free memory
308 for my $txt (@sections) {
310 index_text($self, $txt, 0, 'XQUOT');
312 # does it look like a diff?
313 if ($txt =~ /^(?:diff|---|\+\+\+) /ms) {
314 index_diff($self, $txt, $doc);
316 index_text($self, $txt, 1, 'XNQ');
319 undef $txt; # free memory
323 sub index_ids ($$$$) {
324 my ($self, $doc, $hdr, $mids) = @_;
325 for my $mid (@$mids) {
326 index_text($self, $mid, 1, 'XM');
328 # because too many Message-IDs are prefixed with
330 if ($mid =~ /\w{12,}/) {
331 my @long = ($mid =~ /(\w{3,}+)/g);
332 index_text($self, join(' ', @long), 1, 'XM');
335 $doc->add_boolean_term('Q' . $_) for @$mids;
336 for my $l ($hdr->header_raw('List-Id')) {
337 $l =~ /<([^>]+)>/ or next;
339 $doc->add_boolean_term('G' . $lid);
340 index_text($self, $lid, 1, 'XL'); # probabilistic
344 sub add_xapian ($$$$) {
345 my ($self, $mime, $smsg, $mids) = @_;
346 my $hdr = $mime->header_obj;
347 my $doc = $X->{Document}->new;
348 add_val($doc, PublicInbox::Search::TS(), $smsg->{ts});
349 my @ds = gmtime($smsg->{ds});
350 my $yyyymmdd = strftime('%Y%m%d', @ds);
351 add_val($doc, PublicInbox::Search::YYYYMMDD(), $yyyymmdd);
352 my $dt = strftime('%Y%m%d%H%M%S', @ds);
353 add_val($doc, PublicInbox::Search::DT(), $dt);
354 add_val($doc, PublicInbox::Search::BYTES(), $smsg->{bytes});
355 add_val($doc, PublicInbox::Search::UID(), $smsg->{num});
357 my $tg = term_generator($self);
358 $tg->set_document($doc);
359 index_headers($self, $smsg);
361 msg_iter($mime, \&index_xapian, [ $self, $doc ]);
362 index_ids($self, $doc, $hdr, $mids);
363 $smsg->{to} = $smsg->{cc} = ''; # WWW doesn't need these, only NNTP
364 PublicInbox::OverIdx::parse_references($smsg, $hdr, $mids);
365 my $data = $smsg->to_doc_data;
366 $doc->set_data($data);
367 if (my $altid = $self->{-altid}) {
368 foreach my $alt (@$altid) {
369 my $pfx = $alt->{xprefix};
370 foreach my $mid (@$mids) {
371 my $id = $alt->mid2alt($mid);
372 next unless defined $id;
373 $doc->add_boolean_term($pfx . $id);
377 $self->{xdb}->replace_document($smsg->{num}, $doc);
380 sub _msgmap_init ($) {
382 die "BUG: _msgmap_init is only for v1\n" if $self->{ibx_ver} != 1;
383 $self->{mm} //= eval {
384 require PublicInbox::Msgmap;
385 my $rw = $self->{ibx}->{-no_sync} ? 2 : 1;
386 PublicInbox::Msgmap->new($self->{ibx}->{inboxdir}, $rw);
391 # mime = PublicInbox::Eml or Email::MIME object
392 my ($self, $mime, $smsg, $sync) = @_;
393 my $hdr = $mime->header_obj;
394 my $mids = mids_for_index($hdr);
395 $smsg //= bless { blob => '' }, 'PublicInbox::Smsg'; # test-only compat
396 $smsg->{mid} //= $mids->[0]; # v1 compatibility
397 $smsg->{num} //= do { # v1
399 index_mm($self, $mime, $smsg->{blob}, $sync);
403 $smsg->populate($hdr, $sync);
404 $smsg->{bytes} //= length($mime->as_string);
407 # order matters, overview stores every possible piece of
408 # data in doc_data (deflated). Xapian only stores a subset
409 # of the fields which exist in over.sqlite3. We may stop
410 # storing doc_data in Xapian sometime after we get multi-inbox
412 if (my $over = $self->{over}) { # v1 only
413 $over->add_overview($mime, $smsg);
415 if (need_xapian($self)) {
416 add_xapian($self, $mime, $smsg, $mids);
421 warn "failed to index message <".join('> <',@$mids).">: $@\n";
428 my ($self, $oid, @removed) = @_;
429 my $xdb = $self->{xdb} or return;
430 for my $num (@removed) {
431 my $doc = eval { $xdb->get_document($num) };
433 warn "E: $@\n" if $@;
434 warn "E: #$num $oid missing in Xapian\n";
437 my $smsg = bless {}, 'PublicInbox::Smsg';
438 $smsg->load_expand($doc);
439 my $blob = $smsg->{blob} // '(unset)';
441 $xdb->delete_document($num);
443 warn "E: #$num $oid != $blob in Xapian\n";
449 my ($self, $oid, $num) = @_;
450 die "BUG: remove_by_oid is v2-only\n" if $self->{over};
451 $self->begin_txn_lazy;
452 xdb_remove($self, $oid, $num) if need_xapian($self);
455 sub index_git_blob_id {
456 my ($doc, $pfx, $objid) = @_;
458 my $len = length($objid);
459 for (my $len = length($objid); $len >= 7; ) {
460 $doc->add_term($pfx.$objid);
461 $objid = substr($objid, 0, --$len);
467 my ($self, $oid, $eml) = @_;
468 my $mids = mids($eml);
471 for my $mid (@$mids) {
472 my @removed = eval { $self->{over}->remove_oid($oid, $mid) };
474 warn "E: failed to remove <$mid> from overview: $@\n";
476 $nr += scalar @removed;
477 $tmp{$_}++ for @removed;
481 $mids = join('> <', @$mids);
482 warn "W: <$mids> missing for removal from overview\n";
484 while (my ($num, $nr) = each %tmp) {
485 warn "BUG: $num appears >1 times ($nr) for $oid\n" if $nr != 1;
487 xdb_remove($self, $oid, keys %tmp) if need_xapian($self);
491 my ($self, $mime, $oid, $sync) = @_;
492 my $mids = mids($mime);
493 my $mm = $self->{mm};
494 if ($sync->{reindex}) {
495 my $over = $self->{over};
496 for my $mid (@$mids) {
497 my ($num, undef) = $over->num_mid0_for_oid($oid, $mid);
498 return $num if defined $num;
500 $mm->num_for($mids->[0]) // $mm->mid_insert($mids->[0]);
502 # fallback to num_for since filters like RubyLang set the number
503 $mm->mid_insert($mids->[0]) // $mm->num_for($mids->[0]);
508 my ($self, $mime) = @_;
509 $self->{mm}->mid_delete(mid_mime($mime));
512 # returns the number of bytes to add if given a non-CRLF arg
513 sub crlf_adjust ($) {
514 if (index($_[0], "\r\n") < 0) {
515 # common case is LF-only, every \n needs an \r;
516 # so favor a cheap tr// over an expensive m//g
518 } else { # count number of '\n' w/o '\r', expensive:
519 scalar(my @n = ($_[0] =~ m/(?<!\r)\n/g));
523 sub index_both { # git->cat_async callback
524 my ($bref, $oid, $type, $size, $sync) = @_;
525 my ($nr, $max) = @$sync{qw(nr max)};
528 $size += crlf_adjust($$bref);
529 my $smsg = bless { bytes => $size, blob => $oid }, 'PublicInbox::Smsg';
530 my $self = $sync->{sidx};
531 my $eml = PublicInbox::Eml->new($bref);
532 $smsg->{num} = index_mm($self, $eml, $oid, $sync) or
533 die "E: could not generate NNTP article number for $oid";
534 add_message($self, $eml, $smsg, $sync);
537 sub unindex_both { # git->cat_async callback
538 my ($bref, $oid, $type, $size, $self) = @_;
539 my $eml = PublicInbox::Eml->new($bref);
540 unindex_eml($self, $oid, $eml);
541 unindex_mm($self, $eml);
544 # called by public-inbox-index
546 my ($self, $opts) = @_;
547 delete $self->{lock_path} if $opts->{-skip_lock};
548 $self->{ibx}->with_umask(\&_index_sync, $self, $opts);
549 if ($opts->{reindex}) {
551 delete @again{qw(rethread reindex)};
552 index_sync($self, \%again);
557 my ($self, $oid) = @_;
558 my $max_size = $self->{index_max_size} or return;
559 my (undef, undef, $size) = $self->{ibx}->git->check($oid);
560 die "E: bad $oid in $self->{ibx}->{inboxdir}\n" if !defined($size);
561 return if $size <= $max_size;
562 warn "W: skipping $oid ($size > $max_size)\n";
566 sub ck_size { # check_async cb for -index --max-size=...
567 my ($oid, $type, $size, $arg, $git) = @_;
568 (($type // '') eq 'blob') or die "E: bad $oid in $git->{git_dir}";
569 if ($size <= $arg->{index_max_size}) {
570 $git->cat_async($oid, \&index_both, $arg);
572 warn "W: skipping $oid ($size > $arg->{index_max_size})\n";
576 sub v1_checkpoint ($$;$) {
577 my ($self, $sync, $stk) = @_;
578 $self->{ibx}->git->check_async_wait;
579 $self->{ibx}->git->cat_async_wait;
581 # latest_cmt may be undef
582 my $newest = $stk ? $stk->{latest_cmt} : undef;
584 my $cur = $self->{mm}->last_commit || '';
585 if (need_update($self, $cur, $newest)) {
586 $self->{mm}->last_commit($newest);
589 ${$sync->{max}} = $BATCH_BYTES;
592 $self->{mm}->{dbh}->commit;
593 if ($newest && need_xapian($self)) {
594 my $cur = $self->{xdb}->get_metadata('last_commit');
595 if (need_update($self, $cur, $newest)) {
596 $self->{xdb}->set_metadata('last_commit', $newest);
600 $self->{over}->rethread_done($sync->{-opt}) if $newest; # all done
601 commit_txn_lazy($self);
602 $self->{ibx}->git->cleanup;
603 my $nr = ${$sync->{nr}};
604 idx_release($self, $nr);
605 # let another process do some work...
606 if (my $pr = $sync->{-opt}->{-progress}) {
607 $pr->("indexed $nr/$sync->{ntodo}\n") if $nr;
609 if (!$stk) { # more to come
610 begin_txn_lazy($self);
611 $self->{mm}->{dbh}->begin_work;
617 my ($self, $sync, $stk) = @_;
618 my $git = $self->{ibx}->git;
619 my $max = $BATCH_BYTES;
622 $sync->{max} = \$max;
623 $sync->{sidx} = $self;
625 $self->{mm}->{dbh}->begin_work;
626 if (my @leftovers = keys %{delete($sync->{D}) // {}}) {
627 warn('W: unindexing '.scalar(@leftovers)." leftovers\n");
628 for my $oid (@leftovers) {
629 $oid = unpack('H*', $oid);
630 $git->cat_async($oid, \&unindex_both, $self);
633 $sync->{index_max_size} = $self->{ibx}->{index_max_size};
634 while (my ($f, $at, $ct, $oid) = $stk->pop_rec) {
636 my $arg = { %$sync, autime => $at, cotime => $ct };
637 if ($sync->{index_max_size}) {
638 $git->check_async($oid, \&ck_size, $arg);
640 $git->cat_async($oid, \&index_both, $arg);
642 v1_checkpoint($self, $sync) if $max <= 0;
643 } elsif ($f eq 'd') {
644 $git->cat_async($oid, \&unindex_both, $self);
647 v1_checkpoint($self, $sync, $stk);
650 sub log2stack ($$$$) {
651 my ($sync, $git, $range, $ibx) = @_;
652 my $D = $sync->{D}; # OID_BIN => NR (if reindexing, undef otherwise)
654 if ($ibx->version == 1) {
655 my $path = $hex.'{2}/'.$hex.'{38}';
656 $add = qr!\A:000000 100644 \S+ ($OID) A\t$path$!;
657 $del = qr!\A:100644 000000 ($OID) \S+ D\t$path$!;
659 $del = qr!\A:\d{6} 100644 $OID ($OID) [AM]\td$!;
660 $add = qr!\A:\d{6} 100644 $OID ($OID) [AM]\tm$!;
663 # Count the new files so they can be added newest to oldest
664 # and still have numbers increasing from oldest to newest
665 my $fh = $git->popen(qw(log --raw -r --pretty=tformat:%at-%ct-%H
666 --no-notes --no-color --no-renames --no-abbrev),
670 if (/\A([0-9]+)-([0-9]+)-($OID)$/o) {
671 ($at, $ct) = ($1 + 0, $2 + 0);
672 $stk //= PublicInbox::IdxStack->new($3);
675 if ($D) { # reindex case
676 $D->{pack('H*', $oid)}++;
677 } else { # non-reindex case:
678 $stk->push_rec('d', $at, $ct, $oid);
683 my $oid_bin = pack('H*', $oid);
684 my $nr = --$D->{$oid_bin};
685 delete($D->{$oid_bin}) if $nr <= 0;
687 # nr < 0 (-1) means it never existed
688 $stk->push_rec('m', $at, $ct, $oid) if $nr < 0;
690 $stk->push_rec('m', $at, $ct, $oid);
694 close $fh or die "git log failed: \$?=$?";
695 $stk //= PublicInbox::IdxStack->new;
699 sub prepare_stack ($$$) {
700 my ($self, $sync, $range) = @_;
701 my $git = $self->{ibx}->git;
703 if (index($range, '..') < 0) {
704 # don't show annoying git errors to users who run -index
706 $git->qx(qw(rev-parse -q --verify), "$range^0");
707 return PublicInbox::IdxStack->new->read_prepare if $?;
709 $sync->{D} = $sync->{reindex} ? {} : undef; # OID_BIN => NR
710 log2stack($sync, $git, $range, $self->{ibx});
713 # --is-ancestor requires git 1.8.0+
714 sub is_ancestor ($$$) {
715 my ($git, $cur, $tip) = @_;
716 return 0 unless $git->check($cur);
717 my $cmd = [ 'git', "--git-dir=$git->{git_dir}",
718 qw(merge-base --is-ancestor), $cur, $tip ];
719 my $pid = spawn($cmd);
720 waitpid($pid, 0) == $pid or die join(' ', @$cmd) .' did not finish';
724 sub need_update ($$$) {
725 my ($self, $cur, $new) = @_;
726 my $git = $self->{ibx}->git;
727 return 1 if $cur && !is_ancestor($git, $cur, $new);
728 my $range = $cur eq '' ? $new : "$cur..$new";
729 chomp(my $n = $git->qx(qw(rev-list --count), $range));
730 ($n eq '' || $n > 0);
733 # The last git commit we indexed with Xapian or SQLite (msgmap)
734 # This needs to account for cases where Xapian or SQLite is
735 # out-of-date with respect to the other.
737 my ($self, $mm) = @_;
738 my $lm = $mm->last_commit || '';
740 if (need_xapian($self)) {
741 $lx = $self->{xdb}->get_metadata('last_commit') || '';
745 # Use last_commit from msgmap if it is older or unset
746 if (!$lm || ($lx && $lm && is_ancestor($self->{ibx}->git, $lm, $lx))) {
752 sub reindex_from ($$) {
753 my ($reindex, $last_commit) = @_;
754 return $last_commit unless $reindex;
755 ref($reindex) eq 'HASH' ? $reindex->{from} : '';
758 # indexes all unindexed messages (v1 only)
760 my ($self, $opts) = @_;
761 my $tip = $opts->{ref} || 'HEAD';
762 my $git = $self->{ibx}->git;
764 my $pr = $opts->{-progress};
765 my $sync = { reindex => $opts->{reindex}, -opt => $opts };
766 my $xdb = $self->begin_txn_lazy;
767 $self->{over}->rethread_prepare($opts);
768 my $mm = _msgmap_init($self);
769 if ($sync->{reindex}) {
770 my $last = $mm->last_commit;
774 # somebody just blindly added --reindex when indexing
775 # for the first time, allow it:
776 undef $sync->{reindex};
779 my $last_commit = _last_x_commit($self, $mm);
780 my $lx = reindex_from($sync->{reindex}, $last_commit);
781 my $range = $lx eq '' ? $tip : "$lx..$tip";
782 $pr->("counting changes\n\t$range ... ") if $pr;
783 my $stk = prepare_stack($self, $sync, $range);
784 $sync->{ntodo} = $stk ? $stk->num_records : 0;
785 $pr->("$sync->{ntodo}\n") if $pr; # continue previous line
786 process_stack($self, $sync, $stk);
790 # order matters for unlocking
791 $_[0]->{xdb} = undef;
792 $_[0]->{lockfh} = undef;
795 # remote_* subs are only used by SearchIdxPart
798 if (my $w = $self->{w}) {
799 print $w "commit\n" or die "failed to write commit: $!";
801 $self->commit_txn_lazy;
807 if (my $w = delete $self->{w}) {
808 my $pid = delete $self->{pid} or die "no process to wait on\n";
809 print $w "close\n" or die "failed to write to pid:$pid: $!\n";
810 close $w or die "failed to close pipe for pid:$pid: $!\n";
811 waitpid($pid, 0) == $pid or die "remote process did not finish";
812 $? == 0 or die ref($self)." pid:$pid exited with: $?";
814 die "transaction in progress $self\n" if $self->{txn};
815 idx_release($self) if $self->{xdb};
820 my ($self, $oid, $num) = @_;
821 if (my $w = $self->{w}) {
822 # triggers remove_by_oid in a shard
823 print $w "D $oid $num\n" or die "failed to write remove $!";
825 $self->remove_by_oid($oid, $num);
831 my $xdb = $self->{xdb} || idx_acquire($self);
832 $self->{over}->begin_lazy if $self->{over};
833 $xdb->begin_transaction if $xdb;
840 $self->{ibx}->with_umask(\&_begin_txn, $self) if !$self->{txn};
843 # store 'indexlevel=medium' in v2 shard=0 and v1 (only one shard)
844 # This metadata is read by Admin::detect_indexlevel:
848 if (!$self->{shard} && # undef or 0, not >0
849 delete($self->{-set_indexlevel_once})) {
850 my $xdb = $self->{xdb};
851 my $level = $xdb->get_metadata('indexlevel');
852 if (!$level || $level ne 'medium') {
853 $xdb->set_metadata('indexlevel', 'medium');
860 if (my $xdb = $self->{xdb}) {
861 set_indexlevel($self);
862 $xdb->commit_transaction;
864 $self->{over}->commit_lazy if $self->{over};
867 sub commit_txn_lazy {
869 delete($self->{txn}) and
870 $self->{ibx}->with_umask(\&_commit_txn, $self);
875 if (need_xapian($self)) {
876 die "$$ $0 xdb not released\n" if $self->{xdb};
878 die "$$ $0 still in transaction\n" if $self->{txn};