search: remove documentation for "lid:"

[public-inbox.git] / lib / PublicInbox / Search.pm

diff --git a/lib/PublicInbox/Search.pm b/lib/PublicInbox/Search.pm
index a4491ca1f1743484ba138db4f895f8c2e23ad147..cb669e8733e7cd8596d6483ed77f4bb33dd16d66 100644 (file)
--- a/lib/PublicInbox/Search.pm
+++ b/lib/PublicInbox/Search.pm
@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 # based on notmuch, but with no concept of folders, files or flags
 #
@@ -12,7 +12,7 @@ use constant TS => 0;  # Received: header in Unix time
 use constant YYYYMMDD => 1; # Date: header for searching in the WWW UI
 use constant DT => 2; # Date: YYYYMMDDHHMMSS
 
-use PublicInbox::SearchMsg;
+use PublicInbox::Smsg;
 use PublicInbox::Over;
 my $QP_FLAGS;
 our %X = map { $_ => 0 } qw(BoolWeight Database Enquire
@@ -36,8 +36,8 @@ sub load_xapian () {
                $ENQ_ASCENDING = $x eq 'Xapian' ?
                                1 : Search::Xapian::ENQ_ASCENDING();
 
-               # for SearchMsg:
-               *PublicInbox::SearchMsg::sortable_unserialise =
+               # for Smsg:
+               *PublicInbox::Smsg::sortable_unserialise =
                                                $Xap.'::sortable_unserialise';
                # n.b. FLAG_PURE_NOT is expensive not suitable for a public
                # website as it could become a denial-of-service vector
@@ -77,11 +77,17 @@ use constant {
        # 15 - see public-inbox-v2-format(5)
        #      further bumps likely unnecessary, we'll suggest in-place
        #      "--reindex" use for further fixes and tweaks
+       #
+       #      public-inbox v1.5.0 adds (still SCHEMA_VERSION=15):
+       #      * "lid:" and "l:" for List-Id searches
        SCHEMA_VERSION => 15,
 };
 
+# note: the non-X term prefix allocations are shared with
+# Xapian omega, see xapian-applications/omega/docs/termprefixes.rst
 my %bool_pfx_external = (
        mid => 'Q', # Message-ID (full/exact), this is mostly uniQue
+       lid => 'G', # newsGroup (or similar entity), just inside <>
        dfpre => 'XDFPRE',
        dfpost => 'XDFPOST',
        dfblob => 'XDFPRE XDFPOST',
@@ -92,6 +98,7 @@ my %prob_prefix = (
        # for mairix compatibility
        s => 'S',
        m => 'XM', # 'mid:' (bool) is exact, 'm:' (prob) can do partial
+       l => 'XL', # 'lid:' (bool) is exact, 'l:' (prob) can do partial
        f => 'A',
        t => 'XTO',
        tc => 'XTO XCC',
@@ -115,6 +122,9 @@ my %prob_prefix = (
 );
 
 # not documenting m: and mid: for now, the using the URLs works w/o Xapian
+# not documenting lid: for now, either, it is probably redundant with l:,
+# especially since we don't offer boolean searches for To/Cc/From
+# headers, either
 our @HELP = (
        's:' => 'match within Subject  e.g. s:"a quick brown fox"',
        'd:' => <<EOF,
@@ -134,6 +144,7 @@ EOF
        'f:' => 'match within the From header',
        'a:' => 'match within the To, Cc, and From headers',
        'tc:' => 'match within the To and Cc headers',
+       'l:' => 'match contents of the List-Id header',
        'bs:' => 'match within the Subject and body',
        'dfn:' => 'match filename from diff',
        'dfa:' => 'match diff removed (-) lines',
@@ -279,7 +290,7 @@ sub _enquire_once { # retry_reopen callback
        my $limit = $opts->{limit} || 50;
        my $mset = $enquire->get_mset($offset, $limit);
        return $mset if $opts->{mset};
-       my @msgs = map { PublicInbox::SearchMsg::from_mitem($_) } $mset->items;
+       my @msgs = map { PublicInbox::Smsg::from_mitem($_) } $mset->items;
        return \@msgs unless wantarray;
 
        ($mset->get_matches_estimated, \@msgs)
@@ -313,9 +324,11 @@ sub qp {
        # we do not actually create AltId objects,
        # just parse the spec to avoid the extra DB handles for now.
        if (my $altid = $self->{altid}) {
-               my $user_pfx = $self->{-user_pfx} ||= [];
+               my $user_pfx = $self->{-user_pfx} = [];
                for (@$altid) {
                        # $_ = 'serial:gmane:/path/to/gmane.msgmap.sqlite3'
+                       # note: Xapian supports multibyte UTF-8, /^[0-9]+$/,
+                       # and '_' with prefixes matching \w+
                        /\Aserial:(\w+):/ or next;
                        my $pfx = $1;
                        push @$user_pfx, "$pfx:", <<EOF;