1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
| | # Copyright (C) 2020 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# Qspawn filter
package PublicInbox::GzipFilter;
use strict;
use parent qw(Exporter);
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 }
# for Qspawn if using $env->{'pi-httpd.async'}
sub attach {
my ($self, $http_out) = @_;
$self->{http_out} = $http_out;
$self
}
sub gz_or_noop {
my ($res_hdr, $env) = @_;
if (($env->{HTTP_ACCEPT_ENCODING} // '') =~ /\bgzip\b/) {
$env->{'plack.skip-deflater'} = 1;
push @$res_hdr, @GZIP_HDRS;
gzip_or_die();
} else {
PublicInbox::CompressNoop::new();
}
}
sub gzf_maybe ($$) { bless { gz => gz_or_noop(@_) }, __PACKAGE__ }
sub psgi_response {
my ($self, $code, $res_hdr, $next_cb, $eml_cb) = @_;
my $env = $self->{env};
$self->{gz} //= gz_or_noop($res_hdr, $env);
if ($env->{'pi-httpd.async'}) {
$self->{async_next} = $next_cb;
$self->{async_eml} = $eml_cb;
my $http = $env->{'psgix.io'}; # PublicInbox::HTTP
$http->{forward} = $self;
sub {
my ($wcb) = @_; # -httpd provided write callback
$self->{http_out} = $wcb->([$code, $res_hdr]);
$next_cb->($http); # start stepping
};
} else { # generic PSGI code path
[ $code, $res_hdr, $self ];
}
}
sub qsp_maybe ($$) {
my ($res_hdr, $env) = @_;
return if ($env->{HTTP_ACCEPT_ENCODING} // '') !~ /\bgzip\b/;
my $hdr = join("\n", @$res_hdr);
return if $hdr !~ m!^Content-Type\n
(?:(?:text/(?:html|plain))|
application/atom\+xml)\b!ixsm;
return if $hdr =~ m!^Content-Encoding\ngzip\n!smi;
return if $hdr =~ m!^Content-Length\n[0-9]+\n!smi;
return if $hdr =~ m!^Transfer-Encoding\n!smi;
# in case Plack::Middleware::Deflater is loaded:
return if $env->{'plack.skip-deflater'}++;
push @$res_hdr, @GZIP_HDRS;
bless {}, __PACKAGE__;
}
sub gzip_or_die () {
my ($gz, $err) = Compress::Raw::Zlib::Deflate->new(%OPT);
$err == Z_OK or die "Deflate->new failed: $err";
$gz;
}
# for GetlineBody (via Qspawn) when NOT using $env->{'pi-httpd.async'}
# Also used for ->getline callbacks
sub translate ($$) {
my $self = $_[0]; # $_[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;
'';
} else { # undef == EOF
my $err = $gz->flush($zbuf);
die "gzip->flush: $err" if $err != Z_OK;
$zbuf;
}
}
sub write {
# my $ret = bytes::length($_[1]); # XXX does anybody care?
$_[0]->{http_out}->write(translate($_[0], $_[1]));
}
# 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;
}
# 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};
my $err;
if (defined $_[1]) {
$err = $gz->deflate($_[1], $zbuf);
die "gzip->deflate: $err" if $err != Z_OK;
}
$err = $gz->flush($zbuf);
die "gzip->flush: $err" if $err != Z_OK;
$zbuf;
}
sub close {
my ($self) = @_;
if (my $http_out = delete $self->{http_out}) {
$http_out->write(zflush($self));
$http_out->close;
}
}
# 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'} or return; # client abort
my $smsg = $self->{smsg} or die '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
return $http->next_step($self->{async_next});
}
$smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
$self->{async_eml}->($self, PublicInbox::Eml->new($bref));
$http->next_step($self->{async_next});
}
sub smsg_blob {
my ($self, $smsg) = @_;
git_async_cat($self->{-inbox}->git, $smsg->{blob},
\&async_blob_cb, $self);
}
1;
|