X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwText.pm;h=bcda665c75b9572c029b86b9a829db09e27834fa;hb=a7603ca1d219f39101f8e35bdea1f53ce5c31796;hp=e6d00ea9f00c48e27052f657a812a0e5bc3d3049;hpb=3d41aa23f35501ca92aab8aa42980fa73f7fa74f;p=public-inbox.git

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index e6d00ea9..bcda665c 100644
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -1,14 +1,21 @@
-# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2019 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
 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);
 our $QP_URL = 'https://xapian.org/docs/queryparser.html';
 our $WIKI_URL = 'https://en.wikipedia.org/wiki';
+my $hl = eval {
+	require PublicInbox::HlMod;
+	PublicInbox::HlMod->new
+};
 
 # /$INBOX/_/text/$KEY/ # KEY may contain slashes
 # For now, "help" is the only supported $KEY
@@ -23,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
@@ -60,7 +67,13 @@ sub get_text {
 
 sub _do_linkify {
 	my $l = PublicInbox::Linkify->new;
-	$_[0] = $l->linkify_2(ascii_html($l->linkify_1($_[0])));
+	$l->linkify_1($_[0]);
+	if ($hl) {
+		$hl->do_hl_text(\($_[0]));
+	} else {
+		$_[0] = ascii_html($_[0]);
+	}
+	$_[0] = $l->linkify_2($_[0]);
 }
 
 sub _srch_prefix ($$) {
@@ -87,9 +100,95 @@ sub _srch_prefix ($$) {
 	1;
 }
 
+sub _colors_help ($$) {
+	my ($ctx, $txt) = @_;
+	my $ibx = $ctx->{-inbox};
+	my $env = $ctx->{env};
+	my $base_url = $ibx->base_url($env);
+	$$txt .= "color customization for $base_url\n";
+	$$txt .= <<EOF;
+
+public-inbox provides a stable set of CSS classes for users to
+customize colors for highlighting diffs and code.
+
+Users of browsers such as dillo, Firefox, or some browser
+extensions may start by downloading the following sample CSS file
+to control the colors they see:
+
+	${base_url}userContent.css
+
+CSS sample
+----------
+```css
+EOF
+	$$txt .= PublicInbox::UserContent::sample($ibx, $env) . "```\n";
+}
+
+# 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"]
+	mainrepo = /path/to/top-level-inbox
+EOS
+	for my $k (qw(address listid)) {
+		defined(my $v = $ibx->{$k}) or next;
+		$$txt .= "\t$k = $_\n" for @$v;
+	}
+
+	for my $k (qw(filter infourl 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 $url = $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);
+			}
+			$$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, $txt) = @_;
+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};