-# Copyright (C) 2014-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2014-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
#
# Used for displaying the HTML web interface.
use strict;
use warnings;
use bytes (); # only for bytes::length
+use List::Util qw(max);
use PublicInbox::MsgTime qw(msg_datestamp);
-use PublicInbox::Hval qw(ascii_html obfuscate_addrs prurl mid_href);
+use PublicInbox::Hval qw(ascii_html obfuscate_addrs prurl mid_href
+ ts2str fmt_ts);
use PublicInbox::Linkify;
use PublicInbox::MID qw(id_compress mids mids_for_index references
$MID_EXTRACT);
use PublicInbox::MsgIter;
use PublicInbox::Address;
-use PublicInbox::WwwStream;
+use PublicInbox::WwwStream qw(html_oneshot);
use PublicInbox::Reply;
use PublicInbox::ViewDiff qw(flush_diff);
use PublicInbox::Eml;
-use POSIX qw(strftime);
use Time::Local qw(timegm);
use PublicInbox::Smsg qw(subject_normalized);
use constant COLS => 72;
$ctx->{smsg} = $ctx->{over}->next_by_mid(@{$ctx->{next_arg}});
$ctx->{mhref} = ($ctx->{nr} || $ctx->{smsg}) ?
"../${\mid_href($smsg->{mid})}/" : '';
- my $hdr = $eml->header_obj;
- my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($hdr, $ctx);
+ my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($eml, $ctx);
multipart_text_as_html($eml, $ctx);
delete $ctx->{obuf};
$$obuf .= '</pre><hr>';
}
}
-# /$INBOX/$MESSAGE_ID/ for unindexed v1 inboxes
-sub no_over_i {
+# /$INBOX/$MSGID/ for unindexed v1 inboxes
+sub no_over_html ($) {
my ($ctx) = @_;
- my $eml = delete $ctx->{eml} or return;
- my $hdr = $eml->header_obj;
+ my $bref = $ctx->{ibx}->msg_by_mid($ctx->{mid}) or return; # 404
+ my $eml = PublicInbox::Eml->new($bref);
$ctx->{mhref} = '';
- my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($hdr, $ctx);
+ PublicInbox::WwwStream::init($ctx);
+ my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($eml, $ctx);
multipart_text_as_html($eml, $ctx);
delete $ctx->{obuf};
$$obuf .= '</pre><hr>';
- eval { $$obuf .= html_footer($ctx, $hdr) };
- $$obuf
-}
-
-sub no_over_html ($) {
- my ($ctx) = @_;
- my $bref = $ctx->{-inbox}->msg_by_mid($ctx->{mid}) or return; # 404
- $ctx->{eml} = PublicInbox::Eml->new($bref);
- PublicInbox::WwwStream::response($ctx, 200, \&no_over_i);
+ eval { $$obuf .= html_footer($ctx, $eml) };
+ html_oneshot($ctx, 200, $obuf);
}
# public functions: (unstable)
sub msg_page {
my ($ctx) = @_;
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
$ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
my $over = $ctx->{over} = $ibx->over or return no_over_html($ctx);
my ($id, $prev);
my $next_arg = $ctx->{next_arg} = [ $ctx->{mid}, \$id, \$prev ];
- $ctx->{smsg} = $over->next_by_mid(@$next_arg) or return; # undef == 404
+
+ my $smsg = $ctx->{smsg} = $over->next_by_mid(@$next_arg) or
+ return; # undef == 404
+
+ # allow user to easily browse the range around this message if
+ # they have ->over
+ $ctx->{-t_max} = $smsg->{ts};
PublicInbox::WwwStream::aresponse($ctx, 200, \&msg_page_i);
}
'https://en.wikipedia.org/wiki/Posting_style#Interleaved_style';
my $info = '';
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
if (my $url = $ibx->{infourl}) {
$url = prurl($ctx->{env}, $url);
$info = qq(\n List information: <a\nhref="$url">$url</a>\n);
$nr == 1 ? "$nr $singular" : "$nr $plural";
}
-# human-friendly format
-sub fmt_ts ($) { strftime('%Y-%m-%d %k:%M', gmtime($_[0])) }
-
# Displays the text of of the message for /$INBOX/$MSGID/[Tt]/ endpoint
# this is already inside a <pre>
sub eml_entry {
- my ($ctx, $smsg, $eml, $more) = @_;
+ my ($ctx, $eml) = @_;
+ my $smsg = delete $ctx->{smsg};
my $subj = delete $smsg->{subject};
my $mid_raw = $smsg->{mid};
my $id = id_compress($mid_raw, 1);
# Deleting these fields saves about 400K as we iterate across 1K msgs
delete @$smsg{qw(ts blob)};
- my $hdr = $eml->header_obj;
- my $from = _hdr_names_html($hdr, 'From');
+ my $from = _hdr_names_html($eml, 'From');
obfuscate_addrs($obfs_ibx, $from) if $obfs_ibx;
$rv .= "From: $from @ ".fmt_ts($ds)." UTC";
my $upfx = $ctx->{-upfx};
my $mhref = $upfx . mid_href($mid_raw) . '/';
$rv .= qq{ (<a\nhref="$mhref">permalink</a> / };
$rv .= qq{<a\nhref="${mhref}raw">raw</a>)\n};
- my $to = fold_addresses(_hdr_names_html($hdr, 'To'));
- my $cc = fold_addresses(_hdr_names_html($hdr, 'Cc'));
+ my $to = fold_addresses(_hdr_names_html($eml, 'To'));
+ my $cc = fold_addresses(_hdr_names_html($eml, 'Cc'));
my ($tlen, $clen) = (length($to), length($cc));
my $to_cc = '';
if (($tlen + $clen) > COLS) {
$rv .= $to_cc;
my $mapping = $ctx->{mapping};
- if (!$mapping && (defined($irt) || defined($irt = in_reply_to($hdr)))) {
+ if (!$mapping && (defined($irt) || defined($irt = in_reply_to($eml)))) {
my $href = $upfx . mid_href($irt) . '/';
my $html = ascii_html($irt);
$rv .= qq(In-Reply-To: <<a\nhref="$href">$html</a>>\n)
$hr = $ctx->{-hr};
}
- $rv .= $more ? '</pre><hr><pre>' : '</pre>' if $hr;
+ # do we have more messages? start a new <pre> if so
+ $rv .= scalar(@{$ctx->{msgs}}) ? '</pre><hr><pre>' : '</pre>' if $hr;
$rv;
}
}
sub thread_eml_entry {
- my ($ctx, $level, $smsg, $eml) = @_;
- my ($beg, $end) = thread_adj_level($ctx, $level);
- $beg . '<pre>' . eml_entry($ctx, $smsg, $eml, 0) . '</pre>' . $end;
+ my ($ctx, $eml) = @_;
+ my ($beg, $end) = thread_adj_level($ctx, $ctx->{level});
+ $beg . '<pre>' . eml_entry($ctx, $eml) . '</pre>' . $end;
}
-sub next_in_queue ($;$) {
+sub next_in_queue ($$) {
my ($q, $ghost_ok) = @_;
while (@$q) {
my ($level, $smsg) = splice(@$q, 0, 2);
}
sub stream_thread_i { # PublicInbox::WwwStream::getline callback
- my ($ctx) = @_;
+ my ($ctx, $eml) = @_;
+ return thread_eml_entry($ctx, $eml) if $eml;
return unless exists($ctx->{skel});
- my $nr = $ctx->{nr}++;
- my ($level, $smsg) = next_in_queue($ctx->{-queue}, $nr);
-
- $smsg or return
- join('', thread_adj_level($ctx, 0)) . ${delete $ctx->{skel}};
-
- my $eml = $ctx->{-inbox}->smsg_eml($smsg) or return
- ghost_index_entry($ctx, $level, $smsg);
-
- if ($nr == 0) {
- $ctx->{-title_html} = ascii_html($smsg->{subject});
- $ctx->html_top . thread_eml_entry($ctx, $level, $smsg, $eml);
- } else {
- thread_eml_entry($ctx, $level, $smsg, $eml);
+ my $ghost_ok = $ctx->{nr}++;
+ while (1) {
+ my ($lvl, $smsg) = next_in_queue($ctx->{-queue}, $ghost_ok);
+ if ($smsg) {
+ if (exists $smsg->{blob}) { # next message for cat-file
+ $ctx->{level} = $lvl;
+ if (!$ghost_ok) { # first non-ghost
+ $ctx->{-title_html} =
+ ascii_html($smsg->{subject});
+ $ctx->zmore($ctx->html_top);
+ }
+ return $smsg;
+ }
+ # buffer the ghost entry and loop
+ $ctx->zmore(ghost_index_entry($ctx, $lvl, $smsg));
+ } else { # all done
+ $ctx->zmore(join('', thread_adj_level($ctx, 0)));
+ $ctx->zmore(${delete($ctx->{skel})});
+ return;
+ }
}
}
sub stream_thread ($$) {
my ($rootset, $ctx) = @_;
$ctx->{-queue} = [ map { (0, $_) } @$rootset ];
- PublicInbox::WwwStream::response($ctx, 200, \&stream_thread_i);
+ PublicInbox::WwwStream::aresponse($ctx, 200, \&stream_thread_i);
}
-# /$INBOX/$MESSAGE_ID/t/
+# /$INBOX/$MSGID/t/ and /$INBOX/$MSGID/T/
sub thread_html {
my ($ctx) = @_;
my $mid = $ctx->{mid};
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my ($nr, $msgs) = $ibx->over->get_thread($mid);
return missing_thread($ctx) if $nr == 0;
+
+ # link $INBOX_DIR/description text to "index_topics" view around
+ # the newest message in this thread
+ my $t = ts2str($ctx->{-t_max} = max(map { delete $_->{ts} } @$msgs));
+ my $t_fmt = fmt_ts($ctx->{-t_max});
+
my $skel = '<hr><pre>';
$skel .= $nr == 1 ? 'only message in thread' : 'end of thread';
- $skel .= ", back to <a\nhref=\"../../\">index</a>\n\n";
+ $skel .= <<EOF;
+, other threads:[<a
+href="../../?t=$t">~$t_fmt UTC</a> | <a
+href="../../">newest</a>]
+
+EOF
$skel .= "<b\nid=t>Thread overview:</b> ";
$skel .= $nr == 1 ? '(only message)' : "$nr+ messages";
$skel .= " (download: <a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
# flat display: lazy load the full message from smsg
$ctx->{msgs} = $msgs;
$ctx->{-html_tip} = '<pre>';
- PublicInbox::WwwStream::response($ctx, 200, \&thread_html_i);
+ PublicInbox::WwwStream::aresponse($ctx, 200, \&thread_html_i);
}
sub thread_html_i { # PublicInbox::WwwStream::getline callback
- my ($ctx) = @_;
- my $msgs = $ctx->{msgs} or return;
- while (my $smsg = shift @$msgs) {
- my $eml = $ctx->{-inbox}->smsg_eml($smsg) or next;
+ my ($ctx, $eml) = @_;
+ if ($eml) {
+ my $smsg = $ctx->{smsg};
if (exists $ctx->{-html_tip}) {
$ctx->{-title_html} = ascii_html($smsg->{subject});
- return $ctx->html_top .
- eml_entry($ctx, $smsg, $eml, scalar @$msgs);
+ $ctx->zmore($ctx->html_top);
}
- return eml_entry($ctx, $smsg, $eml, scalar @$msgs);
+ return eml_entry($ctx, $eml);
+ } else {
+ while (my $smsg = shift @{$ctx->{msgs}}) {
+ return $smsg if exists($smsg->{blob});
+ }
+ my $skel = delete($ctx->{skel}) or return; # all done
+ $ctx->zmore($$skel);
+ undef;
}
- my ($skel) = delete @$ctx{qw(skel msgs)};
- $$skel;
}
sub multipart_text_as_html {
sub add_text_body { # callback for each_part
my ($p, $ctx) = @_;
my $upfx = $ctx->{mhref};
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my $l = $ctx->{-linkify} //= PublicInbox::Linkify->new;
# $p - from each_part: [ Email::MIME-like, depth, $idx ]
my ($part, $depth, $idx) = @$p;
}
sub _msg_page_prepare_obuf {
- my ($hdr, $ctx) = @_;
- my $over = $ctx->{-inbox}->over;
+ my ($eml, $ctx) = @_;
+ my $over = $ctx->{ibx}->over;
my $obfs_ibx = $ctx->{-obfs_ibx};
my $rv = '';
- my $mids = mids_for_index($hdr);
+ my $mids = mids_for_index($eml);
my $nr = $ctx->{nr}++;
if ($nr) { # unlikely
$rv .= '<pre>';
} else {
- $ctx->{first_hdr} = $hdr;
+ $ctx->{first_hdr} = $eml->header_obj;
if ($ctx->{smsg}) {
$rv .=
"<pre>WARNING: multiple messages have this Message-ID\n</pre>";
}
$ctx->{-upfx} = '../' if $over;
my @title; # (Subject[0], From[0])
- for my $v ($hdr->header('From')) {
+ for my $v ($eml->header('From')) {
my @n = PublicInbox::Address::names($v);
$v = ascii_html($v);
$title[1] //= ascii_html(join(', ', @n));
$rv .= "From: $v\n" if $v ne '';
}
foreach my $h (qw(To Cc)) {
- for my $v ($hdr->header($h)) {
+ for my $v ($eml->header($h)) {
fold_addresses($v);
$v = ascii_html($v);
obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx;
$rv .= "$h: $v\n" if $v ne '';
}
}
- my @subj = $hdr->header('Subject');
+ my @subj = $eml->header('Subject');
if (@subj) {
my $v = ascii_html(shift @subj);
obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx;
$rv .= qq(<a\nhref="#r"\nid=t></a>) if $over;
$title[0] = '(no subject)';
}
- for my $v ($hdr->header('Date')) {
+ for my $v ($eml->header('Date')) {
$v = ascii_html($v);
obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx; # possible :P
$rv .= "Date: $v\n";
my $lnk = PublicInbox::Linkify->new;
my $s = '';
for my $h (qw(Message-ID X-Alt-Message-ID)) {
- $s .= "$h: $_\n" for ($hdr->header_raw($h));
+ $s .= "$h: $_\n" for ($eml->header_raw($h));
}
$lnk->linkify_mids('..', \$s, 1);
$rv .= $s;
}
- $rv .= _parent_headers($hdr, $over);
+ $rv .= _parent_headers($eml, $over);
$rv .= "\n";
\$rv;
}
sub thread_skel ($$$) {
my ($skel, $ctx, $hdr) = @_;
my $mid = mids($hdr)->[0];
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my ($nr, $msgs) = $ibx->over->get_thread($mid);
my $parent = in_reply_to($hdr);
$$skel .= "\n<b>Thread overview: </b>";
$rv;
}
-# returns a string buffer via ->getline
+# returns a string buffer
sub html_footer {
my ($ctx, $hdr) = @_;
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my $upfx = '../';
- my $skel = " <a\nhref=\"$upfx\">index</a>";
+ my $skel;
my $rv = '<pre>';
if ($ibx->over) {
- $skel .= "\n";
+ my $t = ts2str($ctx->{-t_max});
+ my $t_fmt = fmt_ts($ctx->{-t_max});
+ $skel .= <<EOF;
+ other threads:[<a
+href="$upfx?t=$t">~$t_fmt UTC</a>|<a
+href="$upfx">newest</a>]
+EOF
+
thread_skel(\$skel, $ctx, $hdr);
my ($next, $prev);
my $parent = ' ';
$parent = " <a\nhref=\"$u\"\nrel=prev>parent</a>";
}
$rv .= "$next $prev$parent ";
+ } else { # unindexed inboxes w/o over
+ $skel = qq( <a\nhref="$upfx">latest</a>);
}
$rv .= qq(<a\nhref="#R">reply</a>);
$rv .= $skel;
++$ctx->{root_idx} if $level == 0;
if ($node->{mid} eq $ctx->{mid}) {
$ctx->{found_mid_at} = $ctx->{root_idx};
- return 0;
+ return 0; # stop iterating
}
1;
}
my ($ctx, $level, $smsg) = @_;
my $mid = $smsg->{mid};
my $has_blob = $smsg->{blob} // do {
- if (my $by_mid = $ctx->{-inbox}->smsg_by_mid($mid)) {
+ if (my $by_mid = $ctx->{ibx}->smsg_by_mid($mid)) {
%$smsg = (%$smsg, %$by_mid);
1;
}
}
my @out;
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
# sort by recency, this allows new posts to "bump" old topics...
200;
}
-# only for the t= query parameter passed to overview DB
-sub ts2str ($) { strftime('%Y%m%d%H%M%S', gmtime($_[0])) };
-
sub str2ts ($) {
my ($yyyy, $mon, $dd, $hh, $mm, $ss) = unpack('A4A2A2A2A2A2', $_[0]);
- timegm($ss, $mm, $hh, $dd, $mon - 1, $yyyy);
+ timegm($ss || 0, $mm || 0, $hh || 0, $dd, $mon - 1, $yyyy);
}
sub pagination_footer ($$) {
my ($ctx, $latest) = @_;
- delete $ctx->{qp} or return;
my $next = $ctx->{next_page} || '';
my $prev = $ctx->{prev_page} || '';
- if ($prev) {
- $next = $next ? "$next " : ' ';
- $prev .= qq! <a\nhref='$latest'>latest</a>!;
+ if ($prev) { # aligned padding for: 'next (older) | '
+ $next = $next ? "$next | " : ' | ';
+ $prev .= qq[ | <a\nhref="$latest">latest</a>];
}
"<hr><pre>page: $next$prev</pre>";
}
-sub index_nav { # callback for WwwStream::getline
- my ($ctx) = @_;
- return $ctx->html_top if exists $ctx->{-html_tip};
- pagination_footer($ctx, '.')
-}
-
sub paginate_recent ($$) {
my ($ctx, $lim) = @_;
my $t = $ctx->{qp}->{t} || '';
$t =~ s/\A([0-9]{8,14})-// and $after = str2ts($1);
$t =~ /\A([0-9]{8,14})\z/ and $before = str2ts($1);
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my $msgs = $ibx->recent($opts, $after, $before);
my $nr = scalar @$msgs;
if ($nr < $lim && defined($after)) {
}
if (defined($oldest) && $more) {
my $s = ts2str($oldest);
- $ctx->{next_page} = qq!<a\nhref="?t=$s"\nrel=next>next</a>!;
+ $ctx->{next_page} = qq[<a\nhref="?t=$s"\nrel=next>] .
+ 'next (older)</a>';
}
if (defined($newest) && (defined($before) || defined($after))) {
my $s = ts2str($newest);
- $ctx->{prev_page} = qq!<a\nhref="?t=$s-"\nrel=prev>prev</a>!;
+ $ctx->{prev_page} = qq[<a\nhref="?t=$s-"\nrel=prev>] .
+ 'prev (newer)</a>';
}
$msgs;
}
+# GET /$INBOX - top-level inbox view for indexed inboxes
sub index_topics {
my ($ctx) = @_;
my $msgs = paginate_recent($ctx, 200); # 200 is our window
if (@$msgs) {
walk_thread(thread_results($ctx, $msgs), $ctx, \&acc_topic);
}
- PublicInbox::WwwStream::response($ctx, dump_topics($ctx), \&index_nav);
+ html_oneshot($ctx, dump_topics($ctx), \pagination_footer($ctx, '.'));
+
}
sub thread_adj_level {