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_clean mid_mime);
13 require PublicInbox::Git;
14 require PublicInbox::Thread;
19 my $q = PublicInbox::SearchQuery->new($ctx->{cgi});
22 # double the limit for expanded views:
32 $mset = $ctx->{srch}->query($q->{q}, $opts);
33 $total = $mset->get_matches_estimated;
36 my $res = html_start($q, $ctx) . '<pre>';
39 $res .= err_txt($ctx, $err) . "</pre><hr /><pre>" . foot($ctx);
40 } elsif ($total == 0) {
42 $res .= "\n\n[No results found]</pre><hr /><pre>".foot($ctx);
45 return sub { adump($_[0], $mset, $q, $ctx) } if ($x eq 'A');
47 $res .= search_nav_top($mset, $q) . "\n\n";
49 return sub { tdump($_[0], $res, $mset, $q, $ctx) };
51 dump_mset(\$res, $mset);
52 $res .= '</pre>' . search_nav_bot($mset, $q) .
56 $res .= "</pre></body></html>";
57 [$code, ['Content-Type'=>'text/html; charset=UTF-8'], [$res]];
60 # display non-threaded search results similar to what users expect from
61 # regular WWW search engines:
63 my ($res, $mset) = @_;
65 my $total = $mset->get_matches_estimated;
66 my $pad = length("$total");
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/">}.
78 $$res .= "$pfx - by $f @ $ts UTC [$pct%]\n\n";
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};
95 my $rv = "Search results ordered by [";
97 my $d = $q->qs_html(r => 0);
98 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
100 my $d = $q->qs_html(r => 1);
101 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
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>};
114 my $A = $q->qs_html(x => 'A', r => undef);
115 $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
120 my $total = $mset->get_matches_estimated;
121 my $nr = scalar $mset->items;
125 my $rv = "<hr /><pre>Results $beg-$end of $total";
129 my $qs = $q->qs_html(o => $n);
130 $rv .= qq{, <a\nhref="?$qs"\nrel=next>next</a>}
133 $rv .= $n < $total ? '/' : ', ';
135 my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
136 $rv .= qq{<a\nhref="?$qs"\nrel=prev>prev</a>};
142 my ($cb, $res, $mset, $q, $ctx) = @_;
143 my $fh = $cb->([200, ['Content-Type'=>'text/html; charset=UTF-8']]);
144 $fh->write($res .= '</pre>');
148 my $m = PublicInbox::SearchMsg->load_doc($i->get_document);
149 $pct{$m->mid} = $i->get_percent;
155 my $th = PublicInbox::Thread->new(@m);
157 if ($q->{r}) { # order by relevance
159 sort { (eval { $pct{$b->topmost->messageid} } || 0)
161 (eval { $pct{$a->topmost->messageid} } || 0)
164 } else { # order by time (default for threaded view)
165 $th->order(*PublicInbox::View::sort_ts);
167 @rootset = $th->rootset;
168 my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir});
176 $ctx->{searchview} = 1;
177 tdump_ent($git, $state, $_, 0) for @rootset;
178 PublicInbox::View::thread_adj_level($state, 0);
180 $fh->write(search_nav_bot($mset, $q). "\n\n" .
181 foot($ctx). '</pre></body></html>');
187 my ($git, $state, $node, $level) = @_;
189 my $mime = $node->message;
192 # lazy load the full message from mini_mime:
193 my $mid = mid_mime($mime);
195 my $path = mid2path(mid_clean($mid));
196 Email::MIME->new($git->cat_file('HEAD:'.$path));
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;
204 my $mid = $node->messageid;
205 PublicInbox::View::ghost_flush($state, '', $mid, $level);
207 tdump_ent($git, $state, $node->child, $level + 1);
208 tdump_ent($git, $state, $node->next, $level);
213 my $foot = $ctx->{footer} || '';
214 qq{Back to <a\nhref=".">index</a>.\n$foot};
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 />};
228 $res .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
229 if (my $x = $q->{x}) {
231 $res .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
234 $res .= qq{<input\ntype=submit\nvalue=search /></form>};
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());
250 $x = PublicInbox::SearchMsg->load_doc($_->get_document)->mid;
252 PublicInbox::Feed::add_to_feed($feed_opts, $fh, $x, $git);
254 PublicInbox::Feed::end_feed($fh);
257 package PublicInbox::SearchQuery;
260 use PublicInbox::Hval;
263 my ($class, $cgi) = @_;
264 my $r = $cgi->param('r');
265 my ($off) = (($cgi->param('o') || '0') =~ /(\d+)/);
267 q => $cgi->param('q'),
268 x => $cgi->param('x') || '',
270 r => (defined $r && $r ne '0'),
275 my ($self, %over) = @_;
278 my $tmp = bless { %$self }, ref($self);
279 foreach my $k (keys %over) {
280 $tmp->{$k} = $over{$k};
285 my $q = PublicInbox::Hval->new($self->{'q'})->as_href;
286 $q =~ s/%20/+/g; # improve URL readability
289 if (my $o = $self->{o}) { # ignore o == 0
292 if (my $r = $self->{r}) {
295 if (my $x = $self->{x}) {
296 $qs .= "&x=$x" if ($x eq 't' || $x eq 'A');