X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=34e124358d5e588cfae0f8f9cbfb730e33ee921c;hp=79ed6871e6f3e9224dfc422b3896d3d718881b14;hb=0d38f65c490466837ae091afa7a7b6f59d04ce7c;hpb=b8b03f9c896432816019828b27708fa3b6903d83 diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index 79ed6871..34e12435 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,54 +1,41 @@ # Copyright (C) 2016-2020 all contributors # License: AGPL-3.0+ # -# 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 base qw(Exporter); +use parent qw(Exporter PublicInbox::GzipFilter); our @EXPORT_OK = qw(html_oneshot); use bytes (); # length -use PublicInbox::Hval qw(ascii_html prurl); -use Compress::Raw::Zlib qw(Z_FINISH Z_OK); -use PublicInbox::GzipFilter qw(gzip_maybe); +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 base_url ($) { my $ctx = shift; - my $base_url = $ctx->{-inbox}->base_url($ctx->{env}); + my $base_url = $ctx->{ibx}->base_url($ctx->{env}); chop $base_url; # no trailing slash for clone $base_url; } -sub new { - my ($class, $ctx, $cb) = @_; - - bless { - nr => 0, - cb => $cb, - ctx => $ctx, - base_url => base_url($ctx), - }, $class; +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}; - my $ibx = $ctx->{-inbox}; +sub html_top ($) { + my ($ctx) = @_; + my $ibx = $ctx->{ibx}; my $desc = ascii_html($ibx->description); my $title = delete($ctx->{-title_html}) // $desc; my $upfx = $ctx->{-upfx} || ''; @@ -56,10 +43,18 @@ sub _html_top ($) { my $color = $upfx.'_/text/color'; my $atom = $ctx->{-atom} || $upfx.'new.atom'; my $top = "$desc"; - my $links = "help / ". - "color / ". - "Atom feed"; - if ($ibx->search) { + if (my $t_max = $ctx->{-t_max}) { + $t_max = ts2str($t_max); + $top = qq($top); + # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss + } elsif ($ctx->{qp}->{t}) { + $top = qq($top); + } + my $links = qq(help / ). + qq(color / ). + qq(mirror / ). + qq(Atom feed); + if ($ibx->isrch) { my $q_val = delete($ctx->{-q_value_html}) // ''; $q_val = qq(\nvalue="$q_val") if $q_val ne ''; # XXX gross, for SearchView.pm @@ -81,6 +76,26 @@ sub _html_top ($) { ''. $top . (delete($ctx->{-html_tip}) // ''); } +sub coderepos ($) { + my ($ctx) = @_; + my $ibx = $ctx->{ibx}; + my @ret; + if (defined(my $cr = $ibx->{coderepo})) { + my $cfg = $ctx->{www}->{pi_cfg}; + my $env = $ctx->{env}; + for my $cr_name (@$cr) { + my $urls = $cfg->{"coderepo.$cr_name.cgiturl"}; + if ($urls) { + $ret[0] //= <{ctx}; - my $ibx = $ctx->{-inbox}; + my ($ctx) = @_; + my $urls = <This inbox may be cloned and mirrored by anyone: +EOF + + my $ibx = $ctx->{ibx}; my $desc = ascii_html($ibx->description); my @urls; - my $http = $self->{base_url}; + 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 for my $i (0..$max) { - # old parts my be deleted: + # old epochs my be deleted: -d "$ibx->{inboxdir}/git/$i.git" or next; my $url = "$http/$i"; $seen{$url} = 1; push @urls, "$url $dir/git/$i.git"; } + my $nr = scalar(@urls); + if ($nr > 1) { + $urls .= "\n\t# this inbox consists of $nr epochs:"; + $urls[0] .= "\t# oldest"; + $urls[-1] .= "\t# newest"; + } } else { # v1 push @urls, $http; } @@ -118,90 +142,95 @@ sub _html_end { push @urls, $u =~ /\Ahttps?:/ ? qq($u) : $u; } - if (defined($max) || scalar(@urls) > 1) { - $urls .= "\n" . - join("\n", map { "\tgit clone --mirror $_" } @urls); - } else { - $urls .= " git clone --mirror $urls[0]"; - } - if (defined $max) { - my $addrs = $ibx->{address}; - $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY'; - $urls .= <{address}; + $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY'; + my $v = defined $max ? '-V2' : '-V1'; + $urls .= <{name} $dir/ $http \\ + public-inbox-init $v $ibx->{name} $dir/ $http \\ $addrs public-inbox-index $dir EOF - } else { # v1 - $urls .= "\n"; - } - my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw'; - $urls .= qq(\nExample config snippet for mirrors\n); + $urls .= <config snippet for mirrors. +EOF my @nntp = map { qq($_) } @{$ibx->nntp_url}; if (@nntp) { - $urls .= "\n"; $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are'; $urls .= ' available over NNTP:'; $urls .= "\n\t" . join("\n\t", @nntp) . "\n"; } if ($urls =~ m!\b[^:]+://\w+\.onion/!) { - $urls .= "\n note: .onion URLs require Tor: "; + $urls .= " note: .onion URLs require Tor: "; $urls .= qq[$TOR_URL]; } '

'.join("\n\n",
 		$desc,
 		$urls,
+		coderepos($ctx),
 		code_footer($ctx->{env})
 	).'

'; } # callback for HTTP.pm (and any other PSGI servers) sub getline { - my ($self) = @_; - my $nr = $self->{nr}++; - - return _html_top($self) if $nr == 0; - - if (my $middle = $self->{cb}) { - $middle = $middle->($nr, $self->{ctx}) and return $middle; + 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->{ibx}->smsg_eml($x) or next; + $ctx->{smsg} = $x; + return $ctx->translate($cb->($ctx, $eml)); + } else { # scalar + return $ctx->translate($x); + } } - - delete $self->{cb} ? _html_end($self) : undef; + delete $ctx->{cb}; + $ctx->zflush(_html_end($ctx)); } sub html_oneshot ($$;$) { my ($ctx, $code, $sref) = @_; - my $self = bless { - ctx => $ctx, - base_url => base_url($ctx), - }, __PACKAGE__; - my @x; - my @h = ('Content-Type' => 'text/html; charset=UTF-8'); - if (my $gz = gzip_maybe($ctx->{env})) { - my $err = $gz->deflate(_html_top($self), $x[0]); - die "gzip->deflate: $err" if $err != Z_OK; - if ($sref) { - $err = $gz->deflate($sref, $x[0]); - die "gzip->deflate: $err" if $err != Z_OK; + 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 ] ] +} + +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 } - $err = $gz->deflate(_html_end($self), $x[0]); - die "gzip->deflate: $err" if $err != Z_OK; - $err = $gz->flush($x[0], Z_FINISH); - die "gzip->flush: $err" if $err != Z_OK; - push @h, qw(Vary Accept-Encoding Content-Encoding gzip); - } else { - @x = (_html_top($self), $sref ? $$sref : (), _html_end($self)); - } + }; + warn "E: $@" if $@; +} - my $len = 0; - $len += bytes::length($_) for @x; - push @h, 'Content-Length', $len; - [ $code, \@h, \@x ] +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;