]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/SearchView.pm
imaptracker: preserve WAL journal_mode if set by user
[public-inbox.git] / lib / PublicInbox / SearchView.pm
1 # Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 #
4 # Displays search results for the web interface
5 package PublicInbox::SearchView;
6 use strict;
7 use v5.10.1;
8 use URI::Escape qw(uri_unescape);
9 use PublicInbox::Smsg;
10 use PublicInbox::Hval qw(ascii_html obfuscate_addrs mid_href);
11 use PublicInbox::View;
12 use PublicInbox::WwwAtomStream;
13 use PublicInbox::WwwStream qw(html_oneshot);
14 use PublicInbox::SearchThread;
15 use PublicInbox::SearchQuery;
16 use PublicInbox::Search qw(mdocid);
17 my %rmap_inc;
18
19 sub mbox_results {
20         my ($ctx) = @_;
21         my $q = PublicInbox::SearchQuery->new($ctx->{qp});
22         if ($ctx->{env}->{'psgi.input'}->read(my $buf, 3)) {
23                 $q->{t} = 1 if $buf =~ /\Ax=[^0]/;
24         }
25         require PublicInbox::Mbox;
26         $q->{x} eq 'm' ? PublicInbox::Mbox::mbox_all($ctx, $q) :
27                         sres_top_html($ctx);
28 }
29
30 sub sres_top_html {
31         my ($ctx) = @_;
32         my $srch = $ctx->{-inbox}->search or
33                 return PublicInbox::WWW::need($ctx, 'Search');
34         my $q = PublicInbox::SearchQuery->new($ctx->{qp});
35         my $x = $q->{x};
36         my $query = $q->{'q'};
37         my $o = $q->{o};
38         my $asc;
39         if ($o < 0) {
40                 $asc = 1;
41                 $o = -($o + 1); # so [-1] is the last element, like Perl lists
42         }
43
44         my $code = 200;
45         # double the limit for expanded views:
46         my $opts = {
47                 limit => $q->{l},
48                 offset => $o,
49                 mset => 1,
50                 relevance => $q->{r},
51                 thread => $q->{t},
52                 asc => $asc,
53         };
54         my ($mset, $total, $err, $html);
55 retry:
56         eval {
57                 $mset = $srch->query($query, $opts);
58                 $total = $mset->get_matches_estimated;
59         };
60         $err = $@;
61         ctx_prepare($q, $ctx);
62         if ($err) {
63                 $code = 400;
64                 $html = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
65         } elsif ($total == 0) {
66                 if (defined($ctx->{-uxs_retried})) {
67                         # undo retry damage:
68                         $q->{'q'} = $ctx->{-uxs_retried};
69                 } elsif (index($q->{'q'}, '%') >= 0) {
70                         $ctx->{-uxs_retried} = $q->{'q'};
71                         $q->{'q'} = uri_unescape($q->{'q'});
72                         goto retry;
73                 }
74                 $code = 404;
75                 $html = "<pre>\n[No results found]</pre><hr>";
76         } else {
77                 return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
78
79                 $ctx->{-html_tip} = search_nav_top($mset, $q, $ctx);
80                 return mset_thread($ctx, $mset, $q) if $x eq 't';
81                 mset_summary($ctx, $mset, $q); # appends to {-html_tip}
82                 $html = '';
83         }
84         html_oneshot($ctx, $code);
85 }
86
87 # display non-nested search results similar to what users expect from
88 # regular WWW search engines:
89 sub mset_summary {
90         my ($ctx, $mset, $q) = @_;
91
92         my $total = $mset->get_matches_estimated;
93         my $pad = length("$total");
94         my $pfx = ' ' x $pad;
95         my $res = \($ctx->{-html_tip});
96         my $ibx = $ctx->{-inbox};
97         my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
98         my @nums = @{$ibx->search->mset_to_artnums($mset)};
99         my %num2msg = map { $_->{num} => $_ } @{$ibx->over->get_all(@nums)};
100
101         foreach my $m ($mset->items) {
102                 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
103                 my $pct = get_pct($m);
104                 my $num = shift @nums;
105                 my $smsg = delete($num2msg{$num}) or do {
106                         eval {
107                                 $m = "$m $num expired\n";
108                                 $ctx->{env}->{'psgi.errors'}->print($m);
109                         };
110                         next;
111                 };
112                 my $s = ascii_html($smsg->{subject});
113                 my $f = ascii_html($smsg->{from_name});
114                 if ($obfs_ibx) {
115                         obfuscate_addrs($obfs_ibx, $s);
116                         obfuscate_addrs($obfs_ibx, $f);
117                 }
118                 my $date = PublicInbox::View::fmt_ts($smsg->{ds});
119                 my $mid = mid_href($smsg->{mid});
120                 $s = '(no subject)' if $s eq '';
121                 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
122                         $s . "</a></b>\n";
123                 $$res .= "$pfx  - by $f @ $date UTC [$pct%]\n\n";
124         }
125         $$res .= search_nav_bot($mset, $q);
126         undef;
127 }
128
129 # shorten "/full/path/to/Foo/Bar.pm" to "Foo/Bar.pm" so error
130 # messages don't reveal FS layout info in case people use non-standard
131 # installation paths
132 sub path2inc ($) {
133         my $full = $_[0];
134         if (my $short = $rmap_inc{$full}) {
135                 return $short;
136         } elsif (!scalar(keys %rmap_inc) && -e $full) {
137                 %rmap_inc = map {; "$INC{$_}" => $_ } keys %INC;
138                 # fall back to basename as last resort
139                 $rmap_inc{$full} // (split('/', $full))[-1];
140         } else {
141                 $full;
142         }
143 }
144
145 sub err_txt {
146         my ($ctx, $err) = @_;
147         my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
148         $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
149         $err =~ s!(\S+)!path2inc($1)!sge;
150         $err = ascii_html($err);
151         "\nBad query: <b>$err</b>\n" .
152                 qq{See <a\nhref="$u">$u</a> for help on using search};
153 }
154
155 sub search_nav_top {
156         my ($mset, $q, $ctx) = @_;
157         my $m = $q->qs_html(x => 'm', r => undef, t => undef);
158         my $rv = qq{<form\naction="?$m"\nmethod="post"><pre>};
159         my $initial_q = $ctx->{-uxs_retried};
160         if (defined $initial_q) {
161                 my $rewritten = $q->{'q'};
162                 utf8::decode($initial_q);
163                 utf8::decode($rewritten);
164                 $initial_q = ascii_html($initial_q);
165                 $rewritten = ascii_html($rewritten);
166                 $rv .= " Warning: Initial query:\n <b>$initial_q</b>\n";
167                 $rv .= " returned no results, used:\n";
168                 $rv .= " <b>$rewritten</b>\n instead\n\n";
169         }
170
171         $rv .= 'Search results ordered by [';
172         if ($q->{r}) {
173                 my $d = $q->qs_html(r => 0);
174                 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
175         } else {
176                 my $d = $q->qs_html(r => 1);
177                 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
178         }
179
180         $rv .= ']  view[';
181
182         my $x = $q->{x};
183         if ($x eq '') {
184                 my $t = $q->qs_html(x => 't');
185                 $rv .= qq{<b>summary</b>|<a\nhref="?$t">nested</a>}
186         } elsif ($q->{x} eq 't') {
187                 my $s = $q->qs_html(x => '');
188                 $rv .= qq{<a\nhref="?$s">summary</a>|<b>nested</b>};
189         }
190         my $A = $q->qs_html(x => 'A', r => undef);
191         $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
192         if ($ctx->{-inbox}->search->has_threadid) {
193                 $rv .= qq{\n\t\t\tdownload mbox.gz: } .
194                         # we set name=z w/o using it since it seems required for
195                         # lynx (but works fine for w3m).
196                         qq{<input\ntype=submit\nname=z\n} .
197                                 q{value="results only"/>} .
198                         qq{|<input\ntype=submit\nname=x\n} .
199                                 q{value="full threads"/>};
200         } else { # BOFH needs to --reindex
201                 $rv .= qq{\n\t\t\t\t\t\tdownload: } .
202                         qq{<input\ntype=submit\nname=z\nvalue="mbox.gz"/>}
203         }
204         $rv .= qq{</pre></form><pre>};
205 }
206
207 sub search_nav_bot {
208         my ($mset, $q) = @_;
209         my $total = $mset->get_matches_estimated;
210         my $l = $q->{l};
211         my $rv = '</pre><hr><pre id=t>';
212         my $o = $q->{o};
213         my $off = $o < 0 ? -($o + 1) : $o;
214         my $end = $off + $mset->size;
215         my $beg = $off + 1;
216
217         if ($beg <= $end) {
218                 $rv .= "Results $beg-$end of $total";
219                 $rv .= ' (estimated)' if $end != $total;
220         } else {
221                 $rv .= "No more results, only $total";
222         }
223         my ($next, $join, $prev);
224
225         if ($o >= 0) { # sort descending
226                 my $n = $o + $l;
227                 if ($n < $total) {
228                         $next = $q->qs_html(o => $n, l => $l);
229                 }
230                 if ($o > 0) {
231                         $join = $n < $total ? '/' : '       ';
232                         my $p = $o - $l;
233                         $prev = $q->qs_html(o => ($p > 0 ? $p : 0));
234                 }
235         } else { # o < 0, sort ascending
236                 my $n = $o - $l;
237
238                 if (-$n < $total) {
239                         $next = $q->qs_html(o => $n, l => $l);
240                 }
241                 if ($o < -1) {
242                         $join = -$n < $total ? '/' : '       ';
243                         my $p = $o + $l;
244                         $prev = $q->qs_html(o => ($p < 0 ? $p : 0));
245                 }
246         }
247
248         $rv .= qq{  <a\nhref="?$next"\nrel=next>next</a>} if $next;
249         $rv .= $join if $join;
250         $rv .= qq{<a\nhref="?$prev"\nrel=prev>prev</a>} if $prev;
251
252         my $rev = $q->qs_html(o => $o < 0 ? 0 : -1);
253         $rv .= qq{ | <a\nhref="?$rev">reverse results</a></pre>};
254 }
255
256 sub sort_relevance {
257         [ sort {
258                 (eval { $b->topmost->{pct} } // 0) <=>
259                 (eval { $a->topmost->{pct} } // 0)
260         } @{$_[0]} ]
261 }
262
263 sub get_pct ($) {
264         # Capped at "99%" since "100%" takes an extra column in the
265         # thread skeleton view.  <xapian/mset.h> says the value isn't
266         # very meaningful, anyways.
267         my $n = $_[0]->get_percent;
268         $n > 99 ? 99 : $n;
269 }
270
271 sub mset_thread {
272         my ($ctx, $mset, $q) = @_;
273         my $ibx = $ctx->{-inbox};
274         my $nshard = $ibx->search->{nshard} // 1;
275         my %pct = map { mdocid($nshard, $_) => get_pct($_) } $mset->items;
276         my $msgs = $ibx->over->get_all(keys %pct);
277         $_->{pct} = $pct{$_->{num}} for @$msgs;
278         my $r = $q->{r};
279         my $rootset = PublicInbox::SearchThread::thread($msgs,
280                 $r ? \&sort_relevance : \&PublicInbox::View::sort_ds,
281                 $ctx);
282         my $skel = search_nav_bot($mset, $q). "<pre>";
283         $ctx->{-upfx} = '';
284         $ctx->{anchor_idx} = 1;
285         $ctx->{cur_level} = 0;
286         $ctx->{skel} = \$skel;
287         $ctx->{mapping} = {};
288         $ctx->{searchview} = 1;
289         $ctx->{prev_attr} = '';
290         $ctx->{prev_level} = 0;
291         $ctx->{s_nr} = scalar(@$msgs).'+ results';
292
293         # reduce hash lookups in skel_dump
294         $ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
295         PublicInbox::View::walk_thread($rootset, $ctx,
296                 \&PublicInbox::View::pre_thread);
297
298         @$msgs = reverse @$msgs if $r;
299         $ctx->{msgs} = $msgs;
300         PublicInbox::WwwStream::aresponse($ctx, 200, \&mset_thread_i);
301 }
302
303 # callback for PublicInbox::WwwStream::getline
304 sub mset_thread_i {
305         my ($ctx, $eml) = @_;
306         $ctx->zmore($ctx->html_top) if exists $ctx->{-html_tip};
307         $eml and return PublicInbox::View::eml_entry($ctx, $eml);
308         my $smsg = shift @{$ctx->{msgs}} or
309                 $ctx->zmore(${delete($ctx->{skel})});
310         $smsg;
311 }
312
313 sub ctx_prepare {
314         my ($q, $ctx) = @_;
315         my $qh = $q->{'q'};
316         utf8::decode($qh);
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";
321         my $extra = '';
322         $extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
323         if (my $x = $q->{x}) {
324                 $x = ascii_html($x);
325                 $extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
326         }
327         $ctx->{-extra_form_html} = $extra;
328 }
329
330 sub adump {
331         my ($cb, $mset, $q, $ctx) = @_;
332         $ctx->{ids} = $ctx->{-inbox}->search->mset_to_artnums($mset);
333         $ctx->{search_query} = $q; # used by WwwAtomStream::atom_header
334         PublicInbox::WwwAtomStream->response($ctx, 200, \&adump_i);
335 }
336
337 # callback for PublicInbox::WwwAtomStream::getline
338 sub adump_i {
339         my ($ctx) = @_;
340         while (my $num = shift @{$ctx->{ids}}) {
341                 my $smsg = eval { $ctx->{-inbox}->over->get_art($num) } or next;
342                 return $smsg;
343         }
344 }
345
346 1;