X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwText.pm;h=817d032c7cfae925051766fd665c424bd9fd8942;hb=af0b0fb7a454470a32c452119d0392e0dedb3fe1;hp=ea50428e35c826be79898bee14531030396fe576;hpb=f82c96666b5d51b426f227578112ba3a4fde0538;p=public-inbox.git

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index ea50428e..817d032c 100644
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # used for displaying help texts and other non-mail content
@@ -11,7 +11,6 @@ use PublicInbox::WwwStream;
 use PublicInbox::Hval qw(ascii_html);
 use URI::Escape qw(uri_escape_utf8);
 use PublicInbox::GzipFilter qw(gzf_maybe);
-use Compress::Raw::Zlib qw(Z_FINISH Z_OK);
 our $QP_URL = 'https://xapian.org/docs/queryparser.html';
 our $WIKI_URL = 'https://en.wikipedia.org/wiki';
 my $hl = eval {
@@ -39,21 +38,18 @@ sub get_text {
 	}
 	my $env = $ctx->{env};
 	if ($raw) {
-		my $body;
-		if (my $gzf = $code == 200 ? gzf_maybe($hdr, $env) : undef) {
-			my $zbuf = $gzf->translate($txt);
-			undef $txt;
-			$body = [ $zbuf .= $gzf->translate(undef) ];
-		} else {
-			$body = [ $txt ];
+		if ($code == 200) {
+			my $gzf = gzf_maybe($hdr, $env);
+			$txt = $gzf->translate($txt);
+			$txt .= $gzf->zflush;
 		}
-		$hdr->[3] = bytes::length($body->[0]);
-		return [ $code, $hdr, $body ]
+		$hdr->[3] = bytes::length($txt);
+		return [ $code, $hdr, [ $txt ] ]
 	}
 
 	# enforce trailing slash for "wget -r" compatibility
 	if (!$have_tslash && $code == 200) {
-		my $url = $ctx->{-inbox}->base_url($env);
+		my $url = $ctx->{ibx}->base_url($env);
 		$url .= "_/text/$key/";
 
 		return [ 302, [ 'Content-Type', 'text/plain',
@@ -104,7 +100,7 @@ sub _srch_prefix ($$) {
 
 sub _colors_help ($$) {
 	my ($ctx, $txt) = @_;
-	my $ibx = $ctx->{-inbox};
+	my $ibx = $ctx->{ibx};
 	my $env = $ctx->{env};
 	my $base_url = $ibx->base_url($env);
 	$$txt .= "color customization for $base_url\n";
@@ -139,18 +135,20 @@ sub URI_PATH () { '^A-Za-z0-9\-\._~/' }
 # n.b. this is a perfect candidate for memoization
 sub inbox_config ($$$) {
 	my ($ctx, $hdr, $txt) = @_;
-	my $ibx = $ctx->{-inbox};
+	my $ibx = $ctx->{ibx};
 	push @$hdr, 'Content-Disposition', 'inline; filename=inbox.config';
 	my $name = dq_escape($ibx->{name});
 	my $inboxdir = '/path/to/top-level-inbox';
+	my $base_url = $ibx->base_url($ctx->{env});
 	$$txt .= <<EOS;
-; example public-inbox config snippet for "$name"
-; see public-inbox-config(5) manpage for more details:
+; Example public-inbox config snippet for a mirror of
+; $base_url
+; See public-inbox-config(5) manpage for more details:
 ; https://public-inbox.org/public-inbox-config.html
 [publicinbox "$name"]
 	inboxdir = $inboxdir
-	; note: public-inbox before v1.2.0 used "mainrepo"
-	; instead of "inboxdir", both remain supported after 1.2
+	; note: public-inbox before v1.2.0 used `mainrepo' instead of
+	; `inboxdir', both remain supported after 1.2
 	mainrepo = $inboxdir
 	url = https://example.com/$name/
 	url = http://example.onion/$name/
@@ -160,7 +158,6 @@ EOS
 		$$txt .= "\t$k = $_\n" for @$v;
 	}
 	if (my $altid = $ibx->{altid}) {
-		my $base_url = $ibx->base_url($ctx->{env});
 		my $altid_map = $ibx->altid_map;
 		$$txt .= <<EOF;
 	; altid DBs may be used to provide numeric article ID lookup from
@@ -185,10 +182,16 @@ EOF
 	# and drop the original structure
 	if (defined(my $cr = $ibx->{coderepo})) {
 		$$txt .= "\tcoderepo = $_\n" for @$cr;
+		$$txt .= <<'EOF';
 
-		my $pi_config = $ctx->{www}->{pi_config};
+; `coderepo' entries allows blob reconstruction via patch emails if
+; the inbox is indexed with Xapian.  `@@ <from-range> <to-range> @@'
+; line number ranges in `[PATCH]' emails link to /$INBOX_NAME/$OID/s/,
+; an HTTP endpoint which reconstructs git blobs via git-apply(1).
+EOF
+		my $pi_cfg = $ctx->{www}->{pi_cfg};
 		for my $cr_name (@$cr) {
-			my $urls = $pi_config->{"coderepo.$cr_name.cgiturl"};
+			my $urls = $pi_cfg->{"coderepo.$cr_name.cgiturl"};
 			my $path = "/path/to/$cr_name";
 			$cr_name = dq_escape($cr_name);
 
@@ -196,11 +199,11 @@ EOF
 			if ($urls && scalar(@$urls)) {
 				$$txt .= "\t; ";
 				$$txt .= join(" ||\n\t;\t", map {;
-					my $cpath = $path;
+					my $dst = $path;
 					if ($path !~ m![a-z0-9_/\.\-]!i) {
-						$cpath = dq_escape($cpath);
+						$dst = '"'.dq_escape($dst).'"';
 					}
-					qq(git clone $_ "$cpath");
+					qq(git clone $_ $dst);
 				} @$urls);
 				$$txt .= "\n";
 			}
@@ -218,7 +221,7 @@ sub _default_text ($$$$) {
 	return inbox_config($ctx, $hdr, $txt) if $key eq 'config';
 	return if $key ne 'help'; # TODO more keys?
 
-	my $ibx = $ctx->{-inbox};
+	my $ibx = $ctx->{ibx};
 	my $base_url = $ibx->base_url($ctx->{env});
 	$$txt .= "public-inbox help for $base_url\n";
 	$$txt .= <<EOF;
@@ -247,7 +250,7 @@ EOF
 
 	# n.b. we use the Xapian DB for any regeneratable,
 	# order-of-arrival-independent data.
-	my $srch = $ibx->search;
+	my $srch = $ibx->isrch;
 	if ($srch) {
 		$$txt .= <<EOF;
 search
@@ -335,6 +338,7 @@ contact
 
     This help text is maintained by public-inbox developers
     reachable via plain-text email at: meta\@public-inbox.org
+    Their inbox is archived at: https://public-inbox.org/meta/
 
 EOF
 	# TODO: support admin contact info in ~/.public-inbox/config