]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/View.pm
extract redundant Message-ID handling code
[public-inbox.git] / lib / PublicInbox / View.pm
index 5b24706c1ecd1d7003f5d13c5601688387cd2128..c2dbb7ed42fd9d1048fd3491e6c2fbf705e4447f 100644 (file)
 package PublicInbox::View;
 use strict;
 use warnings;
-use URI::Escape qw/uri_escape/;
-use CGI qw/escapeHTML/;
+use URI::Escape qw/uri_escape_utf8/;
 use Encode qw/find_encoding/;
 use Encode::MIME::Header;
 use Email::MIME::ContentType qw/parse_content_type/;
-use constant MAX_INLINE_QUOTED => 5;
+use PublicInbox::Hval;
+use PublicInbox::MID qw/mid_clean mid_compressed/;
+require POSIX;
+
+# TODO: make these constants tunable
+use constant MAX_INLINE_QUOTED => 12; # half an 80x24 terminal
 use constant MAX_TRUNC_LEN => 72;
+use constant PRE_WRAP => "<pre\nstyle=\"white-space:pre-wrap\">";
 
-my $enc_utf8 = find_encoding('utf8');
-my $enc_ascii = find_encoding('us-ascii');
-my $enc_mime = find_encoding('MIME-Header');
+*ascii_html = *PublicInbox::Hval::ascii_html;
 
