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::WwwAtomStream;
12 use PublicInbox::MID qw(mid2path mid_mime mid_clean mid_escape);
14 require PublicInbox::Git;
15 require PublicInbox::SearchThread;
22 my $q = PublicInbox::SearchQuery->new($ctx->{qp});
25 # double the limit for expanded views:
34 $mset = $ctx->{srch}->query($q->{'q'}, $opts);
35 $total = $mset->get_matches_estimated;
38 ctx_prepare($q, $ctx);
42 $ctx->{-html_tip} = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
44 } elsif ($total == 0) {
46 $ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
50 return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
52 $ctx->{-html_tip} = search_nav_top($mset, $q) . "\n\n";
54 $cb = mset_thread($ctx, $mset, $q);
56 $cb = mset_summary($ctx, $mset, $q);
59 PublicInbox::WwwStream->response($ctx, $code, $cb);
62 # display non-threaded search results similar to what users expect from
63 # regular WWW search engines:
65 my ($ctx, $mset, $q) = @_;
67 my $total = $mset->get_matches_estimated;
68 my $pad = length("$total");
70 my $res = \($ctx->{-html_tip});
71 foreach my $m ($mset->items) {
72 my $rank = sprintf("%${pad}d", $m->get_rank + 1);
73 my $pct = $m->get_percent;
74 my $smsg = PublicInbox::SearchMsg->load_doc($m->get_document);
75 my $s = ascii_html($smsg->subject);
76 my $f = ascii_html($smsg->from_name);
77 my $ts = PublicInbox::View::fmt_ts($smsg->ts);
78 my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->{href};
79 $$res .= qq{$rank. <b><a\nhref="$mid/">}.
81 $$res .= "$pfx - by $f @ $ts UTC [$pct%]\n\n";
83 $$res .= search_nav_bot($mset, $q);
89 my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
90 $err =~ s/^\s*Exception:\s*//; # bad word to show users :P
91 $err = ascii_html($err);
92 "\nBad query: <b>$err</b>\n" .
93 qq{See <a\nhref="$u">$u</a> for help on using search};
99 my $rv = "<pre>Search results ordered by [";
101 my $d = $q->qs_html(r => 0);
102 $rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
104 my $d = $q->qs_html(r => 1);
105 $rv .= qq{<b>date</b>|<a\nhref="?$d">relevance</a>};
112 my $t = $q->qs_html(x => 't');
113 $rv .= qq{<b>summary</b>|<a\nhref="?$t">threaded</a>}
114 } elsif ($q->{x} eq 't') {
115 my $s = $q->qs_html(x => '');
116 $rv .= qq{<a\nhref="?$s">summary</a>|<b>threaded</b>};
118 my $A = $q->qs_html(x => 'A', r => undef);
119 $rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
124 my $total = $mset->get_matches_estimated;
125 my $nr = scalar $mset->items;
129 my $rv = "</pre><hr><pre>Results $beg-$end of $total";
133 my $qs = $q->qs_html(o => $n);
134 $rv .= qq{, <a\nhref="?$qs"\nrel=next>next</a>}
137 $rv .= $n < $total ? '/' : ', ';
139 my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
140 $rv .= qq{<a\nhref="?$qs"\nrel=prev>prev</a>};
146 my ($ctx, $mset, $q) = @_;
150 my $m = PublicInbox::SearchMsg->load_doc($i->get_document);
151 $pct{$m->mid} = $i->get_percent;
155 my $th = PublicInbox::SearchThread->new(\@m);
157 if ($q->{r}) { # order by relevance
159 [ sort { (eval { $pct{$b->topmost->{id}} } || 0)
161 (eval { $pct{$a->topmost->{id}} } || 0)
164 } else { # order by time (default for threaded view)
165 $th->order(*PublicInbox::View::sort_ts);
167 my $skel = search_nav_bot($mset, $q). "<pre>";
168 my $inbox = $ctx->{-inbox};
170 $ctx->{anchor_idx} = 1;
171 $ctx->{cur_level} = 0;
172 $ctx->{dst} = \$skel;
173 $ctx->{mapping} = {};
175 $ctx->{prev_attr} = '';
176 $ctx->{prev_level} = 0;
178 $ctx->{s_nr} = scalar(@m).'+ results';
180 PublicInbox::View::walk_thread($th, $ctx,
181 *PublicInbox::View::pre_thread);
187 while ($mime = shift @$msgs) {
188 $mime = $inbox->msg_by_smsg($mime) and last;
191 $mime = Email::MIME->new($mime);
192 return PublicInbox::View::index_entry($mime, $ctx,
202 my $qh = ascii_html($q->{'q'});
203 $ctx->{-q_value_html} = $qh;
204 $ctx->{-atom} = '?'.$q->qs_html(x => 'A', r => undef);
205 $ctx->{-title_html} = "$qh - search results";
207 $extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
208 if (my $x = $q->{x}) {
210 $extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
212 $ctx->{-extra_form_html} = $extra;
216 my ($cb, $mset, $q, $ctx) = @_;
217 my $ibx = $ctx->{-inbox};
218 my @items = $mset->items;
219 $ctx->{search_query} = $q;
220 PublicInbox::WwwAtomStream->response($ctx, 200, sub {
221 while (my $x = shift @items) {
222 $x = PublicInbox::SearchMsg->load_doc($x->get_document);
223 $x = $ibx->msg_by_smsg($x) and
224 return Email::MIME->new($x);
230 package PublicInbox::SearchQuery;
233 use PublicInbox::Hval;
234 use PublicInbox::MID qw(mid_escape);
237 my ($class, $qp) = @_;
243 o => (($qp->{o} || '0') =~ /(\d+)/),
244 r => (defined $r && $r ne '0'),
249 my ($self, %over) = @_;
252 my $tmp = bless { %$self }, ref($self);
253 foreach my $k (keys %over) {
254 $tmp->{$k} = $over{$k};
259 my $q = mid_escape($self->{'q'});
260 $q =~ s/%20/+/g; # improve URL readability
263 if (my $o = $self->{o}) { # ignore o == 0
266 if (my $r = $self->{r}) {
269 if (my $x = $self->{x}) {
270 $qs .= "&x=$x" if ($x eq 't' || $x eq 'A');