1 # Copyright (C) 2014-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Main web interface for mailing list archives
6 # We focus on the lowest common denominators here:
7 # - targeted at text-only console browsers (w3m, links, etc..)
8 # - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
9 # and diff/syntax-highlighting (optional)
10 # - No JavaScript, graphics or icons allowed.
11 # - Must not rely on static content
12 # - UTF-8 is only for user-content, 7-bit US-ASCII for us
13 package PublicInbox::WWW;
17 use bytes (); # only for bytes::length
18 use PublicInbox::Config;
19 use PublicInbox::Hval;
20 use URI::Escape qw(uri_unescape);
21 use PublicInbox::MID qw(mid_escape);
22 use PublicInbox::GitHTTPBackend;
23 use PublicInbox::UserContent;
24 use PublicInbox::WwwStatic qw(r path_info_raw);
27 # TODO: consider a routing tree now that we have more endpoints:
28 our $INBOX_RE = qr!\A/([\w\-][\w\.\-]*)!;
29 our $MID_RE = qr!([^/]+)!;
30 our $END_RE = qr!(T/|t/|t\.mbox(?:\.gz)?|t\.atom|raw|)!;
31 our $ATTACH_RE = qr!([0-9][0-9\.]*)-($PublicInbox::Hval::FN)!;
32 our $OID_RE = qr![a-f0-9]{7,40}!;
35 my ($class, $pi_config) = @_;
36 $pi_config ||= PublicInbox::Config->new;
37 bless { pi_config => $pi_config }, $class;
40 # backwards compatibility, do not use
42 my ($req, $method) = @_;
43 PublicInbox::WWW->new->call($req->env);
47 my ($self, $env) = @_;
48 my $ctx = { env => $env, www => $self };
50 # we don't care about multi-value
54 my ($k, $v) = split('=', $_, 2);
55 $v = uri_unescape($v // '');
56 # none of the keys we care about will need escaping
58 } split(/[&;]+/, $env->{QUERY_STRING});
60 my $path_info = path_info_raw($env);
61 my $method = $env->{REQUEST_METHOD};
63 if ($method eq 'POST') {
64 if ($path_info =~ m!$INBOX_RE/(?:(?:git/)?([0-9]+)(?:\.git)?/)?
65 (git-upload-pack)\z!x) {
66 my ($epoch, $path) = ($2, $3);
67 return invalid_inbox($ctx, $1) ||
68 serve_git($ctx, $epoch, $path);
69 } elsif ($path_info =~ m!$INBOX_RE/(\w+)\.sql\.gz\z!o) {
70 return get_altid_dump($ctx, $1, $2);
71 } elsif ($path_info =~ m!$INBOX_RE/!o) {
72 return invalid_inbox($ctx, $1) || mbox_results($ctx);
75 elsif ($method !~ /\A(?:GET|HEAD)\z/) {
79 # top-level indices and feeds
80 if ($path_info eq '/' || $path_info eq '/manifest.js.gz') {
81 www_listing($self)->call($env);
82 } elsif ($path_info =~ m!$INBOX_RE\z!o) {
83 invalid_inbox($ctx, $1) || r301($ctx, $1);
84 } elsif ($path_info =~ m!$INBOX_RE(?:/|/index\.html)?\z!o) {
85 invalid_inbox($ctx, $1) || get_index($ctx);
86 } elsif ($path_info =~ m!$INBOX_RE/(?:atom\.xml|new\.atom)\z!o) {
87 invalid_inbox($ctx, $1) || get_atom($ctx);
88 } elsif ($path_info =~ m!$INBOX_RE/new\.html\z!o) {
89 invalid_inbox($ctx, $1) || get_new($ctx);
90 } elsif ($path_info =~ m!$INBOX_RE/description\z!o) {
91 get_description($ctx, $1);
92 } elsif ($path_info =~ m!$INBOX_RE/(?:(?:git/)?([0-9]+)(?:\.git)?/)?
93 ($PublicInbox::GitHTTPBackend::ANY)\z!ox) {
94 my ($epoch, $path) = ($2, $3);
95 invalid_inbox($ctx, $1) || serve_git($ctx, $epoch, $path);
96 } elsif ($path_info =~ m!$INBOX_RE/([a-zA-Z0-9_\-]+).mbox\.gz\z!o) {
97 serve_mbox_range($ctx, $1, $2);
98 } elsif ($path_info =~ m!$INBOX_RE/$MID_RE/$END_RE\z!o) {
99 msg_page($ctx, $1, $2, $3);
101 } elsif ($path_info =~ m!$INBOX_RE/$MID_RE/$ATTACH_RE\z!o) {
102 my ($idx, $fn) = ($3, $4);
103 invalid_inbox_mid($ctx, $1, $2) || get_attach($ctx, $idx, $fn);
104 # in case people leave off the trailing slash:
105 } elsif ($path_info =~ m!$INBOX_RE/$MID_RE/(T|t)\z!o) {
106 my ($inbox, $mid_ue, $suffix) = ($1, $2, $3);
107 $suffix .= $suffix =~ /\A[tT]\z/ ? '/#u' : '/';
108 r301($ctx, $inbox, $mid_ue, $suffix);
110 } elsif ($path_info =~ m!$INBOX_RE/$MID_RE/R/?\z!o) {
111 my ($inbox, $mid_ue) = ($1, $2);
112 r301($ctx, $inbox, $mid_ue, '#R');
114 } elsif ($path_info =~ m!$INBOX_RE/$MID_RE/f/?\z!o) {
116 } elsif ($path_info =~ m!$INBOX_RE/_/text(?:/(.*))?\z!o) {
117 get_text($ctx, $1, $2);
118 } elsif ($path_info =~ m!$INBOX_RE/([a-zA-Z0-9_\-\.]+)\.css\z!o) {
119 get_css($ctx, $1, $2);
120 } elsif ($path_info =~ m!$INBOX_RE/manifest\.js\.gz\z!o) {
121 get_inbox_manifest($ctx, $1, $2);
122 } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s/\z!o) {
123 get_vcs_object($ctx, $1, $2);
124 } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s/
125 ($PublicInbox::Hval::FN)\z!ox) {
126 get_vcs_object($ctx, $1, $2, $3);
127 } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s\z!o) {
128 r301($ctx, $1, $2, 's/');
129 } elsif ($path_info =~ m!$INBOX_RE/(\w+)\.sql\.gz\z!o) {
130 get_altid_dump($ctx, $1, $2);
131 # convenience redirects order matters
132 } elsif ($path_info =~ m!$INBOX_RE/([^/]{2,})\z!o) {
136 legacy_redirects($ctx, $path_info);
140 # for CoW-friendliness, MOOOOO! Even for single-process setups,
141 # we want to get all immortal allocations done early to avoid heap
142 # fragmentation since common allocators favor a large contiguous heap.
146 # populate caches used by Encode internally, since emails
147 # may show up with any encoding.
149 Encode::find_encoding($_) for Encode->encodings(':all');
151 require PublicInbox::ExtMsg;
152 require PublicInbox::Feed;
153 require PublicInbox::View;
154 require PublicInbox::SearchThread;
155 require PublicInbox::Eml;
156 require PublicInbox::Mbox;
157 require PublicInbox::ViewVCS;
158 require PublicInbox::WwwText;
159 require PublicInbox::WwwAttach;
161 require PublicInbox::Search;
162 PublicInbox::Search::load_xapian();
164 for (qw(SearchView MboxGz WwwAltId)) {
165 eval "require PublicInbox::$_;";
168 my $pi_config = $self->{pi_config};
169 if (defined($pi_config->{'publicinbox.cgitrc'})) {
170 $pi_config->limiter('-cgit');
173 $self->stylesheets_prepare($_) for ('', '../', '../../');
176 $pi_config->each_inbox(\&preload_inbox);
188 # private functions below
192 if ($ctx && $ctx->{mid}) {
193 require PublicInbox::ExtMsg;
194 return PublicInbox::ExtMsg::ext_msg($ctx);
199 sub news_cgit_fallback ($) {
201 my $www = $ctx->{www};
202 my $env = $ctx->{env};
203 my $res = $www->news_www->call($env);
204 $res->[0] == 404 ? $www->cgit->call($env) : $res;
207 # returns undef if valid, array ref response if invalid
208 sub invalid_inbox ($$) {
209 my ($ctx, $inbox) = @_;
210 my $ibx = $ctx->{www}->{pi_config}->lookup_name($inbox);
212 $ctx->{-inbox} = $ibx;
216 # sometimes linkifiers (not ours!) screw up automatic link
217 # generation and link things intended for nntp:// to https?://,
218 # so try to infer links and redirect them to the appropriate
220 news_cgit_fallback($ctx);
223 # returns undef if valid, array ref response if invalid
224 sub invalid_inbox_mid {
225 my ($ctx, $inbox, $mid_ue) = @_;
226 my $ret = invalid_inbox($ctx, $inbox);
229 my $mid = $ctx->{mid} = uri_unescape($mid_ue);
230 my $ibx = $ctx->{-inbox};
231 if ($mid =~ m!\A([a-f0-9]{2})([a-f0-9]{38})\z!) {
232 my ($x2, $x38) = ($1, $2);
233 # this is horrifically wasteful for legacy URLs:
234 my $str = $ctx->{-inbox}->msg_by_path("$x2/$x38") or return;
235 my $s = PublicInbox::Eml->new($str);
236 $mid = PublicInbox::MID::mid_clean($s->header_raw('Message-ID'));
237 return r301($ctx, $inbox, mid_escape($mid));
242 # /$INBOX/new.atom -> Atom feed, includes replies
245 require PublicInbox::Feed;
246 PublicInbox::Feed::generate($ctx);
249 # /$INBOX/new.html -> HTML only
252 require PublicInbox::Feed;
253 PublicInbox::Feed::new_html($ctx);
256 # /$INBOX/?r=$GIT_COMMIT -> HTML only
259 require PublicInbox::Feed;
260 if ($ctx->{env}->{QUERY_STRING} =~ /(?:\A|[&;])q=/) {
261 require PublicInbox::SearchView;
262 PublicInbox::SearchView::sres_top_html($ctx);
264 PublicInbox::Feed::generate_html_index($ctx);
268 # /$INBOX/$MESSAGE_ID/raw -> raw mbox
271 require PublicInbox::Mbox;
272 PublicInbox::Mbox::emit_raw($ctx) || r404($ctx);
275 # /$INBOX/$MESSAGE_ID/ -> HTML content (short quotes)
278 require PublicInbox::View;
279 PublicInbox::View::msg_page($ctx) || r404($ctx);
282 # /$INBOX/$MESSAGE_ID/t/
284 my ($ctx, $flat) = @_;
285 $ctx->{-inbox}->over or return need($ctx, 'Overview');
286 $ctx->{flat} = $flat;
287 require PublicInbox::View;
288 PublicInbox::View::thread_html($ctx);
291 # /$INBOX/_/text/$KEY/
292 # /$INBOX/_/text/$KEY/raw
293 # KEY may contain slashes
295 my ($ctx, $inbox, $key) = @_;
296 my $r404 = invalid_inbox($ctx, $inbox);
297 return $r404 if $r404;
299 require PublicInbox::WwwText;
300 PublicInbox::WwwText::get_text($ctx, $key);
303 # show git objects (blobs and commits)
304 # /$INBOX/_/$OBJECT_ID/show
305 # /$INBOX/_/${OBJECT_ID}_${FILENAME}
306 # KEY may contain slashes
307 sub get_vcs_object ($$$;$) {
308 my ($ctx, $inbox, $oid, $filename) = @_;
309 my $r404 = invalid_inbox($ctx, $inbox);
310 return $r404 if $r404;
311 require PublicInbox::ViewVCS;
312 PublicInbox::ViewVCS::show($ctx, $oid, $filename);
316 my ($ctx, $inbox, $altid_pfx) =@_;
317 my $r404 = invalid_inbox($ctx, $inbox);
318 return $r404 if $r404;
319 eval { require PublicInbox::WwwAltId } or return need($ctx, 'sqlite3');
320 PublicInbox::WwwAltId::sqldump($ctx, $altid_pfx);
324 my ($ctx, $extra) = @_;
325 require PublicInbox::WwwStream;
326 PublicInbox::WwwStream::html_oneshot($ctx, 501, \<<EOF);
327 <pre>$extra is not available for this public-inbox
328 <a\nhref="../">Return to index</a></pre>
332 # /$INBOX/$MESSAGE_ID/t.mbox -> thread as mbox
333 # /$INBOX/$MESSAGE_ID/t.mbox.gz -> thread as gzipped mbox
334 # note: I'm not a big fan of other compression formats since they're
335 # significantly more expensive on CPU than gzip and less-widely available,
336 # especially on older systems. Stick to zlib since that's what git uses.
337 sub get_thread_mbox {
338 my ($ctx, $sfx) = @_;
339 my $over = $ctx->{-inbox}->over or return need($ctx, 'Overview');
340 require PublicInbox::Mbox;
341 PublicInbox::Mbox::thread_mbox($ctx, $over, $sfx);
345 # /$INBOX/$MESSAGE_ID/t.atom -> thread as Atom feed
346 sub get_thread_atom {
348 $ctx->{-inbox}->over or return need($ctx, 'Overview');
349 require PublicInbox::Feed;
350 PublicInbox::Feed::generate_thread_atom($ctx);
353 sub legacy_redirects {
354 my ($ctx, $path_info) = @_;
356 # single-message pages
357 if ($path_info =~ m!$INBOX_RE/m/(\S+)/\z!o) {
359 } elsif ($path_info =~ m!$INBOX_RE/m/(\S+)/raw\z!o) {
360 r301($ctx, $1, $2, 'raw');
362 } elsif ($path_info =~ m!$INBOX_RE/f/(\S+)/\z!o) {
366 } elsif ($path_info =~ m!$INBOX_RE/t/(\S+)/\z!o) {
367 r301($ctx, $1, $2, 't/#u');
369 } elsif ($path_info =~ m!$INBOX_RE/t/(\S+)/mbox(\.gz)?\z!o) {
370 r301($ctx, $1, $2, "t.mbox$3");
372 # even older legacy redirects
373 } elsif ($path_info =~ m!$INBOX_RE/m/(\S+)\.html\z!o) {
376 } elsif ($path_info =~ m!$INBOX_RE/t/(\S+)\.html\z!o) {
377 r301($ctx, $1, $2, 't/#u');
379 } elsif ($path_info =~ m!$INBOX_RE/f/(\S+)\.html\z!o) {
382 } elsif ($path_info =~ m!$INBOX_RE/(?:m|f)/(\S+)\.txt\z!o) {
383 r301($ctx, $1, $2, 'raw');
385 } elsif ($path_info =~ m!$INBOX_RE/t/(\S+)(\.mbox(?:\.gz)?)\z!o) {
386 r301($ctx, $1, $2, "t$3");
388 # legacy convenience redirects, order still matters
389 } elsif ($path_info =~ m!$INBOX_RE/m/(\S+)\z!o) {
391 } elsif ($path_info =~ m!$INBOX_RE/t/(\S+)\z!o) {
392 r301($ctx, $1, $2, 't/#u');
393 } elsif ($path_info =~ m!$INBOX_RE/f/(\S+)\z!o) {
396 # some Message-IDs have slashes in them and the HTTP server
397 # may try to be clever and unescape them :<
398 } elsif ($path_info =~ m!$INBOX_RE/(\S+/\S+)/$END_RE\z!o) {
399 msg_page($ctx, $1, $2, $3);
401 # in case people leave off the trailing slash:
402 } elsif ($path_info =~ m!$INBOX_RE/(\S+/\S+)/(T|t)\z!o) {
403 r301($ctx, $1, $2, $3 eq 't' ? 't/#u' : $3);
404 } elsif ($path_info =~ m!$INBOX_RE/(\S+/\S+)/f\z!o) {
407 news_cgit_fallback($ctx);
412 my ($ctx, $inbox, $mid_ue, $suffix) = @_;
413 my $ibx = $ctx->{-inbox};
415 my $r404 = invalid_inbox($ctx, $inbox);
416 return $r404 if $r404;
417 $ibx = $ctx->{-inbox};
419 my $url = $ibx->base_url($ctx->{env});
420 my $qs = $ctx->{env}->{QUERY_STRING};
421 if (defined $mid_ue) {
422 # common, and much nicer as '@' than '%40':
423 $mid_ue =~ s/%40/@/g;
424 $url .= $mid_ue . '/';
426 $url .= $suffix if (defined $suffix);
427 $url .= "?$qs" if $qs ne '';
430 [ Location => $url, 'Content-Type' => 'text/plain' ],
431 [ "Redirecting to $url\n" ] ]
435 my ($ctx, $inbox, $mid_ue, $e) = @_;
437 $ret = invalid_inbox_mid($ctx, $inbox, $mid_ue) and return $ret;
438 '' eq $e and return get_mid_html($ctx);
439 'T/' eq $e and return get_thread($ctx, 1);
440 't/' eq $e and return get_thread($ctx);
441 't.atom' eq $e and return get_thread_atom($ctx);
442 't.mbox' eq $e and return get_thread_mbox($ctx);
443 't.mbox.gz' eq $e and return get_thread_mbox($ctx, '.gz');
444 'raw' eq $e and return get_mid_txt($ctx);
446 # legacy, but no redirect for compatibility:
447 'f/' eq $e and return get_mid_html($ctx);
452 my ($ctx, $epoch, $path) = @_;
453 my $env = $ctx->{env};
454 my $ibx = $ctx->{-inbox};
455 my $git = defined $epoch ? $ibx->git_epoch($epoch) : $ibx->git;
456 $git ? PublicInbox::GitHTTPBackend::serve($env, $git, $path) : r404();
461 if ($ctx->{env}->{QUERY_STRING} =~ /(?:\A|[&;])q=/) {
462 $ctx->{-inbox}->search or return need($ctx, 'search');
463 require PublicInbox::SearchView;
464 return PublicInbox::SearchView::mbox_results($ctx);
469 sub serve_mbox_range {
470 my ($ctx, $inbox, $range) = @_;
471 invalid_inbox($ctx, $inbox) || eval {
472 require PublicInbox::Mbox;
473 PublicInbox::Mbox::emit_range($ctx, $range);
479 $self->{news_www} ||= do {
480 require PublicInbox::NewsWWW;
481 PublicInbox::NewsWWW->new($self->{pi_config});
487 $self->{cgit} ||= do {
488 my $pi_config = $self->{pi_config};
490 if (defined($pi_config->{'publicinbox.cgitrc'})) {
491 require PublicInbox::Cgit;
492 PublicInbox::Cgit->new($pi_config);
495 Plack::Util::inline_object(call => sub { r404() });
502 $self->{www_listing} ||= do {
503 require PublicInbox::WwwListing;
504 PublicInbox::WwwListing->new($self);
508 # GET $INBOX/manifest.js.gz
509 sub get_inbox_manifest ($$$) {
510 my ($ctx, $inbox, $key) = @_;
511 my $r404 = invalid_inbox($ctx, $inbox);
512 return $r404 if $r404;
513 require PublicInbox::WwwListing;
514 PublicInbox::WwwListing::js($ctx->{env}, [$ctx->{-inbox}]);
518 my ($ctx, $idx, $fn) = @_;
519 require PublicInbox::WwwAttach;
520 PublicInbox::WwwAttach::get_attach($ctx, $idx, $fn);
523 # User-generated content (UGC) may have excessively long lines
524 # and screw up rendering on some browsers, so we use pre-wrap.
526 # We also force everything to the same scaled font-size because GUI
527 # browsers (tested both Firefox and surf (webkit)) uses a larger font
528 # for the Search <form> element than the rest of the page. Font size
529 # uniformity is important to people who rely on gigantic fonts.
530 # Finally, we use monospace to ensure the Search field and button
531 # has the same size and spacing as everything else which is
532 # <pre>-formatted anyways.
533 our $STYLE = 'pre{white-space:pre-wrap}*{font-size:100%;font-family:monospace}';
535 sub stylesheets_prepare ($$) {
536 my ($self, $upfx) = @_;
538 require CSS::Minifier;
539 sub { CSS::Minifier::minify(input => $_[0]) };
541 require CSS::Minifier::XS;
542 sub { CSS::Minifier::XS::minify($_[0]) };
546 my $stylesheets = $self->{pi_config}->{css} || [];
550 foreach my $s (@$stylesheets) {
553 foreach my $k (qw(media title href)) {
554 if (s/\s*$k='([^']+)'// || s/\s*$k=(\S+)//) {
559 if (defined $attr->{href}) {
563 my ($key) = (m!([^/]+?)(?:\.css)?\z!i);
564 if ($key !~ /\A[a-zA-Z0-9_\-\.]+\z/) {
565 warn "ignoring $fn, non-ASCII word character\n";
568 open(my $fh, '<', $fn) or do {
569 warn "failed to open $fn: $!\n";
573 my $local = do { local $/; <$fh> };
574 if ($local =~ /\S/) {
575 $ctime = sprintf('%x',(stat($fh))[10]);
576 $local = $mini->($local);
579 # do not let BOFHs override userContent.css:
580 if ($local =~ /!\s*important\b/i) {
581 warn "ignoring $fn since it uses `!important'\n";
585 $css_map->{$key} = $local;
586 $attr->{href} = "$upfx$key.css?$ctime";
587 if (defined($attr->{title})) {
589 } elsif (($attr->{media}||'screen') eq 'screen') {
590 $attr->{-inline} = $local;
596 my $buf = "<style>$STYLE";
598 my @ext; # for media=print and whatnot
599 foreach my $attr (@$links) {
600 if (defined(my $str = delete $attr->{-inline})) {
611 foreach my $attr (@$links) {
612 delete $attr->{-inline};
613 $buf .= "<link\ntype=text/css\nrel=stylesheet";
614 while (my ($k, $v) = each %$attr) {
615 $v = qq{"$v"} if $v =~ /[\s=]/;
620 $self->{"-style-$upfx"} = $buf;
622 $self->{-style_inline} = $buf;
624 $self->{-css_map} = $css_map;
627 # returns an HTML fragment with <style> or <link> tags in them
628 # Called by WwwStream by nearly every HTML page
630 my ($self, $upfx) = @_;
631 $self->{-style_inline} || $self->{"-style-$upfx"} || do {
632 stylesheets_prepare($self, $upfx);
633 $self->{-style_inline} || $self->{"-style-$upfx"}
637 # /$INBOX/$KEY.css endpoint
638 # CSS is configured globally for all inboxes, but we access them on
639 # a per-inbox basis. This allows administrators to setup per-inbox
640 # static routes to intercept the request before it hits PSGI
642 my ($ctx, $inbox, $key) = @_;
643 my $r404 = invalid_inbox($ctx, $inbox);
644 return $r404 if $r404;
645 my $self = $ctx->{www};
646 my $css_map = $self->{-css_map} || stylesheets_prepare($self, '');
647 my $css = $css_map->{$key};
648 if (!defined($css) && $key eq 'userContent') {
649 my $env = $ctx->{env};
650 $css = PublicInbox::UserContent::sample($ctx->{-inbox}, $env);
652 defined $css or return r404();
653 my $h = [ 'Content-Length', bytes::length($css),
654 'Content-Type', 'text/css' ];
655 PublicInbox::GitHTTPBackend::cache_one_year($h);
656 [ 200, $h, [ $css ] ];
659 sub get_description {
660 my ($ctx, $inbox) = @_;
661 invalid_inbox($ctx, $inbox) || do {
662 my $d = $ctx->{-inbox}->description . "\n";
663 [ 200, [ 'Content-Length', bytes::length($d),
664 'Content-Type', 'text/plain' ], [ $d ] ];