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
41 # n.b. FLAG_PURE_NOT is expensive not suitable for a public website
42 # as it could become a denial-of-service vector
43 QP_FLAGS => FLAG_PHRASE|FLAG_BOOLEAN|FLAG_LOVEHATE|FLAG_WILDCARD,
47 my %bool_pfx_internal = (
48 type => 'T', # "mail" or "ghost"
49 thread => 'G', # newsGroup (or similar entity - e.g. a web forum name)
52 my %bool_pfx_external = (
54 mid => 'Q', # uniQue id (Message-ID)
59 s => 'S', # for mairix compatibility
60 m => 'Q', # 'mid' is exact, 'm' can do partial
63 my %all_pfx = (%bool_pfx_internal, %bool_pfx_external, %prob_prefix);
65 sub xpfx { $all_pfx{$_[0]} }
68 my %meta_pfx = (mid => 1, thread => 1, path => 1);
69 while (my ($k, $v) = each %all_pfx) {
70 $PFX2TERM_RMAP{$v} = $k if $meta_pfx{$k};
73 my $mail_query = Search::Xapian::Query->new(xpfx('type') . 'mail');
76 my (undef, $git_dir) = @_;
77 "$git_dir/public-inbox/xapian" . SCHEMA_VERSION;
81 my ($class, $git_dir) = @_;
82 my $dir = $class->xdir($git_dir);
83 my $db = Search::Xapian::Database->new($dir);
84 bless { xdb => $db, git_dir => $git_dir }, $class;
87 sub reopen { $_[0]->{xdb}->reopen }
91 my ($self, $query_string, $opts) = @_;
95 unless ($query_string eq '') {
96 $query = $self->qp->parse_query($query_string, QP_FLAGS);
97 $opts->{relevance} = 1 unless exists $opts->{relevance};
100 _do_enquire($self, $query, $opts);
104 my ($self, $mid, $opts) = @_;
105 my $smsg = eval { $self->lookup_message($mid) };
107 return { total => 0, msgs => [] } unless $smsg;
108 my $qtid = Search::Xapian::Query->new(xpfx('thread').$smsg->thread_id);
109 my $path = id_compress($smsg->path);
110 my $qsub = Search::Xapian::Query->new(xpfx('path').$path);
111 my $query = Search::Xapian::Query->new(OP_OR, $qtid, $qsub);
113 $opts->{limit} ||= 1000;
114 _do_enquire($self, $query, $opts);
118 my ($self, $query, $opts) = @_;
121 eval { $ret = _enquire_once($self, $query, $opts) };
122 return $ret unless $@;
123 # Exception: The revision being read has been discarded -
124 # you should call Xapian::Database::reopen()
125 if (index($@, 'Xapian::Database::reopen') >= 0) {
134 my ($self, $query, $opts) = @_;
135 my $enquire = $self->enquire;
136 if (defined $query) {
137 $query = Search::Xapian::Query->new(OP_AND,$query,$mail_query);
139 $query = $mail_query;
141 $enquire->set_query($query);
143 my $desc = !$opts->{asc};
144 if ($opts->{relevance}) {
145 $enquire->set_sort_by_relevance_then_value(TS, $desc);
146 } elsif ($opts->{num}) {
147 $enquire->set_sort_by_value(NUM, 0);
149 $enquire->set_sort_by_value_then_relevance(TS, $desc);
151 my $offset = $opts->{offset} || 0;
152 my $limit = $opts->{limit} || 50;
153 my $mset = $enquire->get_mset($offset, $limit);
154 return $mset if $opts->{mset};
156 PublicInbox::SearchMsg->load_doc($_->get_document);
159 { total => $mset->get_matches_estimated, msgs => \@msgs }
163 sub stemmer { Search::Xapian::Stem->new($LANG) }
169 my $qp = $self->{query_parser};
173 $qp = Search::Xapian::QueryParser->new;
174 $qp->set_default_op(OP_AND);
175 $qp->set_database($self->{xdb});
176 $qp->set_stemmer($self->stemmer);
177 $qp->set_stemming_strategy(STEM_SOME);
178 $qp->add_valuerangeprocessor($self->ts_range_processor);
179 $qp->add_valuerangeprocessor($self->date_range_processor);
181 while (my ($name, $prefix) = each %bool_pfx_external) {
182 $qp->add_boolean_prefix($name, $prefix);
185 while (my ($name, $prefix) = each %prob_prefix) {
186 $qp->add_prefix($name, $prefix);
189 $self->{query_parser} = $qp;
192 sub ts_range_processor {
193 $_[0]->{tsrp} ||= Search::Xapian::NumberValueRangeProcessor->new(TS);
196 sub date_range_processor {
197 $_[0]->{drp} ||= Search::Xapian::DateValueRangeProcessor->new(TS);
200 sub num_range_processor {
201 $_[0]->{nrp} ||= Search::Xapian::NumberValueRangeProcessor->new(NUM);
204 # only used for NNTP server
206 my ($self, $beg, $end, $offset) = @_;
207 my $qp = Search::Xapian::QueryParser->new;
208 $qp->set_database($self->{xdb});
209 $qp->add_valuerangeprocessor($self->num_range_processor);
210 my $query = $qp->parse_query("$beg..$end", QP_FLAGS);
212 _do_enquire($self, $query, {num => 1, limit => 200, offset => $offset});
216 my ($self, $mid) = @_;
217 $mid = mid_clean($mid);
219 my $doc_id = $self->find_unique_doc_id('mid', $mid);
221 if (defined $doc_id) {
223 my $doc = $self->{xdb}->get_document($doc_id);
224 $smsg = PublicInbox::SearchMsg->wrap($doc, $mid);
225 $smsg->doc_id($doc_id);
230 sub find_unique_doc_id {
231 my ($self, $term, $value) = @_;
233 my ($begin, $end) = $self->find_doc_ids($term, $value);
235 return undef if $begin->equal($end); # not found
237 my $rv = $begin->get_docid;
241 $begin->equal($end) or die "Term '$term:$value' is not unique\n";
245 # returns begin and end PostingIterator
247 my ($self, $term, $value) = @_;
249 $self->find_doc_ids_for_term(xpfx($term) . $value);
252 # returns begin and end PostingIterator
253 sub find_doc_ids_for_term {
254 my ($self, $term) = @_;
255 my $db = $self->{xdb};
257 ($db->postlist_begin($term), $db->postlist_end($term));
260 # normalize subjects so they are suitable as pathnames for URLs
263 $subj = subject_normalized($subj);
264 $subj =~ s![^a-zA-Z0-9_\.~/\-]+!_!g;
268 sub subject_normalized {
270 $subj =~ s/\A\s+//s; # no leading space
271 $subj =~ s/\s+\z//s; # no trailing space
272 $subj =~ s/\s+/ /gs; # no redundant spaces
273 $subj =~ s/\.+\z//; # no trailing '.'
274 $subj =~ s/$REPLY_RE//igo; # remove reply prefix
279 sub subject_summary {
282 if (length($subj) > $max) {
283 my @subj = split(/\s+/, $subj);
287 while ($l = shift @subj) {
288 my $new = $subj . $l . ' ';
289 last if length($new) >= $max;
293 my $r = scalar @subj ? ' ...' : '';
296 # subject has one REALLY long word, and NOT spam? wtf
297 @subj = ($l =~ /\A(.{1,72})/);
298 $subj = $subj[0] . ' ...';
306 $self->{enquire} ||= Search::Xapian::Enquire->new($self->{xdb});