summaryrefslogtreecommitdiff
path: root/lib/HTTP/Server/Simple/CGI
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@lorry>2015-02-02 15:36:39 +0000
committerLorry Tar Creator <lorry-tar-importer@lorry>2015-02-02 15:36:39 +0000
commite2d680ac7c6f0bb36808aa45e1453c8b585d2717 (patch)
tree97944a18c68e27f1472b7c2221ead889b13de107 /lib/HTTP/Server/Simple/CGI
downloadHTTP-Server-Simple-tarball-master.tar.gz
HTTP-Server-Simple-0.50HEADHTTP-Server-Simple-0.50master
Diffstat (limited to 'lib/HTTP/Server/Simple/CGI')
-rw-r--r--lib/HTTP/Server/Simple/CGI/Environment.pm115
1 files changed, 115 insertions, 0 deletions
diff --git a/lib/HTTP/Server/Simple/CGI/Environment.pm b/lib/HTTP/Server/Simple/CGI/Environment.pm
new file mode 100644
index 0000000..4b2c895
--- /dev/null
+++ b/lib/HTTP/Server/Simple/CGI/Environment.pm
@@ -0,0 +1,115 @@
+
+package HTTP::Server::Simple::CGI::Environment;
+
+use strict;
+use warnings;
+use HTTP::Server::Simple;
+
+use vars qw(%ENV_MAPPING);
+
+my %clean_env = %ENV;
+
+=head1 NAME
+
+HTTP::Server::Simple::CGI::Environment - a HTTP::Server::Simple mixin to provide the CGI protocol
+
+=head1 DESCRIPTION
+
+This mixin abstracts the CGI protocol out from
+L<HTTP::Server::Simple::CGI> so that it's easier to provide your own
+CGI handlers with L<HTTP::Server::Simple> which B<don't> use CGI.pm
+
+=head2 setup_environment
+
+C<setup_environemnt> is usually called in the superclass's accept_hook
+
+This routine in this sub-class clears the environment to the
+start-up state.
+
+=cut
+
+sub setup_environment {
+ %ENV = (
+ %clean_env,
+ SERVER_SOFTWARE => "HTTP::Server::Simple/$HTTP::Server::Simple::VERSION",
+ GATEWAY_INTERFACE => 'CGI/1.1'
+ );
+}
+
+=head2 setup_server_url
+
+Sets up the C<SERVER_URL> environment variable
+
+=cut
+
+sub setup_server_url {
+ $ENV{SERVER_URL}
+ ||= ( "http://" . ($ENV{SERVER_NAME} || 'localhost') . ":" . ( $ENV{SERVER_PORT}||80) . "/" );
+}
+
+=head2 setup_environment_from_metadata
+
+This method sets up CGI environment variables based on various
+meta-headers, like the protocol, remote host name, request path, etc.
+
+See the docs in L<HTTP::Server::Simple> for more detail.
+
+=cut
+
+%ENV_MAPPING = (
+ protocol => "SERVER_PROTOCOL",
+ localport => "SERVER_PORT",
+ localname => "SERVER_NAME",
+ path => "PATH_INFO",
+ request_uri => "REQUEST_URI",
+ method => "REQUEST_METHOD",
+ peeraddr => "REMOTE_ADDR",
+ peername => "REMOTE_HOST",
+ peerport => "REMOTE_PORT",
+ query_string => "QUERY_STRING",
+);
+
+sub setup_environment_from_metadata {
+ no warnings 'uninitialized';
+ my $self = shift;
+
+ # XXX TODO: rather than clone functionality from the base class,
+ # we should call super
+ #
+ while ( my ( $item, $value ) = splice @_, 0, 2 ) {
+ if ( my $k = $ENV_MAPPING{$item} ) {
+ $ENV{$k} = $value;
+ }
+ }
+
+ # Apache and lighttpd both do one layer of unescaping on
+ # path_info; we should duplicate that.
+ $ENV{PATH_INFO} =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+}
+
+=head2 header
+
+C<header> turns a single HTTP headers into CGI environment variables.
+
+=cut
+
+sub header {
+ my $self = shift;
+ my $tag = shift;
+ my $value = shift;
+
+ $tag = uc($tag);
+ $tag =~ s/^COOKIES$/COOKIE/;
+ $tag =~ s/-/_/g;
+ $tag = "HTTP_" . $tag
+ unless $tag =~ m/^CONTENT_(?:LENGTH|TYPE)$/;
+
+ if ( exists $ENV{$tag} ) {
+ $ENV{$tag} .= ", $value";
+ }
+ else {
+ $ENV{$tag} = $value;
+ }
+}
+
+1;