X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FSearchView.pm;h=7521a66ddb82c51bc2a6b9b7b1b77772403d2531;hb=6c853f5256f3a324c018a37a9e8a6b9fc8fdc063;hp=5a95a055eb3230c7cfd49db1317b0cfa11f5c9f9;hpb=09e5f81e8259e7deffe0973b3547a5c77fbf3fc5;p=public-inbox.git diff --git a/lib/PublicInbox/SearchView.pm b/lib/PublicInbox/SearchView.pm index 5a95a055..7521a66d 100644 --- a/lib/PublicInbox/SearchView.pm +++ b/lib/PublicInbox/SearchView.pm @@ -1,76 +1,91 @@ -# Copyright (C) 2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2015-2020 all contributors +# License: AGPL-3.0+ # # Displays search results for the web interface package PublicInbox::SearchView; use strict; -use warnings; -use PublicInbox::SearchMsg; -use PublicInbox::Hval qw/ascii_html/; +use v5.10.1; +use List::Util qw(max); +use URI::Escape qw(uri_unescape); +use PublicInbox::Smsg; +use PublicInbox::Hval qw(ascii_html obfuscate_addrs mid_href fmt_ts); use PublicInbox::View; use PublicInbox::WwwAtomStream; -use PublicInbox::MID qw(mid2path mid_mime mid_clean mid_escape); -use PublicInbox::MIME; -require PublicInbox::Git; -require PublicInbox::SearchThread; -our $LIM = 50; +use PublicInbox::WwwStream qw(html_oneshot); +use PublicInbox::SearchThread; +use PublicInbox::SearchQuery; +use PublicInbox::Search qw(mdocid); +my %rmap_inc; -sub noop {} +sub mbox_results { + my ($ctx) = @_; + my $q = PublicInbox::SearchQuery->new($ctx->{qp}); + if ($ctx->{env}->{'psgi.input'}->read(my $buf, 3)) { + $q->{t} = 1 if $buf =~ /\Ax=[^0]/; + } + require PublicInbox::Mbox; + $q->{x} eq 'm' ? PublicInbox::Mbox::mbox_all($ctx, $q) : + sres_top_html($ctx); +} sub sres_top_html { my ($ctx) = @_; + my $srch = $ctx->{-inbox}->search or + return PublicInbox::WWW::need($ctx, 'Search'); my $q = PublicInbox::SearchQuery->new($ctx->{qp}); - my $code = 200; + 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}, + thread => $q->{t}, + asc => $asc, }; - my ($mset, $total); + my ($mset, $total, $err, $html); +retry: eval { - $mset = $ctx->{srch}->query($q->{'q'}, $opts); + $mset = $srch->query($query, $opts); $total = $mset->get_matches_estimated; }; - my $err = $@; + $err = $@; ctx_prepare($q, $ctx); - my $cb; if ($err) { $code = 400; - $ctx->{-html_tip} = '
'.err_txt($ctx, $err).'
'; - $cb = *noop; + $html = '
'.err_txt($ctx, $err).'
'; } 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; - $ctx->{-html_tip} = "
\n[No results found]
"; - $cb = *noop; + $html = "
\n[No results found]
"; } else { - my $x = $q->{x}; return adump($_[0], $mset, $q, $ctx) if $x eq 'A'; - $ctx->{-html_tip} = search_nav_top($mset, $q) . "\n\n"; - if ($x eq 't') { - $cb = mset_thread($ctx, $mset, $q); - } else { - $cb = mset_summary($ctx, $mset, $q); - } - } - PublicInbox::WwwStream->response($ctx, $code, $cb); -} - -# allow undef for individual doc loads... -sub load_doc_retry { - my ($srch, $mitem) = @_; - - eval { - $srch->retry_reopen(sub { - PublicInbox::SearchMsg->load_doc($mitem->get_document) - }); + $ctx->{-html_tip} = search_nav_top($mset, $q, $ctx); + return mset_thread($ctx, $mset, $q) if $x eq 't'; + mset_summary($ctx, $mset, $q); # appends to {-html_tip} + $html = ''; } + html_oneshot($ctx, $code); } -# display non-threaded search results similar to what users expect from +# display non-nested search results similar to what users expect from # regular WWW search engines: sub mset_summary { my ($ctx, $mset, $q) = @_; @@ -79,43 +94,84 @@ sub mset_summary { my $pad = length("$total"); my $pfx = ' ' x $pad; my $res = \($ctx->{-html_tip}); - my $srch = $ctx->{srch}; + my $ibx = $ctx->{-inbox}; + my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef; + my @nums = @{$ibx->search->mset_to_artnums($mset)}; + my %num2msg = map { $_->{num} => $_ } @{$ibx->over->get_all(@nums)}; + foreach my $m ($mset->items) { my $rank = sprintf("%${pad}d", $m->get_rank + 1); - my $pct = $m->get_percent; - my $smsg = load_doc_retry($srch, $m); - unless ($smsg) { + my $pct = get_pct($m); + my $num = shift @nums; + my $smsg = delete($num2msg{$num}) or do { eval { - $m = "$m ".$m->get_docid . " expired\n"; + $m = "$m $num expired\n"; $ctx->{env}->{'psgi.errors'}->print($m); }; next; + }; + $ctx->{-t_max} //= $smsg->{ts}; + + 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 $s = ascii_html($smsg->subject); - my $f = ascii_html($smsg->from_name); - my $ts = PublicInbox::View::fmt_ts($smsg->ts); - my $mid = PublicInbox::Hval->new_msgid($smsg->mid)->{href}; + my $date = fmt_ts($smsg->{ds}); + my $mid = mid_href($smsg->{mid}); + $s = '(no subject)' if $s eq ''; $$res .= qq{$rank. }. $s . "\n"; - $$res .= "$pfx - by $f @ $ts UTC [$pct%]\n\n"; + $$res .= "$pfx - by $f @ $date UTC [$pct%]\n\n"; } $$res .= search_nav_bot($mset, $q); - *noop; + undef; +} + +# 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 ($ctx, $err) = @_; my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/'; $err =~ s/^\s*Exception:\s*//; # bad word to show users :P + $err =~ s!(\S+)!path2inc($1)!sge; $err = ascii_html($err); "\nBad query: $err\n" . qq{See $u 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, t => undef); + my $rv = qq{
};
+	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 $initial_q\n";
+		$rv .= " returned no results, used:\n";
+		$rv .= " $rewritten\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{date|relevance};
@@ -129,100 +185,143 @@ sub search_nav_top {
 	my $x = $q->{x};
 	if ($x eq '') {
 		my $t = $q->qs_html(x => 't');
-		$rv .= qq{summary|threaded}
+		$rv .= qq{summary|nested}
 	} elsif ($q->{x} eq 't') {
 		my $s = $q->qs_html(x => '');
-		$rv .= qq{summary|threaded};
+		$rv .= qq{summary|nested};
 	}
 	my $A = $q->qs_html(x => 'A', r => undef);
 	$rv .= qq{|Atom feed]};
