-# Copyright (C) 2016-2020 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 for
# 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 bytes (); # length
use PublicInbox::Hval qw(ascii_html prurl ts2str);
-our $TOR_URL = 'https://www.torproject.org/';
-our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
+
+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;
}
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_repo_top ($) {
+ my ($ctx) = @_;
+ my $git = $ctx->{git};
+ my $desc = ascii_html($git->description);
+ my $title = delete($ctx->{-title_html}) // $desc;
+ my $upfx = $ctx->{-upfx} // '';
+ my $atom = $ctx->{-atom} // (substr($upfx, -1) eq '/' ?
+ "${upfx}atom/" : "$upfx/atom/");
+ my $top = ascii_html($git->{nick});
+ $top = qq(<a\nhref="$upfx">$top</a>) if length($upfx);
+ $top .= <<EOM;
+ <a href='$upfx#readme'>about</a> / <a
+href='$upfx#heads'>heads</a> / <a
+href='$upfx#tags'>tags</a>
+<b>$desc</b>
+EOM
+ my @url = PublicInbox::ViewVCS::ibx_url_for($ctx);
+ if (@url) {
+ $ctx->{-has_srch} = 1;
+ my $base_url = base_url($ctx);
+ my ($pfx, $sfx) = ($base_url =~ m!\A(https?://[^/]+/)(.*)\z!i);
+ my $iupfx = '../' x (($sfx =~ tr!/!/!) + 1);
+ $pfx = ascii_html($pfx);
+ $pfx = qr/\A\Q$pfx\E/i;
+ my $tmp = $top;
+ $top = '';
+ my ($s, $u, $same_host);
+ my $q_val = delete($ctx->{-q_value_html}) // '';
+ $q_val = qq(\nvalue="$q_val") if $q_val ne '';
+ for (@url) {
+ $u = $s = ascii_html($_);
+ substr($u, 0, 0, $iupfx) if $u !~ m!://!;
+ $s =~ s!$pfx!!;
+ $s =~ s!/\z!!;
+ $top .= qq{<form\naction="$u"><pre>$tmp} .
+ qq{<input\nname=q type=text$q_val />} .
+ qq{<input type=submit\n} .
+ qq{value="search mail in `$s'"/>} .
+ q{</pre></form>};
+ $tmp = '';
+ }
+ } else {
+ $top = "<pre>$top</pre>";
+ }
+ "<html><head><title>$title</title>" .
+ qq(<link\nrel=alternate\ntitle="Atom feed"\n).
+ qq(href="$atom"\ntype="application/atom+xml"/>) .
+ $ctx->{www}->style($upfx) .
+ '</head><body>'.$top;
}
sub html_top ($) {
my ($ctx) = @_;
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx} // return html_repo_top($ctx);
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 = "<b>$desc</b>";
if (my $t_max = $ctx->{-t_max}) {
# 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 $links = qq(<a\nhref="$help">help</a> / ).
- qq(<a\nhref="$color">color</a> / ).
- qq(<a\nhref=#mirror>mirror</a> / ).
- qq(<a\nhref="$atom">Atom feed</a>);
+ my $code = $ibx->{coderepo} ? qq( / <a\nhref=#code>code</a>) : '';
+ # id=mirror must exist for legacy bookmarks
+ my $links = 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 '';
'</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
}
+sub inboxes { () } # TODO
+
sub coderepos ($) {
my ($ctx) = @_;
- my $ibx = $ctx->{-inbox};
- my @ret;
- if (defined(my $cr = $ibx->{coderepo})) {
- my $cfg = $ctx->{www}->{pi_config};
- my $env = $ctx->{env};
- for my $cr_name (@$cr) {
- my $urls = $cfg->{"coderepo.$cr_name.cgiturl"};
- if ($urls) {
- $ret[0] //= <<EOF;
-code repositories for the project(s) associated with this inbox:
-EOF
- $ret[0] .= "\n\t".prurl($env, $_) for @$urls;
- }
+ $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 = '<a id=code>' .
+ '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<a\nhref="$u">$u</a>);
}
}
- @ret; # may be empty
-}
-
-sub code_footer ($) {
- my ($env) = @_;
- my $u = prurl($env, $CODE_URL);
- qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
+ ($buf);
}
sub _html_end {
+ return '</body></html>';
my ($ctx) = @_;
- my $urls = <<EOF;
-<a
-id=mirror>This inbox may be cloned and mirrored by anyone:</a>
+ 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 $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 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) {
- $urls .= "\n\t# this inbox consists of $nr epochs:";
- $urls[0] .= "\t# oldest";
- $urls[-1] .= "\t# newest";
+ 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
+ }
}
- } 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(<a\nhref="$u">$u</a>) : $u;
- }
-
- $urls .= "\n" . join('', map { "\tgit clone --mirror $_\n" } @urls);
- my $addrs = $ibx->{address};
- $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
- my $v = defined $max ? '-V2' : '-V1';
- $urls .= <<EOF;
-
- # If you have public-inbox 1.1+ installed, you may
- # initialize and index your mirror using the following commands:
- public-inbox-init $v $ibx->{name} $dir/ $http \\
- $addrs
- public-inbox-index $dir
-EOF
- my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
- $urls .= <<EOF;
-
-Example <a
-href="$cfg_link">config snippet</a> for mirrors.
+ } 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
- my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
- if (@nntp) {
- $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
- $urls .= ' available over NNTP:';
- $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
+ } elsif ($ctx->{git}) { # coderepo
+ $x = join('', map { "git clone $_\n" }
+ @{$ctx->{git}->cloneurl($ctx->{env})});
}
- if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
- $urls .= " note: .onion URLs require Tor: ";
- $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
- }
- '<hr><pre>'.join("\n\n",
- $desc,
- $urls,
- coderepos($ctx),
- code_footer($ctx->{env})
- ).'</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)
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->{-inbox}->smsg_eml($x) or next;
+ my $eml = $ctx->{ibx}->smsg_eml($x) or next;
$ctx->{smsg} = $x;
return $ctx->translate($cb->($ctx, $eml));
} else { # scalar
$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));
- $res_hdr->[3] = bytes::length($bdy);
+ my $bdy = $ctx->zflush(@top, @_[2..$#_], _html_end($ctx));
+ $res_hdr->[3] = length($bdy);
[ $code, $res_hdr, [ $bdy ] ]
}
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
}
};
}
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;