Reformatted documentation

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / CGI.pm

diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm
index 82ea2ca..d2d041e 100644 (file)
--- a/lib/Catalyst/Engine/CGI.pm
+++ b/lib/Catalyst/Engine/CGI.pm
@@ -4,7 +4,8 @@ use strict;
 use base 'Catalyst::Engine';
 use NEXT;
 use URI;
-use URI::Query;
+
+__PACKAGE__->mk_accessors('env');
 
 =head1 NAME
 
@@ -33,9 +34,7 @@ This is the Catalyst engine specialized for the CGI environment.
 
 This class overloads some methods from C<Catalyst::Engine>.
 
-=over 4
-
-=item $self->finalize_headers($c)
+=head2 $self->finalize_headers($c)
 
 =cut
 
@@ -48,27 +47,28 @@ sub finalize_headers {
     print "\015\012";
 }
 
-=item $self->prepare_connection($c)
+=head2 $self->prepare_connection($c)
 
 =cut
 
 sub prepare_connection {
     my ( $self, $c ) = @_;
-    
+    local (*ENV) = $self->env || \%ENV;
+
     $c->request->address( $ENV{REMOTE_ADDR} );
-    
-    PROXY_CHECK:
+
+  PROXY_CHECK:
     {
         unless ( $c->config->{using_frontend_proxy} ) {
             last PROXY_CHECK if $ENV{REMOTE_ADDR} ne '127.0.0.1';
             last PROXY_CHECK if $c->config->{ignore_frontend_proxy};
         }
         last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_FOR};
-   
+
         # If we are running as a backend server, the user will always appear
         # as 127.0.0.1. Select the most recent upstream IP (last in the list)
         my ($ip) = $ENV{HTTP_X_FORWARDED_FOR} =~ /([^,\s]+)$/;
-        $c->request->address( $ip );
+        $c->request->address($ip);
     }
 
     $c->request->hostname( $ENV{REMOTE_HOST} );
@@ -85,12 +85,13 @@ sub prepare_connection {
     }
 }
 
-=item $self->prepare_headers($c)
+=head2 $self->prepare_headers($c)
 
 =cut
 
 sub prepare_headers {
     my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
     # Read headers from %ENV
     while ( my ( $header, $value ) = each %ENV ) {
@@ -100,20 +101,21 @@ sub prepare_headers {
     }
 }
 
-=item $self->prepare_path($c)
+=head2 $self->prepare_path($c)
 
 =cut
 
 sub prepare_path {
     my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
-    my $scheme    = $c->request->secure ? 'https' : 'http';
+    my $scheme = $c->request->secure ? 'https' : 'http';
     my $host      = $ENV{HTTP_HOST}   || $ENV{SERVER_NAME};
     my $port      = $ENV{SERVER_PORT} || 80;
     my $base_path = $ENV{SCRIPT_NAME} || '/';
-    
+
     # If we are running as a backend proxy, get the true hostname
-    PROXY_CHECK:
+  PROXY_CHECK:
     {
         unless ( $c->config->{using_frontend_proxy} ) {
             last PROXY_CHECK if $host !~ /localhost|127.0.0.1/;
@@ -122,45 +124,60 @@ sub prepare_path {
         last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST};
 
         $host = $ENV{HTTP_X_FORWARDED_HOST};
-        # backend could be on any port, so 
+
+        # backend could be on any port, so
         # assume frontend is on the default port
         $port = $c->request->secure ? 443 : 80;
     }
 
     my $path = $base_path . $ENV{PATH_INFO};
     $path =~ s{^/+}{};
-    
+
     my $uri = URI->new;
-    $uri->scheme( $scheme );
-    $uri->host( $host );
-    $uri->port( $port );    
-    $uri->path( $path );
+    $uri->scheme($scheme);
+    $uri->host($host);
+    $uri->port($port);
+    $uri->path($path);
     $uri->query( $ENV{QUERY_STRING} ) if $ENV{QUERY_STRING};
-    
+
     # sanitize the URI
     $uri = $uri->canonical;
-    $c->request->uri( $uri );
+    $c->request->uri($uri);
 
     # set the base URI
     # base must end in a slash
-    $base_path .= '/' unless ( $base_path =~ /\/$/ );    
+    $base_path .= '/' unless ( $base_path =~ /\/$/ );
     my $base = $uri->clone;
-    $base->path_query( $base_path );
-    $c->request->base( $base );
+    $base->path_query($base_path);
+    $c->request->base($base);
 }
 
-=item $self->prepare_query_parameters($c)
+=head2 $self->prepare_query_parameters($c)
 
 =cut
 
 sub prepare_query_parameters {
     my ( $self, $c ) = @_;
-    
-    my $u = URI::Query->new( $ENV{QUERY_STRING} );
-    $c->request->query_parameters( { $u->hash } );
+    local (*ENV) = $self->env || \%ENV;
+
+    if ( $ENV{QUERY_STRING} ) {
+        $self->SUPER::prepare_query_parameters( $c, $ENV{QUERY_STRING} );
+    }
 }
 
-=item $self->prepare_write($c)
+=head2 $self->prepare_request($c, (env => \%env))
+
+=cut
+
+sub prepare_request {
+    my ( $self, $c, %args ) = @_;
+
+    if ( $args{env} ) {
+        $self->env( $args{env} );
+    }
+}
+
+=head2 $self->prepare_write($c)
 
 Enable autoflush on the output handle for CGI-based engines.
 
@@ -168,27 +185,25 @@ Enable autoflush on the output handle for CGI-based engines.
 
 sub prepare_write {
     my ( $self, $c ) = @_;
-    
+
     # Set the output handle to autoflush
-    $c->response->handle->autoflush(1);
-    
-    $self->NEXT::prepare_write( $c );
+    *STDOUT->autoflush(1);
+
+    $self->NEXT::prepare_write($c);
 }
 
-=item $self->read_chunk($c, $buffer, $length)
+=head2 $self->read_chunk($c, $buffer, $length)
 
 =cut
 
-sub read_chunk { shift; shift->request->handle->sysread( @_ ); }
+sub read_chunk { shift; shift; *STDIN->sysread(@_); }
 
-=item $self->run
+=head2 $self->run
 
 =cut
 
 sub run { shift; shift->handle_request(@_) }
 
-=back
-
 =head1 SEE ALSO
 
 L<Catalyst> L<Catalyst::Engine>.