X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=fd558e1b799bb45c8a86797f6b78d0afdcab483a;hb=89ebf169c3d5edd4f0c19124d586f076fb8d43b2;hp=c708c21f21741b43f04b51caab59e6d63f6cd966;hpb=7a3946ef122e8218c6ce3355d7f968562212d53b;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index c708c21f..fd558e1b 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2016-2018 all contributors +# Copyright (C) 2016-2020 all contributors # License: AGPL-3.0+ # # HTML body stream for which yields getline+close methods @@ -8,52 +8,57 @@ # more common "push" model) package PublicInbox::WwwStream; use strict; -use warnings; -use PublicInbox::Hval qw(ascii_html); -use URI; +use parent qw(Exporter); +our @EXPORT_OK = qw(html_oneshot); +use bytes (); # length +use PublicInbox::Hval qw(ascii_html prurl); +use PublicInbox::GzipFilter qw(gzf_maybe); our $TOR_URL = 'https://www.torproject.org/'; -our $TOR2WEB_URL = 'https://www.tor2web.org/'; -our $CODE_URL = 'https://public-inbox.org/'; -our $PROJECT = 'public-inbox'; +our $CODE_URL = 'https://public-inbox.org/public-inbox.git'; # noop for HTTP.pm (and any other PSGI servers) sub close {} -sub new { - my ($class, $ctx, $cb) = @_; - bless { nr => 0, cb => $cb || *close, ctx => $ctx }, $class; +sub base_url ($) { + my $ctx = shift; + my $base_url = $ctx->{-inbox}->base_url($ctx->{env}); + chop $base_url; # no trailing slash for clone + $base_url; +} + +sub init { + my ($ctx, $cb) = @_; + $ctx->{cb} = $cb; + $ctx->{base_url} = base_url($ctx); + bless $ctx, __PACKAGE__; } sub response { - my ($class, $ctx, $code, $cb) = @_; - [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ], - $class->new($ctx, $cb) ] + my ($ctx, $code, $cb) = @_; + my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ]; + init($ctx, $cb); + $ctx->{gzf} = gzf_maybe($h, $ctx->{env}); + [ $code, $h, $ctx ] } -sub _html_top ($) { - my ($self) = @_; - my $ctx = $self->{ctx}; +sub html_top ($) { + my ($ctx) = @_; my $ibx = $ctx->{-inbox}; my $desc = ascii_html($ibx->description); - my $title = $ctx->{-title_html} || $desc; + my $title = delete($ctx->{-title_html}) // $desc; my $upfx = $ctx->{-upfx} || ''; my $help = $upfx.'_/text/help'; my $color = $upfx.'_/text/color'; my $atom = $ctx->{-atom} || $upfx.'new.atom'; - my $tip = $ctx->{-html_tip} || ''; my $top = "$desc"; my $links = "help / ". "color / ". "Atom feed"; if ($ibx->search) { - my $q_val = $ctx->{-q_value_html}; - if (defined $q_val && $q_val ne '') { - $q_val = qq(\nvalue="$q_val"); - } else { - $q_val = ''; - } + my $q_val = delete($ctx->{-q_value_html}) // ''; + $q_val = qq(\nvalue="$q_val") if $q_val ne ''; # XXX gross, for SearchView.pm - my $extra = $ctx->{-extra_form_html} || ''; + my $extra = delete($ctx->{-extra_form_html}) // ''; my $action = $upfx eq '' ? './' : $upfx; $top = qq{
$top} .
 			  qq{\n} .
@@ -65,59 +70,55 @@ sub _html_top ($) {
 		$top = '
' . $top . "\n" . $links . '
';
 	}
 	"$title" .
-		"" .
+		qq() .
 	        $ctx->{www}->style($upfx) .
