From 6e4654d5c509a2772f9fa8dcd0c46e05ca5feaea Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Sat, 12 Apr 2014 00:09:30 +0000
Subject: cgi: rename to have .cgi suffix

This makes it easier to configure for systems which
determine a script is a CGI script based on suffix.
---
 Makefile.PL      |   2 +-
 public-inbox-cgi | 193 -------------------------------------------------------
 public-inbox.cgi | 193 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 t/cgi.t          |   2 +-
 4 files changed, 195 insertions(+), 195 deletions(-)
 delete mode 100755 public-inbox-cgi
 create mode 100755 public-inbox.cgi

diff --git a/Makefile.PL b/Makefile.PL
index e1bd1cf0..245bb887 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -8,7 +8,7 @@ WriteMakefile(
 	VERSION => '0.0.0',
 	AUTHOR => 'Eric Wong <normalperson@yhbt.net>',
 	ABSTRACT => 'public-inbox server infrastructure',
-	EXE_FILES => [qw/public-inbox-mda public-inbox-cgi
+	EXE_FILES => [qw/public-inbox-mda public-inbox.cgi
 			public-inbox-learn/],
 	PREREQ_PM => {
 		# note: we use ssoma(1) and spamc(1), NOT the Perl modules
diff --git a/public-inbox-cgi b/public-inbox-cgi
deleted file mode 100755
index 6a6f31e2..00000000
--- a/public-inbox-cgi
+++ /dev/null
@@ -1,193 +0,0 @@
-#!/usr/bin/perl -w
-# Copyright (C) 2014, Eric Wong <normalperson@yhbt.net> and all contributors
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
-#
-# We focus on the lowest common denominators here:
-# - targeted at text-only console browsers (lynx, w3m, etc..)
-# - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
-# - No JavaScript, graphics or icons allowed.
-# - Must not rely on static content
-# - UTF-8 is only for user-content, 7-bit US-ASCII for us
-
-use 5.008;
-use strict;
-use warnings;
-use CGI qw(:cgi :escapeHTML -nosticky); # PSGI/FastCGI/mod_perl compat
-use Encode qw(decode_utf8);
-use PublicInbox::Config;
-use Digest::SHA qw(sha1_hex);
-our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
-our $pi_config;
-BEGIN {
-	$pi_config = PublicInbox::Config->new;
-	# TODO: detect and reload config as needed
-	if ($ENV{MOD_PERL}) {
-		CGI->compile;
-	}
-}
-
-my $ret = main();
-
-my ($status, $headers, $body) = @$ret;
-set_binmode($headers);
-if (@ARGV && $ARGV[0] eq 'static') {
-	print $body;
-} else { # CGI
-	print "Status: $status\r\n";
-	while (my ($k, $v) = each %$headers) {
-		print "$k: $v\r\n";
-	}
-	print "\r\n", $body;
-}
-
-# TODO: plack support
-
-# private functions below
-
-sub main {
-	my $cgi = CGI->new;
-	my %ctx;
-	if ($cgi->request_method !~ /\AGET|HEAD\z/) {
-		return r("405 Method Not Allowed");
-	}
-	my $path_info = decode_utf8($ENV{PATH_INFO});
-
-	# top-level indices and feeds
-	if ($path_info eq "/") {
-		r404();
-	} elsif ($path_info =~ m!$LISTNAME_RE(?:/|/index\.html)?\z!o) {
-		invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi, 1);
-	} elsif ($path_info =~ m!$LISTNAME_RE/index\.atom\.xml\z!o) {
-		invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 1);
-	} elsif ($path_info =~ m!$LISTNAME_RE/all\.atom\.xml\z!o) {
-		invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 0);
-
-	# single-message pages
-	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.txt\z!o) {
-		invalid_list_mid(\%ctx, $1, $2) || get_mid_txt(\%ctx, $cgi);
-	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
-		invalid_list_mid(\%ctx, $1, $2) || get_mid_html(\%ctx, $cgi);
-	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\z!o) {
-		redirect_mid_html($cgi, $1, $2);
-
-	# full-message page
-	} elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
-		invalid_list_mid(\%ctx, $1, $2) || get_full_html(\%ctx, $cgi);
-	} elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\z!o) {
-		redirect_mid_html($cgi, $1, $2);
-
-	} else {
-		r404();
-	}
-}
-
-sub r404 { r("404 Not Found") }
-
-# simple response for errors
-sub r { [ $_[0], { 'Content-Type' => 'text/plain' }, '' ] }
-
-# returns undef if valid, array ref response if invalid
-sub invalid_list {
-	my ($ctx, $listname) = @_;
-	my $git_dir = $pi_config->get($listname, "mainrepo");
-	if (defined $git_dir) {
-		$ctx->{git_dir} = $git_dir;
-		$ctx->{listname} = $listname;
-		return undef;
-	}
-	r404();
-}
-
-# returns undef if valid, array ref response if invalid
-sub invalid_list_mid {
-	my ($ctx, $listname, $mid) = @_;
-	my $ret = invalid_list($ctx, $listname, $mid) and return $ret;
-	$ctx->{mid} = $mid;
-	undef;
-}
-
-# /$LISTNAME/index.atom.xml                     -> Atom feed
-# /$LISTNAME/all.atom.xml                       -> Atom feed, includes replies
-sub get_atom {
-	my ($ctx, $cgi, $top) = @_;
-	require PublicInbox::Feed;
-	[ '200 OK', { 'Content-Type' => 'application/xml' },
-	  PublicInbox::Feed->generate({
-			git_dir => $ctx->{git_dir},
-			listname => $ctx->{listname},
-			pi_config => $pi_config,
-			cgi => $cgi,
-			top => $top,
-		})
-	];
-}
-
-# /$LISTNAME/?before=$GIT_COMMIT                 -> HTML only
-sub get_index {
-	my ($ctx, $cgi, $top) = @_;
-	require PublicInbox::Feed;
-	[ '200 OK', { 'Content-Type' => 'text/html' },
-	  PublicInbox::Feed->generate_html_index({
-			git_dir => $ctx->{git_dir},
-			listname => $ctx->{listname},
-			pi_config => $pi_config,
-			cgi => $cgi,
-			top => $top,
-		})
-	];
-}
-
-# just returns a string ref for the blob in the current ctx
-sub mid2blob {
-	my ($ctx) = @_;
-	local $ENV{GIT_DIR} = $ctx->{git_dir};
-	my $hex = sha1_hex($ctx->{mid});
-	$hex =~ /\A([a-f0-9]{2})([a-f0-9]{38})\z/i or
-			die "BUG: not a SHA-1 hex: $hex";
-	my $blob = `git cat-file blob HEAD:$1/$2 2>/dev/null`;
-	$? == 0 ? \$blob : undef;
-}
-
-# /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
-sub get_mid_txt {
-	my ($ctx, $cgi) = @_;
-	my $x = mid2blob($ctx);
-	$x ? [ "200 OK", {'Content-Type' => 'text/plain'}, $$x ] : r404();
-}
-
-# /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
-sub get_mid_html {
-	my ($ctx, $cgi) = @_;
-	my $x = mid2blob($ctx);
-	return r404() unless $x;
-
-	my $pfx = $cgi->self_url;
-	$pfx =~ s!/m/.+\z!/!; # FIXME: this is not robust
-
-	require PublicInbox::View;
-	require Email::MIME;
-	[ "200 OK", {'Content-Type' => 'text/html'},
-		PublicInbox::View->as_html(Email::MIME->new($$x), $pfx)];
-}
-
-# /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (fullquotes)
-sub get_full_html {
-	my ($ctx, $cgi) = @_;
-	my $x = mid2blob($ctx);
-	return r404() unless $x;
-	require PublicInbox::View;
-	require Email::MIME;
-	[ "200 OK", {'Content-Type' => 'text/html'},
-		PublicInbox::View->as_html(Email::MIME->new($$x))];
-}
-
-# only used for CGI and static file generation modes
-sub set_binmode {
-	my ($headers) = @_;
-	if ($headers->{'Content-Type'} eq 'text/plain') {
-		# no way to validate raw messages, mixed encoding is possible.
-		binmode STDOUT;
-	} else { # strict encoding for HTML and XML
-		binmode STDOUT, ':encoding(UTF-8)';
-	}
-}
diff --git a/public-inbox.cgi b/public-inbox.cgi
new file mode 100755
index 00000000..6a6f31e2
--- /dev/null
+++ b/public-inbox.cgi
@@ -0,0 +1,193 @@
+#!/usr/bin/perl -w
+# Copyright (C) 2014, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+#
+# We focus on the lowest common denominators here:
+# - targeted at text-only console browsers (lynx, w3m, etc..)
+# - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
+# - No JavaScript, graphics or icons allowed.
+# - Must not rely on static content
+# - UTF-8 is only for user-content, 7-bit US-ASCII for us
+
+use 5.008;
+use strict;
+use warnings;
+use CGI qw(:cgi :escapeHTML -nosticky); # PSGI/FastCGI/mod_perl compat
+use Encode qw(decode_utf8);
+use PublicInbox::Config;
+use Digest::SHA qw(sha1_hex);
+our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
+our $pi_config;
+BEGIN {
+	$pi_config = PublicInbox::Config->new;
+	# TODO: detect and reload config as needed
+	if ($ENV{MOD_PERL}) {
+		CGI->compile;
+	}
+}
+
+my $ret = main();
+
+my ($status, $headers, $body) = @$ret;
+set_binmode($headers);
+if (@ARGV && $ARGV[0] eq 'static') {
+	print $body;
+} else { # CGI
+	print "Status: $status\r\n";
+	while (my ($k, $v) = each %$headers) {
+		print "$k: $v\r\n";
+	}
+	print "\r\n", $body;
+}
+
+# TODO: plack support
+
+# private functions below
+
+sub main {
+	my $cgi = CGI->new;
+	my %ctx;
+	if ($cgi->request_method !~ /\AGET|HEAD\z/) {
+		return r("405 Method Not Allowed");
+	}
+	my $path_info = decode_utf8($ENV{PATH_INFO});
+
+	# top-level indices and feeds
+	if ($path_info eq "/") {
+		r404();
+	} elsif ($path_info =~ m!$LISTNAME_RE(?:/|/index\.html)?\z!o) {
+		invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi, 1);
+	} elsif ($path_info =~ m!$LISTNAME_RE/index\.atom\.xml\z!o) {
+		invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 1);
+	} elsif ($path_info =~ m!$LISTNAME_RE/all\.atom\.xml\z!o) {
+		invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 0);
+
+	# single-message pages
+	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.txt\z!o) {
+		invalid_list_mid(\%ctx, $1, $2) || get_mid_txt(\%ctx, $cgi);
+	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
+		invalid_list_mid(\%ctx, $1, $2) || get_mid_html(\%ctx, $cgi);
+	} elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\z!o) {
+		redirect_mid_html($cgi, $1, $2);
+
+	# full-message page
+	} elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
+		invalid_list_mid(\%ctx, $1, $2) || get_full_html(\%ctx, $cgi);
+	} elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\z!o) {
+		redirect_mid_html($cgi, $1, $2);
+
+	} else {
+		r404();
+	}
+}
+
+sub r404 { r("404 Not Found") }
+
+# simple response for errors
+sub r { [ $_[0], { 'Content-Type' => 'text/plain' }, '' ] }
+
+# returns undef if valid, array ref response if invalid
+sub invalid_list {
+	my ($ctx, $listname) = @_;
+	my $git_dir = $pi_config->get($listname, "mainrepo");
+	if (defined $git_dir) {
+		$ctx->{git_dir} = $git_dir;
+		$ctx->{listname} = $listname;
+		return undef;
+	}
+	r404();
+}
+
+# returns undef if valid, array ref response if invalid
+sub invalid_list_mid {
+	my ($ctx, $listname, $mid) = @_;
+	my $ret = invalid_list($ctx, $listname, $mid) and return $ret;
+	$ctx->{mid} = $mid;
+	undef;
+}
+
+# /$LISTNAME/index.atom.xml                     -> Atom feed
+# /$LISTNAME/all.atom.xml                       -> Atom feed, includes replies
+sub get_atom {
+	my ($ctx, $cgi, $top) = @_;
+	require PublicInbox::Feed;
+	[ '200 OK', { 'Content-Type' => 'application/xml' },
+	  PublicInbox::Feed->generate({
+			git_dir => $ctx->{git_dir},
+			listname => $ctx->{listname},
+			pi_config => $pi_config,
+			cgi => $cgi,
+			top => $top,
+		})
+	];
+}
+
+# /$LISTNAME/?before=$GIT_COMMIT                 -> HTML only
+sub get_index {
+	my ($ctx, $cgi, $top) = @_;
+	require PublicInbox::Feed;
+	[ '200 OK', { 'Content-Type' => 'text/html' },
+	  PublicInbox::Feed->generate_html_index({
+			git_dir => $ctx->{git_dir},
+			listname => $ctx->{listname},
+			pi_config => $pi_config,
+			cgi => $cgi,
+			top => $top,
+		})
+	];
+}
+
+# just returns a string ref for the blob in the current ctx
+sub mid2blob {
+	my ($ctx) = @_;
+	local $ENV{GIT_DIR} = $ctx->{git_dir};
+	my $hex = sha1_hex($ctx->{mid});
+	$hex =~ /\A([a-f0-9]{2})([a-f0-9]{38})\z/i or
+			die "BUG: not a SHA-1 hex: $hex";
+	my $blob = `git cat-file blob HEAD:$1/$2 2>/dev/null`;
+	$? == 0 ? \$blob : undef;
+}
+
+# /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
+sub get_mid_txt {
+	my ($ctx, $cgi) = @_;
+	my $x = mid2blob($ctx);
+	$x ? [ "200 OK", {'Content-Type' => 'text/plain'}, $$x ] : r404();
+}
+
+# /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
+sub get_mid_html {
+	my ($ctx, $cgi) = @_;
+	my $x = mid2blob($ctx);
+	return r404() unless $x;
+
+	my $pfx = $cgi->self_url;
+	$pfx =~ s!/m/.+\z!/!; # FIXME: this is not robust
+
+	require PublicInbox::View;
+	require Email::MIME;
+	[ "200 OK", {'Content-Type' => 'text/html'},
+		PublicInbox::View->as_html(Email::MIME->new($$x), $pfx)];
+}
+
+# /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (fullquotes)
+sub get_full_html {
+	my ($ctx, $cgi) = @_;
+	my $x = mid2blob($ctx);
+	return r404() unless $x;
+	require PublicInbox::View;
+	require Email::MIME;
+	[ "200 OK", {'Content-Type' => 'text/html'},
+		PublicInbox::View->as_html(Email::MIME->new($$x))];
+}
+
+# only used for CGI and static file generation modes
+sub set_binmode {
+	my ($headers) = @_;
+	if ($headers->{'Content-Type'} eq 'text/plain') {
+		# no way to validate raw messages, mixed encoding is possible.
+		binmode STDOUT;
+	} else { # strict encoding for HTML and XML
+		binmode STDOUT, ':encoding(UTF-8)';
+	}
+}
diff --git a/t/cgi.t b/t/cgi.t
index afbe604f..a66c5825 100644
--- a/t/cgi.t
+++ b/t/cgi.t
@@ -8,7 +8,7 @@ use File::Temp qw/tempdir/;
 use Cwd;
 use IPC::Run qw/run/;
 
-use constant CGI => "blib/script/public-inbox-cgi";
+use constant CGI => "blib/script/public-inbox.cgi";
 my $mda = "blib/script/public-inbox-mda";
 my $tmpdir = tempdir(CLEANUP => 1);
 my $home = "$tmpdir/pi-home";
-- 
cgit v1.2.3-24-ge0c7