# 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 base qw(Exporter);
+use parent qw(Exporter PublicInbox::GzipFilter);
our @EXPORT_OK = qw(html_oneshot);
use bytes (); # length
use PublicInbox::Hval qw(ascii_html prurl);
-use Compress::Raw::Zlib qw(Z_FINISH Z_OK);
-use PublicInbox::GzipFilter qw(gzip_maybe gzf_maybe);
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) = @_;
- my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ];
- my $self = $class->new($ctx, $cb);
- $self->{gzf} = gzf_maybe($h, $ctx->{env});
- [ $code, $h, $self ]
+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;
}
sub _html_end {
- my ($self) = @_;
+ my ($ctx) = @_;
my $urls = 'Archives are clonable:';
- my $ctx = $self->{ctx};
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);
# callback for HTTP.pm (and any other PSGI servers)
sub getline {
- my ($self) = @_;
- my $nr = $self->{nr}++;
-
- my $buf = do {
- if ($nr == 0) {
- _html_top($self);
- } elsif (my $middle = $self->{cb}) {
- $middle->($nr, $self->{ctx});
+ 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);
-
- # gzf may be GzipFilter, `undef' or `0'
- my $gzf = $self->{gzf} or return $buf;
-
- return $gzf->translate($buf) if defined $buf;
- $self->{gzf} = 0; # next call to ->getline returns $buf (== undef)
- $gzf->translate(undef);
+ }
+ delete $ctx->{cb};
+ $ctx->zflush(_html_end($ctx));
}
sub html_oneshot ($$;$) {
my ($ctx, $code, $sref) = @_;
- my $self = bless {
- ctx => $ctx,
- base_url => base_url($ctx),
- }, __PACKAGE__;
- my @x;
- my $h = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
- if (my $gz = gzip_maybe($h, $ctx->{env})) {
- my $err = $gz->deflate(_html_top($self), $x[0]);
- die "gzip->deflate: $err" if $err != Z_OK;
- if ($sref) {
- $err = $gz->deflate($sref, $x[0]);
- die "gzip->deflate: $err" if $err != Z_OK;
+ 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
}
- $err = $gz->deflate(_html_end($self), $x[0]);
- die "gzip->deflate: $err" if $err != Z_OK;
- $err = $gz->flush($x[0], Z_FINISH);
- die "gzip->flush: $err" if $err != Z_OK;
- } else {
- @x = (_html_top($self), $sref ? $$sref : (), _html_end($self));
- }
+ };
+ warn "E: $@" if $@;
+}
- my $len = 0;
- $len += bytes::length($_) for @x;
- push @$h, 'Content-Length', $len;
- [ $code, $h, \@x ]
+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;