From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 4/8] www: avoid incorrect instructions for extindex
Date: Thu, 26 Aug 2021 12:33:34 +0000 [thread overview]
Message-ID: <20210826123338.694-5-e@80x24.org> (raw)
In-Reply-To: <20210826123338.694-1-e@80x24.org>
There's no way to clone an extindex, since there's no git
storage associated with them. So attempt to link to the
HTML listing of public-inboxes, instead.
---
lib/PublicInbox/ExtSearch.pm | 4 --
lib/PublicInbox/WwwStream.pm | 111 +++++++++++++++++++----------------
2 files changed, 62 insertions(+), 53 deletions(-)
diff --git a/lib/PublicInbox/ExtSearch.pm b/lib/PublicInbox/ExtSearch.pm
index 0b480c7e..bd301158 100644
--- a/lib/PublicInbox/ExtSearch.pm
+++ b/lib/PublicInbox/ExtSearch.pm
@@ -106,10 +106,6 @@ sub description {
'$EXTINDEX_DIR/description missing';
}
-sub cloneurl { [] } # TODO
-
-sub nntp_url { [] }
-
no warnings 'once';
*base_url = \&PublicInbox::Inbox::base_url;
*smsg_eml = \&PublicInbox::Inbox::smsg_eml;
diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm
index 57c23690..d8142824 100644
--- a/lib/PublicInbox/WwwStream.pm
+++ b/lib/PublicInbox/WwwStream.pm
@@ -120,52 +120,50 @@ sub code_footer ($) {
sub _html_end {
my ($ctx) = @_;
- my $urls = <<EOF;
-<a
-id=mirror>This inbox may be cloned and mirrored by anyone:</a>
-EOF
-
my $ibx = $ctx->{ibx};
my $desc = ascii_html($ibx->description);
-
- my @urls;
+ my $s = "<a\nid=mirror>";
my $http = $ctx->{base_url};
- my $max = $ibx->max_git_epoch;
my $dir = (split(m!/!, $http))[-1];
my %seen = ($http => 1);
- # TODO: some of these URLs may be too long and we may need to
- # do something like code_footer() above, but these are local
- # admin-defined
- if (defined($max)) { # v2
- for my $i (0..$max) {
- # old epochs my be deleted:
- -d "$ibx->{inboxdir}/git/$i.git" or next;
- my $url = "$http/$i";
- $seen{$url} = 1;
- push @urls, "$url $dir/git/$i.git";
+ if ($ibx->can('cloneurl')) { # PublicInbox::Inbox
+ $s .= "This inbox may be cloned and mirrored by anyone:</a>\n";
+ my @urls;
+ my $max = $ibx->max_git_epoch;
+ # TODO: some of these URLs may be too long and we may need to
+ # do something like code_footer() above, but these are local
+ # admin-defined
+ if (defined($max)) { # v2
+ for my $i (0..$max) {
+ # old epochs my be deleted:
+ -d "$ibx->{inboxdir}/git/$i.git" or next;
+ my $url = "$http/$i";
+ $seen{$url} = 1;
+ push @urls, "$url $dir/git/$i.git";
+ }
+ my $nr = scalar(@urls);
+ if ($nr > 1) {
+ $s .= "\n\t";
+ $s .= "# this inbox consists of $nr epochs:";
+ $urls[0] .= "\t# oldest";
+ $urls[-1] .= "\t# newest";
+ }
+ } else { # v1
+ push @urls, $http;
}
- my $nr = scalar(@urls);
- if ($nr > 1) {
- $urls .= "\n\t# this inbox consists of $nr epochs:";
- $urls[0] .= "\t# oldest";
- $urls[-1] .= "\t# newest";
+ # FIXME: epoch splits can be different in other repositories,
+ # use the "cloneurl" file as-is for now:
+ for my $u (@{$ibx->cloneurl}) {
+ next if $seen{$u}++;
+ push @urls, ($u =~ /\Ahttps?:/ ?
+ qq(<a\nhref="$u">$u</a>) : $u);
}
- } else { # v1
- push @urls, $http;
- }
-
- # FIXME: epoch splits can be different in other repositories,
- # use the "cloneurl" file as-is for now:
- foreach my $u (@{$ibx->cloneurl}) {
- next if $seen{$u}++;
- push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
- }
-
- $urls .= "\n" . join('', map { "\tgit clone --mirror $_\n" } @urls);
- if (my $addrs = $ibx->{address}) {
- $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
- my $v = defined $max ? '-V2' : '-V1';
- $urls .= <<EOF;
+ $s .= "\n";
+ $s .= join('', map { "\tgit clone --mirror $_\n" } @urls);
+ if (my $addrs = $ibx->{address}) {
+ $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
+ my $v = defined $max ? '-V2' : '-V1';
+ $s .= <<EOF;
# If you have public-inbox 1.1+ installed, you may
# initialize and index your mirror using the following commands:
@@ -173,26 +171,41 @@ EOF
$addrs
public-inbox-index $dir
EOF
+ }
+ } else { # PublicInbox::ExtSearch
+ $s .= <<EOM;
+This is an extindex which is an amalgamation of several public-inboxes</a>
+EOM
+ my $v = $ctx->{www}->{pi_cfg}->{lc('publicInbox.wwwListing')};
+ if (($v // '') =~ /\A(?:all|match=domain)\z/) {
+ my $upfx = ($ctx->{-upfx} // ''). '../';
+ $s .= <<EOM;
+A list of them is available in the <a\nhref="$upfx">listing</a>
+EOM
+ }
}
+
my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
- $urls .= <<EOF;
+ $s .= <<EOF;
Example <a
href="$cfg_link">config snippet</a> for mirrors.
EOF
- my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
- if (@nntp) {
- $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
- $urls .= ' available over NNTP:';
- $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
+ if ($ibx->can('nntp_url')) {
+ my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
+ if (@nntp) {
+ $s .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
+ $s .= ' available over NNTP:';
+ $s .= "\n\t" . join("\n\t", @nntp) . "\n";
+ }
}
- if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
- $urls .= " note: .onion URLs require Tor: ";
- $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
+ if ($s =~ m!\b[^:]+://\w+\.onion/!) {
+ $s .= " note: .onion URLs require Tor: ";
+ $s .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
}
'<hr><pre>'.join("\n\n",
$desc,
- $urls,
+ $s,
coderepos($ctx),
code_footer($ctx->{env})
).'</pre></body></html>';
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 ` Eric Wong [this message]
2021-08-26 12:33 ` [PATCH 5/8] www_text: fix example config snippet for extindex Eric Wong
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-5-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).