-# Copyright (C) 2014, Eric Wong <normalperson@yhbt.net> and all contributors
+# Copyright (C) 2014-2015 all contributors <meta@public-inbox.org>
# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
#
+# Main web interface for mailing list archives
+#
# We focus on the lowest common denominators here:
-# - targeted at text-only console browsers (lynx, w3m, etc..)
+# - targeted at text-only console browsers (w3m, links, etc..)
# - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
# - No JavaScript, graphics or icons allowed.
# - Must not rely on static content
use 5.008;
use strict;
use warnings;
-use PublicInbox::Config;
+use Plack::Request;
+use PublicInbox::Config qw(try_cat);
use URI::Escape qw(uri_escape_utf8 uri_unescape);
+use constant SSOMA_URL => '//ssoma.public-inbox.org/';
+use constant PI_URL => '//public-inbox.org/';
+require PublicInbox::Git;
+use PublicInbox::GitHTTPBackend;
our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
-our $pi_config;
-BEGIN {
- $pi_config = PublicInbox::Config->new;
+our $MID_RE = qr!([^/]+)!;
+our $END_RE = qr!(f/|T/|t/|R/|t\.mbox(?:\.gz)?|t\.atom|raw|)!;
+
+sub new {
+ my ($class, $pi_config) = @_;
+ $pi_config ||= PublicInbox::Config->new;
+ bless { pi_config => $pi_config }, $class;
}
+# backwards compatibility, do not use
sub run {
- my ($cgi, $method) = @_;
- my %ctx;
- if ($method !~ /\AGET|HEAD\z/) {
+ my ($req, $method) = @_;
+ PublicInbox::WWW->new->call($req->env);
+}
+
+sub call {
+ my ($self, $env) = @_;
+ my $cgi = Plack::Request->new($env);
+ my $ctx = { cgi => $cgi, pi_config => $self->{pi_config} };
+ my $path_info = $cgi->path_info;
+
+ my $method = $cgi->method;
+ if ($method eq 'POST' &&
+ $path_info =~ m!$LISTNAME_RE/(git-upload-pack)\z!) {
+ my $path = $2;
+ return (invalid_list($self, $ctx, $1) ||
+ serve_git($cgi, $ctx->{git}, $path));
+ }
+ elsif ($method !~ /\AGET|HEAD\z/) {
return r(405, 'Method Not Allowed');
}
- my $path_info = $cgi->path_info;
# top-level indices and feeds
if ($path_info eq '/') {
r404();
} elsif ($path_info =~ m!$LISTNAME_RE\z!o) {
- invalid_list(\%ctx, $1) || redirect_list_index(\%ctx, $cgi);
+ invalid_list($self, $ctx, $1) || r301($ctx, $1);
} elsif ($path_info =~ m!$LISTNAME_RE(?:/|/index\.html)?\z!o) {
- invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi, 0);
- } elsif ($path_info =~ m!$LISTNAME_RE/atom\.xml\z!o) {
- invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 0);
+ invalid_list($self, $ctx, $1) || get_index($ctx);
+ } elsif ($path_info =~ m!$LISTNAME_RE/(?:atom\.xml|new\.atom)\z!o) {
+ invalid_list($self, $ctx, $1) || get_atom($ctx);
- # single-message pages
- } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.txt\z!o) {
- invalid_list_mid(\%ctx, $1, $2) || get_mid_txt(\%ctx, $cgi);
- } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
- invalid_list_mid(\%ctx, $1, $2) || get_mid_html(\%ctx, $cgi);
+ } elsif ($path_info =~ m!$LISTNAME_RE/
+ ($PublicInbox::GitHTTPBackend::ANY)\z!ox) {
+ my $path = $2;
+ invalid_list($self, $ctx, $1) ||
+ serve_git($cgi, $ctx->{git}, $path);
+ } elsif ($path_info =~ m!$LISTNAME_RE/$MID_RE/$END_RE\z!o) {
+ msg_page($self, $ctx, $1, $2, $3);
- # full-message page
- } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
- invalid_list_mid(\%ctx, $1, $2) || get_full_html(\%ctx, $cgi);
+ # in case people leave off the trailing slash:
+ } elsif ($path_info =~ m!$LISTNAME_RE/$MID_RE/(f|T|t|R)\z!o) {
+ my ($listname, $mid, $suffix) = ($1, $2, $3);
+ $suffix .= $suffix =~ /\A[tT]\z/ ? '/#u' : '/';
+ r301($ctx, $listname, $mid, $suffix);
- # convenience redirects, order matters
- } elsif ($path_info =~ m!$LISTNAME_RE/(?:m|f)/(\S+)\z!o) {
- invalid_list_mid(\%ctx, $1, $2) || redirect_mid(\%ctx, $cgi);
+ # convenience redirects order matters
+ } elsif ($path_info =~ m!$LISTNAME_RE/([^/]{2,})\z!o) {
+ r301($ctx, $1, $2);
} else {
- r404();
+ legacy_redirects($self, $ctx, $path_info);
}
}
require Email::MIME;
require Digest::SHA;
require POSIX;
- require XML::Atom::SimpleFeed;
+
+ foreach (qw(PublicInbox::Search PublicInbox::SearchView
+ PublicInbox::Mbox IO::Compress::Gzip
+ PublicInbox::NewsWWW PublicInbox::NewsGroup)) {
+ eval "require $_;";
+ }
}
# private functions below
-sub r404 { r(404, 'Not Found') }
+sub r404 {
+ my ($ctx) = @_;
+ if ($ctx && $ctx->{mid}) {
+ require PublicInbox::ExtMsg;
+ searcher($ctx);
+ return PublicInbox::ExtMsg::ext_msg($ctx);
+ }
+ r(404, 'Not Found');
+}
# simple response for errors
sub r { [ $_[0], ['Content-Type' => 'text/plain'], [ join(' ', @_, "\n") ] ] }
# returns undef if valid, array ref response if invalid
sub invalid_list {
- my ($ctx, $listname) = @_;
- my $git_dir = $pi_config->get($listname, "mainrepo");
+ my ($self, $ctx, $listname, $mid) = @_;
+ my $git_dir = $ctx->{pi_config}->get($listname, "mainrepo");
if (defined $git_dir) {
$ctx->{git_dir} = $git_dir;
+ $ctx->{git} = PublicInbox::Git->new($git_dir);
$ctx->{listname} = $listname;
return;
}
- r404();
+
+ # sometimes linkifiers (not ours!) screw up automatic link
+ # generation and link things intended for nntp:// to https?://,
+ # so try to infer links and redirect them to the appropriate
+ # list URL.
+ $self->news_www->call($ctx->{cgi}->{env});
}
# returns undef if valid, array ref response if invalid
sub invalid_list_mid {
- my ($ctx, $listname, $mid) = @_;
- my $ret = invalid_list($ctx, $listname, $mid);
- $ctx->{mid} = uri_unescape($mid) unless $ret;
- $ret;
+ my ($self, $ctx, $listname, $mid) = @_;
+ my $ret = invalid_list($self, $ctx, $listname, $mid);
+ return $ret if $ret;
+
+ $ctx->{mid} = $mid = uri_unescape($mid);
+ if ($mid =~ /\A[a-f0-9]{40}\z/) {
+ # this is horiffically wasteful for legacy URLs:
+ if ($mid = mid2blob($ctx)) {
+ require Email::Simple;
+ use PublicInbox::MID qw/mid_clean/;
+ $mid = Email::Simple->new($mid);
+ $ctx->{mid} = mid_clean($mid->header('Message-ID'));
+ }
+ }
+ undef;
}
-# /$LISTNAME/atom.xml -> Atom feed, includes replies
+# /$LISTNAME/new.atom -> Atom feed, includes replies
sub get_atom {
- my ($ctx, $cgi, $top) = @_;
+ my ($ctx) = @_;
require PublicInbox::Feed;
- [ 200, [ 'Content-Type' => 'application/xml' ],
- [ PublicInbox::Feed->generate({
- git_dir => $ctx->{git_dir},
- listname => $ctx->{listname},
- pi_config => $pi_config,
- cgi => $cgi,
- top => $top,
- }) ]
- ];
+ PublicInbox::Feed::generate($ctx);
}
# /$LISTNAME/?r=$GIT_COMMIT -> HTML only
sub get_index {
- my ($ctx, $cgi, $top) = @_;
+ my ($ctx) = @_;
require PublicInbox::Feed;
- [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
- [ PublicInbox::Feed->generate_html_index({
- git_dir => $ctx->{git_dir},
- listname => $ctx->{listname},
- pi_config => $pi_config,
- cgi => $cgi,
- top => $top,
- }) ]
- ];
+ my $srch = searcher($ctx);
+ footer($ctx);
+ if (defined $ctx->{cgi}->param('q')) {
+ require PublicInbox::SearchView;
+ PublicInbox::SearchView::sres_top_html($ctx);
+ } else {
+ PublicInbox::Feed::generate_html_index($ctx);
+ }
}
# just returns a string ref for the blob in the current ctx
sub mid2blob {
my ($ctx) = @_;
- require Digest::SHA;
- my $hex = Digest::SHA::sha1_hex($ctx->{mid});
- $hex =~ /\A([a-f0-9]{2})([a-f0-9]{38})\z/i or
- die "BUG: not a SHA-1 hex: $hex";
-
- my @cmd = ('git', "--git-dir=$ctx->{git_dir}",
- qw(cat-file blob), "HEAD:$1/$2");
- my $cmd = join(' ', @cmd);
- my $pid = open my $fh, '-|';
- defined $pid or die "fork failed: $!\n";
- if ($pid == 0) {
- open STDERR, '>', '/dev/null'; # ignore errors
- exec @cmd or die "exec failed: $!\n";
- } else {
- my $blob = eval { local $/; <$fh> };
- close $fh;
- $? == 0 ? \$blob : undef;
- }
+ require PublicInbox::MID;
+ my $path = PublicInbox::MID::mid2path($ctx->{mid});
+ $ctx->{git}->cat_file("HEAD:$path");
}
-# /$LISTNAME/m/$MESSAGE_ID.txt -> raw original
+# /$LISTNAME/$MESSAGE_ID/raw -> raw mbox
sub get_mid_txt {
- my ($ctx, $cgi) = @_;
- my $x = mid2blob($ctx);
- $x ? [ 200, [ 'Content-Type' => 'text/plain' ], [ $$x ] ] : r404();
+ my ($ctx) = @_;
+ my $x = mid2blob($ctx) or return r404($ctx);
+ require PublicInbox::Mbox;
+ PublicInbox::Mbox::emit1($ctx, $x);
}
-# /$LISTNAME/m/$MESSAGE_ID.html -> HTML content (short quotes)
+# /$LISTNAME/$MESSAGE_ID/ -> HTML content (short quotes)
sub get_mid_html {
- my ($ctx, $cgi) = @_;
- my $x = mid2blob($ctx);
- return r404() unless $x;
+ my ($ctx) = @_;
+ my $x = mid2blob($ctx) or return r404($ctx);
require PublicInbox::View;
- my $mid_href = PublicInbox::Hval::ascii_html(
- uri_escape_utf8($ctx->{mid}));
- my $pfx = "../f/$mid_href.html";
+ my $foot = footer($ctx);
require Email::MIME;
+ my $mime = Email::MIME->new($x);
+ searcher($ctx);
[ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
- [ PublicInbox::View->as_html(Email::MIME->new($$x), $pfx) ] ];
+ [ PublicInbox::View::msg_html($ctx, $mime, 'f/', $foot) ] ];
}
-# /$LISTNAME/f/$MESSAGE_ID.html -> HTML content (fullquotes)
+# /$LISTNAME/$MESSAGE_ID/f/ -> HTML content (fullquotes)
sub get_full_html {
- my ($ctx, $cgi) = @_;
- my $x = mid2blob($ctx);
- return r404() unless $x;
+ my ($ctx) = @_;
+ my $x = mid2blob($ctx) or return r404($ctx);
+
require PublicInbox::View;
+ my $foot = footer($ctx);
require Email::MIME;
- [ 200, [ 'Content-Type' => 'text/html' ],
- [ PublicInbox::View->as_html(Email::MIME->new($$x))] ];
+ my $mime = Email::MIME->new($x);
+ searcher($ctx);
+ [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
+ [ PublicInbox::View::msg_html($ctx, $mime, undef, $foot)] ];
}
-sub self_url {
- my ($cgi) = @_;
- ref($cgi) eq 'CGI' ? $cgi->self_url : $cgi->uri->as_string;
+# /$LISTNAME/$MESSAGE_ID/R/ -> HTML content (fullquotes)
+sub get_reply_html {
+ my ($ctx) = @_;
+ my $x = mid2blob($ctx) or return r404($ctx);
+
+ require PublicInbox::View;
+ my $foot = footer($ctx);
+ require Email::MIME;
+ my $hdr = Email::MIME->new($x)->header_obj;
+ [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
+ [ PublicInbox::View::msg_reply($ctx, $hdr, $foot)] ];
}
-sub redirect_list_index {
- my ($ctx, $cgi) = @_;
- do_redirect(self_url($cgi) . "/");
+# /$LISTNAME/$MESSAGE_ID/t/
+sub get_thread {
+ my ($ctx, $flat) = @_;
+ my $srch = searcher($ctx) or return need_search($ctx);
+ require PublicInbox::View;
+ my $foot = footer($ctx);
+ $ctx->{flat} = $flat;
+ PublicInbox::View::thread_html($ctx, $foot, $srch);
}
-sub redirect_mid {
- my ($ctx, $cgi) = @_;
- my $url = self_url($cgi);
- $url =~ s!/f/!/m/!;
- do_redirect($url . '.html');
+sub ctx_get {
+ my ($ctx, $key) = @_;
+ my $val = $ctx->{$key};
+ (defined $val && $val ne '') or die "BUG: bad ctx, $key unusable";
+ $val;
}
-sub do_redirect {
- my ($url) = @_;
+sub footer {
+ my ($ctx) = @_;
+ return '' unless $ctx;
+ my $git_dir = ctx_get($ctx, 'git_dir');
+
+ # favor user-supplied footer
+ my $footer = try_cat("$git_dir/public-inbox/footer.html");
+ if (defined $footer) {
+ chomp $footer;
+ $ctx->{footer} = $footer;
+ return $footer;
+ }
+
+ # auto-generate a footer
+ my $listname = ctx_get($ctx, 'listname');
+ my $desc = try_cat("$git_dir/description");
+ $desc = '$GIT_DIR/description missing' unless defined $desc;
+ chomp $desc;
+
+ my $urls = try_cat("$git_dir/cloneurl");
+ my @urls = split(/\r?\n/, $urls || '');
+ my %seen = map { $_ => 1 } @urls;
+ my $cgi = $ctx->{cgi};
+ my $http = $cgi->base->as_string . $listname;
+ $seen{$http} or unshift @urls, $http;
+ my $ssoma_url = PublicInbox::Hval::prurl($cgi->{env}, SSOMA_URL);
+ if (scalar(@urls) == 1) {
+ $urls = "URL for <a\nhref=\"" . $ssoma_url .
+ qq(">ssoma</a> or <b>git clone --mirror \$URL</b> :) .
+ $urls[0];
+ } else {
+ $urls = "URLs for <a\nhref=\"" . $ssoma_url .
+ qq(">ssoma</a> or <b>git clone --mirror \$URL</b>\n) .
+ join("\n", map { "\t$_" } @urls);
+ }
+
+ my $addr = $ctx->{pi_config}->get($listname, 'address');
+ if (ref($addr) eq 'ARRAY') {
+ $addr = $addr->[0]; # first address is primary
+ }
+
+ $addr = "<a\nhref=\"mailto:$addr\">$addr</a>";
+
+ $ctx->{footer} = join("\n",
+ '- ' . $desc,
+ "A <a\nhref=\"" .
+ PublicInbox::Hval::prurl($ctx->{cgi}->{env}, PI_URL) .
+ '">public-inbox</a>, ' .
+ 'anybody may post in plain-text (not HTML):',
+ $addr,
+ $urls
+ );
+}
+
+# search support is optional, returns undef if Xapian is not installed
+# or not configured for the given GIT_DIR
+sub searcher {
+ my ($ctx) = @_;
+ eval {
+ require PublicInbox::Search;
+ $ctx->{srch} = PublicInbox::Search->new($ctx->{git_dir});
+ };
+}
+
+sub need_search {
+ my ($ctx) = @_;
+ my $msg = <<EOF;
+<html><head><title>Search not available for this
+public-inbox</title><body><pre>Search is not available for this public-inbox
+<a href="../">Return to index</a></pre></body></html>
+EOF
+ [ 501, [ 'Content-Type' => 'text/html; charset=UTF-8' ], [ $msg ] ];
+}
+
+# /$LISTNAME/$MESSAGE_ID/t.mbox -> thread as mbox
+# /$LISTNAME/$MESSAGE_ID/t.mbox.gz -> thread as gzipped mbox
+# note: I'm not a big fan of other compression formats since they're
+# significantly more expensive on CPU than gzip and less-widely available,
+# especially on older systems. Stick to zlib since that's what git uses.
+sub get_thread_mbox {
+ my ($ctx, $sfx) = @_;
+ my $srch = searcher($ctx) or return need_search($ctx);
+ require PublicInbox::Mbox;
+ PublicInbox::Mbox::thread_mbox($ctx, $srch, $sfx);
+}
+
+
+# /$LISTNAME/$MESSAGE_ID/t.atom -> thread as Atom feed
+sub get_thread_atom {
+ my ($ctx) = @_;
+ searcher($ctx) or return need_search($ctx);
+ $ctx->{self_url} = $ctx->{cgi}->uri->as_string;
+ require PublicInbox::Feed;
+ PublicInbox::Feed::generate_thread_atom($ctx);
+}
+
+sub legacy_redirects {
+ my ($self, $ctx, $path_info) = @_;
+
+ # single-message pages
+ if ($path_info =~ m!$LISTNAME_RE/m/(\S+)/\z!o) {
+ r301($ctx, $1, $2);
+ } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)/raw\z!o) {
+ r301($ctx, $1, $2, 'raw');
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)/\z!o) {
+ r301($ctx, $1, $2, 'f/');
+
+ # thread display
+ } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)/\z!o) {
+ r301($ctx, $1, $2, 't/#u');
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)/mbox(\.gz)?\z!o) {
+ r301($ctx, $1, $2, "t.mbox$3");
+
+ # even older legacy redirects
+ } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
+ r301($ctx, $1, $2);
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)\.html\z!o) {
+ r301($ctx, $1, $2, 't/#u');
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
+ r301($ctx, $1, $2, 'f/');
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/(?:m|f)/(\S+)\.txt\z!o) {
+ r301($ctx, $1, $2, 'raw');
+
+ } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)(\.mbox(?:\.gz)?)\z!o) {
+ r301($ctx, $1, $2, "t$3");
+
+ # legacy convenience redirects, order still matters
+ } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\z!o) {
+ r301($ctx, $1, $2);
+ } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)\z!o) {
+ r301($ctx, $1, $2, 't/#u');
+ } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\z!o) {
+ r301($ctx, $1, $2, 'f/');
+
+ # some Message-IDs have slashes in them and the HTTP server
+ # may try to be clever and unescape them :<
+ } elsif ($path_info =~ m!$LISTNAME_RE/(\S+/\S+)/$END_RE\z!o) {
+ msg_page($self, $ctx, $1, $2, $3);
+
+ # in case people leave off the trailing slash:
+ } elsif ($path_info =~ m!$LISTNAME_RE/(\S+/\S+)/(f|T|t)\z!o) {
+ r301($ctx, $1, $2, $3 eq 't' ? 't/#u' : $3);
+ } else {
+ $self->news_www->call($ctx->{cgi}->{env});
+ }
+}
+
+sub r301 {
+ my ($ctx, $listname, $mid, $suffix) = @_;
+ my $cgi = $ctx->{cgi};
+ my $url;
+ my $qs = $cgi->env->{QUERY_STRING};
+ $url = $cgi->base->as_string . $listname . '/';
+ $url .= (uri_escape_utf8($mid) . '/') if (defined $mid);
+ $url .= $suffix if (defined $suffix);
+ $url .= "?$qs" if $qs ne '';
+
[ 301,
[ Location => $url, 'Content-Type' => 'text/plain' ],
- [ "Redirecting to $url\n" ]
- ]
+ [ "Redirecting to $url\n" ] ]
+}
+
+sub msg_page {
+ my ($self, $ctx, $list, $mid, $e) = @_;
+ my $ret;
+ $ret = invalid_list_mid($self, $ctx, $list, $mid) and return $ret;
+ '' eq $e and return get_mid_html($ctx);
+ 't/' eq $e and return get_thread($ctx);
+ 't.atom' eq $e and return get_thread_atom($ctx);
+ 't.mbox' eq $e and return get_thread_mbox($ctx);
+ 't.mbox.gz' eq $e and return get_thread_mbox($ctx, '.gz');
+ 'T/' eq $e and return get_thread($ctx, 1);
+ 'raw' eq $e and return get_mid_txt($ctx);
+ 'f/' eq $e and return get_full_html($ctx);
+ 'R/' eq $e and return get_reply_html($ctx);
+ r404($ctx);
+}
+
+sub serve_git {
+ my ($cgi, $git, $path) = @_;
+ PublicInbox::GitHTTPBackend::serve($cgi, $git, $path);
+}
+
+sub news_www {
+ my ($self) = @_;
+ my $nw = $self->{news_www};
+ return $nw if $nw;
+ require PublicInbox::NewsWWW;
+ $self->{news_www} = PublicInbox::NewsWWW->new($self->{pi_config});
}
1;