X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FSearch.pm;h=209969c57c94b6a1d515d60c33e08a079da4f6f5;hb=2958cd17d58c79c952afae6cfd594595ffcaf4fa;hp=bbc5e32fca980a810f47983d02c3c4873e13998b;hpb=ba135f3e25bf5d1b3aa3d34e31fefb55ee4c8d29;p=public-inbox.git diff --git a/lib/PublicInbox/Search.pm b/lib/PublicInbox/Search.pm index bbc5e32f..209969c5 100644 --- a/lib/PublicInbox/Search.pm +++ b/lib/PublicInbox/Search.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2015-2020 all contributors +# Copyright (C) 2015-2021 all contributors # License: AGPL-3.0+ # based on notmuch, but with no concept of folders, files or flags # @@ -6,8 +6,9 @@ package PublicInbox::Search; use strict; use parent qw(Exporter); -our @EXPORT_OK = qw(retry_reopen); +our @EXPORT_OK = qw(retry_reopen int_val get_pct xap_terms); use List::Util qw(max); +use POSIX qw(strftime); # values for searching, changing the numeric value breaks # compatibility with old indices (so don't change them it) @@ -58,7 +59,11 @@ our $QP_FLAGS; our %X = map { $_ => 0 } qw(BoolWeight Database Enquire QueryParser Stem Query); our $Xap; # 'Search::Xapian' or 'Xapian' our $NVRP; # '$Xap::'.('NumberValueRangeProcessor' or 'NumberRangeProcessor') -our $ENQ_ASCENDING; + +# ENQ_DESCENDING and ENQ_ASCENDING weren't in SWIG Xapian.pm prior to 1.4.16, +# let's hope the ABI is stable +our $ENQ_DESCENDING = 0; +our $ENQ_ASCENDING = 1; sub load_xapian () { return 1 if defined $Xap; @@ -84,13 +89,8 @@ sub load_xapian () { 'NumberRangeProcessor' : 'NumberValueRangeProcessor'); $X{$_} = $Xap.'::'.$_ for (keys %X); - # ENQ_ASCENDING doesn't seem exported by SWIG Xapian.pm, - # so lets hope this part of the ABI is stable because it's - # just an integer: - $ENQ_ASCENDING = $x eq 'Xapian' ? - 1 : Search::Xapian::ENQ_ASCENDING(); - *sortable_serialise = $x.'::sortable_serialise'; + *sortable_unserialise = $x.'::sortable_unserialise'; # n.b. FLAG_PURE_NOT is expensive not suitable for a public # website as it could become a denial-of-service vector # FLAG_PHRASE also seems to cause performance problems chert @@ -196,6 +196,8 @@ sub xdb_shards_flat ($) { my ($self) = @_; my $xpfx = $self->{xpfx}; my (@xdb, $slow_phrase); + load_xapian(); + $self->{qp_flags} //= $QP_FLAGS; if ($xpfx =~ m/xapian${\SCHEMA_VERSION}\z/) { @xdb = ($X{Database}->new($xpfx)); $self->{qp_flags} |= FLAG_PHRASE() if !-f "$xpfx/iamchert"; @@ -214,16 +216,6 @@ sub xdb_shards_flat ($) { @xdb; } -sub _xdb { - my ($self) = @_; - $self->{qp_flags} //= $QP_FLAGS; - my @xdb = xdb_shards_flat($self) or return; - $self->{nshard} = scalar(@xdb); - my $xdb = shift @xdb; - $xdb->add_database($_) for @xdb; - $xdb; -} - # v2 Xapian docids don't conflict, so they're identical to # NNTP article numbers and IMAP UIDs. # https://trac.xapian.org/wiki/FAQ/MultiDatabaseDocumentID @@ -242,8 +234,11 @@ sub mset_to_artnums { sub xdb ($) { my ($self) = @_; $self->{xdb} //= do { - load_xapian(); - $self->_xdb; + my @xdb = $self->xdb_shards_flat or return; + $self->{nshard} = scalar(@xdb); + my $xdb = shift @xdb; + $xdb->add_database($_) for @xdb; + $xdb; }; } @@ -265,13 +260,118 @@ sub reopen { $self; # make chaining easier } +# Convert git "approxidate" ranges to something usable with our +# Xapian indices. At the moment, Xapian only offers a C++-only API +# and neither the SWIG nor XS bindings allow us to use custom code +# to parse dates (and libgit2 doesn't expose git__date_parse, either, +# so we're running git-rev-parse(1)). +# This replaces things we need to send to $git->date_parse with +# "\0".$strftime_format.['+'|$idx]."\0" placeholders +sub date_parse_prepare { + my ($to_parse, $pfx, $range) = @_; + # are we inside a parenthesized statement? + my $end = $range =~ s/([\)\s]*)\z// ? $1 : ''; + my @r = split(/\.\./, $range, 2); + + # expand "d:20101002" => "d:20101002..20101003" and like + # n.b. git doesn't do YYYYMMDD w/o '-', it needs YYYY-MM-DD + if ($pfx eq 'd') { + if (!defined($r[1])) { + if ($r[0] =~ /\A([0-9]{4})([0-9]{2})([0-9]{2})\z/) { + push @$to_parse, "$1-$2-$3"; + # we could've handled as-is, but we need + # to parse anyways for "d+" below + } else { + push @$to_parse, $r[0]; + } + $r[0] = "\0%Y%m%d$#$to_parse\0"; + $r[1] = "\0%Y%m%d+\0"; + } else { + for my $x (@r) { + next if $x eq '' || $x =~ /\A[0-9]{8}\z/; + push @$to_parse, $x; + $x = "\0%Y%m%d$#$to_parse\0"; + } + } + } elsif ($pfx eq 'dt') { + if (!defined($r[1])) { # git needs gaps and not /\d{14}/ + if ($r[0] =~ /\A([0-9]{4})([0-9]{2})([0-9]{2}) + ([0-9]{2})([0-9]{2})([0-9]{2})\z/x) { + push @$to_parse, "$1-$2-$3 $4:$5:$6"; + } else { + push @$to_parse, $r[0]; + } + $r[0] = "\0%Y%m%d%H%M%S$#$to_parse\0"; + $r[1] = "\0%Y%m%d%H%M%S+\0"; + } else { + for my $x (@r) { + next if $x eq '' || $x =~ /\A[0-9]{14}\z/; + push @$to_parse, $x; + $x = "\0%Y%m%d%H%M%S$#$to_parse\0"; + } + } + } else { # "rt", let git interpret "YYYY", deal with Y10K later :P + for my $x (@r) { + next if $x eq '' || $x =~ /\A[0-9]{5,}\z/; + push @$to_parse, $x; + $x = "\0%s$#$to_parse\0"; + } + $r[1] //= "\0%s+\0"; + } + "$pfx:".join('..', @r).$end; +} + +sub date_parse_finalize { + my ($git, $to_parse) = @_; + # git-rev-parse can handle any number of args up to system + # limits (around (4096*32) bytes on Linux). + my @r = $git->date_parse(@$to_parse); + my $i; + $_[2] =~ s/\0(%[%YmdHMSs]+)([0-9\+]+)\0/strftime($1, + gmtime($2 eq '+' ? ($r[$i]+86400) : $r[$i=$2+0]))/sge; +} + +# n.b. argv never has NUL, though we'll need to filter it out +# if this $argv isn't from a command execution +sub query_argv_to_string { + my (undef, $git, $argv) = @_; + my $to_parse; + my $tmp = join(' ', map {; + if (s!\b(d|rt|dt):(\S+)\z!date_parse_prepare( + $to_parse //= [], $1, $2)!sge) { + $_; + } elsif (/\s/) { + s/(.*?)\b(\w+:)// ? qq{$1$2"$_"} : qq{"$_"}; + } else { + $_ + } + } @$argv); + date_parse_finalize($git, $to_parse, $tmp) if $to_parse; + $tmp +} + +# this is for the WWW "q=" query parameter and "lei q --stdin" +# it can't do d:"5 days ago", but it will do d:5.days.ago +sub query_approxidate { + my (undef, $git) = @_; # $_[2] = $query_string (modified in-place) + my $DQ = qq<"\x{201c}\x{201d}>; # Xapian can use curly quotes + $_[2] =~ tr/\x00/ /; # Xapian doesn't do NUL, we use it as a placeholder + my ($terms, $phrase, $to_parse); + $_[2] =~ s{([^$DQ]*)([$DQ][^$DQ]*[$DQ])?}{ + ($terms, $phrase) = ($1, $2); + $terms =~ s!\b(d|rt|dt):(\S+)! + date_parse_prepare($to_parse //= [], $1, $2)!sge; + $terms.($phrase // ''); + }sge; + date_parse_finalize($git, $to_parse, $_[2]) if $to_parse; +} + # read-only sub mset { my ($self, $query_string, $opts) = @_; $opts ||= {}; my $qp = $self->{qp} //= qparse_new($self); my $query = $qp->parse_query($query_string, $self->{qp_flags}); - $opts->{relevance} = 1 unless exists $opts->{relevance}; _do_enquire($self, $query, $opts); } @@ -328,18 +428,21 @@ sub _enquire_once { # retry_reopen callback my $enquire = $X{Enquire}->new($xdb); $enquire->set_query($query); $opts ||= {}; - my $desc = !$opts->{asc}; - if (($opts->{mset} || 0) == 2) { # mset == 2: ORDER BY docid/UID - $enquire->set_docid_order($ENQ_ASCENDING); + my $rel = $opts->{relevance} // 0; + if ($rel == -2) { # ORDER BY docid/UID (highest first) $enquire->set_weighting_scheme($X{BoolWeight}->new); - } elsif ($opts->{relevance}) { - $enquire->set_sort_by_relevance_then_value(TS, $desc); - } else { - $enquire->set_sort_by_value_then_relevance(TS, $desc); + $enquire->set_docid_order($ENQ_DESCENDING); + } elsif ($rel == -1) { # ORDER BY docid/UID (lowest first) + $enquire->set_weighting_scheme($X{BoolWeight}->new); + $enquire->set_docid_order($ENQ_ASCENDING); + } elsif ($rel == 0) { + $enquire->set_sort_by_value_then_relevance(TS, !$opts->{asc}); + } else { # rel > 0 + $enquire->set_sort_by_relevance_then_value(TS, !$opts->{asc}); } # `mairix -t / --threads' or JMAP collapseThreads - if ($opts->{thread} && has_threadid($self)) { + if ($opts->{threads} && has_threadid($self)) { $enquire->set_collapse_key(THREADID); } $enquire->get_mset($opts->{offset} || 0, $opts->{limit} || 50); @@ -378,8 +481,8 @@ sub qparse_new ($) { $cb->($qp, $NVRP->new(DT, 'dt:')); # for IMAP, undocumented for WWW and may be split off go away - $cb->($qp, $NVRP->new(BYTES, 'bytes:')); - $cb->($qp, $NVRP->new(TS, 'ts:')); + $cb->($qp, $NVRP->new(BYTES, 'z:')); + $cb->($qp, $NVRP->new(TS, 'rt:')); $cb->($qp, $NVRP->new(UID, 'uid:')); while (my ($name, $prefix) = each %bool_pfx_external) { @@ -421,4 +524,36 @@ sub help { \@ret; } +sub int_val ($$) { + my ($doc, $col) = @_; + my $val = $doc->get_value($col) or return; # undefined is '' in Xapian + sortable_unserialise($val) + 0; # PV => IV conversion +} + +sub get_pct ($) { # mset item + # Capped at "99%" since "100%" takes an extra column in the + # thread skeleton view. says the value isn't + # very meaningful, anyways. + my $n = $_[0]->get_percent; + $n > 99 ? 99 : $n; +} + +sub xap_terms ($$;@) { + my ($pfx, $xdb_or_doc, @docid) = @_; # @docid may be empty () + my %ret; + eval { + my $end = $xdb_or_doc->termlist_end(@docid); + my $cur = $xdb_or_doc->termlist_begin(@docid); + for (; $cur != $end; $cur++) { + $cur->skip_to($pfx); + last if $cur == $end; + my $tn = $cur->get_termname; + if (index($tn, $pfx) == 0) { + $ret{substr($tn, length($pfx))} = undef; + } + } + }; + \%ret; +} + 1;