X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwText.pm;h=53e15e454629e78acd49d160773e1a607ce0bcc6;hb=e3b57fe9f68e80fc85cff46ccec9246b670f1312;hp=adadc37aab3da1f32ee40a7eb0687444281b9696;hpb=8b8577f91109e76d12fcfa55a2e7388f54a41be6;p=public-inbox.git diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm index adadc37a..53e15e45 100644 --- a/lib/PublicInbox/WwwText.pm +++ b/lib/PublicInbox/WwwText.pm @@ -1,13 +1,16 @@ -# Copyright (C) 2016-2018 all contributors +# Copyright (C) 2016-2020 all contributors # License: AGPL-3.0+ # used for displaying help texts and other non-mail content package PublicInbox::WwwText; use strict; use warnings; +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); +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 { @@ -28,19 +31,25 @@ 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"; } + my $env = $ctx->{env}; if ($raw) { - return [ $code, [ 'Content-Type', 'text/plain', - 'Content-Length', bytes::length($txt) ], - [ $txt ] ] + 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->{ibx}->base_url($env); $url .= "_/text/$key/"; return [ 302, [ 'Content-Type', 'text/plain', @@ -51,27 +60,18 @@ sub get_text { # 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 ? '
'.$txt.'
' : 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 = '
' . $l->linkify_2($txt) . '
'; + PublicInbox::WwwStream::html_oneshot($ctx, $code, \$txt); } sub _srch_prefix ($$) { @@ -100,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"; @@ -122,12 +122,106 @@ 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->{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 .= <{$k}) or next; + $$txt .= "\t$k = $_\n" for @$v; + } + if (my $altid = $ibx->{altid}) { + my $altid_map = $ibx->altid_map; + $$txt .= <{$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; + $$txt .= <<'EOF'; + +; `coderepo' entries allows blob reconstruction via patch emails if +; the inbox is indexed with Xapian. `@@ @@' +; 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"}; + 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 $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/"; + $$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}; + my $ibx = $ctx->{ibx}; my $base_url = $ibx->base_url($ctx->{env}); $$txt .= "public-inbox help for $base_url\n"; $$txt .= <search; + my $srch = $ibx->isrch; if ($srch) { $$txt .= <over; + if ($over) { + $$txt .= <