X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=59edad5de5bd4238212b45f06c2b174f4e6ed7ae;hb=0aa46753c3b033aee1b4de5f358c33b912febe07;hp=c80440d14dad6291abdc0fe091c7f9011c9e1eb7;hpb=52a02a813a46940530183ede4d4cc7028290cd8f;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index c80440d1..59edad5d 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,28 +1,24 @@ -# Copyright (C) 2016-2020 all contributors +# Copyright (C) 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 v5.10.1; +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); -our $TOR_URL = 'https://www.torproject.org/'; -our $CODE_URL = 'https://public-inbox.org/public-inbox.git'; +use PublicInbox::Hval qw(ascii_html prurl ts2str); -# 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} // $ctx->{git})->base_url($ctx->{env}); chop $base_url; # no trailing slash for clone $base_url; } @@ -31,32 +27,42 @@ sub init { my ($ctx, $cb) = @_; $ctx->{cb} = $cb; $ctx->{base_url} = base_url($ctx); - $ctx->{nr} = 0; + $ctx->{-res_hdr} = [ 'Content-Type' => 'text/html; charset=UTF-8' ]; + $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($ctx->{-res_hdr}, + $ctx->{env}); 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->write($ctx->{cb}->($ctx, $eml)); } -sub _html_top ($) { +sub html_top ($) { my ($ctx) = @_; - my $ibx = $ctx->{-inbox}; + my $ibx = $ctx->{ibx} // $ctx->{git}; 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 $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); + } elsif (length($upfx)) { + $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 @@ -78,122 +84,146 @@ sub _html_top ($) { ''. $top . (delete($ctx->{-html_tip}) // ''); } -sub code_footer ($) { - my ($env) = @_; - my $u = prurl($env, $CODE_URL); - qq(AGPL code for this site: git clone $u) -} +sub inboxes { () } # TODO -sub _html_end { +sub coderepos ($) { my ($ctx) = @_; - my $urls = 'Archives are clonable:'; - my $ibx = $ctx->{-inbox}; - my $desc = ascii_html($ibx->description); - - 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 - for my $i (0..$max) { - # old parts 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"; + $ctx->{ibx} // return inboxes($ctx); + my $cr = $ctx->{ibx}->{coderepo} // return (); + my $upfx = ($ctx->{-upfx} // ''). '../'; + my $pfx = $ctx->{base_url} //= $ctx->base_url; + my $up = $upfx =~ tr!/!/!; + $pfx =~ s!/[^/]+\z!/! for (1..$up); + $pfx .= '/' if substr($pfx, -1, 1) ne '/'; + my $buf = '' . + 'Code repositories for project(s) associated with this '. + $ctx->{ibx}->thing_type . "\n"; + for my $git (@{$ctx->{www}->{pi_cfg}->repo_objs($ctx->{ibx})}) { + for ($git->pub_urls($ctx->{env})) { + my $u = m!\A(?:[a-z\+]+:)?//!i ? $_ : $pfx.$_; + $u = ascii_html(prurl($ctx->{env}, $u)); + $buf .= qq(\n\t$u); } - } else { # v1 - 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}++; - 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 _html_end { + my ($ctx) = @_; + my $upfx = $ctx->{-upfx} || ''; + my $m = "${upfx}_/text/mirror/"; + my $x = ''; + if ($ctx->{ibx} && $ctx->{ibx}->can('cloneurl')) { + $x = <mirroring instructions +for how to clone and mirror all data and code used for this inbox EOF - } else { # v1 - $urls .= "\n"; - } - - 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]; + my $has_nntp = @{$ctx->{ibx}->nntp_url($ctx)}; + my $has_imap = @{$ctx->{ibx}->imap_url($ctx)}; + if ($has_nntp || $has_imap) { + substr($x, -1, 1) = ";\n"; # s/\n/;\n + if ($has_nntp && $has_imap) { + $x .= <{ibx}) { # extindex + $x = <mirroring instructions on how to clone and mirror +all data and code used by this external index. +EOF + } elsif ($ctx->{git}) { # coderepo + $x = join('', map { "git clone $_\n" } + @{$ctx->{git}->cloneurl($ctx->{env})}); } - '

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

'; + chomp $x; + '

'.join("\n\n", coderepos($ctx), $x).'

' } # callback for HTTP.pm (and any other PSGI servers) sub getline { my ($ctx) = @_; - my $nr = $ctx->{nr}++; - - my $buf = do { - if ($nr == 0) { - _html_top($ctx); - } elsif (my $middle = $ctx->{cb}) { - $middle->($nr, $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}) ? _html_end($ctx) : undef); + } + delete $ctx->{cb}; + $ctx->zflush(_html_end($ctx)); +} + +sub html_done ($;@) { + my $ctx = $_[0]; + my $bdy = $ctx->zflush(@_[1..$#_], _html_end($ctx)); + my $res_hdr = delete $ctx->{-res_hdr}; + push @$res_hdr, 'Content-Length', length($bdy); + [ 200, $res_hdr, [ $bdy ] ] +} - # gzf may be GzipFilter, `undef' or `0' - my $gzf = $ctx->{gzf} or return $buf; +sub html_oneshot ($$;@) { + my ($ctx, $code) = @_[0, 1]; + 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}); + my @top; + $ctx->{base_url} // do { + @top = html_top($ctx); + $ctx->{base_url} = base_url($ctx); + }; + my $bdy = $ctx->zflush(@top, @_[2..$#_], _html_end($ctx)); + $res_hdr->[3] = 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->write(_html_end($ctx)); + $ctx->close; # GzipFilter->close + } + }; + warn "E: $@" if $@; +} - return $gzf->translate($buf) if defined $buf; - $ctx->{gzf} = 0; # next call to ->getline returns $buf (== undef) - $gzf->translate(undef); +sub aresponse { + my ($ctx, $cb) = @_; + init($ctx, $cb); + $ctx->psgi_response(200, delete $ctx->{-res_hdr}); } -sub html_oneshot ($$;$) { - my ($ctx, $code, $sref) = @_; +sub html_init { + my ($ctx) = @_; $ctx->{base_url} = base_url($ctx); + my $h = $ctx->{-res_hdr} = ['Content-Type', 'text/html; charset=UTF-8']; + $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($h, $ctx->{env}); 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 ] + print { $ctx->zfh } html_top($ctx); +} + +sub DESTROY { + my ($ctx) = @_; + $ctx->{git}->cleanup if $ctx->{git} && $ctx->{git}->{-tmp}; } 1;