]> Sergey Matveev's repositories - public-inbox.git/commitdiff
wwwlisting: use GzipFilter for HTML
authorEric Wong <e@yhbt.net>
Sun, 5 Jul 2020 23:27:23 +0000 (23:27 +0000)
committerEric Wong <e@yhbt.net>
Mon, 6 Jul 2020 20:01:15 +0000 (20:01 +0000)
The changes to GzipFilter here may be beneficial for building
HTML and XML responses in other places, too.

MANIFEST
lib/PublicInbox/GzipFilter.pm
lib/PublicInbox/NoopFilter.pm [new file with mode: 0644]
lib/PublicInbox/WwwListing.pm
t/www_listing.t

index 6de2c72581b78ecadfcc75e20a87eaeb4fd3a863..dcd7a7e5f7b1b2645212dd3e6719b05b7fc8d347 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -159,6 +159,7 @@ lib/PublicInbox/NNTP.pm
 lib/PublicInbox/NNTPD.pm
 lib/PublicInbox/NNTPdeflate.pm
 lib/PublicInbox/NewsWWW.pm
+lib/PublicInbox/NoopFilter.pm
 lib/PublicInbox/Over.pm
 lib/PublicInbox/OverIdx.pm
 lib/PublicInbox/ParentPipe.pm
index 95fced053579cebfc34359138d3077a2afa19847..8cc5ea00bc09880137b623f0b59af6d953dcb2e7 100644 (file)
@@ -42,7 +42,7 @@ sub gzf_maybe ($$) {
 # for GetlineBody (via Qspawn) when NOT using $env->{'pi-httpd.async'}
 # Also used for ->getline callbacks
 sub translate ($$) {
-       my $self = $_[0];
+       my $self = $_[0]; # $_[1] => input
 
        # allocate the zlib context lazily here, instead of in ->new.
        # Deflate contexts are memory-intensive and this object may
@@ -72,10 +72,34 @@ sub write {
        $_[0]->{fh}->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;
+       '';
+}
+
+# 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, Z_FINISH);
+       die "gzip->flush: $err" if $err != Z_OK;
+       $zbuf;
+}
+
 sub close {
        my ($self) = @_;
        my $fh = delete $self->{fh};
-       $fh->write(translate($self, undef));
+       $fh->write(zflush($self));
        $fh->close;
 }
 
diff --git a/lib/PublicInbox/NoopFilter.pm b/lib/PublicInbox/NoopFilter.pm
new file mode 100644 (file)
index 0000000..b9c00ff
--- /dev/null
@@ -0,0 +1,13 @@
+# Copyright (C) 2020 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+package PublicInbox::NoopFilter;
+use strict;
+
+sub new { bless \(my $ignore), __PACKAGE__ }
+
+# noop workalike for PublicInbox::GzipFilter methods
+sub translate { $_[1] // '' }
+sub zmore { $_[1] }
+sub zflush { $_[1] // '' }
+1;
index a3d4e2b3566972796bc6c920568a9a1078d485be..780c97e913b22a9d2427aa4d7cd5a3c80f4a65ea 100644 (file)
@@ -10,6 +10,8 @@ use PublicInbox::Hval qw(ascii_html prurl);
 use PublicInbox::Linkify;
 use PublicInbox::View;
 use PublicInbox::Inbox;
+use PublicInbox::NoopFilter;
+use PublicInbox::GzipFilter qw(gzf_maybe);
 use bytes (); # bytes::length
 use HTTP::Date qw(time2str);
 use Digest::SHA ();
@@ -104,13 +106,15 @@ sub ibx_entry {
 
 sub html ($$) {
        my ($env, $list) = @_;
-       my $title = 'public-inbox';
-       my $out = '';
+       my $h = [ 'Content-Type', 'text/html; charset=UTF-8',
+                       'Content-Length', undef ];
+       my $gzf = gzf_maybe($h, $env) || PublicInbox::NoopFilter::new();
+       my $out = $gzf->zmore('<html><head><title>' .
+                               'public-inbox listing</title>' .
+                               '</head><body><pre>');
        my $code = 404;
        if (@$list) {
-               $title .= ' - listing';
                $code = 200;
-
                # Schwartzian transform since Inbox->modified is expensive
                @$list = sort {
                        $b->[0] <=> $a->[0]
@@ -118,13 +122,14 @@ sub html ($$) {
 
                my $tmp = join("\n", map { ibx_entry(@$_, $env) } @$list);
                my $l = PublicInbox::Linkify->new;
-               $out = '<pre>'.$l->to_html($tmp).'</pre><hr>';
+               $out .= $gzf->zmore($l->to_html($tmp));
+       } else {
+               $out .= $gzf->zmore('no inboxes, yet');
        }
-       $out = "<html><head><title>$title</title></head><body>" . $out;
-       $out .= '<pre>'. PublicInbox::WwwStream::code_footer($env) .
-               '</pre></body></html>';
-
-       my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ];
+       $out .= $gzf->zflush('</pre><hr><pre>'.
+                               PublicInbox::WwwStream::code_footer($env) .
+                               '</pre></body></html>');
+       $h->[3] = bytes::length($out);
        [ $code, $h, [ $out ] ];
 }
 
index 0aededd43ebc669b211ebbd366ec8bec770e85d8..c4511cd1fed11cc46233e24b371b9d5c0f47b7f3 100644 (file)
@@ -35,13 +35,19 @@ like(PublicInbox::WwwListing::fingerprint($bare), qr/\A[a-f0-9]{40}\z/,
 
 sub tiny_test {
        my ($json, $host, $port) = @_;
+       my $tmp;
        my $http = HTTP::Tiny->new;
        my $res = $http->get("http://$host:$port/");
        is($res->{status}, 200, 'got HTML listing');
        like($res->{content}, qr!</html>!si, 'listing looks like HTML');
+
+       $res = $http->get("http://$host:$port/", {'Accept-Encoding'=>'gzip'});
+       is($res->{status}, 200, 'got gzipped HTML listing');
+       IO::Uncompress::Gunzip::gunzip(\(delete $res->{content}) => \$tmp);
+       like($tmp, qr!</html>!si, 'unzipped listing looks like HTML');
+
        $res = $http->get("http://$host:$port/manifest.js.gz");
        is($res->{status}, 200, 'got manifest');
-       my $tmp;
        IO::Uncompress::Gunzip::gunzip(\(delete $res->{content}) => \$tmp);
        unlike($tmp, qr/"modified":\s*"/, 'modified is an integer');
        my $manifest = $json->decode($tmp);