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
=head1 DESCRIPTION
-This is the Catalyst engine specialized for the CGI environment (using the
-C<CGI::Simple> and C<CGI::Cookie> 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<nph->.
+This class overloads some methods from C<Catalyst::Engine>.
-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<CGI::Simple> 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} );
+ $request->protocol( $ENV{SERVER_PROTOCOL} );
+ $request->user( $ENV{REMOTE_USER} );
+ $request->method( $ENV{REQUEST_METHOD} );
-This class overloads some methods from C<Catalyst>.
+ 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_connection
+ # 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_connection {
- my $c = shift;
- $c->req->hostname( $c->cgi->remote_host );
- $c->req->address( $c->cgi->remote_addr );
-}
+ # backend could be on any port, so
+ # assume frontend is on the default port
+ $port = $c->request->secure ? 443 : 80;
+ }
-=item $c->prepare_cookies
+ # 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 );
+}
-Sets up cookies.
+=head2 $self->prepare_query_parameters($c)
=cut
-sub prepare_cookies { shift->req->cookies( { CGI::Cookie->fetch } ) }
+around prepare_query_parameters => sub {
+ my $orig = shift;
+ my ( $self, $c ) = @_;
+ local (*ENV) = $self->env || \%ENV;
-=item $c->prepare_headers
+ if ( $ENV{QUERY_STRING} ) {
+ $self->$orig( $c, $ENV{QUERY_STRING} );
+ }
+};
+
+=head2 $self->prepare_request($c, (env => \%env))
=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) );
+sub prepare_request {
+ my ( $self, $c, %args ) = @_;
+
+ if ( $args{env} ) {
+ $self->env( $args{env} );
}
- $c->req->headers->header( 'Content-Type' => $c->cgi->content_type );
- $c->req->headers->header( 'Content-Length' => $c->cgi->content_length );
}
-=item $c->prepare_parameters
+=head2 $self->prepare_write($c)
+
+Enable autoflush on the output handle for CGI-based engines.
=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;
- }
- $c->req->parameters( {%vars} );
-}
+before prepare_write => sub {
+ *STDOUT->autoflush(1);
+};
+
+=head2 $self->write($c, $buffer)
-=item $c->prepare_path
+Writes the buffer to the client.
=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;
+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;
}
- $base = URI->new($base);
- $base->path('/') if ( $ENV{CATALYST_TEST} || !$base->path );
- $c->req->base( $base->as_string );
-}
-=item $c->prepare_request
+ return $self->$orig( $c, $buffer );
+};
+
+=head2 $self->read_chunk($c, $buffer, $length)
=cut
-sub prepare_request { shift->cgi( CGI::Simple->new ) }
+sub read_chunk { shift; shift; *STDIN->sysread(@_); }
-=item $c->prepare_uploads
+=head2 $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 }
+=head1 SEE ALSO
-=back
+L<Catalyst> L<Catalyst::Engine>.
-=head1 SEE ALSO
+=head1 AUTHORS
-L<Catalyst>.
+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