-# Copyright (C) 2016-2019 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
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 {
$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',
# Follow git commit message conventions,
# first line is the Subject/title
my ($title) = ($txt =~ /\A([^\n]*)/s);
- _do_linkify($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
- });
-}
-
-sub _do_linkify {
my $l = PublicInbox::Linkify->new;
- $l->linkify_1($_[0]);
+ $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]);
+ $txt = '<pre>' . $l->linkify_2($txt) . '</pre>';
+ PublicInbox::WwwStream::html_oneshot($ctx, $code, \$txt);
}
sub _srch_prefix ($$) {
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"]
- 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)) {
+ 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 infourl newsgroup obfuscate replyto watchheader)) {
+ for my $k (qw(filter newsgroup obfuscate replyto)) {
defined(my $v = $ibx->{$k}) or next;
$$txt .= "\t$k = $v\n";
}
# 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 $url = $pi_config->{"coderepo.$cr_name.cgiturl"};
+ 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 (defined($url)) {
- my $cpath = $path;
- if ($path !~ m![a-z0-9_/\.\-]!i) {
- $cpath = dq_escape($cpath);
- }
- $$txt .= qq(\t; git clone $url "$cpath"\n);
+ if ($urls && scalar(@$urls)) {
+ $$txt .= "\t; ";
+ $$txt .= join(" ||\n\t;\t", map {;
+ my $dst = $path;
+ if ($path !~ m![a-z0-9_/\.\-]!i) {
+ $dst = '"'.dq_escape($dst).'"';
+ }
+ qq(git clone $_ $dst);
+ } @$urls);
+ $$txt .= "\n";
}
$$txt .= "\tdir = $path\n";
$$txt .= "\tcgiturl = https://example.com/";
$QP_URL
+EOF
+ } # $srch
+ my $over = $ibx->over;
+ if ($over) {
+ $$txt .= <<EOF;
message threading
-----------------
$WIKI_URL/Mbox
+EOF
+ } # $over
+
+ $$txt .= <<EOF;
contact
-------
EOF
# TODO: support admin contact info in ~/.public-inbox/config
- }
1;
}