]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WwwStream.pm
www_coderepo: an alternative to cgit
[public-inbox.git] / lib / PublicInbox / WwwStream.pm
index c960edc52fdc545503e9d73ec8444f04c812e62e..92d243eb09fd172e6cfcc1d25575e94d246dd5a3 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) 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 for
@@ -18,7 +18,7 @@ https://public-inbox.org/public-inbox.git) ];
 
 sub base_url ($) {
        my $ctx = shift;
-       my $base_url = $ctx->{ibx}->base_url($ctx->{env});
+       my $base_url = ($ctx->{ibx} // $ctx->{git})->base_url($ctx->{env});
        chop $base_url; # no trailing slash for clone
        $base_url;
 }
@@ -27,17 +27,20 @@ sub init {
        my ($ctx, $cb) = @_;
        $ctx->{cb} = $cb;
        $ctx->{base_url} = base_url($ctx);
+       $ctx->{-res_hdr} = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
+       $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($ctx->{-res_hdr},
+                                                       $ctx->{env});
        bless $ctx, __PACKAGE__;
 }
 
 sub async_eml { # for async_blob_cb
        my ($ctx, $eml) = @_;
-       $ctx->{http_out}->write($ctx->translate($ctx->{cb}->($ctx, $eml)));
+       $ctx->write($ctx->{cb}->($ctx, $eml));
 }
 
 sub html_top ($) {
        my ($ctx) = @_;
-       my $ibx = $ctx->{ibx};
+       my $ibx = $ctx->{ibx} // $ctx->{git};
        my $desc = ascii_html($ibx->description);
        my $title = delete($ctx->{-title_html}) // $desc;
        my $upfx = $ctx->{-upfx} || '';
@@ -49,6 +52,8 @@ sub html_top ($) {
        # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss
        } elsif ($ctx->{qp}->{t}) {
                $top = qq(<a\nhref="./">$top</a>);
+       } elsif (length($upfx)) {
+               $top = qq(<a\nhref="$upfx">$top</a>);
        }
        my $code = $ibx->{coderepo} ? qq( / <a\nhref=#code>code</a>) : '';
        # id=mirror must exist for legacy bookmarks
@@ -79,22 +84,25 @@ sub html_top ($) {
                '</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
 }
 
+sub inboxes { () } # TODO
+
 sub coderepos ($) {
        my ($ctx) = @_;
+       $ctx->{ibx} // return inboxes($ctx);
        my $cr = $ctx->{ibx}->{coderepo} // return ();
        my $cfg = $ctx->{www}->{pi_cfg};
        my $upfx = ($ctx->{-upfx} // ''). '../';
-       my @ret;
+       my $pfx = $ctx->{base_url} //= $ctx->base_url;
+       my $up = $upfx =~ tr!/!/!;
+       $pfx =~ s!/[^/]+\z!/! for (1..$up);
+       my @ret = ('<a id=code>' .
+               'Code repositories for project(s) associated with this '.
+               $ctx->{ibx}->thing_type . "\n");
        for my $cr_name (@$cr) {
-               $ret[0] //= <<EOF;
-<a id=code>code repositories for project(s) associated with this inbox:
-EOF
                my $urls = $cfg->get_all("coderepo.$cr_name.cgiturl");
                if ($urls) {
                        for (@$urls) {
-                               # relative or absolute URL?, prefix relative
-                               # "foo.git" with appropriate number of "../"
-                               my $u = m!\A(?:[a-z\+]+:)?//! ? $_ : $upfx.$_;
+                               my $u = m!\A(?:[a-z\+]+:)?//! ? $_ : $pfx.$_;
                                $u = ascii_html(prurl($ctx->{env}, $u));
                                $ret[0] .= qq(\n\t<a\nhref="$u">$u</a>);
                        }
@@ -107,10 +115,45 @@ EOF
 
 sub _html_end {
        my ($ctx) = @_;
-       my @cr = coderepos($ctx);
-       scalar(@cr) ?
-               '<hr><pre>'.join("\n\n", @cr).'</pre></body></html>' :
-               '</body></html>';
+       my $upfx = $ctx->{-upfx} || '';
+       my $m = "${upfx}_/text/mirror/";
+       my $x = '';
+       if ($ctx->{ibx} && $ctx->{ibx}->can('cloneurl')) {
+               $x = <<EOF;
+This is a public inbox, see <a
+href="$m">mirroring instructions</a>
+for how to clone and mirror all data and code used for this inbox
+EOF
+               my $has_nntp = @{$ctx->{ibx}->nntp_url($ctx)};
+               my $has_imap = @{$ctx->{ibx}->imap_url($ctx)};
+               if ($has_nntp || $has_imap) {
+                       substr($x, -1, 1) = ";\n"; # s/\n/;\n
+                       if ($has_nntp && $has_imap) {
+                               $x .= <<EOM;
+as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).
+EOM
+                       } elsif ($has_nntp) {
+                               $x .= <<EOM;
+as well as URLs for NNTP newsgroup(s).
+EOM
+                       } else {
+                               $x .= <<EOM;
+as well as URLs for IMAP folder(s).
+EOM
+                       }
+               }
+       } elsif ($ctx->{ibx}) { # extindex
+               $x = <<EOF;
+This is an external index of several public inboxes,
+see <a href="$m">mirroring instructions</a> on how to clone and mirror
+all data and code used by this external index.
+EOF
+       } elsif ($ctx->{git}) { # coderepo
+               $x = join('', map { "git clone $_\n" }
+                       @{$ctx->{git}->cloneurl($ctx->{env})});
+       }
+       chomp $x;
+       '<hr><pre>'.join("\n\n", coderepos($ctx), $x).'</pre></body></html>'
 }
 
 # callback for HTTP.pm (and any other PSGI servers)
@@ -130,18 +173,26 @@ sub getline {
        $ctx->zflush(_html_end($ctx));
 }
 
-sub html_oneshot ($$;$) {
-       my ($ctx, $code, $sref) = @_;
+sub html_done ($;@) {
+       my $ctx = $_[0];
+       my $bdy = $ctx->zflush(@_[1..$#_], _html_end($ctx));
+       my $res_hdr = delete $ctx->{-res_hdr};
+       push @$res_hdr, 'Content-Length', length($bdy);
+       [ 200, $res_hdr, [ $bdy ] ]
+}
+
+sub html_oneshot ($$;@) {
+       my ($ctx, $code) = @_[0, 1];
        my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8',
                'Content-Length' => undef ];
        bless $ctx, __PACKAGE__;
        $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env});
-       $ctx->{base_url} //= do {
-               $ctx->zmore(html_top($ctx));
-               base_url($ctx);
+       my @top;
+       $ctx->{base_url} // do {
+               @top = html_top($ctx);
+               $ctx->{base_url} = base_url($ctx);
        };
-       $ctx->zmore($$sref) if $sref;
-       my $bdy = $ctx->zflush(_html_end($ctx));
+       my $bdy = $ctx->zflush(@top, @_[2..$#_], _html_end($ctx));
        $res_hdr->[3] = length($bdy);
        [ $code, $res_hdr, [ $bdy ] ]
 }
@@ -153,8 +204,7 @@ sub async_next ($) {
                if (my $smsg = $ctx->{smsg} = $ctx->{cb}->($ctx)) {
                        $ctx->smsg_blob($smsg);
                } else {
-                       $ctx->{http_out}->write(
-                                       $ctx->translate(_html_end($ctx)));
+                       $ctx->write(_html_end($ctx));
                        $ctx->close; # GzipFilter->close
                }
        };
@@ -162,10 +212,23 @@ sub async_next ($) {
 }
 
 sub aresponse {
-       my ($ctx, $code, $cb) = @_;
-       my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
+       my ($ctx, $cb) = @_;
        init($ctx, $cb);
-       $ctx->psgi_response($code, $res_hdr);
+       $ctx->psgi_response(200, delete $ctx->{-res_hdr});
+}
+
+sub html_init {
+       my ($ctx) = @_;
+       $ctx->{base_url} = base_url($ctx);
+       my $h = $ctx->{-res_hdr} = ['Content-Type', 'text/html; charset=UTF-8'];
+       $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($h, $ctx->{env});
+       bless $ctx, __PACKAGE__;
+       print { $ctx->zfh } html_top($ctx);
+}
+
+sub DESTROY {
+       my ($ctx) = @_;
+       $ctx->{git}->cleanup if $ctx->{git} && $ctx->{git}->{-tmp};
 }
 
 1;