X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FEngine%2FCGI.pm;h=ae5a65283f069c0e5ab9a8e7d25c2009d4865ef7;hp=eb64e4a16a0414490c12b5a0414e73061fc819f4;hb=ac5c933bdd463558e8d621507a53a7b247a9093e;hpb=dbf68ff43fb78bf7363f0b8ee38a45587c934214 diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm index eb64e4a..ae5a652 100644 --- a/lib/Catalyst/Engine/CGI.pm +++ b/lib/Catalyst/Engine/CGI.pm @@ -1,13 +1,9 @@ package Catalyst::Engine::CGI; -use strict; -use base 'Catalyst::Engine'; +use Moose; +extends 'Catalyst::Engine'; -use CGI; -use URI; -use URI::http; - -__PACKAGE__->mk_accessors('cgi'); +has env => (is => 'rw'); =head1 NAME @@ -30,230 +26,225 @@ appropriate engine module. =head1 DESCRIPTION -This is the Catalyst engine specialized for the CGI environment (using the -C and C 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 object. - -=back +This is the Catalyst engine specialized for the CGI environment. =head1 OVERLOADED METHODS This class overloads some methods from C. -=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 ); - print $c->response->headers->as_string("\015\012"); - print "\015\012"; + $self->{_header_buf} + = $c->response->headers->as_string("\015\012") . "\015\012"; } -=item $c->prepare_body +=head2 $self->prepare_connection($c) =cut -sub prepare_body { - my $c = shift; +sub prepare_connection { + my ( $self, $c ) = @_; + local (*ENV) = $self->env || \%ENV; - # 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. + my $request = $c->request; + $request->address( $ENV{REMOTE_ADDR} ); - $c->request->body( $c->cgi->param('POSTDATA') ); -} + 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}; -=item $c->prepare_connection + # 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]+)$/; + $request->address($ip); + } -=cut + $request->hostname( $ENV{REMOTE_HOST} ); + $request->protocol( $ENV{SERVER_PROTOCOL} ); + $request->user( $ENV{REMOTE_USER} ); + $request->method( $ENV{REQUEST_METHOD} ); -sub prepare_connection { - my $c = shift; - $c->request->address( $ENV{REMOTE_ADDR} ); - $c->request->hostname( $ENV{REMOTE_HOST} ); - $c->request->protocol( $ENV{SERVER_PROTOCOL} ); + if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { + $request->secure(1); + } - if ( $ENV{HTTPS} || $ENV{SERVER_PORT} == 443 ) { - $c->request->secure(1); + if ( $ENV{SERVER_PORT} == 443 ) { + $request->secure(1); } } -=item $c->prepare_headers +=head2 $self->prepare_headers($c) =cut sub prepare_headers { - my $c = shift; - - while ( my ( $header, $value ) = each %ENV ) { - - next unless $header =~ /^(HTTP|CONTENT)/i; - + my ( $self, $c ) = @_; + local (*ENV) = $self->env || \%ENV; + my $headers = $c->request->headers; + # Read headers from %ENV + foreach my $header ( keys %ENV ) { + next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i; ( my $field = $header ) =~ s/^HTTPS?_//; - - $c->req->headers->header( $field => $value ); + $headers->header( $field => $ENV{$header} ); } - - $c->req->method( $ENV{REQUEST_METHOD} || 'GET' ); } -=item $c->prepare_parameters +=head2 $self->prepare_path($c) =cut -sub prepare_parameters { - my $c = shift; - - my ( @params ); - - 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 ); - } - } +sub prepare_path { + my ( $self, $c ) = @_; + local (*ENV) = $self->env || \%ENV; + + my $scheme = $c->request->secure ? 'https' : 'http'; + my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME}; + my $port = $ENV{SERVER_PORT} || 80; + my $base_path; + if ( exists $ENV{REDIRECT_URL} ) { + $base_path = $ENV{REDIRECT_URL}; + $base_path =~ s/$ENV{PATH_INFO}$//; + } + else { + $base_path = $ENV{SCRIPT_NAME} || '/'; } - for my $param ( $c->cgi->param ) { - for my $value ( $c->cgi->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}; + + $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); + # set the request URI + my $path = $base_path . ( $ENV{PATH_INFO} || '' ); + $path =~ s{^/+}{}; + + # Using URI directly is way too slow, so we construct the URLs manually + my $uri_class = "URI::$scheme"; + + # HTTP_HOST will include the port even if it's 80/443 + $host =~ s/:(?:80|443)$//; + + if ( $port !~ /^(?:80|443)$/ && $host !~ /:/ ) { + $host .= ":$port"; + } + + # Escape the path + $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go; + $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE + + my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : ''; + my $uri = $scheme . '://' . $host . '/' . $path . $query; + + $c->request->uri( bless \$uri, $uri_class ); + + # set the base URI + # base must end in a slash + $base_path .= '/' unless $base_path =~ m{/$}; + + my $base_uri = $scheme . '://' . $host . $base_path; + + $c->request->base( bless \$base_uri, $uri_class ); } -=item $c->prepare_path +=head2 $self->prepare_query_parameters($c) =cut -sub prepare_path { - my $c = shift; +around prepare_query_parameters => sub { + my $orig = shift; + 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} || '/'; - - unless ( $path =~ /\/$/ ) { - $path .= '/'; - } - - $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->$orig( $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; + my ( $self, $c, %args ) = @_; + + if ( $args{env} ) { + $self->env( $args{env} ); + } } -=item $c->prepare_uploads +=head2 $self->prepare_write($c) -=cut +Enable autoflush on the output handle for CGI-based engines. -sub prepare_uploads { - my $c = shift; +=cut - my @uploads; +before prepare_write => sub { + *STDOUT->autoflush(1); +}; - for my $param ( $c->cgi->param ) { +=head2 $self->write($c, $buffer) - my @values = $c->cgi->param($param); +Writes the buffer to the client. - next unless ref( $values[0] ); +=cut - for my $fh (@values) { +around write => sub { + my $orig = shift; + my ( $self, $c, $buffer ) = @_; - next unless my $size = ( stat $fh )[7]; + # Prepend the headers if they have not yet been sent + if ( my $headers = delete $self->{_header_buf} ) { + $buffer = $headers . $buffer; + } - 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]; + return $self->$orig( $c, $buffer ); +}; - 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. +L L. + +=head1 AUTHORS + +Sebastian Riedel, -=head1 AUTHOR +Christian Hansen, -Sebastian Riedel, C +Andy Grundman, =head1 COPYRIGHT