wwwtext: describe the use of `coderepo' entries

[public-inbox.git] / lib / PublicInbox / WwwText.pm

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index 2008ba0928decaba609dadbd8e67515cea2678fa..81c0ee4abfc889fbb9939498296e4d6cff4118a6 100644 (file)
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -10,6 +10,7 @@ use PublicInbox::Linkify;
 use PublicInbox::WwwStream;
 use PublicInbox::Hval qw(ascii_html);
 use URI::Escape qw(uri_escape_utf8);
+use PublicInbox::GzipFilter qw(gzf_maybe);
 our $QP_URL = 'https://xapian.org/docs/queryparser.html';
 our $WIKI_URL = 'https://en.wikipedia.org/wiki';
 my $hl = eval {
@@ -35,14 +36,20 @@ sub get_text {
                $code = 404;
                $txt = "404 Not Found ($key)\n";
        }
+       my $env = $ctx->{env};
        if ($raw) {
+               if ($code == 200) {
+                       my $gzf = gzf_maybe($hdr, $env);
+                       $txt = $gzf->translate($txt);
+                       $txt .= $gzf->zflush;
+               }
                $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($ctx->{env});
+               my $url = $ctx->{-inbox}->base_url($env);
                $url .= "_/text/$key/";
 
                return [ 302, [ 'Content-Type', 'text/plain',
@@ -53,25 +60,18 @@ sub get_text {
        # Follow git commit message conventions,
        # first line is the Subject/title
        my ($title) = ($txt =~ /\A([^\n]*)/s);
-       $ctx->{txt} = \$txt;
        $ctx->{-title_html} = ascii_html($title);
        my $nslash = ($key =~ tr!/!/!);
        $ctx->{-upfx} = '../../../' . ('../' x $nslash);
-       PublicInbox::WwwStream->response($ctx, $code, \&_do_linkify);
-}
-
-sub _do_linkify {
-       my ($nr, $ctx) = @_;
-       return unless $nr == 1;
        my $l = PublicInbox::Linkify->new;
-       my $txt = delete $ctx->{txt};
-       $l->linkify_1($$txt);
+       $l->linkify_1($txt);
        if ($hl) {
-               $hl->do_hl_text($txt);
+               $hl->do_hl_text(\$txt);
        } else {
-               $$txt = ascii_html($$txt);
+               $txt = ascii_html($txt);
        }
-       '<pre>' . $l->linkify_2($$txt) . '</pre>';
+       $txt = '<pre>' . $l->linkify_2($txt) . '</pre>';
+       PublicInbox::WwwStream::html_oneshot($ctx, $code, \$txt);
 }
 
 sub _srch_prefix ($$) {
@@ -151,7 +151,7 @@ sub inbox_config ($$$) {
        url = https://example.com/$name/
        url = http://example.onion/$name/
 EOS
-       for my $k (qw(address listid infourl)) {
+       for my $k (qw(address listid infourl watchheader)) {
                defined(my $v = $ibx->{$k}) or next;
                $$txt .= "\t$k = $_\n" for @$v;
        }
@@ -171,7 +171,7 @@ EOF
                }
        }
 
-       for my $k (qw(filter newsgroup obfuscate replyto watchheader)) {
+       for my $k (qw(filter newsgroup obfuscate replyto)) {
                defined(my $v = $ibx->{$k}) or next;
                $$txt .= "\t$k = $v\n";
        }
@@ -181,7 +181,13 @@ EOF
        # and drop the original structure
        if (defined(my $cr = $ibx->{coderepo})) {
                $$txt .= "\tcoderepo = $_\n" for @$cr;
+               $$txt .= <<'EOF';
 
+; `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_config = $ctx->{www}->{pi_config};
                for my $cr_name (@$cr) {
                        my $urls = $pi_config->{"coderepo.$cr_name.cgiturl"};