X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FSearchView.pm;h=0d2e71fda534d4819ae23813516d4df9b74f7c45;hb=55b707d788ce13696e4411389583e720ea6dab01;hp=b65351aa18b5250b4fb3a96cd55e39f22e776d57;hpb=d6089bc6728e6dc03640b312f097fe8328e8992e;p=public-inbox.git

diff --git a/lib/PublicInbox/SearchView.pm b/lib/PublicInbox/SearchView.pm
index b65351aa..0d2e71fd 100644
--- a/lib/PublicInbox/SearchView.pm
+++ b/lib/PublicInbox/SearchView.pm
@@ -1,93 +1,173 @@
-# Copyright (C) 2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+#
+# Displays search results for the web interface
 package PublicInbox::SearchView;
 use strict;
 use warnings;
+use URI::Escape qw(uri_unescape uri_escape);
 use PublicInbox::SearchMsg;
-use PublicInbox::Hval;
+use PublicInbox::Hval qw/ascii_html obfuscate_addrs/;
 use PublicInbox::View;
-use PublicInbox::MID qw(mid2path mid_clean);
-use Email::MIME;
-use POSIX qw/strftime/;
-our $LIM = 50;
+use PublicInbox::WwwAtomStream;
+use PublicInbox::SearchThread;
+our $LIM = 200;
+my %rmap_inc;
+
+sub noop {}
+
+sub mbox_results {
+	my ($ctx) = @_;
+	my $q = PublicInbox::SearchQuery->new($ctx->{qp});
+	my $x = $q->{x};
+	require PublicInbox::Mbox;
+	return PublicInbox::Mbox::mbox_all($ctx, $q->{'q'}) if $x eq 'm';
+	sres_top_html($ctx);
+}
 
 sub sres_top_html {
 	my ($ctx) = @_;
-	my $q = PublicInbox::SearchQuery->new($ctx->{cgi});
-	my $code = 200;
+	my $srch = $ctx->{-inbox}->search or
+		return PublicInbox::WWW::need($ctx, 'Search');
+	my $q = PublicInbox::SearchQuery->new($ctx->{qp});
+	my $x = $q->{x};
+	my $query = $q->{'q'};
+	my $o = $q->{o};
+	my $asc;
+	if ($o < 0) {
+		$asc = 1;
+		$o = -($o + 1); # so [-1] is the last element, like Perl lists
+	}
 
+	my $code = 200;
 	# double the limit for expanded views:
 	my $opts = {
-		limit => $LIM,
-		offset => $q->{o},
+		limit => $q->{l},
+		offset => $o,
 		mset => 1,
 		relevance => $q->{r},
+		asc => $asc,
 	};
-	my ($mset, $total);
-
+	my ($mset, $total, $err, $cb);
+retry:
 	eval {
-		$mset = $ctx->{srch}->query($q->{q}, $opts);
+		$mset = $srch->query($query, $opts);
 		$total = $mset->get_matches_estimated;
 	};
-	my $err = $@;
-	my $res = html_start($q, $ctx) . PublicInbox::View::PRE_WRAP;
+	$err = $@;
+	ctx_prepare($q, $ctx);
 	if ($err) {
 		$code = 400;
-		$res .= err_txt($err) . "</pre><hr /><pre>" . foot($ctx);
+		$ctx->{-html_tip} = '<pre>'.err_txt($ctx, $err).'</pre><hr>';
+		$cb = *noop;
 	} elsif ($total == 0) {
+		if (defined($ctx->{-uxs_retried})) {
+			# undo retry damage:
+			$q->{'q'} = $ctx->{-uxs_retried};
+		} elsif (index($q->{'q'}, '%') >= 0) {
+			$ctx->{-uxs_retried} = $q->{'q'};
+			$q->{'q'} = uri_unescape($q->{'q'});
+			goto retry;
+		}
 		$code = 404;
-		$res .= "\n\n[No results found]</pre><hr /><pre>".foot($ctx);
+		$ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
+		$cb = *noop;
 	} else {
-		my $x = $q->{x};
-		return sub { adump($_[0], $mset, $q, $ctx) } if ($x eq 'A');
+		return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
 
-		$res .= search_nav_top($mset, $q);
+		$ctx->{-html_tip} = search_nav_top($mset, $q, $ctx);
 		if ($x eq 't') {
-			return sub { tdump($_[0], $res, $mset, $q, $ctx) };
+			$cb = mset_thread($ctx, $mset, $q);
+		} else {
+			$cb = mset_summary($ctx, $mset, $q);
 		}
-		$res .= "\n\n";
-		dump_mset(\$res, $mset);
-		$res .= search_nav_bot($mset, $q) . "\n\n" . foot($ctx);
 	}
-
-	$res .= "</pre></body></html>";
-	[$code, ['Content-Type'=>'text/html; charset=UTF-8'], [$res]];
+	PublicInbox::WwwStream->response($ctx, $code, $cb);
 }
 
