lib/PublicInbox/View.pm

   1 # Copyright (C) 2014-2015 all contributors <meta@public-inbox.org>
   2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
   3 #
   4 # Used for displaying the HTML web interface.
   5 # See Documentation/design_www.txt for this.
   6 package PublicInbox::View;
   7 use strict;
   8 use warnings;
   9 use URI::Escape qw/uri_escape_utf8/;
  10 use Date::Parse qw/str2time/;
  11 use Encode qw/find_encoding/;
  12 use Encode::MIME::Header;
  13 use Email::MIME::ContentType qw/parse_content_type/;
  14 use PublicInbox::Hval;
  15 use PublicInbox::MID qw/mid_clean id_compress mid2path/;
  16 use Digest::SHA qw/sha1_hex/;
  17 my $SALT = rand;
  18 require POSIX;
  19
  20 # TODO: make these constants tunable
  21 use constant MAX_INLINE_QUOTED => 12; # half an 80x24 terminal
  22 use constant MAX_TRUNC_LEN => 72;
  23 use constant T_ANCHOR => '#u';
  24 use constant INDENT => '  ';
  25
  26 *ascii_html = *PublicInbox::Hval::ascii_html;
  27
  28 my $enc_utf8 = find_encoding('UTF-8');
  29
  30 # public functions:
  31 sub msg_html {
  32         my ($ctx, $mime, $full_pfx, $footer) = @_;
  33         if (defined $footer) {
  34                 $footer = "\n" . $footer;
  35         } else {
  36                 $footer = '';
  37         }
  38         headers_to_html_header($mime, $full_pfx, $ctx) .
  39                 multipart_text_as_html($mime, $full_pfx) .
  40                 '</pre><hr /><pre>' .
  41                 html_footer($mime, 1, $full_pfx, $ctx) .
  42                 $footer .
  43                 '</pre></body></html>';
  44 }
  45
  46 sub feed_entry {
  47         my ($class, $mime, $full_pfx) = @_;
  48
  49         # no <head> here for <style>...
  50         PublicInbox::Hval::PRE .
  51                 multipart_text_as_html($mime, $full_pfx) . '</pre>';
  52 }
  53
  54 sub in_reply_to {
  55         my ($header_obj) = @_;
  56         my $irt = $header_obj->header('In-Reply-To');
  57
  58         return mid_clean($irt) if (defined $irt);
  59
  60         my $refs = $header_obj->header('References');
  61         if ($refs && $refs =~ /<([^>]+)>\s*\z/s) {
  62                 return $1;
  63         }
  64         undef;
  65 }
  66
  67 # this is already inside a <pre>
  68 sub index_entry {
  69         my ($fh, $mime, $level, $state) = @_;
  70         my $midx = $state->{anchor_idx}++;
  71         my $ctx = $state->{ctx};
  72         my $srch = $ctx->{srch};
  73         my ($prev, $next) = ($midx - 1, $midx + 1);
  74         my $part_nr = 0;
  75         my $enc = enc_for($mime->header("Content-Type"));
  76         my $subj = $mime->header('Subject');
  77         my $header_obj = $mime->header_obj;
  78
  79         my $mid_raw = mid_clean($header_obj->header('Message-ID'));
  80         my $id = anchor_for($mid_raw);
  81         my $seen = $state->{seen};
  82         $seen->{$id} = "#$id"; # save the anchor for children, later
  83
  84         my $mid = PublicInbox::Hval->new_msgid($mid_raw);
  85         my $from = PublicInbox::Hval->new_oneline($mime->header('From'))->raw;
  86         my @from = Email::Address->parse($from);
  87         $from = $from[0]->name;
  88
  89         $from = PublicInbox::Hval->new_oneline($from)->as_html;
  90         $subj = PublicInbox::Hval->new_oneline($subj)->as_html;
  91         my $root_anchor = $state->{root_anchor} || '';
  92         my $path = $root_anchor ? '../../' : '';
  93         my $href = $mid->as_href;
  94         my $irt = in_reply_to($header_obj);
  95         my $parent_anchor = $seen->{anchor_for($irt)} if defined $irt;
  96
  97         if ($srch) {
  98                 my $t = $ctx->{flat} ? 'T' : 't';
  99                 $subj = "<a\nhref=\"${path}$href/$t/#u\">$subj</a>";
 100         }
 101         if ($root_anchor eq $id) {
 102                 $subj = "<u\nid=u>$subj</u>";
 103         }
 104
 105         my $ts = _msg_date($mime);
 106         my $rv = "<pre\nid=s$midx>";
 107         $rv .= "<b\nid=$id>$subj</b>\n";
 108         $rv .= "- $from @ $ts UTC - ";
 109         $rv .= "<a\nhref=\"#s$next\">next</a>";
 110         if ($prev >= 0) {
 111                 $rv .= "/<a\nhref=\"#s$prev\">prev</a>";
 112         }
 113         $fh->write($rv .= "\n\n");
 114
 115         my ($fhref, $more_ref);
 116         my $mhref = "${path}$href/";
 117         my $more = 'permalink';
 118
 119         # show full message if it's our root message
 120         my $neq = $root_anchor ne $id;
 121         if ($neq || ($neq && $level != 0 && !$ctx->{flat})) {
 122                 $fhref = "${path}$href/f/";
 123                 $more_ref = \$more;
 124         }
 125         # scan through all parts, looking for displayable text
 126         $mime->walk_parts(sub {
 127                 index_walk($fh, $_[0], $enc, \$part_nr, $fhref, $more_ref);
 128         });
 129         $mime->body_set('');
 130
 131         my $txt = "${path}$href/raw";
 132         $rv = "\n<a\nhref=\"$mhref\">$more</a> <a\nhref=\"$txt\">raw</a> ";
 133         $rv .= html_footer($mime, 0, undef, $ctx);
 134
 135         if (defined $irt) {
 136                 unless (defined $parent_anchor) {
 137                         my $v = PublicInbox::Hval->new_msgid($irt, 1);
 138                         $v = $v->as_href;
 139                         $parent_anchor = "${path}$v/";
 140                 }
 141                 $rv .= " <a\nhref=\"$parent_anchor\">parent</a>";
 142         }
 143         if (my $pct = $state->{pct}) { # used by SearchView.pm
 144                 $rv .= " [relevance $pct->{$mid_raw}%]";
 145         } elsif ($srch) {
 146                 if ($ctx->{flat}) {
 147                         $rv .= " [<a\nhref=\"${path}$href/t/#u\">threaded</a>" .
 148                                 "|<b>flat</b>]";
 149                 } else {
 150                         $rv .= " [<b>threaded</b>|" .
 151                                 "<a\nhref=\"${path}$href/T/#u\">flat</a>]";
 152                 }
 153         }
 154         $fh->write($rv .= '</pre>');
 155 }
 156
 157 sub thread_html {
 158         my ($ctx, $foot, $srch) = @_;
 159         sub { emit_thread_html($_[0], $ctx, $foot, $srch) }
 160 }
 161
 162 # only private functions below.
 163
 164 sub emit_thread_html {
 165         my ($cb, $ctx, $foot, $srch) = @_;
 166         my $mid = $ctx->{mid};
 167         my $res = $srch->get_thread($mid);
 168         my $msgs = load_results($res);
 169         my $nr = scalar @$msgs;
 170         return missing_thread($cb, $ctx) if $nr == 0;
 171         my $flat = $ctx->{flat};
 172         my $orig_cb = $cb;
 173         my $seen = {};
 174         my $state = {
 175                 ctx => $ctx,
 176                 seen => $seen,
 177                 root_anchor => anchor_for($mid),
 178                 anchor_idx => 0,
 179                 cur_level => 0,
 180         };
 181
 182         require PublicInbox::Git;
 183         my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir});
 184         if ($flat) {
 185                 pre_anchor_entry($seen, $_) for (@$msgs);
 186                 __thread_entry(\$cb, $git, $state, $_, 0) for (@$msgs);
 187         } else {
 188                 my $th = thread_results($msgs);
 189                 thread_entry(\$cb, $git, $state, $_, 0) for $th->rootset;
 190                 if (my $max = $state->{cur_level}) {
 191                         $cb->write(('</ul></li>' x ($max - 1)) . '</ul>');
 192                 }
 193         }
 194         $git = undef;
 195         Email::Address->purge_cache;
 196
 197         # there could be a race due to a message being deleted in git
 198         # but still being in the Xapian index:
 199         return missing_thread($cb, $ctx) if ($orig_cb eq $cb);
 200
 201         my $final_anchor = $state->{anchor_idx};
 202         my $next = "<a\nid=s$final_anchor>";
 203         $next .= $final_anchor == 1 ? 'only message in' : 'end of';
 204         $next .= " thread</a>, back to <a\nhref=\"../../\">index</a>";
 205         $next .= "\ndownload thread: ";
 206         $next .= "<a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
 207         $next .= " / follow: <a\nhref=\"../t.atom\">Atom feed</a>";
 208         $cb->write('<hr /><pre>' . $next . "\n\n".
 209                         $foot .  '</pre></body></html>');
 210         $cb->close;
 211 }
 212
 213 sub index_walk {
 214         my ($fh, $part, $enc, $part_nr, $fhref, $more) = @_;
 215         my $s = add_text_body($enc, $part, $part_nr, $fhref);
 216
 217         if ($more) {
 218                 my $m = 0;
 219                 # drop the remainder of git patches, they're usually better
 220                 # to review when the full message is viewed
 221                 $s =~ s!^---+\n.*\z!!ms and $m = 1;
 222
 223                 # Drop signatures
 224                 $s =~ s/^-- \n.*\z//ms and $m = 1;
 225                 $$more = "<b>More...</b>\n\n$$more" if $m;
 226         }
 227
 228         # kill any leading or trailing whitespace lines
 229         $s =~ s/^\s*$//sgm;
 230         $s =~ s/\s+\z//s;
 231
 232         if ($s ne '') {
 233                 # kill per-line trailing whitespace
 234                 $s =~ s/[ \t]+$//sgm;
 235                 $s .= "\n" unless $s =~ /\n\z/s;
 236         }
 237         $fh->write($s);
 238 }
 239
 240 sub enc_for {
 241         my ($ct, $default) = @_;
 242         $default ||= $enc_utf8;
 243         defined $ct or return $default;
 244         my $ct_parsed = parse_content_type($ct);
 245         if ($ct_parsed) {
 246                 if (my $charset = $ct_parsed->{attributes}->{charset}) {
 247                         my $enc = find_encoding($charset);
 248                         return $enc if $enc;
 249                 }
 250         }
 251         $default;
 252 }
 253
 254 sub multipart_text_as_html {
 255         my ($mime, $full_pfx, $srch) = @_;
 256         my $rv = "";
 257         my $part_nr = 0;
 258         my $enc = enc_for($mime->header("Content-Type"));
 259
 260         # scan through all parts, looking for displayable text
 261         $mime->walk_parts(sub {
 262                 my ($part) = @_;
 263                 $rv .= add_text_body($enc, $part, \$part_nr, $full_pfx, 1);
 264         });
 265         $mime->body_set('');
 266         $rv;
 267 }
 268
 269 sub add_filename_line {
 270         my ($enc, $fn) = @_;
 271         my $len = 72;
 272         my $pad = "-";
 273         $fn = $enc->decode($fn);
 274         $len -= length($fn);
 275         $pad x= ($len/2) if ($len > 0);
 276         "$pad " . ascii_html($fn) . " $pad\n";
 277 }
 278
 279 my $LINK_RE = qr!\b((?:ftp|https?|nntp)://
 280                  [\@:\w\.-]+/
 281                  ?[\@\w\+\&\?\.\%\;/#=-]*)!x;
 282
 283 sub linkify_1 {
 284         my ($link_map, $s) = @_;
 285         $s =~ s!$LINK_RE!
 286                 my $url = $1;
 287                 # salt this, as this could be exploited to show
 288                 # links in the HTML which don't show up in the raw mail.
 289                 my $key = sha1_hex($url . $SALT);
 290                 $link_map->{$key} = $url;
 291                 'PI-LINK-'. $key;
 292         !ge;
 293         $s;
 294 }
 295
 296 sub linkify_2 {
 297         my ($link_map, $s) = @_;
 298
 299         # Added "PI-LINK-" prefix to avoid false-positives on git commits
 300         $s =~ s!\bPI-LINK-([a-f0-9]{40})\b!
 301                 my $key = $1;
 302                 my $url = $link_map->{$key};
 303                 if (defined $url) {
 304                         $url = ascii_html($url);
 305                         "<a\nhref=\"$url\">$url</a>";
 306                 } else {
 307                         # false positive or somebody tried to mess with us
 308                         $key;
 309                 }
 310         !ge;
 311         $s;
 312 }
 313
 314 sub flush_quote {
 315         my ($quot, $n, $part_nr, $full_pfx, $final, $do_anchor) = @_;
 316
 317         # n.b.: do not use <blockquote> since it screws up alignment
 318         # w.r.t. unquoted text.  Repliers may rely on pre-formatted
 319         # alignment to point out a certain word in quoted text.
 320         if ($full_pfx) {
 321                 if (!$final && scalar(@$quot) <= MAX_INLINE_QUOTED) {
 322                         # show quote inline
 323                         my %l;
 324                         my $rv = join('', map { linkify_1(\%l, $_) } @$quot);
 325                         @$quot = ();
 326                         $rv = ascii_html($rv);
 327                         return linkify_2(\%l, $rv);
 328                 }
 329
 330                 # show a short snippet of quoted text and link to full version:
 331                 @$quot = map { s/^(?:>\s*)+//gm; $_ } @$quot;
 332                 my $cur = join(' ', @$quot);
 333                 @$quot = split(/\s+/, $cur);
 334                 $cur = '';
 335                 do {
 336                         my $tmp = shift(@$quot);
 337                         my $len = length($tmp) + length($cur);
 338                         if ($len > MAX_TRUNC_LEN) {
 339                                 @$quot = ();
 340                         } else {
 341                                 $cur .= $tmp . ' ';
 342                         }
 343                 } while (@$quot && length($cur) < MAX_TRUNC_LEN);
 344                 @$quot = ();
 345                 $cur =~ s/ \z/ .../s;
 346                 $cur = ascii_html($cur);
 347                 my $nr = ++$$n;
 348                 "&gt; [<a\nhref=\"$full_pfx#q${part_nr}_$nr\">$cur</a>]\n";
 349         } else {
 350                 # show everything in the full version with anchor from
 351                 # short version (see above)
 352                 my %l;
 353                 my $rv .= join('', map { linkify_1(\%l, $_) } @$quot);
 354                 @$quot = ();
 355                 $rv = ascii_html($rv);
 356                 return linkify_2(\%l, $rv) unless $do_anchor;
 357                 my $nr = ++$$n;
 358                 "<a\nid=q${part_nr}_$nr></a>" . linkify_2(\%l, $rv);
 359         }
 360 }
 361
 362 sub add_text_body {
 363         my ($enc_msg, $part, $part_nr, $full_pfx, $do_anchor) = @_;
 364         return '' if $part->subparts;
 365
 366         my $ct = $part->content_type;
 367         # account for filter bugs...
 368         if (defined $ct && $ct =~ m!\btext/x?html\b!i) {
 369                 $part->body_set('');
 370                 return '';
 371         }
 372         my $enc = enc_for($ct, $enc_msg);
 373         my $n = 0;
 374         my $nr = 0;
 375         my $s = $part->body;
 376         $part->body_set('');
 377         $s = $enc->decode($s);
 378         my @lines = split(/^/m, $s);
 379         $s = '';
 380
 381         if ($$part_nr > 0) {
 382                 my $fn = $part->filename;
 383                 defined($fn) or $fn = "part #" . ($$part_nr + 1);
 384                 $s .= add_filename_line($enc, $fn);
 385         }
 386
 387         my @quot;
 388         while (defined(my $cur = shift @lines)) {
 389                 if ($cur !~ /^>/) {
 390                         # show the previously buffered quote inline
 391                         if (scalar @quot) {
 392                                 $s .= flush_quote(\@quot, \$n, $$part_nr,
 393                                                   $full_pfx, 0, $do_anchor);
 394                         }
 395
 396                         # regular line, OK
 397                         my %l;
 398                         $cur = linkify_1(\%l, $cur);
 399                         $cur = ascii_html($cur);
 400                         $s .= linkify_2(\%l, $cur);
 401                 } else {
 402                         push @quot, $cur;
 403                 }
 404         }
 405         if (scalar @quot) {
 406                 $s .= flush_quote(\@quot, \$n, $$part_nr, $full_pfx, 1,
 407                                   $do_anchor);
 408         }
 409         $s .= "\n" unless $s =~ /\n\z/s;
 410         ++$$part_nr;
 411         $s;
 412 }
 413
 414 sub headers_to_html_header {
 415         my ($mime, $full_pfx, $ctx) = @_;
 416         my $srch = $ctx->{srch} if $ctx;
 417         my $rv = "";
 418         my @title;
 419         my $header_obj = $mime->header_obj;
 420         my $mid = $header_obj->header('Message-ID');
 421         $mid = PublicInbox::Hval->new_msgid($mid);
 422         foreach my $h (qw(From To Cc Subject Date)) {
 423                 my $v = $header_obj->header($h);
 424                 defined($v) && ($v ne '') or next;
 425                 $v = PublicInbox::Hval->new_oneline($v);
 426
 427                 if ($h eq 'From') {
 428                         my @from = Email::Address->parse($v->raw);
 429                         $title[1] = ascii_html($from[0]->name);
 430                 } elsif ($h eq 'Subject') {
 431                         $title[0] = $v->as_html;
 432                         if ($srch) {
 433                                 $rv .= "$h: <b\nid=t>";
 434                                 $rv .= $v->as_html . "</b>\n";
 435                                 next;
 436                         }
 437                 }
 438                 $rv .= "$h: " . $v->as_html . "\n";
 439
 440         }
 441         $rv .= 'Message-ID: &lt;' . $mid->as_html . '&gt; ';
 442         my $upfx = $full_pfx ? '' : '../';
 443         $rv .= "(<a\nhref=\"${upfx}raw\">raw</a>)\n";
 444         my $atom;
 445         if ($srch) {
 446                 thread_inline(\$rv, $ctx, $mime, $upfx);
 447
 448                 $atom = qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
 449                         qq!href="${upfx}t.atom"\ntype="application/atom+xml"/>!;
 450         } else {
 451                 $rv .= _parent_headers_nosrch($header_obj);
 452                 $atom = '';
 453         }
 454         $rv .= "\n";
 455
 456         ("<html><head><title>".  join(' - ', @title) . "</title>$atom".
 457          PublicInbox::Hval::STYLE . "</head><body><pre>" . $rv);
 458 }
 459
 460 sub thread_inline {
 461         my ($dst, $ctx, $cur, $upfx) = @_;
 462         my $srch = $ctx->{srch};
 463         my $mid = mid_clean($cur->header('Message-ID'));
 464         my $res = $srch->get_thread($mid);
 465         my $nr = $res->{total};
 466         my $expand = "<a\nhref=\"${upfx}t/#u\">expand</a> " .
 467                         "/ <a\nhref=\"${upfx}t.mbox.gz\">mbox.gz</a>";
 468
 469         $$dst .= 'Thread: ';
 470         my $parent = in_reply_to($cur);
 471         if ($nr <= 1) {
 472                 if (defined $parent) {
 473                         $$dst .= "($expand)\n ";
 474                         $$dst .= ghost_parent("$upfx../", $parent) . "\n";
 475                 } else {
 476                         $$dst .= "[no followups, yet] ($expand)\n";
 477                 }
 478                 $ctx->{next_msg} = undef;
 479                 $ctx->{parent_msg} = $parent;
 480                 return;
 481         }
 482
 483         $$dst .= "~$nr messages ($expand";
 484         if ($nr > MAX_INLINE_QUOTED) {
 485                 $$dst .= qq! / <a\nhref="#b">[scroll down]</a>!;
 486         }
 487         $$dst .= ")\n";
 488
 489         my $subj = $srch->subject_path($cur->header('Subject'));
 490         my $state = {
 491                 seen => { $subj => 1 },
 492                 srch => $srch,
 493                 cur => $mid,
 494                 parent_cmp => defined $parent ? $parent : '',
 495                 parent => $parent,
 496                 prev_attr => '',
 497                 prev_level => 0,
 498         };
 499         for (thread_results(load_results($res))->rootset) {
 500                 inline_dump($dst, $state, $upfx, $_, 0);
 501         }
 502         $$dst .= "<a\nid=b></a>"; # anchor for body start
 503         $ctx->{next_msg} = $state->{next_msg};
 504         $ctx->{parent_msg} = $state->{parent};
 505 }
 506
 507 sub _parent_headers_nosrch {
 508         my ($header_obj) = @_;
 509         my $rv = '';
 510
 511         my $irt = in_reply_to($header_obj);
 512         if (defined $irt) {
 513                 my $v = PublicInbox::Hval->new_msgid($irt, 1);
 514                 my $html = $v->as_html;
 515                 my $href = $v->as_href;
 516                 $rv .= "In-Reply-To: &lt;";
 517                 $rv .= "<a\nhref=\"../$href/\">$html</a>&gt;\n";
 518         }
 519
 520         my $refs = $header_obj->header('References');
 521         if ($refs) {
 522                 # avoid redundant URLs wasting bandwidth
 523                 my %seen;
 524                 $seen{$irt} = 1 if defined $irt;
 525                 my @refs;
 526                 my @raw_refs = ($refs =~ /<([^>]+)>/g);
 527                 foreach my $ref (@raw_refs) {
 528                         next if $seen{$ref};
 529                         $seen{$ref} = 1;
 530                         push @refs, linkify_ref_nosrch($ref);
 531                 }
 532
 533                 if (@refs) {
 534                         $rv .= 'References: '. join(' ', @refs) . "\n";
 535                 }
 536         }
 537         $rv;
 538 }
 539
 540 sub html_footer {
 541         my ($mime, $standalone, $full_pfx, $ctx) = @_;
 542         my %cc; # everyone else
 543         my $to; # this is the From address
 544
 545         foreach my $h (qw(From To Cc)) {
 546                 my $v = $mime->header($h);
 547                 defined($v) && ($v ne '') or next;
 548                 my @addrs = Email::Address->parse($v);
 549                 foreach my $recip (@addrs) {
 550                         my $address = $recip->address;
 551                         my $dst = lc($address);
 552                         $cc{$dst} ||= $address;
 553                         $to ||= $dst;
 554                 }
 555         }
 556         Email::Address->purge_cache if $standalone;
 557
 558         my $subj = $mime->header('Subject') || '';
 559         $subj = "Re: $subj" unless $subj =~ /\bRe:/i;
 560         my $mid = $mime->header('Message-ID');
 561         my $irt = uri_escape_utf8($mid);
 562         delete $cc{$to};
 563         $to = uri_escape_utf8($to);
 564         $subj = uri_escape_utf8($subj);
 565
 566         my $cc = uri_escape_utf8(join(',', sort values %cc));
 567         my $href = "mailto:$to?In-Reply-To=$irt&Cc=${cc}&Subject=$subj";
 568         $href =~ s/%20/+/g;
 569
 570         my $srch = $ctx->{srch} if $ctx;
 571         my $upfx = $full_pfx ? '../' : '../../';
 572         my $tpfx = $full_pfx ? '' : '../';
 573         my $idx = $standalone ? " <a\nhref=\"$upfx\">index</a>" : '';
 574
 575         if ($srch && $standalone) {
 576                 $idx .= qq{ / follow: <a\nhref="${tpfx}t.atom">Atom feed</a>\n};
 577         }
 578         if ($idx && $srch) {
 579                 my $p = $ctx->{parent_msg};
 580                 my $next = $ctx->{next_msg};
 581                 if ($p) {
 582                         $p = PublicInbox::Hval->new_oneline($p);
 583                         $p = $p->as_href;
 584                         $irt = "<a\nhref=\"$upfx$p/\">parent</a> ";
 585                 } else {
 586                         $irt = ' ' x length('parent ');
 587                 }
 588                 if ($next) {
 589                         $irt .= "<a\nhref=\"$upfx$next/\">next</a> ";
 590                 } else {
 591                         $irt .= ' ' x length('next ');
 592                 }
 593                 if ($p || $next) {
 594                         $irt .= "<a\nhref=\"${tpfx}t/#u\">thread</a> ";
 595                 } else {
 596                         $irt .= ' ' x length('thread ');
 597                 }
 598         } else {
 599                 $irt = '';
 600         }
 601
 602         "$irt<a\nhref=\"" . ascii_html($href) . '">reply</a>' . $idx;
 603 }
 604
 605 sub linkify_ref_nosrch {
 606         my $v = PublicInbox::Hval->new_msgid($_[0], 1);
 607         my $html = $v->as_html;
 608         my $href = $v->as_href;
 609         "&lt;<a\nhref=\"../$href/\">$html</a>&gt;";
 610 }
 611
 612 sub anchor_for {
 613         my ($msgid) = @_;
 614         my $id = $msgid;
 615         if ($id !~ /\A[a-f0-9]{40}\z/) {
 616                 $id = id_compress(mid_clean($id), 1);
 617         }
 618         'm' . $id;
 619 }
 620
 621 sub thread_html_head {
 622         my ($cb, $header, $state) = @_;
 623         $$cb = $$cb->([200, ['Content-Type'=> 'text/html; charset=UTF-8']]);
 624
 625         my $s = PublicInbox::Hval->new_oneline($header->header('Subject'));
 626         $s = $s->as_html;
 627         $$cb->write("<html><head><title>$s</title>".
 628                 qq{<link\nrel=alternate\ntitle="Atom feed"\n} .
 629                 qq!href="../t.atom"\ntype="application/atom+xml"/>! .
 630                 PublicInbox::Hval::STYLE .
 631                 "</head><body>");
 632 }
 633
 634 sub pre_anchor_entry {
 635         my ($seen, $mime) = @_;
 636         my $id = anchor_for($mime->header('Message-ID'));
 637         $seen->{$id} = "#$id"; # save the anchor for children, later
 638 }
 639
 640 sub ghost_parent {
 641         my ($upfx, $mid) = @_;
 642         # 'subject dummy' is used internally by Mail::Thread
 643         return '[no common parent]' if ($mid eq 'subject dummy');
 644
 645         $mid = PublicInbox::Hval->new_msgid($mid);
 646         my $href = $mid->as_href;
 647         my $html = $mid->as_html;
 648         qq{[parent not found: &lt;<a\nhref="$upfx$href/">$html</a>&gt;]};
 649 }
 650
 651 sub thread_adj_level {
 652         my ($fh, $state, $level) = @_;
 653
 654         my $max = $state->{cur_level};
 655         if ($level <= 0) {
 656                 return '' if $max == 0; # flat output
 657
 658                 # reset existing lists
 659                 my $x = $max > 1 ? ('</ul></li>' x ($max - 1)) : '';
 660                 $fh->write($x . '</ul>');
 661                 $state->{cur_level} = 0;
 662                 return '';
 663         }
 664         if ($level == $max) { # continue existing list
 665                 $fh->write('<li>');
 666         } elsif ($level < $max) {
 667                 my $x = $max > 1 ? ('</ul></li>' x ($max - $level)) : '';
 668                 $fh->write($x .= '<li>');
 669                 $state->{cur_level} = $level;
 670         } else { # ($level > $max) # start a new level
 671                 $state->{cur_level} = $level;
 672                 $fh->write(($max ? '<li>' : '') . '<ul><li>');
 673         }
 674         '</li>';
 675 }
 676
 677 sub ghost_flush {
 678         my ($fh, $state, $upfx, $mid, $level) = @_;
 679
 680         my $end = thread_adj_level($fh, $state, $level);
 681         $fh->write('<pre>'. ghost_parent($upfx, $mid) .  '</pre>' . $end);
 682 }
 683
 684 sub __thread_entry {
 685         my ($cb, $git, $state, $mime, $level) = @_;
 686
 687         # lazy load the full message from mini_mime:
 688         $mime = eval {
 689                 my $path = mid2path(mid_clean($mime->header('Message-ID')));
 690                 Email::MIME->new($git->cat_file('HEAD:'.$path));
 691         } or return;
 692
 693         if ($state->{anchor_idx} == 0) {
 694                 thread_html_head($cb, $mime, $state, $level);
 695         }
 696         my $fh = $$cb;
 697         if (my $ghost = delete $state->{ghost}) {
 698                 # n.b. ghost messages may only be parents, not children
 699                 foreach my $g (@$ghost) {
 700                         ghost_flush($fh, $state, '../../', @$g);
 701                 }
 702         }
 703         my $end = thread_adj_level($fh, $state, $level);
 704         index_entry($fh, $mime, $level, $state);
 705         $fh->write($end) if $end;
 706
 707         1;
 708 }
 709
 710 sub indent_for {
 711         my ($level) = @_;
 712         INDENT x ($level - 1);
 713 }
 714
 715 sub __ghost_prepare {
 716         my ($state, $node, $level) = @_;
 717         my $ghost = $state->{ghost} ||= [];
 718         push @$ghost, [ $node->messageid, $level ];
 719 }
 720
 721 sub thread_entry {
 722         my ($cb, $git, $state, $node, $level) = @_;
 723         return unless $node;
 724         if (my $mime = $node->message) {
 725                 unless (__thread_entry($cb, $git, $state, $mime, $level)) {
 726                         __ghost_prepare($state, $node, $level);
 727                 }
 728         } else {
 729                 __ghost_prepare($state, $node, $level);
 730         }
 731
 732         thread_entry($cb, $git, $state, $node->child, $level + 1);
 733         thread_entry($cb, $git, $state, $node->next, $level);
 734 }
 735
 736 sub load_results {
 737         my ($res) = @_;
 738
 739         [ map { $_->mini_mime } @{delete $res->{msgs}} ];
 740 }
 741
 742 sub msg_timestamp {
 743         my ($mime) = @_;
 744         my $ts = eval { str2time($mime->header('Date')) };
 745         defined($ts) ? $ts : 0;
 746 }
 747
 748 sub thread_results {
 749         my ($msgs, $nosubject) = @_;
 750         require PublicInbox::Thread;
 751         my $th = PublicInbox::Thread->new(@$msgs);
 752         no warnings 'once';
 753         $Mail::Thread::nosubject = $nosubject;
 754         $th->thread;
 755         $th->order(*sort_ts);
 756         $th
 757 }
 758
 759 sub missing_thread {
 760         my ($cb, $ctx) = @_;
 761         require PublicInbox::ExtMsg;
 762
 763         $cb->(PublicInbox::ExtMsg::ext_msg($ctx))
 764 }
 765
 766 sub _msg_date {
 767         my ($mime) = @_;
 768         my $ts = $mime->header('X-PI-TS') || msg_timestamp($mime);
 769         fmt_ts($ts);
 770 }
 771
 772 sub fmt_ts { POSIX::strftime('%Y-%m-%d %k:%M', gmtime($_[0])) }
 773
 774 sub _inline_header {
 775         my ($dst, $state, $upfx, $mime, $level) = @_;
 776         my $dot = $level == 0 ? '' : '` ';
 777
 778         my $cur = $state->{cur};
 779         my $mid = mid_clean($mime->header('Message-ID'));
 780         my $f = $mime->header('X-PI-From');
 781         my $d = _msg_date($mime);
 782         $f = PublicInbox::Hval->new_oneline($f)->as_html;
 783         my $pfx = ' ' . $d . ' ' . indent_for($level);
 784         my $attr = $f;
 785         $state->{first_level} ||= $level;
 786
 787         if ($attr ne $state->{prev_attr} || $state->{prev_level} > $level) {
 788                 $state->{prev_attr} = $attr;
 789         } else {
 790                 $attr = '';
 791         }
 792         $state->{prev_level} = $level;
 793
 794         if ($cur) {
 795                 if ($cur eq $mid) {
 796                         delete $state->{cur};
 797                         $$dst .= "$pfx$dot<b><a\nid=r\nhref=\"#b\">".
 798                                  "$attr [this message]</a></b>\n";
 799
 800                         return;
 801                 }
 802         } else {
 803                 $state->{next_msg} ||= $mid;
 804         }
 805
 806         # Subject is never undef, this mail was loaded from
 807         # our Xapian which would've resulted in '' if it were
 808         # really missing (and Filter rejects empty subjects)
 809         my $s = $mime->header('Subject');
 810         my $h = $state->{srch}->subject_path($s);
 811         if ($state->{seen}->{$h}) {
 812                 $s = undef;
 813         } else {
 814                 $state->{seen}->{$h} = 1;
 815                 $s = PublicInbox::Hval->new($s);
 816                 $s = $s->as_html;
 817         }
 818         my $m = PublicInbox::Hval->new_msgid($mid);
 819         $m = $upfx . '../' . $m->as_href . '/';
 820         if (defined $s) {
 821                 $$dst .= "$pfx$dot<a\nhref=\"$m\">$s</a> $attr\n";
 822         } else {
 823                 $$dst .= "$pfx$dot<a\nhref=\"$m\">$f</a>\n";
 824         }
 825 }
 826
 827 sub inline_dump {
 828         my ($dst, $state, $upfx, $node, $level) = @_;
 829         return unless $node;
 830         if (my $mime = $node->message) {
 831                 my $mid = mid_clean($mime->header('Message-ID'));
 832                 if ($mid eq $state->{parent_cmp}) {
 833                         $state->{parent} = $mid;
 834                 }
 835                 _inline_header($dst, $state, $upfx, $mime, $level);
 836         } else {
 837                 my $dot = $level == 0 ? '' : '` ';
 838                 my $pfx = (' ' x length(' 1970-01-01 13:37 ')).
 839                         indent_for($level) . $dot;
 840                 $$dst .= $pfx;
 841                 $$dst .= ghost_parent("$upfx../", $node->messageid) . "\n";
 842         }
 843         inline_dump($dst, $state, $upfx, $node->child, $level+1);
 844         inline_dump($dst, $state, $upfx, $node->next, $level);
 845 }
 846
 847 sub sort_ts {
 848         sort {
 849                 (eval { $a->topmost->message->header('X-PI-TS') } || 0) <=>
 850                 (eval { $b->topmost->message->header('X-PI-TS') } || 0)
 851         } @_;
 852 }
 853
 854 sub rsort_ts {
 855         sort {
 856                 (eval { $b->topmost->message->header('X-PI-TS') } || 0) <=>
 857                 (eval { $a->topmost->message->header('X-PI-TS') } || 0)
 858         } @_;
 859 }
 860
 861 # accumulate recent topics if search is supported
 862 # returns 1 if done, undef if not
 863 sub add_topic {
 864         my ($state, $node, $level) = @_;
 865         return unless $node;
 866         my $child_adjust = 1;
 867
 868         if (my $x = $node->message) {
 869                 $x = $x->header_obj;
 870                 my $subj;
 871
 872                 $subj = $x->header('Subject');
 873                 $subj = $state->{srch}->subject_normalized($subj);
 874
 875                 if (++$state->{subjs}->{$subj} == 1) {
 876                         push @{$state->{order}}, [ $level, $subj ];
 877                 }
 878
 879                 my $mid = mid_clean($x->header('Message-ID'));
 880
 881                 my $ts = $x->header('X-PI-TS');
 882                 my $exist = $state->{latest}->{$subj};
 883                 if (!$exist || $exist->[1] < $ts) {
 884                         $state->{latest}->{$subj} = [ $mid, $ts ];
 885                 }
 886         } else {
 887                 # ghost message, do not bump level
 888                 $child_adjust = 0;
 889         }
 890
 891         add_topic($state, $node->child, $level + $child_adjust);
 892         add_topic($state, $node->next, $level);
 893 }
 894
 895 sub dump_topics {
 896         my ($state) = @_;
 897         my $order = $state->{order};
 898         my $subjs = $state->{subjs};
 899         my $latest = $state->{latest};
 900         return "\n[No topics in range]</pre>" unless (scalar @$order);
 901         my $dst = '';
 902         my $pfx;
 903         my $prev = 0;
 904         my $prev_attr = '';
 905         while (defined(my $info = shift @$order)) {
 906                 my ($level, $subj) = @$info;
 907                 my $n = delete $subjs->{$subj};
 908                 my ($mid, $ts) = @{delete $latest->{$subj}};
 909                 $mid = PublicInbox::Hval->new_msgid($mid)->as_href;
 910                 $subj = PublicInbox::Hval->new($subj)->as_html;
 911                 $pfx = indent_for($level);
 912                 my $nl = $level == $prev ? "\n" : '';
 913                 my $dot = $level == 0 ? '' : '` ';
 914                 $dst .= "$nl$pfx$dot<a\nhref=\"$mid/t/#u\"><b>$subj</b></a>\n";
 915
 916                 my $attr;
 917                 $ts = fmt_ts($ts);
 918                 $attr = " $ts UTC";
 919
 920                 # $n isn't the total number of posts on the topic,
 921                 # just the number of posts in the current results
 922                 # window, so leave it unlabeled
 923                 $n = $n == 1 ? '' : " ($n+ messages)";
 924
 925                 if ($level == 0 || $attr ne $prev_attr) {
 926                         my $mbox = qq(<a\nhref="$mid/t.mbox.gz">mbox.gz</a>);
 927                         my $atom = qq(<a\nhref="$mid/t.atom">Atom</a>);
 928                         $pfx .= INDENT if $level > 0;
 929                         $dst .= $pfx . $attr . $n . " - $mbox / $atom\n";
 930                         $prev_attr = $attr;
 931                 }
 932         }
 933         $dst .= '</pre>';
 934 }
 935
 936 sub emit_index_topics {
 937         my ($state, $fh) = @_;
 938         my $off = $state->{ctx}->{cgi}->param('o');
 939         $off = 0 unless defined $off;
 940         $state->{order} = [];
 941         $state->{subjs} = {};
 942         $state->{latest} = {};
 943         my $max = 25;
 944         my %opts = ( offset => int $off, limit => $max * 4 );
 945         while (scalar @{$state->{order}} < $max) {
 946                 my $res = $state->{srch}->query('', \%opts);
 947                 my $nr = scalar @{$res->{msgs}} or last;
 948
 949                 for (rsort_ts(thread_results(load_results($res), 1)->rootset)) {
 950                         add_topic($state, $_, 0);
 951                 }
 952                 $opts{offset} += $nr;
 953         }
 954
 955         $fh->write(dump_topics($state));
 956         $opts{offset};
 957 }
 958
 959 1;