Reformatted documentation
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / CGI.pm
index 3028080..d2d041e 100644 (file)
@@ -2,12 +2,10 @@ package Catalyst::Engine::CGI;
 
 use strict;
 use base 'Catalyst::Engine';
-
-use CGI;
+use NEXT;
 use URI;
-use URI::http;
 
-__PACKAGE__->mk_accessors('cgi');
+__PACKAGE__->mk_accessors('env');
 
 =head1 NAME
 
@@ -30,50 +28,18 @@ appropriate engine module.
 
 =head1 DESCRIPTION
 
-This is the Catalyst engine specialized for the CGI environment (using the
-C<CGI> and C<CGI::Cookie> modules).  Normally Catalyst will select the
-appropriate engine according to the environment that it detects, however you
-can force Catalyst to use the CGI engine by specifying the following in your
-application module:
-
-    use Catalyst qw(-Engine=CGI);
-
-The performance of this way of using Catalyst is not expected to be
-useful in production applications, but it may be helpful for development.
-
-=head1 METHODS
-
-=over 4
-
-=item $c->cgi
-
-This config parameter contains the C<CGI> object.
-
-=back
+This is the Catalyst engine specialized for the CGI environment.
 
 =head1 OVERLOADED METHODS
 
 This class overloads some methods from C<Catalyst::Engine>.
 
-=over 4
-
-=item $c->finalize_body
-
-Prints the response output to STDOUT.
-
-=cut
-
-sub finalize_body {
-    my $c = shift;
-    print $c->response->output;
-}
-
-=item $c->finalize_headers
+=head2 $self->finalize_headers($c)
 
 =cut
 
 sub finalize_headers {
-    my $c = shift;
+    my ( $self, $c ) = @_;
 
     $c->response->header( Status => $c->response->status );
 
@@ -81,175 +47,174 @@ sub finalize_headers {
     print "\015\012";
 }
 
-=item $c->prepare_body
+=head2 $self->prepare_connection($c)
 
 =cut
 
-sub prepare_body {
-    my $c = shift;
-
-    # XXX this is undocumented in CGI.pm. If Content-Type is not
-    # application/x-www-form-urlencoded or multipart/form-data
-    # CGI.pm will read STDIN into a param, POSTDATA.
+sub prepare_connection {
+    my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
-    $c->request->body( $c->cgi->param('POSTDATA') );
-}
+    $c->request->address( $ENV{REMOTE_ADDR} );
 
-=item $c->prepare_connection
+  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};
 
-=cut
+        # 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);
+    }
 
-sub prepare_connection {
-    my $c = shift;
-    $c->request->address( $ENV{REMOTE_ADDR} );
     $c->request->hostname( $ENV{REMOTE_HOST} );
     $c->request->protocol( $ENV{SERVER_PROTOCOL} );
+    $c->request->user( $ENV{REMOTE_USER} );
+    $c->request->method( $ENV{REQUEST_METHOD} );
 
-    if ( $ENV{HTTPS} || $ENV{SERVER_PORT} == 443 ) {
+    if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) {
+        $c->request->secure(1);
+    }
+
+    if ( $ENV{SERVER_PORT} == 443 ) {
         $c->request->secure(1);
     }
 }
 
-=item $c->prepare_headers
+=head2 $self->prepare_headers($c)
 
 =cut
 
 sub prepare_headers {
-    my $c = shift;
+    my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
+    # Read headers from %ENV
     while ( my ( $header, $value ) = each %ENV ) {
-
-        next unless $header =~ /^(HTTP|CONTENT)/i;
-
+        next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i;
         ( my $field = $header ) =~ s/^HTTPS?_//;
-
         $c->req->headers->header( $field => $value );
     }
-
-    $c->req->method( $ENV{REQUEST_METHOD} || 'GET' );
 }
 
-=item $c->prepare_parameters
+=head2 $self->prepare_path($c)
 
 =cut
 
