1 # Copyright (C) 2014-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Used for displaying the HTML web interface.
5 # See Documentation/design_www.txt for this.
6 package PublicInbox::View;
9 use bytes (); # only for bytes::length
10 use PublicInbox::MsgTime qw(msg_datestamp);
11 use PublicInbox::Hval qw(ascii_html obfuscate_addrs prurl);
12 use PublicInbox::Linkify;
13 use PublicInbox::MID qw/id_compress mid_escape mids mids_for_index references/;
14 use PublicInbox::MsgIter;
15 use PublicInbox::Address;
16 use PublicInbox::WwwStream;
17 use PublicInbox::Reply;
18 use PublicInbox::ViewDiff qw(flush_diff);
19 use POSIX qw(strftime);
20 use Time::Local qw(timegm);
21 use PublicInbox::SearchMsg qw(subject_normalized);
22 use constant COLS => 72;
23 use constant INDENT => ' ';
24 use constant TCHILD => '` ';
25 sub th_pfx ($) { $_[0] == 0 ? '' : TCHILD };
29 my $more = $ctx->{more};
31 # $more cannot be true w/o $smsg being defined:
32 my $upfx = $more ? '../'.mid_escape($ctx->{smsg}->mid).'/' : '';
34 multipart_text_as_html(delete $ctx->{mime}, $upfx,
36 } elsif ($more && @$more) {
38 msg_html_more($ctx, $more, $nr);
39 } elsif ($nr == $ctx->{end_nr}) {
40 # fake an EOF if generating the footer fails;
41 # we want to at least show the message if something
44 my $hdr = delete($ctx->{hdr});
45 '<pre>' . html_footer($hdr, 1, $ctx) .
46 '</pre>' . msg_reply($ctx, $hdr)
53 # public functions: (unstable)
56 my ($ctx, $mime, $more, $smsg) = @_;
57 my $ibx = $ctx->{-inbox};
58 $ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
59 my $hdr = $ctx->{hdr} = $mime->header_obj;
60 $ctx->{tip} = _msg_html_prepare($hdr, $ctx, $more, 0);
65 PublicInbox::WwwStream->response($ctx, 200, \&msg_html_i);
70 my $mid = $ctx->{mid};
71 my $ibx = $ctx->{-inbox};
74 if (my $over = $ibx->over) {
76 $smsg = $over->next_by_mid($mid, \$id, \$prev);
77 $first = $ibx->msg_by_smsg($smsg) if $smsg;
79 my $next = $over->next_by_mid($mid, \$id, \$prev);
80 $more = [ $id, $prev, $next ] if $next;
84 $first = $ibx->msg_by_mid($mid) or return;
86 msg_html($ctx, PublicInbox::MIME->new($first), $more, $smsg);
90 my ($ctx, $more, $nr) = @_;
92 my ($id, $prev, $smsg) = @$more;
93 my $mid = $ctx->{mid};
94 my $ibx = $ctx->{-inbox};
95 $smsg = $ibx->smsg_mime($smsg);
96 my $next = $ibx->over->next_by_mid($mid, \$id, \$prev);
97 @$more = $next ? ($id, $prev, $next) : ();
99 my $upfx = '../' . mid_escape($smsg->mid) . '/';
100 my $mime = delete $smsg->{mime};
101 _msg_html_prepare($mime->header_obj, $ctx, $more, $nr) .
102 multipart_text_as_html($mime, $upfx, $ctx) .
109 warn "Error lookup up additional messages: $@\n";
110 $str = '<pre>Error looking up additional messages</pre>';
115 # /$INBOX/$MESSAGE_ID/#R
117 my ($ctx, $hdr) = @_;
119 'https://kernel.org/pub/software/scm/git/docs/git-send-email.html';
121 'https://en.wikipedia.org/wiki/Posting_style#Interleaved_style';
124 my $ibx = $ctx->{-inbox};
125 if (my $url = $ibx->{infourl}) {
126 $url = prurl($ctx->{env}, $url);
127 $info = qq(\n List information: <a\nhref="$url">$url</a>\n);
130 my ($arg, $link, $reply_to_all) =
131 PublicInbox::Reply::mailto_arg_link($ibx, $hdr);
132 if (ref($arg) eq 'SCALAR') {
133 return '<pre id=R>'.ascii_html($$arg).'</pre>';
136 # mailto: link only works if address obfuscation is disabled
140 * If your mail client supports setting the <b>In-Reply-To</b> header
141 via mailto: links, try the <a
142 href="$link">mailto: link</a>
146 push @$arg, '/path/to/YOUR_REPLY';
147 $arg = ascii_html(join(" \\\n ", '', @$arg));
150 id=R><b>Reply instructions:</b>
152 You may reply publicly to <a
153 href=#t>this message</a> via plain-text email
154 using any one of the following methods:
156 * Save the following mbox file, import it into your mail client,
157 and $reply_to_all from there: <a
160 Avoid top-posting and favor interleaved quoting:
162 href="$p_url">$p_url</a>
164 * Reply using the <b>--to</b>, <b>--cc</b>, and <b>--in-reply-to</b>
165 switches of git-send-email(1):
170 href="$se_url">$se_url</a>
177 my $refs = references($hdr);
181 sub fold_addresses ($) {
182 return $_[0] if length($_[0]) <= COLS;
183 # try to fold on commas after non-word chars before $lim chars,
184 # Try to get the "," preceeded by ">" or ")", but avoid folding
185 # on the comma where somebody uses "Lastname, Firstname".
186 # We also try to keep the last and penultimate addresses in
187 # the list on the same line if possible, hence the extra \z
188 # Fall back to folding on spaces at $lim + 1 chars
189 my $lim = COLS - 8; # 8 = "\t" display width
190 my $too_long = $lim + 1;
191 $_[0] =~ s/\s*\z//s; # Email::Simple doesn't strip trailing spaces
193 ($_[0] =~ /(.{0,$lim}\W(?:,|\z)|
196 .{$too_long,}?)(?:\s|\z)/xgo));
199 sub _hdr_names_html ($$) {
200 my ($hdr, $field) = @_;
201 my @vals = $hdr->header($field) or return '';
202 ascii_html(join(', ', PublicInbox::Address::names(join(',', @vals))));
206 my ($nr, $singular, $plural) = @_;
207 return "0 $plural" if $nr == 0;
208 $nr == 1 ? "$nr $singular" : "$nr $plural";
211 # human-friendly format
212 sub fmt_ts ($) { strftime('%Y-%m-%d %k:%M', gmtime($_[0])) }
214 # this is already inside a <pre>
216 my ($smsg, $ctx, $more) = @_;
217 my $subj = $smsg->subject;
218 my $mid_raw = $smsg->mid;
219 my $id = id_compress($mid_raw, 1);
222 my $root_anchor = $ctx->{root_anchor} || '';
224 my $obfs_ibx = $ctx->{-obfs_ibx};
226 $subj = '(no subject)' if $subj eq '';
227 my $rv = "<a\nhref=#e$id\nid=m$id>*</a> ";
228 $subj = '<b>'.ascii_html($subj).'</b>';
229 obfuscate_addrs($obfs_ibx, $subj) if $obfs_ibx;
230 $subj = "<u\nid=u>$subj</u>" if $root_anchor eq $id_m;
232 $rv .= _th_index_lite($mid_raw, \$irt, $id, $ctx);
234 my $ds = $smsg->ds; # for v1 non-Xapian/SQLite users
235 # deleting {mime} is critical to memory use,
236 # the rest of the fields saves about 400K as we iterate across 1K msgs
237 my ($mime) = delete @$smsg{qw(mime ds ts blob subject)};
239 my $hdr = $mime->header_obj;
240 my $from = _hdr_names_html($hdr, 'From');
241 obfuscate_addrs($obfs_ibx, $from) if $obfs_ibx;
242 $rv .= "From: $from @ ".fmt_ts($ds)." UTC";
243 my $upfx = $ctx->{-upfx};
244 my $mhref = $upfx . mid_escape($mid_raw) . '/';
245 $rv .= qq{ (<a\nhref="$mhref">permalink</a> / };
246 $rv .= qq{<a\nhref="${mhref}raw">raw</a>)\n};
247 my $to = fold_addresses(_hdr_names_html($hdr, 'To'));
248 my $cc = fold_addresses(_hdr_names_html($hdr, 'Cc'));
249 my ($tlen, $clen) = (length($to), length($cc));
251 if (($tlen + $clen) > COLS) {
252 $to_cc .= ' To: '.$to."\n" if $tlen;
253 $to_cc .= ' Cc: '.$cc."\n" if $clen;
256 $to_cc .= ' To: '.$to;
257 $to_cc .= '; <b>+Cc:</b> '.$cc if $clen;
259 $to_cc .= ' Cc: '.$cc if $clen;
263 obfuscate_addrs($obfs_ibx, $to_cc) if $obfs_ibx;
266 my $mapping = $ctx->{mapping};
267 if (!$mapping && (defined($irt) || defined($irt = in_reply_to($hdr)))) {
268 my $mirt = PublicInbox::Hval->new_msgid($irt);
269 my $href = $upfx . $mirt->{href}. '/';
270 my $html = $mirt->as_html;
271 $rv .= qq(In-Reply-To: <<a\nhref="$href">$html</a>>\n)
275 # scan through all parts, looking for displayable text
276 $ctx->{mhref} = $mhref;
278 msg_iter($mime, \&add_text_body, $ctx, 1);
282 $rv .= "\n<a\nhref=#$id_m\nid=e$id>^</a> ".
283 "<a\nhref=\"$mhref\">permalink</a>" .
284 " <a\nhref=\"${mhref}raw\">raw</a>" .
285 " <a\nhref=\"${mhref}#R\">reply</a>";
288 if (defined(my $pct = $smsg->{pct})) { # used by SearchView.pm
289 $rv .= "\t[relevance $pct%]";
292 my $nested = 'nested';
297 $flat = "<b>$flat</b>";
299 $nested = "<b>$nested</b>";
301 $rv .= "\t[<a\nhref=\"${mhref}T/#u\">$flat</a>";
302 $rv .= "|<a\nhref=\"${mhref}t/#u\">$nested</a>]";
303 $rv .= " <a\nhref=#r$id>$ctx->{s_nr}</a>";
308 $rv .= $more ? '</pre><hr><pre>' : '</pre>' if $hr;
312 sub pad_link ($$;$) {
313 my ($mid, $level, $s) = @_;
315 my $id = id_compress($mid, 1);
316 (' 'x19).indent_for($level).th_pfx($level)."<a\nhref=#r$id>($s)</a>\n";
320 my ($mid_raw, $irt, $id, $ctx) = @_;
322 my $mapping = $ctx->{mapping} or return $rv;
324 my $mid_map = $mapping->{$mid_raw};
326 return 'public-inbox BUG: '.ascii_html($mid_raw).' not mapped';
327 my ($attr, $node, $idx, $level) = @$mid_map;
328 my $children = $node->{children};
329 my $nr_c = scalar @$children;
332 if (my $smsg = $node->{smsg}) {
333 # delete saves about 200KB on a 1K message thread
334 if (my $refs = delete $smsg->{references}) {
335 ($$irt) = ($refs =~ m/<([^>]+)>\z/);
338 my $irt_map = $mapping->{$$irt} if defined $$irt;
339 if (defined $irt_map) {
340 $siblings = $irt_map->[1]->{children};
341 $nr_s = scalar(@$siblings) - 1;
342 $rv .= $pad . $irt_map->[0];
344 my $prev = $siblings->[$idx - 1];
345 my $pmid = $prev->{id};
347 my $s = ($idx - 1). ' preceding siblings ...';
348 $rv .= pad_link($pmid, $level, $s);
349 } elsif ($idx == 2) {
350 my $ppmid = $siblings->[0]->{id};
351 $rv .= $pad . $mapping->{$ppmid}->[0];
353 $rv .= $pad . $mapping->{$pmid}->[0];
356 my $s_s = nr_to_s($nr_s, 'sibling', 'siblings');
357 my $s_c = nr_to_s($nr_c, 'reply', 'replies');
358 $attr =~ s!\n\z!</b>\n!s;
359 $attr =~ s!<a\nhref.*</a> !!s; # no point in duplicating subject
360 $attr =~ s!<a\nhref=[^>]+>([^<]+)</a>!$1!s; # no point linking to self
363 my $cmid = $children->[0]->{id};
364 $rv .= $pad . $mapping->{$cmid}->[0];
366 my $s = ($nr_c - 1). ' more replies';
367 $rv .= pad_link($cmid, $level + 1, $s);
368 } elsif (my $cn = $children->[1]) {
369 $rv .= $pad . $mapping->{$cn->{id}}->[0];
373 my $next = $siblings->[$idx+1] if $siblings && $idx >= 0;
375 my $nmid = $next->{id};
376 $rv .= $pad . $mapping->{$nmid}->[0];
377 my $nnext = $nr_s - $idx;
379 my $s = ($nnext - 1).' subsequent siblings';
380 $rv .= pad_link($nmid, $level, $s);
381 } elsif (my $nn = $siblings->[$idx + 2]) {
382 $rv .= $pad . $mapping->{$nn->{id}}->[0];
385 $rv .= $pad ."<a\nhref=#r$id>$s_s, $s_c; $ctx->{s_nr}</a>\n";
389 my ($rootset, $ctx, $cb) = @_;
390 my @q = map { (0, $_, -1) } @$rootset;
392 my ($level, $node, $i) = splice(@q, 0, 3);
393 defined $node or next;
394 $cb->($ctx, $level, $node, $i) or return;
397 unshift @q, map { ($level, $_, $i++) } @{$node->{children}};
402 my ($ctx, $level, $node, $idx) = @_;
403 $ctx->{mapping}->{$node->{id}} = [ '', $node, $idx, $level ];
404 skel_dump($ctx, $level, $node);
407 sub thread_index_entry {
408 my ($ctx, $level, $smsg) = @_;
409 my ($beg, $end) = thread_adj_level($ctx, $level);
410 $beg . '<pre>' . index_entry($smsg, $ctx, 0) . '</pre>' . $end;
413 sub stream_thread_i { # PublicInbox::WwwStream::getline callback
415 return unless exists($ctx->{skel});
416 my $q = $ctx->{-queue};
418 my $level = shift @$q;
419 my $node = shift @$q or next;
421 unshift @$q, map { ($cl, $_) } @{$node->{children}};
422 if (my $smsg = $ctx->{-inbox}->smsg_mime($node->{smsg})) {
423 return thread_index_entry($ctx, $level, $smsg);
425 return ghost_index_entry($ctx, $level, $node);
428 join('', thread_adj_level($ctx, 0)) . ${delete $ctx->{skel}};
431 sub stream_thread ($$) {
432 my ($rootset, $ctx) = @_;
433 my $ibx = $ctx->{-inbox};
434 my @q = map { (0, $_) } @$rootset;
438 my $node = shift @q or next;
440 unshift @q, map { ($cl, $_) } @{$node->{children}};
441 $smsg = $ibx->smsg_mime($node->{smsg}) and last;
443 return missing_thread($ctx) unless $smsg;
445 $ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
446 $ctx->{-title_html} = ascii_html($smsg->subject);
447 $ctx->{-html_tip} = thread_index_entry($ctx, $level, $smsg);
448 $ctx->{-queue} = \@q;
449 PublicInbox::WwwStream->response($ctx, 200, \&stream_thread_i);
452 # /$INBOX/$MESSAGE_ID/t/
455 my $mid = $ctx->{mid};
456 my $ibx = $ctx->{-inbox};
457 my ($nr, $msgs) = $ibx->over->get_thread($mid);
458 return missing_thread($ctx) if $nr == 0;
459 my $skel = '<hr><pre>';
460 $skel .= $nr == 1 ? 'only message in thread' : 'end of thread';
461 $skel .= ", back to <a\nhref=\"../../\">index</a>\n\n";
462 $skel .= "<b\nid=t>Thread overview:</b> ";
463 $skel .= $nr == 1 ? '(only message)' : "$nr+ messages";
464 $skel .= " (download: <a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
465 $skel .= " / follow: <a\nhref=\"../t.atom\">Atom feed</a>)\n";
466 $skel .= "-- links below jump to the message on this page --\n";
467 $ctx->{-upfx} = '../../';
468 $ctx->{cur_level} = 0;
469 $ctx->{skel} = \$skel;
470 $ctx->{prev_attr} = '';
471 $ctx->{prev_level} = 0;
472 $ctx->{root_anchor} = anchor_for($mid);
473 $ctx->{mapping} = {};
474 $ctx->{s_nr} = ($nr > 1 ? "$nr+ messages" : 'only message')
477 my $rootset = thread_results($ctx, $msgs);
479 # reduce hash lookups in pre_thread->skel_dump
480 $ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
481 walk_thread($rootset, $ctx, *pre_thread);
484 return stream_thread($rootset, $ctx) unless $ctx->{flat};
486 # flat display: lazy load the full message from smsg
488 while (my $m = shift @$msgs) {
489 $smsg = $ibx->smsg_mime($m) and last;
491 return missing_thread($ctx) unless $smsg;
492 $ctx->{-title_html} = ascii_html($smsg->subject);
493 $ctx->{-html_tip} = '<pre>'.index_entry($smsg, $ctx, scalar @$msgs);
494 $ctx->{msgs} = $msgs;
495 PublicInbox::WwwStream->response($ctx, 200, \&thread_html_i);
498 sub thread_html_i { # PublicInbox::WwwStream::getline callback
500 my $msgs = $ctx->{msgs} or return;
501 while (my $smsg = shift @$msgs) {
502 $ctx->{-inbox}->smsg_mime($smsg) or next;
503 return index_entry($smsg, $ctx, scalar @$msgs);
505 my ($skel) = delete @$ctx{qw(skel msgs)};
509 sub multipart_text_as_html {
510 my (undef, $mhref, $ctx) = @_; # $mime = $_[0]
511 $ctx->{mhref} = $mhref;
512 $ctx->{rv} = \(my $rv = '');
514 # scan through all parts, looking for displayable text
515 msg_iter($_[0], \&add_text_body, $ctx, 1);
516 ${delete $ctx->{rv}};
520 my ($s, $l, $quot) = @_;
522 # show everything in the full version with anchor from
523 # short version (see above)
524 my $rv = $l->linkify_1($$quot);
526 # we use a <span> here to allow users to specify their own
527 # color for quoted text
528 $rv = $l->linkify_2(ascii_html($rv));
530 $$s .= qq(<span\nclass="q">) . $rv . '</span>'
533 sub attach_link ($$$$;$) {
534 my ($ctx, $ct, $p, $fn, $err) = @_;
535 my ($part, $depth, @idx) = @$p;
536 my $nl = $idx[-1] > 1 ? "\n" : '';
537 my $idx = join('.', @idx);
538 my $size = bytes::length($part->body);
540 # hide attributes normally, unless we want to aid users in
541 # spotting MUA problems:
542 $ct =~ s/;.*// unless $err;
543 $ct = ascii_html($ct);
544 my $desc = $part->header('Content-Description');
545 $desc = $fn unless defined $desc;
546 $desc = '' unless defined $desc;
548 if (defined $fn && $fn =~ /\A$PublicInbox::Hval::FN\z/o) {
550 } elsif ($ct eq 'text/plain') {
556 $$rv .= qq($nl<a\nhref="$ctx->{mhref}$idx-$sfn">);
558 $$rv .= "[-- Warning: decoded text below may be mangled --]\n";
560 $$rv .= "[-- Attachment #$idx: ";
561 my $ts = "Type: $ct, Size: $size bytes";
562 $desc = ascii_html($desc);
563 $$rv .= ($desc eq '') ? "$ts --]" : "$desc --]\n[-- $ts --]";
568 sub add_text_body { # callback for msg_iter
570 my $upfx = $ctx->{mhref};
571 my $ibx = $ctx->{-inbox};
572 # $p - from msg_iter: [ Email::MIME, depth, @idx ]
573 my ($part, $depth, @idx) = @$p;
574 my $ct = $part->content_type || 'text/plain';
575 my $fn = $part->filename;
576 my ($s, $err) = msg_part_text($part, $ct);
577 return attach_link($ctx, $ct, $p, $fn) unless defined $s;
579 # makes no difference to browsers, and don't screw up filename
580 # link generation in diffs with the extra '%0D'
583 # always support diff-highlighting, but we can't linkify hunk
584 # headers for solver unless some coderepo are configured:
586 if ($s =~ /^(?:diff|---|\+{3}) /ms) {
587 # diffstat anchors do not link across attachments or messages:
588 $idx[0] = $upfx . $idx[0] if $upfx ne '';
589 $ctx->{-apfx} = join('/', @idx);
590 $ctx->{-anchors} = {}; # attr => filename
591 $ctx->{-diff} = $diff = [];
592 delete $ctx->{-long_path};
594 if ($ibx->{-repo_objs}) {
595 if (index($upfx, '//') >= 0) { # absolute URL (Atom feeds)
597 $spfx =~ s!/([^/]*)/\z!/!;
599 my $n_slash = $upfx =~ tr!/!/!;
602 } elsif ($n_slash == 1) {
604 } else { # nslash == 2
609 $ctx->{-spfx} = $spfx;
612 # some editors don't put trailing newlines at the end:
613 $s .= "\n" unless $s =~ /\n\z/s;
615 # split off quoted and unquoted blocks:
616 my @sections = split(/((?:^>[^\n]*\n)+)/sm, $s);
619 if (defined($fn) || $depth > 0 || $err) {
620 # badly-encoded message with $err? tell the world about it!
621 attach_link($ctx, $ct, $p, $fn, $err);
624 my $l = PublicInbox::Linkify->new;
625 foreach my $cur (@sections) {
627 flush_quote($rv, $l, \$cur);
629 @$diff = split(/^/m, $cur);
631 flush_diff($rv, $ctx, $l);
635 $$rv .= $l->linkify_2(ascii_html($cur));
640 obfuscate_addrs($ibx, $$rv) if $ibx->{obfuscate};
643 sub _msg_html_prepare {
644 my ($hdr, $ctx, $more, $nr) = @_;
646 my $over = $ctx->{-inbox}->over;
647 my $obfs_ibx = $ctx->{-obfs_ibx};
649 my $mids = mids_for_index($hdr);
653 "<pre>WARNING: multiple messages have this Message-ID\n</pre>";
655 $rv .= "<pre\nid=b>"; # anchor for body start
660 $ctx->{-upfx} = '../';
662 my @title; # (Subject[0], From[0])
663 for my $v ($hdr->header('From')) {
664 $v = PublicInbox::Hval->new($v);
665 my @n = PublicInbox::Address::names($v->raw);
666 $title[1] //= ascii_html(join(', ', @n));
669 obfuscate_addrs($obfs_ibx, $v);
670 obfuscate_addrs($obfs_ibx, $title[1]);
672 $rv .= "From: $v\n" if $v ne '';
674 foreach my $h (qw(To Cc)) {
675 for my $v ($hdr->header($h)) {
678 obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx;
679 $rv .= "$h: $v\n" if $v ne '';
682 my @subj = $hdr->header('Subject');
686 obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx;
689 $rv .= qq(<a\nhref="#r"\nid=t>$v</a>\n);
695 } else { # dummy anchor for thread skeleton at bottom of page
696 $rv .= qq(<a\nhref="#r"\nid=t></a>) if $over;
697 $title[0] = '(no subject)';
699 for my $v ($hdr->header('Date')) {
701 obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx; # possible :P
704 $ctx->{-title_html} = join(' - ', @title);
705 if (scalar(@$mids) == 1) { # common case
706 my $mid = PublicInbox::Hval->new_msgid($mids->[0]);
707 my $mhtml = $mid->as_html;
708 $rv .= "Message-ID: <$mhtml> ";
709 $rv .= "(<a\nhref=\"raw\">raw</a>)\n";
711 # X-Alt-Message-ID can happen if a message is injected from
712 # public-inbox-nntpd because of multiple Message-ID headers.
713 my $lnk = PublicInbox::Linkify->new;
715 for my $h (qw(Message-ID X-Alt-Message-ID)) {
716 $s .= "$h: $_\n" for ($hdr->header_raw($h));
718 $lnk->linkify_mids('..', \$s, 1);
721 $rv .= _parent_headers($hdr, $over);
726 my ($skel, $ctx, $hdr, $tpfx) = @_;
727 my $mid = mids($hdr)->[0];
728 my $ibx = $ctx->{-inbox};
729 my ($nr, $msgs) = $ibx->over->get_thread($mid);
730 my $expand = qq(expand[<a\nhref="${tpfx}T/#u">flat</a>) .
731 qq(|<a\nhref="${tpfx}t/#u">nested</a>] ) .
732 qq(<a\nhref="${tpfx}t.mbox.gz">mbox.gz</a> ) .
733 qq(<a\nhref="${tpfx}t.atom">Atom feed</a>);
735 my $parent = in_reply_to($hdr);
736 $$skel .= "\n<b>Thread overview: </b>";
738 if (defined $parent) {
739 $$skel .= "$expand\n ";
740 $$skel .= ghost_parent("$tpfx../", $parent) . "\n";
742 $$skel .= "[no followups] $expand\n";
744 $ctx->{next_msg} = undef;
745 $ctx->{parent_msg} = $parent;
749 $$skel .= "$nr+ messages / $expand";
750 $$skel .= qq! <a\nhref="#b">top</a>\n!;
752 # nb: mutt only shows the first Subject in the index pane
753 # when multiple Subject: headers are present, so we follow suit:
754 my $subj = $hdr->header('Subject') // '';
755 $subj = '(no subject)' if $subj eq '';
756 $ctx->{prev_subj} = [ split(/ /, subject_normalized($subj)) ];
758 $ctx->{prev_attr} = '';
759 $ctx->{prev_level} = 0;
760 $ctx->{skel} = $skel;
762 # reduce hash lookups in skel_dump
763 $ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
764 walk_thread(thread_results($ctx, $msgs), $ctx, *skel_dump);
766 $ctx->{parent_msg} = $parent;
769 sub _parent_headers {
770 my ($hdr, $over) = @_;
772 my @irt = $hdr->header_raw('In-Reply-To');
775 my $lnk = PublicInbox::Linkify->new;
776 $rv .= "In-Reply-To: $_\n" for @irt;
777 $lnk->linkify_mids('..', \$rv);
779 $refs = references($hdr);
780 my $irt = pop @$refs;
782 my $v = PublicInbox::Hval->new_msgid($irt);
783 my $html = $v->as_html;
784 my $href = $v->{href};
785 $rv .= "In-Reply-To: <";
786 $rv .= "<a\nhref=\"../$href/\">$html</a>>\n";
790 # do not display References: if search is present,
791 # we show the thread skeleton at the bottom, instead.
794 $refs //= references($hdr);
796 @$refs = map { linkify_ref_no_over($_) } @$refs;
797 $rv .= 'References: '. join("\n\t", @$refs) . "\n";
803 my ($hdr, $standalone, $ctx, $rhref) = @_;
805 my $ibx = $ctx->{-inbox} if $ctx;
808 my $skel = $standalone ? " <a\nhref=\"$upfx\">index</a>" : '';
810 if ($skel && $ibx->over) {
812 thread_skel(\$skel, $ctx, $hdr, $tpfx);
817 if (my $n = $ctx->{next_msg}) {
818 $n = PublicInbox::Hval->new_msgid($n)->{href};
819 $next = "<a\nhref=\"$upfx$n/\"\nrel=next>next</a>";
822 my $par = $ctx->{parent_msg};
824 $u = PublicInbox::Hval->new_msgid($par)->{href};
827 if (my $p = $ctx->{prev_msg}) {
828 $prev = PublicInbox::Hval->new_msgid($p)->{href};
829 if ($p && $par && $p eq $par) {
830 $prev = "<a\nhref=\"$upfx$prev/\"\n" .
831 'rel=prev>prev parent</a>';
834 $prev = "<a\nhref=\"$upfx$prev/\"\n" .
836 $parent = " <a\nhref=\"$u\">parent</a>" if $u;
838 } elsif ($u) { # unlikely
839 $parent = " <a\nhref=\"$u\"\nrel=prev>parent</a>";
841 $irt = "$next $prev$parent ";
846 $irt .= qq(<a\nhref="$rhref">reply</a>);
850 sub linkify_ref_no_over {
851 my $v = PublicInbox::Hval->new_msgid($_[0]);
852 my $html = $v->as_html;
853 my $href = $v->{href};
854 "<<a\nhref=\"../$href/\">$html</a>>";
859 'm' . id_compress($msgid, 1);
863 my ($upfx, $mid) = @_;
865 $mid = PublicInbox::Hval->new_msgid($mid);
866 my $href = $mid->{href};
867 my $html = $mid->as_html;
868 qq{[parent not found: <<a\nhref="$upfx$href/">$html</a>>]};
873 $level ? INDENT x ($level - 1) : '';
877 my ($ctx, $level, $node, $idx) = @_;
878 ++$ctx->{root_idx} if $level == 0;
879 if ($node->{id} eq $ctx->{mid}) {
880 $ctx->{found_mid_at} = $ctx->{root_idx};
886 sub strict_loose_note ($) {
889 " -- strict thread matches above, loose matches on Subject: below --\n";
891 if ($nr > PublicInbox::Over::DEFAULT_LIMIT()) {
893 " -- use mbox.gz link to download all $nr messages --\n";
899 my ($ctx, $msgs) = @_;
900 require PublicInbox::SearchThread;
901 my $rootset = PublicInbox::SearchThread::thread($msgs, \&sort_ds, $ctx);
903 # FIXME: `tid' is broken on --reindex, so that needs to be fixed
904 # and preserved in the future. This bug is hidden by `sid' matches
905 # in get_thread, so we never noticed it until now. And even when
906 # reindexing is fixed, we'll keep this code until a SCHEMA_VERSION
907 # bump since reindexing is expensive and users may not do it
909 # loose threading could've returned too many results,
910 # put the root the message we care about at the top:
911 my $mid = $ctx->{mid};
912 if (defined($mid) && scalar(@$rootset) > 1) {
913 $ctx->{root_idx} = -1;
914 my $nr = scalar @$msgs;
915 walk_thread($rootset, $ctx, *find_mid_root);
916 my $idx = $ctx->{found_mid_at};
917 if (defined($idx) && $idx != 0) {
918 my $tip = splice(@$rootset, $idx, 1);
919 @$rootset = reverse @$rootset;
920 unshift @$rootset, $tip;
921 $ctx->{sl_note} = strict_loose_note($nr);
929 require PublicInbox::ExtMsg;
930 PublicInbox::ExtMsg::ext_msg($ctx);
934 my ($prev_subj, $subj, $val) = @_;
936 my $omit = ''; # '"' denotes identical text omitted
937 my (@prev_pop, @curr_pop);
938 while (@$prev_subj && @$subj && $subj->[-1] eq $prev_subj->[-1]) {
939 push(@prev_pop, pop(@$prev_subj));
940 push(@curr_pop, pop(@$subj));
943 pop @$subj if @$subj && $subj->[-1] =~ /^re:\s*/i;
944 if (scalar(@curr_pop) == 1) {
946 push @$prev_subj, @prev_pop;
947 push @$subj, @curr_pop;
953 my ($ctx, $level, $node) = @_;
954 my $smsg = $node->{smsg} or return _skel_ghost($ctx, $level, $node);
956 my $skel = $ctx->{skel};
957 my $cur = $ctx->{cur};
958 my $mid = $smsg->{mid};
960 if ($level == 0 && $ctx->{skel_dump_roots}++) {
961 $$skel .= delete($ctx->{sl_note}) || '';
964 my $f = ascii_html($smsg->from_name);
965 my $obfs_ibx = $ctx->{-obfs_ibx};
966 obfuscate_addrs($obfs_ibx, $f) if $obfs_ibx;
968 my $d = fmt_ts($smsg->{ds});
969 my $unmatched; # if lazy-loaded by SearchThread::Msg::visible()
970 if (exists $ctx->{searchview}) {
971 if (defined(my $pct = $smsg->{pct})) {
972 $d .= (sprintf(' % 2u', $pct) . '%');
978 $d .= ' ' . indent_for($level) . th_pfx($level);
980 $ctx->{first_level} ||= $level;
982 if ($attr ne $ctx->{prev_attr} || $ctx->{prev_level} > $level) {
983 $ctx->{prev_attr} = $attr;
985 $ctx->{prev_level} = $level;
990 $$skel .= "<b>$d<a\nid=r\nhref=\"#t\">".
991 "$attr [this message]</a></b>\n";
994 $ctx->{prev_msg} = $mid;
997 $ctx->{next_msg} ||= $mid;
1000 # Subject is never undef, this mail was loaded from
1001 # our Xapian which would've resulted in '' if it were
1002 # really missing (and Filter rejects empty subjects)
1003 my @subj = split(/ /, subject_normalized($smsg->subject));
1004 # remove common suffixes from the subject if it matches the previous,
1005 # so we do not show redundant text at the end.
1006 my $prev_subj = $ctx->{prev_subj} || [];
1007 $ctx->{prev_subj} = [ @subj ];
1008 my $omit = dedupe_subject($prev_subj, \@subj, '" ');
1011 my $subj = join(' ', @subj);
1012 $subj = ascii_html($subj);
1013 obfuscate_addrs($obfs_ibx, $subj) if $obfs_ibx;
1014 $end = "$subj</a> $omit$f\n"
1020 my $mapping = $unmatched ? undef : $ctx->{mapping};
1022 my $map = $mapping->{$mid};
1023 $id = id_compress($mid, 1);
1025 $map->[0] = "$d<a\nhref=\"$m\">$end";
1028 $m = $ctx->{-upfx}.mid_escape($mid).'/';
1030 $$skel .= $d . "<a\nhref=\"$m\"$id>" . $end;
1035 my ($ctx, $level, $node) = @_;
1037 my $mid = $node->{id};
1038 my $d = ' [not found] ';
1039 $d .= ' ' if exists $ctx->{searchview};
1040 $d .= indent_for($level) . th_pfx($level);
1041 my $upfx = $ctx->{-upfx};
1042 my $m = PublicInbox::Hval->new_msgid($mid);
1043 my $href = $upfx . $m->{href} . '/';
1044 my $html = $m->as_html;
1046 my $mapping = $ctx->{mapping};
1047 my $map = $mapping->{$mid} if $mapping;
1049 my $id = id_compress($mid, 1);
1050 $map->[0] = $d . qq{<<a\nhref=#r$id>$html</a>>\n};
1051 $d .= qq{<<a\nhref="$href"\nid=r$id>$html</a>>\n};
1053 $d .= qq{<<a\nhref="$href">$html</a>>\n};
1055 ${$ctx->{skel}} .= $d;
1061 (eval { $a->topmost->{smsg}->ds } || 0) <=>
1062 (eval { $b->topmost->{smsg}->ds } || 0)
1066 # accumulate recent topics if search is supported
1067 # returns 200 if done, 404 if not
1069 my ($ctx, $level, $node) = @_;
1070 my $mid = $node->{id};
1071 my $x = $node->{smsg} || $ctx->{-inbox}->smsg_by_mid($mid);
1075 $subj = $x->subject;
1076 $subj = subject_normalized($subj);
1077 $subj = '(no subject)' if $subj eq '';
1080 $topic = [ $ds, 1, { $subj => $mid }, $subj ];
1081 $ctx->{-cur_topic} = $topic;
1082 push @{$ctx->{order}}, $topic;
1086 $topic = $ctx->{-cur_topic}; # should never be undef
1087 $topic->[0] = $ds if $ds > $topic->[0];
1089 my $seen = $topic->[2];
1090 if (scalar(@$topic) == 3) { # parent was a ghost
1091 push @$topic, $subj;
1092 } elsif (!$seen->{$subj}) {
1093 push @$topic, $level, $subj;
1095 $seen->{$subj} = $mid; # latest for subject
1096 } else { # ghost message
1097 return 1 if $level != 0; # ignore child ghosts
1098 $topic = [ -666, 0, {} ];
1099 $ctx->{-cur_topic} = $topic;
1100 push @{$ctx->{order}}, $topic;
1107 my $order = delete $ctx->{order}; # [ ds, subj1, subj2, subj3, ... ]
1109 $ctx->{-html_tip} = '<pre>[No topics in range]</pre>';
1114 my $ibx = $ctx->{-inbox};
1115 my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
1117 # sort by recency, this allows new posts to "bump" old topics...
1118 foreach my $topic (sort { $b->[0] <=> $a->[0] } @$order) {
1119 my ($ds, $n, $seen, $top, @ex) = @$topic;
1121 next unless defined $top; # ghost topic
1122 my $mid = delete $seen->{$top};
1123 my $href = mid_escape($mid);
1124 my $prev_subj = [ split(/ /, $top) ];
1125 $top = PublicInbox::Hval->new($top)->as_html;
1128 # $n isn't the total number of posts on the topic,
1129 # just the number of posts in the current results window
1133 $anchor = '#u'; # top of only message
1135 $n = " ($n+ messages)";
1136 $anchor = '#t'; # thread skeleton
1139 my $mbox = qq(<a\nhref="$href/t.mbox.gz">mbox.gz</a>);
1140 my $atom = qq(<a\nhref="$href/t.atom">Atom</a>);
1141 my $s = "<a\nhref=\"$href/T/$anchor\">$top</a>\n" .
1142 " $ds UTC $n - $mbox / $atom\n";
1143 for (my $i = 0; $i < scalar(@ex); $i += 2) {
1144 my $level = $ex[$i];
1145 my $subj = $ex[$i + 1];
1146 $mid = delete $seen->{$subj};
1147 my @subj = split(/ /, subject_normalized($subj));
1148 my @next_prev = @subj; # full copy
1149 my $omit = dedupe_subject($prev_subj, \@subj, ' "');
1150 $prev_subj = \@next_prev;
1151 $subj = ascii_html(join(' ', @subj));
1152 obfuscate_addrs($obfs_ibx, $subj) if $obfs_ibx;
1153 $href = mid_escape($mid);
1154 $s .= indent_for($level) . TCHILD;
1155 $s .= "<a\nhref=\"$href/T/#u\">$subj</a>$omit\n";
1159 $ctx->{-html_tip} = '<pre>' . join("\n", @out) . '</pre>';
1163 # only for the t= query parameter passed to overview DB
1164 sub ts2str ($) { strftime('%Y%m%d%H%M%S', gmtime($_[0])) };
1167 my ($yyyy, $mon, $dd, $hh, $mm, $ss) = unpack('A4A2A2A2A2A2', $_[0]);
1168 timegm($ss, $mm, $hh, $dd, $mon - 1, $yyyy);
1171 sub pagination_footer ($$) {
1172 my ($ctx, $latest) = @_;
1173 delete $ctx->{qp} or return;
1174 my $next = $ctx->{next_page} || '';
1175 my $prev = $ctx->{prev_page} || '';
1177 $next = $next ? "$next " : ' ';
1178 $prev .= qq! <a\nhref='$latest'>latest</a>!;
1180 "<hr><pre>page: $next$prev</pre>";
1183 sub index_nav { # callback for WwwStream
1184 my (undef, $ctx) = @_;
1185 pagination_footer($ctx, '.')
1188 sub paginate_recent ($$) {
1189 my ($ctx, $lim) = @_;
1190 my $t = $ctx->{qp}->{t} || '';
1191 my $opts = { limit => $lim };
1192 my ($after, $before);
1194 # Xapian uses '..' but '-' is perhaps friendier to URL linkifiers
1195 # if only $after exists "YYYYMMDD.." because "." could be skipped
1196 # if interpreted as an end-of-sentence
1197 $t =~ s/\A([0-9]{8,14})-// and $after = str2ts($1);
1198 $t =~ /\A([0-9]{8,14})\z/ and $before = str2ts($1);
1200 my $ibx = $ctx->{-inbox};
1201 my $msgs = $ibx->recent($opts, $after, $before);
1202 my $nr = scalar @$msgs;
1203 if ($nr < $lim && defined($after)) {
1204 $after = $before = undef;
1205 $msgs = $ibx->recent($opts);
1206 $nr = scalar @$msgs;
1208 my $more = $nr == $lim;
1209 my ($newest, $oldest);
1211 $newest = $msgs->[0]->{ts};
1212 $oldest = $msgs->[-1]->{ts};
1213 # if we only had $after, our SQL query in ->recent ordered
1214 if ($newest < $oldest) {
1215 ($oldest, $newest) = ($newest, $oldest);
1216 $more = 0 if defined($after) && $after < $oldest;
1219 if (defined($oldest) && $more) {
1220 my $s = ts2str($oldest);
1221 $ctx->{next_page} = qq!<a\nhref="?t=$s"\nrel=next>next</a>!;
1223 if (defined($newest) && (defined($before) || defined($after))) {
1224 my $s = ts2str($newest);
1225 $ctx->{prev_page} = qq!<a\nhref="?t=$s-"\nrel=prev>prev</a>!;
1232 my $msgs = paginate_recent($ctx, 200); # 200 is our window
1234 walk_thread(thread_results($ctx, $msgs), $ctx, *acc_topic);
1236 PublicInbox::WwwStream->response($ctx, dump_topics($ctx), *index_nav);
1239 sub thread_adj_level {
1240 my ($ctx, $level) = @_;
1242 my $max = $ctx->{cur_level};
1244 return ('', '') if $max == 0; # flat output
1246 # reset existing lists
1247 my $beg = $max > 1 ? ('</ul></li>' x ($max - 1)) : '';
1248 $ctx->{cur_level} = 0;
1250 } elsif ($level == $max) { # continue existing list
1252 } elsif ($level < $max) {
1253 my $beg = $max > 1 ? ('</ul></li>' x ($max - $level)) : '';
1254 $ctx->{cur_level} = $level;
1255 ("$beg<li>", '</li>');
1256 } else { # ($level > $max) # start a new level
1257 $ctx->{cur_level} = $level;
1258 my $beg = ($max ? '<li>' : '') . '<ul><li>';
1263 sub ghost_index_entry {
1264 my ($ctx, $level, $node) = @_;
1265 my ($beg, $end) = thread_adj_level($ctx, $level);
1266 $beg . '<pre>'. ghost_parent($ctx->{-upfx}, $node->{id})