-# Copyright (C) 2014-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) 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.
# See Documentation/design_www.txt for this.
package PublicInbox::View;
use strict;
-use warnings;
-use bytes (); # only for bytes::length
+use v5.10.1;
use List::Util qw(max);
+use Text::Wrap qw(wrap); # stdlib, we need Perl 5.6+ for $huge
use PublicInbox::MsgTime qw(msg_datestamp);
use PublicInbox::Hval qw(ascii_html obfuscate_addrs prurl mid_href
ts2str fmt_ts);
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 PublicInbox::ContentHash qw(content_hash);
use constant COLS => 72;
use constant INDENT => ' ';
use constant TCHILD => '` ';
my ($ctx, $eml) = @_;
if ($eml) { # called by WwwStream::async_eml or getline
my $smsg = $ctx->{smsg};
- $ctx->{smsg} = $ctx->{over}->next_by_mid(@{$ctx->{next_arg}});
+ my $over = $ctx->{ibx}->over;
+ $ctx->{smsg} = $over ? $over->next_by_mid(@{$ctx->{next_arg}})
+ : $ctx->gone('over');
$ctx->{mhref} = ($ctx->{nr} || $ctx->{smsg}) ?
"../${\mid_href($smsg->{mid})}/" : '';
- my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($eml, $ctx);
- multipart_text_as_html($eml, $ctx);
+ my $obuf = _msg_page_prepare_obuf($eml, $ctx);
+ if (length($$obuf)) {
+ multipart_text_as_html($eml, $ctx);
+ $$obuf .= '</pre><hr>';
+ }
delete $ctx->{obuf};
- $$obuf .= '</pre><hr>';
$$obuf .= html_footer($ctx, $ctx->{first_hdr}) if !$ctx->{smsg};
$$obuf;
} else { # called by WwwStream::async_next or getline
my $eml = PublicInbox::Eml->new($bref);
$ctx->{mhref} = '';
PublicInbox::WwwStream::init($ctx);
- my $obuf = $ctx->{obuf} = _msg_page_prepare_obuf($eml, $ctx);
- multipart_text_as_html($eml, $ctx);
+ my $obuf = _msg_page_prepare_obuf($eml, $ctx);
+ if (length($$obuf)) {
+ multipart_text_as_html($eml, $ctx);
+ $$obuf .= '</pre><hr>';
+ }
delete $ctx->{obuf};
- $$obuf .= '</pre><hr>';
eval { $$obuf .= html_footer($ctx, $eml) };
- html_oneshot($ctx, 200, $obuf);
+ html_oneshot($ctx, 200, $$obuf);
}
# public functions: (unstable)
my ($ctx) = @_;
my $ibx = $ctx->{ibx};
$ctx->{-obfs_ibx} = $ibx->{obfuscate} ? $ibx : undef;
- my $over = $ctx->{over} = $ibx->over or return no_over_html($ctx);
+ my $over = $ibx->over or return no_over_html($ctx);
my ($id, $prev);
my $next_arg = $ctx->{next_arg} = [ $ctx->{mid}, \$id, \$prev ];
<a
href="$se_url">$se_url</a>
$link</pre>
+
+ Be sure your reply has a <b>Subject:</b> header at the top and a blank line
+ before the message body.
EOF
}
# scan through all parts, looking for displayable text
$ctx->{mhref} = $mhref;
+ $ctx->{end_id} = "e$id";
$ctx->{obuf} = \$rv;
$eml->each_part(\&add_text_body, $ctx, 1);
delete $ctx->{obuf};
" <a\nhref=\"${mhref}raw\">raw</a>" .
" <a\nhref=\"${mhref}#R\">reply</a>";
+ delete($ctx->{-qry}) and
+ $rv .= qq[ <a\nhref="${mhref}#related">related</a>];
+
my $hr;
if (defined(my $pct = $smsg->{pct})) { # used by SearchView.pm
$rv .= "\t[relevance $pct%]";
} elsif ($mapping) {
my $nested = 'nested';
my $flat = 'flat';
- my $end = '';
if ($ctx->{flat}) {
$hr = 1;
$flat = "<b>$flat</b>";
sub pad_link ($$;$) {
my ($mid, $level, $s) = @_;
$s ||= '...';
- my $id = id_compress($mid, 1);
- (' 'x19).indent_for($level).th_pfx($level)."<a\nhref=#r$id>($s)</a>\n";
+ my $href = defined($mid) ?
+ ("<a\nhref=#r".id_compress($mid, 1).">($s)</a>\n") :
+ "($s)\n";
+ (' 'x19).indent_for($level).th_pfx($level).$href;
+}
+
+sub _skel_hdr {
+ # my ($mapping, $mid) = @_;
+ ($_[0]->{$_[1] // \'bogus'} // [ "(?)\n" ])->[0];
}
sub _th_index_lite {
my $s = ($idx - 1). ' preceding siblings ...';
$rv .= pad_link($pmid, $level, $s);
} elsif ($idx == 2) {
- my $ppmid = $siblings->[0]->{mid};
- $rv .= $pad . $mapping->{$ppmid}->[0];
+ $rv .= $pad . _skel_hdr($mapping,
+ $siblings->[0] ?
+ $siblings->[0]->{mid} : undef);
}
- $rv .= $pad . $mapping->{$pmid}->[0];
+ $rv .= $pad . _skel_hdr($mapping, $pmid);
}
}
my $s_s = nr_to_s($nr_s, 'sibling', 'siblings');
$attr =~ s!<a\nhref=[^>]+>([^<]+)</a>!$1!s; # no point linking to self
$rv .= "<b>@ $attr";
if ($nr_c) {
- my $cmid = $children->[0]->{mid};
- $rv .= $pad . $mapping->{$cmid}->[0];
+ my $cmid = $children->[0] ? $children->[0]->{mid} : undef;
+ $rv .= $pad . _skel_hdr($mapping, $cmid);
if ($nr_c > 2) {
my $s = ($nr_c - 1). ' more replies';
$rv .= pad_link($cmid, $level + 1, $s);
} elsif (my $cn = $children->[1]) {
- $rv .= $pad . $mapping->{$cn->{mid}}->[0];
+ $rv .= $pad . _skel_hdr($mapping, $cn->{mid});
}
}
my $next = $siblings->[$idx+1] if $siblings && $idx >= 0;
if ($next) {
my $nmid = $next->{mid};
- $rv .= $pad . $mapping->{$nmid}->[0];
+ $rv .= $pad . _skel_hdr($mapping, $nmid);
my $nnext = $nr_s - $idx;
if ($nnext > 2) {
my $s = ($nnext - 1).' subsequent siblings';
$rv .= pad_link($nmid, $level, $s);
} elsif (my $nn = $siblings->[$idx + 2]) {
- $rv .= $pad . $mapping->{$nn->{mid}}->[0];
+ $rv .= $pad . _skel_hdr($mapping, $nn->{mid});
}
}
$rv .= $pad ."<a\nhref=#r$id>$s_s, $s_c; $ctx->{s_nr}</a>\n";
sub stream_thread ($$) {
my ($rootset, $ctx) = @_;
- $ctx->{-queue} = [ map { (0, $_) } @$rootset ];
+ @{$ctx->{-queue}} = map { (0, $_) } @$rootset;
PublicInbox::WwwStream::aresponse($ctx, 200, \&stream_thread_i);
}
# /$INBOX/$MSGID/t/ and /$INBOX/$MSGID/T/
sub thread_html {
my ($ctx) = @_;
+ $ctx->{-upfx} = '../../';
my $mid = $ctx->{mid};
my $ibx = $ctx->{ibx};
my ($nr, $msgs) = $ibx->over->get_thread($mid);
$skel .= " (download: <a\nhref=\"../t.mbox.gz\">mbox.gz</a>";
$skel .= " / follow: <a\nhref=\"../t.atom\">Atom feed</a>)\n";
$skel .= "-- links below jump to the message on this page --\n";
- $ctx->{-upfx} = '../../';
$ctx->{cur_level} = 0;
$ctx->{skel} = \$skel;
$ctx->{prev_attr} = '';
$ctx->{prev_level} = 0;
- $ctx->{root_anchor} = anchor_for($mid);
- $ctx->{mapping} = {};
+ $ctx->{root_anchor} = 'm' . id_compress($mid, 1);
+ $ctx->{mapping} = {}; # mid -> [ header_summary, node, idx, level ]
$ctx->{s_nr} = ($nr > 1 ? "$nr+ messages" : 'only message')
.' in thread';
return unless $part->{bdy};
my $nl = $idx eq '1' ? '' : "\n"; # like join("\n", ...)
- my $size = bytes::length($part->body);
+ my $size = length($part->body);
+ delete $part->{bdy}; # save memory
# hide attributes normally, unless we want to aid users in
# spotting MUA problems:
# makes no difference to browsers, and don't screw up filename
# link generation in diffs with the extra '%0D'
- $s =~ s/\r\n/\n/sg;
+ $s =~ s/\r+\n/\n/sg;
# will be escaped to `•' in HTML
obfuscate_addrs($ibx, $s, "\x{2022}") if $ibx->{obfuscate};
$ctx->{-spfx} = $spfx;
};
- # some editors don't put trailing newlines at the end:
- $s .= "\n" unless $s =~ /\n\z/s;
-
# split off quoted and unquoted blocks:
my @sections = PublicInbox::MsgIter::split_quotes($s);
undef $s; # free memory
attach_link($ctx, $ct, $p, $fn, $err);
$$rv .= "\n";
}
+ delete $part->{bdy}; # save memory
foreach my $cur (@sections) {
if ($cur =~ /\A>/) {
# we use a <span> here to allow users to specify
sub _msg_page_prepare_obuf {
my ($eml, $ctx) = @_;
- my $over = $ctx->{ibx}->over;
+ my $have_over = !!$ctx->{ibx}->over;
my $obfs_ibx = $ctx->{-obfs_ibx};
- my $rv = '';
+ $ctx->{obuf} = \(my $rv = '');
my $mids = mids_for_index($eml);
my $nr = $ctx->{nr}++;
if ($nr) { # unlikely
- $rv .= '<pre>';
+ if ($ctx->{chash} eq content_hash($eml)) {
+ warn "W: BUG? @$mids not deduplicated properly\n";
+ return \$rv;
+ }
+ $rv .=
+"<pre>WARNING: multiple messages have this Message-ID\n</pre><pre>";
} else {
$ctx->{first_hdr} = $eml->header_obj;
- if ($ctx->{smsg}) {
- $rv .=
-"<pre>WARNING: multiple messages have this Message-ID\n</pre>";
- }
+ $ctx->{chash} = content_hash($eml) if $ctx->{smsg}; # reused MID
$rv .= "<pre\nid=b>"; # anchor for body start
}
- $ctx->{-upfx} = '../' if $over;
+ $ctx->{-upfx} = '../' if $have_over;
my @title; # (Subject[0], From[0])
for my $v ($eml->header('From')) {
my @n = PublicInbox::Address::names($v);
my $v = ascii_html(shift @subj);
obfuscate_addrs($obfs_ibx, $v) if $obfs_ibx;
$rv .= 'Subject: ';
- $rv .= $over ? qq(<a\nhref="#r"\nid=t>$v</a>\n) : "$v\n";
+ $rv .= $
have_over ? qq(<a\nhref="#r"\nid=t>$v</a>\n) : "$v\n";
$title[0] = $v;
for $v (@subj) { # multi-Subject message :<
$v = ascii_html($v);
$rv .= "Subject: $v\n";
}
} else { # dummy anchor for thread skeleton at bottom of page
- $rv .= qq(<a\nhref="#r"\nid=t></a>) if $over;
+ $rv .= qq(<a\nhref="#r"\nid=t></a>) if $have_over;
$title[0] = '(no subject)';
}
for my $v ($eml->header('Date')) {
$ctx->{-title_html} = join(' - ', @title);
$rv = $ctx->html_top . $rv;
}
+
+ $ctx->{-linkify} //= PublicInbox::Linkify->new;
if (scalar(@$mids) == 1) { # common case
my $mhtml = ascii_html($mids->[0]);
- $rv .= "Message-ID: <$mhtml> ";
- $rv .= "(<a\nhref=\"raw\">raw</a>)\n";
+ $rv .= qq[Message-ID: <$mhtml> (<a href="raw">raw</a>)\n];
} else {
# X-Alt-Message-ID can happen if a message is injected from
# public-inbox-nntpd because of multiple Message-ID headers.
- my $lnk = PublicInbox::Linkify->new;
my $s = '';
for my $h (qw(Message-ID X-Alt-Message-ID)) {
$s .= "$h: $_\n" for ($eml->header_raw($h));
}
- $lnk->linkify_mids('..', \$s, 1);
+ $ctx->{-linkify}->linkify_mids('..', \$s, 1);
$rv .= $s;
}
- $rv .= _parent_headers($eml, $over);
+ _parent_headers($ctx, $eml);
$rv .= "\n";
\$rv;
}
}
sub _parent_headers {
- my ($hdr, $over) = @_;
- my $rv = '';
+ my ($ctx, $hdr) = @_;
my @irt = $hdr->header_raw('In-Reply-To');
my $refs;
if (@irt) {
- my $lnk = PublicInbox::Linkify->new;
- $rv .= "In-Reply-To: $_\n" for @irt;
- $lnk->linkify_mids('..', \$rv);
+ my $s = '';
+ $s .= "In-Reply-To: $_\n" for @irt;
+ $ctx->{-linkify}->linkify_mids('..', \$s);
+ ${$ctx->{obuf}} .= $s;
} else {
$refs = references($hdr);
my $irt = pop @$refs;
if (defined $irt) {
my $html = ascii_html($irt);
my $href = mid_href($irt);
- $rv .= "In-Reply-To: <";
- $rv .= "<a\nhref=\"../$href/\">$html</a>>\n";
+ ${$ctx->{obuf}} .= <<EOM;
+In-Reply-To: <<a\nhref="../$href/">$html</a>>
+EOM
}
}
# do not display References: if search is present,
# we show the thread skeleton at the bottom, instead.
- return $rv if $over;
+ return if $ctx->{ibx}->over;
$refs //= references($hdr);
if (@$refs) {
- @$refs = map { linkify_ref_no_over($_) } @$refs;
- $rv .= 'References: '. join("\n\t", @$refs) . "\n";
+ $_ = linkify_ref_no_over($_) for @$refs;
+ ${$ctx->{obuf}} .= 'References: '. join("\n\t", @$refs) . "\n";
}
- $rv;
}
# returns a string buffer
sub html_footer {
my ($ctx, $hdr) = @_;
- my $ibx = $ctx->{ibx};
my $upfx = '../';
my $skel;
my $rv = '<pre>';
- if ($ibx->over) {
+ my $related;
+ my $qry = delete $ctx->{-qry};
+ if ($qry && $ctx->{ibx}->isrch) {
+ my $q = ''; # search for either ancestor or descendent patches
+ for (@{$qry->{dfpre}}, @{$qry->{dfpost}}) {
+ chop if length > 7; # include 1 abbrev "older" patches
+ $q .= "dfblob:$_ ";
+ }
+ chop $q; # omit trailing SP
+ local $Text::Wrap::columns = COLS;
+ local $Text::Wrap::huge = 'overflow';
+ $q = wrap('', '', $q);
+ my $rows = ($q =~ tr/\n/\n/) + 1;
+ $q = ascii_html($q);
+ $related = <<EOM;
+<form id=related
+action=$upfx
+><pre>find likely ancestor, descendant, or conflicting patches for <a
+href=#t>this message</a>:
+<textarea name=q cols=${\COLS} rows=$rows>$q</textarea>
+<input type=submit value=search
+/>\t(<a href=${upfx}_/text/help/>help</a>)</pre></form>
+EOM
+ }
+ if ($ctx->{ibx}->over) {
my $t = ts2str($ctx->{-t_max});
my $t_fmt = fmt_ts($ctx->{-t_max});
- $skel .= <<EOF;
- other threads:[<a
+ my $fallback = $related ? "\t" : "<a id=related>\t</a>";
+ $skel = <<EOF;
+${fallback}other threads:[<a
href="$upfx?t=$t">~$t_fmt UTC</a>|<a
href="$upfx">newest</a>]
EOF
$rv .= qq(<a\nhref="#R">reply</a>);
$rv .= $skel;
$rv .= '</pre>';
+ $rv .= $related // '';
$rv .= msg_reply($ctx, $hdr);
}
"<<a\nhref=\"../$href/\">$html</a>>";
}
-sub anchor_for {
- my ($msgid) = @_;
- 'm' . id_compress($msgid, 1);
-}
-
sub ghost_parent {
my ($upfx, $mid) = @_;
$$skel .= delete($ctx->{sl_note}) || '';
}
- my $f = ascii_html($smsg->{from_name});
+ my $f = ascii_html(delete $smsg->{from_name});
my $obfs_ibx = $ctx->{-obfs_ibx};
obfuscate_addrs($obfs_ibx, $f) if $obfs_ibx;
}
sub sort_ds {
- [ sort {
+ @{$_[0]} = sort {
(eval { $a->topmost->{ds} } || 0) <=>
(eval { $b->topmost->{ds} } || 0)
- } @{$_[0]} ];
+ } @{$_[0]};
}
# accumulate recent topics if search is supported
}
my @out;
- my $ibx = $ctx->{ibx};
- my $obfs_ibx = $ibx->{obfuscate} ? $ibx : undef;
-
+ my $obfs_ibx = $ctx->{ibx}->{obfuscate} ? $ctx->{ibx} : undef;
+ if (my $note = delete $ctx->{t_note}) {
+ push @out, $note; # "messages from ... to ..."
+ }
# sort by recency, this allows new posts to "bump" old topics...
foreach my $topic (sort { $b->[0] <=> $a->[0] } @$order) {
my ($ds, $n, $seen, $top_subj, @extra) = @$topic;
$anchor = '#t'; # thread skeleton
}
- my $mbox = qq(<a\nhref="$href/t.mbox.gz">mbox.gz</a>);
- my $atom = qq(<a\nhref="$href/t.atom">Atom</a>);
my $s = "<a\nhref=\"$href/T/$anchor\">$top_subj</a>\n" .
- " $ds UTC $n - $mbox / $atom\n";
- for (my $i = 0; $i < scalar(@extra); $i += 2) {
- my $level = $extra[$i];
- my $subj = $extra[$i + 1]; # already normalized
+ " $ds UTC $n\n";
+ while (@extra) {
+ my $level = shift @extra;
+ my $subj = shift @extra; # already normalized
$mid = delete $seen->{$subj};
my @subj = split(/ /, $subj);
my @next_prev = @subj; # full copy
$next = $next ? "$next | " : ' | ';
$prev .= qq[ | <a\nhref="$latest">latest</a>];
}
- "<hr><pre>page: $next$prev</pre>";
+ ($next || $prev) ? "<hr><pre id=nav>page: $next$prev</pre>" : '';
}
sub paginate_recent ($$) {
$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->{ibx};
- my $msgs = $ibx->recent($opts, $after, $before);
- my $nr = scalar @$msgs;
- if ($nr < $lim && defined($after)) {
+ my $msgs = $ctx->{ibx}->over->recent($opts, $after, $before);
+ if (defined($after) && scalar(@$msgs) < $lim) {
$after = $before = undef;
- $msgs = $ibx->recent($opts);
- $nr = scalar @$msgs;
+ $msgs = $ctx->{ibx}->over->recent($opts);
}
- my $more = $nr == $lim;
+ my $more = scalar(@$msgs) == $lim;
my ($newest, $oldest);
- if ($nr) {
+ if (@$msgs) {
$newest = $msgs->[0]->{ts};
$oldest = $msgs->[-1]->{ts};
# if we only had $after, our SQL query in ->recent ordered
if ($newest < $oldest) {
($oldest, $newest) = ($newest, $oldest);
- $more = 0 if defined($after) && $after < $oldest;
+ $more = undef if defined($after) && $after < $oldest;
+ }
+ if (defined($after // $before)) {
+ my $n = strftime('%Y-%m-%d %H:%M:%S', gmtime($newest));
+ my $o = strftime('%Y-%m-%d %H:%M:%S', gmtime($oldest));
+ $ctx->{t_note} = <<EOM;
+ messages from $o to $n UTC, [<a href="#nav">more...</a>]
+EOM
+ my $s = ts2str($newest);
+ $ctx->{prev_page} = qq[<a\nhref="?t=$s-"\nrel=prev>] .
+ 'prev (newer)</a>';
}
}
if (defined($oldest) && $more) {
$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 (newer)</a>';
- }
$msgs;
}
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);
- }
- html_oneshot($ctx, dump_topics($ctx), \pagination_footer($ctx, '.'));
-
+ walk_thread(thread_results($ctx, $msgs), $ctx, \&acc_topic) if @$msgs;
+ html_oneshot($ctx, dump_topics($ctx), pagination_footer($ctx, '.'));
}
sub thread_adj_level {
sub ghost_index_entry {
my ($ctx, $level, $node) = @_;
my ($beg, $end) = thread_adj_level($ctx, $level);
- $beg . '<pre>'. ghost_parent($ctx->{-upfx}, $node->{mid})
+ $beg . '<pre>'. ghost_parent($ctx->{-upfx}, $node->{mid} // '?')
. '</pre>' . $end;
}