lib/PublicInbox/View.pm

   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)
   3 package PublicInbox::View;
   4 use strict;
   5 use warnings;
   6 use PublicInbox::Hval;
   7 use URI::Escape qw/uri_escape_utf8/;
   8 use Encode qw/find_encoding/;
   9 use Encode::MIME::Header;
  10 use Email::MIME::ContentType qw/parse_content_type/;
  11 require POSIX;
  12
  13 # TODO: make these constants tunable
  14 use constant MAX_INLINE_QUOTED => 12; # half an 80x24 terminal
  15 use constant MAX_TRUNC_LEN => 72;
  16 use constant PRE_WRAP => "<pre\nstyle=\"white-space:pre-wrap\">";
  17
  18 *ascii_html = *PublicInbox::Hval::ascii_html;
  19
  20 my $enc_utf8 = find_encoding('UTF-8');
  21 my $enc_mime = find_encoding('MIME-Header');
  22
  23 # public functions:
  24 sub msg_html {
  25         my ($class, $mime, $full_pfx, $footer) = @_;
  26         if (defined $footer) {
  27                 $footer = "\n" . $footer;
  28         } else {
  29                 $footer = '';
  30         }
  31         headers_to_html_header($mime, $full_pfx) .
  32                 multipart_text_as_html($mime, $full_pfx) .
  33                 '</pre><hr />' . PRE_WRAP .
  34                 html_footer($mime, 1) . $footer .
  35                 '</pre></body></html>';
  36 }
  37
  38 sub feed_entry {
  39         my ($class, $mime, $full_pfx) = @_;
  40
  41         PRE_WRAP . multipart_text_as_html($mime, $full_pfx) . '</pre>';
  42 }
  43
  44 # this is already inside a <pre>
  45 sub index_entry {
  46         my ($class, $mime, $level, $state) = @_;
  47         my ($now, $seen, $first) = @$state;
  48         my $midx = $state->[3]++;
  49         my ($prev, $next) = ($midx - 1, $midx + 1);
  50         my $rv = '';
  51         my $part_nr = 0;
  52         my $enc_msg = enc_for($mime->header("Content-Type"));
  53         my $subj = $mime->header('Subject');
  54         my $header_obj = $mime->header_obj;
  55
  56         my $mid_raw = $header_obj->header_raw('Message-ID');
  57         my $name = anchor_for($mid_raw);
  58         $seen->{$name} = "#$name"; # save the anchor for later
  59
  60         my $mid = PublicInbox::Hval->new_msgid($mid_raw);
  61         my $from = PublicInbox::Hval->new_oneline($mime->header('From'))->raw;
  62         my @from = Email::Address->parse($from);
  63         $from = $from[0]->name;
  64         (defined($from) && length($from)) or $from = $from[0]->address;
  65
  66         $from = PublicInbox::Hval->new_oneline($from)->as_html;
  67         $subj = PublicInbox::Hval->new_oneline($subj)->as_html;
  68         my $pfx = ('  ' x $level);
  69
  70         my $ts = $mime->header('X-PI-Date');
  71         my $fmt = '%H:%M UTC';
  72         if ($now > ($ts + (365 * 24 * 60 * 60))) {
  73                 # doesn't have to be exactly 1 year
  74                 $fmt = '%Y/%m/%d';
  75         } elsif ($now > ($ts + (24 * 60 * 60))) {
  76                 $fmt = '%m/%d';
  77         }
  78         $ts = POSIX::strftime($fmt, gmtime($ts));
  79
  80         $rv .= "$pfx<a\nname=\"$name\"></a>" .
  81                 "<a\nname=\"s$midx\"></a>" .
  82                 "<b>$subj</b>\n$pfx";
  83
  84         $rv .= "- by $from @ $ts - ";
  85
  86         $rv .= "<a\nhref=\"#s$next\">next</a>";
  87         if ($prev >= 0) {
  88                 $rv .= "/<a\nhref=\"#s$prev\">prev</a>";
  89         }
  90         $rv .= "\n\n";
  91
  92         my $irp = $header_obj->header_raw('In-Reply-To');
  93         my ($anchor_idx, $anchor);
  94         if (defined $irp) {
  95                 $anchor_idx = anchor_for($irp);
  96                 $anchor = $seen->{$anchor_idx};
  97         }
  98         my $href = $mid->as_href;
  99         my $mhref = "m/$href.html";
 100         my $fhref = "f/$href.html";
 101         my $more = 'message';
 102         # scan through all parts, looking for displayable text
 103         $mime->walk_parts(sub {
 104                 my ($part) = @_;
 105                 return if $part->subparts; # walk_parts already recurses
 106                 my $enc = enc_for($part->content_type) || $enc_msg || $enc_utf8;
 107
 108                 if ($part_nr > 0) {
 109                         my $fn = $part->filename;
 110                         defined($fn) or $fn = "part #" . ($part_nr + 1);
 111                         $rv .= $pfx . add_filename_line($enc->decode($fn));
 112                 }
 113
 114                 my $s = add_text_body_short($enc, $part, $part_nr, $fhref);
 115
 116                 # drop the remainder of git patches, they're usually better
 117                 # to review when the full message is viewed
 118                 $s =~ s!^---+\n.*\z!!ms and $more = 'more...';
 119
 120                 # Drop signatures
 121                 $s =~ s/^-- \n.*\z//ms and $more = 'more...';
 122
 123                 # kill any leading or trailing whitespace
 124                 $s =~ s/\A\s+//s;
 125                 $s =~ s/\s+\z//s;
 126
 127                 if (length $s) {
 128                         # add prefix:
 129                         $s =~ s/^/$pfx/sgm;
 130
 131                         $rv .= $s . "\n";
 132                 }
 133                 ++$part_nr;
 134         });
 135
 136         $rv .= "\n$pfx<a\nhref=\"$mhref\">$more</a> ";
 137         my $txt = "m/$href.txt";
 138         $rv .= "<a\nhref=\"$txt\">raw</a> ";
 139         $rv .= html_footer($mime, 0);
 140
 141         if (defined $irp) {
 142                 unless (defined $anchor) {
 143                         my $v = PublicInbox::Hval->new_msgid($irp);
 144                         my $html = $v->as_html;
 145                         $anchor = 'm/' . $v->as_href . '.html';
 146                         $seen->{$anchor_idx} = $anchor;
 147                 }
 148                 $rv .= " <a\nhref=\"$anchor\">parent</a>";
 149         }
 150         $rv .= " <a\nhref=\"?r=$first#$name\">permalink</a>";
 151
 152         $rv . "\n\n";
 153 }
 154
 155 # only private functions below.
 156
 157 sub enc_for {
 158         my ($ct) = @_;
 159         defined $ct or return $enc_utf8;
 160         my $ct_parsed = parse_content_type($ct);
 161         if ($ct_parsed) {
 162                 if (my $charset = $ct_parsed->{attributes}->{charset}) {
 163                         my $enc = find_encoding($charset);
 164                         return $enc if $enc;
 165                 }
 166         }
 167         $enc_utf8;
 168 }
 169
 170 sub multipart_text_as_html {
 171         my ($mime, $full_pfx) = @_;
 172         my $rv = "";
 173         my $part_nr = 0;
 174         my $enc_msg = enc_for($mime->header("Content-Type"));
 175
 176         # scan through all parts, looking for displayable text
 177         $mime->walk_parts(sub {
 178                 my ($part) = @_;
 179                 return if $part->subparts; # walk_parts already recurses
 180                 my $enc = enc_for($part->content_type) || $enc_msg || $enc_utf8;
 181
 182                 if ($part_nr > 0) {
 183                         my $fn = $part->filename;
 184                         defined($fn) or $fn = "part #" . ($part_nr + 1);
 185                         $rv .= add_filename_line($enc->decode($fn));
 186                 }
 187
 188                 if (defined $full_pfx) {
 189                         $rv .= add_text_body_short($enc, $part, $part_nr,
 190                                                 $full_pfx);
 191                 } else {
 192                         $rv .= add_text_body_full($enc, $part, $part_nr);
 193                 }
 194                 $rv .= "\n" unless $rv =~ /\n\z/s;
 195                 ++$part_nr;
 196         });
 197         $rv;
 198 }
 199
 200 sub add_filename_line {
 201         my ($fn) = @_;
 202         my $len = 72;
 203         my $pad = "-";
 204
 205         $len -= length($fn);
 206         $pad x= ($len/2) if ($len > 0);
 207         "$pad " . ascii_html($fn) . " $pad\n";
 208 }
 209
 210 sub add_text_body_short {
 211         my ($enc, $part, $part_nr, $full_pfx) = @_;
 212         my $n = 0;
 213         my $s = ascii_html($enc->decode($part->body));
 214         $s =~ s!^((?:(?:&gt;[^\n]*)\n)+)!
 215                 my $cur = $1;
 216                 my @lines = split(/\n/, $cur);
 217                 if (@lines > MAX_INLINE_QUOTED) {
 218                         # show a short snippet of quoted text
 219                         $cur = join(' ', @lines);
 220                         $cur =~ s/^&gt;\s*//;
 221
 222                         my @sum = split(/\s+/, $cur);
 223                         $cur = '';
 224                         do {
 225                                 my $tmp = shift(@sum);
 226                                 my $len = length($tmp) + length($cur);
 227                                 if ($len > MAX_TRUNC_LEN) {
 228                                         @sum = ();
 229                                 } else {
 230                                         $cur .= $tmp . ' ';
 231                                 }
 232                         } while (@sum && length($cur) < MAX_TRUNC_LEN);
 233                         $cur =~ s/ \z/ .../;
 234                         "&gt; &lt;<a\nhref=\"${full_pfx}#q${part_nr}_" . $n++ .
 235                                 "\">$cur<\/a>&gt;\n";
 236                 } else {
 237                         $cur;
 238                 }
 239         !emg;
 240         $s;
 241 }
 242
 243 sub add_text_body_full {
 244         my ($enc, $part, $part_nr) = @_;
 245         my $n = 0;
 246         my $s = ascii_html($enc->decode($part->body));
 247         $s =~ s!^((?:(?:&gt;[^\n]*)\n)+)!
 248                 my $cur = $1;
 249                 my @lines = split(/\n/, $cur);
 250                 if (@lines > MAX_INLINE_QUOTED) {
 251                         "<a\nname=q${part_nr}_" . $n++ . ">$cur</a>";
 252                 } else {
 253                         $cur;
 254                 }
 255         !emg;
 256         $s;
 257 }
 258
 259 sub headers_to_html_header {
 260         my ($mime, $full_pfx) = @_;
 261
 262         my $rv = "";
 263         my @title;
 264         foreach my $h (qw(From To Cc Subject Date)) {
 265                 my $v = $mime->header($h);
 266                 defined($v) && length($v) or next;
 267                 $v = PublicInbox::Hval->new_oneline($v);
 268                 $rv .= "$h: " . $v->as_html . "\n";
 269
 270                 if ($h eq 'From') {
 271                         my @from = Email::Address->parse($v->raw);
 272                         $v = $from[0]->name;
 273                         unless (defined($v) && length($v)) {
 274                                 $v = '<' . $from[0]->address . '>';
 275                         }
 276                         $title[1] = ascii_html($v);
 277                 } elsif ($h eq 'Subject') {
 278                         $title[0] = $v->as_html;
 279                 }
 280         }
 281
 282         my $header_obj = $mime->header_obj;
 283         my $mid = $header_obj->header_raw('Message-ID');
 284         if (defined $mid) {
 285                 $mid = PublicInbox::Hval->new_msgid($mid);
 286                 $rv .= 'Message-ID: &lt;' . $mid->as_html . '&gt; ';
 287                 my $href = $mid->as_href;
 288                 $href = "../m/$href" unless $full_pfx;
 289                 $rv .= "(<a\nhref=\"$href.txt\">original</a>)\n";
 290         }
 291
 292         my $irp = $header_obj->header_raw('In-Reply-To');
 293         if (defined $irp) {
 294                 my $v = PublicInbox::Hval->new_msgid($irp);
 295                 my $html = $v->as_html;
 296                 my $href = $v->as_href;
 297                 $rv .= "In-Reply-To: &lt;";
 298                 $rv .= "<a\nhref=\"$href.html\">$html</a>&gt;\n";
 299         }
 300
 301         my $refs = $header_obj->header_raw('References');
 302         if ($refs) {
 303                 $refs =~ s/\s*\Q$irp\E\s*// if (defined $irp);
 304                 my @refs = ($refs =~ /<([^>]+)>/g);
 305                 if (@refs) {
 306                         $rv .= 'References: '. linkify_refs(@refs) . "\n";
 307                 }
 308         }
 309
 310         $rv .= "\n";
 311
 312         ("<html><head><title>".  join(' - ', @title) .
 313          '</title></head><body>' . PRE_WRAP . $rv);
 314 }
 315
 316 sub html_footer {
 317         my ($mime, $standalone) = @_;
 318         my %cc; # everyone else
 319         my $to; # this is the From address
 320
 321         foreach my $h (qw(From To Cc)) {
 322                 my $v = $mime->header($h);
 323                 defined($v) && length($v) or next;
 324                 my @addrs = Email::Address->parse($v);
 325                 foreach my $recip (@addrs) {
 326                         my $address = $recip->address;
 327                         my $dst = lc($address);
 328                         $cc{$dst} ||= $address;
 329                         $to ||= $dst;
 330                 }
 331         }
 332         Email::Address->purge_cache if $standalone;
 333
 334         my $subj = $mime->header('Subject') || '';
 335         $subj = "Re: $subj" unless $subj =~ /\bRe:/;
 336         my $irp = uri_escape_utf8(
 337                         $mime->header_obj->header_raw('Message-ID') || '');
 338         delete $cc{$to};
 339         $to = uri_escape_utf8($to);
 340         $subj = uri_escape_utf8($subj);
 341
 342         my $cc = uri_escape_utf8(join(',', values %cc));
 343         my $href = "mailto:$to?In-Reply-To=$irp&Cc=${cc}&Subject=$subj";
 344
 345         my $idx = $standalone ? " <a\nhref=\"../\">index</a>" : '';
 346
 347         "<a\nhref=\"" . ascii_html($href) . '">reply</a>' . $idx;
 348 }
 349
 350 sub linkify_refs {
 351         join(' ', map {
 352                 my $v = PublicInbox::Hval->new_msgid($_);
 353                 my $html = $v->as_html;
 354                 my $href = $v->as_href;
 355                 "&lt;<a\nhref=\"$href.html\">$html</a>&gt;";
 356         } @_);
 357 }
 358
 359 require Digest::SHA;
 360 sub anchor_for {
 361         my ($msgid) = @_;
 362         $msgid =~ s/\A\s*<?//;
 363         $msgid =~ s/>?\s*\z//;
 364         Digest::SHA::sha1_hex($msgid);
 365 }
 366
 367 1;