X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine%2FCGI.pm;h=6fb71b951d68d61d3b7530bcf54b972614547e25;hb=e0616220ee0bf2a2a9f0bacc0cb3b7fd2a464f36;hp=e682f6e818a1db2e961c17edd98c490d163ba434;hpb=9a33da6aa4eb69de77c36f572e875a2529a39eef;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm index e682f6e..6fb71b9 100644 --- a/lib/Catalyst/Engine/CGI.pm +++ b/lib/Catalyst/Engine/CGI.pm @@ -2,22 +2,17 @@ package Catalyst::Engine::CGI; use strict; use base 'Catalyst::Engine'; +use NEXT; use URI; -require CGI::Simple; -require CGI::Cookie; - -$CGI::Simple::POST_MAX = 1048576; -$CGI::Simple::DISABLE_UPLOADS = 0; - -__PACKAGE__->mk_accessors('cgi'); - =head1 NAME Catalyst::Engine::CGI - The CGI Engine =head1 SYNOPSIS +A script using the Catalyst::Engine::CGI module might look like: + #!/usr/bin/perl -w use strict; @@ -26,152 +21,184 @@ Catalyst::Engine::CGI - The CGI Engine MyApp->run; -See L. +The application module (C) would use C, which loads the +appropriate engine module. =head1 DESCRIPTION -This is the CGI engine for Catalyst. - -The script shown above must be designated as a "Non-parsed Headers" -script to function properly. -To do this in Apache name the script starting with C. +This is the Catalyst engine specialized for the CGI environment. -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 OVERLOADED METHODS -=head2 METHODS +This class overloads some methods from C. -=head3 run +=over 4 -To be called from a CGI script to start the Catalyst application. +=item $self->finalize_headers($c) -=head3 cgi +=cut -This config parameter contains the C object. +sub finalize_headers { + my ( $self, $c ) = @_; -=head2 OVERLOADED METHODS + $c->response->header( Status => $c->response->status ); -This class overloads some methods from C. + print $c->response->headers->as_string("\015\012"); + print "\015\012"; +} -=head3 finalize_headers +=item $self->prepare_connection($c) =cut -sub finalize_headers { - my $c = shift; - my %headers = ( -nph => 1 ); - $headers{-status} = $c->response->status if $c->response->status; - for my $name ( $c->response->headers->header_field_names ) { - $headers{"-$name"} = $c->response->headers->header($name); - } - my @cookies; - while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) { - push @cookies, $c->cgi->cookie( - -name => $name, - -value => $cookie->{value}, - -expires => $cookie->{expires}, - -domain => $cookie->{domain}, - -path => $cookie->{path}, - -secure => $cookie->{secure} || 0 - ); - } - $headers{-cookie} = \@cookies if @cookies; - print $c->cgi->header(%headers); -} +sub prepare_connection { + my ( $self, $c ) = @_; -=head3 finalize_output + $c->request->address( $ENV{REMOTE_ADDR} ); -=cut + 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}; -sub finalize_output { - my $c = shift; - print $c->response->output; -} + # 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); + } -=head3 prepare_cookies + $c->request->hostname( $ENV{REMOTE_HOST} ); + $c->request->protocol( $ENV{SERVER_PROTOCOL} ); + $c->request->user( $ENV{REMOTE_USER} ); + $c->request->method( $ENV{REQUEST_METHOD} ); -=cut + if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { + $c->request->secure(1); + } -sub prepare_cookies { shift->req->cookies( { CGI::Cookie->fetch } ) } + if ( $ENV{SERVER_PORT} == 443 ) { + $c->request->secure(1); + } +} -=head3 prepare_headers +=item $self->prepare_headers($c) =cut sub prepare_headers { - my $c = shift; - $c->req->method( $c->cgi->request_method ); - for my $header ( $c->cgi->http ) { + my ( $self, $c ) = @_; + + # Read headers from %ENV + while ( my ( $header, $value ) = each %ENV ) { + next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i; ( my $field = $header ) =~ s/^HTTPS?_//; - $c->req->headers->header( $field => $c->cgi->http($header) ); + $c->req->headers->header( $field => $value ); } } -=head3 prepare_parameters +=item $self->prepare_path($c) =cut -sub prepare_parameters { - my $c = shift; - my %vars = $c->cgi->Vars; - while ( my ( $key, $value ) = each %vars ) { - my @values = split "\0", $value; - $vars{$key} = @values <= 1 ? $values[0] : \@values; +sub prepare_path { + my ( $self, $c ) = @_; + + 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: + { + 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}; + + $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->req->parameters( {%vars} ); + + 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); } -=head3 prepare_path +=item $self->prepare_query_parameters($c) =cut -sub prepare_path { - my $c = shift; - $c->req->path( $c->cgi->url( -absolute => 1, -path_info => 1 ) ); - my $loc = $c->cgi->url( -absolute => 1 ); - no warnings 'uninitialized'; - $c->req->{path} =~ s/^($loc)?\///; - $c->req->{path} .= '/' if $c->req->path eq $loc; - my $base = $c->cgi->url; - if ( $ENV{CATALYST_TEST} ) { - my $script = $c->cgi->script_name; - $base =~ s/$script$//i; - } - $base = URI->new($base); - $base->path('/') if ( $ENV{CATALYST_TEST} || !$base->path ); - $c->req->base( $base->as_string ); +sub prepare_query_parameters { + my ( $self, $c ) = @_; + + $self->SUPER::prepare_query_parameters( $c, $ENV{QUERY_STRING} ); +} + +=item $self->prepare_write($c) + +Enable autoflush on the output handle for CGI-based engines. + +=cut + +sub prepare_write { + my ( $self, $c ) = @_; + + # Set the output handle to autoflush + *STDOUT->autoflush(1); + + $self->NEXT::prepare_write($c); } -=head3 prepare_request +=item $self->read_chunk($c, $buffer, $length) =cut -sub prepare_request { shift->cgi( CGI::Simple->new ) } +sub read_chunk { shift; shift; *STDIN->sysread(@_); } -=head3 prepare_uploads +=item $self->run =cut -sub prepare_uploads { - my $c = shift; - for my $name ( $c->cgi->upload ) { - $c->req->uploads->{$name} = { - fh => $c->cgi->upload($name), - size => $c->cgi->upload_info( $name, 'size' ), - type => $c->cgi->upload_info( $name, 'mime' ) - }; - } -} +sub run { shift; shift->handle_request(@_) } -sub run { shift->handler } +=back =head1 SEE ALSO -L. +L L. + +=head1 AUTHORS + +Sebastian Riedel, -=head1 AUTHOR +Christian Hansen, -Sebastian Riedel, C +Andy Grundman, =head1 COPYRIGHT