#
# 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 parent qw(Exporter PublicInbox::GzipFilter);
+our @EXPORT_OK = qw(html_oneshot);
+use bytes (); # length
+use PublicInbox::Hval qw(ascii_html prurl);
our $TOR_URL = 'https://www.torproject.org/';
-our $CODE_URL = 'https://public-inbox.org/';
-our $PROJECT = 'public-inbox';
+our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
+# noop for HTTP.pm (and any other PSGI servers)
sub close {}
-sub new {
- my ($class, $ctx, $cb) = @_;
- bless { nr => 0, cb => $cb || *close, ctx => $ctx }, $class;
+sub base_url ($) {
+ my $ctx = shift;
+ my $base_url = $ctx->{-inbox}->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 response {
- my ($class, $ctx, $code, $cb) = @_;
- [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ],
- $class->new($ctx, $cb) ]
+ my ($ctx, $code, $cb) = @_;
+ my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8' ];
+ init($ctx, $cb);
+ $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env});
+ [ $code, $res_hdr, $ctx ]
}
-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->{-inbox};
+ 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 $tip = $ctx->{-html_tip} || '';
- my $top = "$desc (Atom feed)";
- 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 = "$desc";
+ my $links = "help / ".
+ "color / ".
+ "Atom feed";
+ if ($ibx->search) {
+ 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{}
} else {
- $top = '' . $top . '
';
+ $top = '' . $top . "\n" . $links . '
';
}
"$title" .
- "" .
- PublicInbox::Hval::STYLE .
- "". $top . $tip;
+ qq() .
+ $ctx->{www}->style($upfx) .
+ ''. $top . (delete($ctx->{-html_tip}) // '');
+}
+
+sub code_footer ($) {
+ my ($env) = @_;
+ my $u = prurl($env, $CODE_URL);
+ qq(AGPL code for this site: git clone $u)
}
sub _html_end {
- my ($self) = @_;
+ my ($ctx) = @_;
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);
- my $need_tor;
- foreach my $u (@{$obj->cloneurl}) {
- next if $seen{$u};
- $need_tor = 1 if $u =~ m!\A[^:]+://\w+\.onion/!;
- $seen{$u} = 1;
+ 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 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
+ 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($u) : $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 .= <{name} $dir/ $http \\
+ $addrs
+ public-inbox-index $dir
+EOF
+ } else { # v1
+ $urls .= "\n";
}
- if ($need_tor) {
+ my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
+ $urls .= qq(\nExample config snippet for mirrors\n);
+ my @nntp = map { qq($_) } @{$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[$TOR_URL];
}
- my $url = PublicInbox::Hval::prurl($ctx->{env}, $CODE_URL);
'
'.join("\n\n",
$desc,
$urls,
- 'Code for this site: '.
- qq(git clone $url $PROJECT)
+ code_footer($ctx->{env})
).'
';
}
+# 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;
+ my ($ctx) = @_;
+ my $cb = $ctx->{cb} or return;
+ if (defined(my $buf = $cb->($ctx))) {
+ return $ctx->translate($buf);
}
+ delete $ctx->{cb};
+ $ctx->zflush(_html_end($ctx));
+}
- delete $self->{cb} ? _html_end($self) : undef;
+sub html_oneshot ($$;$) {
+ my ($ctx, $code, $sref) = @_;
+ $ctx->{base_url} = base_url($ctx);
+ bless $ctx, __PACKAGE__;
+ my @bdy;
+ my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8',
+ 'Content-Length' => undef ];
+ $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env});
+ $ctx->zmore(html_top($ctx));
+ $ctx->zmore($$sref) if $sref;
+ $bdy[0] = $ctx->zflush(_html_end($ctx));
+ $res_hdr->[3] = bytes::length($bdy[0]);
+ [ $code, $res_hdr, \@bdy ]
}
1;