-sub prepare_parameters {
-    my $c = shift;
+sub prepare_path {
+    my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
-    my ( @params );
+    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 ( $c->request->method eq 'POST' ) {
-        for my $param ( $c->cgi->url_param ) {
-            for my $value (  $c->cgi->url_param($param) ) {
-                push ( @params, $param, $value );
-            }
+    # If we are running as a backend proxy, get the true hostname
+  PROXY_CHECK:
+    {
+        unless ( $c->config->{using_frontend_proxy} ) {
+            last PROXY_CHECK if $host !~ /localhost|127.0.0.1/;
+            last PROXY_CHECK if $c->config->{ignore_frontend_proxy};
         }
-    }
+        last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST};
 
-    for my $param ( $c->cgi->param ) {
-        for my $value (  $c->cgi->param($param) ) {
-            push ( @params, $param, $value );
-        }
+        $host = $ENV{HTTP_X_FORWARDED_HOST};
+
+        # backend could be on any port, so
+        # assume frontend is on the default port
+        $port = $c->request->secure ? 443 : 80;
     }
 
-    $c->request->param(@params);
+    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->query( $ENV{QUERY_STRING} ) if $ENV{QUERY_STRING};
+
+    # sanitize the URI
+    $uri = $uri->canonical;
+    $c->request->uri($uri);
+
+    # set the base URI
+    # base must end in a slash
+    $base_path .= '/' unless ( $base_path =~ /\/$/ );
+    my $base = $uri->clone;
+    $base->path_query($base_path);
+    $c->request->base($base);
 }
 
-=item $c->prepare_path
+=head2 $self->prepare_query_parameters($c)
 
 =cut
 
-sub prepare_path {
-    my $c = shift;
+sub prepare_query_parameters {
+    my ( $self, $c ) = @_;
+    local (*ENV) = $self->env || \%ENV;
 
-    my $base;
-    {
-        my $scheme = $c->request->secure ? 'https' : 'http';
-        my $host   = $ENV{HTTP_HOST}   || $ENV{SERVER_NAME};
-        my $port   = $ENV{SERVER_PORT} || 80;
-        my $path   = $ENV{SCRIPT_NAME} || '/';
-
-        $base = URI->new;
-        $base->scheme($scheme);
-        $base->host($host);
-        $base->port($port);
-        $base->path($path);
-
-        $base = $base->canonical->as_string;
+    if ( $ENV{QUERY_STRING} ) {
+        $self->SUPER::prepare_query_parameters( $c, $ENV{QUERY_STRING} );
     }
-
-    my $path = $ENV{PATH_INFO} || '/';
-    $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
-    $path =~ s/^\///;
-
-    $c->req->base($base);
-    $c->req->path($path);
 }
 
-=item $c->prepare_request
+=head2 $self->prepare_request($c, (env => \%env))
 
 =cut
 
 sub prepare_request {
-    my ( $c, $cgi ) = @_;
-    $c->cgi( $cgi || CGI->new );
-    $c->cgi->_reset_globals;
-}
-
-=item $c->prepare_uploads
+    my ( $self, $c, %args ) = @_;
 
-=cut
-
-sub prepare_uploads {
-    my $c = shift;
-
-    my @uploads;
+    if ( $args{env} ) {
+        $self->env( $args{env} );
+    }
+}
 
-    for my $param ( $c->cgi->param ) {
+=head2 $self->prepare_write($c)
 
-        my @values = $c->cgi->param($param);
+Enable autoflush on the output handle for CGI-based engines.
 
-        next unless ref( $values[0] );
+=cut
 
-        for my $fh (@values) {
+sub prepare_write {
+    my ( $self, $c ) = @_;
 
-            next unless my $size = ( stat $fh )[7];
+    # Set the output handle to autoflush
+    *STDOUT->autoflush(1);
 
-            my $info        = $c->cgi->uploadInfo($fh);
-            my $tempname    = $c->cgi->tmpFileName($fh);
-            my $type        = $info->{'Content-Type'};
-            my $disposition = $info->{'Content-Disposition'};
-            my $filename    = ( $disposition =~ / filename="([^;]*)"/ )[0];
+    $self->NEXT::prepare_write($c);
+}
 
-            my $upload = Catalyst::Request::Upload->new(
-                filename => $filename,
-                size     => $size,
-                tempname => $tempname,
-                type     => $type
-            );
+=head2 $self->read_chunk($c, $buffer, $length)
 
-            push( @uploads, $param, $upload );
-        }
-    }
+=cut
 
-    $c->request->upload(@uploads);
-}
+sub read_chunk { shift; shift; *STDIN->sysread(@_); }
 
-=item $c->run
+=head2 $self->run
 
 =cut
 
-sub run { shift->handler }
-
-=back
+sub run { shift; shift->handle_request(@_) }
 
 =head1 SEE ALSO
 
-L<Catalyst>.
+L<Catalyst> L<Catalyst::Engine>.
+
+=head1 AUTHORS
+
+Sebastian Riedel, <sri@cpan.org>
 
-=head1 AUTHOR
+Christian Hansen, <ch@ngmedia.com>
 
-Sebastian Riedel, C<sri@cpan.org>
+Andy Grundman, <andy@hybridized.org>
 
 =head1 COPYRIGHT