-# Copyright (C) 2015, all contributors <meta@public-inbox.org>
+# Copyright (C) 2015 all contributors <meta@public-inbox.org>
# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
# based on notmuch, but with no concept of folders, files or flags
+#
+# Read-only search interface for use by the web and NNTP interfaces
package PublicInbox::Search;
use strict;
use warnings;
-use constant TS => 0;
+
+# values for searching
+use constant TS => 0; # timestamp
+use constant NUM => 1; # NNTP article number
+use constant BYTES => 2; # :bytes as defined in RFC 3977
+use constant LINES => 3; # :lines as defined in RFC 3977
+
use Search::Xapian qw/:standard/;
use PublicInbox::SearchMsg;
use Email::MIME;
-use PublicInbox::MID qw/mid_clean mid_compress/;
+use PublicInbox::MID qw/mid_clean id_compress/;
# This is English-only, everything else is non-standard and may be confused as
# a prefix common in patch emails
# SCHEMA_VERSION history
# 0 - initial
# 1 - subject_path is lower-cased
- # 2 - subject_path is mid_compress in the index, only
+ # 2 - subject_path is id_compress in the index, only
# 3 - message-ID is compressed if it includes '%' (hack!)
# 4 - change "Re: " normalization, avoid circular Reference ghosts
# 5 - subject_path drops trailing '.'
# 6 - preserve References: order in document data
# 7 - remove references and inreplyto terms
# 8 - remove redundant/unneeded document data
- SCHEMA_VERSION => 8,
+ # 9 - disable Message-ID compression (SHA-1)
+ # 10 - optimize doc for NNTP overviews
+ SCHEMA_VERSION => 10,
+
+ # n.b. FLAG_PURE_NOT is expensive not suitable for a public website
+ # as it could become a denial-of-service vector
QP_FLAGS => FLAG_PHRASE|FLAG_BOOLEAN|FLAG_LOVEHATE|FLAG_WILDCARD,
};
# setup prefixes
my %bool_pfx_internal = (
type => 'T', # "mail" or "ghost"
- mid => 'Q', # uniQue id (Message-ID or mid_compress)
+ thread => 'G', # newsGroup (or similar entity - e.g. a web forum name)
);
my %bool_pfx_external = (
path => 'XPATH',
- thread => 'G', # newsGroup (or similar entity - e.g. a web forum name)
+ mid => 'Q', # uniQue id (Message-ID)
);
my %prob_prefix = (
subject => 'S',
+ s => 'S', # for mairix compatibility
+ m => 'Q', # 'mid' is exact, 'm' can do partial
);
my %all_pfx = (%bool_pfx_internal, %bool_pfx_external, %prob_prefix);
$opts ||= {};
unless ($query_string eq '') {
$query = $self->qp->parse_query($query_string, QP_FLAGS);
- $opts->{relevance} = 1;
+ $opts->{relevance} = 1 unless exists $opts->{relevance};
}
$self->do_enquire($query, $opts);
}
-sub get_subject_path {
- my ($self, $path, $opts) = @_;
- my $query = $self->qp->parse_query("path:".mid_compress($path), 0);
- $self->do_enquire($query, $opts);
-}
-
sub get_thread {
my ($self, $mid, $opts) = @_;
my $smsg = eval { $self->lookup_message($mid) };
return { total => 0, msgs => [] } unless $smsg;
- my $qp = $self->qp;
- my $qtid = $qp->parse_query('thread:'.$smsg->thread_id, 0);
- my $qsub = $qp->parse_query('path:'.mid_compress($smsg->path), 0);
+ my $qtid = Search::Xapian::Query->new(xpfx('thread').$smsg->thread_id);
+ my $path = id_compress($smsg->path);
+ my $qsub = Search::Xapian::Query->new(xpfx('path').$path);
my $query = Search::Xapian::Query->new(OP_OR, $qtid, $qsub);
+ $opts ||= {};
+ $opts->{limit} ||= 1000;
$self->do_enquire($query, $opts);
}
-# private subs below
-
sub do_enquire {
my ($self, $query, $opts) = @_;
my $enquire = $self->enquire;
$query = $mail_query;
}
$enquire->set_query($query);
+ $opts ||= {};
+ my $desc = !$opts->{asc};
if ($opts->{relevance}) {
- $enquire->set_sort_by_relevance_then_value(TS, 0);
+ $enquire->set_sort_by_relevance_then_value(TS, $desc);
} else {
- $enquire->set_sort_by_value(TS, 0);
+ $enquire->set_sort_by_value_then_relevance(TS, $desc);
}
- $opts ||= {};
my $offset = $opts->{offset} || 0;
my $limit = $opts->{limit} || 50;
my $mset = $enquire->get_mset($offset, $limit);
+ return $mset if $opts->{mset};
my @msgs = map {
PublicInbox::SearchMsg->load_doc($_->get_document);
} $mset->items;
$_[0]->{drp} ||= Search::Xapian::DateValueRangeProcessor->new(TS);
}
+sub num_range_processor {
+ $_[0]->{nrp} ||= Search::Xapian::NumberValueRangeProcessor->new(NUM);
+}
+
+# only used for NNTP server
+sub query_xover {
+ my ($self, $beg, $end, $offset) = @_;
+ my $enquire = $self->enquire;
+ my $qp = Search::Xapian::QueryParser->new;
+ $qp->set_database($self->{xdb});
+ $qp->add_valuerangeprocessor($self->num_range_processor);
+ my $query = $qp->parse_query("$beg..$end", QP_FLAGS);
+ $query = Search::Xapian::Query->new(OP_AND, $mail_query, $query);
+ $enquire->set_query($query);
+ $enquire->set_sort_by_value(NUM, 0);
+ my $limit = 200;
+ my $mset = $enquire->get_mset($offset, $limit);
+ my @msgs = map {
+ PublicInbox::SearchMsg->load_doc($_->get_document);
+ } $mset->items;
+
+ { total => $mset->get_matches_estimated, msgs => \@msgs }
+}
+
sub lookup_message {
my ($self, $mid) = @_;
$mid = mid_clean($mid);
- $mid = mid_compress($mid);
my $doc_id = $self->find_unique_doc_id('mid', $mid);
my $smsg;