# Copyright (C) 2016-2020 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
+# HTML body stream for which yields getline+close methods for
+# generic PSGI servers and callbacks for public-inbox-httpd.
#
-# 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)
+# See PublicInbox::GzipFilter parent class for more info.
package PublicInbox::WwwStream;
use strict;
-use warnings;
+use parent qw(Exporter PublicInbox::GzipFilter);
+our @EXPORT_OK = qw(html_oneshot);
use bytes (); # length
-use PublicInbox::Hval qw(ascii_html prurl);
+use PublicInbox::Hval qw(ascii_html prurl ts2str);
our $TOR_URL = 'https://www.torproject.org/';
our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
-# noop for HTTP.pm (and any other PSGI servers)
-sub close {}
-
sub base_url ($) {
my $ctx = shift;
my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
$base_url;
}
-sub new {
- my ($class, $ctx, $cb) = @_;
-
- bless {
- nr => 0,
- cb => $cb,
- ctx => $ctx,
- base_url => base_url($ctx),
- }, $class;
+sub init {
+ my ($ctx, $cb) = @_;
+ $ctx->{cb} = $cb;
+ $ctx->{base_url} = base_url($ctx);
+ bless $ctx, __PACKAGE__;
}
-sub response {
- my ($class, $ctx, $code, $cb) = @_;
- [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ],
- $class->new($ctx, $cb) ]
+sub async_eml { # for async_blob_cb
+ my ($ctx, $eml) = @_;
+ $ctx->{http_out}->write($ctx->translate($ctx->{cb}->($ctx, $eml)));
}
-sub _html_top ($) {
- my ($self) = @_;
- my $ctx = $self->{ctx};
+sub html_top ($) {
+ my ($ctx) = @_;
my $ibx = $ctx->{-inbox};
my $desc = ascii_html($ibx->description);
my $title = delete($ctx->{-title_html}) // $desc;
my $color = $upfx.'_/text/color';
my $atom = $ctx->{-atom} || $upfx.'new.atom';
my $top = "<b>$desc</b>";
- my $links = "<a\nhref=\"$help\">help</a> / ".
- "<a\nhref=\"$color\">color</a> / ".
- "<a\nhref=\"$atom\">Atom feed</a>";
+ if (my $t_max = $ctx->{-t_max}) {
+ $t_max = ts2str($t_max);
+ $top = qq(<a\nhref="$upfx?t=$t_max">$top</a>);
+ # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss
+ } elsif ($ctx->{qp}->{t}) {
+ $top = qq(<a\nhref="./">$top</a>);
+ }
+ my $links = qq(<a\nhref="$help">help</a> / ).
+ qq(<a\nhref="$color">color</a> / ).
+ qq(<a\nhref=#mirror>mirror</a> / ).
+ qq(<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 '';
'</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
}
+sub coderepos ($) {
+ my ($ctx) = @_;
+ my $ibx = $ctx->{-inbox};
+ my @ret;
+ if (defined(my $cr = $ibx->{coderepo})) {
+ my $cfg = $ctx->{www}->{pi_config};
+ my $env = $ctx->{env};
+ for my $cr_name (@$cr) {
+ my $urls = $cfg->{"coderepo.$cr_name.cgiturl"};
+ if ($urls) {
+ $ret[0] //= <<EOF;
+code repositories for the project(s) associated with this inbox:
+EOF
+ $ret[0] .= "\n\t".prurl($env, $_) for @$urls;
+ }
+ }
+ }
+ @ret; # may be empty
+}
+
sub code_footer ($) {
my ($env) = @_;
my $u = prurl($env, $CODE_URL);
}
sub _html_end {
- my ($self) = @_;
- my $urls = 'Archives are clonable:';
- my $ctx = $self->{ctx};
+ my ($ctx) = @_;
+ 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);
my @urls;
- my $http = $self->{base_url};
+ my $http = $ctx->{base_url};
my $max = $ibx->max_git_epoch;
my $dir = (split(m!/!, $http))[-1];
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;
}
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]";
- }
- if (defined $max) {
- my $addrs = $ibx->{address};
- $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
- $urls .= <<EOF
-
+ $urls .= "\n" . join('', map { "\tgit clone --mirror $_\n" } @urls);
+ my $addrs = $ibx->{address};
+ $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
+ my $v = defined $max ? '-V2' : '-V1';
+ $urls .= <<EOF;
# 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 \\
+ public-inbox-init $v $ibx->{name} $dir/ $http \\
$addrs
public-inbox-index $dir
EOF
- } else { # v1
- $urls .= "\n";
- }
-
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",
$desc,
$urls,
+ coderepos($ctx),
code_footer($ctx->{env})
).'</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 $middle = $self->{cb}) {
- $middle = $middle->($nr, $self->{ctx}) and return $middle;
+ my ($ctx) = @_;
+ my $cb = $ctx->{cb} or return;
+ while (defined(my $x = $cb->($ctx))) { # x = smsg or scalar non-ref
+ if (ref($x)) { # smsg
+ my $eml = $ctx->{-inbox}->smsg_eml($x) or next;
+ $ctx->{smsg} = $x;
+ return $ctx->translate($cb->($ctx, $eml));
+ } else { # scalar
+ return $ctx->translate($x);
+ }
}
-
- delete $self->{cb} ? _html_end($self) : undef;
+ delete $ctx->{cb};
+ $ctx->zflush(_html_end($ctx));
}
-sub oneshot {
+sub html_oneshot ($$;$) {
my ($ctx, $code, $sref) = @_;
- my $self = bless {
- ctx => $ctx,
- base_url => base_url($ctx),
- }, __PACKAGE__;
- my @x = (_html_top($self), $sref ? $$sref : (), _html_end($self));
- my $len = 0;
- $len += bytes::length($_) for @x;
- [ $code, [
- 'Content-Type' => 'text/html; charset=UTF-8',
- 'Content-Length' => $len
- ], \@x ];
+ 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);
+ };
+ $ctx->zmore($$sref) if $sref;
+ my $bdy = $ctx->zflush(_html_end($ctx));
+ $res_hdr->[3] = bytes::length($bdy);
+ [ $code, $res_hdr, [ $bdy ] ]
+}
+
+sub async_next ($) {
+ my ($http) = @_; # PublicInbox::HTTP
+ my $ctx = $http->{forward} or return;
+ eval {
+ if (my $smsg = $ctx->{smsg} = $ctx->{cb}->($ctx)) {
+ $ctx->smsg_blob($smsg);
+ } else {
+ $ctx->{http_out}->write(
+ $ctx->translate(_html_end($ctx)));
+ $ctx->close; # GzipFilter->close
+ }
+ };
+ warn "E: $@" if $@;
+}
+
+sub aresponse {
+ my ($ctx, $code, $cb) = @_;
+ my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
+ init($ctx, $cb);
+ $ctx->psgi_response($code, $res_hdr);
}
1;