]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WwwStream.pm
cleanup: use '$ibx' consistently when referring to Inbox refs
[public-inbox.git] / lib / PublicInbox / WwwStream.pm
index c89e6de41822a7571c06864074ff984bcf6a7151..8b79923b64efeab0946e18b1b3bf03094dd6a5fc 100644 (file)
@@ -1,16 +1,22 @@
-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # HTML body stream for which yields getline+close methods
+#
+# public-inbox-httpd favors "getline" response bodies to take a
+# "pull"-based approach to feeding slow clients (as opposed to a
+# more common "push" model)
 package PublicInbox::WwwStream;
 use strict;
 use warnings;
 use PublicInbox::Hval qw(ascii_html);
 use URI;
 our $TOR_URL = 'https://www.torproject.org/';
+our $TOR2WEB_URL = 'https://www.tor2web.org/';
 our $CODE_URL = 'https://public-inbox.org/';
 our $PROJECT = 'public-inbox';
 
+# noop for HTTP.pm (and any other PSGI servers)
 sub close {}
 
 sub new {
@@ -27,17 +33,19 @@ sub response {
 sub _html_top ($) {
        my ($self) = @_;
        my $ctx = $self->{ctx};
-       my $obj = $ctx->{-inbox};
-       my $desc = ascii_html($obj->description);
+       my $ibx = $ctx->{-inbox};
+       my $desc = ascii_html($ibx->description);
        my $title = $ctx->{-title_html} || $desc;
        my $upfx = $ctx->{-upfx} || '';
        my $help = $upfx.'_/text/help';
+       my $color = $upfx.'_/text/color';
        my $atom = $ctx->{-atom} || $upfx.'new.atom';
        my $tip = $ctx->{-html_tip} || '';
        my $top = "<b>$desc</b>";
        my $links = "<a\nhref=\"$help\">help</a> / ".
+                       "<a\nhref=\"$color\">color</a> / ".
                        "<a\nhref=\"$atom\">Atom feed</a>";
-       if ($obj->search) {
+       if ($ibx->search) {
                my $q_val = $ctx->{-q_value_html};
                if (defined $q_val && $q_val ne '') {
                        $q_val = qq(\nvalue="$q_val");
@@ -59,7 +67,7 @@ sub _html_top ($) {
        "<html><head><title>$title</title>" .
                "<link\nrel=alternate\ntitle=\"Atom feed\"\n".
                "href=\"$atom\"\ntype=\"application/atom+xml\"/>" .
-               PublicInbox::Hval::STYLE .
+               $ctx->{www}->style($upfx) .
                "</head><body>". $top . $tip;
 }
 
@@ -67,26 +75,56 @@ sub _html_end {
        my ($self) = @_;
        my $urls = 'Archives are clonable:';
        my $ctx = $self->{ctx};
-       my $obj = $ctx->{-inbox};
-       my $desc = ascii_html($obj->description);
+       my $ibx = $ctx->{-inbox};
+       my $desc = ascii_html($ibx->description);
 
-       my $http = $obj->base_url($ctx->{env});
-       chop $http;
-       my %seen = ( $http => 1 );
-       my @urls = ($http);
-       foreach my $u (@{$obj->cloneurl}) {
+       my (%seen, @urls);
+       my $http = $ibx->base_url($ctx->{env});
+       chop $http; # no trailing slash for clone
+       my $part = $ibx->max_git_part;
+       my $dir = (split(m!/!, $http))[-1];
+       if (defined($part)) { # v2
+               $seen{$http} = 1;
+               for my $i (0..$part) {
+                       # old parts my be deleted:
+                       -d "$ibx->{mainrepo}/git/$i.git" or next;
+                       my $url = "$http/$i";
+                       $seen{$url} = 1;
+                       push @urls, "$url $dir/git/$i.git";
+               }
+       } else { # v1
+               $seen{$http} = 1;
+               push @urls, $http;
+       }
+
+       # FIXME: partitioning in can be different in other repositories,
+       # use the "cloneurl" file as-is for now:
+       foreach my $u (@{$ibx->cloneurl}) {
                next if $seen{$u};
                $seen{$u} = 1;
                push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
        }
-       if (scalar(@urls) == 1) {
-               $urls .= " git clone --mirror $http";
-       } else {
+
+       if (defined($part) || scalar(@urls) > 1) {
                $urls .= "\n" .
                        join("\n", map { "\tgit clone --mirror $_" } @urls);
+       } else {
+               $urls .= " git clone --mirror $urls[0]";
        }
+       if (defined $part) {
+               my $addrs = $ibx->{address};
+               $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
+               $urls .=  <<EOF
+
 
-       my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$obj->nntp_url};
+       # If you have public-inbox 1.1+ installed, you may
+       # initialize and index your mirror using the following commands:
+       public-inbox-init -V2 $ibx->{name} $dir/ $http \\
+               $addrs
+       public-inbox-index $dir
+EOF
+       }
+       my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
        if (@nntp) {
                $urls .= "\n\n";
                $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
@@ -96,24 +134,29 @@ sub _html_end {
        if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
                $urls .= "\n note: .onion URLs require Tor: ";
                $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
+               if ($TOR2WEB_URL) {
+                       $urls .= "\n       or Tor2web: ";
+                       $urls .= qq[<a\nhref="$TOR2WEB_URL">$TOR2WEB_URL</a>];
+               }
        }
        my $url = PublicInbox::Hval::prurl($ctx->{env}, $CODE_URL);
        '<hr><pre>'.join("\n\n",
                $desc,
                $urls,
-               'Code for this site: '.
+               'AGPL code for this site: '.
                qq(git clone <a\nhref="$url">$url</a> $PROJECT)
        ).'</pre></body></html>';
 }
 
+# callback for HTTP.pm (and any other PSGI servers)
 sub getline {
        my ($self) = @_;
        my $nr = $self->{nr}++;
 
        return _html_top($self) if $nr == 0;
 
-       if (my $mid = $self->{cb}) { # middle
-               $mid = $mid->($nr, $self->{ctx}) and return $mid;
+       if (my $middle = $self->{cb}) {
+               $middle = $middle->($nr, $self->{ctx}) and return $middle;
        }
 
        delete $self->{cb} ? _html_end($self) : undef;