]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/View.pm
www: redirect /$MESSAGE_ID/f/ endpoints
[public-inbox.git] / lib / PublicInbox / View.pm
index 2cf7e4f01ff120c8c6b4ef3634b944c7f0332043..ac44d442b166ba1189772d363612a4c638450891 100644 (file)
@@ -16,23 +16,19 @@ use PublicInbox::Linkify;
 use PublicInbox::MID qw/mid_clean id_compress mid2path mid_mime/;
 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 T_ANCHOR => '#u';
 use constant INDENT => '  ';
 
 my $enc_utf8 = find_encoding('UTF-8');
 
 # public functions:
 sub msg_html {
-       my ($ctx, $mime, $full_pfx, $footer) = @_;
+       my ($ctx, $mime, $footer) = @_;
        $footer = defined($footer) ? "\n$footer" : '';
        my $hdr = $mime->header_obj;
-       headers_to_html_header($hdr, $full_pfx, $ctx) .
-               multipart_text_as_html($mime, $full_pfx) .
+       headers_to_html_header($hdr, $ctx) .
+               multipart_text_as_html($mime) .
                '</pre><hr /><pre>' .
-               html_footer($hdr, 1, $full_pfx, $ctx) .
+               html_footer($hdr, 1, $ctx) .
                $footer .
                '</pre></body></html>';
 }
