-# 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)
+#
+# Used for displaying the HTML web interface.
+# See Documentation/design_www.txt for this.
package PublicInbox::View;
use strict;
use warnings;
use URI::Escape qw/uri_escape_utf8/;
use Date::Parse qw/str2time/;
-use Encode qw/find_encoding/;
use Encode::MIME::Header;
-use Email::MIME::ContentType qw/parse_content_type/;
-use PublicInbox::Hval;
-use PublicInbox::MID qw/mid_clean mid_compress mid2path/;
-use Digest::SHA qw/sha1_hex/;
-my $SALT = rand;
+use Plack::Util;
+use PublicInbox::Hval qw/ascii_html/;
+use PublicInbox::Linkify;
+use PublicInbox::MID qw/mid_clean id_compress mid_mime/;
+use PublicInbox::MsgIter;
+use PublicInbox::Address;
+use PublicInbox::WwwStream;
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\">";
-use constant T_ANCHOR => '#u';
use constant INDENT => ' ';
+use constant TCHILD => '` ';
+sub th_pfx ($) { $_[0] == 0 ? '' : TCHILD };
-*ascii_html = *PublicInbox::Hval::ascii_html;
-
-my $enc_utf8 = find_encoding('UTF-8');
-
-# public functions:
+# public functions: (unstable)
sub msg_html {
- my ($ctx, $mime, $full_pfx, $footer) = @_;
- if (defined $footer) {
- $footer = "\n" . $footer;
- } else {
- $footer = '';
- }
- headers_to_html_header($mime, $full_pfx, $ctx) .
- multipart_text_as_html($mime, $full_pfx) .
- '</pre><hr />' . PRE_WRAP .
- html_footer($mime, 1, $full_pfx, $ctx) .
- $footer .
- '</pre></body></html>';
+ my ($ctx, $mime, $footer) = @_;
+ my $hdr = $mime->header_obj;
+ my $tip = _msg_html_prepare($hdr, $ctx);
+ PublicInbox::WwwStream->new($ctx, sub {
+ my ($nr, undef) = @_;
+ if ($nr == 1) {
+ $tip . multipart_text_as_html($mime, '') .
+ '</pre><hr />'
+ } elsif ($nr == 2) {
+ # fake an EOF if generating the footer fails;
+ # we want to at least show the message if something
+ # here crashes:
+ eval {
+ '<pre>' . html_footer($hdr, 1, $ctx) .
+ '</pre>' . msg_reply($ctx, $hdr)
+ };
+ } else {
+ undef
+ }
+ });
}
-sub feed_entry {
- my ($class, $mime, $full_pfx) = @_;
+# /$INBOX/$MESSAGE_ID/#R
+sub msg_reply {
+ my ($ctx, $hdr) = @_;
+ my $se_url = 'https://git-htmldocs.bogomips.org/git-send-email.html';
+
+ my ($arg, $link) = mailto_arg_link($hdr);
+ push @$arg, '/path/to/YOUR_REPLY';
- PRE_WRAP . multipart_text_as_html($mime, $full_pfx) . '</pre>';
+ "<pre\nid=R>".
+ "You may reply publically to <a\nhref=#t>this message</a> via\n".
+ "plain-text email using any one of the following methods:\n\n" .
+ "* Save the following mbox file, import it into your mail client,\n" .
+ " and reply-to-all from there: <a\nhref=raw>mbox</a>\n\n" .
+ "* Reply to all the recipients using the <b>--to</b>, <b>--cc</b>,\n" .
+ " and <b>--in-reply-to</b> switches of git-send-email(1):\n\n" .
+ " git send-email \\\n " .
+ join(" \\\n ", @$arg ). "\n\n" .
+ qq( <a\nhref="$se_url">$se_url</a>\n\n) .
+ "* If your mail client supports setting the <b>In-Reply-To</b>" .
+ " header\n via mailto: links, try the " .
+ qq(<a\nhref="$link">mailto: link</a>\n) .
+ '</pre>';
}
sub in_reply_to {
- my ($header_obj) = @_;
- my $irt = $header_obj->header('In-Reply-To');
+ my ($hdr) = @_;
+ my $irt = $hdr->header_raw('In-Reply-To');
return mid_clean($irt) if (defined $irt);
- my $refs = $header_obj->header('References');
+ my $refs = $hdr->header_raw('References');
if ($refs && $refs =~ /<([^>]+)>\s*\z/s) {
return $1;
}
undef;
}
+sub _hdr_names ($$) {
+ my ($hdr, $field) = @_;
+ my $val = $hdr->header($field) or return '';
+ ascii_html(join(', ', PublicInbox::Address::names($val)));
+}
+
+sub nr_to_s ($$$) {
+ my ($nr, $singular, $plural) = @_;
+ return "0 $plural" if $nr == 0;
+ $nr == 1 ? "$nr $singular" : "$nr $plural";
+}
+
# this is already inside a <pre>
sub index_entry {
- my ($fh, $mime, $level, $state) = @_;
- my $midx = $state->{anchor_idx}++;
+ my ($mime, $state) = @_;
my $ctx = $state->{ctx};
my $srch = $ctx->{srch};
- my ($prev, $next) = ($midx - 1, $midx + 1);
- my $part_nr = 0;
- my $enc = enc_for($mime->header("Content-Type"));
- my $subj = $mime->header('Subject');
- my $header_obj = $mime->header_obj;
-
- my $mid_raw = $header_obj->header('Message-ID');
- my $id = anchor_for($mid_raw);
- my $seen = $state->{seen};
- $seen->{$id} = "#$id"; # save the anchor for children, later
+ my $hdr = $mime->header_obj;
+ my $subj = $hdr->header('Subject');
+ my $mid_raw = mid_clean(mid_mime($mime));
+ my $id = id_compress($mid_raw);
+ my $id_m = 'm'.$id;
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;
-
- $from = PublicInbox::Hval->new_oneline($from)->as_html;
- $subj = PublicInbox::Hval->new_oneline($subj)->as_html;
- my $more = 'permalink';
- my $root_anchor = $state->{root_anchor};
+
+ my $root_anchor = $state->{root_anchor} || '';
my $path = $root_anchor ? '../../' : '';
my $href = $mid->as_href;
- my $irt = in_reply_to($header_obj);
- my $parent_anchor = $seen->{anchor_for($irt)} if defined $irt;
+ my $irt = in_reply_to($hdr);
+
+ $subj = '<b>'.ascii_html($subj).'</b>';
+ $subj = "<u\nid=u>$subj</u>" if $root_anchor eq $id_m;
+
+ my $ts = _msg_date($hdr);
+ my $rv = "<a\nhref=#e$id\nid=$id_m>#</a> ";
+ $rv .= $subj;
+ my $mhref = $path.$href.'/';
+ my $from = _hdr_names($hdr, 'From');
+ $rv .= "\n- $from @ $ts UTC\n";
+ my @tocc;
+ foreach my $f (qw(To Cc)) {
+ my $dst = _hdr_names($hdr, $f);
+ push @tocc, "$f: $dst" if $dst ne '';
+ }
+ $rv .= ' '.join('; +', @tocc) . "\n" if @tocc;
+ $rv .= "\n";
- if ($srch) {
- my $t = $ctx->{flat} ? 'T' : 't';
- $subj = "<a\nhref=\"${path}$href/$t/#u\">$subj</a>";
- }
- if ($root_anchor && $root_anchor eq $id) {
- $subj = "<u\nid=\"u\">$subj</u>";
+ # scan through all parts, looking for displayable text
+ msg_iter($mime, sub { $rv .= add_text_body($mhref, $_[0]) });
+ $rv .= "\n<a\nhref=\"$mhref\"\n>permalink</a>" .
+ " / <a\nhref=\"${mhref}raw\">raw</a> / ";
+ my $mapping = $state->{mapping};
+ my $nr_c = $mapping->{$mid_raw} || 0;
+ my $nr_s = 0;
+ if (defined $irt) {
+ $nr_s = ($mapping->{$irt} || 0) - 1;
+ $nr_s = 0 if $nr_s < 0;
+ $irt = anchor_for($irt);
+ $rv .= "<a\nhref=#$irt>#parent</a>,";
+ } else {
+ $rv .= 'root message:';
}
+ $nr_s = nr_to_s($nr_s, 'sibling', 'siblings');
+ $nr_c = nr_to_s($nr_c, 'reply', 'replies');
+ $rv .= " <a\nhref=#r$id\nid=e$id>$nr_s, $nr_c</a>";
+ $rv .= " / <a\nhref=\"${mhref}#R\">reply</a>";
- my $ts = _msg_date($mime);
- my $rv = "<table\nsummary=l$level><tr>";
- if ($level) {
- $rv .= '<td><pre>' . (INDENT x $level) . '</pre></td>';
+ if (my $pct = $state->{pct}) { # used by SearchView.pm
+ $rv .= " [relevance $pct->{$mid_raw}%]";
}
- $rv .= "<td\nid=s$midx>" . PRE_WRAP;
- $rv .= "<b\nid=\"$id\">$subj</b>\n";
- $rv .= "- by $from @ $ts UTC - ";
- $rv .= "<a\nhref=\"#s$next\">next</a>";
- if ($prev >= 0) {
- $rv .= "/<a\nhref=\"#s$prev\">prev</a>";
- }
- $fh->write($rv .= "\n\n");
-
- my ($fhref, $more_ref);
- my $mhref = "${path}$href/";
+ $rv .= "\n\n";
+}
- # show full messages at level == 0 in threaded view
- if ($level > 0 || ($ctx->{flat} && $root_anchor ne $id)) {
- $fhref = "${path}$href/f/";
- $more_ref = \$more;
+sub walk_thread {
+ my ($th, $state, $cb) = @_;
+ my @q = map { (0, $_) } $th->rootset;
+ while (@q) {
+ my $level = shift @q;
+ my $node = shift @q or next;
+ $cb->($state, $level, $node);
+ unshift @q, $level+1, $node->child, $level, $node->next;
}
- # scan through all parts, looking for displayable text
- $mime->walk_parts(sub {
- index_walk($fh, $_[0], $enc, \$part_nr, $fhref, $more_ref);
- });
- $mime->body_set('');
-
- my $txt = "${path}$href/raw";
- $rv = "\n<a\nhref=\"$mhref\">$more</a> <a\nhref=\"$txt\">raw</a> ";
- $rv .= html_footer($mime, 0, undef, $ctx);
+}
- if (defined $irt) {
- unless (defined $parent_anchor) {
- my $v = PublicInbox::Hval->new_msgid($irt, 1);
- $v = $v->as_href;
- $parent_anchor = "${path}$v/";
- }
- $rv .= " <a\nhref=\"$parent_anchor\">parent</a>";
- }
- if ($srch) {
- if ($ctx->{flat}) {
- $rv .= " [<a\nhref=\"${path}$href/t/#u\">threaded</a>" .
- "|<b>flat</b>]";
- } else {
- $rv .= " [<b>threaded</b>|" .
- "<a\nhref=\"${path}$href/T/#u\">flat</a>]";
- }
+sub pre_thread {
+ my ($state, $level, $node) = @_;
+ my $parent = $node->parent;
+ if ($parent) {
+ my $mid = $parent->messageid;
+ my $m = $state->{mapping};
+ $m->{$mid} ||= 0;
+ $m->{$mid}++;
}
-
- $fh->write($rv .= '</pre></td></tr></table>');
+ skel_dump($state, $level, $node);
}
sub thread_html {
- my ($ctx, $foot, $srch) = @_;
- sub { emit_thread_html($_[0], $ctx, $foot, $srch) }
-}
-
-# only private functions below.
-
-sub emit_thread_html {
- my ($cb, $ctx, $foot, $srch) = @_;
- my $mid = mid_compress($ctx->{mid});
- my $res = $srch->get_thread($mid);
- my $msgs = load_results($res);
- my $nr = scalar @$msgs;
- return missing_thread($cb, $ctx) if $nr == 0;
- my $flat = $ctx->{flat};
- my $orig_cb = $cb;
- my $seen = {};
+ my ($ctx) = @_;
+ my $mid = $ctx->{mid};
+ my $sres = $ctx->{srch}->get_thread($mid, { asc => 1 });
+ my $msgs = load_results($sres);
+ my $nr = $sres->{total};
+ return missing_thread($ctx) if $nr == 0;
+ my $skel = '</pre><hr /><pre>';
+ $skel .= $nr == 1 ? 'only message in thread' : 'end of thread';
+ $skel .= ", back to <a\nhref=\"../../\">index</a>";
+ $skel .= "\n<a\nid=t>$nr+ messages in thread:</a> (download: ";
+ $skel .= "<a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
+ $skel .= " / follow: <a\nhref=\"../t.atom\">Atom feed</a>)\n";
my $state = {
ctx => $ctx,
- seen => $seen,
+ cur_level => 0,
+ dst => \$skel,
+ mapping => {}, # mid -> reply count
+ prev_attr => '',
+ prev_level => 0,
root_anchor => anchor_for($mid),
- anchor_idx => 0,
+ seen => {},
+ srch => $ctx->{srch},
+ upfx => '../../',
};
- require PublicInbox::GitCatFile;
- my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
- if ($flat) {
- pre_anchor_entry($seen, $_) for (@$msgs);
- __thread_entry(\$cb, $git, $state, $_, 0) for (@$msgs);
- } else {
- my $th = thread_results($msgs);
- thread_entry(\$cb, $git, $state, $_, 0) for $th->rootset;
- }
- $git = undef;
- Email::Address->purge_cache;
-
- # there could be a race due to a message being deleted in git
- # but still being in the Xapian index:
- return missing_thread($cb, $ctx) if ($orig_cb eq $cb);
-
- my $final_anchor = $state->{anchor_idx};
- my $next = "<a\nid=\"s$final_anchor\">";
- $next .= $final_anchor == 1 ? 'only message in' : 'end of';
- $next .= " thread</a>, back to <a\nhref=\"../../\">index</a>";
- if ($flat) {
- $next .= " [<a\nhref=\"../t/#u\">threaded</a>|<b>flat</b>]";
- } else {
- $next .= " [<b>threaded</b>|<a\nhref=\"../T/#u\">flat</a>]";
- }
- $next .= "\ndownload thread: <a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
- $next .= " / follow: <a\nhref=\"../t.atom\">Atom feed</a>";
- $cb->write("<hr />" . PRE_WRAP . $next . "\n\n". $foot .
- "</pre></body></html>");
- $cb->close;
-}
-
-sub index_walk {
- my ($fh, $part, $enc, $part_nr, $fhref, $more) = @_;
- my $s = add_text_body($enc, $part, $part_nr, $fhref);
+ walk_thread(thread_results($msgs), $state, *pre_thread);
- if ($more) {
- # 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 lines
- $s =~ s/^\s*$//sgm;
- $s =~ s/\s+\z//s;
-
- if ($s ne '') {
- # kill per-line trailing whitespace
- $s =~ s/[ \t]+$//sgm;
- $s .= "\n" unless $s =~ /\n\z/s;
- }
- $fh->write($s);
-}
-
-sub enc_for {
- 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}) {
- my $enc = find_encoding($charset);
- return $enc if $enc;
+ # lazy load the full message from mini_mime:
+ my $inbox = $ctx->{-inbox};
+ my $mime;
+ while ($mime = shift @$msgs) {
+ $mime = $inbox->msg_by_mid(mid_clean(mid_mime($mime))) and last;
+ }
+ $mime = Email::MIME->new($mime);
+ $ctx->{-upfx} = '../../';
+ $ctx->{-title_html} = ascii_html($mime->header('Subject'));
+ $ctx->{-html_tip} = '<pre>'.index_entry($mime, $state);
+ $mime = undef;
+ my $body = PublicInbox::WwwStream->new($ctx, sub {
+ return unless $msgs;
+ while ($mime = shift @$msgs) {
+ $mid = mid_clean(mid_mime($mime));
+ $mime = $inbox->msg_by_mid($mid) and last;
}
- }
- $default;
+ return index_entry(Email::MIME->new($mime), $state) if $mime;
+ $msgs = undef;
+ $skel .= "</pre>";
+ });
+ [ 200, ['Content-Type', 'text/html; charset=UTF-8'], $body ];
}
sub multipart_text_as_html {
- my ($mime, $full_pfx, $srch) = @_;
+ my ($mime, $upfx) = @_;
my $rv = "";
- my $part_nr = 0;
- my $enc = enc_for($mime->header("Content-Type"));
# scan through all parts, looking for displayable text
- $mime->walk_parts(sub {
- my ($part) = @_;
- $rv .= add_text_body($enc, $part, \$part_nr, $full_pfx);
+ msg_iter($mime, sub {
+ my ($p) = @_;
+ $rv .= add_text_body($upfx, $p);
});
- $mime->body_set('');
$rv;
}
-sub add_filename_line {
- my ($enc, $fn) = @_;
- my $len = 72;
- my $pad = "-";
- $fn = $enc->decode($fn);
- $len -= length($fn);
- $pad x= ($len/2) if ($len > 0);
- "$pad " . ascii_html($fn) . " $pad\n";
-}
-
-my $LINK_RE = qr!\b((?:ftp|https?|nntp)://
- [\@:\w\.-]+/
- ?[\@\w\+\&\?\.\%\;/#=-]*)!x;
-
-sub linkify_1 {
- my ($link_map, $s) = @_;
- $s =~ s!$LINK_RE!
- my $url = $1;
- # salt this, as this could be exploited to show
- # links in the HTML which don't show up in the raw mail.
- my $key = sha1_hex($url . $SALT);
- $link_map->{$key} = $url;
- 'PI-LINK-'. $key;
- !ge;
- $s;
-}
-
-sub linkify_2 {
- my ($link_map, $s) = @_;
-
- # Added "PI-LINK-" prefix to avoid false-positives on git commits
- $s =~ s!\bPI-LINK-([a-f0-9]{40})\b!
- my $key = $1;
- my $url = $link_map->{$key};
- if (defined $url) {
- $url = ascii_html($url);
- "<a\nhref=\"$url\">$url</a>";
- } else {
- # false positive or somebody tried to mess with us
- $key;
- }
- !ge;
- $s;
-}
-
sub flush_quote {
- my ($quot, $n, $part_nr, $full_pfx, $final) = @_;
-
- if ($full_pfx) {
- if (!$final && scalar(@$quot) <= MAX_INLINE_QUOTED) {
- # show quote inline
- my %l;
- my $rv = join('', map { linkify_1(\%l, $_) } @$quot);
- @$quot = ();
- $rv = ascii_html($rv);
- return linkify_2(\%l, $rv);
- }
-
- # show a short snippet of quoted text and link to full version:
- @$quot = map { s/^(?:>\s*)+//gm; $_ } @$quot;
- my $cur = join(' ', @$quot);
- @$quot = split(/\s+/, $cur);
- $cur = '';
- do {
- my $tmp = shift(@$quot);
- my $len = length($tmp) + length($cur);
- if ($len > MAX_TRUNC_LEN) {
- @$quot = ();
- } else {
- $cur .= $tmp . ' ';
- }
- } while (@$quot && length($cur) < MAX_TRUNC_LEN);
- @$quot = ();
- $cur =~ s/ \z/ .../s;
- $cur = ascii_html($cur);
- my $nr = ++$$n;
- "> [<a\nhref=\"$full_pfx#q${part_nr}_$nr\">$cur</a>]\n";
+ my ($s, $l, $quot) = @_;
+
+ # show everything in the full version with anchor from
+ # short version (see above)
+ my $rv = $l->linkify_1(join('', @$quot));
+ @$quot = ();
+
+ # we use a <span> here to allow users to specify their own
+ # color for quoted text
+ $rv = $l->linkify_2(ascii_html($rv));
+ $$s .= qq(<span\nclass="q">) . $rv . '</span>'
+}
+
+sub attach_link ($$$$) {
+ my ($upfx, $ct, $p, $fn) = @_;
+ my ($part, $depth, @idx) = @$p;
+ my $nl = $idx[-1] > 1 ? "\n" : '';
+ my $idx = join('.', @idx);
+ my $size = bytes::length($part->body);
+ $ct ||= 'text/plain';
+ $ct =~ s/;.*//; # no attributes
+ $ct = ascii_html($ct);
+ my $desc = $part->header('Content-Description');
+ $desc = $fn unless defined $desc;
+ $desc = '' unless defined $desc;
+ my $sfn;
+ if (defined $fn && $fn =~ /\A[[:alnum:]][\w\.-]+[[:alnum:]]\z/) {
+ $sfn = $fn;
+ } elsif ($ct eq 'text/plain') {
+ $sfn = 'a.txt';
} else {
- # show everything in the full version with anchor from
- # short version (see above)
- my $nr = ++$$n;
- my $rv = "";
- my %l;
- $rv .= join('', map { linkify_1(\%l, $_) } @$quot);
- @$quot = ();
- $rv = ascii_html($rv);
- "<a\nid=q${part_nr}_$nr></a>" . linkify_2(\%l, $rv);
+ $sfn = 'a.bin';
}
+ my @ret = qq($nl<a\nhref="$upfx$idx-$sfn">[-- Attachment #$idx: );
+ my $ts = "Type: $ct, Size: $size bytes";
+ push(@ret, ($desc eq '') ? "$ts --]" : "$desc --]\n[-- $ts --]");
+ join('', @ret, "</a>\n");
}
sub add_text_body {
- my ($enc_msg, $part, $part_nr, $full_pfx) = @_;
- return '' if $part->subparts;
-
+ my ($upfx, $p) = @_; # from msg_iter: [ Email::MIME, depth, @idx ]
+ my ($part, $depth, @idx) = @$p;
my $ct = $part->content_type;
- # account for filter bugs...
- if (defined $ct && $ct =~ m!\btext/[xh]+tml\b!i) {
- $part->body_set('');
- return '';
+ my $fn = $part->filename;
+
+ if (defined $ct && $ct =~ m!\btext/x?html\b!i) {
+ return attach_link($upfx, $ct, $p, $fn);
}
- my $enc = enc_for($ct, $enc_msg);
- my $n = 0;
- my $nr = 0;
- my $s = $part->body;
- $part->body_set('');
- $s = $enc->decode($s);
+
+ my $s = eval { $part->body_str };
+
+ # badly-encoded message? tell the world about it!
+ return attach_link($upfx, $ct, $p, $fn) if $@;
+
my @lines = split(/^/m, $s);
$s = '';
-
- if ($$part_nr > 0) {
- my $fn = $part->filename;
- defined($fn) or $fn = "part #" . ($$part_nr + 1);
- $s .= add_filename_line($enc, $fn);
+ if (defined($fn) || $depth > 0) {
+ $s .= attach_link($upfx, $ct, $p, $fn);
+ $s .= "\n";
}
-
my @quot;
+ my $l = PublicInbox::Linkify->new;
while (defined(my $cur = shift @lines)) {
if ($cur !~ /^>/) {
# show the previously buffered quote inline
- if (scalar @quot) {
- $s .= flush_quote(\@quot, \$n, $$part_nr,
- $full_pfx, 0);
- }
+ flush_quote(\$s, $l, \@quot) if @quot;
# regular line, OK
- my %l;
- $cur = linkify_1(\%l, $cur);
+ $cur = $l->linkify_1($cur);
$cur = ascii_html($cur);
- $s .= linkify_2(\%l, $cur);
+ $s .= $l->linkify_2($cur);
} else {
push @quot, $cur;
}
}
- $s .= flush_quote(\@quot, \$n, $$part_nr, $full_pfx, 1) if scalar @quot;
- $s .= "\n" unless $s =~ /\n\z/s;
- ++$$part_nr;
- $s;
+
+ my $end = "\n";
+ if (@quot) {
+ $end = '';
+ flush_quote(\$s, $l, \@quot);
+ }
+ $s =~ s/[ \t]+$//sgm; # kill per-line trailing whitespace
+ $s =~ s/\A\n+//s; # kill leading blank lines
+ $s =~ s/\s+\z//s; # kill all trailing spaces
+ $s .= $end;
}
-sub headers_to_html_header {
- my ($mime, $full_pfx, $ctx) = @_;
+sub _msg_html_prepare {
+ my ($hdr, $ctx) = @_;
my $srch = $ctx->{srch} if $ctx;
- my $rv = "";
+ my $atom = '';
+ my $rv = "<pre\nid=b>"; # anchor for body start
+
+ if ($srch) {
+ $ctx->{-upfx} = '../';
+ }
my @title;
- my $header_obj = $mime->header_obj;
- my $mid = $header_obj->header('Message-ID');
+ my $mid = $hdr->header_raw('Message-ID');
$mid = PublicInbox::Hval->new_msgid($mid);
- my $mid_href = $mid->as_href;
foreach my $h (qw(From To Cc Subject Date)) {
- my $v = $mime->header($h);
+ my $v = $hdr->header($h);
defined($v) && ($v ne '') or next;
- $v = PublicInbox::Hval->new_oneline($v);
+ $v = PublicInbox::Hval->new($v);
if ($h eq 'From') {
- my @from = Email::Address->parse($v->raw);
- $title[1] = ascii_html($from[0]->name);
+ my @n = PublicInbox::Address::names($v->raw);
+ $title[1] = ascii_html(join(', ', @n));
} elsif ($h eq 'Subject') {
$title[0] = $v->as_html;
if ($srch) {
- my $p = $full_pfx ? '' : '../';
- $rv .= "$h: <a\nid=\"t\"\nhref=\"${p}t/#u\">";
+ $rv .= qq($h: <a\nhref="#r"\nid=t>);
$rv .= $v->as_html . "</a>\n";
next;
}
}
- $rv .= "$h: " . $v->as_html . "\n";
+ $v = $v->as_html;
+ $v =~ s/(\@[^,]+,) /$1\n\t/g if ($h eq 'Cc' || $h eq 'To');
+ $rv .= "$h: $v\n";
}
+ $title[0] ||= '(no subject)';
+ $ctx->{-title_html} = join(' - ', @title);
$rv .= 'Message-ID: <' . $mid->as_html . '> ';
- my $raw_ref = $full_pfx ? 'raw' : '../raw';
- $rv .= "(<a\nhref=\"$raw_ref\">raw</a>)\n";
- if ($srch) {
- $rv .= "<a\nhref=\"#r\">References: [see below]</a>\n";
- } else {
- $rv .= _parent_headers_nosrch($header_obj);
- }
+ $rv .= "(<a\nhref=\"raw\">raw</a>)\n";
+ $rv .= _parent_headers($hdr, $srch);
$rv .= "\n";
-
- ("<html><head><title>". join(' - ', @title) .
- '</title></head><body>' . PRE_WRAP . $rv);
}
-sub thread_inline {
- my ($dst, $ctx, $cur, $full_pfx) = @_;
+sub thread_skel {
+ my ($dst, $ctx, $hdr, $tpfx) = @_;
my $srch = $ctx->{srch};
- my $mid = mid_compress(mid_clean($cur->header('Message-ID')));
- my $res = $srch->get_thread($mid);
- my $nr = $res->{total};
-
+ my $mid = mid_clean($hdr->header_raw('Message-ID'));
+ my $sres = $srch->get_thread($mid);
+ my $nr = $sres->{total};
+ my $expand = qq(<a\nhref="${tpfx}t/#u">expand</a> ) .
+ qq(/ <a\nhref="${tpfx}t.mbox.gz">mbox.gz</a> ) .
+ qq(/ <a\nhref="${tpfx}t.atom">Atom feed</a>);
+
+ my $parent = in_reply_to($hdr);
if ($nr <= 1) {
- $$dst .= "\n[no followups, yet]\n";
- return (undef, in_reply_to($cur));
+ if (defined $parent) {
+ $$dst .= "($expand)\n ";
+ $$dst .= ghost_parent("$tpfx../", $parent) . "\n";
+ } else {
+ $$dst .= "[no followups, yet] ($expand)\n";
+ }
+ $ctx->{next_msg} = undef;
+ $ctx->{parent_msg} = $parent;
+ return;
}
- my $upfx = $full_pfx ? '' : '../';
- $$dst .= "\n\n~$nr messages in thread: ".
- "(<a\nhref=\"${upfx}t/#u\">expand</a>)\n";
- my $subj = $srch->subject_path($cur->header('Subject'));
- my $parent = in_reply_to($cur);
+ $$dst .= "$nr+ messages in thread ($expand";
+ $$dst .= qq! / <a\nhref="#b">[top]</a>)\n!;
+
+ my $subj = $srch->subject_path($hdr->header('Subject'));
my $state = {
seen => { $subj => 1 },
srch => $srch,
cur => $mid,
- parent_cmp => $parent ? mid_compress($parent) : '',
- parent => $parent,
+ prev_attr => '',
+ prev_level => 0,
+ upfx => "$tpfx../",
+ dst => $dst,
};
- for (thread_results(load_results($res))->rootset) {
- inline_dump($dst, $state, $upfx, $_, 0);
- }
- ($state->{next_msg}, $state->{parent});
+ walk_thread(thread_results(load_results($sres)), $state, *skel_dump);
+ $ctx->{next_msg} = $state->{next_msg};
+ $ctx->{parent_msg} = $parent;
}
-sub _parent_headers_nosrch {
- my ($header_obj) = @_;
+sub _parent_headers {
+ my ($hdr, $srch) = @_;
my $rv = '';
- my $irt = in_reply_to($header_obj);
+ my $irt = in_reply_to($hdr);
if (defined $irt) {
my $v = PublicInbox::Hval->new_msgid($irt, 1);
my $html = $v->as_html;
$rv .= "<a\nhref=\"../$href/\">$html</a>>\n";
}
- my $refs = $header_obj->header('References');
+ # do not display References: if search is present,
+ # we show the thread skeleton at the bottom, instead.
+ return $rv if $srch;
+
+ my $refs = $hdr->header_raw('References');
if ($refs) {
# avoid redundant URLs wasting bandwidth
my %seen;
}
if (@refs) {
- $rv .= 'References: '. join(' ', @refs) . "\n";
+ $rv .= 'References: '. join("\n\t", @refs) . "\n";
}
}
$rv;
}
-sub html_footer {
- my ($mime, $standalone, $full_pfx, $ctx) = @_;
+sub squote_maybe ($) {
+ my ($val) = @_;
+ if ($val =~ m{([^\w@\./,\%\+\-])}) {
+ $val =~ s/(['!])/'\\$1'/g; # '!' for csh
+ return "'$val'";
+ }
+ $val;
+}
+
+sub mailto_arg_link {
+ my ($hdr) = @_;
my %cc; # everyone else
my $to; # this is the From address
foreach my $h (qw(From To Cc)) {
- my $v = $mime->header($h);
+ my $v = $hdr->header($h);
defined($v) && ($v ne '') or next;
- my @addrs = Email::Address->parse($v);
- foreach my $recip (@addrs) {
- my $address = $recip->address;
+ my @addrs = PublicInbox::Address::emails($v);
+ foreach my $address (@addrs) {
my $dst = lc($address);
$cc{$dst} ||= $address;
$to ||= $dst;
}
}
- Email::Address->purge_cache if $standalone;
+ my @arg;
- my $subj = $mime->header('Subject') || '';
+ my $subj = $hdr->header('Subject') || '';
$subj = "Re: $subj" unless $subj =~ /\bRe:/i;
- my $mid = $mime->header('Message-ID');
+ my $mid = $hdr->header_raw('Message-ID');
+ push @arg, '--in-reply-to='.ascii_html(squote_maybe(mid_clean($mid)));
my $irt = uri_escape_utf8($mid);
delete $cc{$to};
+ push @arg, '--to=' . ascii_html($to);
$to = uri_escape_utf8($to);
$subj = uri_escape_utf8($subj);
-
- my $cc = uri_escape_utf8(join(',', sort values %cc));
+ my $cc = join(',', sort values %cc);
+ push @arg, '--cc=' . ascii_html($cc);
+ $cc = uri_escape_utf8($cc);
my $href = "mailto:$to?In-Reply-To=$irt&Cc=${cc}&Subject=$subj";
+ $href =~ s/%20/+/g;
+
+ (\@arg, ascii_html($href));
+}
+
+sub html_footer {
+ my ($hdr, $standalone, $ctx, $rhref) = @_;
my $srch = $ctx->{srch} if $ctx;
- my $upfx = $full_pfx ? '../' : '../../';
+ my $upfx = '../';
+ my $tpfx = '';
my $idx = $standalone ? " <a\nhref=\"$upfx\">index</a>" : '';
+ my $irt = '';
if ($idx && $srch) {
- my ($next, $p) = thread_inline(\$idx, $ctx, $mime, $full_pfx);
- if (defined $p) {
- $p = PublicInbox::Hval->new_oneline($p);
+ $idx .= "\n";
+ thread_skel(\$idx, $ctx, $hdr, $tpfx);
+ my $p = $ctx->{parent_msg};
+ my $next = $ctx->{next_msg};
+ if ($p) {
+ $p = PublicInbox::Hval->new_msgid($p);
$p = $p->as_href;
- $irt = "<a\nhref=\"$upfx$p/\">parent</a> ";
+ $irt = "<a\nhref=\"$upfx$p/\"\nrel=prev>parent</a> ";
} else {
$irt = ' ' x length('parent ');
}
if ($next) {
- $irt .= "<a\nhref=\"$upfx$next/\">next</a> ";
+ my $n = PublicInbox::Hval->new_msgid($next)->as_href;
+ $irt .= "<a\nhref=\"$upfx$n/\"\nrel=next>next</a> ";
} else {
- $irt .= ' ';
+ $irt .= ' ' x length('next ');
}
} else {
$irt = '';
}
-
- "$irt<a\nhref=\"" . ascii_html($href) . '">reply</a>' . $idx;
+ $rhref ||= '#R';
+ $irt .= qq(<a\nhref="$rhref">reply</a>);
+ $irt .= $idx;
}
sub linkify_ref_nosrch {
sub anchor_for {
my ($msgid) = @_;
- my $id = $msgid;
- if ($id !~ /\A[a-f0-9]{40}\z/) {
- $id = mid_compress(mid_clean($id), 1);
- }
- 'm' . $id;
-}
-
-sub thread_html_head {
- my ($cb, $mime) = @_;
- $$cb = $$cb->([200, ['Content-Type'=> 'text/html; charset=UTF-8']]);
-
- my $s = PublicInbox::Hval->new_oneline($mime->header('Subject'));
- $s = $s->as_html;
- $$cb->write("<html><head><title>$s</title></head><body>");
-}
-
-sub pre_anchor_entry {
- my ($seen, $mime) = @_;
- my $id = anchor_for($mime->header('Message-ID'));
- $seen->{$id} = "#$id"; # save the anchor for children, later
+ 'm' . id_compress($msgid, 1);
}
-sub __thread_entry {
- my ($cb, $git, $state, $mime, $level) = @_;
+sub ghost_parent {
+ my ($upfx, $mid) = @_;
+ # 'subject dummy' is used internally by Mail::Thread
+ return '[no common parent]' if ($mid eq 'subject dummy');
- # lazy load the full message from mini_mime:
- $mime = eval {
- my $path = mid2path(mid_clean($mime->header('Message-ID')));
- Email::MIME->new($git->cat_file('HEAD:'.$path));
- } or return;
-
- if ($state->{anchor_idx} == 0) {
- thread_html_head($cb, $mime, $state);
- }
-
- if (my $ghost = delete $state->{ghost}) {
- # n.b. ghost messages may only be parents, not children
- foreach my $g (@$ghost) {
- my $mid = PublicInbox::Hval->new_msgid($g->[0]);
- my $pfx = INDENT x $g->[1];
- my $href = $mid->as_href;
- my $html = $mid->as_html;
- $$cb->write("<table><tr><td>$pfx</td><td>" .
- PRE_WRAP .
- '[parent not found: <' .
- qq{<a\nhref="../../$href/">}.
- "$html</a>>]</pre></td></table>");
- }
- }
- index_entry($$cb, $mime, $level, $state);
- 1;
-}
-
-sub __ghost_entry {
- my ($state, $node, $level) = @_;
- my $ghost = $state->{ghost} ||= [];
- push @$ghost, [ $node->messageid, $level ];
+ $mid = PublicInbox::Hval->new_msgid($mid);
+ my $href = $mid->as_href;
+ my $html = $mid->as_html;
+ qq{[parent not found: <<a\nhref="$upfx$href/">$html</a>>]};
}
-sub thread_entry {
- my ($cb, $git, $state, $node, $level) = @_;
- return unless $node;
- if (my $mime = $node->message) {
- unless (__thread_entry($cb, $git, $state, $mime, $level)) {
- __ghost_entry($state, $node, $level);
- }
- } else {
- __ghost_entry($state, $node, $level);
- }
-
- thread_entry($cb, $git, $state, $node->child, $level + 1);
- thread_entry($cb, $git, $state, $node->next, $level);
+sub indent_for {
+ my ($level) = @_;
+ INDENT x ($level - 1);
}
sub load_results {
- my ($res) = @_;
+ my ($sres) = @_;
- [ map { $_->mini_mime } @{delete $res->{msgs}} ];
+ [ map { $_->mini_mime } @{delete $sres->{msgs}} ];
}
sub msg_timestamp {
- my ($mime) = @_;
- my $ts = eval { str2time($mime->header('Date')) };
+ my ($hdr) = @_;
+ my $ts = eval { str2time($hdr->header('Date')) };
defined($ts) ? $ts : 0;
}
require PublicInbox::Thread;
my $th = PublicInbox::Thread->new(@$msgs);
$th->thread;
- no warnings 'once';
- $th->order(*PublicInbox::Thread::sort_ts);
+ $th->order(*sort_ts);
$th
}
sub missing_thread {
- my ($cb, $ctx) = @_;
+ my ($ctx) = @_;
require PublicInbox::ExtMsg;
-
- $cb->(PublicInbox::ExtMsg::ext_msg($ctx))
+ PublicInbox::ExtMsg::ext_msg($ctx);
}
sub _msg_date {
- my ($mime) = @_;
- my $ts = $mime->header('X-PI-TS') || msg_timestamp($mime);
- POSIX::strftime('%Y-%m-%d %H:%M', gmtime($ts));
+ my ($hdr) = @_;
+ my $ts = $hdr->header('X-PI-TS') || msg_timestamp($hdr);
+ fmt_ts($ts);
}
-sub _inline_header {
- my ($dst, $state, $upfx, $mime, $level) = @_;
- my $pfx = INDENT x $level;
+sub fmt_ts { POSIX::strftime('%Y-%m-%d %k:%M', gmtime($_[0])) }
+
+sub _skel_header {
+ my ($state, $hdr, $level) = @_;
+ my $dst = $state->{dst};
my $cur = $state->{cur};
- my $mid = $mime->header('Message-ID');
- my $f = $mime->header('X-PI-From');
- my $d = _msg_date($mime);
- $f = PublicInbox::Hval->new($f);
- $d = PublicInbox::Hval->new($d);
- $f = $f->as_html;
- $d = $d->as_html . ' UTC';
- my $midc = mid_compress(mid_clean($mid));
+ my $mid = mid_clean($hdr->header_raw('Message-ID'));
+ my $f = ascii_html($hdr->header('X-PI-From'));
+ my $d = _msg_date($hdr);
+ my $pfx = "$d " . indent_for($level) . th_pfx($level);
+ my $attr = $f;
+ $state->{first_level} ||= $level;
+
+ if ($attr ne $state->{prev_attr} || $state->{prev_level} > $level) {
+ $state->{prev_attr} = $attr;
+ } else {
+ $attr = '';
+ }
+ $state->{prev_level} = $level;
+
if ($cur) {
- if ($cur eq $midc) {
+ if ($cur eq $mid) {
delete $state->{cur};
- $$dst .= "$pfx` <b><a\nid=\"r\"\nhref=\"#t\">".
- "[this message]</a></b> by $f @ $d\n";
+ $$dst .= "$pfx<b><a\nid=r\nhref=\"#t\">".
+ "$attr [this message]</a></b>\n";
return;
}
} else {
- $state->{next_msg} ||= $midc;
+ $state->{next_msg} ||= $mid;
}
# Subject is never undef, this mail was loaded from
# our Xapian which would've resulted in '' if it were
# really missing (and Filter rejects empty subjects)
- my $s = $mime->header('Subject');
+ my $s = $hdr->header('Subject');
my $h = $state->{srch}->subject_path($s);
if ($state->{seen}->{$h}) {
$s = undef;
$s = $s->as_html;
}
my $m = PublicInbox::Hval->new_msgid($mid);
- $m = $upfx . '../' . $m->as_href . '/';
- if (defined $s) {
- $$dst .= "$pfx` <a\nhref=\"$m\">$s</a>\n" .
- "$pfx $f @ $d\n";
+ my $id = '';
+ if ($state->{mapping}) {
+ $id = id_compress($mid, 1);
+ $m = '#m'.$id;
+ $id = "\nid=r".$id;
} else {
- $$dst .= "$pfx` <a\nhref=\"$m\">$f @ $d</a>\n";
+ $m = $state->{upfx}.$m->as_href.'/';
}
+ $$dst .= "$pfx<a\nhref=\"$m\"$id>";
+ $$dst .= defined($s) ? "$s</a> $f\n" : "$f</a>\n";
}
-sub inline_dump {
- my ($dst, $state, $upfx, $node, $level) = @_;
- return unless $node;
+sub skel_dump {
+ my ($state, $level, $node) = @_;
if (my $mime = $node->message) {
- my $mid = mid_clean($mime->header('Message-ID'));
- if ($mid eq $state->{parent_cmp}) {
- $state->{parent} = $mid;
- }
- _inline_header($dst, $state, $upfx, $mime, $level);
+ _skel_header($state, $mime->header_obj, $level);
} else {
- my $pfx = INDENT x $level;
- my $v = PublicInbox::Hval->new_msgid($node->messageid, 1);
- my $html = $v->as_html;
- my $href = $v->as_href;
- $$dst .= $pfx . '` [parent not found: <' .
- qq{<a\nhref="$upfx../$href/">}.
- "$html</a>>]\n";
+ my $mid = $node->messageid;
+ my $dst = $state->{dst};
+ if ($mid eq 'subject dummy') {
+ $$dst .= "\t[no common parent]\n";
+ return;
+ }
+ if ($state->{pct}) { # search result
+ $$dst .= ' [irrelevant] ';
+ } else {
+ $$dst .= ' [not found] ';
+ }
+ $$dst .= indent_for($level) . th_pfx($level);
+ my $upfx = $state->{upfx};
+ my $id = '';
+ if ($state->{mapping}) { # thread index view
+ $id = "\nid=".anchor_for($mid);
+ }
+ $mid = PublicInbox::Hval->new_msgid($mid);
+ my $href = $upfx . $mid->as_href . '/';
+ my $html = $mid->as_html;
+ $$dst .= qq{<<a\nhref="$href"$id>$html</a>>\n};
+ }
+}
+
+sub sort_ts {
+ sort {
+ (eval { $a->topmost->message->header('X-PI-TS') } || 0) <=>
+ (eval { $b->topmost->message->header('X-PI-TS') } || 0)
+ } @_;
+}
+
+sub _tryload_ghost ($$) {
+ my ($srch, $mid) = @_;
+ my $smsg = $srch->lookup_mail($mid) or return;
+ $smsg->mini_mime;
+}
+
+# accumulate recent topics if search is supported
+# returns 1 if done, undef if not
+sub add_topic {
+ my ($state, $level, $node) = @_;
+ my $srch = $state->{srch};
+ my $mid = $node->messageid;
+ my $x = $node->message || _tryload_ghost($srch, $mid);
+ my ($subj, $ts);
+ if ($x) {
+ $x = $x->header_obj;
+ $subj = $x->header('Subject');
+ $subj = $srch->subject_normalized($subj);
+ $ts = $x->header('X-PI-TS');
+ } else { # ghost message, do not bump level
+ $ts = -666;
+ $subj = "<$mid>";
+ }
+ if (++$state->{subjs}->{$subj} == 1) {
+ push @{$state->{order}}, [ $level, $subj ];
+ }
+ my $exist = $state->{latest}->{$subj};
+ if (!$exist || $exist->[1] < $ts) {
+ $state->{latest}->{$subj} = [ $mid, $ts ];
+ }
+}
+
+sub emit_topics {
+ my ($state) = @_;
+ my $order = $state->{order};
+ my $subjs = $state->{subjs};
+ my $latest = $state->{latest};
+ my $fh = $state->{fh};
+ return $fh->write("\n[No topics in range]</pre>") unless scalar @$order;
+ my $pfx;
+ my $prev = 0;
+ my $prev_attr = '';
+ my $cur;
+ my @recent;
+ while (defined(my $info = shift @$order)) {
+ my ($level, $subj) = @$info;
+ my $n = delete $subjs->{$subj};
+ my ($mid, $ts) = @{delete $latest->{$subj}};
+ $mid = PublicInbox::Hval->new_msgid($mid)->as_href;
+ $pfx = indent_for($level);
+ my $nl = $level == $prev ? "\n" : '';
+ if ($nl && $cur) {
+ push @recent, $cur;
+ $cur = undef;
+ }
+ $cur ||= [ $ts, '' ];
+ $cur->[0] = $ts if $ts > $cur->[0];
+ $cur->[1] .= $nl . $pfx . th_pfx($level);
+ if ($ts == -666) { # ghost
+ $cur->[1] .= ghost_parent('', $mid) . "\n";
+ next; # child will have mbox / atom link
+ }
+
+ $subj = PublicInbox::Hval->new($subj)->as_html;
+ $cur->[1] .= "<a\nhref=\"$mid/t/#u\"><b>$subj</b></a>\n";
+ $ts = fmt_ts($ts);
+ my $attr = " $ts UTC";
+
+ # $n isn't the total number of posts on the topic,
+ # just the number of posts in the current results window
+ $n = $n == 1 ? '' : " ($n+ messages)";
+
+ if ($level == 0 || $attr ne $prev_attr) {
+ my $mbox = qq(<a\nhref="$mid/t.mbox.gz">mbox.gz</a>);
+ my $atom = qq(<a\nhref="$mid/t.atom">Atom</a>);
+ $pfx .= INDENT if $level > 0;
+ $cur->[1] .= $pfx . $attr . $n . " - $mbox / $atom\n";
+ $prev_attr = $attr;
+ }
}
- inline_dump($dst, $state, $upfx, $node->child, $level+1);
- inline_dump($dst, $state, $upfx, $node->next, $level);
+ push @recent, $cur if $cur;
+ @recent = map { $_->[1] } sort { $b->[0] <=> $a->[0] } @recent;
+ $fh->write(join('', @recent) . '</pre>');
+}
+
+sub emit_index_topics {
+ my ($state) = @_;
+ my ($off) = (($state->{ctx}->{cgi}->param('o') || '0') =~ /(\d+)/);
+ $state->{order} = [];
+ $state->{subjs} = {};
+ $state->{latest} = {};
+ my $max = 25;
+ my %opts = ( offset => $off, limit => $max * 4 );
+ while (scalar @{$state->{order}} < $max) {
+ my $sres = $state->{srch}->query('', \%opts);
+ my $nr = scalar @{$sres->{msgs}} or last;
+ $sres = load_results($sres);
+ walk_thread(thread_results($sres), $state, *add_topic);
+ $opts{offset} += $nr;
+ }
+
+ emit_topics($state);
+ $opts{offset};
}
1;