]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WwwStream.pm
wwwstream: use parent.pm and no warnings
[public-inbox.git] / lib / PublicInbox / WwwStream.pm
index 6696cc35d4d1e24e402ab6ad49f03275a0761333..fd558e1b799bb45c8a86797f6b78d0afdcab483a 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 all contributors <meta@public-inbox.org>
+# 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
@@ -8,58 +8,57 @@
 # more common "push" model)
 package PublicInbox::WwwStream;
 use strict;
-use warnings;
-use PublicInbox::Hval qw(ascii_html);
+use parent qw(Exporter);
+our @EXPORT_OK = qw(html_oneshot);
+use bytes (); # length
+use PublicInbox::Hval qw(ascii_html prurl);
+use PublicInbox::GzipFilter qw(gzf_maybe);
 our $TOR_URL = 'https://www.torproject.org/';
-our $CODE_URL = 'https://public-inbox.org/';
-our $PROJECT = 'public-inbox';
+our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
 
 # noop for HTTP.pm (and any other PSGI servers)
 sub close {}
 
-sub new {
-       my ($class, $ctx, $cb) = @_;
-
+sub base_url ($) {
+       my $ctx = shift;
        my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
        chop $base_url; # no trailing slash for clone
-       bless {
-               nr => 0,
-               cb => $cb || *close,
-               ctx => $ctx,
-               base_url => $base_url,
-       }, $class;
+       $base_url;
+}
+
+sub init {
+       my ($ctx, $cb) = @_;
+       $ctx->{cb} = $cb;
+       $ctx->{base_url} = base_url($ctx);
+       bless $ctx, __PACKAGE__;
 }
 
 sub response {
-       my ($class, $ctx, $code, $cb) = @_;
-       [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ],
-         $class->new($ctx, $cb) ]
+       my ($ctx, $code, $cb) = @_;
+       my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ];
+       init($ctx, $cb);
+       $ctx->{gzf} = gzf_maybe($h, $ctx->{env});
+       [ $code, $h, $ctx ]
 }
 
-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 = $ctx->{-title_html} || $desc;
+       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 $tip = $ctx->{-html_tip} || '';
        my $top = "<b>$desc</b>";
        my $links = "<a\nhref=\"$help\">help</a> / ".
                        "<a\nhref=\"$color\">color</a> / ".
                        "<a\nhref=\"$atom\">Atom feed</a>";
        if ($ibx->search) {
-               my $q_val = $ctx->{-q_value_html};
-               if (defined $q_val && $q_val ne '') {
-                       $q_val = qq(\nvalue="$q_val");
-               } else {
-                       $q_val = '';
-               }
+               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 = $ctx->{-extra_form_html} || '';
+               my $extra = delete($ctx->{-extra_form_html}) // '';
                my $action = $upfx eq '' ? './' : $upfx;
                $top = qq{<form\naction="$action"><pre>$top} .
                          qq{\n<input\nname=q\ntype=text$q_val />} .
@@ -71,31 +70,30 @@ sub _html_top ($) {
                $top = '<pre>' . $top . "\n" . $links . '</pre>';
        }
        "<html><head><title>$title</title>" .
-               "<link\nrel=alternate\ntitle=\"Atom feed\"\n".
-               "href=\"$atom\"\ntype=\"application/atom+xml\"/>" .
+               qq(<link\nrel=alternate\ntitle="Atom feed"\n).
+               qq(href="$atom"\ntype="application/atom+xml"/>) .
                $ctx->{www}->style($upfx) .
-               "</head><body>". $top . $tip;
+               '</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
 }
 
 sub code_footer ($) {
        my ($env) = @_;
-       my $u = PublicInbox::Hval::prurl($env, $CODE_URL);
-       qq(AGPL code for this site: git clone <a\nhref="$u">$u</a> $PROJECT)
+       my $u = prurl($env, $CODE_URL);
+       qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
 }
 
 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 (%seen, @urls);
-       my $http = $self->{base_url};
+       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
-               $seen{$http} = 1;
                for my $i (0..$max) {
                        # old parts my be deleted:
                        -d "$ibx->{inboxdir}/git/$i.git" or next;
@@ -104,15 +102,13 @@ sub _html_end {
                        push @urls, "$url $dir/git/$i.git";
                }
        } else { # v1
-               $seen{$http} = 1;
                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};
-               $seen{$u} = 1;
+               next if $seen{$u}++;
                push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
        }
 
@@ -160,16 +156,36 @@ EOF
 
 # callback for HTTP.pm (and any other PSGI servers)
 sub getline {
-       my ($self) = @_;
-       my $nr = $self->{nr}++;
+       my ($ctx) = @_;
+       my $cb = $ctx->{cb};
+       my $buf = $cb->($ctx) if $cb;
+       $buf //= delete($ctx->{cb}) ? _html_end($ctx) : undef;
 
-       return _html_top($self) if $nr == 0;
+       # gzf may be GzipFilter, `undef' or `0'
+       my $gzf = $ctx->{gzf} or return $buf;
 
-       if (my $middle = $self->{cb}) {
-               $middle = $middle->($nr, $self->{ctx}) and return $middle;
-       }
+       return $gzf->translate($buf) if defined $buf;
+       $ctx->{gzf} = 0; # next call to ->getline returns $buf (== undef)
+       $gzf->translate(undef);
+}
 
-       delete $self->{cb} ? _html_end($self) : undef;
+sub html_oneshot ($$;$) {
+       my ($ctx, $code, $sref) = @_;
+       $ctx->{base_url} = base_url($ctx);
+       bless $ctx, __PACKAGE__;
+       my @x;
+       my $h = [ 'Content-Type' => 'text/html; charset=UTF-8',
+               'Content-Length' => undef ];
+       if (my $gzf = gzf_maybe($h, $ctx->{env})) {
+               $gzf->zmore(html_top($ctx));
+               $gzf->zmore($$sref) if $sref;
+               $x[0] = $gzf->zflush(_html_end($ctx));
+               $h->[3] = length($x[0]);
+       } else {
+               @x = (html_top($ctx), $sref ? $$sref : (), _html_end($ctx));
+               $h->[3] += bytes::length($_) for @x;
+       }
+       [ $code, $h, \@x ]
 }
 
 1;