# Copyright (C) 2016-2021 all contributors # License: AGPL-3.0+ # # HTML body stream for which yields getline+close methods for # generic PSGI servers and callbacks for public-inbox-httpd. # # See PublicInbox::GzipFilter parent class for more info. package PublicInbox::WwwStream; use strict; 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 $base_url; } sub init { my ($ctx, $cb) = @_; $ctx->{cb} = $cb; $ctx->{base_url} = base_url($ctx); bless $ctx, __PACKAGE__; } sub async_eml { # for async_blob_cb my ($ctx, $eml) = @_; $ctx->write($ctx->{cb}->($ctx, $eml)); } 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} || ''; my $atom = $ctx->{-atom} || $upfx.'new.atom'; my $top = "$desc"; 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 my $extra = delete($ctx->{-extra_form_html}) // ''; my $action = $upfx eq '' ? './' : $upfx; $top = qq{
$top} .
			  qq{\n} .
			  $extra .
			  qq{} .
			  ' ' . $links .
			  q{
} } else { $top = '
' . $top . "\n" . $links . '
'; } "$title" . qq() . $ctx->{www}->style($upfx) . ''. $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 _html_end { my ($ctx) = @_; my $upfx = $ctx->{-upfx} || ''; my $m = "${upfx}_/text/mirror/"; my $x; if ($ctx->{ibx}->can('cloneurl')) { $x = <mirroring instructions for how to clone and mirror all data and code used for this inbox EOF 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 .= <mirroring instructions on how to clone and mirror all data and code used by this external index. EOF } chomp $x; '
'.join("\n\n", coderepos($ctx), $x).'
' } # callback for HTTP.pm (and any other PSGI servers) sub getline { 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)); } 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)); $ctx->{base_url} = base_url($ctx); }; $ctx->zmore($$sref) if $sref; my $bdy = $ctx->zflush(_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 $@; } 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;