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=67ec08c39db49694bb0ed6a122fa53a86555ebb8;hb=ac5c933bdd463558e8d621507a53a7b247a9093e;hpb=8495c1decb1fab254162f713255ece0372c2697d diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm index 67ec08c..ae5a652 100644 --- a/lib/Catalyst/Engine/CGI.pm +++ b/lib/Catalyst/Engine/CGI.pm @@ -1,16 +1,9 @@ package Catalyst::Engine::CGI; -use strict; -use base 'Catalyst::Engine'; -use URI; +use Moose; +extends 'Catalyst::Engine'; -require CGI::Simple; -require CGI::Cookie; - -$CGI::Simple::POST_MAX = 1048576; -$CGI::Simple::DISABLE_UPLOADS = 0; - -__PACKAGE__->mk_accessors('cgi'); +has env => (is => 'rw'); =head1 NAME @@ -18,146 +11,240 @@ Catalyst::Engine::CGI - The CGI Engine =head1 SYNOPSIS -See L. +A script using the Catalyst::Engine::CGI module might look like: + + #!/usr/bin/perl -w + + use strict; + use lib '/path/to/MyApp/lib'; + use MyApp; + + MyApp->run; + +The application module (C) would use C, which loads the +appropriate engine module. =head1 DESCRIPTION -This is the CGI engine for Catalyst. +This is the Catalyst engine specialized for the CGI environment. -=head2 METHODS +=head1 OVERLOADED METHODS -=head3 run +This class overloads some methods from C. -To be called from a CGI script to start the Catalyst application. +=head2 $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. + $self->{_header_buf} + = $c->response->headers->as_string("\015\012") . "\015\012"; +} -=head3 finalize_headers +=head2 $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); +sub prepare_connection { + my ( $self, $c ) = @_; + local (*ENV) = $self->env || \%ENV; + + my $request = $c->request; + $request->address( $ENV{REMOTE_ADDR} ); + + 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]+)$/; + $request->address($ip); + } + + $request->hostname( $ENV{REMOTE_HOST} ); + $request->protocol( $ENV{SERVER_PROTOCOL} ); + $request->user( $ENV{REMOTE_USER} ); + $request->method( $ENV{REQUEST_METHOD} ); + + if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { + $request->secure(1); } - 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 - ); + + if ( $ENV{SERVER_PORT} == 443 ) { + $request->secure(1); } - $headers{-cookie} = \@cookies if @cookies; - print $c->cgi->header(%headers); } -=head3 finalize_output +=head2 $self->prepare_headers($c) =cut -sub finalize_output { - my $c = shift; - print $c->response->output; +sub prepare_headers { + 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?_//; + $headers->header( $field => $ENV{$header} ); + } } -=head3 prepare_cookies +=head2 $self->prepare_path($c) =cut -sub prepare_cookies { shift->req->cookies( { CGI::Cookie->fetch } ) } +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} || '/'; + } -=head3 prepare_headers + # 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}; -=cut + $host = $ENV{HTTP_X_FORWARDED_HOST}; -sub prepare_headers { - my $c = shift; - $c->req->method( $c->cgi->request_method ); - for my $header ( $c->cgi->http ) { - ( my $field = $header ) =~ s/^HTTPS?_//; - $c->req->headers->header( $field => $c->cgi->http($header) ); + # backend could be on any port, so + # assume frontend is on the default port + $port = $c->request->secure ? 443 : 80; + } + + # 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 ); } -=head3 prepare_parameters +=head2 $self->prepare_query_parameters($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; +around prepare_query_parameters => sub { + my $orig = shift; + my ( $self, $c ) = @_; + local (*ENV) = $self->env || \%ENV; + + if ( $ENV{QUERY_STRING} ) { + $self->$orig( $c, $ENV{QUERY_STRING} ); } - $c->req->parameters( {%vars} ); -} +}; -=head3 prepare_path +=head2 $self->prepare_request($c, (env => \%env)) =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; +sub prepare_request { + my ( $self, $c, %args ) = @_; + + if ( $args{env} ) { + $self->env( $args{env} ); } - $base = URI->new($base); - $base->path('/') if ( $ENV{CATALYST_TEST} || !$base->path ); - $c->req->base( $base->as_string ); - $c->req->server_base( $base->scheme . '://' . $base->authority ); } -=head3 prepare_request +=head2 $self->prepare_write($c) + +Enable autoflush on the output handle for CGI-based engines. =cut -sub prepare_request { shift->cgi( CGI::Simple->new ) } +before prepare_write => sub { + *STDOUT->autoflush(1); +}; + +=head2 $self->write($c, $buffer) -=head3 prepare_uploads +Writes the buffer to the client. =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' ) - }; +around write => sub { + my $orig = shift; + my ( $self, $c, $buffer ) = @_; + + # Prepend the headers if they have not yet been sent + if ( my $headers = delete $self->{_header_buf} ) { + $buffer = $headers . $buffer; } -} -sub run { shift->handler } + return $self->$orig( $c, $buffer ); +}; + +=head2 $self->read_chunk($c, $buffer, $length) + +=cut + +sub read_chunk { shift; shift; *STDIN->sysread(@_); } + +=head2 $self->run + +=cut + +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