1 # Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <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 obfuscate_addrs/;
11 use PublicInbox::View;
12 use PublicInbox::WwwAtomStream;
13 use PublicInbox::MID qw(MID_ESC);
14 use PublicInbox::MIME;
15 require PublicInbox::Git;
16 require PublicInbox::SearchThread;
24 my $q = PublicInbox::SearchQuery->new($ctx->{qp});
26 require PublicInbox::Mbox;
27 return PublicInbox::Mbox::mbox_all($ctx, $q->{'q'}) if $x eq 'm';
33 my $srch = $ctx->{-inbox}->search or
34 return PublicInbox::WWW::need($ctx, 'Search');
35 my $q = PublicInbox::SearchQuery->new($ctx->{qp});
37 my $query = $q->{'q'};
42 $o = -($o + 1); # so [-1] is the last element, like Perl lists
46 # double the limit for expanded views:
54 my ($mset, $total, $err, $cb);
57 $mset = $srch->query($query, $opts);
58 $total = $mset->get_matches_estimated;
61 ctx_prepare($q, $ctx);
64 $ctx->{-html_tip} = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
66 } elsif ($total == 0) {
67 if (defined($ctx->{-uxs_retried})) {
69 $q->{'q'} = $ctx->{-uxs_retried};
70 } elsif (index($q->{'q'}, '%') >= 0) {
71 $ctx->{-uxs_retried} = $q->{'q'};
72 $q->{'q'} = uri_unescape($q->{'q'});
76 $ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
79 return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
81 $ctx->{-html_tip} = search_nav_top($mset, $q, $ctx);
83 $cb = mset_thread($ctx, $mset, $q);
85 $cb = mset_summary($ctx, $mset, $q);
88 PublicInbox::WwwStream->response($ctx, $code, $cb);
91 # display non-nested search results similar to what users expect from
92 # regular WWW search engines:
94 my ($ctx, $mset, $q) = @_;
96 my $total = $mset->get_matches_estimated;
97 my $pad = length("$total");
99 my $res = \($ctx->{-html_tip});
100 my $ibx = $ctx->{-inbox};
101 my $srch = $ibx->search;
102 my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
103 foreach my $m ($mset->items) {
104 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
105 my $pct = get_pct($m);
106 my $smsg = PublicInbox::SearchMsg::from_mitem($m, $srch);
109 $m = "$m ".$m->get_docid . " expired\n";
110 $ctx->{env}->{'psgi.errors'}->print($m);
114 my $s = ascii_html($smsg->subject);
115 my $f = ascii_html($smsg->from_name);
117 obfuscate_addrs($obfs_ibx, $s);
118 obfuscate_addrs($obfs_ibx, $f);
120 my $date = PublicInbox::View::fmt_ts($smsg->ds);
121 my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->{href};
122 $s = '(no subject)' if $s eq '';
123 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
125 $$res .= "$pfx - by $f @ $date UTC [$pct%]\n\n";
127 $$res .= search_nav_bot($mset, $q);
131 # shorten "/full/path/to/Foo/Bar.pm" to "Foo/Bar.pm" so error
132 # messages don't reveal FS layout info in case people use non-standard
136 if (my $short = $rmap_inc{$full}) {
138 } elsif (!scalar(keys %rmap_inc) && -e $full) {
139 %rmap_inc = map {; "$INC{$_}" => $_ } keys %INC;
140 # fall back to basename as last resort
141 $rmap_inc{$full} // (split('/', $full))[-1];
148 my ($ctx, $err) = @_;
149 my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
150 $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
151 $err =~ s!(\S+)!path2inc($1)!sge;
152 $err = ascii_html($err);
153 "\nBad query: <b>$err</b>\n" .
154 qq{See <a\nhref="$u">$u</a> for help on using search};
158 my ($mset, $q, $ctx) = @_;
159 my $m = $q->qs_html(x => 'm', r => undef);
160 my $rv = qq{<form\naction="?$m"\nmethod="post"><pre>};
161 my $initial_q = $ctx->{-uxs_retried};
162 if (defined $initial_q) {
163 my $rewritten = $q->{'q'};
164 utf8::decode($initial_q);
165 utf8::decode($rewritten);
166 $initial_q = ascii_html($initial_q);
167 $rewritten = ascii_html($rewritten);
168 $rv .= " Warning: Initial query:\n <b>$initial_q</b>\n";
169 $rv .= " returned no results, used:\n";
170 $rv .= " <b>$rewritten</b>\n instead\n\n";
173 $rv .= 'Search results ordered by [';
175 my $d = $q->qs_html(r => 0);
176 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
178 my $d = $q->qs_html(r => 1);
179 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
186 my $t = $q->qs_html(x => 't');
187 $rv .= qq{<b>summary</b>|<a\nhref="?$t">nested</a>}
188 } elsif ($q->{x} eq 't') {
189 my $s = $q->qs_html(x => '');
190 $rv .= qq{<a\nhref="?$s">summary</a>|<b>nested</b>};
192 my $A = $q->qs_html(x => 'A', r => undef);
193 $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
194 $rv .= qq{\n\t\t\t\t\t\tdownload: };
195 $rv .= qq{<input\ntype=submit\nvalue="mbox.gz"/></pre></form><pre>};
200 my $total = $mset->get_matches_estimated;
202 my $rv = '</pre><hr><pre id=t>';
204 my $off = $o < 0 ? -($o + 1) : $o;
205 my $end = $off + $mset->size;
209 $rv .= "Results $beg-$end of $total";
210 $rv .= ' (estimated)' if $end != $total;
212 $rv .= "No more results, only $total";
214 my ($next, $join, $prev);
216 if ($o >= 0) { # sort descending
219 $next = $q->qs_html(o => $n, l => $l);
222 $join = $n < $total ? '/' : ' ';
224 $prev = $q->qs_html(o => ($p > 0 ? $p : 0));
226 } else { # o < 0, sort ascending
230 $next = $q->qs_html(o => $n, l => $l);
233 $join = -$n < $total ? '/' : ' ';
235 $prev = $q->qs_html(o => ($p < 0 ? $p : 0));
239 $rv .= qq{ <a\nhref="?$next"\nrel=next>next</a>} if $next;
240 $rv .= $join if $join;
241 $rv .= qq{<a\nhref="?$prev"\nrel=prev>prev</a>} if $prev;
243 my $rev = $q->qs_html(o => $o < 0 ? 0 : -1);
244 $rv .= qq{ | <a\nhref="?$rev">reverse results</a></pre>};
249 (eval { $b->topmost->{smsg}->{pct} } // 0) <=>
250 (eval { $a->topmost->{smsg}->{pct} } // 0)
255 # Capped at "99%" since "100%" takes an extra column in the
256 # thread skeleton view. <xapian/mset.h> says the value isn't
257 # very meaningful, anyways.
258 my $n = $_[0]->get_percent;
266 my $smsg = PublicInbox::SearchMsg::from_mitem($mi);
267 $smsg->{pct} = get_pct($mi);
273 my ($ctx, $mset, $q) = @_;
274 my $msgs = $ctx->{-inbox}->search->retry_reopen(\&load_msgs, $mset);
276 my $rootset = PublicInbox::SearchThread::thread($msgs,
277 $r ? \&sort_relevance : \&PublicInbox::View::sort_ds,
279 my $skel = search_nav_bot($mset, $q). "<pre>";
281 $ctx->{anchor_idx} = 1;
282 $ctx->{cur_level} = 0;
283 $ctx->{dst} = \$skel;
284 $ctx->{mapping} = {};
285 $ctx->{searchview} = 1;
286 $ctx->{prev_attr} = '';
287 $ctx->{prev_level} = 0;
288 $ctx->{s_nr} = scalar(@$msgs).'+ results';
290 # reduce hash lookups in skel_dump
291 $ctx->{-obfuscate} = $ctx->{-inbox}->{obfuscate};
292 PublicInbox::View::walk_thread($rootset, $ctx,
293 *PublicInbox::View::pre_thread);
295 @$msgs = reverse @$msgs if $r;
296 $ctx->{msgs} = $msgs;
300 # callback for PublicInbox::WwwStream::getline
303 my $msgs = $ctx->{msgs} or return;
304 while (my $smsg = pop @$msgs) {
305 $ctx->{-inbox}->smsg_mime($smsg) or next;
306 return PublicInbox::View::index_entry($smsg, $ctx,
309 my ($skel) = delete @$ctx{qw(dst msgs)};
310 $$skel .= "\n</pre>";
317 $qh = ascii_html($qh);
318 $ctx->{-q_value_html} = $qh;
319 $ctx->{-atom} = '?'.$q->qs_html(x => 'A', r => undef);
320 $ctx->{-title_html} = "$qh - search results";
322 $extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
323 if (my $x = $q->{x}) {
325 $extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
327 $ctx->{-extra_form_html} = $extra;
331 my ($cb, $mset, $q, $ctx) = @_;
332 $ctx->{items} = [ $mset->items ];
333 $ctx->{search_query} = $q; # used by WwwAtomStream::atom_header
334 $ctx->{srch} = $ctx->{-inbox}->search;
335 PublicInbox::WwwAtomStream->response($ctx, 200, \&adump_i);
338 # callback for PublicInbox::WwwAtomStream::getline
341 while (my $mi = shift @{$ctx->{items}}) {
343 PublicInbox::SearchMsg::from_mitem($mi, $ctx->{srch});
345 $ctx->{-inbox}->smsg_mime($smsg) and return $smsg;
349 package PublicInbox::SearchQuery;
352 use URI::Escape qw(uri_escape);
353 use PublicInbox::Hval;
354 use PublicInbox::MID qw(MID_ESC);
357 my ($class, $qp) = @_;
360 my ($l) = (($qp->{l} || '') =~ /([0-9]+)/);
361 $l = $LIM if !$l || $l > $LIM;
365 o => (($qp->{o} || '0') =~ /(-?[0-9]+)/),
367 r => (defined $r && $r ne '0'),
372 my ($self, %over) = @_;
375 my $tmp = bless { %$self }, ref($self);
376 foreach my $k (keys %over) {
377 $tmp->{$k} = $over{$k};
382 my $q = uri_escape($self->{'q'}, MID_ESC);
383 $q =~ s/%20/+/g; # improve URL readability
386 if (my $o = $self->{o}) { # ignore o == 0
389 if (my $l = $self->{l}) {
390 $qs .= "&l=$l" unless $l == $LIM;
392 if (my $r = $self->{r}) {
395 if (my $x = $self->{x}) {
396 $qs .= "&x=$x" if ($x eq 't' || $x eq 'A' || $x eq 'm');