1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
2 # License: AGPLv3 or later (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;
10 # values for searching
11 use constant TS => 0; # timestamp
12 use constant NUM => 1; # NNTP article number
13 use constant BYTES => 2; # :bytes as defined in RFC 3977
14 use constant LINES => 3; # :lines as defined in RFC 3977
16 use Search::Xapian qw/:standard/;
17 use PublicInbox::SearchMsg;
19 use PublicInbox::MID qw/mid_clean id_compress/;
21 # This is English-only, everything else is non-standard and may be confused as
22 # a prefix common in patch emails
23 our $REPLY_RE = qr/^re:\s+/i;
24 our $LANG = 'english';
27 # SCHEMA_VERSION history
29 # 1 - subject_path is lower-cased
30 # 2 - subject_path is id_compress in the index, only
31 # 3 - message-ID is compressed if it includes '%' (hack!)
32 # 4 - change "Re: " normalization, avoid circular Reference ghosts
33 # 5 - subject_path drops trailing '.'
34 # 6 - preserve References: order in document data
35 # 7 - remove references and inreplyto terms
36 # 8 - remove redundant/unneeded document data
37 # 9 - disable Message-ID compression (SHA-1)
38 # 10 - optimize doc for NNTP overviews
39 # 11 - merge threads when vivifying ghosts
42 # n.b. FLAG_PURE_NOT is expensive not suitable for a public website
43 # as it could become a denial-of-service vector
44 QP_FLAGS => FLAG_PHRASE|FLAG_BOOLEAN|FLAG_LOVEHATE|FLAG_WILDCARD,
48 my %bool_pfx_internal = (
49 type => 'T', # "mail" or "ghost"
50 thread => 'G', # newsGroup (or similar entity - e.g. a web forum name)
53 my %bool_pfx_external = (
55 mid => 'Q', # uniQue id (Message-ID)
60 s => 'S', # for mairix compatibility
61 m => 'Q', # 'mid' is exact, 'm' can do partial
64 my %all_pfx = (%bool_pfx_internal, %bool_pfx_external, %prob_prefix);
66 sub xpfx { $all_pfx{$_[0]} }
69 my %meta_pfx = (mid => 1, thread => 1, path => 1);
70 while (my ($k, $v) = each %all_pfx) {
71 $PFX2TERM_RMAP{$v} = $k if $meta_pfx{$k};
74 my $mail_query = Search::Xapian::Query->new(xpfx('type') . 'mail');
77 my (undef, $git_dir) = @_;
78 "$git_dir/public-inbox/xapian" . SCHEMA_VERSION;
82 my ($class, $git_dir) = @_;
83 my $dir = $class->xdir($git_dir);
84 my $db = Search::Xapian::Database->new($dir);
85 bless { xdb => $db, git_dir => $git_dir }, $class;
88 sub reopen { $_[0]->{xdb}->reopen }
92 my ($self, $query_string, $opts) = @_;
96 unless ($query_string eq '') {
97 $query = $self->qp->parse_query($query_string, QP_FLAGS);
98 $opts->{relevance} = 1 unless exists $opts->{relevance};
101 _do_enquire($self, $query, $opts);
105 my ($self, $mid, $opts) = @_;
106 my $smsg = eval { $self->lookup_message($mid) };
108 return { total => 0, msgs => [] } unless $smsg;
109 my $qtid = Search::Xapian::Query->new(xpfx('thread').$smsg->thread_id);
110 my $path = $smsg->path;
111 if (defined $path && $path ne '') {
112 my $path = id_compress($smsg->path);
113 my $qsub = Search::Xapian::Query->new(xpfx('path').$path);
114 $qtid = Search::Xapian::Query->new(OP_OR, $qtid, $qsub);
117 $opts->{limit} ||= 1000;
118 _do_enquire($self, $qtid, $opts);
122 my ($self, $query, $opts) = @_;
125 eval { $ret = _enquire_once($self, $query, $opts) };
126 return $ret unless $@;
127 # Exception: The revision being read has been discarded -
128 # you should call Xapian::Database::reopen()
129 if (index($@, 'Xapian::Database::reopen') >= 0) {
138 my ($self, $query, $opts) = @_;
139 my $enquire = $self->enquire;
140 if (defined $query) {
141 $query = Search::Xapian::Query->new(OP_AND,$query,$mail_query);
143 $query = $mail_query;
145 $enquire->set_query($query);
147 my $desc = !$opts->{asc};
148 if ($opts->{relevance}) {
149 $enquire->set_sort_by_relevance_then_value(TS, $desc);
150 } elsif ($opts->{num}) {
151 $enquire->set_sort_by_value(NUM, 0);
153 $enquire->set_sort_by_value_then_relevance(TS, $desc);
155 my $offset = $opts->{offset} || 0;
156 my $limit = $opts->{limit} || 50;
157 my $mset = $enquire->get_mset($offset, $limit);
158 return $mset if $opts->{mset};
160 PublicInbox::SearchMsg->load_doc($_->get_document);
163 { total => $mset->get_matches_estimated, msgs => \@msgs }
167 sub stemmer { Search::Xapian::Stem->new($LANG) }
173 my $qp = $self->{query_parser};
177 $qp = Search::Xapian::QueryParser->new;
178 $qp->set_default_op(OP_AND);
179 $qp->set_database($self->{xdb});
180 $qp->set_stemmer($self->stemmer);
181 $qp->set_stemming_strategy(STEM_SOME);
182 $qp->add_valuerangeprocessor($self->ts_range_processor);
183 $qp->add_valuerangeprocessor($self->date_range_processor);
185 while (my ($name, $prefix) = each %bool_pfx_external) {
186 $qp->add_boolean_prefix($name, $prefix);
189 while (my ($name, $prefix) = each %prob_prefix) {
190 $qp->add_prefix($name, $prefix);
193 $self->{query_parser} = $qp;
196 sub ts_range_processor {
197 $_[0]->{tsrp} ||= Search::Xapian::NumberValueRangeProcessor->new(TS);
200 sub date_range_processor {
201 $_[0]->{drp} ||= Search::Xapian::DateValueRangeProcessor->new(TS);
204 sub num_range_processor {
205 $_[0]->{nrp} ||= Search::Xapian::NumberValueRangeProcessor->new(NUM);
208 # only used for NNTP server
210 my ($self, $beg, $end, $offset) = @_;
211 my $qp = Search::Xapian::QueryParser->new;
212 $qp->set_database($self->{xdb});
213 $qp->add_valuerangeprocessor($self->num_range_processor);
214 my $query = $qp->parse_query("$beg..$end", QP_FLAGS);
216 _do_enquire($self, $query, {num => 1, limit => 200, offset => $offset});
220 my ($self, $mid) = @_;
221 $mid = mid_clean($mid);
223 my $doc_id = $self->find_unique_doc_id('mid', $mid);
225 if (defined $doc_id) {
227 my $doc = $self->{xdb}->get_document($doc_id);
228 $smsg = PublicInbox::SearchMsg->wrap($doc, $mid);
229 $smsg->doc_id($doc_id);
234 sub lookup_mail { # no ghosts!
235 my ($self, $mid) = @_;
236 my $smsg = lookup_message($self, $mid);
237 PublicInbox::SearchMsg->load_doc($smsg->{doc});
240 sub find_unique_doc_id {
241 my ($self, $term, $value) = @_;
243 my ($begin, $end) = $self->find_doc_ids($term, $value);
245 return undef if $begin->equal($end); # not found
247 my $rv = $begin->get_docid;
251 $begin->equal($end) or die "Term '$term:$value' is not unique\n";
255 # returns begin and end PostingIterator
257 my ($self, $term, $value) = @_;
259 $self->find_doc_ids_for_term(xpfx($term) . $value);
262 # returns begin and end PostingIterator
263 sub find_doc_ids_for_term {
264 my ($self, $term) = @_;
265 my $db = $self->{xdb};
267 ($db->postlist_begin($term), $db->postlist_end($term));
270 # normalize subjects so they are suitable as pathnames for URLs
273 $subj = subject_normalized($subj);
274 $subj =~ s![^a-zA-Z0-9_\.~/\-]+!_!g;
278 sub subject_normalized {
280 $subj =~ s/\A\s+//s; # no leading space
281 $subj =~ s/\s+\z//s; # no trailing space
282 $subj =~ s/\s+/ /gs; # no redundant spaces
283 $subj =~ s/\.+\z//; # no trailing '.'
284 $subj =~ s/$REPLY_RE//igo; # remove reply prefix
289 sub subject_summary {
292 if (length($subj) > $max) {
293 my @subj = split(/\s+/, $subj);
297 while ($l = shift @subj) {
298 my $new = $subj . $l . ' ';
299 last if length($new) >= $max;
303 my $r = scalar @subj ? ' ...' : '';
306 # subject has one REALLY long word, and NOT spam? wtf
307 @subj = ($l =~ /\A(.{1,72})/);
308 $subj = $subj[0] . ' ...';
316 $self->{enquire} ||= Search::Xapian::Enquire->new($self->{xdb});