-		"". $top . $tip;
+		''. $top . (delete($ctx->{-html_tip}) // '');
 }
 
 sub code_footer ($) {
 	my ($env) = @_;
-	my $u = PublicInbox::Hval::prurl($env, $CODE_URL);
-	qq(AGPL code for this site: git clone $u $PROJECT)
+	my $u = prurl($env, $CODE_URL);
+	qq(AGPL code for this site: git clone $u)
 }
 
 sub _html_end {
-	my ($self) = @_;
+	my ($ctx) = @_;
 	my $urls = 'Archives are clonable:';
-	my $ctx = $self->{ctx};
 	my $ibx = $ctx->{-inbox};
 	my $desc = ascii_html($ibx->description);
 
-	my (%seen, @urls);
-	my $http = $ibx->base_url($ctx->{env});
-	chop $http; # no trailing slash for clone
-	my $part = $ibx->max_git_part;
+	my @urls;
+	my $http = $ctx->{base_url};
+	my $max = $ibx->max_git_epoch;
 	my $dir = (split(m!/!, $http))[-1];
-	if (defined($part)) { # v2
-		$seen{$http} = 1;
-		for my $i (0..$part) {
+	my %seen = ($http => 1);
+	if (defined($max)) { # v2
+		for my $i (0..$max) {
 			# old parts my be deleted:
-			-d "$ibx->{mainrepo}/git/$i.git" or next;
+			-d "$ibx->{inboxdir}/git/$i.git" or next;
 			my $url = "$http/$i";
 			$seen{$url} = 1;
 			push @urls, "$url $dir/git/$i.git";
 		}
 	} else { # v1
-		$seen{$http} = 1;
 		push @urls, $http;
 	}
 
-	# FIXME: partitioning in can be different in other repositories,
+	# FIXME: epoch splits can be different in other repositories,
 	# use the "cloneurl" file as-is for now:
 	foreach my $u (@{$ibx->cloneurl}) {
-		next if $seen{$u};
-		$seen{$u} = 1;
+		next if $seen{$u}++;
 		push @urls, $u =~ /\Ahttps?:/ ? qq($u) : $u;
 	}
 
-	if (defined($part) || scalar(@urls) > 1) {
+	if (defined($max) || scalar(@urls) > 1) {
 		$urls .= "\n" .
 			join("\n", map { "\tgit clone --mirror $_" } @urls);
 	} else {
 		$urls .= " git clone --mirror $urls[0]";
 	}
-	if (defined $part) {
+	if (defined $max) {
 		my $addrs = $ibx->{address};
 		$addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
 		$urls .=  <{-upfx} // '').'_/text/config/raw';
+	$urls .= qq(\nExample config snippet for mirrors\n);
 	my @nntp = map { qq($_) } @{$ibx->nntp_url};
 	if (@nntp) {
-		$urls .= "\n\n";
+		$urls .= "\n";
 		$urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
 		$urls .= ' available over NNTP:';
 		$urls .= "\n\t" . join("\n\t", @nntp) . "\n";
@@ -140,10 +146,6 @@ EOF
 	if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
 		$urls .= "\n note: .onion URLs require Tor: ";
 		$urls .= qq[$TOR_URL];
-		if ($TOR2WEB_URL) {
-			$urls .= "\n       or Tor2web: ";
-			$urls .= qq[$TOR2WEB_URL];
-		}
 	}
 	'
'.join("\n\n",
 		$desc,
@@ -154,16 +156,36 @@ EOF
 
 # callback for HTTP.pm (and any other PSGI servers)
 sub getline {
-	my ($self) = @_;
-	my $nr = $self->{nr}++;
+	my ($ctx) = @_;
+	my $cb = $ctx->{cb};
+	my $buf = $cb->($ctx) if $cb;
+	$buf //= delete($ctx->{cb}) ? _html_end($ctx) : undef;
 
-	return _html_top($self) if $nr == 0;
+	# gzf may be GzipFilter, `undef' or `0'
+	my $gzf = $ctx->{gzf} or return $buf;
 
-	if (my $middle = $self->{cb}) {
-		$middle = $middle->($nr, $self->{ctx}) and return $middle;
-	}
+	return $gzf->translate($buf) if defined $buf;
+	$ctx->{gzf} = 0; # next call to ->getline returns $buf (== undef)
+	$gzf->translate(undef);
+}
 
-	delete $self->{cb} ? _html_end($self) : undef;
+sub html_oneshot ($$;$) {
+	my ($ctx, $code, $sref) = @_;
+	$ctx->{base_url} = base_url($ctx);
+	bless $ctx, __PACKAGE__;
+	my @x;
+	my $h = [ 'Content-Type' => 'text/html; charset=UTF-8',
+		'Content-Length' => undef ];
+	if (my $gzf = gzf_maybe($h, $ctx->{env})) {
+		$gzf->zmore(html_top($ctx));
+		$gzf->zmore($$sref) if $sref;
+		$x[0] = $gzf->zflush(_html_end($ctx));
+		$h->[3] = length($x[0]);
+	} else {
+		@x = (html_top($ctx), $sref ? $$sref : (), _html_end($ctx));
+		$h->[3] += bytes::length($_) for @x;
+	}
+	[ $code, $h, \@x ]
 }
 
 1;