-# public functions:
-sub as_html {
-       my ($class, $mime, $full_pfx) = @_;
+my $enc_utf8 = find_encoding('UTF-8');
 
-       headers_to_html_header($mime) .
+# public functions:
+sub msg_html {
+       my ($class, $mime, $full_pfx, $footer) = @_;
+       if (defined $footer) {
+               $footer = "\n" . $footer;
+       } else {
+               $footer = '';
+       }
+       headers_to_html_header($mime, $full_pfx) .
                multipart_text_as_html($mime, $full_pfx) .
+               '</pre><hr />' . PRE_WRAP .
+               html_footer($mime, 1) . $footer .
                '</pre></body></html>';
 }
 
-sub as_feed_entry {
+sub feed_entry {
        my ($class, $mime, $full_pfx) = @_;
 
-       "<pre>" . multipart_text_as_html($mime, $full_pfx) . "</pre>";
+       PRE_WRAP . multipart_text_as_html($mime, $full_pfx) . '</pre>';
 }
 
+# this is already inside a <pre>
+sub index_entry {
+       my ($class, $mime, $level, $state) = @_;
+       my ($now, $seen, $first) = @$state;
+       my $midx = $state->[3]++;
+       my ($prev, $next) = ($midx - 1, $midx + 1);
+       my $rv = '';
+       my $part_nr = 0;
+       my $enc_msg = enc_for($mime->header("Content-Type"));
+       my $subj = $mime->header('Subject');
+       my $header_obj = $mime->header_obj;
+
+       my $mid_raw = $header_obj->header_raw('Message-ID');
+       my $id = anchor_for($mid_raw);
+       $seen->{$id} = "#$id"; # save the anchor for later
+
+       my $mid = PublicInbox::Hval->new_msgid($mid_raw);
+       my $from = PublicInbox::Hval->new_oneline($mime->header('From'))->raw;
+       my @from = Email::Address->parse($from);
+       $from = $from[0]->name;
+       (defined($from) && length($from)) or $from = $from[0]->address;
+
+       $from = PublicInbox::Hval->new_oneline($from)->as_html;
+       $subj = PublicInbox::Hval->new_oneline($subj)->as_html;
+       my $pfx = ('  ' x $level);
+
+       my $ts = $mime->header('X-PI-Date');
+       my $fmt = '%Y-%m-%d %H:%M UTC';
+       $ts = POSIX::strftime($fmt, gmtime($ts));
+
+       $rv .= "$pfx<b\nid=\"$id\">$subj</b>\n$pfx";
+       $rv .= "- by $from @ $ts - ";
+       $rv .= "<a\nid=\"s$midx\"\nhref=\"#s$next\">next</a>";
+       if ($prev >= 0) {
+               $rv .= "/<a\nhref=\"#s$prev\">prev</a>";
+       }
+       $rv .= "\n\n";
+
+       my $irp = $header_obj->header_raw('In-Reply-To');
+       my ($anchor_idx, $anchor);
+       if (defined $irp) {
+               $anchor_idx = anchor_for($irp);
+               $anchor = $seen->{$anchor_idx};
+       }
+       my $href = $mid->as_href;
+       my $mhref = "m/$href.html";
+       my $fhref = "f/$href.html";
+       my $more = 'message';
+       # scan through all parts, looking for displayable text
+       $mime->walk_parts(sub {
+               my ($part) = @_;
+               return if $part->subparts; # walk_parts already recurses
+               my $ct = $part->content_type;
+
+               # account for filter bugs...
+               return if defined $ct && $ct =~ m!\btext/[xh]+tml\b!i;
+
+               my $enc = enc_for($ct, $enc_msg);
+
+               if ($part_nr > 0) {
+                       my $fn = $part->filename;
+                       defined($fn) or $fn = "part #" . ($part_nr + 1);
+                       $rv .= $pfx . add_filename_line($enc->decode($fn));
+               }
+
+               my $s = add_text_body_short($enc, $part, $part_nr, $fhref);
+
+               # drop the remainder of git patches, they're usually better
+               # to review when the full message is viewed
+               $s =~ s!^---+\n.*\z!!ms and $more = 'more...';
+
+               # Drop signatures
+               $s =~ s/^-- \n.*\z//ms and $more = 'more...';
+
+               # kill any leading or trailing whitespace
+               $s =~ s/\A\s+//s;
+               $s =~ s/\s+\z//s;
+
+               if (length $s) {
+                       # add prefix:
+                       $s =~ s/^/$pfx/sgm;
+
+                       $rv .= $s . "\n";
+               }
+               ++$part_nr;
+       });
+
+       $rv .= "\n$pfx<a\nhref=\"$mhref\">$more</a> ";
+       my $txt = "m/$href.txt";
+       $rv .= "<a\nhref=\"$txt\">raw</a> ";
+       $rv .= html_footer($mime, 0);
+
+       if (defined $irp) {
+               unless (defined $anchor) {
+                       my $v = PublicInbox::Hval->new_msgid($irp);
+                       my $html = $v->as_html;
+                       $anchor = 'm/' . $v->as_href . '.html';
+                       $seen->{$anchor_idx} = $anchor;
+               }
+               $rv .= " <a\nhref=\"$anchor\">parent</a>";
+       }
+       $rv .= " <a\nhref=\"?r=$first#$id\">threadlink</a>";
+
+       $rv . "\n\n";
+}
 
 # only private functions below.
 
 sub enc_for {
-       my ($ct) = @_;
-       defined $ct or return $enc_utf8;
+       my ($ct, $default) = @_;
+       $default ||= $enc_utf8;
+       defined $ct or return $default;
        my $ct_parsed = parse_content_type($ct);
        if ($ct_parsed) {
                if (my $charset = $ct_parsed->{attributes}->{charset}) {
@@ -43,7 +160,7 @@ sub enc_for {
                        return $enc if $enc;
                }
        }
-       $enc_utf8;
+       $default;
 }
 
 sub multipart_text_as_html {
@@ -56,7 +173,12 @@ sub multipart_text_as_html {
        $mime->walk_parts(sub {
                my ($part) = @_;
                return if $part->subparts; # walk_parts already recurses
-               my $enc = enc_for($part->content_type) || $enc_msg || $enc_utf8;
+               my $ct = $part->content_type;
+
+               # account for filter bugs...
+               return if defined $ct && $ct =~ m!\btext/[xh]+tml\b!i;
+
+               my $enc = enc_for($ct, $enc_msg);
 
                if ($part_nr > 0) {
                        my $fn = $part->filename;
@@ -86,10 +208,19 @@ sub add_filename_line {
        "$pad " . ascii_html($fn) . " $pad\n";
 }
 
+my $LINK_RE = qr!\b((?:ftp|https?|nntp)://[@\w\+\&\?\.\%\;/#=-]+)!;
+
+sub linkify {
+       # no newlines added here since it'd break the splitting we do
+       # to fold quotes
+       $_[0] =~ s!$LINK_RE!<a href="$1">$1</a>!g;
+}
+
 sub add_text_body_short {
        my ($enc, $part, $part_nr, $full_pfx) = @_;
        my $n = 0;
        my $s = ascii_html($enc->decode($part->body));
+       linkify($s);
        $s =~ s!^((?:(?:&gt;[^\n]*)\n)+)!
                my $cur = $1;
                my @lines = split(/\n/, $cur);
@@ -110,7 +241,7 @@ sub add_text_body_short {
                                }
                        } while (@sum && length($cur) < MAX_TRUNC_LEN);
                        $cur =~ s/ \z/ .../;
-                       "&gt; &lt;<a href=\"${full_pfx}#q${part_nr}_" . $n++ .
+                       "&gt; &lt;<a\nhref=\"${full_pfx}#q${part_nr}_" . $n++ .
                                "\">$cur<\/a>&gt;\n";
                } else {
                        $cur;
@@ -123,11 +254,12 @@ sub add_text_body_full {
        my ($enc, $part, $part_nr) = @_;
        my $n = 0;
        my $s = ascii_html($enc->decode($part->body));
+       linkify($s);
        $s =~ s!^((?:(?:&gt;[^\n]*)\n)+)!
                my $cur = $1;
                my @lines = split(/\n/, $cur);
                if (@lines > MAX_INLINE_QUOTED) {
-                       "<a name=q${part_nr}_" . $n++ . ">$cur</a>";
+                       "<a\nid=q${part_nr}_" . $n++ . ">$cur</a>";
                } else {
                        $cur;
                }
@@ -135,64 +267,109 @@ sub add_text_body_full {
        $s;
 }
 
-sub trim_message_id {
-       my ($mid) = @_;
-       $mid =~ s/\A\s*<//;
-       $mid =~ s/>\s*\z//;
-       my $html = ascii_html($mid);
-       my $href = ascii_html(uri_escape($mid));
-
-       ($html, $href);
-}
-
-sub ascii_html {
-       $enc_ascii->encode(escapeHTML($_[0]), Encode::HTMLCREF);
-}
-
 sub headers_to_html_header {
-       my ($simple) = @_;
+       my ($mime, $full_pfx) = @_;
 
        my $rv = "";
        my @title;
        foreach my $h (qw(From To Cc Subject Date)) {
-               my $v = $simple->header($h);
-               defined $v or next;
-               $v =~ tr/\n/ /s;
-               $v =~ tr/\r//d;
-               my $raw = $enc_mime->decode($v);
-               $v = ascii_html($raw);
-               $rv .= "$h: $v\n";
+               my $v = $mime->header($h);
+               defined($v) && length($v) or next;
+               $v = PublicInbox::Hval->new_oneline($v);
+               $rv .= "$h: " . $v->as_html . "\n";
 
                if ($h eq 'From') {
-                       my @from = Email::Address->parse($raw);
-                       $raw = $from[0]->name;
-                       unless (defined($raw) && length($raw)) {
-                               $raw = '<' . $from[0]->address . '>';
+                       my @from = Email::Address->parse($v->raw);
+                       $v = $from[0]->name;
+                       unless (defined($v) && length($v)) {
+                               $v = '<' . $from[0]->address . '>';
                        }
-                       $title[1] = ascii_html($raw);
-
+                       $title[1] = ascii_html($v);
                } elsif ($h eq 'Subject') {
-                       $title[0] = $v;
+                       $title[0] = $v->as_html;
                }
        }
 
-       my $mid = $simple->header('Message-ID');
+       my $header_obj = $mime->header_obj;
+       my $mid = $header_obj->header_raw('Message-ID');
        if (defined $mid) {
-               my ($html, $href) = trim_message_id($mid);
-               $rv .= "Message-ID: &lt;$html&gt; ";
-               $rv .= "(<a href=\"$href.txt\">original</a>)\n";
+               $mid = PublicInbox::Hval->new_msgid($mid);
+               $rv .= 'Message-ID: &lt;' . $mid->as_html . '&gt; ';
+               my $href = $mid->as_href;
+               $href = "../m/$href" unless $full_pfx;
+               $rv .= "(<a\nhref=\"$href.txt\">raw</a>)\n";
        }
 
-       my $irp = $simple->header('In-Reply-To');
+       my $irp = $header_obj->header_raw('In-Reply-To');
        if (defined $irp) {
-               my ($html, $href) = trim_message_id($irp);
+               my $v = PublicInbox::Hval->new_msgid($irp);
+               my $html = $v->as_html;
+               my $href = $v->as_href;
                $rv .= "In-Reply-To: &lt;";
-               $rv .= "<a href=\"$href.html\">$html</a>&gt;\n";
+               $rv .= "<a\nhref=\"$href.html\">$html</a>&gt;\n";
        }
+
+       my $refs = $header_obj->header_raw('References');
+       if ($refs) {
+               $refs =~ s/\s*\Q$irp\E\s*// if (defined $irp);
+               my @refs = ($refs =~ /<([^>]+)>/g);
+               if (@refs) {
+                       $rv .= 'References: '. linkify_refs(@refs) . "\n";
+               }
+       }
+
        $rv .= "\n";
 
        ("<html><head><title>".  join(' - ', @title) .
-        '</title></head><body><pre style="white-space:pre-wrap">' .  $rv);
+        '</title></head><body>' . PRE_WRAP . $rv);
+}
+
+sub html_footer {
+       my ($mime, $standalone) = @_;
+       my %cc; # everyone else
+       my $to; # this is the From address
+
+       foreach my $h (qw(From To Cc)) {
+               my $v = $mime->header($h);
+               defined($v) && length($v) or next;
+               my @addrs = Email::Address->parse($v);
+               foreach my $recip (@addrs) {
+                       my $address = $recip->address;
+                       my $dst = lc($address);
+                       $cc{$dst} ||= $address;
+                       $to ||= $dst;
+               }
+       }
+       Email::Address->purge_cache if $standalone;
+
+       my $subj = $mime->header('Subject') || '';
+       $subj = "Re: $subj" unless $subj =~ /\bRe:/;
+       my $irp = uri_escape_utf8(
+                       $mime->header_obj->header_raw('Message-ID') || '');
+       delete $cc{$to};
+       $to = uri_escape_utf8($to);
+       $subj = uri_escape_utf8($subj);
+
+       my $cc = uri_escape_utf8(join(',', sort values %cc));
+       my $href = "mailto:$to?In-Reply-To=$irp&Cc=${cc}&Subject=$subj";
+
+       my $idx = $standalone ? " <a\nhref=\"../\">index</a>" : '';
+
+       "<a\nhref=\"" . ascii_html($href) . '">reply</a>' . $idx;
+}
+
+sub linkify_refs {
+       join(' ', map {
+               my $v = PublicInbox::Hval->new_msgid($_);
+               my $html = $v->as_html;
+               my $href = $v->as_href;
+               "&lt;<a\nhref=\"$href.html\">$html</a>&gt;";
+       } @_);
+}
+
+sub anchor_for {
+       my ($msgid) = @_;
+       'm' . mid_compressed(mid_clean($msgid));
 }
 
 1;