]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/WwwText.pm
wwwtext: config comment improvements
[public-inbox.git] / lib / PublicInbox / WwwText.pm
index cbe82b730f765a585e3fbf019a98f5183afa3405..2ed7d0d2ee09d8ba2d4c28282de08bdde9503430 100644 (file)
@@ -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 ($$) {
@@ -138,24 +138,41 @@ sub inbox_config ($$$) {
        my $ibx = $ctx->{-inbox};
        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 = /path/to/top-level-inbox
-       ; note: public-inbox before v1.2.0 used "mainrepo"
-       ; instead of "inboxdir", both remain supported after 1.2
-       mainrepo = /path/to/top-level-inbox
+       inboxdir = $inboxdir
+       ; 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/
 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;
        }
+       if (my $altid = $ibx->{altid}) {
+               my $altid_map = $ibx->altid_map;
+               $$txt .= <<EOF;
+       ; altid DBs may be used to provide numeric article ID lookup from
+       ; old, pre-existing sources.  You can recreate them via curl(1),
+       ; gzip(1), and sqlite3(1) as documented:
+EOF
+               for (sort keys %$altid_map) {
+                       $$txt .= "\t;\tcurl -XPOST $base_url$_.sql.gz | \\\n" .
+                               "\t;\tgzip -dc | \\\n" .
+                               "\t;\tsqlite3 $inboxdir/$_.sqlite3\n";
+                       $$txt .= "\taltid = serial:$_:file=$_.sqlite3\n";
+               }
+       }
 
-       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";
        }
@@ -165,7 +182,13 @@ EOS
        # 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"};
@@ -176,11 +199,11 @@ EOS
                        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";
                        }