]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WWW.pm
cleanup: use '$ibx' consistently when referring to Inbox refs
[public-inbox.git] / lib / PublicInbox / WWW.pm
index c73370f9a233d82d7c89fc10e7937e87154465e6..6e69001c4c4d78fa2e52fc851525c30bfd8f7a59 100644 (file)
@@ -6,6 +6,7 @@
 # We focus on the lowest common denominators here:
 # - targeted at text-only console browsers (w3m, links, etc..)
 # - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
+#   and diff/syntax-highlighting (optional)
 # - No JavaScript, graphics or icons allowed.
 # - Must not rely on static content
 # - UTF-8 is only for user-content, 7-bit US-ASCII for us
@@ -13,12 +14,15 @@ package PublicInbox::WWW;
 use 5.008;
 use strict;
 use warnings;
+use bytes (); # only for bytes::length
+use Plack::Util;
 use PublicInbox::Config;
 use PublicInbox::Hval;
 use URI::Escape qw(uri_unescape);
 use PublicInbox::MID qw(mid_escape);
 require PublicInbox::Git;
 use PublicInbox::GitHTTPBackend;
+use PublicInbox::UserContent;
 
 # TODO: consider a routing tree now that we have more endpoints:
 our $INBOX_RE = qr!\A/([\w\-][\w\.\-]*)!;
