unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: meta@public-inbox.org
Subject: [PATCH] searchview: retry queries if uri_unescape-able
Date: Tue, 23 May 2017 23:17:56 +0000	[thread overview]
Message-ID: <20170523231756.GA20232@dcvr> (raw)
In-Reply-To: <20170523184310.GB9543@dcvr>

> Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
> > I don't know if it breaks anything else but calling uri_unescape()
> > would work for these sort of msgids, but then of course searching for
> > %2b wouldn't work, hrm...

So it's now trying the query as-is first, then retrying the
unescaped query if there's no results:

------8<------
Subject: [PATCH] searchview: retry queries if uri_unescape-able
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

It is possible to have double-escaped queries when copy and
pasting into browsers, so try to help users work around this
common error by automatically retrying after unescaping once.

Of course, we must inform the user when doing this results in
success, in case they really meant to search for a
double-escaped term which resulted in nothing.

Reported-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  https://public-inbox.org/meta/CACBZZX5Gnow08r=0A1J_kt3a=zpGyMfvsqu8nAN7kacNnDm+dg@mail.gmail.com/
---
 lib/PublicInbox/SearchView.pm | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/lib/PublicInbox/SearchView.pm b/lib/PublicInbox/SearchView.pm
index 42bc648..f92790f 100644
--- a/lib/PublicInbox/SearchView.pm
+++ b/lib/PublicInbox/SearchView.pm
@@ -5,11 +5,12 @@
 package PublicInbox::SearchView;
 use strict;
 use warnings;
+use URI::Escape qw(uri_unescape uri_escape);
 use PublicInbox::SearchMsg;
 use PublicInbox::Hval qw/ascii_html/;
 use PublicInbox::View;
 use PublicInbox::WwwAtomStream;
-use PublicInbox::MID qw(mid2path mid_mime mid_clean mid_escape);
+use PublicInbox::MID qw(mid2path mid_mime mid_clean mid_escape MID_ESC);
 use PublicInbox::MIME;
 require PublicInbox::Git;
 require PublicInbox::SearchThread;
@@ -29,19 +30,27 @@ sub sres_top_html {
 		mset => 1,
 		relevance => $q->{r},
 	};
-	my ($mset, $total);
+	my ($mset, $total, $err, $cb);
+retry:
 	eval {
 		$mset = $ctx->{srch}->query($q->{'q'}, $opts);
 		$total = $mset->get_matches_estimated;
 	};
-	my $err = $@;
+	$err = $@;
 	ctx_prepare($q, $ctx);
-	my $cb;
 	if ($err) {
 		$code = 400;
 		$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;
 		$ctx->{-html_tip} = "<pre>\n[No results found]</pre><hr>";
 		$cb = *noop;
@@ -49,7 +58,7 @@ sub sres_top_html {
 		my $x = $q->{x};
 		return adump($_[0], $mset, $q, $ctx) if $x eq 'A';
 
-		$ctx->{-html_tip} = search_nav_top($mset, $q) . "\n\n";
+		$ctx->{-html_tip} = search_nav_top($mset, $q, $ctx) . "\n\n";
 		if ($x eq 't') {
 			$cb = mset_thread($ctx, $mset, $q);
 		} else {
@@ -113,9 +122,22 @@ sub err_txt {
 }
 
 sub search_nav_top {
-	my ($mset, $q) = @_;
+	my ($mset, $q, $ctx) = @_;
+
+	my $rv = '<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 = "<pre>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>};
-- 
(deployed on public-inbox.org and all .onions)

      reply	other threads:[~2017-05-23 23:17 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-23 10:17 Feature R/BUG: Auto uri_unescape() & utf8 handling Ævar Arnfjörð Bjarmason
2017-05-23 18:39 ` Eric Wong
2017-05-23 22:02   ` [PATCH] www: do not mangle characters from search queries Eric Wong
2017-05-23 18:43 ` Feature R/BUG: Auto uri_unescape() & utf8 handling Eric Wong
2017-05-23 23:17   ` Eric Wong [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170523231756.GA20232@dcvr \
    --to=e@80x24.org \
    --cc=avarab@gmail.com \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).