1 # Copyright (C) 2015-2018 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 Fcntl qw(:flock :DEFAULT);
13 use PublicInbox::MIME;
14 use base qw(PublicInbox::Search);
15 use PublicInbox::MID qw/mid_clean id_compress mid_mime/;
16 use PublicInbox::MsgIter;
18 use POSIX qw(strftime);
19 require PublicInbox::Git;
22 MAX_MID_SIZE => 244, # max term size - 1 in Xapian
25 OLD_PERM_EVERYBODY => 2,
27 PERM_EVERYBODY => 0664,
28 BATCH_BYTES => 1_000_000,
29 DEBUG => !!$ENV{DEBUG},
44 return $s unless ($s =~ /\A"(.*)"\z/);
46 $s =~ s/\\([abfnrtv])/$GIT_ESC{$1}/g;
47 $s =~ s/\\([0-7]{1,3})/chr(oct($1))/ge;
52 my ($class, $ibx, $creat, $part) = @_;
53 my $mainrepo = $ibx; # for "public-inbox-index" w/o entry in config
54 my $git_dir = $mainrepo;
58 $mainrepo = $ibx->{mainrepo};
59 $altid = $ibx->{altid};
60 $version = $ibx->{version} || 1;
62 require PublicInbox::AltId;
64 PublicInbox::AltId->new($ibx, $_);
69 $git = PublicInbox::Git->new($git_dir); # v1 only
71 require Search::Xapian::WritableDatabase;
73 mainrepo => $mainrepo,
78 my $perm = $self->_git_config_perm;
79 my $umask = _umask_for($perm);
80 $self->{umask} = $umask;
82 $self->{lock_path} = "$mainrepo/ssoma.lock";
83 } elsif ($version == 2) {
84 defined $part or die "partition is required for v2\n";
85 # partition is a number or "all"
86 $self->{partition} = $part;
87 $self->{lock_path} = undef;
88 $self->{msgmap_path} = "$mainrepo/msgmap.sqlite3";
90 die "unsupported inbox version=$version\n";
92 $self->{creat} = ($creat || 0) == 1;
98 my $xdb = delete $self->{xdb} or croak 'not acquired';
100 _lock_release($self) if $self->{creat};
106 croak 'already acquired' if $self->{xdb};
107 my $dir = $self->xdir;
108 my $flag = Search::Xapian::DB_OPEN;
109 if ($self->{creat}) {
111 _lock_acquire($self);
112 File::Path::mkpath($dir);
113 $flag = Search::Xapian::DB_CREATE_OR_OPEN;
115 $self->{xdb} = Search::Xapian::WritableDatabase->new($dir, $flag);
118 # we only acquire the flock if creating or reindexing;
119 # PublicInbox::Import already has the lock on its own.
122 croak 'already locked' if $self->{lockfh};
123 my $lock_path = $self->{lock_path} or return;
124 sysopen(my $lockfh, $lock_path, O_WRONLY|O_CREAT) or
125 die "failed to open lock $lock_path: $!\n";
126 flock($lockfh, LOCK_EX) or die "lock failed: $!\n";
127 $self->{lockfh} = $lockfh;
132 return unless $self->{lock_path};
133 my $lockfh = delete $self->{lockfh} or croak 'not locked';
134 flock($lockfh, LOCK_UN) or die "unlock failed: $!\n";
135 close $lockfh or die "close failed: $!\n";
139 my ($doc, $col, $num) = @_;
140 $num = Search::Xapian::sortable_serialise($num);
141 $doc->add_value($col, $num);
144 sub add_values ($$) {
145 my ($doc, $values) = @_;
147 my $ts = $values->[PublicInbox::Search::TS];
148 add_val($doc, PublicInbox::Search::TS, $ts);
150 my $num = $values->[PublicInbox::Search::NUM];
151 defined($num) and add_val($doc, PublicInbox::Search::NUM, $num);
153 my $bytes = $values->[PublicInbox::Search::BYTES];
154 defined($bytes) and add_val($doc, PublicInbox::Search::BYTES, $bytes);
156 my $lines = $values->[PublicInbox::Search::LINES];
157 add_val($doc, PublicInbox::Search::LINES, $lines);
159 my $yyyymmdd = strftime('%Y%m%d', gmtime($ts));
160 add_val($doc, PublicInbox::Search::YYYYMMDD, $yyyymmdd);
163 sub index_users ($$) {
164 my ($tg, $smsg) = @_;
166 my $from = $smsg->from;
170 $tg->index_text($from, 1, 'A'); # A - author
171 $tg->increase_termpos;
172 $tg->index_text($to, 1, 'XTO') if $to ne '';
173 $tg->increase_termpos;
174 $tg->index_text($cc, 1, 'XCC') if $cc ne '';
175 $tg->increase_termpos;
178 sub index_text_inc ($$$) {
179 my ($tg, $text, $pfx) = @_;
180 $tg->index_text($text, 1, $pfx);
181 $tg->increase_termpos;
184 sub index_old_diff_fn {
185 my ($tg, $seen, $fa, $fb) = @_;
187 # no renames or space support for traditional diffs,
188 # find the number of leading common paths to strip:
189 my @fa = split('/', $fa);
190 my @fb = split('/', $fb);
191 while (scalar(@fa) && scalar(@fb)) {
192 $fa = join('/', @fa);
193 $fb = join('/', @fb);
195 index_text_inc($tg, $fa,'XDFN') unless $seen->{$fa}++;
204 sub index_diff ($$$) {
205 my ($tg, $lines, $doc) = @_;
209 if ($in_diff && s/^ //) { # diff context
210 index_text_inc($tg, $_, 'XDFCTX');
211 } elsif (/^-- $/) { # email signature begins
213 } elsif (m!^diff --git ("?a/.+) ("?b/.+)\z!) {
214 my ($fa, $fb) = ($1, $2);
215 my $fn = (split('/', git_unquote($fa), 2))[1];
216 index_text_inc($tg, $fn, 'XDFN') unless $seen{$fn}++;
217 $fn = (split('/', git_unquote($fb), 2))[1];
218 index_text_inc($tg, $fn, 'XDFN') unless $seen{$fn}++;
221 } elsif (m/^diff -(.+) (\S+) (\S+)$/) {
222 my ($opt, $fa, $fb) = ($1, $2, $3);
223 # only support unified:
224 next unless $opt =~ /[uU]/;
225 $in_diff = index_old_diff_fn($tg, \%seen, $fa, $fb);
226 } elsif (m!^--- ("?a/.+)!) {
227 my $fn = (split('/', git_unquote($1), 2))[1];
228 index_text_inc($tg, $fn, 'XDFN') unless $seen{$fn}++;
230 } elsif (m!^\+\+\+ ("?b/.+)!) {
231 my $fn = (split('/', git_unquote($1), 2))[1];
232 index_text_inc($tg, $fn, 'XDFN') unless $seen{$fn}++;
234 } elsif (/^--- (\S+)/) {
236 } elsif (defined $in_diff && /^\+\+\+ (\S+)/) {
237 $in_diff = index_old_diff_fn($tg, \%seen, $in_diff, $1);
238 } elsif ($in_diff && s/^\+//) { # diff added
239 index_text_inc($tg, $_, 'XDFB');
240 } elsif ($in_diff && s/^-//) { # diff removed
241 index_text_inc($tg, $_, 'XDFA');
242 } elsif (m!^index ([a-f0-9]+)\.\.([a-f0-9]+)!) {
243 my ($ba, $bb) = ($1, $2);
244 index_git_blob_id($doc, 'XDFPRE', $ba);
245 index_git_blob_id($doc, 'XDFPOST', $bb);
247 } elsif (/^@@ (?:\S+) (?:\S+) @@\s*$/) {
248 # traditional diff w/o -p
249 } elsif (/^@@ (?:\S+) (?:\S+) @@\s*(\S+.*)$/) {
250 # hunk header context
251 index_text_inc($tg, $1, 'XDFHH');
252 # ignore the following lines:
253 } elsif (/^(?:dis)similarity index/) {
254 } elsif (/^(?:old|new) mode/) {
255 } elsif (/^(?:deleted|new) file mode/) {
256 } elsif (/^(?:copy|rename) (?:from|to) /) {
257 } elsif (/^(?:dis)?similarity index /) {
258 } elsif (/^\\ No newline at end of file/) {
259 } elsif (/^Binary files .* differ/) {
263 warn "non-diff line: $_\n" if DEBUG && $_ ne '';
269 sub index_body ($$$) {
270 my ($tg, $lines, $doc) = @_;
271 my $txt = join("\n", @$lines);
272 $tg->index_text($txt, !!$doc, $doc ? 'XNQ' : 'XQUOT');
273 $tg->increase_termpos;
274 # does it look like a diff?
275 if ($doc && $txt =~ /^(?:diff|---|\+\+\+) /ms) {
277 index_diff($tg, $lines, $doc);
283 my ($self, $mime, $bytes, $num, $blob) = @_; # mime = Email::MIME object
284 my $db = $self->{xdb};
286 my ($doc_id, $old_tid);
287 my $mid = mid_clean(mid_mime($mime));
288 my $skel = $self->{skeleton};
291 die 'Message-ID too long' if length($mid) > MAX_MID_SIZE;
292 my $smsg = $self->lookup_message($mid);
294 # convert a ghost to a regular message
295 # it will also clobber any existing regular message
296 $doc_id = $smsg->{doc_id};
297 $old_tid = $smsg->thread_id unless $skel;
299 $smsg = PublicInbox::SearchMsg->new($mime);
300 my $doc = $smsg->{doc};
301 $doc->add_term('XMID' . $mid);
303 my $subj = $smsg->subject;
306 $xpath = $self->subject_path($subj);
307 $xpath = id_compress($xpath);
308 $doc->add_term('XPATH' . $xpath);
311 my $lines = $mime->body_raw =~ tr!\n!\n!;
312 my @values = ($smsg->ts, $num, $bytes, $lines);
313 add_values($doc, \@values);
315 my $tg = $self->term_generator;
317 $tg->set_document($doc);
318 $tg->index_text($subj, 1, 'S') if $subj;
319 $tg->increase_termpos;
321 index_users($tg, $smsg);
323 msg_iter($mime, sub {
324 my ($part, $depth, @idx) = @{$_[0]};
325 my $ct = $part->content_type || 'text/plain';
326 my $fn = $part->filename;
327 if (defined $fn && $fn ne '') {
328 $tg->index_text($fn, 1, 'XFN');
331 return if $ct =~ m!\btext/x?html\b!i;
333 my $s = eval { $part->body_str };
335 if ($ct =~ m!\btext/plain\b!i) {
336 # Try to assume UTF-8 because Alpine
337 # seems to do wacky things and set
339 $part->charset_set('UTF-8');
340 $s = eval { $part->body_str };
341 $s = $part->body if $@;
344 defined $s or return;
347 my $body = $part->body;
348 my @lines = split(/\n/, $body);
349 while (defined(my $l = shift @lines)) {
351 index_body($tg, \@orig, $doc) if @orig;
354 index_body($tg, \@quot, 0) if @quot;
358 index_body($tg, \@quot, 0) if @quot;
359 index_body($tg, \@orig, $doc) if @orig;
362 # populates smsg->references for smsg->to_doc_data
363 my $refs = parse_references($smsg);
364 my $data = $smsg->to_doc_data($blob);
366 push @values, $mid, $xpath, $data;
367 $skel->index_skeleton(\@values);
369 link_message($self, $smsg, $refs, $old_tid);
371 $tg->index_text($mid, 1, 'XM');
372 $doc->set_data($data);
374 if (my $altid = $self->{-altid}) {
375 foreach my $alt (@$altid) {
376 my $id = $alt->mid2alt($mid);
377 next unless defined $id;
378 $doc->add_term($alt->{xprefix} . $id);
381 if (defined $doc_id) {
382 $db->replace_document($doc_id, $doc);
384 $doc_id = $db->add_document($doc);
389 warn "failed to index message <$mid>: $@\n";
395 # returns deleted doc_id on success, undef on missing
397 my ($self, $mid) = @_;
398 my $db = $self->{xdb};
400 $mid = mid_clean($mid);
403 my ($head, $tail) = $self->find_doc_ids('XMID' . $mid);
404 if ($head->equal($tail)) {
405 warn "cannot remove non-existent <$mid>\n";
407 for (; $head != $tail; $head->inc) {
408 my $docid = $head->get_docid;
409 $db->delete_document($docid);
414 warn "failed to remove message <$mid>: $@\n";
420 sub term_generator { # write-only
423 my $tg = $self->{term_generator};
426 $tg = Search::Xapian::TermGenerator->new;
427 $tg->set_stemmer($self->stemmer);
429 $self->{term_generator} = $tg;
432 # increments last_thread_id counter
433 # returns a 64-bit integer represented as a decimal string
436 my $db = $self->{xdb};
437 my $last_thread_id = int($db->get_metadata('last_thread_id') || 0);
439 $db->set_metadata('last_thread_id', ++$last_thread_id);
444 sub parse_references ($) {
446 my $doc = $smsg->{doc};
447 my $mid = $smsg->mid;
448 my $mime = $smsg->{mime};
449 my $hdr = $mime->header_obj;
451 # last References should be IRT, but some mail clients do things
452 # out of order, so trust IRT over References iff IRT exists
453 my @refs = (($hdr->header_raw('References') || '') =~ /<([^>]+)>/g);
454 push(@refs, (($hdr->header_raw('In-Reply-To') || '') =~ /<([^>]+)>/g));
457 my %uniq = ($mid => 1);
458 my @orig_refs = @refs;
461 # prevent circular references via References: here:
462 foreach my $ref (@orig_refs) {
463 if (length($ref) > MAX_MID_SIZE) {
464 warn "References: <$ref> too long, ignoring\n";
471 $smsg->{references} = '<'.join('> <', @refs).'>' if @refs;
476 my ($self, $smsg, $refs, $old_tid) = @_;
481 # first ref *should* be the thread root,
482 # but we can never trust clients to do the right thing
483 my $ref = shift @$refs;
484 $tid = $self->_resolve_mid_to_tid($ref);
485 $self->merge_threads($tid, $old_tid) if defined $old_tid;
487 # the rest of the refs should point to this tid:
488 foreach $ref (@$refs) {
489 my $ptid = $self->_resolve_mid_to_tid($ref);
490 merge_threads($self, $tid, $ptid);
493 $tid = defined $old_tid ? $old_tid : $self->next_thread_id;
495 $smsg->{doc}->add_term('G' . $tid);
498 sub index_git_blob_id {
499 my ($doc, $pfx, $objid) = @_;
501 my $len = length($objid);
502 for (my $len = length($objid); $len >= 7; ) {
503 $doc->add_term($pfx.$objid);
504 $objid = substr($objid, 0, --$len);
509 my ($self, $mime) = @_;
510 my $mid = eval { mid_clean(mid_mime($mime)) };
511 $self->remove_message($mid) if defined $mid;
515 my ($self, $mime, $warn_existing) = @_;
516 my $mid = mid_clean(mid_mime($mime));
517 my $mm = $self->{mm};
518 my $num = $mm->mid_insert($mid);
519 return $num if defined $num;
521 warn "<$mid> reused\n" if $warn_existing;
522 # fallback to num_for since filters like RubyLang set the number
527 my ($self, $mime) = @_;
528 $self->{mm}->mid_delete(mid_clean(mid_mime($mime)));
532 my ($self, $mime, $bytes, $blob) = @_;
533 my $num = $self->{mm}->num_for(mid_clean(mid_mime($mime)));
534 add_message($self, $mime, $bytes, $num, $blob);
538 my ($self, $mime) = @_;
539 $self->{mm}->mid_delete(mid_clean(mid_mime($mime)));
540 unindex_blob($self, $mime);
544 my ($self, $mime, $bytes, $blob) = @_;
545 my $num = index_mm($self, $mime);
546 add_message($self, $mime, $bytes, $num, $blob);
550 my ($self, $mime) = @_;
551 unindex_blob($self, $mime);
552 unindex_mm($self, $mime);
556 my ($git, $blob, $sizeref) = @_;
558 my $str = $git->cat_file($blob, $sizeref);
559 # fixup bugs from import:
560 $$str =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
561 PublicInbox::MIME->new($str);
567 my ($self, $opts) = @_;
568 with_umask($self, sub { $self->_index_sync($opts) });
571 sub batch_adjust ($$$$) {
572 my ($max, $bytes, $batch_cb, $latest) = @_;
576 $batch_cb->($latest, 1);
582 my ($self, $log, $add_cb, $del_cb, $batch_cb) = @_;
583 my $hex = '[a-f0-9]';
584 my $h40 = $hex .'{40}';
585 my $addmsg = qr!^:000000 100644 \S+ ($h40) A\t${hex}{2}/${hex}{38}$!;
586 my $delmsg = qr!^:100644 000000 ($h40) \S+ D\t${hex}{2}/${hex}{38}$!;
587 my $git = $self->{git};
590 my $max = BATCH_BYTES;
593 while (defined($line = <$log>)) {
594 if ($line =~ /$addmsg/o) {
596 my $mime = do_cat_mail($git, $blob, \$bytes) or next;
597 batch_adjust(\$max, $bytes, $batch_cb, $latest);
598 $add_cb->($self, $mime, $bytes, $blob);
599 } elsif ($line =~ /$delmsg/o) {
601 my $mime = do_cat_mail($git, $blob, \$bytes) or next;
602 batch_adjust(\$max, $bytes, $batch_cb, $latest);
603 $del_cb->($self, $mime);
604 } elsif ($line =~ /^commit ($h40)/o) {
608 $batch_cb->($latest, 0);
613 $self->{mm} ||= eval {
614 require PublicInbox::Msgmap;
615 my $msgmap_path = $self->{msgmap_path};
616 if (defined $msgmap_path) { # v2
617 PublicInbox::Msgmap->new_file($msgmap_path, 1);
619 PublicInbox::Msgmap->new($self->{mainrepo}, 1);
625 my ($self, $range) = @_;
626 $self->{git}->popen(qw/log --reverse --no-notes --no-color
627 --raw -r --no-abbrev/, $range);
630 # indexes all unindexed messages
632 my ($self, $opts) = @_;
633 my $tip = $opts->{ref} || 'HEAD';
634 my $reindex = $opts->{reindex};
635 my ($mkey, $last_commit, $lx, $xlog);
636 $self->{git}->batch_prepare;
637 my $xdb = _xdb_acquire($self);
638 $xdb->begin_transaction;
641 $mkey = 'last_commit';
642 $last_commit = $xdb->get_metadata('last_commit');
646 $mkey = undef if $last_commit ne '';
648 $xdb->cancel_transaction;
649 $xdb = _xdb_release($self);
651 # ensure we leak no FDs to "git log"
652 my $range = $lx eq '' ? $tip : "$lx..$tip";
653 $xlog = _git_log($self, $range);
655 $xdb = _xdb_acquire($self);
656 $xdb->begin_transaction;
657 } while ($xdb->get_metadata('last_commit') ne $last_commit);
659 my $mm = _msgmap_init($self);
660 my $dbh = $mm->{dbh} if $mm;
663 my ($commit, $more) = @_;
665 $mm->last_commit($commit) if $commit;
669 $xdb->set_metadata($mkey, $commit) if $mkey && $commit;
670 $xdb->commit_transaction;
671 $xdb = _xdb_release($self);
673 # let another process do some work... <
676 $xdb = _xdb_acquire($self);
677 $xdb->begin_transaction;
679 $dbh->begin_work if $dbh;
685 my $lm = $mm->last_commit || '';
687 # Common case is the indexes are synced,
688 # we only need to run git-log once:
689 rlog($self, $xlog, *index_both, *unindex_both, $cb);
691 # Uncommon case, msgmap and xapian are out-of-sync
692 # do not care for performance (but git is fast :>)
693 # This happens if we have to reindex Xapian since
694 # msgmap is a frozen format and our Xapian format
696 my $r = $lm eq '' ? $tip : "$lm..$tip";
698 # first, ensure msgmap is up-to-date:
699 my $mkey_prev = $mkey;
700 $mkey = undef; # ignore xapian, for now
701 my $mlog = _git_log($self, $r);
703 rlog($self, $mlog, *index_mm, *unindex_mm, $cb);
704 $mm_only = $mlog = undef;
706 # now deal with Xapian
709 rlog($self, $xlog, *index_mm2, *unindex_mm2, $cb);
712 # user didn't install DBD::SQLite and DBI
713 rlog($self, $xlog, *add_message, *unindex_blob, $cb);
717 # this will create a ghost as necessary
718 sub _resolve_mid_to_tid {
719 my ($self, $mid) = @_;
721 my $smsg = $self->lookup_message($mid) || $self->create_ghost($mid);
726 my ($self, $mid) = @_;
728 my $tid = $self->next_thread_id;
729 my $doc = Search::Xapian::Document->new;
730 $doc->add_term('XMID' . $mid);
731 $doc->add_term('G' . $tid);
732 $doc->add_term('T' . 'ghost');
734 my $smsg = PublicInbox::SearchMsg->wrap($doc, $mid);
735 $self->{xdb}->add_document($doc);
741 my ($self, $winner_tid, $loser_tid) = @_;
742 return if $winner_tid == $loser_tid;
743 my $db = $self->{xdb};
745 my $batch_size = 1000; # don't let @ids grow too large to avoid OOM
747 my ($head, $tail) = $self->find_doc_ids('G' . $loser_tid);
748 return if $head == $tail;
750 for (; $head != $tail && @ids < $batch_size; $head->inc) {
751 push @ids, $head->get_docid;
753 foreach my $docid (@ids) {
754 my $doc = $db->get_document($docid);
755 $doc->remove_term('G' . $loser_tid);
756 $doc->add_term('G' . $winner_tid);
757 $db->replace_document($docid, $doc);
762 sub _read_git_config_perm {
764 my @cmd = qw(config);
765 if ($self->{version} == 2) {
766 push @cmd, "--file=$self->{mainrepo}/inbox-config";
768 my $fh = $self->{git}->popen(@cmd, 'core.sharedRepository');
771 chomp $perm if defined $perm;
775 sub _git_config_perm {
777 my $perm = scalar @_ ? $_[0] : _read_git_config_perm($self);
778 return PERM_GROUP if (!defined($perm) || $perm eq '');
779 return PERM_UMASK if ($perm eq 'umask');
780 return PERM_GROUP if ($perm eq 'group');
781 if ($perm =~ /\A(?:all|world|everybody)\z/) {
782 return PERM_EVERYBODY;
784 return PERM_GROUP if ($perm =~ /\A(?:true|yes|on|1)\z/);
785 return PERM_UMASK if ($perm =~ /\A(?:false|no|off|0)\z/);
788 return PERM_UMASK if ($i == PERM_UMASK);
789 return PERM_GROUP if ($i == OLD_PERM_GROUP);
790 return PERM_EVERYBODY if ($i == OLD_PERM_EVERYBODY);
792 if (($i & 0600) != 0600) {
793 die "core.sharedRepository mode invalid: ".
794 sprintf('%.3o', $i) . "\nOwner must have permissions\n";
800 my ($perm) = @_; # _git_config_perm return value
802 return umask if $rv == 0;
804 # set +x bit if +r or +w were set
805 $rv |= 0100 if ($rv & 0600);
806 $rv |= 0010 if ($rv & 0060);
807 $rv |= 0001 if ($rv & 0006);
812 my ($self, $cb) = @_;
813 my $old = umask $self->{umask};
814 my $rv = eval { $cb->() };
822 # order matters for unlocking
823 $_[0]->{xdb} = undef;
824 $_[0]->{lockfh} = undef;
827 # remote_* subs are only used by SearchIdxPart and SearchIdxSkeleton
830 print { $self->{w} } "commit\n" or die "failed to write commit: $!";
835 my $pid = delete $self->{pid} or die "no process to wait on\n";
836 my $w = delete $self->{w} or die "no pipe to write to\n";
837 print $w "close\n" or die "failed to write to pid:$pid: $!\n";
838 close $w or die "failed to close pipe for pid:$pid: $!\n";
839 waitpid($pid, 0) == $pid or die "remote process did not finish";
840 $? == 0 or die ref($self)." exited with: $?";