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 URI::Escape qw(uri_unescape uri_escape);
9 use PublicInbox::SearchMsg;
10 use PublicInbox::Hval qw/ascii_html/;
11 use PublicInbox::View;
12 use PublicInbox::WwwAtomStream;
13 use PublicInbox::MID qw(mid2path mid_mime mid_clean mid_escape MID_ESC);
14 use PublicInbox::MIME;
15 require PublicInbox::Git;
16 require PublicInbox::SearchThread;
23 my $q = PublicInbox::SearchQuery->new($ctx->{qp});
26 # double the limit for expanded views:
33 my ($mset, $total, $err, $cb);
36 $mset = $ctx->{srch}->query($q->{'q'}, $opts);
37 $total = $mset->get_matches_estimated;
40 ctx_prepare($q, $ctx);
43 $ctx->{-html_tip} = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
45 } elsif ($total == 0) {
46 if (defined($ctx->{-uxs_retried})) {
48 $q->{'q'} = $ctx->{-uxs_retried};
49 } elsif (index($q->{'q'}, '%') >= 0) {
50 $ctx->{-uxs_retried} = $q->{'q'};
51 $q->{'q'} = uri_unescape($q->{'q'});
55 $ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
59 return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
61 $ctx->{-html_tip} = search_nav_top($mset, $q, $ctx) . "\n\n";
63 $cb = mset_thread($ctx, $mset, $q);
65 $cb = mset_summary($ctx, $mset, $q);
68 PublicInbox::WwwStream->response($ctx, $code, $cb);
71 # allow undef for individual doc loads...
73 my ($srch, $mitem) = @_;
76 $srch->retry_reopen(sub {
77 PublicInbox::SearchMsg->load_doc($mitem->get_document)
82 # display non-threaded search results similar to what users expect from
83 # regular WWW search engines:
85 my ($ctx, $mset, $q) = @_;
87 my $total = $mset->get_matches_estimated;
88 my $pad = length("$total");
90 my $res = \($ctx->{-html_tip});
91 my $srch = $ctx->{srch};
92 foreach my $m ($mset->items) {
93 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
94 my $pct = $m->get_percent;
95 my $smsg = load_doc_retry($srch, $m);
98 $m = "$m ".$m->get_docid . " expired\n";
99 $ctx->{env}->{'psgi.errors'}->print($m);
103 my $s = ascii_html($smsg->subject);
104 my $f = ascii_html($smsg->from_name);
105 my $ts = PublicInbox::View::fmt_ts($smsg->ts);
106 my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->{href};
107 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
109 $$res .= "$pfx - by $f @ $ts UTC [$pct%]\n\n";
111 $$res .= search_nav_bot($mset, $q);
116 my ($ctx, $err) = @_;
117 my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
118 $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
119 $err = ascii_html($err);
120 "\nBad query: <b>$err</b>\n" .
121 qq{See <a\nhref="$u">$u</a> for help on using search};
125 my ($mset, $q, $ctx) = @_;
128 my $initial_q = $ctx->{-uxs_retried};
129 if (defined $initial_q) {
130 my $rewritten = $q->{'q'};
131 utf8::decode($initial_q);
132 utf8::decode($rewritten);
133 $initial_q = ascii_html($initial_q);
134 $rewritten = ascii_html($rewritten);
135 $rv .= " Warning: Initial query:\n <b>$initial_q</b>\n";
136 $rv .= " returned no results, used:\n";
137 $rv .= " <b>$rewritten</b>\n instead\n\n";
140 $rv .= 'Search results ordered by [';
142 my $d = $q->qs_html(r => 0);
143 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
145 my $d = $q->qs_html(r => 1);
146 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
153 my $t = $q->qs_html(x => 't');
154 $rv .= qq{<b>summary</b>|<a\nhref="?$t">threaded</a>}
155 } elsif ($q->{x} eq 't') {
156 my $s = $q->qs_html(x => '');
157 $rv .= qq{<a\nhref="?$s">summary</a>|<b>threaded</b>};
159 my $A = $q->qs_html(x => 'A', r => undef);
160 $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
165 my $total = $mset->get_matches_estimated;
166 my $nr = scalar $mset->items;
170 my $rv = '</pre><hr><pre id=t>';
172 $rv .= "Results $beg-$end of $total";
173 $rv .= ' (estimated)' if $end != $total;
175 $rv .= "No more results, only $total";
180 my $qs = $q->qs_html(o => $n);
181 $rv .= qq{ <a\nhref="?$qs"\nrel=next>next</a>}
184 $rv .= $n < $total ? '/' : ' ';
186 my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
187 $rv .= qq{<a\nhref="?$qs"\nrel=prev>prev</a>};
195 [ sort { (eval { $pct->{$b->topmost->{id}} } || 0)
197 (eval { $pct->{$a->topmost->{id}} } || 0)
202 my ($ctx, $mset, $q) = @_;
204 my $msgs = $ctx->{srch}->retry_reopen(sub { [ map {
206 my $smsg = PublicInbox::SearchMsg->load_doc($i->get_document);
207 $pct{$smsg->mid} = $i->get_percent;
209 } ($mset->items) ]});
211 my $rootset = PublicInbox::SearchThread::thread($msgs,
212 $r ? sort_relevance(\%pct) : *PublicInbox::View::sort_ts);
213 my $skel = search_nav_bot($mset, $q). "<pre>";
214 my $inbox = $ctx->{-inbox};
216 $ctx->{anchor_idx} = 1;
217 $ctx->{cur_level} = 0;
218 $ctx->{dst} = \$skel;
219 $ctx->{mapping} = {};
221 $ctx->{prev_attr} = '';
222 $ctx->{prev_level} = 0;
224 $ctx->{s_nr} = scalar(@$msgs).'+ results';
226 PublicInbox::View::walk_thread($rootset, $ctx,
227 *PublicInbox::View::pre_thread);
228 @$msgs = reverse @$msgs if $r;
232 while ($mime = pop @$msgs) {
233 $mime = $inbox->msg_by_smsg($mime) and last;
236 $mime = PublicInbox::MIME->new($mime);
237 return PublicInbox::View::index_entry($mime, $ctx,
249 $qh = ascii_html($qh);
250 $ctx->{-q_value_html} = $qh;
251 $ctx->{-atom} = '?'.$q->qs_html(x => 'A', r => undef);
252 $ctx->{-title_html} = "$qh - search results";
254 $extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
255 if (my $x = $q->{x}) {
257 $extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
259 $ctx->{-extra_form_html} = $extra;
263 my ($cb, $mset, $q, $ctx) = @_;
264 my $ibx = $ctx->{-inbox};
265 my @items = $mset->items;
266 $ctx->{search_query} = $q;
267 my $srch = $ctx->{srch};
268 PublicInbox::WwwAtomStream->response($ctx, 200, sub {
269 while (my $x = shift @items) {
270 $x = load_doc_retry($srch, $x);
271 $x = $ibx->msg_by_smsg($x) and
272 return PublicInbox::MIME->new($x);
278 package PublicInbox::SearchQuery;
281 use URI::Escape qw(uri_escape);
282 use PublicInbox::Hval;
283 use PublicInbox::MID qw(MID_ESC);
286 my ($class, $qp) = @_;
292 o => (($qp->{o} || '0') =~ /(\d+)/),
293 r => (defined $r && $r ne '0'),
298 my ($self, %over) = @_;
301 my $tmp = bless { %$self }, ref($self);
302 foreach my $k (keys %over) {
303 $tmp->{$k} = $over{$k};
308 my $q = uri_escape($self->{'q'}, MID_ESC);
309 $q =~ s/%20/+/g; # improve URL readability
312 if (my $o = $self->{o}) { # ignore o == 0
315 if (my $r = $self->{r}) {
318 if (my $x = $self->{x}) {
319 $qs .= "&x=$x" if ($x eq 't' || $x eq 'A');