+	if ($ctx->{-inbox}->search->has_threadid) {
+		$rv .= qq{\n\t\t\tdownload mbox.gz: } .
+			# we set name=z w/o using it since it seems required for
+			# lynx (but works fine for w3m).
+			qq{} .
+			qq{|};
+	} else { # BOFH needs to --reindex
+		$rv .= qq{\n\t\t\t\t\t\tdownload: } .
+			qq{}
+	}
+	$rv .= qq{
};
 }
 
 sub search_nav_bot {
 	my ($mset, $q) = @_;
 	my $total = $mset->get_matches_estimated;
-	my $nr = scalar $mset->items;
+	my $l = $q->{l};
+	my $rv = '
';
 	my $o = $q->{o};
-	my $end = $o + $nr;
-	my $beg = $o + 1;
-	my $rv = '
';
+	my $off = $o < 0 ? -($o + 1) : $o;
+	my $end = $off + $mset->size;
+	my $beg = $off + 1;
+
 	if ($beg <= $end) {
 		$rv .= "Results $beg-$end of $total";
 		$rv .= ' (estimated)' if $end != $total;
 	} else {
 		$rv .= "No more results, only $total";
 	}
-	my $n = $o + $LIM;
+	my ($next, $join, $prev);
 
-	if ($n < $total) {
-		my $qs = $q->qs_html(o => $n);
-		$rv .= qq{  next}
-	}
-	if ($o > 0) {
-		$rv .= $n < $total ? '/' : '       ';
-		my $p = $o - $LIM;
-		my $qs = $q->qs_html(o => ($p > 0 ? $p : 0));
-		$rv .= qq{prev};
+	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;
+
+		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));
+		}
 	}
