#
# 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 parent qw(Exporter PublicInbox::GzipFilter);
our @EXPORT_OK = qw(html_oneshot);
use bytes (); # length
use PublicInbox::Hval qw(ascii_html prurl);
our $TOR_URL = 'https://www.torproject.org/';
our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
sub base_url ($) {
my $ctx = shift;
my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
chop $base_url; # no trailing slash for clone
$base_url;
}
sub init {
my ($ctx, $cb) = @_;
$ctx->{cb} = $cb;
$ctx->{base_url} = base_url($ctx);
bless $ctx, __PACKAGE__;
}
sub response {
my ($ctx, $code, $cb) = @_;
my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
init($ctx, $cb);
$ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env});
[ $code, $res_hdr, $ctx ]
}
sub async_eml { # ->{async_eml} for async_blob_cb
my ($ctx, $eml) = @_;
$ctx->{http_out}->write($ctx->translate($ctx->{cb}->($ctx, $eml)));
}
sub html_top ($) {
my ($ctx) = @_;
my $ibx = $ctx->{-inbox};
my $desc = ascii_html($ibx->description);
my $title = delete($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 $top = "$desc";
my $links = "help / ".
"color / ".
"Atom feed";
if ($ibx->search) {
my $q_val = delete($ctx->{-q_value_html}) // '';
$q_val = qq(\nvalue="$q_val") if $q_val ne '';
# XXX gross, for SearchView.pm
my $extra = delete($ctx->{-extra_form_html}) // '';
my $action = $upfx eq '' ? './' : $upfx;
$top = qq{}
} else {
$top = '' . $top . "\n" . $links . '
';
}
"$title" .
qq() .
$ctx->{www}->style($upfx) .
''. $top . (delete($ctx->{-html_tip}) // '');
}
sub code_footer ($) {
my ($env) = @_;
my $u = prurl($env, $CODE_URL);
qq(AGPL code for this site: git clone $u)
}
sub _html_end {
my ($ctx) = @_;
my $urls = 'Archives are clonable:';
my $ibx = $ctx->{-inbox};
my $desc = ascii_html($ibx->description);
my @urls;
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:
-d "$ibx->{inboxdir}/git/$i.git" or next;
my $url = "$http/$i";
$seen{$url} = 1;
push @urls, "$url $dir/git/$i.git";
}
} 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($u) : $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 .= <{name} $dir/ $http \\
$addrs
public-inbox-index $dir
EOF
} else { # v1
$urls .= "\n";
}
my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
$urls .= qq(\nExample config snippet for mirrors\n);
my @nntp = map { qq($_) } @{$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 .= qq[$TOR_URL];
}
'
'.join("\n\n",
$desc,
$urls,
code_footer($ctx->{env})
).'
';
}
# callback for HTTP.pm (and any other PSGI servers)
sub getline {
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 $ctx->{cb};
$ctx->zflush(_html_end($ctx));
}
sub html_oneshot ($$;$) {
my ($ctx, $code, $sref) = @_;
$ctx->{base_url} = base_url($ctx);
bless $ctx, __PACKAGE__;
my @bdy;
my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8',
'Content-Length' => undef ];
$ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env});
$ctx->zmore(html_top($ctx));
$ctx->zmore($$sref) if $sref;
$bdy[0] = $ctx->zflush(_html_end($ctx));
$res_hdr->[3] = bytes::length($bdy[0]);
[ $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, \&async_next, \&async_eml);
}
1;