1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
4 # Displays search results for the web interface
5 package PublicInbox::SearchView;
8 use PublicInbox::SearchMsg;
9 use PublicInbox::Hval qw/ascii_html/;
10 use PublicInbox::View;
11 use PublicInbox::MID qw(mid2path mid_mime mid_clean);
13 require PublicInbox::Git;
14 require PublicInbox::Thread;
21 my $q = PublicInbox::SearchQuery->new($ctx->{qp});
24 # double the limit for expanded views:
33 $mset = $ctx->{srch}->query($q->{'q'}, $opts);
34 $total = $mset->get_matches_estimated;
37 ctx_prepare($q, $ctx);
41 $ctx->{-html_tip} = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
43 } elsif ($total == 0) {
45 $ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
49 return sub { adump($_[0], $mset, $q, $ctx) } if ($x eq 'A');
51 $ctx->{-html_tip} = search_nav_top($mset, $q) . "\n\n";
53 $cb = mset_thread($ctx, $mset, $q);
55 $cb = mset_summary($ctx, $mset, $q);
58 PublicInbox::WwwStream->response($ctx, $code, $cb);
61 # display non-threaded search results similar to what users expect from
62 # regular WWW search engines:
64 my ($ctx, $mset, $q) = @_;
66 my $total = $mset->get_matches_estimated;
67 my $pad = length("$total");
69 my $res = \($ctx->{-html_tip});
70 foreach my $m ($mset->items) {
71 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
72 my $pct = $m->get_percent;
73 my $smsg = PublicInbox::SearchMsg->load_doc($m->get_document);
74 my $s = ascii_html($smsg->subject);
75 my $f = ascii_html($smsg->from_name);
76 my $ts = PublicInbox::View::fmt_ts($smsg->ts);
77 my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->as_href;
78 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
80 $$res .= "$pfx - by $f @ $ts UTC [$pct%]\n\n";
82 $$res .= search_nav_bot($mset, $q);
88 my $u = '//xapian.org/docs/queryparser.html';
89 $u = PublicInbox::Hval::prurl($ctx->{env}, $u);
90 $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
91 $err = ascii_html($err);
92 "\nBad query: <b>$err</b>\n" .
93 qq{See <a\nhref="$u">$u</a> for Xapian query syntax};
99 my $rv = "<pre>Search results ordered by [";
101 my $d = $q->qs_html(r => 0);
102 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
104 my $d = $q->qs_html(r => 1);
105 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
112 my $t = $q->qs_html(x => 't');
113 $rv .= qq{<b>summary</b>|<a\nhref="?$t">threaded</a>}
114 } elsif ($q->{x} eq 't') {
115 my $s = $q->qs_html(x => '');
116 $rv .= qq{<a\nhref="?$s">summary</a>|<b>threaded</b>};
118 my $A = $q->qs_html(x => 'A', r => undef);
119 $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
124 my $total = $mset->get_matches_estimated;
125 my $nr = scalar $mset->items;
129 my $rv = "</pre><hr><pre>Results $beg-$end of $total";
133 my $qs = $q->qs_html(o => $n);
134 $rv .= qq{, <a\nhref="?$qs"\nrel=next>next</a>}
137 $rv .= $n < $total ? '/' : ', ';
139 my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
140 $rv .= qq{<a\nhref="?$qs"\nrel=prev>prev</a>};
146 my ($ctx, $mset, $q) = @_;
150 my $m = PublicInbox::SearchMsg->load_doc($i->get_document);
151 $pct{$m->mid} = $i->get_percent;
156 my $th = PublicInbox::Thread->new(@m);
158 if ($q->{r}) { # order by relevance
160 sort { (eval { $pct{$b->topmost->messageid} } || 0)
162 (eval { $pct{$a->topmost->messageid} } || 0)
165 } else { # order by time (default for threaded view)
166 $th->order(*PublicInbox::View::sort_ts);
168 my $skel = search_nav_bot($mset, $q). "<pre>";
169 my $inbox = $ctx->{-inbox};
171 $ctx->{anchor_idx} = 1;
172 $ctx->{cur_level} = 0;
173 $ctx->{dst} = \$skel;
174 $ctx->{mapping} = {};
176 $ctx->{prev_attr} = '';
177 $ctx->{prev_level} = 0;
179 $ctx->{s_nr} = scalar(@m).'+ results';
181 PublicInbox::View::walk_thread($th, $ctx,
182 *PublicInbox::View::pre_thread);
188 while ($mime = shift @$msgs) {
189 my $mid = mid_clean(mid_mime($mime));
190 $mime = $inbox->msg_by_mid($mid) and last;
193 $mime = Email::MIME->new($mime);
194 return PublicInbox::View::index_entry($mime, $ctx,
204 my $qh = ascii_html($q->{'q'});
205 $ctx->{-q_value_html} = $qh;
206 $ctx->{-atom} = '?'.$q->qs_html(x => 'A', r => undef);
207 $ctx->{-title_html} = "$qh - search results";
209 $extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
210 if (my $x = $q->{x}) {
212 $extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
214 $ctx->{-extra_form_html} = $extra;
218 my ($cb, $mset, $q, $ctx) = @_;
219 my $fh = $cb->([ 200, ['Content-Type' => 'application/atom+xml']]);
220 my $ibx = $ctx->{-inbox};
221 my $feed_opts = PublicInbox::Feed::get_feedopts($ctx);
222 my $x = ascii_html($q->{'q'});
223 $x = qq{$x - search results};
224 $feed_opts->{atomurl} = $feed_opts->{url} . '?'. $q->qs_html;
225 $feed_opts->{url} .= '?'. $q->qs_html(x => undef);
226 $x = PublicInbox::Feed::atom_header($feed_opts, $x);
227 $fh->write($x. PublicInbox::Feed::feed_updated());
230 $x = PublicInbox::SearchMsg->load_doc($_->get_document)->mid;
232 my $s = PublicInbox::Feed::feed_entry($feed_opts, $x, $ibx);
233 $fh->write($s) if defined $s;
235 PublicInbox::Feed::end_feed($fh);
238 package PublicInbox::SearchQuery;
241 use PublicInbox::Hval;
244 my ($class, $qp) = @_;
250 o => (($qp->{o} || '0') =~ /(\d+)/),
251 r => (defined $r && $r ne '0'),
256 my ($self, %over) = @_;
259 my $tmp = bless { %$self }, ref($self);
260 foreach my $k (keys %over) {
261 $tmp->{$k} = $over{$k};
266 my $q = PublicInbox::Hval->new($self->{'q'})->as_href;
267 $q =~ s/%20/+/g; # improve URL readability
270 if (my $o = $self->{o}) { # ignore o == 0
273 if (my $r = $self->{r}) {
276 if (my $x = $self->{x}) {
277 $qs .= "&x=$x" if ($x eq 't' || $x eq 'A');