about summary refs log tree commit homepage
path: root/lib
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2020-09-08 08:29:14 +0000
committerEric Wong <e@80x24.org>2020-09-09 06:17:32 +0000
commit2f61828fcb727e51cb0a10eea4fee65e9e866ba6 (patch)
treedd4527e9384b4472c25362770d7552bcc8b4516b /lib
parent3bf9e1e4d8e5a84a0d8c733faf49555aa84379aa (diff)
downloadpublic-inbox-2f61828fcb727e51cb0a10eea4fee65e9e866ba6.tar.gz
In order to fight the misconception that public-inboxes are
centralized, anchor "#mirror" to the clone instructions and
place an emphasis on "mirror", not just cloning.

While we're at it, better describe multi-epoch -V2 inboxes,
since some users do not seem to realize epochs consist of
different data.
Diffstat (limited to 'lib')
-rw-r--r--lib/PublicInbox/WwwStream.pm37
1 files changed, 23 insertions, 14 deletions
diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm
index e06e3456..f1b5119a 100644
--- a/lib/PublicInbox/WwwStream.pm
+++ b/lib/PublicInbox/WwwStream.pm
@@ -50,9 +50,10 @@ sub html_top ($) {
         } elsif ($ctx->{qp}->{t}) {
                 $top = qq(<a\nhref="./">$top</a>);
         }
-        my $links = "<a\nhref=\"$help\">help</a> / ".
-                        "<a\nhref=\"$color\">color</a> / ".
-                        "<a\nhref=\"$atom\">Atom feed</a>";
+        my $links = qq(<a\nhref="$help">help</a> / ).
+                        qq(<a\nhref="$color">color</a> / ).
+                        qq(<a\nhref=#mirror>mirror</a> / ).
+                        q(<a\nhref="$atom">Atom feed</a>);
         if ($ibx->search) {
                 my $q_val = delete($ctx->{-q_value_html}) // '';
                 $q_val = qq(\nvalue="$q_val") if $q_val ne '';
@@ -83,7 +84,11 @@ sub code_footer ($) {
 
 sub _html_end {
         my ($ctx) = @_;
-        my $urls = 'Archives are clonable:';
+        my $urls = <<EOF;
+<a
+id=mirror>This inbox may be cloned and mirrored by anyone:</a>
+EOF
+
         my $ibx = $ctx->{-inbox};
         my $desc = ascii_html($ibx->description);
 
@@ -94,12 +99,18 @@ sub _html_end {
         my %seen = ($http => 1);
         if (defined($max)) { # v2
                 for my $i (0..$max) {
-                        # old parts my be deleted:
+                        # 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) {
+                        $urls .= "\n\t# this inbox consists of $nr epochs:";
+                        $urls[0] .= "\t# oldest";
+                        $urls[-1] .= "\t# newest";
+                }
         } else { # v1
                 push @urls, $http;
         }
@@ -111,12 +122,7 @@ sub _html_end {
                 push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
         }
 
-        if (defined($max) || scalar(@urls) > 1) {
-                $urls .= "\n" .
-                        join("\n", map { "\tgit clone --mirror $_" } @urls);
-        } else {
-                $urls .= " git clone --mirror $urls[0]";
-        }
+        $urls .= "\n" .  join("\n", map { "\tgit clone --mirror $_" } @urls);
         if (defined $max) {
                 my $addrs = $ibx->{address};
                 $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
@@ -134,16 +140,19 @@ EOF
         }
 
         my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
-        $urls .= qq(\nExample <a\nhref="$cfg_link">config snippet</a> for mirrors\n);
+        $urls .= <<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 .= "\n";
                 $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
                 $urls .= ' available over NNTP:';
                 $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
         }
         if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
-                $urls .= "\n note: .onion URLs require Tor: ";
+                $urls .= " note: .onion URLs require Tor: ";
                 $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
         }
         '<hr><pre>'.join("\n\n",