* [PATCH 0/4] more tweaks and finalize WwwStream conversion
@ 2016-07-07 1:50 7% Eric Wong
2016-07-07 1:50 4% ` [PATCH 4/4] www: remove old footer generation code and normalize new.html Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2016-07-07 1:50 UTC (permalink / raw)
To: meta
Finally, we now have consistent HTML for all of our non-error
pages and we have fewer layering violations for cleanup.
Eric Wong (4):
githttpbackend: avoid intermediate array creation from stat
t/git-http-backend: check BSD::Resource availability
inbox: cleanup and consolidate object weakening
www: remove old footer generation code and normalize new.html
lib/PublicInbox/Feed.pm | 86 ++++++++++-----------------------------
lib/PublicInbox/GitHTTPBackend.pm | 3 +-
lib/PublicInbox/HTTP.pm | 16 --------
lib/PublicInbox/Inbox.pm | 37 +++++++++++++++--
lib/PublicInbox/NNTP.pm | 17 --------
lib/PublicInbox/View.pm | 47 ++++++++++++++++-----
lib/PublicInbox/WWW.pm | 44 +-------------------
t/cgi.t | 17 +-------
t/git-http-backend.t | 2 +-
t/html_index.t | 16 --------
t/plack.t | 4 +-
11 files changed, 98 insertions(+), 191 deletions(-)
^ permalink raw reply [relevance 7%]
* [PATCH 4/4] www: remove old footer generation code and normalize new.html
2016-07-07 1:50 7% [PATCH 0/4] more tweaks and finalize WwwStream conversion Eric Wong
@ 2016-07-07 1:50 4% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2016-07-07 1:50 UTC (permalink / raw)
To: meta
We now generate all of our HTML using WwwStream which
forces us to have consistent headers and footers in
the HTML itself.
This also makes the search-capable vs search-less installs
go to the new.html endpoint to maintain consistency
(in case an admin decides to enable Xapian).
---
lib/PublicInbox/Feed.pm | 86 +++++++++++++------------------------------------
lib/PublicInbox/View.pm | 47 +++++++++++++++++++++------
lib/PublicInbox/WWW.pm | 42 +-----------------------
t/cgi.t | 17 +---------
t/html_index.t | 16 ---------
t/plack.t | 4 +--
6 files changed, 63 insertions(+), 149 deletions(-)
diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm
index 026a069..65adf37 100644
--- a/lib/PublicInbox/Feed.pm
+++ b/lib/PublicInbox/Feed.pm
@@ -31,7 +31,19 @@ sub generate_thread_atom {
sub generate_html_index {
my ($ctx) = @_;
- sub { emit_html_index($_[0], $ctx) };
+ # if the 'r' query parameter is given, it is a legacy permalink
+ # which we must continue supporting:
+ my $qp = $ctx->{qp};
+ if ($qp && !$qp->{r} && $ctx->{srch}) {
+ return PublicInbox::View::index_topics($ctx);
+ }
+
+ my $env = $ctx->{env};
+ my $url = $ctx->{-inbox}->base_url($env) . 'new.html';
+ my $qs = $env->{QUERY_STRING};
+ $url .= "?$qs" if $qs ne '';
+ [302, [ 'Location', $url, 'Content-Type', 'text/plain'],
+ [ "Redirecting to $url\n" ] ];
}
sub new_html {
@@ -56,7 +68,7 @@ sub new_html {
$s .= '</pre>' unless $more;
return $s;
}
- undef;
+ new_html_footer($ctx, $last);
});
}
@@ -159,74 +171,20 @@ sub _html_index_top {
"</head><body>$top";
}
-sub emit_html_index {
- my ($res, $ctx) = @_;
- my $feed_opts = get_feedopts($ctx);
- my $fh = $res->([200,['Content-Type'=>'text/html; charset=UTF-8']]);
-
- my $max = $ctx->{max} || MAX_PER_PAGE;
- $ctx->{-upfx} = '';
-
- my ($footer, $param, $last);
- $ctx->{seen} = {};
- $ctx->{anchor_idx} = 0;
- $ctx->{fh} = $fh;
- my $srch = $ctx->{srch};
- $fh->write(_html_index_top($feed_opts, $srch));
-
- # if the 'r' query parameter is given, it is a legacy permalink
- # which we must continue supporting:
- my $qp = $ctx->{qp};
- if ($qp && !$qp->{r} && $srch) {
- $last = PublicInbox::View::emit_index_topics($ctx);
- $param = 'o';
- } else {
- $last = emit_index_nosrch($ctx);
- $param = 'r';
- }
- $footer = nav_footer($ctx, $last, $feed_opts, $param);
- if ($footer) {
- my $list_footer = $ctx->{footer};
- $footer .= "\n\n" . $list_footer if $list_footer;
- $footer = "<hr><pre>$footer</pre>";
- }
- $fh->write("$footer</body></html>");
- $fh->close;
-}
-
-sub emit_index_nosrch {
- my ($ctx) = @_;
- my $ibx = $ctx->{-inbox};
- my $fh = $ctx->{fh};
- my (undef, $last) = each_recent_blob($ctx, sub {
- my ($path, $commit, $ts, $u, $subj) = @_;
- $ctx->{first} ||= $commit;
-
- my $mime = do_cat_mail($ibx, $path) or return 0;
- $fh->write(PublicInbox::View::index_entry($mime, $ctx, 1));
- 1;
- });
- $last;
-}
-
-sub nav_footer {
- my ($ctx, $last, $feed_opts, $param) = @_;
- my $qp = $ctx->{qp} or return '';
- my $old_r = $qp->{$param};
- my $head = ' ';
+sub new_html_footer {
+ my ($ctx, $last) = @_;
+ my $qp = delete $ctx->{qp} or return;
+ my $old_r = $qp->{r};
+ my $latest = '';
my $next = ' ';
- my $first = $ctx->{first};
- my $anchor = $ctx->{anchor_idx};
if ($last) {
- $next = qq!<a\nhref="?$param=$last"\nrel=next>next</a>!;
+ $next = qq!<a\nhref="?r=$last"\nrel=next>next</a>!;
}
if ($old_r) {
- $head = $ctx->{env}->{PATH_INFO};
- $head = qq!<a\nhref="$head">head</a>!;
+ $latest = qq! <a\nhref='./new.html'>latest</a>!;
}
- my $atom = "<a\nhref=\"$feed_opts->{atomurl}\">Atom feed</a>";
- "<a\nname=\"s$anchor\">page:</a> $next $head $atom";
+ "<hr><pre>page: $next$latest</pre>";
}
sub each_recent_blob {
diff --git a/lib/PublicInbox/View.pm b/lib/PublicInbox/View.pm
index 7ff3b40..0903550 100644
--- a/lib/PublicInbox/View.pm
+++ b/lib/PublicInbox/View.pm
@@ -24,7 +24,7 @@ sub th_pfx ($) { $_[0] == 0 ? '' : TCHILD };
# public functions: (unstable)
sub msg_html {
- my ($ctx, $mime, $footer) = @_;
+ my ($ctx, $mime) = @_;
my $hdr = $mime->header_obj;
my $tip = _msg_html_prepare($hdr, $ctx);
PublicInbox::WwwStream->response($ctx, 200, sub {
@@ -853,13 +853,15 @@ sub add_topic {
}
}
-sub emit_topics {
+sub topics {
my ($ctx) = @_;
my $order = $ctx->{order};
my $subjs = $ctx->{subjs};
my $latest = $ctx->{latest};
- my $fh = $ctx->{fh};
- return $fh->write("\n[No topics in range]</pre>") unless scalar @$order;
+ if (!@$order) {
+ $ctx->{-html_tip} = '<pre>[No topics in range]</pre>';
+ return 404;
+ }
my $pfx;
my $prev = 0;
my $prev_attr = '';
@@ -903,13 +905,38 @@ sub emit_topics {
}
push @recent, $cur if $cur;
@recent = map { $_->[1] } sort { $b->[0] <=> $a->[0] } @recent;
- $fh->write(join('', @recent) . '</pre>');
+ $ctx->{-html_tip} = join('', '<pre>', @recent, '</pre>');
+ 200;
}
-sub emit_index_topics {
+sub index_nav { # callback for WwwStream
+ my (undef, $ctx) = @_;
+ delete $ctx->{qp} or return;
+ my ($next, $prev);
+ $next = $prev = ' ';
+ my $latest = '';
+
+ my $next_o = $ctx->{-next_o};
+ if ($next_o) {
+ $next = qq!<a\nhref="?o=$next_o"\nrel=next>next</a>!;
+ }
+ if (my $cur_o = $ctx->{-cur_o}) {
+ $latest = qq! <a\nhref=.>latest</a>!;
+
+ my $o = $cur_o - ($next_o - $cur_o);
+ if ($o > 0) {
+ $prev = qq!<a\nhref="?o=$o"\nrel=prev>prev</a>!;
+ } elsif ($o == 0) {
+ $prev = qq!<a\nhref=.\nrel=prev>prev</a>!;
+ }
+ }
+ "<hr><pre>page: $next $prev$latest</pre>";
+}
+
+sub index_topics {
my ($ctx) = @_;
my ($off) = (($ctx->{qp}->{o} || '0') =~ /(\d+)/);
- $ctx->{order} = [];
+ my $order = $ctx->{order} = [];
$ctx->{subjs} = {};
$ctx->{latest} = {};
my $max = 25;
@@ -921,9 +948,9 @@ sub emit_index_topics {
walk_thread(thread_results($sres), $ctx, *add_topic);
$opts{offset} += $nr;
}
-
- emit_topics($ctx);
- $opts{offset};
+ $ctx->{-next_o} = $opts{offset};
+ $ctx->{-cur_o} = $off;
+ PublicInbox::WwwStream->response($ctx, topics($ctx), *index_nav);
}
sub thread_adj_level {
diff --git a/lib/PublicInbox/WWW.pm b/lib/PublicInbox/WWW.pm
index 5de5ffe..2c60d59 100644
--- a/lib/PublicInbox/WWW.pm
+++ b/lib/PublicInbox/WWW.pm
@@ -198,7 +198,6 @@ sub get_index {
my ($ctx) = @_;
require PublicInbox::Feed;
my $srch = searcher($ctx);
- footer($ctx);
if ($ctx->{env}->{QUERY_STRING} =~ /(?:\A|[&;])q=/) {
require PublicInbox::SearchView;
PublicInbox::SearchView::sres_top_html($ctx);
@@ -227,11 +226,10 @@ sub get_mid_html {
my $x = mid2blob($ctx) or return r404($ctx);
require PublicInbox::View;
- my $foot = footer($ctx);
require Email::MIME;
my $mime = Email::MIME->new($x);
searcher($ctx);
- PublicInbox::View::msg_html($ctx, $mime, $foot);
+ PublicInbox::View::msg_html($ctx, $mime);
}
# /$INBOX/$MESSAGE_ID/t/
@@ -250,44 +248,6 @@ sub ctx_get {
$val;
}
-sub footer {
- my ($ctx) = @_;
- return '' unless $ctx;
- my $obj = $ctx->{-inbox} or return '';
-
- # auto-generate a footer
- chomp(my $desc = $obj->description);
- $desc = PublicInbox::Hval::ascii_html($desc);
-
- my $urls;
- my @urls = @{$obj->cloneurl};
- my %seen = map { $_ => 1 } @urls;
- my $env = $ctx->{env};
- my $http = $obj->base_url($env);
- chop $http;
- $seen{$http} or unshift @urls, $http;
- my $ssoma_url = PublicInbox::Hval::prurl($env, SSOMA_URL);
- if (scalar(@urls) == 1) {
- $urls = "URL for <a\nhref=\"" . $ssoma_url .
- qq(">ssoma</a> or <b>git clone --mirror $urls[0]</b>);
- } else {
- $urls = "URLs for <a\nhref=\"" . $ssoma_url .
- qq(">ssoma</a> or <b>git clone --mirror</b>\n) .
- join("\n", map { "\tgit clone --mirror $_" } @urls);
- }
-
- my $addr = $obj->{-primary_address};
- $ctx->{footer} = join("\n",
- '- ' . $desc,
- "A <a\nhref=\"" .
- PublicInbox::Hval::prurl($ctx->{env}, PI_URL) .
- '">public-inbox</a>, ' .
- 'anybody may post in plain-text (not HTML):',
- $addr,
- $urls
- );
-}
-
# search support is optional, returns undef if Xapian is not installed
# or not configured for the given GIT_DIR
sub searcher {
diff --git a/t/cgi.t b/t/cgi.t
index 720925a..a0f09c5 100644
--- a/t/cgi.t
+++ b/t/cgi.t
@@ -131,21 +131,6 @@ EOF
like($res->{body}, qr/what\?/, "reply included");
}
-# indices
-{
- local $ENV{HOME} = $home;
- my $res = cgi_run("/test/");
- like($res->{head}, qr/Status: 200 OK/, "index returns 200");
-
- my $idx = cgi_run("/test/index.html");
- $idx->{body} =~ s!/index.html(\?r=)!/$1!g; # dirty...
- $idx->{body} = [ split(/\n/, $idx->{body}) ];
- $res->{body} = [ split(/\n/, $res->{body}) ];
- is_deeply($res, $idx,
- '/$INBOX/ and /$INBOX/index.html are nearly identical');
- # more checks in t/feed.t
-}
-
# message-id pages
{
local $ENV{HOME} = $home;
@@ -187,7 +172,7 @@ EOF
$res = cgi_run("/test/blahblah\@example.con/");
like($res->{head}, qr/Status: 300 Multiple Choices/, "mid html miss");
- $res = cgi_run("/test/");
+ $res = cgi_run("/test/new.html");
like($res->{body}, qr/slashy%2Fasdf%40example\.com/,
"slashy URL generated correctly");
}
diff --git a/t/html_index.t b/t/html_index.t
index 100d21a..f29b442 100644
--- a/t/html_index.t
+++ b/t/html_index.t
@@ -26,11 +26,6 @@ my $im = PublicInbox::Import->new($git, 'tester', 'test@example');
my $prev = "";
foreach my $i (1..6) {
- # my $pid = open(my $pipe, "|-");
- # defined $pid or die "fork/pipe failed: $!\n";
- # if ($pid == 0) {
- # exec("ssoma-mda", $git_dir);
- # }
my $mid = "<$i\@example.com>";
my $mid_line = "Message-ID: $mid";
if ($prev) {
@@ -58,15 +53,4 @@ EOF
$im->done;
}
-# check HTML index
-{
- use IO::File;
- my $cb = PublicInbox::Feed::generate_html_index({
- -inbox => $ibx,
- max => 3
- });
- require 't/common.perl';
- like(stream_to_string($cb), qr/html/, "feed is valid HTML :)");
-}
-
done_testing();
diff --git a/t/plack.t b/t/plack.t
index 40298e5..db3a9b2 100644
--- a/t/plack.t
+++ b/t/plack.t
@@ -120,9 +120,9 @@ EOF
test_psgi($app, sub {
my ($cb) = @_;
my $atomurl = 'http://example.com/test/new.atom';
- my $res = $cb->(GET('http://example.com/test/'));
+ my $res = $cb->(GET('http://example.com/test/new.html'));
is(200, $res->code, 'success response received');
- like($res->content, qr!href="\Q$atomurl\E"!,
+ like($res->content, qr!href="new\.atom"!,
'atom URL generated');
like($res->content, qr!href="blah%40example\.com/"!,
'index generated');
--
EW
^ permalink raw reply related [relevance 4%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2016-07-07 1:50 7% [PATCH 0/4] more tweaks and finalize WwwStream conversion Eric Wong
2016-07-07 1:50 4% ` [PATCH 4/4] www: remove old footer generation code and normalize new.html Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).