-sub dump_mset {
-	my ($res, $mset) = @_;
+# display non-nested search results similar to what users expect from
+# regular WWW search engines:
+sub mset_summary {
+	my ($ctx, $mset, $q) = @_;
 
 	my $total = $mset->get_matches_estimated;
 	my $pad = length("$total");
 	my $pfx = ' ' x $pad;
+	my $res = \($ctx->{-html_tip});
+	my $ibx = $ctx->{-inbox};
+	my $srch = $ibx->search;
+	my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
 	foreach my $m ($mset->items) {
 		my $rank = sprintf("%${pad}d", $m->get_rank + 1);
-		my $pct = $m->get_percent;
-		my $smsg = PublicInbox::SearchMsg->load_doc($m->get_document);
-		my $s = PublicInbox::Hval->new_oneline($smsg->subject);
-		my $f = $smsg->from_name;
-		$f = PublicInbox::Hval->new_oneline($f)->as_html;
-		my $d = strftime('%Y-%m-%d %H:%M', gmtime($smsg->ts));
-		my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->as_href;
+		my $pct = get_pct($m);
+		my $smsg = PublicInbox::SearchMsg::from_mitem($m, $srch);
+		unless ($smsg) {
+			eval {
+				$m = "$m ".$m->get_docid . " expired\n";
+				$ctx->{env}->{'psgi.errors'}->print($m);
+			};
+			next;
+		}
+		my $s = ascii_html($smsg->subject);
+		my $f = ascii_html($smsg->from_name);
+		if ($obfs_ibx) {
+			obfuscate_addrs($obfs_ibx, $s);
+			obfuscate_addrs($obfs_ibx, $f);
+		}
+		my $date = PublicInbox::View::fmt_ts($smsg->ds);
+		my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->{href};
+		$s = '(no subject)' if $s eq '';
 		$$res .= qq{$rank. <b><a\nhref="$mid/">}.
-			$s->as_html . "</a></b>\n";
-		$$res .= "$pfx  - by $f @ $d UTC [$pct%]\n\n";
+			$s . "</a></b>\n";
+		$$res .= "$pfx  - by $f @ $date UTC [$pct%]\n\n";
+	}
+	$$res .= search_nav_bot($mset, $q);
+	*noop;
+}
+
+# shorten "/full/path/to/Foo/Bar.pm" to "Foo/Bar.pm" so error
+# messages don't reveal FS layout info in case people use non-standard
+# installation paths
+sub path2inc ($) {
+	my $full = $_[0];
+	if (my $short = $rmap_inc{$full}) {
+		return $short;
+	} elsif (!scalar(keys %rmap_inc) && -e $full) {
+		%rmap_inc = map {; "$INC{$_}" => $_ } keys %INC;
+		# fall back to basename as last resort
+		$rmap_inc{$full} // (split('/', $full))[-1];
+	} else {
+		$full;
 	}
 }
 
 sub err_txt {
-	my ($err) = @_;
-	my $u = 'http://xapian.org/docs/queryparser.html';
+	my ($ctx, $err) = @_;
+	my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
 	$err =~ s/^\s*Exception:\s*//; # bad word to show users :P
-	$err = PublicInbox::Hval->new_oneline($err)->as_html;
-	"\n\nBad query: <b>$err</b>\n" .
-		qq{See <a\nhref="$u">$u</a> for Xapian query syntax};
+	$err =~ s!(\S+)!path2inc($1)!sge;
+	$err = ascii_html($err);
+	"\nBad query: <b>$err</b>\n" .
+		qq{See <a\nhref="$u">$u</a> for help on using search};
 }
 
 sub search_nav_top {
-	my ($mset, $q) = @_;
+	my ($mset, $q, $ctx) = @_;
+	my $m = $q->qs_html(x => 'm', r => undef);
+	my $rv = qq{<form\naction="?$m"\nmethod="post"><pre>};
+	my $initial_q = $ctx->{-uxs_retried};
+	if (defined $initial_q) {
+		my $rewritten = $q->{'q'};
+		utf8::decode($initial_q);
+		utf8::decode($rewritten);
+		$initial_q = ascii_html($initial_q);
+		$rewritten = ascii_html($rewritten);
+		$rv .= " Warning: Initial query:\n <b>$initial_q</b>\n";
+		$rv .= " returned no results, used:\n";
+		$rv .= " <b>$rewritten</b>\n instead\n\n";
+	}
 
-	my $rv = "Search results ordered by [";
+	$rv .= 'Search results ordered by [';
 	if ($q->{r}) {
 		my $d = $q->qs_html(r => 0);
 		$rv .= qq{<a\nhref="?$d">date</a>|<b>relevance</b>};
@@ -101,201 +181,215 @@ sub search_nav_top {
 	my $x = $q->{x};
 	if ($x eq '') {
 		my $t = $q->qs_html(x => 't');
-		$rv .= qq{<b>summary</b>|};
-		$rv .= qq{<a\nhref="?$t">threaded</a>}
+		$rv .= qq{<b>summary</b>|<a\nhref="?$t">nested</a>}
 	} elsif ($q->{x} eq 't') {
 		my $s = $q->qs_html(x => '');
-		$rv .= qq{<a\nhref="?$s">summary</a>|};
-		$rv .= qq{<b>threaded</b>};
+		$rv .= qq{<a\nhref="?$s">summary</a>|<b>nested</b>};
 	}
-	my $A = $q->qs_html(x => 'A');
-	$rv .= qq{|<a\nhref="?$A">Atom</a>};
-	$rv .= ']';
+	my $A = $q->qs_html(x => 'A', r => undef);
+	$rv .= qq{|<a\nhref="?$A">Atom feed</a>]};
+	$rv .= qq{\n\t\t\t\t\t\tdownload: };
+	$rv .= qq{<input\ntype=submit\nvalue="mbox.gz"/></pre></form><pre>};
 }
 
 sub search_nav_bot {
 	my ($mset, $q) = @_;
 	my $total = $mset->get_matches_estimated;
-	my $nr = scalar $mset->items;
+	my $l = $q->{l};
+	my $rv = '</pre><hr><pre id=t>';
 	my $o = $q->{o};
-	my $end = $o + $nr;
-	my $beg = $o + 1;
-	my $rv = "<hr /><pre>Results $beg-$end of $total";
-	my $n = $o + $LIM;
-
-	if ($n < $total) {
-		my $qs = $q->qs_html(o => $n);
-		$rv .= qq{, <a\nhref="?$qs">next</a>}
-	}
-	if ($o > 0) {
-		$rv .= $n < $total ? '/' : ',      ';
-		my $p = $o - $LIM;
-		my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
-		$rv .= qq{<a\nhref="?$qs">prev</a>};
-	}
-	$rv;
-}
+	my $off = $o < 0 ? -($o + 1) : $o;
+	my $end = $off + $mset->size;
+	my $beg = $off + 1;
 
-sub tdump {
-	my ($cb, $res, $mset, $q, $ctx) = @_;
-	my $fh = $cb->([200, ['Content-Type'=>'text/html; charset=UTF-8']]);
-	$fh->write($res);
-	my %pct;
-	my @m = map {
-		my $i = $_;
-		my $m = PublicInbox::SearchMsg->load_doc($i->get_document);
-		$pct{$m->mid} = $i->get_percent;
-		$m = $m->mini_mime;
-		$m;
-	} ($mset->items);
-
-	require PublicInbox::Thread;
-	my $th = PublicInbox::Thread->new(@m);
-	{
-		no warnings 'once';
-		$Mail::Thread::nosubject = 0;
-	}
-	$th->thread;
-	if ($q->{r}) {
-		$th->order(sub {
-			sort { (eval { $pct{$b->topmost->messageid} } || 0)
-					<=>
-				(eval { $pct{$a->topmost->messageid} } || 0)
-			} @_;
-		});
+	if ($beg <= $end) {
+		$rv .= "Results $beg-$end of $total";
+		$rv .= ' (estimated)' if $end != $total;
 	} else {
-		no warnings 'once';
-		$th->order(*PublicInbox::View::rsort_ts);
+		$rv .= "No more results, only $total";
 	}
+	my ($next, $join, $prev);
 
-	require PublicInbox::GitCatFile;
-	my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
-	my $state = { ctx => $ctx, anchor_idx => 0, pct => \%pct };
-	$ctx->{searchview} = 1;
-	tdump_ent($fh, $git, $state, $_, 0) for $th->rootset;
-	$git = undef;
-	Email::Address->purge_cache;
+	if ($o >= 0) { # sort descending
+		my $n = $o + $l;
+		if ($n < $total) {
+			$next = $q->qs_html(o => $n, l => $l);
+		}
+		if ($o > 0) {
+			$join = $n < $total ? '/' : '       ';
+			my $p = $o - $l;
+			$prev = $q->qs_html(o => ($p > 0 ? $p : 0));
+		}
+	} else { # o < 0, sort ascending
+		my $n = $o - $l;
 
-	$fh->write(search_nav_bot($mset, $q). "\n\n" .
-			foot($ctx). '</pre></body></html>');
+		if (-$n < $total) {
+			$next = $q->qs_html(o => $n, l => $l);
+		}
+		if ($o < -1) {
+			$join = -$n < $total ? '/' : '       ';
+			my $p = $o + $l;
+			$prev = $q->qs_html(o => ($p < 0 ? $p : 0));
+		}
+	}
 
-	$fh->close;
+	$rv .= qq{  <a\nhref="?$next"\nrel=next>next</a>} if $next;
+	$rv .= $join if $join;
+	$rv .= qq{<a\nhref="?$prev"\nrel=prev>prev</a>} if $prev;
+
+	my $rev = $q->qs_html(o => $o < 0 ? 0 : -1);
+	$rv .= qq{ | <a\nhref="?$rev">reverse results</a></pre>};
 }
 
-sub tdump_ent {
-	my ($fh, $git, $state, $node, $level) = @_;
-	return unless $node;
-	my $mime = $node->message;
-
-	if ($mime) {
-		# lazy load the full message from mini_mime:
-		my $mid = $mime->header('Message-ID');
-		$mime = eval {
-			my $path = mid2path(mid_clean($mid));
-			Email::MIME->new($git->cat_file('HEAD:'.$path));
-		};
-	}
-	if ($mime) {
-		PublicInbox::View::index_entry($fh, $mime, $level, $state);
-	} else {
-		my $mid = $node->messageid;
-		$fh->write(PublicInbox::View::ghost_table('', $mid, $level));
-	}
-	tdump_ent($fh, $git, $state, $node->child, $level + 1);
-	tdump_ent($fh, $git, $state, $node->next, $level);
+sub sort_relevance {
+	[ sort {
+		(eval { $b->topmost->{smsg}->{pct} } // 0) <=>
+		(eval { $a->topmost->{smsg}->{pct} } // 0)
+	} @{$_[0]} ]
 }
 
-sub foot {
-	my ($ctx) = @_;
-	my $foot = $ctx->{footer} || '';
-	qq{Back to <a\nhref=".">index</a>.\n$foot};
+sub get_pct ($) {
+	# Capped at "99%" since "100%" takes an extra column in the
+	# thread skeleton view.  <xapian/mset.h> says the value isn't
+	# very meaningful, anyways.
+	my $n = $_[0]->get_percent;
+	$n > 99 ? 99 : $n;
 }
 
-sub html_start {
-	my ($q, $ctx) = @_;
-	my $query = PublicInbox::Hval->new_oneline($q->{q});
+sub load_msgs {
+	my ($mset) = @_;
+	[ map {
+		my $mi = $_;
+		my $smsg = PublicInbox::SearchMsg::from_mitem($mi);
+		$smsg->{pct} = get_pct($mi);
+		$smsg;
+	} ($mset->items) ]
+}
 
-	my $qh = $query->as_html;
-	my $A = $q->qs_html(x => 'A');
-	my $res = "<html><head><title>$qh - search results</title>" .
-		qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
-		qq!href="?$A"\ntype="application/atom+xml"/></head>! .
-		qq{<body><form\naction="">} .
-		qq{<input\nname=q\nvalue="$qh"\ntype=text />};
+sub mset_thread {
+	my ($ctx, $mset, $q) = @_;
+	my $msgs = $ctx->{-inbox}->search->retry_reopen(\&load_msgs, $mset);
+	my $r = $q->{r};
+	my $rootset = PublicInbox::SearchThread::thread($msgs,
+		$r ? \&sort_relevance : \&PublicInbox::View::sort_ds,
+		$ctx);
+	my $skel = search_nav_bot($mset, $q). "<pre>";
+	$ctx->{-upfx} = '';
+	$ctx->{anchor_idx} = 1;
+	$ctx->{cur_level} = 0;
+	$ctx->{dst} = \$skel;
+	$ctx->{mapping} = {};
+	$ctx->{searchview} = 1;
+	$ctx->{prev_attr} = '';
+	$ctx->{prev_level} = 0;
+	$ctx->{s_nr} = scalar(@$msgs).'+ results';
+
+	# reduce hash lookups in skel_dump
+	$ctx->{-obfuscate} = $ctx->{-inbox}->{obfuscate};
+	PublicInbox::View::walk_thread($rootset, $ctx,
+		*PublicInbox::View::pre_thread);
+
+	@$msgs = reverse @$msgs if $r;
+	$ctx->{msgs} = $msgs;
+	\&mset_thread_i;
+}
 
-	$res .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
-	if (my $x = $q->{x}) {
-		my $xh = PublicInbox::Hval->new_oneline($x)->as_html;
-		$res .= qq{<input\ntype=hidden\nname=x\nvalue="$xh" />};
+# callback for PublicInbox::WwwStream::getline
+sub mset_thread_i {
+	my ($nr, $ctx) = @_;
+	my $msgs = $ctx->{msgs} or return;
+	while (my $smsg = pop @$msgs) {
+		$ctx->{-inbox}->smsg_mime($smsg) or next;
+		return PublicInbox::View::index_entry($smsg, $ctx,
+							scalar @$msgs);
 	}
+	my ($skel) = delete @$ctx{qw(dst msgs)};
+	$$skel .= "\n</pre>";
+}
 
-	$res .= qq{<input\ntype=submit\nvalue=search /></form>};
+sub ctx_prepare {
+	my ($q, $ctx) = @_;
+	my $qh = $q->{'q'};
+	utf8::decode($qh);
+	$qh = ascii_html($qh);
+	$ctx->{-q_value_html} = $qh;
+	$ctx->{-atom} = '?'.$q->qs_html(x => 'A', r => undef);
+	$ctx->{-title_html} = "$qh - search results";
+	my $extra = '';
+	$extra .= qq{<input\ntype=hidden\nname=r />} if $q->{r};
+	if (my $x = $q->{x}) {
+		$x = ascii_html($x);
+		$extra .= qq{<input\ntype=hidden\nname=x\nvalue="$x" />};
+	}
+	$ctx->{-extra_form_html} = $extra;
 }
 
 sub adump {
 	my ($cb, $mset, $q, $ctx) = @_;
-	my $fh = $cb->([ 200, ['Content-Type' => 'application/atom+xml']]);
-	require PublicInbox::GitCatFile;
-	my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
-	my $feed_opts = PublicInbox::Feed::get_feedopts($ctx);
-	my $x = PublicInbox::Hval->new_oneline($q->{q})->as_html;
-	$x = qq{$x - search results};
-	$feed_opts->{atomurl} = $feed_opts->{url} . '?'. $q->qs_html;
-	$feed_opts->{url} .= '?'. $q->qs_html(x => undef);
-	$x = PublicInbox::Feed::atom_header($feed_opts, $x);
-	$fh->write($x. PublicInbox::Feed::feed_updated());
-
-	for ($mset->items) {
-		$x = PublicInbox::SearchMsg->load_doc($_->get_document)->mid;
-		$x = mid2path($x);
-		PublicInbox::Feed::add_to_feed($feed_opts, $fh, $x, $git);
+	$ctx->{items} = [ $mset->items ];
+	$ctx->{search_query} = $q; # used by WwwAtomStream::atom_header
+	$ctx->{srch} = $ctx->{-inbox}->search;
+	PublicInbox::WwwAtomStream->response($ctx, 200, \&adump_i);
+}
+
+# callback for PublicInbox::WwwAtomStream::getline
+sub adump_i {
+	my ($ctx) = @_;
+	while (my $mi = shift @{$ctx->{items}}) {
+		my $smsg = eval {
+			PublicInbox::SearchMsg::from_mitem($mi, $ctx->{srch});
+		} or next;
+		$ctx->{-inbox}->smsg_mime($smsg) and return $smsg;
 	}
-	$git = undef;
-	PublicInbox::Feed::end_feed($fh);
 }
 
 package PublicInbox::SearchQuery;
 use strict;
 use warnings;
-use fields qw(q o t x r);
-use PublicInbox::Hval;
+use URI::Escape qw(uri_escape);
+use PublicInbox::MID qw(MID_ESC);
 
 sub new {
-	my ($class, $cgi) = @_;
-	my $self = fields::new($class);
-	$self->{q} = $cgi->param('q');
-	$self->{x} = $cgi->param('x') || '';
-	$self->{o} = int($cgi->param('o') || 0) || 0;
-	my $r = $cgi->param('r');
-	$self->{r} = (defined $r && $r ne '0');
-
-	$self;
+	my ($class, $qp) = @_;
+
+	my $r = $qp->{r};
+	my ($l) = (($qp->{l} || '') =~ /([0-9]+)/);
+	$l = $LIM if !$l || $l > $LIM;
+	bless {
+		q => $qp->{'q'},
+		x => $qp->{x} || '',
+		o => (($qp->{o} || '0') =~ /(-?[0-9]+)/),
+		l => $l,
+		r => (defined $r && $r ne '0'),
+	}, $class;
 }
 
 sub qs_html {
 	my ($self, %over) = @_;
 
 	if (keys %over) {
-		my $tmp = fields::new(ref($self));
-		%$tmp = %$self;
+		my $tmp = bless { %$self }, ref($self);
 		foreach my $k (keys %over) {
 			$tmp->{$k} = $over{$k};
 		}
 		$self = $tmp;
 	}
 
-	my $q = PublicInbox::Hval->new($self->{q})->as_href;
+	my $q = uri_escape($self->{'q'}, MID_ESC);
 	$q =~ s/%20/+/g; # improve URL readability
 	my $qs = "q=$q";
 
 	if (my $o = $self->{o}) { # ignore o == 0
 		$qs .= "&amp;o=$o";
 	}
+	if (my $l = $self->{l}) {
+		$qs .= "&amp;l=$l" unless $l == $LIM;
+	}
 	if (my $r = $self->{r}) {
 		$qs .= "&amp;r";
 	}
 	if (my $x = $self->{x}) {
-		$qs .= "&amp;x=$x" if ($x eq 't' || $x eq 'A');
+		$qs .= "&amp;x=$x" if ($x eq 't' || $x eq 'A' || $x eq 'm');
 	}
 	$qs;
 }