From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 5/8] www_text: fix example config snippet for extindex
Date: Thu, 26 Aug 2021 12:33:35 +0000 [thread overview]
Message-ID: <20210826123338.694-6-e@80x24.org> (raw)
In-Reply-To: <20210826123338.694-1-e@80x24.org>
extindex doesn't use the same config stuff as normal
"publicinbox" entries, so we'll need a separate function
for them.
---
lib/PublicInbox/WwwText.pm | 29 ++++++++++++++++++++++++++++-
t/extindex-psgi.t | 12 ++++++++++++
2 files changed, 40 insertions(+), 1 deletion(-)
diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index db5060ea..eb5e3ac7 100644
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -214,10 +214,37 @@ EOF
1;
}
+# n.b. this is a perfect candidate for memoization
+sub extindex_config ($$$) {
+ my ($ctx, $hdr, $txt) = @_;
+ my $ibx = $ctx->{ibx};
+ push @$hdr, 'Content-Disposition', 'inline; filename=extindex.config';
+ my $name = dq_escape($ibx->{name});
+ my $base_url = $ibx->base_url($ctx->{env});
+ $$txt .= <<EOS;
+; Example public-inbox config snippet for the external index (extindex) at:
+; $base_url
+; See public-inbox-config(5)manpage for more details:
+; https://public-inbox.org/public-inbox-config.html
+[extindex "$name"]
+ topdir = /path/to/extindex-topdir
+ url = https://example.com/$name/
+ url = http://example.onion/$name/
+EOS
+ for my $k (qw(infourl)) {
+ defined(my $v = $ibx->{$k}) or next;
+ $$txt .= "\t$k = $v\n";
+ }
+ # TODO: coderepo support for extindex
+ 1;
+}
+
sub _default_text ($$$$) {
my ($ctx, $key, $hdr, $txt) = @_;
return _colors_help($ctx, $txt) if $key eq 'color';
- return inbox_config($ctx, $hdr, $txt) if $key eq 'config';
+ $key eq 'config' and return $ctx->{ibx}->can('cloneurl') ?
+ inbox_config($ctx, $hdr, $txt) :
+ extindex_config($ctx, $hdr, $txt);
return if $key ne 'help'; # TODO more keys?
my $ibx = $ctx->{ibx};
diff --git a/t/extindex-psgi.t b/t/extindex-psgi.t
index 6f62b5a0..b9acc979 100644
--- a/t/extindex-psgi.t
+++ b/t/extindex-psgi.t
@@ -40,6 +40,18 @@ my $client = sub {
'Host: header respected in Atom feed');
unlike($res->content, qr!http://bogus\.example\.com/!s,
'default URL ignored with different host header');
+
+ $res = $cb->(GET('/all/_/text/config/'));
+ is($res->code, 200, '/text/config HTML');
+ $res = $cb->(GET('/all/_/text/config/raw'));
+ is($res->code, 200, '/text/config raw');
+ my $f = "$tmpdir/extindex.config";
+ open my $fh, '>', $f or xbail $!;
+ print $fh $res->content or xbail $!;
+ close $fh or xbail $!;
+ my $cfg = PublicInbox::Config->git_config_dump($f);
+ is($?, 0, 'no errors from git-config parsing');
+ ok($cfg->{'extindex.all.topdir'}, 'extindex.topdir defined');
};
test_psgi(sub { $www->call(@_) }, $client);
%$env = (%$env, TMPDIR => $tmpdir, PI_CONFIG => $pi_config);
next prev parent reply other threads:[~2021-08-26 12:33 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-16 16:36 RFE: Long .onion URL breaks mobile view Konstantin Ryabitsev
2021-08-16 22:38 ` Eric Wong
2021-08-16 22:53 ` Eric Wong
2021-08-26 12:33 ` [PATCH 0/8] various WWW + extindex stuff Eric Wong
2021-08-26 12:33 ` [PATCH 1/8] get rid of unnecessary bytes::length usage Eric Wong
2021-08-26 12:33 ` [PATCH 2/8] ds: use bytes::substr and bytes::length module-wide for now Eric Wong
2021-08-26 12:33 ` [PATCH 3/8] www_stream: sh-friendly .onion URLs wrapping Eric Wong
2021-08-26 12:33 ` [PATCH 4/8] www: avoid incorrect instructions for extindex Eric Wong
2021-08-26 12:33 ` Eric Wong [this message]
2021-08-26 12:33 ` [PATCH 6/8] config: do not parse altid " Eric Wong
2021-08-26 12:33 ` [PATCH 7/8] www_text: add coderepo config support " Eric Wong
2021-08-26 12:33 ` [PATCH 8/8] move ->ids_after from mm to over Eric Wong
2021-08-26 13:27 ` [PATCH 0/8] various WWW + extindex stuff Konstantin Ryabitsev
2021-08-28 11:50 ` [PATCH 0/2] www: split out mirror to /text/ Eric Wong
2021-08-28 11:50 ` [PATCH 1/2] www: move mirror instructions " Eric Wong
2021-08-28 11:50 ` [PATCH 2/2] www_stream: description header links to top $INBOX_URL Eric Wong
2021-08-28 17:58 ` [PATCH 0/2] www: split out mirror to /text/ Konstantin Ryabitsev
2021-08-30 23:44 ` [PATCH 0/3] www: more footer and mirroring instructions tweaks Eric Wong
2021-08-30 23:44 ` [PATCH 1/3] www_stream: extra link to mirroring information in the footer Eric Wong
2021-08-30 23:44 ` [PATCH 2/3] www_text/mirror: spell out "external index" and "public inbox" Eric Wong
2021-08-30 23:44 ` [PATCH 3/3] www_listing: add note about mirroring information Eric Wong
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=20210826123338.694-6-e@80x24.org \
--to=e@80x24.org \
--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).