-# Copyright (C) 2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2019-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# Provide an HTTP-accessible listing of inboxes.
# Used by PublicInbox::WWW
package PublicInbox::WwwListing;
use strict;
-use warnings;
-use PublicInbox::Hval qw(ascii_html);
+use PublicInbox::Hval qw(prurl fmt_ts);
use PublicInbox::Linkify;
-use PublicInbox::View;
+use PublicInbox::GzipFilter qw(gzf_maybe);
+use PublicInbox::ConfigIter;
+use bytes (); # bytes::length
-sub list_all ($$) {
- my ($self, undef) = @_;
- my @list;
- $self->{pi_config}->each_inbox(sub {
- my ($ibx) = @_;
- push @list, $ibx unless $ibx->{-hide}->{www};
- });
- \@list;
-}
+sub ibx_entry {
+ my ($ctx, $ibx) = @_;
+ my $mtime = $ibx->modified;
+ my $ts = fmt_ts($mtime);
+ my $url = prurl($ctx->{env}, $ibx->{url});
+ my $tmp = <<"";
+* $ts - $url
+ ${\$ibx->description}
-sub list_match_domain ($$) {
- my ($self, $env) = @_;
- my @list;
- my $host = $env->{HTTP_HOST} // $env->{SERVER_NAME};
- $host =~ s/:\d+\z//;
- my $re = qr!\A(?:https?:)?//\Q$host\E(?::\d+)?/!i;
- $self->{pi_config}->each_inbox(sub {
- my ($ibx) = @_;
- push @list, $ibx if !$ibx->{-hide}->{www} && $ibx->{url} =~ $re;
- });
- \@list;
+ if (defined(my $info_url = $ibx->{infourl})) {
+ $tmp .= ' ' . prurl($ctx->{env}, $info_url) . "\n";
+ }
+ push @{$ctx->{-list}}, [ $mtime, $tmp ];
}
-sub list_404 ($$) { [] }
-
-# TODO: +cgit
-my %VALID = (
- all => *list_all,
- 'match=domain' => *list_match_domain,
- 404 => *list_404,
-);
-
-sub new {
- my ($class, $www) = @_;
- my $k = 'publicinbox.wwwListing';
- my $pi_config = $www->{pi_config};
- my $v = $pi_config->{lc($k)} // 404;
- bless {
- pi_config => $pi_config,
- style => $www->style("\0"),
- list_cb => $VALID{$v} || do {
- warn <<"";
-`$v' is not a valid value for `$k'
-$k be one of `all', `match=domain', or `404'
+sub list_match_i { # ConfigIter callback
+ my ($cfg, $section, $re, $ctx) = @_;
+ if (defined($section)) {
+ return if $section !~ m!\Apublicinbox\.([^/]+)\z!;
+ my $ibx = $cfg->lookup_name($1) or return;
+ if (!$ibx->{-hide}->{$ctx->hide_key} &&
+ grep(/$re/, @{$ibx->{url}})) {
+ $ctx->ibx_entry($ibx);
+ }
+ } else { # undef == "EOF"
+ $ctx->{-wcb}->($ctx->psgi_triple);
+ }
+}
- *list_404;
- },
- }, $class;
+sub url_regexp {
+ my ($ctx, $key, $default) = @_;
+ $key //= 'publicInbox.wwwListing';
+ $default //= '404';
+ my $v = $ctx->{www}->{pi_cfg}->{lc $key} // $default;
+again:
+ if ($v eq 'match=domain') {
+ my $h = $ctx->{env}->{HTTP_HOST} // $ctx->{env}->{SERVER_NAME};
+ $h =~ s/:[0-9]+\z//;
+ qr!\A(?:https?:)?//\Q$h\E(?::[0-9]+)?/!i;
+ } elsif ($v eq 'all') {
+ qr/./;
+ } elsif ($v eq '404') {
+ undef;
+ } else {
+ warn <<EOF;
+`$v' is not a valid value for `$key'
+$key be one of `all', `match=domain', or `404'
+EOF
+ $v = $default; # 'match=domain' or 'all'
+ goto again;
+ }
}
-sub ibx_entry {
- my ($mtime, $ibx, $env) = @_;
- my $ts = PublicInbox::View::fmt_ts($mtime);
- my $url = PublicInbox::Hval::prurl($env, $ibx->{url});
- my $tmp = <<"";
-* $ts - $url
- ${\$ibx->description}
+sub hide_key { 'www' }
- if (defined(my $info_url = $ibx->{info_url})) {
- $tmp .= "\n$info_url";
+sub response {
+ my ($class, $ctx) = @_;
+ bless $ctx, $class;
+ if (my $ALL = $ctx->{www}->{pi_cfg}->ALL) {
+ $ALL->misc->reopen;
+ }
+ my $re = $ctx->url_regexp or return $ctx->psgi_triple;
+ my $iter = PublicInbox::ConfigIter->new($ctx->{www}->{pi_cfg},
+ \&list_match_i, $re, $ctx);
+ sub {
+ $ctx->{-wcb} = $_[0]; # HTTP server callback
+ $ctx->{env}->{'pi-httpd.async'} ?
+ $iter->event_step : $iter->each_section;
}
- $tmp;
}
-# not really a stand-alone PSGI app, but maybe it could be...
-sub call {
- my ($self, $env) = @_;
- my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ];
- my $list = $self->{list_cb}->($self, $env);
+sub psgi_triple {
+ my ($ctx) = @_;
+ my $h = [ 'Content-Type', 'text/html; charset=UTF-8',
+ 'Content-Length', undef ];
+ my $gzf = gzf_maybe($h, $ctx->{env});
+ $gzf->zmore('<html><head><title>' .
+ 'public-inbox listing</title>' .
+ '</head><body><pre>');
my $code = 404;
- my $title = 'public-inbox';
- my $out = '';
- if (@$list) {
- # Swartzian transform since ->modified is expensive
- @$list = sort {
- $b->[0] <=> $a->[0]
- } map { [ $_->modified, $_ ] } @$list;
-
+ if (my $list = $ctx->{-list}) {
$code = 200;
- $title .= ' - listing';
- my $tmp = join("\n", map { ibx_entry(@$_, $env) } @$list);
+ # sort by ->modified
+ @$list = map { $_->[1] } sort { $b->[0] <=> $a->[0] } @$list;
+ $list = join("\n", @$list);
my $l = PublicInbox::Linkify->new;
- $l->linkify_1($tmp);
- $out = '<pre>'.$l->linkify_2(ascii_html($tmp)).'</pre><hr>';
+ $gzf->zmore($l->to_html($list));
+ } else {
+ $gzf->zmore('no inboxes, yet');
}
- $out = "<html><head><title>$title</title></head><body>" . $out;
- $out .= '<pre>'. PublicInbox::WwwStream::code_footer($env) .
- '</pre></body></html>';
- [ $code, $h, [ $out ] ]
+ my $out = $gzf->zflush('</pre><hr><pre>'.
+ PublicInbox::WwwStream::code_footer($ctx->{env}) .
+ '</pre></body></html>');
+ $h->[3] = bytes::length($out);
+ [ $code, $h, [ $out ] ];
}
1;