]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WwwStream.pm
www: improve navigation around contemporary threads
[public-inbox.git] / lib / PublicInbox / WwwStream.pm
index 8f5a65263fadea90ac12629a434ff3ec736c364e..e06e3456ae19cbf163fcae457cce533f58bf33c0 100644 (file)
@@ -1,64 +1,63 @@
-# 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
+# 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 PublicInbox::Hval qw(ascii_html prurl);
+use parent qw(Exporter PublicInbox::GzipFilter);
+our @EXPORT_OK = qw(html_oneshot);
+use bytes (); # length
+use PublicInbox::Hval qw(ascii_html prurl ts2str);
 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 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) ]
+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 = $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>";
+       if (my $t_max = $ctx->{-t_max}) {
+               $t_max = ts2str($t_max);
+               $top = qq(<a\nhref="$upfx?t=$t_max">$top</a>);
+       # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss
+       } elsif ($ctx->{qp}->{t}) {
+               $top = qq(<a\nhref="./">$top</a>);
+       }
        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 />} .
@@ -70,10 +69,10 @@ 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 ($) {
@@ -83,18 +82,17 @@ sub code_footer ($) {
 }
 
 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;
@@ -103,15 +101,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;
        }
 
@@ -159,16 +155,57 @@ EOF
 
 # callback for HTTP.pm (and any other PSGI servers)
 sub getline {
-       my ($self) = @_;
-       my $nr = $self->{nr}++;
+       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 $ctx->{cb};
+       $ctx->zflush(_html_end($ctx));
+}
 
-       return _html_top($self) if $nr == 0;
+sub html_oneshot ($$;$) {
+       my ($ctx, $code, $sref) = @_;
+       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 ] ]
+}
 
-       if (my $middle = $self->{cb}) {
-               $middle = $middle->($nr, $self->{ctx}) and return $middle;
-       }
+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
+               }
+       };
+       warn "E: $@" if $@;
+}
 
-       delete $self->{cb} ? _html_end($self) : undef;
+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;