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