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');
+use URI::Query;
=head1 NAME
=head1 SYNOPSIS
-See L<Catalyst>.
+A script using the Catalyst::Engine::CGI module might look like:
-=head1 DESCRIPTION
+ #!/usr/bin/perl -w
-This is the CGI engine for Catalyst.
+ use strict;
+ use lib '/path/to/MyApp/lib';
+ use MyApp;
-=head2 METHODS
+ MyApp->run;
-=head3 run
+The application module (C<MyApp>) would use C<Catalyst>, which loads the
+appropriate engine module.
-To be called from a CGI script to start the Catalyst application.
+=head1 DESCRIPTION
-=head3 cgi
+This is the Catalyst engine specialized for the CGI environment.
-This config parameter contains the C<CGI::Simple> object.
+=head1 OVERLOADED METHODS
-=head2 OVERLOADED METHODS
+This class overloads some methods from C<Catalyst::Engine>.
-This class overloads some methods from C<Catalyst>.
+=over 4
-=head3 finalize_headers
+=item $self->finalize_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
- );
- }
- $headers{-cookie} = \@cookies if @cookies;
- print $c->cgi->header(%headers);
+ my ( $self, $c ) = @_;
+
+ $c->response->header( Status => $c->response->status );
+
+ print $c->response->headers->as_string("\015\012");
+ print "\015\012";
}
-=head3 finalize_output
+=item $self->prepare_connection($c)
=cut
-sub finalize_output {
- my $c = shift;
- print $c->response->output;
-}
+sub prepare_connection {
+ my ( $self, $c ) = @_;
+
+ $c->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]+)$/;
+ $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 );
- $c->req->server_base( $base->scheme . '://' . $base->authority . '/' );
+sub prepare_query_parameters {
+ my ( $self, $c ) = @_;
+
+ my $u = URI::Query->new( $ENV{QUERY_STRING} );
+ $c->request->query_parameters( { $u->hash } );
}
-=head3 prepare_request
+=item $self->prepare_write($c)
+
+Enable autoflush on the output handle for CGI-based engines.
=cut
-sub prepare_request { shift->cgi( CGI::Simple->new ) }
+sub prepare_write {
+ my ( $self, $c ) = @_;
+
+ # Set the output handle to autoflush
+ $c->response->handle->autoflush(1);
+
+ $self->NEXT::prepare_write( $c );
+}
-=head3 prepare_uploads
+=item $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->request->handle->sysread( @_ ); }
+
+=item $self->run
+
+=cut
-sub run { shift->handler }
+sub run { shift; shift->handle_request(@_) }
+
+=back
=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
projects / catagits/Catalyst-Runtime.git / blobdiff