-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2019 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
+#
+# public-inbox-httpd favors "getline" response bodies to take a
+# "pull"-based approach to feeding slow clients (as opposed to a
+# more common "push" model)
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';
+our $TOR_URL = 'https://www.torproject.org/';
+our $CODE_URL = 'https://public-inbox.org/';
+our $PROJECT = 'public-inbox';
+
+# noop for HTTP.pm (and any other PSGI servers)
+sub close {}
sub new {
my ($class, $ctx, $cb) = @_;
- bless { nr => 0, cb => $cb, ctx => $ctx }, $class;
+
+ my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
+ chop $base_url; # no trailing slash for clone
+ bless {
+ nr => 0,
+ cb => $cb || *close,
+ ctx => $ctx,
+ base_url => $base_url,
+ }, $class;
}
sub response {
sub _html_top ($) {
my ($self) = @_;
my $ctx = $self->{ctx};
- my $obj = $ctx->{-inbox};
- my $desc = ascii_html($obj->description);
+ my $ibx = $ctx->{-inbox};
+ my $desc = ascii_html($ibx->description);
my $title = $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 $tip = $ctx->{-html_tip} || '';
- my $top = "<b>$desc</b> (<a\nhref=\"$atom\">Atom feed</a>)";
- if ($obj->search) {
+ my $top = "<b>$desc</b>";
+ my $links = "<a\nhref=\"$help\">help</a> / ".
+ "<a\nhref=\"$color\">color</a> / ".
+ "<a\nhref=\"$atom\">Atom feed</a>";
+ if ($ibx->search) {
my $q_val = $ctx->{-q_value_html};
if (defined $q_val && $q_val ne '') {
- $q_val = qq(\nvalue="$q_val" );
+ $q_val = qq(\nvalue="$q_val");
} else {
$q_val = '';
}
# XXX gross, for SearchView.pm
my $extra = $ctx->{-extra_form_html} || '';
- $top = qq{<form\naction="$upfx"><pre>$top} .
- qq{ <input\nname=q\ntype=text$q_val/>} .
+ my $action = $upfx eq '' ? './' : $upfx;
+ $top = qq{<form\naction="$action"><pre>$top} .
+ 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 .
+ $ctx->{www}->style($upfx) .
"</head><body>". $top . $tip;
}
+sub code_footer ($) {
+ my ($env) = @_;
+ my $u = PublicInbox::Hval::prurl($env, $CODE_URL);
+ qq(AGPL code for this site: git clone <a\nhref="$u">$u</a> $PROJECT)
+}
+
sub _html_end {
my ($self) = @_;
- my $urls = 'Archives are clone-able:';
+ my $urls = 'Archives are clonable:';
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}) {
+ my $ibx = $ctx->{-inbox};
+ my $desc = ascii_html($ibx->description);
+
+ my (%seen, @urls);
+ my $http = $self->{base_url};
+ my $max = $ibx->max_git_epoch;
+ my $dir = (split(m!/!, $http))[-1];
+ if (defined($max)) { # v2
+ $seen{$http} = 1;
+ for my $i (0..$max) {
+ # old parts 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";
+ }
+ } else { # v1
+ $seen{$http} = 1;
+ 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};
$seen{$u} = 1;
push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
}
- if (scalar(@urls) == 1) {
- $urls .= " git clone --mirror $http";
- } else {
+
+ if (defined($max) || scalar(@urls) > 1) {
$urls .= "\n" .
join("\n", map { "\tgit clone --mirror $_" } @urls);
+ } else {
+ $urls .= " git clone --mirror $urls[0]";
+ }
+ if (defined $max) {
+ my $addrs = $ibx->{address};
+ $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
+ $urls .= <<EOF
+
+
+ # If you have public-inbox 1.1+ installed, you may
+ # initialize and index your mirror using the following commands:
+ public-inbox-init -V2 $ibx->{name} $dir/ $http \\
+ $addrs
+ public-inbox-index $dir
+EOF
+ } else { # v1
+ $urls .= "\n";
}
- my $url = PublicInbox::Hval::prurl($ctx->{env}, PI_URL);
- '<pre>'.join("\n",
- '- ' . $desc,
+
+ my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
+ $urls .= qq(\nExample <a\nhref="$cfg_link">config snippet</a> for mirrors\n);
+ my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
+ if (@nntp) {
+ $urls .= "\n";
+ $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
+ $urls .= ' available over NNTP:';
+ $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
+ }
+ if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
+ $urls .= "\n note: .onion URLs require Tor: ";
+ $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
+ }
+ '<hr><pre>'.join("\n\n",
+ $desc,
$urls,
- 'served with software from public-inbox: '
- ."<a\nhref=\"$url\">$url</a>",
+ code_footer($ctx->{env})
).'</pre></body></html>';
}
+# callback for HTTP.pm (and any other PSGI servers)
sub getline {
my ($self) = @_;
my $nr = $self->{nr}++;
return _html_top($self) if $nr == 0;
- if (my $mid = $self->{cb}) { # middle
- $mid = $mid->($nr, $self->{ctx}) and return $mid;
+ if (my $middle = $self->{cb}) {
+ $middle = $middle->($nr, $self->{ctx}) and return $middle;
}
delete $self->{cb} ? _html_end($self) : undef;
}
-sub close {}
-
1;