@@ -118,10 +122,14 @@ sub call {
                r301($ctx, $1, $2);
        } elsif ($path_info =~ m!$INBOX_RE/_/text(?:/(.*))?\z!o) {
                get_text($ctx, $1, $2);
-       } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s\z!o) {
+       } elsif ($path_info =~ m!$INBOX_RE/([\w\-\.]+)\.css\z!o) {
+               get_css($ctx, $1, $2);
+       } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s/\z!o) {
                get_vcs_object($ctx, $1, $2);
-       } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/_([\w\.\-]+)\z!o) {
+       } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s/([\w\.\-]+)\z!o) {
                get_vcs_object($ctx, $1, $2, $3);
+       } elsif ($path_info =~ m!$INBOX_RE/($OID_RE)/s\z!o) {
+               r301($ctx, $1, $2, 's/');
        # convenience redirects order matters
        } elsif ($path_info =~ m!$INBOX_RE/([^/]{2,})\z!o) {
                r301($ctx, $1, $2);
@@ -133,6 +141,7 @@ sub call {
 
 # for CoW-friendliness, MOOOOO!
 sub preload {
+       my ($self) = @_;
        require PublicInbox::Feed;
        require PublicInbox::View;
        require PublicInbox::SearchThread;
@@ -145,6 +154,10 @@ sub preload {
                        PublicInbox::NewsWWW)) {
                eval "require $_;";
        }
+       if (ref($self)) {
+               $self->cgit;
+               $self->stylesheets_prepare($_) for ('', '../', '../../');
+       }
 }
 
 # private functions below
@@ -162,14 +175,20 @@ sub r404 {
 # simple response for errors
 sub r { [ $_[0], ['Content-Type' => 'text/plain'], [ join(' ', @_, "\n") ] ] }
 
+sub news_cgit_fallback ($) {
+       my ($ctx) = @_;
+       my $www = $ctx->{www};
+       my $env = $ctx->{env};
+       my $res = $www->news_www->call($env);
+       $res->[0] == 404 ? $www->cgit->call($env) : $res;
+}
+
 # returns undef if valid, array ref response if invalid
 sub invalid_inbox ($$) {
        my ($ctx, $inbox) = @_;
-       my $www = $ctx->{www};
-       my $obj = $www->{pi_config}->lookup_name($inbox);
-       if (defined $obj) {
-               $ctx->{git} = $obj->git;
-               $ctx->{-inbox} = $obj;
+       my $ibx = $ctx->{www}->{pi_config}->lookup_name($inbox);
+       if (defined $ibx) {
+               $ctx->{-inbox} = $ibx;
                return;
        }
 
@@ -177,7 +196,7 @@ sub invalid_inbox ($$) {
        # generation and link things intended for nntp:// to https?://,
        # so try to infer links and redirect them to the appropriate
        # list URL.
-       $www->news_www->call($ctx->{env});
+       news_cgit_fallback($ctx);
 }
 
 # returns undef if valid, array ref response if invalid
@@ -377,19 +396,19 @@ sub legacy_redirects {
        } elsif ($path_info =~ m!$INBOX_RE/(\S+/\S+)/f\z!o) {
                r301($ctx, $1, $2);
        } else {
-               $ctx->{www}->news_www->call($ctx->{env});
+               news_cgit_fallback($ctx);
        }
 }
 
 sub r301 {
        my ($ctx, $inbox, $mid_ue, $suffix) = @_;
-       my $obj = $ctx->{-inbox};
-       unless ($obj) {
+       my $ibx = $ctx->{-inbox};
+       unless ($ibx) {
                my $r404 = invalid_inbox($ctx, $inbox);
                return $r404 if $r404;
-               $obj = $ctx->{-inbox};
+               $ibx = $ctx->{-inbox};
        }
-       my $url = $obj->base_url($ctx->{env});
+       my $url = $ibx->base_url($ctx->{env});
        my $qs = $ctx->{env}->{QUERY_STRING};
        if (defined $mid_ue) {
                # common, and much nicer as '@' than '%40':
@@ -456,10 +475,156 @@ sub news_www {
        }
 }
 
+sub cgit {
+       my ($self) = @_;
+       $self->{cgit} ||= do {
+               my $pi_config = $self->{pi_config};
+
+               if (defined($pi_config->{'publicinbox.cgitrc'})) {
+                       require PublicInbox::Cgit;
+                       PublicInbox::Cgit->new($pi_config);
+               } else {
+                       Plack::Util::inline_object(call => sub { r404() });
+               }
+       }
+}
+
 sub get_attach {
        my ($ctx, $idx, $fn) = @_;
        require PublicInbox::WwwAttach;
        PublicInbox::WwwAttach::get_attach($ctx, $idx, $fn);
 }
 
+# User-generated content (UGC) may have excessively long lines
+# and screw up rendering on some browsers, so we use pre-wrap.
+#
+# We also force everything to the same scaled font-size because GUI
+# browsers (tested both Firefox and surf (webkit)) uses a larger font
+# for the Search <form> element than the rest of the page.  Font size
+# uniformity is important to people who rely on gigantic fonts.
+# Finally, we use monospace to ensure the Search field and button
+# has the same size and spacing as everything else which is
+# <pre>-formatted anyways.
+our $STYLE = 'pre{white-space:pre-wrap}*{font-size:100%;font-family:monospace}';
+
+sub stylesheets_prepare ($$) {
+       my ($self, $upfx) = @_;
+       my $mini = eval {
+               require CSS::Minifier;
+               sub { CSS::Minifier::minify(input => $_[0]) };
+       } || eval {
+               require CSS::Minifier::XS;
+               sub { CSS::Minifier::XS::minify($_[0]) };
+       } || sub { $_[0] };
+
+       my $css_map = {};
+       my $stylesheets = $self->{pi_config}->{css} || [];
+       my $links = [];
+       my $inline_ok = 1;
+
+       foreach my $s (@$stylesheets) {
+               my $attr = {};
+               local $_ = $s;
+               foreach my $k (qw(media title href)) {
+                       if (s/\s*$k='([^']+)'// || s/\s*$k=(\S+)//) {
+                               $attr->{$k} = $1;
+                       }
+               }
+
+               if (defined $attr->{href}) {
+                       $inline_ok = 0;
+               } else {
+                       my $fn = $_;
+                       open(my $fh, '<', $fn) or do {
+                               warn "failed to open $fn: $!\n";
+                               next;
+                       };
+                       my ($key) = (m!([^/]+?)(?:\.css)?\z!i);
+                       my $ctime = 0;
+                       my $local = do { local $/; <$fh> };
+                       if ($local =~ /\S/) {
+                               $ctime = sprintf('%x',(stat($fh))[10]);
+                               $local = $mini->($local);
+                       }
+
+                       # do not let BOFHs override userContent.css:
+                       if ($local =~ /!\s*important\b/i) {
+                               warn "ignoring $fn since it uses `!important'\n";
+                               next;
+                       }
+
+                       $css_map->{$key} = $local;
+                       $attr->{href} = "$upfx$key.css?$ctime";
+                       if (defined($attr->{title})) {
+                               $inline_ok = 0;
+                       } elsif (($attr->{media}||'screen') eq 'screen') {
+                               $attr->{-inline} = $local;
+                       }
+               }
+               push @$links, $attr;
+       }
+
+       my $buf = "<style>$STYLE";
+       if ($inline_ok) {
+               my @ext; # for media=print and whatnot
+               foreach my $attr (@$links) {
+                       if (defined(my $str = delete $attr->{-inline})) {
+                               $buf .= $str;
+                       } else {
+                               push @ext, $attr;
+                       }
+               }
+               $links = \@ext;
+       }
+       $buf .= '</style>';
+
+       if (@$links) {
+               foreach my $attr (@$links) {
+                       delete $attr->{-inline};
+                       $buf .= "<link\ntype=text/css\nrel=stylesheet";
+                       while (my ($k, $v) = each %$attr) {
+                               $v = qq{"$v"} if $v =~ /[\s=]/;
+                               $buf .= qq{\n$k=$v};
+                       }
+                       $buf .= ' />';
+               }
+               $self->{"-style-$upfx"} = $buf;
+       } else {
+               $self->{-style_inline} = $buf;
+       }
+       $self->{-css_map} = $css_map;
+}
+
+# returns an HTML fragment with <style> or <link> tags in them
+# Called by WwwStream by nearly every HTML page
+sub style {
+       my ($self, $upfx) = @_;
+       $self->{-style_inline} || $self->{"-style-$upfx"} || do {
+               stylesheets_prepare($self, $upfx);
+               $self->{-style_inline} || $self->{"-style-$upfx"}
+       };
+}
+
+# /$INBOX/$KEY.css endpoint
+# CSS is configured globally for all inboxes, but we access them on
+# a per-inbox basis.  This allows administrators to setup per-inbox
+# static routes to intercept the request before it hits PSGI
+sub get_css ($$$) {
+       my ($ctx, $inbox, $key) = @_;
+       my $r404 = invalid_inbox($ctx, $inbox);
+       return $r404 if $r404;
+       my $self = $ctx->{www};
+       my $css_map = $self->{-css_map} || stylesheets_prepare($self, '');
+       my $css = $css_map->{$key};
+       if (!defined($css) && $key eq 'userContent') {
+               my $env = $ctx->{env};
+               $css = PublicInbox::UserContent::sample($ctx->{-inbox}, $env);
+       }
+       defined $css or return r404();
+       my $h = [ 'Content-Length', bytes::length($css),
+               'Content-Type', 'text/css' ];
+       PublicInbox::GitHTTPBackend::cache_one_year($h);
+       [ 200, $h, [ $css ] ];
+}
+
 1;