X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=92d243eb09fd172e6cfcc1d25575e94d246dd5a3;hb=6dec9bf8c0e1b859703d7a5dfb87052cf4e87846;hp=d81428242544db08afb90cce5084211ec9b8e8da;hpb=4363e6037fa7d597294186f60373e9de8e1b3d74;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index d8142824..92d243eb 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2016-2021 all contributors +# Copyright (C) all contributors # License: AGPL-3.0+ # # HTML body stream for which yields getline+close methods for @@ -11,7 +11,6 @@ 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 $TOR_URL = 'https://www.torproject.org/'; our $CODE_URL = [ qw( http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git @@ -19,7 +18,7 @@ https://public-inbox.org/public-inbox.git) ]; sub base_url ($) { my $ctx = shift; - my $base_url = $ctx->{ibx}->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; } @@ -28,22 +27,23 @@ sub init { my ($ctx, $cb) = @_; $ctx->{cb} = $cb; $ctx->{base_url} = base_url($ctx); + $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 async_eml { # for async_blob_cb my ($ctx, $eml) = @_; - $ctx->{http_out}->write($ctx->translate($ctx->{cb}->($ctx, $eml))); + $ctx->write($ctx->{cb}->($ctx, $eml)); } sub html_top ($) { my ($ctx) = @_; - my $ibx = $ctx->{ibx}; + 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"; if (my $t_max = $ctx->{-t_max}) { @@ -52,11 +52,15 @@ sub html_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) : ''; - my $links = qq(help / ). - qq(color / ). - qq(mirror$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}) // ''; @@ -80,22 +84,25 @@ sub html_top ($) { ''. $top . (delete($ctx->{-html_tip}) // ''); } +sub inboxes { () } # TODO + sub coderepos ($) { my ($ctx) = @_; + $ctx->{ibx} // return inboxes($ctx); my $cr = $ctx->{ibx}->{coderepo} // return (); my $cfg = $ctx->{www}->{pi_cfg}; my $upfx = ($ctx->{-upfx} // ''). '../'; - my @ret; + my $pfx = $ctx->{base_url} //= $ctx->base_url; + my $up = $upfx =~ tr!/!/!; + $pfx =~ s!/[^/]+\z!/! for (1..$up); + my @ret = ('' . + 'Code repositories for project(s) associated with this '. + $ctx->{ibx}->thing_type . "\n"); 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.$_; + my $u = m!\A(?:[a-z\+]+:)?//! ? $_ : $pfx.$_; $u = ascii_html(prurl($ctx->{env}, $u)); $ret[0] .= qq(\n\t$u); } @@ -106,109 +113,47 @@ EOF @ret; # may be empty, this sub is called as an arg for join() } -sub code_footer ($) { - my ($env) = @_; - my $u = prurl($env, $CODE_URL); - my $arg = $u; - if ($arg =~ s!\A(https?://)([^/\.]+)\.onion/!$1\$hostname\.onion/!i) { - "AGPL code for this site:\n\thostname=$2\n\t" . - qq(torsocks git clone $arg) - } else { - qq(AGPL code for this site: git clone $u) - } -} - sub _html_end { my ($ctx) = @_; - my $ibx = $ctx->{ibx}; - my $desc = ascii_html($ibx->description); - my $s = ""; - my $http = $ctx->{base_url}; - my $dir = (split(m!/!, $http))[-1]; - my %seen = ($http => 1); - if ($ibx->can('cloneurl')) { # PublicInbox::Inbox - $s .= "This inbox may be cloned and mirrored by anyone:\n"; - my @urls; - my $max = $ibx->max_git_epoch; - # TODO: some of these URLs may be too long and we may need to - # do something like code_footer() above, but these are local - # admin-defined - if (defined($max)) { # v2 - for my $i (0..$max) { - # 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) { - $s .= "\n\t"; - $s .= "# this inbox consists of $nr epochs:"; - $urls[0] .= "\t# oldest"; - $urls[-1] .= "\t# newest"; - } - } else { # v1 - push @urls, $http; - } - # FIXME: epoch splits can be different in other repositories, - # use the "cloneurl" file as-is for now: - for my $u (@{$ibx->cloneurl}) { - next if $seen{$u}++; - push @urls, ($u =~ /\Ahttps?:/ ? - qq($u) : $u); - } - $s .= "\n"; - $s .= join('', map { "\tgit clone --mirror $_\n" } @urls); - if (my $addrs = $ibx->{address}) { - $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY'; - my $v = defined $max ? '-V2' : '-V1'; - $s .= <{name} $dir/ $http \\ - $addrs - public-inbox-index $dir + 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 { # PublicInbox::ExtSearch - $s .= < + 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 .= <{www}->{pi_cfg}->{lc('publicInbox.wwwListing')}; - if (($v // '') =~ /\A(?:all|match=domain)\z/) { - my $upfx = ($ctx->{-upfx} // ''). '../'; - $s .= <listing + } elsif ($has_nntp) { + $x .= <{-upfx} // '').'_/text/config/raw'; - $s .= <config snippet for mirrors. + } elsif ($ctx->{ibx}) { # extindex + $x = <mirroring instructions on how to clone and mirror +all data and code used by this external index. EOF - if ($ibx->can('nntp_url')) { - my @nntp = map { qq($_) } @{$ibx->nntp_url}; - if (@nntp) { - $s .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are'; - $s .= ' available over NNTP:'; - $s .= "\n\t" . join("\n\t", @nntp) . "\n"; - } + } elsif ($ctx->{git}) { # coderepo + $x = join('', map { "git clone $_\n" } + @{$ctx->{git}->cloneurl($ctx->{env})}); } - if ($s =~ m!\b[^:]+://\w+\.onion/!) { - $s .= " note: .onion URLs require Tor: "; - $s .= qq[$TOR_URL]; - } - '

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

'; + chomp $x; + '

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

' } # callback for HTTP.pm (and any other PSGI servers) @@ -228,18 +173,26 @@ sub getline { $ctx->zflush(_html_end($ctx)); } -sub html_oneshot ($$;$) { - my ($ctx, $code, $sref) = @_; +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 ] ] +} + +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}); - $ctx->{base_url} //= do { - $ctx->zmore(html_top($ctx)); - base_url($ctx); + my @top; + $ctx->{base_url} // do { + @top = html_top($ctx); + $ctx->{base_url} = base_url($ctx); }; - $ctx->zmore($$sref) if $sref; - my $bdy = $ctx->zflush(_html_end($ctx)); + my $bdy = $ctx->zflush(@top, @_[2..$#_], _html_end($ctx)); $res_hdr->[3] = length($bdy); [ $code, $res_hdr, [ $bdy ] ] } @@ -251,8 +204,7 @@ sub async_next ($) { if (my $smsg = $ctx->{smsg} = $ctx->{cb}->($ctx)) { $ctx->smsg_blob($smsg); } else { - $ctx->{http_out}->write( - $ctx->translate(_html_end($ctx))); + $ctx->write(_html_end($ctx)); $ctx->close; # GzipFilter->close } }; @@ -260,10 +212,23 @@ sub async_next ($) { } sub aresponse { - my ($ctx, $code, $cb) = @_; - my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8' ]; + my ($ctx, $cb) = @_; init($ctx, $cb); - $ctx->psgi_response($code, $res_hdr); + $ctx->psgi_response(200, delete $ctx->{-res_hdr}); +} + +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__; + print { $ctx->zfh } html_top($ctx); +} + +sub DESTROY { + my ($ctx) = @_; + $ctx->{git}->cleanup if $ctx->{git} && $ctx->{git}->{-tmp}; } 1;