1 # Copyright (C) 2015-2021 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 # Read-only search interface for use by the web and NNTP interfaces
6 package PublicInbox::Search;
8 use parent qw(Exporter);
9 our @EXPORT_OK = qw(retry_reopen int_val get_pct xap_terms);
10 use List::Util qw(max);
11 use POSIX qw(strftime);
14 # values for searching, changing the numeric value breaks
15 # compatibility with old indices (so don't change them it)
17 TS => 0, # Received: in Unix time (IMAP INTERNALDATE, JMAP receivedAt)
18 YYYYMMDD => 1, # Date: header for searching in the WWW UI
19 DT => 2, # Date: YYYYMMDDHHMMSS (IMAP SENT*, JMAP sentAt)
21 # added for public-inbox 1.6.0+
22 BYTES => 3, # IMAP RFC822.SIZE
23 UID => 4, # IMAP UID == NNTP article number == Xapian docid
24 THREADID => 5, # RFC 8474, RFC 8621
27 # REPLYCNT => ?, # IMAP ANSWERED
29 # SCHEMA_VERSION history
31 # 1 - subject_path is lower-cased
32 # 2 - subject_path is id_compress in the index, only
33 # 3 - message-ID is compressed if it includes '%' (hack!)
34 # 4 - change "Re: " normalization, avoid circular Reference ghosts
35 # 5 - subject_path drops trailing '.'
36 # 6 - preserve References: order in document data
37 # 7 - remove references and inreplyto terms
38 # 8 - remove redundant/unneeded document data
39 # 9 - disable Message-ID compression (SHA-1)
40 # 10 - optimize doc for NNTP overviews
41 # 11 - merge threads when vivifying ghosts
42 # 12 - change YYYYMMDD value column to numeric
43 # 13 - fix threading for empty References/In-Reply-To
44 # (commit 83425ef12e4b65cdcecd11ddcb38175d4a91d5a0)
45 # 14 - fix ghost root vivification
46 # 15 - see public-inbox-v2-format(5)
47 # further bumps likely unnecessary, we'll suggest in-place
48 # "--reindex" use for further fixes and tweaks:
50 # public-inbox v1.5.0 adds (still SCHEMA_VERSION=15):
51 # * "lid:" and "l:" for List-Id searches
53 # v1.6.0 adds BYTES, UID and THREADID values
57 use PublicInbox::Smsg;
58 use PublicInbox::Over;
60 our %X = map { $_ => 0 } qw(BoolWeight Database Enquire QueryParser Stem Query);
61 our $Xap; # 'Search::Xapian' or 'Xapian'
62 our $NVRP; # '$Xap::'.('NumberValueRangeProcessor' or 'NumberRangeProcessor')
64 # ENQ_DESCENDING and ENQ_ASCENDING weren't in SWIG Xapian.pm prior to 1.4.16,
65 # let's hope the ABI is stable
66 our $ENQ_DESCENDING = 0;
67 our $ENQ_ASCENDING = 1;
70 return 1 if defined $Xap;
71 # n.b. PI_XAPIAN is intended for development use only. We still
72 # favor Search::Xapian since that's what's available in current
73 # Debian stable (10.x) and derived distros.
74 for my $x (($ENV{PI_XAPIAN} // 'Search::Xapian'), 'Xapian') {
78 $x->import(qw(:standard));
81 # `version_string' was added in Xapian 1.1
82 my $xver = eval('v'.eval($x.'::version_string()')) //
83 eval('v'.eval($x.'::xapian_version_string()'));
85 # NumberRangeProcessor was added in Xapian 1.3.6,
86 # NumberValueRangeProcessor was removed for 1.5.0+,
87 # favor the older /Value/ variant since that's what our
88 # (currently) preferred Search::Xapian supports
89 $NVRP = $x.'::'.($x eq 'Xapian' && $xver ge v1.5 ?
90 'NumberRangeProcessor' : 'NumberValueRangeProcessor');
91 $X{$_} = $Xap.'::'.$_ for (keys %X);
93 *sortable_serialise = $x.'::sortable_serialise';
94 *sortable_unserialise = $x.'::sortable_unserialise';
95 # n.b. FLAG_PURE_NOT is expensive not suitable for a public
96 # website as it could become a denial-of-service vector
97 # FLAG_PHRASE also seems to cause performance problems chert
98 # (and probably earlier Xapian DBs). glass seems fine...
99 # TODO: make this an option, maybe?
100 # or make indexlevel=medium as default
101 $QP_FLAGS = FLAG_PHRASE() | FLAG_BOOLEAN() | FLAG_LOVEHATE() |
108 # This is English-only, everything else is non-standard and may be confused as
109 # a prefix common in patch emails
110 our $LANG = 'english';
112 # note: the non-X term prefix allocations are shared with
113 # Xapian omega, see xapian-applications/omega/docs/termprefixes.rst
114 my %bool_pfx_external = (
115 mid => 'Q', # Message-ID (full/exact), this is mostly uniQue
116 lid => 'G', # newsGroup (or similar entity), just inside <>
119 dfblob => 'XDFPRE XDFPOST',
122 my $non_quoted_body = 'XNQ XDFN XDFA XDFB XDFHH XDFCTX XDFPRE XDFPOST';
124 # for mairix compatibility
126 m => 'XM', # 'mid:' (bool) is exact, 'm:' (prob) can do partial
127 l => 'XL', # 'lid:' (bool) is exact, 'l:' (prob) can do partial
134 b => $non_quoted_body . ' XQUOT',
135 bs => $non_quoted_body . ' XQUOT S',
139 nq => $non_quoted_body,
147 '' => 'XM S A XQUOT XFN ' . $non_quoted_body,
150 # not documenting m: and mid: for now, the using the URLs works w/o Xapian
151 # not documenting lid: for now, either, it is probably redundant with l:,
152 # especially since we don't offer boolean searches for To/Cc/From
155 's:' => 'match within Subject e.g. s:"a quick brown fox"',
157 date range as YYYYMMDD e.g. d:19931002..20101002
158 Open-ended ranges such as d:19931002.. and d:..20101002
162 date-time range as YYYYMMDDhhmmss (e.g. dt:19931002011000..19931002011200)
164 'b:' => 'match within message body, including text attachments',
165 'nq:' => 'match non-quoted text within message body',
166 'q:' => 'match quoted text within message body',
167 'n:' => 'match filename of attachment(s)',
168 't:' => 'match within the To header',
169 'c:' => 'match within the Cc header',
170 'f:' => 'match within the From header',
171 'a:' => 'match within the To, Cc, and From headers',
172 'tc:' => 'match within the To and Cc headers',
173 'l:' => 'match contents of the List-Id header',
174 'bs:' => 'match within the Subject and body',
175 'dfn:' => 'match filename from diff',
176 'dfa:' => 'match diff removed (-) lines',
177 'dfb:' => 'match diff added (+) lines',
178 'dfhh:' => 'match diff hunk header context (usually a function name)',
179 'dfctx:' => 'match diff context lines',
180 'dfpre:' => 'match pre-image git blob ID',
181 'dfpost:' => 'match post-image git blob ID',
182 'dfblob:' => 'match either pre or post-image git blob ID',
187 my ($self, $rdonly) = @_;
188 if ($rdonly || !defined($self->{shard})) {
190 } else { # v2 + extindex only:
191 "$self->{xpfx}/$self->{shard}";
195 # returns all shards as separate Xapian::Database objects w/o combining
196 sub xdb_shards_flat ($) {
198 my $xpfx = $self->{xpfx};
199 my (@xdb, $slow_phrase);
201 $self->{qp_flags} //= $QP_FLAGS;
202 if ($xpfx =~ m!/xapian[0-9]+\z!) {
203 @xdb = ($X{Database}->new($xpfx));
204 $self->{qp_flags} |= FLAG_PHRASE() if !-f "$xpfx/iamchert";
206 opendir(my $dh, $xpfx) or return (); # not initialized yet
207 # We need numeric sorting so shard[0] is first for reading
208 # Xapian metadata, if needed
209 my $last = max(grep(/\A[0-9]+\z/, readdir($dh))) // return ();
211 my $shard_dir = "$self->{xpfx}/$_";
212 push @xdb, $X{Database}->new($shard_dir);
213 $slow_phrase ||= -f "$shard_dir/iamchert";
215 $self->{qp_flags} |= FLAG_PHRASE() if !$slow_phrase;
220 # v2 Xapian docids don't conflict, so they're identical to
221 # NNTP article numbers and IMAP UIDs.
222 # https://trac.xapian.org/wiki/FAQ/MultiDatabaseDocumentID
224 my ($nshard, $mitem) = @_;
225 my $docid = $mitem->get_docid;
226 int(($docid - 1) / $nshard) + 1;
229 sub mset_to_artnums {
230 my ($self, $mset) = @_;
231 my $nshard = $self->{nshard};
232 [ map { mdocid($nshard, $_) } $mset->items ];
238 my @xdb = $self->xdb_shards_flat or return;
239 $self->{nshard} = scalar(@xdb);
240 my $xdb = shift @xdb;
241 $xdb->add_database($_) for @xdb;
247 my ($class, $ibx) = @_;
248 ref $ibx or die "BUG: expected PublicInbox::Inbox object: $ibx";
249 my $xap = $ibx->version > 1 ? 'xap' : 'public-inbox/xapian';
250 my $xpfx = "$ibx->{inboxdir}/$xap".SCHEMA_VERSION;
251 my $self = bless { xpfx => $xpfx }, $class;
252 $self->{altid} = $ibx->{altid} if defined($ibx->{altid});
258 if (my $xdb = $self->{xdb}) {
261 $self; # make chaining easier
264 # Convert git "approxidate" ranges to something usable with our
265 # Xapian indices. At the moment, Xapian only offers a C++-only API
266 # and neither the SWIG nor XS bindings allow us to use custom code
267 # to parse dates (and libgit2 doesn't expose git__date_parse, either,
268 # so we're running git-rev-parse(1)).
269 # This replaces things we need to send to $git->date_parse with
270 # "\0".$strftime_format.['+'|$idx]."\0" placeholders
271 sub date_parse_prepare {
272 my ($to_parse, $pfx, $range) = @_;
273 # are we inside a parenthesized statement?
274 my $end = $range =~ s/([\)\s]*)\z// ? $1 : '';
275 my @r = split(/\.\./, $range, 2);
277 # expand "d:20101002" => "d:20101002..20101003" and like
278 # n.b. git doesn't do YYYYMMDD w/o '-', it needs YYYY-MM-DD
279 # We upgrade "d:" to "dt:" to iff using approxidate
281 my $fmt = "\0%Y%m%d";
282 if (!defined($r[1])) {
283 if ($r[0] =~ /\A([0-9]{4})([0-9]{2})([0-9]{2})\z/) {
284 push @$to_parse, "$1-$2-$3";
285 # we could've handled as-is, but we need
286 # to parse anyways for "d+" below
288 push @$to_parse, $r[0];
289 if ($r[0] !~ /\A[0-9]{4}-[0-9]{2}-[0-9]{2}\z/) {
291 $fmt = "\0%Y%m%d%H%M%S";
294 $r[0] = "$fmt+$#$to_parse\0";
298 next if $x eq '' || $x =~ /\A[0-9]{8}\z/;
300 if ($x !~ /\A[0-9]{4}-[0-9]{2}-[0-9]{2}\z/) {
303 $x = "$fmt$#$to_parse\0";
307 s/\0%Y%m%d/\0%Y%m%d%H%M%S/;
308 s/\A([0-9]{8})\z/${1}000000/;
312 } elsif ($pfx eq 'dt') {
313 if (!defined($r[1])) { # git needs gaps and not /\d{14}/
314 if ($r[0] =~ /\A([0-9]{4})([0-9]{2})([0-9]{2})
315 ([0-9]{2})([0-9]{2})([0-9]{2})\z/x) {
316 push @$to_parse, "$1-$2-$3 $4:$5:$6";
318 push @$to_parse, $r[0];
320 $r[0] = "\0%Y%m%d%H%M%S$#$to_parse\0";
321 $r[1] = "\0%Y%m%d%H%M%S+\0";
324 next if $x eq '' || $x =~ /\A[0-9]{14}\z/;
326 $x = "\0%Y%m%d%H%M%S$#$to_parse\0";
329 } else { # "rt", let git interpret "YYYY", deal with Y10K later :P
331 next if $x eq '' || $x =~ /\A[0-9]{5,}\z/;
333 $x = "\0%s$#$to_parse\0";
335 $r[1] //= "\0%s+\0"; # add 1 day
337 "$pfx:".join('..', @r).$end;
340 sub date_parse_finalize {
341 my ($git, $to_parse) = @_;
342 # git-rev-parse can handle any number of args up to system
343 # limits (around (4096*32) bytes on Linux).
344 my @r = $git->date_parse(@$to_parse);
345 # n.b. git respects TZ, times stored in SQLite/Xapian are always UTC,
346 # and gmtime doesn't seem to do the right thing when TZ!=UTC
348 $_[2] =~ s/\0(%[%YmdHMSs]+)([0-9\+]+)\0/
349 $t = $2 eq '+' ? ($r[$i]+86400) : $r[$i=$2+0];
350 $1 eq '%s' ? $t : strftime($1, gmtime($t))/sge;
353 # n.b. argv never has NUL, though we'll need to filter it out
354 # if this $argv isn't from a command execution
355 sub query_argv_to_string {
356 my (undef, $git, $argv) = @_;
358 my $tmp = join(' ', map {;
359 if (s!\b(d|rt|dt):(\S+)\z!date_parse_prepare(
360 $to_parse //= [], $1, $2)!sge) {
363 s/(.*?)\b(\w+:)// ? qq{$1$2"$_"} : qq{"$_"};
368 date_parse_finalize($git, $to_parse, $tmp) if $to_parse;
372 # this is for the WWW "q=" query parameter and "lei q --stdin"
373 # it can't do d:"5 days ago", but it will do d:5.days.ago
374 sub query_approxidate {
375 my (undef, $git) = @_; # $_[2] = $query_string (modified in-place)
376 my $DQ = qq<"\x{201c}\x{201d}>; # Xapian can use curly quotes
377 $_[2] =~ tr/\x00/ /; # Xapian doesn't do NUL, we use it as a placeholder
378 my ($terms, $phrase, $to_parse);
379 $_[2] =~ s{([^$DQ]*)([$DQ][^$DQ]*[$DQ])?}{
380 ($terms, $phrase) = ($1, $2);
381 $terms =~ s!\b(d|rt|dt):(\S+)!
382 date_parse_prepare($to_parse //= [], $1, $2)!sge;
383 $terms.($phrase // '');
385 date_parse_finalize($git, $to_parse, $_[2]) if $to_parse;
390 my ($self, $query_string, $opts) = @_;
392 my $qp = $self->{qp} //= $self->qparse_new;
393 my $query = $qp->parse_query($query_string, $self->{qp_flags});
394 _do_enquire($self, $query, $opts);
398 my ($self, $cb, @arg) = @_;
402 eval { @ret = $cb->($self, @arg) };
403 return @ret unless $@;
406 eval { $ret = $cb->($self, @arg) };
407 return $ret unless $@;
409 # Exception: The revision being read has been discarded -
410 # you should call Xapian::Database::reopen()
411 if (ref($@) =~ /\bDatabaseModifiedError\b/) {
414 # let caller decide how to spew, because ExtMsg queries
415 # get wonky and trigger:
416 # "something terrible happened at .../Xapian/Enquire.pm"
420 Carp::croak("Too many Xapian database modifications in progress\n");
424 my ($self, $query, $opts) = @_;
425 retry_reopen($self, \&_enquire_once, $query, $opts);
428 # returns true if all docs have the THREADID value
429 sub has_threadid ($) {
431 (xdb($self)->get_metadata('has_threadid') // '') eq '1';
434 sub _enquire_once { # retry_reopen callback
435 my ($self, $query, $opts) = @_;
436 my $xdb = xdb($self);
437 if (defined(my $eidx_key = $opts->{eidx_key})) {
438 $query = $X{Query}->new(OP_FILTER(), $query, 'O'.$eidx_key);
440 if (defined(my $uid_range = $opts->{uid_range})) {
441 my $range = $X{Query}->new(OP_VALUE_RANGE(), UID,
442 sortable_serialise($uid_range->[0]),
443 sortable_serialise($uid_range->[1]));
444 $query = $X{Query}->new(OP_FILTER(), $query, $range);
446 my $enquire = $X{Enquire}->new($xdb);
447 $enquire->set_query($query);
449 my $rel = $opts->{relevance} // 0;
450 if ($rel == -2) { # ORDER BY docid/UID (highest first)
451 $enquire->set_weighting_scheme($X{BoolWeight}->new);
452 $enquire->set_docid_order($ENQ_DESCENDING);
453 } elsif ($rel == -1) { # ORDER BY docid/UID (lowest first)
454 $enquire->set_weighting_scheme($X{BoolWeight}->new);
455 $enquire->set_docid_order($ENQ_ASCENDING);
456 } elsif ($rel == 0) {
457 $enquire->set_sort_by_value_then_relevance(TS, !$opts->{asc});
459 $enquire->set_sort_by_relevance_then_value(TS, !$opts->{asc});
462 # `mairix -t / --threads' or JMAP collapseThreads
463 if ($opts->{threads} && has_threadid($self)) {
464 $enquire->set_collapse_key(THREADID);
466 $enquire->get_mset($opts->{offset} || 0, $opts->{limit} || 50);
470 my ($self, $ibx, $mset) = @_;
471 my $nshard = $self->{nshard};
473 my %order = map { mdocid($nshard, $_) => ++$i } $mset->items;
475 $order{$a->{num}} <=> $order{$b->{num}}
476 } @{$ibx->over->get_all(keys %order)};
477 wantarray ? ($mset->get_matches_estimated, \@msgs) : \@msgs;
481 sub stemmer { $X{Stem}->new($LANG) }
487 my $xdb = xdb($self);
488 my $qp = $X{QueryParser}->new;
489 $qp->set_default_op(OP_AND());
490 $qp->set_database($xdb);
491 $qp->set_stemmer(stemmer($self));
492 $qp->set_stemming_strategy(STEM_SOME());
493 my $cb = $qp->can('set_max_wildcard_expansion') //
494 $qp->can('set_max_expansion'); # Xapian 1.5.0+
496 $cb = $qp->can('add_valuerangeprocessor') //
497 $qp->can('add_rangeprocessor'); # Xapian 1.5.0+
498 $cb->($qp, $NVRP->new(YYYYMMDD, 'd:'));
499 $cb->($qp, $NVRP->new(DT, 'dt:'));
501 # for IMAP, undocumented for WWW and may be split off go away
502 $cb->($qp, $NVRP->new(BYTES, 'z:'));
503 $cb->($qp, $NVRP->new(TS, 'rt:'));
504 $cb->($qp, $NVRP->new(UID, 'uid:'));
506 while (my ($name, $prefix) = each %bool_pfx_external) {
507 $qp->add_boolean_prefix($name, $_) foreach split(/ /, $prefix);
510 # we do not actually create AltId objects,
511 # just parse the spec to avoid the extra DB handles for now.
512 if (my $altid = $self->{altid}) {
513 my $user_pfx = $self->{-user_pfx} = [];
515 # $_ = 'serial:gmane:/path/to/gmane.msgmap.sqlite3'
516 # note: Xapian supports multibyte UTF-8, /^[0-9]+$/,
517 # and '_' with prefixes matching \w+
518 /\Aserial:(\w+):/ or next;
520 push @$user_pfx, "$pfx:", <<EOF;
521 alternate serial number e.g. $pfx:12345 (boolean)
524 $qp->add_boolean_prefix($pfx, 'X'.uc($pfx));
529 while (my ($name, $prefix) = each %prob_prefix) {
530 $qp->add_prefix($name, $_) foreach split(/ /, $prefix);
537 $self->{qp} //= $self->qparse_new; # parse altids
539 if (my $user_pfx = $self->{-user_pfx}) {
540 push @ret, @$user_pfx;
546 my ($doc, $col) = @_;
547 my $val = $doc->get_value($col) or return; # undefined is '' in Xapian
548 sortable_unserialise($val) + 0; # PV => IV conversion
551 sub get_pct ($) { # mset item
552 # Capped at "99%" since "100%" takes an extra column in the
553 # thread skeleton view. <xapian/mset.h> says the value isn't
554 # very meaningful, anyways.
555 my $n = $_[0]->get_percent;
559 sub xap_terms ($$;@) {
560 my ($pfx, $xdb_or_doc, @docid) = @_; # @docid may be empty ()
562 my $end = $xdb_or_doc->termlist_end(@docid);
563 my $cur = $xdb_or_doc->termlist_begin(@docid);
564 for (; $cur != $end; $cur++) {
566 last if $cur == $end;
567 my $tn = $cur->get_termname;
568 $ret{substr($tn, length($pfx))} = undef if !index($tn, $pfx);
570 wantarray ? sort(keys(%ret)) : \%ret;