-	$rv .= '
';
+
+	$rv .= qq{  next} if $next;
+	$rv .= $join if $join;
+	$rv .= qq{prev} if $prev;
+
+	my $rev = $q->qs_html(o => $o < 0 ? 0 : -1);
+	$rv .= qq{ | reverse results
}; } sub sort_relevance { - my ($pct) = @_; - sub { - [ sort { (eval { $pct->{$b->topmost->{id}} } || 0) - <=> - (eval { $pct->{$a->topmost->{id}} } || 0) - } @{$_[0]} ] }; + [ sort { + (eval { $b->topmost->{pct} } // 0) <=> + (eval { $a->topmost->{pct} } // 0) + } @{$_[0]} ] +} + +sub get_pct ($) { + # Capped at "99%" since "100%" takes an extra column in the + # thread skeleton view. says the value isn't + # very meaningful, anyways. + my $n = $_[0]->get_percent; + $n > 99 ? 99 : $n; } sub mset_thread { my ($ctx, $mset, $q) = @_; - my %pct; - my $msgs = $ctx->{srch}->retry_reopen(sub { [ map { - my $i = $_; - my $smsg = PublicInbox::SearchMsg->load_doc($i->get_document); - $pct{$smsg->mid} = $i->get_percent; - $smsg; - } ($mset->items) ]}); - + my $ibx = $ctx->{-inbox}; + my $nshard = $ibx->search->{nshard} // 1; + my %pct = map { mdocid($nshard, $_) => get_pct($_) } $mset->items; + my $msgs = $ibx->over->get_all(keys %pct); + $_->{pct} = $pct{$_->{num}} for @$msgs; + my $r = $q->{r}; my $rootset = PublicInbox::SearchThread::thread($msgs, - $q->{r} ? sort_relevance(\%pct) : *PublicInbox::View::sort_ts); + $r ? \&sort_relevance : \&PublicInbox::View::sort_ds, + $ctx); my $skel = search_nav_bot($mset, $q). "
";
-	my $inbox = $ctx->{-inbox};
 	$ctx->{-upfx} = '';
 	$ctx->{anchor_idx} = 1;
 	$ctx->{cur_level} = 0;
-	$ctx->{dst} = \$skel;
+	$ctx->{skel} = \$skel;
 	$ctx->{mapping} = {};
-	$ctx->{pct} = \%pct;
+	$ctx->{searchview} = 1;
 	$ctx->{prev_attr} = '';
 	$ctx->{prev_level} = 0;
-	$ctx->{seen} = {};
 	$ctx->{s_nr} = scalar(@$msgs).'+ results';
 
+	# reduce hash lookups in skel_dump
+	$ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
 	PublicInbox::View::walk_thread($rootset, $ctx,
-		*PublicInbox::View::pre_thread);
+		\&PublicInbox::View::pre_thread);
 
-	my $mime;
-	sub {
-		return unless $msgs;
-		while ($mime = shift @$msgs) {
-			$mime = $inbox->msg_by_smsg($mime) and last;
-		}
-		if ($mime) {
-			$mime = PublicInbox::MIME->new($mime);
-			return PublicInbox::View::index_entry($mime, $ctx,
-				scalar @$msgs);
-		}
-		$msgs = undef;
-		$skel .= "\n
"; - }; + # link $INBOX_DIR/description text to "recent" view around + # the newest message in this result set: + $ctx->{-t_max} = max(map { delete $_->{ts} } @$msgs); + + @$msgs = reverse @$msgs if $r; + $ctx->{msgs} = $msgs; + PublicInbox::WwwStream::aresponse($ctx, 200, \&mset_thread_i); +} + +# callback for PublicInbox::WwwStream::getline +sub mset_thread_i { + my ($ctx, $eml) = @_; + $ctx->zmore($ctx->html_top) if exists $ctx->{-html_tip}; + $eml and return PublicInbox::View::eml_entry($ctx, $eml); + my $smsg = shift @{$ctx->{msgs}} or + $ctx->zmore(${delete($ctx->{skel})}); + $smsg; } sub ctx_prepare { my ($q, $ctx) = @_; - my $qh = ascii_html($q->{'q'}); + 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"; @@ -237,63 +336,18 @@ sub ctx_prepare { sub adump { my ($cb, $mset, $q, $ctx) = @_; - my $ibx = $ctx->{-inbox}; - my @items = $mset->items; - $ctx->{search_query} = $q; - my $srch = $ctx->{srch}; - PublicInbox::WwwAtomStream->response($ctx, 200, sub { - while (my $x = shift @items) { - $x = load_doc_retry($srch, $x); - $x = $ibx->msg_by_smsg($x) and - return PublicInbox::MIME->new($x); - } - return undef; - }); -} - -package PublicInbox::SearchQuery; -use strict; -use warnings; -use PublicInbox::Hval; -use PublicInbox::MID qw(mid_escape); - -sub new { - my ($class, $qp) = @_; - - my $r = $qp->{r}; - bless { - q => $qp->{'q'}, - x => $qp->{x} || '', - o => (($qp->{o} || '0') =~ /(\d+)/), - r => (defined $r && $r ne '0'), - }, $class; + $ctx->{ids} = $ctx->{-inbox}->search->mset_to_artnums($mset); + $ctx->{search_query} = $q; # used by WwwAtomStream::atom_header + PublicInbox::WwwAtomStream->response($ctx, 200, \&adump_i); } -sub qs_html { - my ($self, %over) = @_; - - if (keys %over) { - my $tmp = bless { %$self }, ref($self); - foreach my $k (keys %over) { - $tmp->{$k} = $over{$k}; - } - $self = $tmp; - } - - my $q = mid_escape($self->{'q'}); - $q =~ s/%20/+/g; # improve URL readability - my $qs = "q=$q"; - - if (my $o = $self->{o}) { # ignore o == 0 - $qs .= "&o=$o"; - } - if (my $r = $self->{r}) { - $qs .= "&r"; - } - if (my $x = $self->{x}) { - $qs .= "&x=$x" if ($x eq 't' || $x eq 'A'); +# callback for PublicInbox::WwwAtomStream::getline +sub adump_i { + my ($ctx) = @_; + while (my $num = shift @{$ctx->{ids}}) { + my $smsg = eval { $ctx->{-inbox}->over->get_art($num) } or next; + return $smsg; } - $qs; } 1;