X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=2f8212d4a917d651802f2e78e0df36e430e90396;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=fd558e1b799bb45c8a86797f6b78d0afdcab483a;hpb=89ebf169c3d5edd4f0c19124d586f076fb8d43b2;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index fd558e1b..2f8212d4 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,27 +1,23 @@ -# Copyright (C) 2016-2020 all contributors +# Copyright (C) 2016-2021 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 parent 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 PublicInbox::GzipFilter qw(gzf_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 {} +our $CODE_URL = [ qw(http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git + https://public-inbox.org/public-inbox.git) ]; 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; } @@ -33,28 +29,34 @@ sub init { bless $ctx, __PACKAGE__; } -sub response { - 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 async_eml { # for async_blob_cb + my ($ctx, $eml) = @_; + $ctx->{http_out}->write($ctx->translate($ctx->{cb}->($ctx, $eml))); } sub html_top ($) { my ($ctx) = @_; - my $ibx = $ctx->{-inbox}; + my $ibx = $ctx->{ibx}; my $desc = ascii_html($ibx->description); my $title = delete($ctx->{-title_html}) // $desc; my $upfx = $ctx->{-upfx} || ''; - my $help = $upfx.'_/text/help'; - my $color = $upfx.'_/text/color'; + my $help = $upfx.'_/text/help/'; + 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 $code = $ibx->{coderepo} ? qq( / code) : ''; + my $links = qq(help / ). + qq(color / ). + qq(mirror$code / ). + 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 @@ -76,6 +78,32 @@ sub html_top ($) { ''. $top . (delete($ctx->{-html_tip}) // ''); } +sub coderepos ($) { + my ($ctx) = @_; + my $cr = $ctx->{ibx}->{coderepo} // return (); + my $cfg = $ctx->{www}->{pi_cfg}; + my $upfx = ($ctx->{-upfx} // ''). '../'; + my @ret; + for my $cr_name (@$cr) { + $ret[0] //= <code repositories for project(s) associated with this inbox: +EOF + my $urls = $cfg->get_all("coderepo.$cr_name.cgiturl"); + if ($urls) { + for (@$urls) { + # relative or absolute URL?, prefix relative + # "foo.git" with appropriate number of "../" + my $u = m!\A(?:[a-z\+]+:)?//! ? $_ : $upfx.$_; + $u = ascii_html(prurl($ctx->{env}, $u)); + $ret[0] .= qq(\n\t$u); + } + } else { + $ret[0] .= qq[\n\t$cr_name.git (no URL configured)]; + } + } + @ret; # may be empty, this sub is called as an arg for join() +} + sub code_footer ($) { my ($env) = @_; my $u = prurl($env, $CODE_URL); @@ -84,8 +112,12 @@ sub code_footer ($) { sub _html_end { my ($ctx) = @_; - my $urls = 'Archives are clonable:'; - my $ibx = $ctx->{-inbox}; + my $urls = <This inbox may be cloned and mirrored by anyone: +EOF + + my $ibx = $ctx->{ibx}; my $desc = ascii_html($ibx->description); my @urls; @@ -95,12 +127,18 @@ sub _html_end { 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; } @@ -112,44 +150,39 @@ 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}; + $urls .= "\n" . join('', map { "\tgit clone --mirror $_\n" } @urls); + if (my $addrs = $ibx->{address}) { $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY'; - $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})
 	).'

'; } @@ -157,35 +190,56 @@ EOF # callback for HTTP.pm (and any other PSGI servers) sub getline { my ($ctx) = @_; - my $cb = $ctx->{cb}; - my $buf = $cb->($ctx) if $cb; - $buf //= delete($ctx->{cb}) ? _html_end($ctx) : undef; - - # gzf may be GzipFilter, `undef' or `0' - my $gzf = $ctx->{gzf} or return $buf; - - return $gzf->translate($buf) if defined $buf; - $ctx->{gzf} = 0; # next call to ->getline returns $buf (== undef) - $gzf->translate(undef); + 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 $ctx->{cb}; + $ctx->zflush(_html_end($ctx)); } 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', + my $res_hdr = [ '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 ] + 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 + } + }; + warn "E: $@" if $@; +} + +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;