X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=c960edc52fdc545503e9d73ec8444f04c812e62e;hp=f5338c39a67486d3569993d182b639c5ec6516bb;hb=5b96edcb1e0d825244d5a12470e0f32526262611;hpb=dbb6c7b51862d0ea7438f5fb393d115ea46f1fab diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index f5338c39..c960edc5 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,65 +1,67 @@ -# Copyright (C) 2016-2019 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 warnings; -use PublicInbox::Hval qw(ascii_html); -our $TOR_URL = 'https://www.torproject.org/'; -our $CODE_URL = 'https://public-inbox.org/'; -our $PROJECT = 'public-inbox'; - -# noop for HTTP.pm (and any other PSGI servers) -sub close {} - -sub new { - my ($class, $ctx, $cb) = @_; - - my $base_url = $ctx->{-inbox}->base_url($ctx->{env}); +use v5.10.1; +use parent qw(Exporter PublicInbox::GzipFilter); +our @EXPORT_OK = qw(html_oneshot); +use PublicInbox::Hval qw(ascii_html prurl ts2str); + +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->{ibx}->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}; - my $ibx = $ctx->{-inbox}; +sub html_top ($) { + my ($ctx) = @_; + my $ibx = $ctx->{ibx}; 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 = "$desc"; - my $links = "help / ". - "color / ". - "Atom feed"; - 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 = ''; - } + 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) : ''; + # id=mirror must exist for legacy bookmarks + 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 - my $extra = $ctx->{-extra_form_html} || ''; + my $extra = delete($ctx->{-extra_form_html}) // ''; my $action = $upfx eq '' ? './' : $upfx; $top = qq{
$top} .
 			  qq{\n} .
@@ -71,105 +73,99 @@ sub _html_top ($) {
 		$top = '
' . $top . "\n" . $links . '
'; } "$title" . - "" . + qq() . $ctx->{www}->style($upfx) . - "". $top . $tip; -} - -sub code_footer ($) { - my ($env) = @_; - my $u = PublicInbox::Hval::prurl($env, $CODE_URL); - qq(AGPL code for this site: git clone $u $PROJECT) + ''. $top . (delete($ctx->{-html_tip}) // ''); } -sub _html_end { - my ($self) = @_; - 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 $max = $ibx->max_git_epoch; - my $dir = (split(m!/!, $http))[-1]; - if (defined($max)) { # v2 - $seen{$http} = 1; - for my $i (0..$max) { - # old parts my be deleted: - -d "$ibx->{mainrepo}/git/$i.git" or next; - my $url = "$http/$i"; - $seen{$url} = 1; - 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; - 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 .= <{name} $dir/ $http \\ - $addrs - public-inbox-index $dir +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 - } else { # v1 - $urls .= "\n"; + 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() +} - my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw'; - $urls .= qq(\nExample config snippet for mirrors\n); - 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 .= qq[$TOR_URL]; - } - '
'.join("\n\n",
-		$desc,
-		$urls,
-		code_footer($ctx->{env})
-	).'
'; +sub _html_end { + my ($ctx) = @_; + my @cr = coderepos($ctx); + scalar(@cr) ? + '
'.join("\n\n", @cr).'
' : + ''; } # 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->{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)); +} - 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] = 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;