-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
#
-# 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.
+#
+# See PublicInbox::GzipFilter parent class for more info.
package PublicInbox::WwwStream;
use strict;
-use warnings;
-use PublicInbox::Hval qw(ascii_html);
-use URI;
-use constant PI_URL => 'https://public-inbox.org/README.html';
+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 new {
- my ($class, $ctx, $cb) = @_;
- bless { nr => 0, cb => $cb, ctx => $ctx }, $class;
+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 $obj = $ctx->{-inbox};
- my $desc = ascii_html($obj->description);
- my $title = $ctx->{-title_html} || $desc;
+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 $tip = $ctx->{-html_tip} || '';
- my $top = "<b>$desc</b> (<a\nhref=\"$atom\">Atom feed</a>)";
- if ($obj->search) {
- my $q_val = $ctx->{-q_value_html};
- if (defined $q_val && $q_val ne '') {
- $q_val = qq(\nvalue="$q_val" );
- } else {
- $q_val = '';
- }
+ my $top = "<b>$desc</b>";
+ if (my $t_max = $ctx->{-t_max}) {
+ $t_max = ts2str($t_max);
+ $top = qq(<a\nhref="$upfx?t=$t_max">$top</a>);
+ # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss
+ } elsif ($ctx->{qp}->{t}) {
+ $top = qq(<a\nhref="./">$top</a>);
+ }
+ my $code = $ibx->{coderepo} ? qq( / <a\nhref=#code>code</a>) : '';
+ # id=mirror must exist for legacy bookmarks
+ my $links = qq(<a\nhref="${upfx}_/text/help/">help</a> / ).
+ qq(<a\nhref="${upfx}_/text/color/">color</a> / ).
+ qq(<a\nid=mirror) .
+ qq(\nhref="${upfx}_/text/mirror/">mirror</a>$code / ).
+ qq(<a\nhref="$atom">Atom feed</a>);
+ 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{<form\naction="$action"><pre>$top} .
- qq{ <input\nname=q\ntype=text$q_val/>} .
+ qq{\n<input\nname=q\ntype=text$q_val />} .
$extra .
qq{<input\ntype=submit\nvalue=search />} .
+ ' ' . $links .
q{</pre></form>}
} else {
- $top = '<pre>' . $top . '</pre>';
+ $top = '<pre>' . $top . "\n" . $links . '</pre>';
}
"<html><head><title>$title</title>" .
- "<link\nrel=alternate\ntitle=\"Atom feed\"\n".
- "href=\"$atom\"\ntype=\"application/atom+xml\"/>" .
- PublicInbox::Hval::STYLE .
- "</head><body>". $top . $tip;
+ qq(<link\nrel=alternate\ntitle="Atom feed"\n).
+ qq(href="$atom"\ntype="application/atom+xml"/>) .
+ $ctx->{www}->style($upfx) .
+ '</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
}
-sub _html_end {
- my ($self) = @_;
- my $urls = 'Archives are clone-able:';
- my $ctx = $self->{ctx};
- my $obj = $ctx->{-inbox};
- my $desc = ascii_html($obj->description);
-
- # FIXME: cleanup
- my $env = $ctx->{env};
- my $scheme = $env->{'psgi.url_scheme'};
- my $host_port = $env->{HTTP_HOST} ||
- "$env->{SERVER_NAME}:$env->{SERVER_PORT}";
- my $http = "$scheme://$host_port".($env->{SCRIPT_NAME} || '/');
- $http = URI->new($http . $obj->{name})->canonical->as_string;
- my %seen = ( $http => 1 );
- my @urls = ($http);
- foreach my $u (@{$obj->cloneurl}) {
- next if $seen{$u};
- $seen{$u} = 1;
- push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
- }
- if (scalar(@urls) == 1) {
- $urls .= " git clone --mirror $http";
- } else {
- $urls .= "\n" .
- join("\n", map { "\tgit clone --mirror $_" } @urls);
+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] //= <<EOF;
+<a id=code>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<a\nhref="$u">$u</a>);
+ }
+ } else {
+ $ret[0] .= qq[\n\t$cr_name.git (no URL configured)];
+ }
}
- my $url = PublicInbox::Hval::prurl($ctx->{env}, PI_URL);
- '<pre>'.join("\n",
- '- ' . $desc,
- $urls,
- 'served with software from public-inbox: '
- ."<a\nhref=\"$url\">$url</a>",
- ).'</pre></body></html>';
+ @ret; # may be empty, this sub is called as an arg for join()
}
-sub getline {
- my ($self) = @_;
- my $nr = $self->{nr}++;
-
- return _html_top($self) if $nr == 0;
+sub _html_end {
+ my ($ctx) = @_;
+ my @cr = coderepos($ctx);
+ scalar(@cr) ?
+ '<hr><pre>'.join("\n\n", @cr).'</pre></body></html>' :
+ '</body></html>';
+}
- if (my $mid = $self->{cb}) { # middle
- $mid = $mid->($nr, $self->{ctx}) and return $mid;
+# 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));
+ base_url($ctx);
+ };
+ $ctx->zmore($$sref) if $sref;
+ my $bdy = $ctx->zflush(_html_end($ctx));
+ $res_hdr->[3] = length($bdy);
+ [ $code, $res_hdr, [ $bdy ] ]
+}
- delete $self->{cb} ? _html_end($self) : undef;
+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 close {}
+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;