-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 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;
-our $TOR_URL = 'https://www.torproject.org/';
-our $TOR2WEB_URL = 'https://www.tor2web.org/';
-our $CODE_URL = 'https://public-inbox.org/';
-our $PROJECT = 'public-inbox';
-
-sub close {}
-
-sub new {
- my ($class, $ctx, $cb) = @_;
- bless { nr => 0, cb => $cb || *close, ctx => $ctx }, $class;
+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} // $ctx->{git})->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);
+ $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 ($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->write($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} // $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 $atom = $ctx->{-atom} || $upfx.'new.atom';
- my $tip = $ctx->{-html_tip} || '';
my $top = "<b>$desc</b>";
- my $links = "<a\nhref=\"$help\">help</a> / ".
- "<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 = '';
- }
+ 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>);
+ } elsif (length($upfx)) {
+ $top = qq(<a\nhref="$upfx">$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{\n<input\nname=q\ntype=text$q_val />} .
$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 clonable:';
- my $ctx = $self->{ctx};
- my $obj = $ctx->{-inbox};
- my $desc = ascii_html($obj->description);
-
- my $http = $obj->base_url($ctx->{env});
- chop $http;
- 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 inboxes { () } # TODO
- my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$obj->nntp_url};
- if (@nntp) {
- $urls .= "\n\n";
- $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
- $urls .= ' available over NNTP:';
- $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
+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 $pfx = $ctx->{base_url} //= $ctx->base_url;
+ my $up = $upfx =~ tr!/!/!;
+ $pfx =~ s!/[^/]+\z!/! for (1..$up);
+ my @ret = ('<a id=code>' .
+ 'Code repositories for project(s) associated with this '.
+ $ctx->{ibx}->thing_type . "\n");
+ my $objs = $cfg->repo_objs($ctx->{ibx});
+ for my $git (@$objs) {
+ my @urls = $git->pub_urls($ctx->{env});
+ for (@urls) {
+ my $u = m!\A(?:[a-z\+]+:)?//! ? $_ : $pfx.$_;
+ $u = ascii_html(prurl($ctx->{env}, $u));
+ $ret[0] .= qq(\n\t<a\nhref="$u">$u</a>);
+ }
}
- if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
- $urls .= "\n note: .onion URLs require Tor: ";
- $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
- if ($TOR2WEB_URL) {
- $urls .= "\n or Tor2web: ";
- $urls .= qq[<a\nhref="$TOR2WEB_URL">$TOR2WEB_URL</a>];
+ @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} && $ctx->{ibx}->can('cloneurl')) {
+ $x = <<EOF;
+This is a public inbox, see <a
+href="$m">mirroring instructions</a>
+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 .= <<EOM;
+as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).
+EOM
+ } elsif ($has_nntp) {
+ $x .= <<EOM;
+as well as URLs for NNTP newsgroup(s).
+EOM
+ } else {
+ $x .= <<EOM;
+as well as URLs for IMAP folder(s).
+EOM
+ }
}
+ } elsif ($ctx->{ibx}) { # extindex
+ $x = <<EOF;
+This is an external index of several public inboxes,
+see <a href="$m">mirroring instructions</a> 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})});
}
- my $url = PublicInbox::Hval::prurl($ctx->{env}, $CODE_URL);
- '<hr><pre>'.join("\n\n",
- $desc,
- $urls,
- 'AGPL code for this site: '.
- qq(git clone <a\nhref="$url">$url</a> $PROJECT)
- ).'</pre></body></html>';
+ chomp $x;
+ '<hr><pre>'.join("\n\n", coderepos($ctx), $x).'</pre></body></html>'
}
+# 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_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 ] ]
+}
- if (my $mid = $self->{cb}) { # middle
- $mid = $mid->($nr, $self->{ctx}) and return $mid;
- }
+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 $@;
+}
+
+sub aresponse {
+ my ($ctx, $cb) = @_;
+ init($ctx, $cb);
+ $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);
+}
- delete $self->{cb} ? _html_end($self) : undef;
+sub DESTROY {
+ my ($ctx) = @_;
+ $ctx->{git}->cleanup if $ctx->{git} && $ctx->{git}->{-tmp};
}
1;