From 7a3946ef122e8218c6ce3355d7f968562212d53b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 18 Apr 2019 08:25:56 +0000 Subject: www: support listing of inboxes We will still return a 404 by default to '/' for compatibility with users of Plack::App::Cascade or similar. Inboxes are sorted by modification times to help users detect activity (similar to the /$INBOX/ topic view). New configuration options: * publicinbox.wwwlisting - configure the listing type * publicinbox..hide - hide a particular inbox from the listing See changes to public-inbox-config.pod for full descriptions of the new options. Requested-by: Leah Neukirchen https://public-inbox.org/meta/871sdfzy80.fsf@gmail.com/ --- lib/PublicInbox/WwwListing.pm | 104 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 lib/PublicInbox/WwwListing.pm (limited to 'lib/PublicInbox/WwwListing.pm') diff --git a/lib/PublicInbox/WwwListing.pm b/lib/PublicInbox/WwwListing.pm new file mode 100644 index 00000000..e8dad4b8 --- /dev/null +++ b/lib/PublicInbox/WwwListing.pm @@ -0,0 +1,104 @@ +# Copyright (C) 2019 all contributors +# License: AGPL-3.0+ + +# 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::Linkify; +use PublicInbox::View; + +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 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; +} + +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' + + *list_404; + }, + }, $class; +} + +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} + + if (defined(my $info_url = $ibx->{info_url})) { + $tmp .= "\n$info_url"; + } + $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); + 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; + + $code = 200; + $title .= ' - listing'; + my $tmp = join("\n", map { ibx_entry(@$_, $env) } @$list); + my $l = PublicInbox::Linkify->new; + $l->linkify_1($tmp); + $out = '
'.$l->linkify_2(ascii_html($tmp)).'

'; + } + $out = "$title" . $out; + $out .= '
'. PublicInbox::WwwStream::code_footer($env) .
+		'
'; + [ $code, $h, [ $out ] ] +} + +1; -- cgit v1.2.3-24-ge0c7