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
4 package PublicInbox::Search;
8 use Search::Xapian qw/:standard/;
9 use PublicInbox::SearchMsg;
11 use PublicInbox::MID qw/mid_clean mid_compress/;
13 # This is English-only, everything else is non-standard and may be confused as
14 # a prefix common in patch emails
15 our $REPLY_RE = qr/^re:\s+/i;
16 our $LANG = 'english';
19 # SCHEMA_VERSION history
21 # 1 - subject_path is lower-cased
22 # 2 - subject_path is mid_compress in the index, only
23 # 3 - message-ID is compressed if it includes '%' (hack!)
24 # 4 - change "Re: " normalization, avoid circular Reference ghosts
25 # 5 - subject_path drops trailing '.'
26 # 6 - preserve References: order in document data
27 # 7 - remove references and inreplyto terms
28 # 8 - remove redundant/unneeded document data
29 # 9 - disable Message-ID compression
32 # n.b. FLAG_PURE_NOT is expensive not suitable for a public website
33 # as it could become a denial-of-service vector
34 QP_FLAGS => FLAG_PHRASE|FLAG_BOOLEAN|FLAG_LOVEHATE|FLAG_WILDCARD,
38 my %bool_pfx_internal = (
39 type => 'T', # "mail" or "ghost"
40 thread => 'G', # newsGroup (or similar entity - e.g. a web forum name)
43 my %bool_pfx_external = (
45 mid => 'Q', # uniQue id (Message-ID)
50 s => 'S', # for mairix compatibility
51 m => 'Q', # 'mid' is exact, 'm' can do partial
54 my %all_pfx = (%bool_pfx_internal, %bool_pfx_external, %prob_prefix);
56 sub xpfx { $all_pfx{$_[0]} }
59 my %meta_pfx = (mid => 1, thread => 1, path => 1);
60 while (my ($k, $v) = each %all_pfx) {
61 $PFX2TERM_RMAP{$v} = $k if $meta_pfx{$k};
64 my $mail_query = Search::Xapian::Query->new(xpfx('type') . 'mail');
67 my (undef, $git_dir) = @_;
68 "$git_dir/public-inbox/xapian" . SCHEMA_VERSION;
72 my ($class, $git_dir) = @_;
73 my $dir = $class->xdir($git_dir);
74 my $db = Search::Xapian::Database->new($dir);
75 bless { xdb => $db, git_dir => $git_dir }, $class;
78 sub reopen { $_[0]->{xdb}->reopen }
82 my ($self, $query_string, $opts) = @_;
86 unless ($query_string eq '') {
87 $query = $self->qp->parse_query($query_string, QP_FLAGS);
88 $opts->{relevance} = 1 unless exists $opts->{relevance};
91 $self->do_enquire($query, $opts);
94 sub get_subject_path {
95 my ($self, $path, $opts) = @_;
96 my $q = Search::Xapian::Query->new(xpfx("path").mid_compress($path));
97 $self->do_enquire($q, $opts);
101 my ($self, $mid, $opts) = @_;
102 my $smsg = eval { $self->lookup_message($mid) };
104 return { total => 0, msgs => [] } unless $smsg;
105 my $qtid = Search::Xapian::Query->new(xpfx('thread').$smsg->thread_id);
106 my $path = mid_compress($smsg->path);
107 my $qsub = Search::Xapian::Query->new(xpfx('path').$path);
108 my $query = Search::Xapian::Query->new(OP_OR, $qtid, $qsub);
109 $self->do_enquire($query, $opts);
115 my ($self, $query, $opts) = @_;
116 my $enquire = $self->enquire;
117 if (defined $query) {
118 $query = Search::Xapian::Query->new(OP_AND,$query,$mail_query);
120 $query = $mail_query;
122 $enquire->set_query($query);
123 if ($opts->{relevance}) {
124 $enquire->set_sort_by_relevance_then_value(TS, 1);
126 $enquire->set_sort_by_value_then_relevance(TS, 1);
129 my $offset = $opts->{offset} || 0;
130 my $limit = $opts->{limit} || 50;
131 my $mset = $enquire->get_mset($offset, $limit);
132 return $mset if $opts->{mset};
134 PublicInbox::SearchMsg->load_doc($_->get_document);
137 { total => $mset->get_matches_estimated, msgs => \@msgs }
141 sub stemmer { Search::Xapian::Stem->new($LANG) }
147 my $qp = $self->{query_parser};
151 $qp = Search::Xapian::QueryParser->new;
152 $qp->set_default_op(OP_AND);
153 $qp->set_database($self->{xdb});
154 $qp->set_stemmer($self->stemmer);
155 $qp->set_stemming_strategy(STEM_SOME);
156 $qp->add_valuerangeprocessor($self->ts_range_processor);
157 $qp->add_valuerangeprocessor($self->date_range_processor);
159 while (my ($name, $prefix) = each %bool_pfx_external) {
160 $qp->add_boolean_prefix($name, $prefix);
163 while (my ($name, $prefix) = each %prob_prefix) {
164 $qp->add_prefix($name, $prefix);
167 $self->{query_parser} = $qp;
170 sub ts_range_processor {
171 $_[0]->{tsrp} ||= Search::Xapian::NumberValueRangeProcessor->new(TS);
174 sub date_range_processor {
175 $_[0]->{drp} ||= Search::Xapian::DateValueRangeProcessor->new(TS);
179 my ($self, $mid) = @_;
180 $mid = mid_clean($mid);
182 my $doc_id = $self->find_unique_doc_id('mid', $mid);
184 if (defined $doc_id) {
186 my $doc = $self->{xdb}->get_document($doc_id);
187 $smsg = PublicInbox::SearchMsg->wrap($doc, $mid);
188 $smsg->doc_id($doc_id);
193 sub find_unique_doc_id {
194 my ($self, $term, $value) = @_;
196 my ($begin, $end) = $self->find_doc_ids($term, $value);
198 return undef if $begin->equal($end); # not found
200 my $rv = $begin->get_docid;
204 $begin->equal($end) or die "Term '$term:$value' is not unique\n";
208 # returns begin and end PostingIterator
210 my ($self, $term, $value) = @_;
212 $self->find_doc_ids_for_term(xpfx($term) . $value);
215 # returns begin and end PostingIterator
216 sub find_doc_ids_for_term {
217 my ($self, $term) = @_;
218 my $db = $self->{xdb};
220 ($db->postlist_begin($term), $db->postlist_end($term));
223 # normalize subjects so they are suitable as pathnames for URLs
226 $subj = subject_normalized($subj);
227 $subj =~ s![^a-zA-Z0-9_\.~/\-]+!_!g;
231 sub subject_normalized {
233 $subj =~ s/\A\s+//s; # no leading space
234 $subj =~ s/\s+\z//s; # no trailing space
235 $subj =~ s/\s+/ /gs; # no redundant spaces
236 $subj =~ s/\.+\z//; # no trailing '.'
237 $subj =~ s/$REPLY_RE//igo; # remove reply prefix
242 sub subject_summary {
245 if (length($subj) > $max) {
246 my @subj = split(/\s+/, $subj);
250 while ($l = shift @subj) {
251 my $new = $subj . $l . ' ';
252 last if length($new) >= $max;
256 my $r = scalar @subj ? ' ...' : '';
259 # subject has one REALLY long word, and NOT spam? wtf
260 @subj = ($l =~ /\A(.{1,72})/);
261 $subj = $subj[0] . ' ...';
269 $self->{enquire} ||= Search::Xapian::Enquire->new($self->{xdb});
273 my ($self, $mpfx) = @_;
274 my $query = eval { $self->qp->parse_query("m:$mpfx", FLAG_PARTIAL) };
276 my $res = $self->do_enquire($query, { relevance => 1 });
277 return unless $res->{total};
278 [ map { $_->mid } @{$res->{msgs}} ];