treewide: run update-copyrights from gnulib for 2019

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

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index f42f3595fd6578d49f07b8527c45503f56467c48..f6d831f62d1d2a7d1503ee00496fadb993631c58 100644 (file)
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2020 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
@@ -9,6 +9,7 @@ use bytes (); # only for bytes::length
 use PublicInbox::Linkify;
 use PublicInbox::WwwStream;
 use PublicInbox::Hval qw(ascii_html);
+use URI::Escape qw(uri_escape_utf8);
 our $QP_URL = 'https://xapian.org/docs/queryparser.html';
 our $WIKI_URL = 'https://en.wikipedia.org/wiki';
 my $hl = eval {
@@ -29,14 +30,14 @@ sub get_text {
        my $have_tslash = ($key =~ s!/\z!!) if !$raw;
 
        my $txt = '';
-       if (!_default_text($ctx, $key, \$txt)) {
+       my $hdr = [ 'Content-Type', 'text/plain', 'Content-Length', undef ];
+       if (!_default_text($ctx, $key, $hdr, \$txt)) {
                $code = 404;
                $txt = "404 Not Found ($key)\n";
        }
        if ($raw) {
-               return [ $code, [ 'Content-Type', 'text/plain',
-                                 'Content-Length', bytes::length($txt) ],
-                       [ $txt ] ]
+               $hdr->[3] = bytes::length($txt);
+               return [ $code, $hdr, [ $txt ] ]
        }
 
        # enforce trailing slash for "wget -r" compatibility
@@ -52,27 +53,25 @@ sub get_text {
        # Follow git commit message conventions,
        # first line is the Subject/title
        my ($title) = ($txt =~ /\A([^\n]*)/s);
-       _do_linkify($txt);
+       $ctx->{txt} = \$txt;
        $ctx->{-title_html} = ascii_html($title);
-
        my $nslash = ($key =~ tr!/!/!);
        $ctx->{-upfx} = '../../../' . ('../' x $nslash);
-
-       PublicInbox::WwwStream->response($ctx, $code, sub {
-               my ($nr, undef) = @_;
-               $nr == 1 ? '<pre>'.$txt.'</pre>' : undef
-       });
+       PublicInbox::WwwStream->response($ctx, $code, \&_do_linkify);
 }
 
 sub _do_linkify {
+       my ($nr, $ctx) = @_;
+       return unless $nr == 1;
        my $l = PublicInbox::Linkify->new;
-       $l->linkify_1($_[0]);
+       my $txt = delete $ctx->{txt};
+       $l->linkify_1($$txt);
        if ($hl) {
-               $hl->do_hl_text(\($_[0]));
+               $hl->do_hl_text($txt);
        } else {
-               $_[0] = ascii_html($_[0]);
+               $$txt = ascii_html($$txt);
        }
-       $_[0] = $l->linkify_2($_[0]);
+       '<pre>' . $l->linkify_2($$txt) . '</pre>';
 }
 
 sub _srch_prefix ($$) {
@@ -123,9 +122,80 @@ EOF
        $$txt .= PublicInbox::UserContent::sample($ibx, $env) . "```\n";
 }
 
-sub _default_text ($$$) {
-       my ($ctx, $key, $txt) = @_;
+# git-config section names are quoted in the config file, so escape them
+sub dq_escape ($) {
+       my ($name) = @_;
+       $name =~ s/\\/\\\\/g;
+       $name =~ s/"/\\"/g;
+       $name;
+}
+
+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};
+       push @$hdr, 'Content-Disposition', 'inline; filename=inbox.config';
+       my $name = dq_escape($ibx->{name});
+       $$txt .= <<EOS;
+; example public-inbox config snippet for "$name"
+; 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
+       url = https://example.com/$name/
+       url = http://example.onion/$name/
+EOS
+       for my $k (qw(address listid infourl)) {
+               defined(my $v = $ibx->{$k}) or next;
+               $$txt .= "\t$k = $_\n" for @$v;
+       }
+
+       for my $k (qw(filter newsgroup obfuscate replyto watchheader)) {
+               defined(my $v = $ibx->{$k}) or next;
+               $$txt .= "\t$k = $v\n";
+       }
+       $$txt .= "\tnntpmirror = $_\n" for (@{$ibx->nntp_url});
+
+       # note: this doesn't preserve cgitrc layout, since we parse cgitrc
+       # and drop the original structure
+       if (defined(my $cr = $ibx->{coderepo})) {
+               $$txt .= "\tcoderepo = $_\n" for @$cr;
+
+               my $pi_config = $ctx->{www}->{pi_config};
+               for my $cr_name (@$cr) {
+                       my $urls = $pi_config->{"coderepo.$cr_name.cgiturl"};
+                       my $path = "/path/to/$cr_name";
+                       $cr_name = dq_escape($cr_name);
+
+                       $$txt .= qq([coderepo "$cr_name"]\n);
+                       if ($urls && scalar(@$urls)) {
+                               $$txt .= "\t; ";
+                               $$txt .= join(" ||\n\t;\t", map {;
+                                       my $cpath = $path;
+                                       if ($path !~ m![a-z0-9_/\.\-]!i) {
+                                               $cpath = dq_escape($cpath);
+                                       }
+                                       qq(git clone $_ "$cpath");
+                               } @$urls);
+                               $$txt .= "\n";
+                       }
+                       $$txt .= "\tdir = $path\n";
+                       $$txt .= "\tcgiturl = https://example.com/";
+                       $$txt .= uri_escape_utf8($cr_name, URI_PATH)."\n";
+               }
+       }
+       1;
+}
+
+sub _default_text ($$$$) {
+       my ($ctx, $key, $hdr, $txt) = @_;
        return _colors_help($ctx, $txt) if $key eq 'color';
+       return inbox_config($ctx, $hdr, $txt) if $key eq 'config';
        return if $key ne 'help'; # TODO more keys?
 
        my $ibx = $ctx->{-inbox};