From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH 3/3] wwwaltid: inform users to use POST instead of GET
Date: Thu, 26 Mar 2020 08:21:29 +0000 [thread overview]
Message-ID: <20200326082129.21699-4-e@yhbt.net> (raw)
In-Reply-To: <20200326082129.21699-1-e@yhbt.net>
Seeing the example config linkified, some users may inevitably
try to following it in a browser with a GET request. Provide
a helpful message to inform users to use POST instead of
attempting to treat /$INBOX/$ALTID.sql.gz as a Message-Id.
---
lib/PublicInbox/WWW.pm | 2 ++
lib/PublicInbox/WwwAltId.pm | 18 +++++++++++++++++-
2 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/lib/PublicInbox/WWW.pm b/lib/PublicInbox/WWW.pm
index 56d2c42a..275e509f 100644
--- a/lib/PublicInbox/WWW.pm
+++ b/lib/PublicInbox/WWW.pm
@@ -125,6 +125,8 @@ sub call {
get_vcs_object($ctx, $1, $2, $3);
} elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s\z!o) {
r301($ctx, $1, $2, 's/');
+ } elsif ($path_info =~ m!$INBOX_RE/(\w+)\.sql\.gz\z!o) {
+ get_altid_dump($ctx, $1, $2);
# convenience redirects order matters
} elsif ($path_info =~ m!$INBOX_RE/([^/]{2,})\z!o) {
r301($ctx, $1, $2);
diff --git a/lib/PublicInbox/WwwAltId.pm b/lib/PublicInbox/WwwAltId.pm
index a45d8061..263e884a 100644
--- a/lib/PublicInbox/WwwAltId.pm
+++ b/lib/PublicInbox/WwwAltId.pm
@@ -38,6 +38,7 @@ sub check_output {
# and thus not usable from DBD::SQLite.
sub sqldump ($$) {
my ($ctx, $altid_pfx) = @_;
+ my $env = $ctx->{env};
my $ibx = $ctx->{-inbox};
my $altid_map = $ibx->altid_map;
my $fn = $altid_map->{$altid_pfx};
@@ -47,6 +48,22 @@ sub sqldump ($$) {
EOF
}
+ if ($env->{REQUEST_METHOD} ne 'POST') {
+ my $url = $ibx->base_url($ctx->{env}) . "$altid_pfx.sql.gz";
+ return PublicInbox::WwwStream::oneshot($ctx, 405, \<<EOF);
+<pre>A POST request required to retrieve $altid_pfx.sql.gz
+
+ curl -XPOST -O $url
+
+or
+
+ curl -XPOST $url | \\
+ gzip -dc | \\
+ sqlite3 /path/to/$altid_pfx.sqlite3
+</pre>
+EOF
+ }
+
eval { require PublicInbox::GzipFilter } or
return PublicInbox::WwwStream::oneshot($ctx, 501, \<<EOF);
<pre>gzip output not available
@@ -73,7 +90,6 @@ EOF
# TODO: use -readonly if available with newer sqlite3(1)
my $qsp = PublicInbox::Qspawn->new([$sqlite3, $fn], undef, { 0 => $r });
- my $env = $ctx->{env};
$ctx->{altid_pfx} = $altid_pfx;
$env->{'qspawn.filter'} = PublicInbox::GzipFilter->new;
$qsp->psgi_return($env, undef, \&check_output, $ctx);
prev parent reply other threads:[~2020-03-26 8:21 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-26 8:21 [PATCH 0/3] wwwaltid: add pointers for usability Eric Wong
2020-03-26 8:21 ` [PATCH 1/3] inbox: altid_map becomes a method Eric Wong
2020-03-26 8:21 ` [PATCH 2/3] wwwtext: show altid instructions in config Eric Wong
2020-03-26 8:21 ` 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: http://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=20200326082129.21699-4-e@yhbt.net \
--to=e@yhbt.net \
--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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
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).