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=fa329020466e591f4abf40b76f2c916e384d72e4;hp=1efa954631460b6525ea2c48d8fea6a76c4560c4;hb=536bee890cf24e0e4bcda7562e7b70cc03ca0620;hpb=23f9d93414eadb11350029f13b51841d8309363b diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm index 1efa954..fa32902 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 _header_buf => (is => 'rw', clearer => '_clear_header_buf', predicate => '_has_header_buf'); =head1 NAME @@ -33,173 +26,229 @@ 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: +This is the Catalyst engine specialized for the CGI environment. - use Catalyst qw(-Engine=CGI); +=head1 OVERLOADED METHODS -Catalyst::Engine::CGI generates a full set of HTTP headers, which means that -applications using the engine must be be configured as "Non-parsed Headers" -scripts (at least when running under Apache). To configure this under Apache -name the starting with C. +This class overloads some methods from C. -The performance of this way of using Catalyst is not expected to be -useful in production applications, but it may be helpful for development. +=head2 $self->finalize_headers($c) -=head1 METHODS +=cut -=over 4 +sub finalize_headers { + my ( $self, $c ) = @_; -=item $c->run + $c->response->header( Status => $c->response->status ); -To be called from a CGI script to start the Catalyst application. + $self->_header_buf($c->response->headers->as_string("\015\012") . "\015\012"); +} -=item $c->cgi +=head2 $self->prepare_connection($c) -This config parameter contains the C object. +=cut -=back +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); + } -=head1 OVERLOADED METHODS + $request->hostname( $ENV{REMOTE_HOST} ) if exists $ENV{REMOTE_HOST}; + $request->protocol( $ENV{SERVER_PROTOCOL} ); + $request->user( $ENV{REMOTE_USER} ); # XXX: Deprecated. See Catalyst::Request for removal information + $request->remote_user( $ENV{REMOTE_USER} ); + $request->method( $ENV{REQUEST_METHOD} ); -This class overloads some methods from C. + if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { + $request->secure(1); + } -=over 4 + if ( $ENV{SERVER_PORT} == 443 ) { + $request->secure(1); + } +} -=item $c->finalize_headers +=head2 $self->prepare_headers($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 - ); +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} ); } - $headers{-cookie} = \@cookies if @cookies; - print $c->cgi->header(%headers); } -=item $c->finalize_output - -Prints the response output to STDOUT. +=head2 $self->prepare_path($c) =cut -sub finalize_output { - my $c = shift; - print $c->response->output; -} +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} || '/'; + } -=item $c->prepare_cookies + # 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}; -Sets up cookies. + $host = $ENV{HTTP_X_FORWARDED_HOST}; -=cut + # backend could be on any port, so + # assume frontend is on the default port + $port = $c->request->secure ? 443 : 80; + } -sub prepare_cookies { shift->req->cookies( { CGI::Cookie->fetch } ) } + # 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_headers +=head2 $self->prepare_query_parameters($c) =cut -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) ); +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} ); } -} +}; -=item $c->prepare_parameters +=head2 $self->prepare_request($c, (env => \%env)) =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_request { + my ( $self, $c, %args ) = @_; + + if ( $args{env} ) { + $self->env( $args{env} ); } - $c->req->parameters( {%vars} ); } -=item $c->prepare_path +=head2 $self->prepare_write($c) + +Enable autoflush on the output handle for CGI-based engines. =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 ); -} +around prepare_write => sub { + *STDOUT->autoflush(1); + return shift->(@_); +}; + +=head2 $self->write($c, $buffer) -=item $c->prepare_request +Writes the buffer to the client. =cut -sub prepare_request { shift->cgi( CGI::Simple->new ) } +around write => sub { + my $orig = shift; + my ( $self, $c, $buffer ) = @_; + + # Prepend the headers if they have not yet been sent + if ( $self->_has_header_buf ) { + $buffer = $self->_clear_header_buf . $buffer; + } + + return $self->$orig( $c, $buffer ); +}; -=item $c->prepare_uploads +=head2 $self->read_chunk($c, $buffer, $length) =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 read_chunk { shift; shift; *STDIN->sysread(@_); } -sub run { shift->handler } +=head2 $self->run + +=cut -=back +sub run { shift; shift->handle_request( env => \%ENV ) } =head1 SEE ALSO -L. +L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut +no Moose; 1;