-# Copyright (C) 2020 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>
-
-# Qspawn filter
+#
+# In public-inbox <=1.5.0, public-inbox-httpd favored "getline"
+# response bodies to take a "pull"-based approach to feeding
+# slow clients (as opposed to a more common "push" model).
+#
+# In newer versions, public-inbox-httpd supports a backpressure-aware
+# pull/push model which also accounts for slow git blob storage.
+# async_next callbacks only run when the DS {wbuf} is drained
+# async_eml callbacks only run when a blob arrives from git.
+#
+# We continue to support getline+close for generic PSGI servers.
package PublicInbox::GzipFilter;
use strict;
use parent qw(Exporter);
-use Compress::Raw::Zlib qw(Z_FINISH Z_OK);
+use Compress::Raw::Zlib qw(Z_OK);
+use PublicInbox::CompressNoop;
+use PublicInbox::Eml;
+use PublicInbox::GitAsyncCat;
+
our @EXPORT_OK = qw(gzf_maybe);
my %OPT = (-WindowBits => 15 + 16, -AppendOutput => 1);
my @GZIP_HDRS = qw(Vary Accept-Encoding Content-Encoding gzip);
-sub new { bless {}, shift }
+sub new { bless {}, shift } # qspawn filter
# for Qspawn if using $env->{'pi-httpd.async'}
sub attach {
- my ($self, $fh) = @_;
- $self->{fh} = $fh;
+ my ($self, $http_out) = @_;
+ $self->{http_out} = $http_out; # PublicInbox::HTTP::{Chunked,Identity}
$self
}
-# returns `0' and not `undef' on failure (see Www*Stream)
-sub gzf_maybe ($$) {
+sub gz_or_noop {
my ($res_hdr, $env) = @_;
- return 0 if (($env->{HTTP_ACCEPT_ENCODING}) // '') !~ /\bgzip\b/;
- my ($gz, $err) = Compress::Raw::Zlib::Deflate->new(%OPT);
- return 0 if $err != Z_OK;
+ if (($env->{HTTP_ACCEPT_ENCODING} // '') =~ /\bgzip\b/) {
+ $env->{'plack.skip-deflater'} = 1;
+ push @$res_hdr, @GZIP_HDRS;
+ gzip_or_die();
+ } else {
+ PublicInbox::CompressNoop::new();
+ }
+}
- # in case Plack::Middleware::Deflater is loaded:
- $env->{'plack.skip-deflater'} = 1;
- push @$res_hdr, @GZIP_HDRS;
- bless { gz => $gz }, __PACKAGE__;
+sub gzf_maybe ($$) { bless { gz => gz_or_noop(@_) }, __PACKAGE__ }
+
+sub psgi_response {
+ # $code may be an HTTP response code (e.g. 200) or a CODE ref (mbox_hdr)
+ my ($self, $code, $res_hdr) = @_;
+ if ($self->{env}->{'pi-httpd.async'}) {
+ my $http = $self->{env}->{'psgix.io'}; # PublicInbox::HTTP
+ $http->{forward} = $self;
+ sub {
+ my ($wcb) = @_; # -httpd provided write callback
+ $self->{wcb_args} = [ $code, $res_hdr, $wcb ];
+ $self->can('async_next')->($http); # start stepping
+ };
+ } else { # generic PSGI code path
+ ref($code) eq 'CODE' and
+ ($code, $res_hdr) = @{$code->($self)};
+ $self->{gz} //= gz_or_noop($res_hdr, $self->{env});
+ [ $code, $res_hdr, $self ];
+ }
}
sub qsp_maybe ($$) {
$gz;
}
+sub gone { # what: search/over/mm
+ my ($ctx, $what) = @_;
+ warn "W: `$ctx->{ibx}->{name}' $what went away unexpectedly\n";
+ undef;
+}
+
# for GetlineBody (via Qspawn) when NOT using $env->{'pi-httpd.async'}
# Also used for ->getline callbacks
-sub translate ($$) {
- my $self = $_[0]; # $_[1] => input
+sub translate {
+ my $self = shift; # $_[1] => input
# allocate the zlib context lazily here, instead of in ->new.
# Deflate contexts are memory-intensive and this object may
# be sitting in the Qspawn limiter queue for a while.
- my $gz = $self->{gz} //= gzip_or_die();
- my $zbuf = delete($self->{zbuf});
- if (defined $_[1]) { # my $buf = $_[1];
- my $err = $gz->deflate($_[1], $zbuf);
- die "gzip->deflate: $err" if $err != Z_OK;
- return $zbuf if length($zbuf) >= 8192;
-
- $self->{zbuf} = $zbuf;
- '';
+ $self->{gz} //= gzip_or_die();
+ if (defined $_[0]) { # my $buf = $_[1];
+ zmore($self, @_);
+ length($self->{zbuf}) >= 8192 ? delete($self->{zbuf}) : '';
} else { # undef == EOF
- my $err = $gz->flush($zbuf, Z_FINISH);
- die "gzip->flush: $err" if $err != Z_OK;
- $zbuf;
+ zflush($self);
}
}
+# returns PublicInbox::HTTP::{Chunked,Identity}
+sub http_out ($) {
+ my ($self) = @_;
+ $self->{http_out} // do {
+ my $args = delete $self->{wcb_args} // return undef;
+ my $wcb = pop @$args; # from PublicInbox:HTTP async
+ # $args->[0] may be \&mbox_hdr or similar
+ $args = $args->[0]->($self) if ref($args->[0]) eq 'CODE';
+ $self->{gz} //= gz_or_noop($args->[1], $self->{env});
+ $self->{http_out} = $wcb->($args); # $wcb->([$code, $hdr_ary])
+ };
+}
+
sub write {
+ my $self = shift;
# my $ret = bytes::length($_[1]); # XXX does anybody care?
- $_[0]->{fh}->write(translate($_[0], $_[1]));
+ http_out($self)->write($self->translate(@_));
+}
+
+sub zfh {
+ $_[0]->{zfh} // do {
+ open($_[0]->{zfh}, '>>', \($_[0]->{pbuf} //= '')) or
+ die "open: $!";
+ $_[0]->{zfh}
+ };
}
# similar to ->translate; use this when we're sure we know we have
# more data to buffer after this
sub zmore {
- my $self = $_[0]; # $_[1] => input
- my $err = $self->{gz}->deflate($_[1], $self->{zbuf});
- die "gzip->deflate: $err" if $err != Z_OK;
- undef;
+ my $self = shift;
+ my $zfh = delete $self->{zfh};
+ if (@_ > 1 || $zfh) {
+ print { $zfh // zfh($self) } @_;
+ @_ = (delete $self->{pbuf});
+ delete $self->{zfh};
+ };
+ http_out($self);
+ my $err;
+ ($err = $self->{gz}->deflate($_[0], $self->{zbuf})) == Z_OK or
+ die "gzip->deflate: $err";
}
# flushes and returns the final bit of gzipped data
-sub zflush ($;$) {
- my $self = $_[0]; # $_[1] => final input (optional)
- my $zbuf = delete $self->{zbuf};
- my $gz = delete $self->{gz};
+sub zflush ($;@) {
+ my $self = shift; # $_[1..Inf] => final input (optional)
+ zmore($self, @_) if scalar(@_) || $self->{zfh};
+ # not a bug, recursing on DS->write failure
+ my $gz = delete $self->{gz} // return '';
my $err;
- if (defined $_[1]) {
- $err = $gz->deflate($_[1], $zbuf);
- die "gzip->deflate: $err" if $err != Z_OK;
- }
- $err = $gz->flush($zbuf, Z_FINISH);
- die "gzip->flush: $err" if $err != Z_OK;
+ my $zbuf = delete $self->{zbuf};
+ ($err = $gz->flush($zbuf)) == Z_OK or die "gzip->flush: $err";
$zbuf;
}
sub close {
my ($self) = @_;
- my $fh = delete $self->{fh};
- $fh->write(zflush($self));
- $fh->close;
+ my $http_out = http_out($self) // return;
+ $http_out->write($self->zflush);
+ (delete($self->{http_out}) // return)->close;
+}
+
+sub bail {
+ my $self = shift;
+ if (my $env = $self->{env}) {
+ warn @_, "\n";
+ my $http = $env->{'psgix.io'} or return; # client abort
+ eval { $http->close }; # should hit our close
+ warn "E: error in http->close: $@" if $@;
+ eval { $self->close }; # just in case...
+ warn "E: error in self->close: $@" if $@;
+ } else {
+ warn @_, "\n";
+ }
+}
+
+# this is public-inbox-httpd-specific
+sub async_blob_cb { # git->cat_async callback
+ my ($bref, $oid, $type, $size, $self) = @_;
+ my $http = $self->{env}->{'psgix.io'}; # PublicInbox::HTTP
+ $http->{forward} or return; # client aborted
+ my $smsg = $self->{smsg} or bail($self, 'BUG: no smsg');
+ if (!defined($oid)) {
+ # it's possible to have TOCTOU if an admin runs
+ # public-inbox-(edit|purge), just move onto the next message
+ warn "E: $smsg->{blob} missing in $self->{ibx}->{inboxdir}\n";
+ return $http->next_step($self->can('async_next'));
+ }
+ $smsg->{blob} eq $oid or bail($self, "BUG: $smsg->{blob} != $oid");
+ eval { $self->async_eml(PublicInbox::Eml->new($bref)) };
+ bail($self, "E: async_eml: $@") if $@;
+ if ($self->{-low_prio}) { # run via PublicInbox::WWW::event_step
+ push(@{$self->{www}->{-low_prio_q}}, $self) == 1 and
+ PublicInbox::DS::requeue($self->{www});
+ } else {
+ $http->next_step($self->can('async_next'));
+ }
+}
+
+sub smsg_blob {
+ my ($self, $smsg) = @_;
+ ibx_async_cat($self->{ibx}, $smsg->{blob}, \&async_blob_cb, $self);
}
1;