view: implement optional address obfuscation

[public-inbox.git] / lib / PublicInbox / Hval.pm

diff --git a/lib/PublicInbox/Hval.pm b/lib/PublicInbox/Hval.pm
index 1a83cf10a54561f698f45a6671d6ed1f99734548..2379b918514d398763fd3cf17a1151e60e1b5ed1 100644 (file)
--- a/lib/PublicInbox/Hval.pm
+++ b/lib/PublicInbox/Hval.pm
@@ -1,32 +1,37 @@
-# 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)
 #
-# represents a header value in various forms
+# represents a header value in various forms.  Used for HTML generation
+# in our web interface(s)
 package PublicInbox::Hval;
 use strict;
 use warnings;
-use fields qw(raw);
 use Encode qw(find_encoding);
-use URI::Escape qw(uri_escape);
+use PublicInbox::MID qw/mid_clean mid_escape/;
+use base qw/Exporter/;
+our @EXPORT_OK = qw/ascii_html obfuscate_addrs/;
+
+# for user-generated content (UGC) which may have excessively long lines
+# and screw up rendering on some browsers.  This is the only CSS style
+# feature we use.
+use constant STYLE => '<style>pre{white-space:pre-wrap}</style>';
 
 my $enc_ascii = find_encoding('us-ascii');
 
 sub new {
-       my ($class, $raw) = @_;
-       my $self = fields::new($class);
+       my ($class, $raw, $href) = @_;
 
-       # we never care about leading/trailing whitespace
-       $raw =~ s/\A\s*//;
+       # we never care about trailing whitespace
        $raw =~ s/\s*\z//;
-       $self->{raw} = $raw;
-       $self;
+       bless {
+               raw => $raw,
+               href => defined $href ? $href : $raw,
+       }, $class;
 }
 
 sub new_msgid {
-       my ($class, $raw) = @_;
-       $raw =~ s/\A<//;
-       $raw =~ s/>\z//;
-       $class->new($raw);
+       my ($class, $msgid) = @_;
+       $class->new($msgid, mid_escape($msgid));
 }
 
 sub new_oneline {
@@ -45,14 +50,28 @@ my %xhtml_map = (
        '>' => '&gt;',
 );
 
+$xhtml_map{chr($_)} = sprintf('\\x%02x', $_) for (0..31);
+# some of these overrides are standard C escapes so they're
+# easy-to-understand when rendered.
+$xhtml_map{"\x00"} = '\\0'; # NUL
+$xhtml_map{"\x07"} = '\\a'; # bell
+$xhtml_map{"\x08"} = '\\b'; # backspace
+$xhtml_map{"\x09"} = "\t"; # obvious to show as-is
+$xhtml_map{"\x0a"} = "\n"; # obvious to show as-is
+$xhtml_map{"\x0b"} = '\\v'; # vertical tab
+$xhtml_map{"\x0c"} = '\\f'; # form feed
+$xhtml_map{"\x0d"} = '\\r'; # carriage ret (not preceding \n)
+$xhtml_map{"\x1b"} = '^['; # ASCII escape (mutt seems to escape this way)
+$xhtml_map{"\x7f"} = '\\x7f'; # DEL
+
 sub ascii_html {
        my ($s) = @_;
-       $s =~ s/([<>&'"])/$xhtml_map{$1}/ge;
+       $s =~ s/\r\n/\n/sg; # fixup bad line endings
+       $s =~ s/([<>&'"\x7f\x00-\x1f])/$xhtml_map{$1}/sge;
        $enc_ascii->encode($s, Encode::HTMLCREF);
 }
 
 sub as_html { ascii_html($_[0]->{raw}) }
-sub as_href { ascii_html(uri_escape($_[0]->{raw})) }
 
 sub raw {
        if (defined $_[1]) {
@@ -62,4 +81,16 @@ sub raw {
        }
 }
 
+sub prurl {
+       my ($env, $u) = @_;
+       index($u, '//') == 0 ? "$env->{'psgi.url_scheme'}:$u" : $u;
+}
+
+# for misguided people who believe in this stuff, give them a
+# substitution for '.'
+# &#8228; &#183; and &#890; were also candidates:
+#   https://public-inbox.org/meta/20170615015250.GA6484@starla/
+# However, &#8226; was chosen to make copy+paste errors more obvious
+sub obfuscate_addrs ($) { $_[0] =~ s/(\S+@[^\.]+)\./$1&#8226;/g }
+
 1;