1 # Copyright (C) 2014, Eric Wong <normalperson@yhbt.net> and all contributors
2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
4 # We focus on the lowest common denominators here:
5 # - targeted at text-only console browsers (lynx, w3m, etc..)
6 # - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
7 # - No JavaScript, graphics or icons allowed.
8 # - Must not rely on static content
9 # - UTF-8 is only for user-content, 7-bit US-ASCII for us
10 package PublicInbox::WWW;
14 use PublicInbox::Config;
15 use URI::Escape qw(uri_escape_utf8 uri_unescape);
16 use constant SSOMA_URL => 'http://ssoma.public-inbox.org/';
17 use constant PI_URL => 'http://public-inbox.org/';
18 our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
21 $pi_config = PublicInbox::Config->new;
25 my ($cgi, $method) = @_;
27 if ($method !~ /\AGET|HEAD\z/) {
28 return r(405, 'Method Not Allowed');
30 my $path_info = $cgi->path_info;
32 # top-level indices and feeds
33 if ($path_info eq '/') {
35 } elsif ($path_info =~ m!$LISTNAME_RE\z!o) {
36 invalid_list(\%ctx, $1) || redirect_list_index(\%ctx, $cgi);
37 } elsif ($path_info =~ m!$LISTNAME_RE(?:/|/index\.html)?\z!o) {
38 invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi);
39 } elsif ($path_info =~ m!$LISTNAME_RE/atom\.xml\z!o) {
40 invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi);
42 # single-message pages
43 } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.txt\z!o) {
44 invalid_list_mid(\%ctx, $1, $2) || get_mid_txt(\%ctx, $cgi);
45 } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
46 invalid_list_mid(\%ctx, $1, $2) || get_mid_html(\%ctx, $cgi);
49 } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
50 invalid_list_mid(\%ctx, $1, $2) || get_full_html(\%ctx, $cgi);
53 } elsif ($path_info =~ m!$LISTNAME_RE/t/(\S+)\.html\z!o) {
54 invalid_list_mid(\%ctx, $1, $2) || get_thread(\%ctx, $cgi);
56 # subject_path display
57 } elsif ($path_info =~ m!$LISTNAME_RE/s/(\S+)\.html\z!o) {
59 invalid_list(\%ctx, $1) || get_subject_path(\%ctx, $cgi, $sp);
61 } elsif ($path_info =~ m!$LISTNAME_RE/f/\S+\.txt\z!o) {
62 invalid_list_mid(\%ctx, $1, $2) ||
63 redirect_mid_txt(\%ctx, $cgi);
65 # convenience redirects, order matters
66 } elsif ($path_info =~ m!$LISTNAME_RE/(m|f|t|s)/(\S+)\z!o) {
68 invalid_list_mid(\%ctx, $1, $3) ||
69 redirect_mid(\%ctx, $cgi, $2);
76 # for CoW-friendliness, MOOOOO!
78 require PublicInbox::Feed;
79 require PublicInbox::View;
80 require PublicInbox::Thread;
84 require XML::Atom::SimpleFeed;
87 # private functions below
89 sub r404 { r(404, 'Not Found') }
91 # simple response for errors
92 sub r { [ $_[0], ['Content-Type' => 'text/plain'], [ join(' ', @_, "\n") ] ] }
94 # returns undef if valid, array ref response if invalid
96 my ($ctx, $listname) = @_;
97 my $git_dir = $pi_config->get($listname, "mainrepo");
98 if (defined $git_dir) {
99 $ctx->{git_dir} = $git_dir;
100 $ctx->{listname} = $listname;
106 # returns undef if valid, array ref response if invalid
107 sub invalid_list_mid {
108 my ($ctx, $listname, $mid) = @_;
109 my $ret = invalid_list($ctx, $listname, $mid);
110 $ctx->{mid} = uri_unescape($mid) unless $ret;
114 # /$LISTNAME/atom.xml -> Atom feed, includes replies
116 my ($ctx, $cgi) = @_;
117 require PublicInbox::Feed;
118 $ctx->{pi_config} = $pi_config;
120 [ 200, [ 'Content-Type' => 'application/xml' ],
121 [ PublicInbox::Feed->generate($ctx) ] ]
124 # /$LISTNAME/?r=$GIT_COMMIT -> HTML only
126 my ($ctx, $cgi) = @_;
127 require PublicInbox::Feed;
128 my $srch = searcher($ctx);
129 $ctx->{pi_config} = $pi_config;
132 [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
133 [ PublicInbox::Feed->generate_html_index($ctx) ] ]
136 # just returns a string ref for the blob in the current ctx
139 require PublicInbox::MID;
140 my $path = PublicInbox::MID::mid2path($ctx->{mid});
141 my @cmd = ('git', "--git-dir=$ctx->{git_dir}",
142 qw(cat-file blob), "HEAD:$path");
143 my $cmd = join(' ', @cmd);
144 my $pid = open my $fh, '-|';
145 defined $pid or die "fork failed: $!\n";
147 open STDERR, '>', '/dev/null'; # ignore errors
148 exec @cmd or die "exec failed: $!\n";
150 my $blob = eval { local $/; <$fh> };
152 $? == 0 ? \$blob : undef;
156 # /$LISTNAME/m/$MESSAGE_ID.txt -> raw original
158 my ($ctx, $cgi) = @_;
159 my $x = mid2blob($ctx);
160 $x ? [ 200, [ 'Content-Type' => 'text/plain' ], [ $$x ] ] : r404();
163 # /$LISTNAME/m/$MESSAGE_ID.html -> HTML content (short quotes)
165 my ($ctx, $cgi) = @_;
166 my $x = mid2blob($ctx);
167 return r404() unless $x;
169 require PublicInbox::View;
170 my $pfx = msg_pfx($ctx);
171 my $foot = footer($ctx);
173 my $mime = Email::MIME->new($x);
174 my $srch = searcher($ctx);
175 [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
176 [ PublicInbox::View->msg_html($mime, $pfx, $foot, $srch) ] ];
179 # /$LISTNAME/f/$MESSAGE_ID.html -> HTML content (fullquotes)
181 my ($ctx, $cgi) = @_;
182 my $x = mid2blob($ctx);
183 return r404() unless $x;
184 require PublicInbox::View;
185 my $foot = footer($ctx);
187 my $mime = Email::MIME->new($x);
188 my $srch = searcher($ctx);
189 [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
190 [ PublicInbox::View->msg_html($mime, undef, $foot, $srch)] ];
193 # /$LISTNAME/t/$MESSAGE_ID.html
195 my ($ctx, $cgi) = @_;
196 my $srch = searcher($ctx) or return need_search($ctx);
197 require PublicInbox::View;
198 my $foot = footer($ctx);
199 my $body = PublicInbox::View->thread_html($ctx, $foot, $srch) or
201 [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
205 # /$LISTNAME/s/$SUBJECT_PATH.html
206 sub get_subject_path {
207 my ($ctx, $cgi, $sp) = @_;
208 $ctx->{subject_path} = $sp;
209 my $srch = searcher($ctx) or return need_search($ctx);
210 require PublicInbox::View;
211 my $foot = footer($ctx);
212 my $body = PublicInbox::View->subject_path_html($ctx, $foot, $srch) or
214 [ 200, [ 'Content-Type' => 'text/html; charset=UTF-8' ],
220 ref($cgi) eq 'CGI' ? $cgi->self_url : $cgi->uri->as_string;
223 sub redirect_list_index {
224 my ($ctx, $cgi) = @_;
225 do_redirect(self_url($cgi) . "/");
229 my ($ctx, $cgi, $pfx) = @_;
230 my $url = self_url($cgi);
232 if (lc($pfx) eq 't') {
233 $anchor = '#u'; # <u id='#u'> is used to highlight in View.pm
235 do_redirect($url . ".html$anchor");
238 # only hit when somebody tries to guess URLs manually:
239 sub redirect_mid_txt {
240 my ($ctx, $cgi, $pfx) = @_;
241 my $listname = $ctx->{listname};
242 my $url = self_url($cgi);
243 $url =~ s!/$listname/f/(\S+\.txt)\z!/$listname/m/$1!;
250 [ Location => $url, 'Content-Type' => 'text/plain' ],
251 [ "Redirecting to $url\n" ]
256 my ($ctx, $key) = @_;
257 my $val = $ctx->{$key};
258 (defined $val && length $val) or die "BUG: bad ctx, $key unusable\n";
265 if (open(my $fh, '<', $path)) {
275 return '' unless $ctx;
276 my $git_dir = ctx_get($ctx, 'git_dir');
278 # favor user-supplied footer
279 my $footer = try_cat("$git_dir/public-inbox/footer.html");
280 if (defined $footer) {
282 $ctx->{footer} = $footer;
286 # auto-generate a footer
287 my $listname = ctx_get($ctx, 'listname');
288 my $desc = try_cat("$git_dir/description");
289 $desc = '$GIT_DIR/description missing' unless defined $desc;
292 my $urls = try_cat("$git_dir/cloneurl");
293 my @urls = split(/\r?\n/, $urls || '');
294 my $nurls = scalar @urls;
296 $urls = '($GIT_DIR/cloneurl missing)';
297 } elsif ($nurls == 1) {
298 $urls = "git URL for <a\nhref=\"" . SSOMA_URL .
299 '">ssoma</a>: ' . $urls[0];
301 $urls = "git URLs for <a\nhref=\"" . SSOMA_URL .
302 "\">ssoma</a>:\n" . join("\n", map { "\t$_" } @urls);
305 my $addr = $pi_config->get($listname, 'address');
306 if (ref($addr) eq 'ARRAY') {
307 $addr = $addr->[0]; # first address is primary
310 $addr = "<a\nhref=\"mailto:$addr\">$addr</a>";
313 $ctx->{footer} = join("\n",
315 "A <a\nhref=\"" . PI_URL . '">public-inbox</a>, ' .
316 'anybody may post in plain-text (not HTML):',
322 # search support is optional, returns undef if Xapian is not installed
323 # or not configured for the given GIT_DIR
327 require PublicInbox::Search;
328 $ctx->{srch} = PublicInbox::Search->new($ctx->{git_dir});
335 <html><head><title>Search not available for this
336 public-inbox</title><body><pre>Search is not available for this public-inbox
337 <a href="../">Return to index</a></pre></body></html>
339 [ 501, [ 'Content-Type' => 'text/html; charset=UTF-8' ], [ $msg ] ];
344 my $href = PublicInbox::Hval::ascii_html(uri_escape_utf8($ctx->{mid}));