@@ -76,11 +72,10 @@ sub msg_reply {
 }
 
 sub feed_entry {
-       my ($class, $mime, $full_pfx) = @_;
+       my ($class, $mime) = @_;
 
        # no <head> here for <style>...
-       PublicInbox::Hval::PRE .
-               multipart_text_as_html($mime, $full_pfx) . '</pre>';
+       PublicInbox::Hval::PRE . multipart_text_as_html($mime) . '</pre>';
 }
 
 sub in_reply_to {
@@ -135,20 +130,14 @@ sub index_entry {
        my $fh = $state->{fh};
        $fh->write($rv .= "- $from @ $ts UTC (<a\nhref=\"$txt\">raw</a>)\n\n");
 
-       my $fhref;
        my $mhref = "${path}$href/";
 
-       # show full message if it's our root message
-       my $neq = $root_anchor ne $id;
-       if ($neq || ($neq && $level != 0 && !$ctx->{flat})) {
-               $fhref = "${path}$href/f/";
-       }
        # scan through all parts, looking for displayable text
        $mime->walk_parts(sub {
-               index_walk($fh, $_[0], $enc, \$part_nr, $fhref);
+               index_walk($fh, $_[0], $enc, \$part_nr);
        });
        $mime->body_set('');
-       $rv = "\n" . html_footer($hdr, 0, undef, $ctx, $mhref);
+       $rv = "\n" . html_footer($hdr, 0, $ctx, $mhref);
 
        if (defined $irt) {
                unless (defined $parent_anchor) {
@@ -231,8 +220,8 @@ sub emit_thread_html {
 }
 
 sub index_walk {
-       my ($fh, $part, $enc, $part_nr, $fhref) = @_;
-       my $s = add_text_body($enc, $part, $part_nr, $fhref, 1);
+       my ($fh, $part, $enc, $part_nr) = @_;
+       my $s = add_text_body($enc, $part, $part_nr);
 
        return if $s eq '';
 
@@ -256,7 +245,7 @@ sub enc_for {
 }
 
 sub multipart_text_as_html {
-       my ($mime, $full_pfx, $srch) = @_;
+       my ($mime) = @_;
        my $rv = "";
        my $part_nr = 0;
        my $enc = enc_for($mime->header("Content-Type"));
@@ -264,7 +253,7 @@ sub multipart_text_as_html {
        # scan through all parts, looking for displayable text
        $mime->walk_parts(sub {
                my ($part) = @_;
-               $part = add_text_body($enc, $part, \$part_nr, $full_pfx, 1);
+               $part = add_text_body($enc, $part, \$part_nr);
                $rv .= $part;
                $rv .= "\n" if $part ne '';
        });
@@ -283,55 +272,21 @@ sub add_filename_line {
 }
 
 sub flush_quote {
-       my ($quot, $n, $part_nr, $full_pfx, $final, $do_anchor) = @_;
-
-       # n.b.: do not use <blockquote> since it screws up alignment
-       # w.r.t. unquoted text.  Repliers may rely on pre-formatted
-       # alignment to point out a certain word in quoted text.
-       if ($full_pfx) {
-               if (!$final && scalar(@$quot) <= MAX_INLINE_QUOTED) {
-                       # show quote inline
-                       my $l = PublicInbox::Linkify->new;
-                       my $rv = join('', map { $l->linkify_1($_) } @$quot);
-                       @$quot = ();
-                       $rv = ascii_html($rv);
-                       return $l->linkify_2($rv);
-               }
+       my ($s, $l, $quot, $part_nr) = @_;
 
-               # 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;
-               "&gt; [<a\nhref=\"$full_pfx#q${part_nr}_$nr\">$cur</a>]\n";
-       } else {
-               # show everything in the full version with anchor from
-               # short version (see above)
-               my $l = PublicInbox::Linkify->new;
-               my $rv .= join('', map { $l->linkify_1($_) } @$quot);
-               @$quot = ();
-               $rv = ascii_html($rv);
-               return $l->linkify_2($rv) unless $do_anchor;
-               my $nr = ++$$n;
-               "<a\nid=q${part_nr}_$nr></a>" . $l->linkify_2($rv);
-       }
+       # show everything in the full version with anchor from
+       # short version (see above)
+       my $rv = $l->linkify_1(join('', @$quot));
+       @$quot = ();
+
+       # we use a <div> 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 add_text_body {
-       my ($enc_msg, $part, $part_nr, $full_pfx, $do_anchor) = @_;
+       my ($enc_msg, $part, $part_nr) = @_;
        return '' if $part->subparts;
 
        my $ct = $part->content_type;
@@ -341,8 +296,6 @@ sub add_text_body {
                return '';
        }
        my $enc = enc_for($ct, $enc_msg);
-       my $n = 0;
-       my $nr = 0;
        my $s = $part->body;
        $part->body_set('');
        $s = $enc->decode($s);
@@ -356,16 +309,13 @@ sub add_text_body {
        }
 
        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, $do_anchor);
-                       }
+                       flush_quote(\$s, $l, \@quot, $$part_nr) if @quot;
 
                        # regular line, OK
-                       my $l = PublicInbox::Linkify->new;
                        $cur = $l->linkify_1($cur);
                        $cur = ascii_html($cur);
                        $s .= $l->linkify_2($cur);
@@ -373,10 +323,8 @@ sub add_text_body {
                        push @quot, $cur;
                }
        }
-       if (scalar @quot) {
-               $s .= flush_quote(\@quot, \$n, $$part_nr, $full_pfx, 1,
-                                 $do_anchor);
-       }
+
+       flush_quote(\$s, $l, \@quot, $$part_nr) if @quot;
        ++$$part_nr;
 
        $s =~ s/[ \t]+$//sgm; # kill per-line trailing whitespace
@@ -386,9 +334,17 @@ sub add_text_body {
 }
 
 sub headers_to_html_header {
-       my ($hdr, $full_pfx, $ctx) = @_;
+       my ($hdr, $ctx) = @_;
        my $srch = $ctx->{srch} if $ctx;
-       my $rv = "";
+       my $atom = '';
+       my $rv = '';
+       my $upfx = '';
+
+       if ($srch) {
+               $atom = qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
+                       qq!href="${upfx}t.atom"\ntype="application/atom+xml"/>!;
+       }
+
        my @title;
        my $mid = $hdr->header_raw('Message-ID');
        $mid = PublicInbox::Hval->new_msgid($mid);
@@ -403,8 +359,8 @@ sub headers_to_html_header {
                } elsif ($h eq 'Subject') {
                        $title[0] = $v->as_html;
                        if ($srch) {
-                               $rv .= "$h: <b\nid=t>";
-                               $rv .= $v->as_html . "</b>\n";
+                               $rv .= qq($h: <a\nhref="#r"\nid=t>);
+                               $rv .= $v->as_html . "</a>\n";
                                next;
                        }
                }
@@ -412,25 +368,17 @@ sub headers_to_html_header {
 
        }
        $rv .= 'Message-ID: &lt;' . $mid->as_html . '&gt; ';
-       my $upfx = $full_pfx ? '' : '../';
        $rv .= "(<a\nhref=\"${upfx}raw\">raw</a>)\n";
-       my $atom;
-       if ($srch) {
-               thread_inline(\$rv, $ctx, $hdr, $upfx);
-
-               $atom = qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
-                       qq!href="${upfx}t.atom"\ntype="application/atom+xml"/>!;
-       } else {
-               $rv .= _parent_headers_nosrch($hdr);
-               $atom = '';
-       }
+       $rv .= _parent_headers($hdr, $srch);
        $rv .= "\n";
 
        ("<html><head><title>".  join(' - ', @title) . "</title>$atom".
-        PublicInbox::Hval::STYLE . "</head><body><pre>" . $rv);
+        PublicInbox::Hval::STYLE .
+        "</head><body><pre\nid=b>" . # anchor for body start
+        $rv);
 }
 
-sub thread_inline {
+sub thread_skel {
        my ($dst, $ctx, $hdr, $upfx) = @_;
        my $srch = $ctx->{srch};
        my $mid = mid_clean($hdr->header_raw('Message-ID'));
@@ -439,7 +387,6 @@ sub thread_inline {
        my $expand = "<a\nhref=\"${upfx}t/#u\">expand</a> " .
                        "/ <a\nhref=\"${upfx}t.mbox.gz\">mbox.gz</a>";
 
-       $$dst .= 'Thread: ';
        my $parent = in_reply_to($hdr);
        if ($nr <= 1) {
                if (defined $parent) {
@@ -453,11 +400,8 @@ sub thread_inline {
                return;
        }
 
-       $$dst .= "~$nr messages ($expand";
-       if ($nr > MAX_INLINE_QUOTED) {
-               $$dst .= qq! / <a\nhref="#b">[scroll down]</a>!;
-       }
-       $$dst .= ")\n";
+       $$dst .= "$nr+ messages in thread ($expand";
+       $$dst .= qq! / <a\nhref="#b">[top]</a>)\n!;
 
        my $subj = $srch->subject_path($hdr->header('Subject'));
        my $state = {
@@ -468,15 +412,14 @@ sub thread_inline {
                prev_level => 0,
        };
        for (thread_results(load_results($sres))->rootset) {
-               inline_dump($dst, $state, $upfx, $_, 0);
+               skel_dump($dst, $state, $upfx, $_, 0);
        }
-       $$dst .= "<a\nid=b></a>"; # anchor for body start
        $ctx->{next_msg} = $state->{next_msg};
        $ctx->{parent_msg} = $parent;
 }
 
-sub _parent_headers_nosrch {
-       my ($hdr) = @_;
+sub _parent_headers {
+       my ($hdr, $srch) = @_;
        my $rv = '';
 
        my $irt = in_reply_to($hdr);
@@ -488,6 +431,10 @@ sub _parent_headers_nosrch {
                $rv .= "<a\nhref=\"../$href/\">$html</a>&gt;\n";
        }
 
+       # 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
@@ -546,11 +493,11 @@ sub mailto_arg_link {
 }
 
 sub html_footer {
-       my ($mime, $standalone, $full_pfx, $ctx, $mhref) = @_;
+       my ($hdr, $standalone, $ctx, $mhref) = @_;
 
        my $srch = $ctx->{srch} if $ctx;
-       my $upfx = $full_pfx ? '../' : '../../';
-       my $tpfx = $full_pfx ? '' : '../';
+       my $upfx = '../';
+       my $tpfx = '';
        my $idx = $standalone ? " <a\nhref=\"$upfx\">index</a>" : '';
        my $irt = '';
 
@@ -558,6 +505,7 @@ sub html_footer {
                $idx .= qq{ / follow: <a\nhref="${tpfx}t.atom">Atom feed</a>\n};
        }
        if ($idx && $srch) {
+               thread_skel(\$idx, $ctx, $hdr, $tpfx);
                my $p = $ctx->{parent_msg};
                my $next = $ctx->{next_msg};
                if ($p) {
@@ -572,17 +520,11 @@ sub html_footer {
                } else {
                        $irt .= ' ' x length('next ');
                }
-               if ($p || $next) {
-                       $irt .= "<a\nhref=\"${tpfx}t/#u\">thread</a> ";
-               } else {
-                       $irt .= ' ' x length('thread ');
-               }
        } else {
                $irt = '';
        }
 
-       $mhref = './' unless defined $mhref;
-       $irt . qq(<a\nhref="${mhref}R/">reply</a>) . $idx;
+       $irt . qq(<a\nhref="${tpfx}R/">reply</a>) . $idx;
 }
 
 sub linkify_ref_nosrch {
@@ -726,13 +668,21 @@ sub msg_timestamp {
 }
 
 sub thread_results {
-       my ($msgs, $nosubject) = @_;
+       my ($msgs, $nosubject, $nosort) = @_;
        require PublicInbox::Thread;
        my $th = PublicInbox::Thread->new(@$msgs);
+
+       # WARNING! both these Mail::Thread knobs were found by inspecting
+       # the Mail::Thread 2.55 source code, and we have some monkey patches
+       # in PublicInbox::Thread to fix memory leaks.  Since Mail::Thread
+       # appears unmaintained, I suppose it's safe to depend on these
+       # variables for now:
        no warnings 'once';
        $Mail::Thread::nosubject = $nosubject;
+       # Keep ghosts with only a single direct child:
+       $Mail::Thread::noprune = 1;
        $th->thread;
-       $th->order(*sort_ts);
+       $th->order(*sort_ts) unless $nosort;
        $th
 }
 
@@ -751,7 +701,7 @@ sub _msg_date {
 
 sub fmt_ts { POSIX::strftime('%Y-%m-%d %k:%M', gmtime($_[0])) }
 
-sub _inline_header {
+sub _skel_header {
        my ($dst, $state, $upfx, $hdr, $level) = @_;
        my $dot = $level == 0 ? '' : '` ';
 
@@ -803,22 +753,29 @@ sub _inline_header {
        }
 }
 
-sub inline_dump {
+sub skel_dump {
        my ($dst, $state, $upfx, $node, $level) = @_;
        return unless $node;
        if (my $mime = $node->message) {
                my $hdr = $mime->header_obj;
                my $mid = mid_clean($hdr->header_raw('Message-ID'));
-               _inline_header($dst, $state, $upfx, $hdr, $level);
+               _skel_header($dst, $state, $upfx, $hdr, $level);
        } else {
-               my $dot = $level == 0 ? '' : '` ';
-               my $pfx = (' ' x length(' 1970-01-01 13:37 ')).
-                       indent_for($level) . $dot;
-               $$dst .= $pfx;
-               $$dst .= ghost_parent("$upfx../", $node->messageid) . "\n";
+               my $mid = $node->messageid;
+               if ($mid eq 'subject dummy') {
+                       $$dst .= "\t[no common parent]\n";
+               } else {
+                       $$dst .= '      [not found] ';
+                       my $dot = $level == 0 ? '' : '` ';
+                       $$dst .= indent_for($level) . $dot;
+                       $mid = PublicInbox::Hval->new_msgid($mid);
+                       my $href = "$upfx../" . $mid->as_href . '/';
+                       my $html = $mid->as_html;
+                       $$dst .= qq{&lt;<a\nhref="$href">$html</a>&gt;\n};
+               }
        }
-       inline_dump($dst, $state, $upfx, $node->child, $level+1);
-       inline_dump($dst, $state, $upfx, $node->next, $level);
+       skel_dump($dst, $state, $upfx, $node->child, $level+1);
+       skel_dump($dst, $state, $upfx, $node->next, $level);
 }
 
 sub sort_ts {
@@ -828,13 +785,6 @@ sub sort_ts {
        } @_;
 }
 
-sub rsort_ts {
-       sort {
-               (eval { $b->topmost->message->header('X-PI-TS') } || 0) <=>
-               (eval { $a->topmost->message->header('X-PI-TS') } || 0)
-       } @_;
-}
-
 # accumulate recent topics if search is supported
 # returns 1 if done, undef if not
 sub add_topic {
@@ -869,16 +819,18 @@ sub add_topic {
        add_topic($state, $node->next, $level);
 }
 
-sub dump_topics {
+sub emit_topics {
        my ($state) = @_;
        my $order = $state->{order};
        my $subjs = $state->{subjs};
        my $latest = $state->{latest};
-       return "\n[No topics in range]</pre>" unless (scalar @$order);
-       my $dst = '';
+       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};
@@ -887,8 +839,16 @@ sub dump_topics {
                $subj = PublicInbox::Hval->new($subj)->as_html;
                $pfx = indent_for($level);
                my $nl = $level == $prev ? "\n" : '';
+               if ($nl && $cur) {
+                       push @recent, $cur;
+                       $cur = undef;
+               }
+               $cur ||= [ $ts, '' ];
                my $dot = $level == 0 ? '' : '` ';
-               $dst .= "$nl$pfx$dot<a\nhref=\"$mid/t/#u\"><b>$subj</b></a>\n";
+               $cur->[0] = $ts if $ts > $cur->[0];
+               $cur->[1] .= "$nl$pfx$dot<a\nhref=\"$mid/t/#u\"><b>";
+               $cur->[1] .= $subj;
+               $cur->[1] .= "</b></a>\n";
 
                $ts = fmt_ts($ts);
                my $attr = " $ts UTC";
@@ -901,11 +861,13 @@ sub dump_topics {
                        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;
-                       $dst .= $pfx . $attr . $n . " - $mbox / $atom\n";
+                       $cur->[1] .= $pfx . $attr . $n . " - $mbox / $atom\n";
                        $prev_attr = $attr;
                }
        }
-       $dst .= '</pre>';
+       push @recent, $cur if $cur;
+       @recent = map { $_->[1] } sort { $b->[0] <=> $a->[0] } @recent;
+       $fh->write(join('', @recent) . '</pre>');
 }
 
 sub emit_index_topics {
@@ -921,13 +883,13 @@ sub emit_index_topics {
                my $sres = $state->{srch}->query('', \%opts);
                my $nr = scalar @{$sres->{msgs}} or last;
 
-               for (rsort_ts(thread_results(load_results($sres), 1)->rootset)){
+               for (thread_results(load_results($sres), 1)->rootset) {
                        add_topic($state, $_, 0);
                }
                $opts{offset} += $nr;
        }
 
-       $state->{fh}->write(dump_topics($state));
+       emit_topics($state);
        $opts{offset};
 }