]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/SearchView.pm
remove Email::Address dependency
[public-inbox.git] / lib / PublicInbox / SearchView.pm
1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
2 # License: AGPLv3 or later (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 warnings;
8 use PublicInbox::SearchMsg;
9 use PublicInbox::Hval qw/ascii_html/;
10 use PublicInbox::View;
11 use PublicInbox::MID qw(mid2path mid_clean mid_mime);
12 use Email::MIME;
13 require PublicInbox::Git;
14 require PublicInbox::Thread;
15 our $LIM = 50;
16
17 sub sres_top_html {
18         my ($ctx) = @_;
19         my $q = PublicInbox::SearchQuery->new($ctx->{cgi});
20         my $code = 200;
21
22         # double the limit for expanded views:
23         my $opts = {
24                 limit => $LIM,
25                 offset => $q->{o},
26                 mset => 1,
27                 relevance => $q->{r},
28         };
29         my ($mset, $total);
30
31         eval {
32                 $mset = $ctx->{srch}->query($q->{q}, $opts);
33                 $total = $mset->get_matches_estimated;
34         };
35         my $err = $@;
36         my $res = html_start($q, $ctx) . '<pre>';
37         if ($err) {
38                 $code = 400;
39                 $res .= err_txt($ctx, $err) . "</pre><hr /><pre>" . foot($ctx);
40         } elsif ($total == 0) {
41                 $code = 404;
42                 $res .= "\n\n[No results found]</pre><hr /><pre>".foot($ctx);
43         } else {
44                 my $x = $q->{x};
45                 return sub { adump($_[0], $mset, $q, $ctx) } if ($x eq 'A');
46
47                 $res .= search_nav_top($mset, $q) . "\n\n";
48                 if ($x eq 't') {
49                         return sub { tdump($_[0], $res, $mset, $q, $ctx) };
50                 }
51                 dump_mset(\$res, $mset);
52                 $res .= '</pre>' . search_nav_bot($mset, $q) .
53                         "\n\n" . foot($ctx);
54         }
55
56         $res .= "</pre></body></html>";
57         [$code, ['Content-Type'=>'text/html; charset=UTF-8'], [$res]];
58 }
59
60 # display non-threaded search results similar to what users expect from
61 # regular WWW search engines:
62 sub dump_mset {
63         my ($res, $mset) = @_;
64
65         my $total = $mset->get_matches_estimated;
66         my $pad = length("$total");
67         my $pfx = ' ' x $pad;
68         foreach my $m ($mset->items) {
69                 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
70                 my $pct = $m->get_percent;
71                 my $smsg = PublicInbox::SearchMsg->load_doc($m->get_document);
72                 my $s = ascii_html($smsg->subject);
73                 my $f = ascii_html($smsg->from_name);
74                 my $ts = PublicInbox::View::fmt_ts($smsg->ts);
75                 my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->as_href;
76                 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
77                         $s . "</a></b>\n";
78                 $$res .= "$pfx  - by $f @ $ts UTC [$pct%]\n\n";
79         }
80 }
81
82 sub err_txt {
83         my ($ctx, $err) = @_;
84         my $u = '//xapian.org/docs/queryparser.html';
85         $u = PublicInbox::Hval::prurl($ctx->{cgi}->{env}, $u);
86         $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
87         $err = ascii_html($err);
88         "\n\nBad query: <b>$err</b>\n" .
89                 qq{See <a\nhref="$u">$u</a> for Xapian query syntax};
90 }
91
92 sub search_nav_top {
93         my ($mset, $q) = @_;
94
95         my $rv = "Search results ordered by [";
96         if ($q->{r}) {
97                 my $d = $q->qs_html(r => 0);
98                 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
99         } else {
100                 my $d = $q->qs_html(r => 1);
101                 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
102         }
103
104         $rv .= ']  view[';
105
106         my $x = $q->{x};
107         if ($x eq '') {
108                 my $t = $q->qs_html(x => 't');
109                 $rv .= qq{<b>summary</b>|<a\nhref="?$t">threaded</a>}
110         } elsif ($q->{x} eq 't') {
111                 my $s = $q->qs_html(x => '');
112                 $rv .= qq{<a\nhref="?$s">summary</a>|<b>threaded</b>};
113         }
114         my $A = $q->qs_html(x => 'A', r => undef);
115         $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
116 }
117
118 sub search_nav_bot {
119         my ($mset, $q) = @_;
120         my $total = $mset->get_matches_estimated;
121         my $nr = scalar $mset->items;
122         my $o = $q->{o};
123         my $end = $o + $nr;
124         my $beg = $o + 1;
125         my $rv = "<hr /><pre>Results $beg-$end of $total";
126         my $n = $o + $LIM;
127
128         if ($n < $total) {
129                 my $qs = $q->qs_html(o => $n);
130                 $rv .= qq{, <a\nhref="?$qs"\nrel=next>next</a>}
131         }
132         if ($o > 0) {
133                 $rv .= $n < $total ? '/' : ',      ';
134                 my $p = $o - $LIM;
135                 my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
136                 $rv .= qq{<a\nhref="?$qs"\nrel=prev>prev</a>};
137         }
138         $rv;
139 }
140
141 sub tdump {
142         my ($cb, $res, $mset, $q, $ctx) = @_;
143         my $fh = $cb->([200, ['Content-Type'=>'text/html; charset=UTF-8']]);
144         $fh->write($res .= '</pre>');
145         my %pct;
146         my @m = map {
147                 my $i = $_;
148                 my $m = PublicInbox::SearchMsg->load_doc($i->get_document);
149                 $pct{$m->mid} = $i->get_percent;
150                 $m = $m->mini_mime;
151                 $m;
152         } ($mset->items);
153
154         my @rootset;
155         my $th = PublicInbox::Thread->new(@m);
156         $th->thread;
157         if ($q->{r}) { # order by relevance
158                 $th->order(sub {
159                         sort { (eval { $pct{$b->topmost->messageid} } || 0)
160                                         <=>
161                                 (eval { $pct{$a->topmost->messageid} } || 0)
162                         } @_;
163                 });
164         } else { # order by time (default for threaded view)
165                 $th->order(*PublicInbox::View::sort_ts);
166         }
167         @rootset = $th->rootset;
168         my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir});
169         my $state = {
170                 ctx => $ctx,
171                 anchor_idx => 0,
172                 pct => \%pct,
173                 cur_level => 0,
174                 fh => $fh,
175         };
176         $ctx->{searchview} = 1;
177         tdump_ent($git, $state, $_, 0) for @rootset;
178         PublicInbox::View::thread_adj_level($state, 0);
179
180         $fh->write(search_nav_bot($mset, $q). "\n\n" .
181                         foot($ctx). '</pre></body></html>');
182
183         $fh->close;
184 }
185
186 sub tdump_ent {
187         my ($git, $state, $node, $level) = @_;
188         return unless $node;
189         my $mime = $node->message;
190
191         if ($mime) {
192                 # lazy load the full message from mini_mime:
193                 my $mid = mid_mime($mime);
194                 $mime = eval {
195                         my $path = mid2path(mid_clean($mid));
196                         Email::MIME->new($git->cat_file('HEAD:'.$path));
197                 };
198         }
199         if ($mime) {
200                 my $end = PublicInbox::View::thread_adj_level($state, $level);
201                 PublicInbox::View::index_entry($mime, $level, $state);
202                 $state->{fh}->write($end) if $end;
203         } else {
204                 my $mid = $node->messageid;
205                 PublicInbox::View::ghost_flush($state, '', $mid, $level);
206         }
207         tdump_ent($git, $state, $node->child, $level + 1);
208         tdump_ent($git, $state, $node->next, $level);
209 }
210
211 sub foot {
212         my ($ctx) = @_;
213         my $foot = $ctx->{footer} || '';
214         qq{Back to <a\nhref=".">index</a>.\n$foot};
215 }
216
217 sub html_start {
218         my ($q, $ctx) = @_;
219         my $qh = ascii_html($q->{'q'});
220         my $A = $q->qs_html(x => 'A', r => undef);
221         my $res = '<html><head>' . PublicInbox::Hval::STYLE .
222                 "<title>$qh - search results</title>" .
223                 qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
224                 qq!href="?$A"\ntype="application/atom+xml"/></head>! .
225                 qq{<body><form\naction="">} .
226                 qq{<input\nname=q\nvalue="$qh"\ntype=text />};
227
228         $res .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
229         if (my $x = $q->{x}) {
230                 $x = ascii_html($x);
231                 $res .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
232         }
233
234         $res .= qq{<input\ntype=submit\nvalue=search /></form>};
235 }
236
237 sub adump {
238         my ($cb, $mset, $q, $ctx) = @_;
239         my $fh = $cb->([ 200, ['Content-Type' => 'application/atom+xml']]);
240         my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir});
241         my $feed_opts = PublicInbox::Feed::get_feedopts($ctx);
242         my $x = ascii_html($q->{'q'});
243         $x = qq{$x - search results};
244         $feed_opts->{atomurl} = $feed_opts->{url} . '?'. $q->qs_html;
245         $feed_opts->{url} .= '?'. $q->qs_html(x => undef);
246         $x = PublicInbox::Feed::atom_header($feed_opts, $x);
247         $fh->write($x. PublicInbox::Feed::feed_updated());
248
249         for ($mset->items) {
250                 $x = PublicInbox::SearchMsg->load_doc($_->get_document)->mid;
251                 $x = mid2path($x);
252                 PublicInbox::Feed::add_to_feed($feed_opts, $fh, $x, $git);
253         }
254         PublicInbox::Feed::end_feed($fh);
255 }
256
257 package PublicInbox::SearchQuery;
258 use strict;
259 use warnings;
260 use PublicInbox::Hval;
261
262 sub new {
263         my ($class, $cgi) = @_;
264         my $r = $cgi->param('r');
265         my ($off) = (($cgi->param('o') || '0') =~ /(\d+)/);
266         bless {
267                 q => $cgi->param('q'),
268                 x => $cgi->param('x') || '',
269                 o => $off,
270                 r => (defined $r && $r ne '0'),
271         }, $class;
272 }
273
274 sub qs_html {
275         my ($self, %over) = @_;
276
277         if (keys %over) {
278                 my $tmp = bless { %$self }, ref($self);
279                 foreach my $k (keys %over) {
280                         $tmp->{$k} = $over{$k};
281                 }
282                 $self = $tmp;
283         }
284
285         my $q = PublicInbox::Hval->new($self->{'q'})->as_href;
286         $q =~ s/%20/+/g; # improve URL readability
287         my $qs = "q=$q";
288
289         if (my $o = $self->{o}) { # ignore o == 0
290                 $qs .= "&amp;o=$o";
291         }
292         if (my $r = $self->{r}) {
293                 $qs .= "&amp;r";
294         }
295         if (my $x = $self->{x}) {
296                 $qs .= "&amp;x=$x" if ($x eq 't' || $x eq 'A');
297         }
298         $qs;
299 }
300
301 1;