1 # Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Provide an HTTP-accessible listing of inboxes.
5 # Used by PublicInbox::WWW
6 package PublicInbox::WwwListing;
9 use PublicInbox::Hval qw(ascii_html prurl);
10 use PublicInbox::Linkify;
11 use PublicInbox::View;
12 use PublicInbox::Inbox;
13 use PublicInbox::GzipFilter qw(gzf_maybe);
14 use bytes (); # bytes::length
15 use HTTP::Date qw(time2str);
18 use IO::Compress::Gzip qw(gzip);
19 *try_cat = \&PublicInbox::Inbox::try_cat;
21 for my $mod (qw(JSON::MaybeXS JSON JSON::PP)) {
22 eval "require $mod" or next;
23 # ->ascii encodes non-ASCII to "\uXXXX"
24 $json = $mod->new->ascii(1) and last;
29 my ($list, $hide_key) = @$arg;
30 push @$list, $ibx unless $ibx->{-hide}->{$hide_key};
34 my ($self, $env, $hide_key) = @_;
36 $self->{pi_config}->each_inbox(\&list_all_i, [ $list, $hide_key ]);
40 sub list_match_domain_i {
42 my ($list, $hide_key, $re) = @$arg;
43 if (!$ibx->{-hide}->{$hide_key} && grep($re, @{$ibx->{url}})) {
48 sub list_match_domain ($$$) {
49 my ($self, $env, $hide_key) = @_;
51 my $host = $env->{HTTP_HOST} // $env->{SERVER_NAME};
52 $host =~ s/:[0-9]+\z//;
53 my $arg = [ $list, $hide_key,
54 qr!\A(?:https?:)?//\Q$host\E(?::[0-9]+)?/!i ];
55 $self->{pi_config}->each_inbox(\&list_match_domain_i, $arg);
59 sub list_404 ($$) { [] }
64 'match=domain' => *list_match_domain,
69 my ($pi_config, $k, $default) = @_;
70 my $v = $pi_config->{lc $k} // $default;
73 `$v' is not a valid value for `$k'
74 $k be one of `all', `match=domain', or `404'
81 my ($class, $www) = @_;
82 my $pi_config = $www->{pi_config};
84 pi_config => $pi_config,
85 style => $www->style("\0"),
86 www_cb => set_cb($pi_config, 'publicInbox.wwwListing', 404),
87 manifest_cb => set_cb($pi_config, 'publicInbox.grokManifest',
93 my ($mtime, $ibx, $env) = @_;
94 my $ts = PublicInbox::View::fmt_ts($mtime);
95 my $url = prurl($env, $ibx->{url});
100 if (defined(my $info_url = $ibx->{infourl})) {
101 $tmp .= ' ' . prurl($env, $info_url) . "\n";
107 my ($env, $list) = @_;
108 my $h = [ 'Content-Type', 'text/html; charset=UTF-8',
109 'Content-Length', undef ];
110 my $gzf = gzf_maybe($h, $env);
111 $gzf->zmore('<html><head><title>' .
112 'public-inbox listing</title>' .
113 '</head><body><pre>');
117 # Schwartzian transform since Inbox->modified is expensive
120 } map { [ $_->modified, $_ ] } @$list;
122 my $tmp = join("\n", map { ibx_entry(@$_, $env) } @$list);
123 my $l = PublicInbox::Linkify->new;
124 $gzf->zmore($l->to_html($tmp));
126 $gzf->zmore('no inboxes, yet');
128 my $out = $gzf->zflush('</pre><hr><pre>'.
129 PublicInbox::WwwStream::code_footer($env) .
130 '</pre></body></html>');
131 $h->[3] = bytes::length($out);
132 [ $code, $h, [ $out ] ];
135 sub fingerprint ($) {
137 # TODO: convert to qspawn for fairness when there's
139 my ($fh, $pid) = $git->popen('show-ref');
140 my $dig = Digest::SHA->new(1);
141 while (read($fh, my $buf, 65536)) {
146 return if $?; # empty, uninitialized git repo
150 sub manifest_add ($$;$$) {
151 my ($manifest, $ibx, $epoch, $default_desc) = @_;
152 my $url_path = "/$ibx->{name}";
153 my $git_dir = $ibx->{inboxdir};
154 if (defined $epoch) {
155 $git_dir .= "/git/$epoch.git";
156 $url_path .= "/git/$epoch.git";
158 return unless -d $git_dir;
159 my $git = PublicInbox::Git->new($git_dir);
160 my $fingerprint = fingerprint($git) or return; # no empty repos
162 chomp(my $owner = $git->qx('config', 'gitweb.owner'));
163 chomp(my $desc = try_cat("$git_dir/description"));
164 utf8::decode($owner);
166 $owner = undef if $owner eq '';
167 $desc = 'Unnamed repository' if $desc eq '';
169 # templates/hooks--update.sample and git-multimail in git.git
170 # only match "Unnamed repository", not the full contents of
171 # templates/this--description in git.git
172 if ($desc =~ /\AUnnamed repository/) {
173 $desc = "$default_desc [epoch $epoch]" if defined($epoch);
177 chomp(my $alt = try_cat("$git_dir/objects/info/alternates"));
179 # n.b.: GitPython doesn't seem to handle comments or C-quoted
180 # strings like native git does; and we don't for now, either.
181 my @alt = split(/\n+/, $alt);
183 # grokmirror only supports 1 alternate for "reference",
184 if (scalar(@alt) == 1) {
185 my $objdir = "$git_dir/objects";
186 $reference = File::Spec->rel2abs($alt[0], $objdir);
187 $reference =~ s!/[^/]+/?\z!!; # basename
190 $manifest->{-abs2urlpath}->{$git_dir} = $url_path;
191 my $modified = $git->modified;
192 if ($modified > $manifest->{-mtime}) {
193 $manifest->{-mtime} = $modified;
195 $manifest->{$url_path} = {
197 reference => $reference,
198 description => $desc,
199 modified => $modified,
200 fingerprint => $fingerprint,
206 my ($env, $list) = @_;
207 # $json won't be defined if IO::Compress::Gzip is missing
208 $json or return [ 404, [], [] ];
210 my $manifest = { -abs2urlpath => {}, -mtime => 0 };
211 for my $ibx (@$list) {
212 if (defined(my $max = $ibx->max_git_epoch)) {
213 my $desc = $ibx->description;
214 for my $epoch (0..$max) {
215 manifest_add($manifest, $ibx, $epoch, $desc);
218 manifest_add($manifest, $ibx);
221 my $abs2urlpath = delete $manifest->{-abs2urlpath};
222 my $mtime = delete $manifest->{-mtime};
223 while (my ($url_path, $repo) = each %$manifest) {
224 defined(my $abs = $repo->{reference}) or next;
225 $repo->{reference} = $abs2urlpath->{$abs};
228 gzip(\($json->encode($manifest)) => \$out);
230 [ 200, [ qw(Content-Type application/gzip),
231 'Last-Modified', time2str($mtime),
232 'Content-Length', bytes::length($out) ], [ $out ] ];
235 # not really a stand-alone PSGI app, but maybe it could be...
237 my ($self, $env) = @_;
239 if ($env->{PATH_INFO} eq '/manifest.js.gz') {
240 # grokmirror uses relative paths, so it's domain-dependent
241 my $list = $self->{manifest_cb}->($self, $env, 'manifest');
244 my $list = $self->{www_cb}->($self, $env, 'www');