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 constant YYYYMMDD => 4; # for searching in the WWW UI
use Search::Xapian qw/:standard/;
use PublicInbox::SearchMsg;
# 9 - disable Message-ID compression (SHA-1)
# 10 - optimize doc for NNTP overviews
# 11 - merge threads when vivifying ghosts
- SCHEMA_VERSION => 11,
+ # 12 - change YYYYMMDD value column to numeric
+ SCHEMA_VERSION => 12,
# n.b. FLAG_PURE_NOT is expensive not suitable for a public website
# as it could become a denial-of-service vector
);
my %bool_pfx_external = (
+ # do we still need these? probably not..
path => 'XPATH',
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
+ # for mairix compatibility
+ s => 'S',
+ m => 'XMID', # 'mid:' (bool) is exact, 'm:' (prob) can do partial
+ f => 'A',
+ t => 'XTO',
+ tc => 'XTO XCC',
+ c => 'XCC',
+ tcf => 'XTO XCC A',
+ a => 'XTO XCC A',
+ b => 'XNQ XQUOT',
+ bs => 'XNQ XQUOT S',
+ n => 'XFN',
+
+ q => 'XQUOT',
+ nq => 'XNQ',
+
+ # default:
+ '' => 'XMID S A XNQ XQUOT XFN',
);
+# not documenting m: and mid: for now, the using the URLs works w/o Xapian
+our @HELP = (
+ 's:' => 'match within Subject e.g. s:"a quick brown fox"',
+ 'd:' => <<EOF,
+date range as YYYYMMDD e.g. d:19931002..20101002
+Open-ended ranges such as d:19931002.. and d:..20101002
+are also supported
+EOF
+ 'b:' => 'match within message body, including text attachments',
+ 'nq:' => 'match non-quoted text within message body',
+ 'quot:' => 'match quoted text within message body',
+ 'n:' => 'match filename of attachment(s)',
+ 't:' => 'match within the To header',
+ 'c:' => 'match within the Cc header',
+ 'f:' => 'match within the From header',
+ 'a:' => 'match within the To, Cc, and From headers',
+ 'tc:' => 'match within the To and Cc headers',
+ 'bs:' => 'match within the Subject and body',
+);
+chomp @HELP;
+# TODO:
+# df (filenames from diff)
+# da (diff a/ removed lines)
+# db (diff b/ added lines)
+
my %all_pfx = (%bool_pfx_internal, %bool_pfx_external, %prob_prefix);
sub xpfx { $all_pfx{$_[0]} }
$qp->set_database($self->{xdb});
$qp->set_stemmer($self->stemmer);
$qp->set_stemming_strategy(STEM_SOME);
- $qp->add_valuerangeprocessor($self->ts_range_processor);
- $qp->add_valuerangeprocessor($self->date_range_processor);
+ $qp->add_valuerangeprocessor(
+ Search::Xapian::NumberValueRangeProcessor->new(YYYYMMDD, 'd:'));
while (my ($name, $prefix) = each %bool_pfx_external) {
$qp->add_boolean_prefix($name, $prefix);
# 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} ||= [];
for (@$altid) {
# $_ = 'serial:gmane:/path/to/gmane.msgmap.sqlite3'
/\Aserial:(\w+):/ or next;
my $pfx = $1;
+ push @$user_pfx, "$pfx:", <<EOF;
+alternate serial number e.g. $pfx:12345 (boolean)
+EOF
# gmane => XGMANE
$qp->add_boolean_prefix($pfx, 'X'.uc($pfx));
}
+ chomp @$user_pfx;
}
while (my ($name, $prefix) = each %prob_prefix) {
- $qp->add_prefix($name, $prefix);
+ $qp->add_prefix($name, $_) foreach split(/ /, $prefix);
}
$self->{query_parser} = $qp;
}
-sub ts_range_processor {
- $_[0]->{tsrp} ||= Search::Xapian::NumberValueRangeProcessor->new(TS);
-}
-
-sub date_range_processor {
- $_[0]->{drp} ||= Search::Xapian::DateValueRangeProcessor->new(TS);
-}
-
sub num_range_processor {
$_[0]->{nrp} ||= Search::Xapian::NumberValueRangeProcessor->new(NUM);
}
sub lookup_mail { # no ghosts!
my ($self, $mid) = @_;
- my $smsg = lookup_message($self, $mid);
+ my $smsg = lookup_message($self, $mid) or return;
PublicInbox::SearchMsg->load_doc($smsg->{doc});
}
$self->{enquire} ||= Search::Xapian::Enquire->new($self->{xdb});
}
+sub help {
+ my ($self) = @_;
+ $self->qp; # parse altids
+ my @ret = @HELP;
+ if (my $user_pfx = $self->{-user_pfx}) {
+ push @ret, @$user_pfx;
+ }
+ \@ret;
+}
+
1;