From: Florian Ragwitz Date: Sun, 5 Dec 2010 13:00:18 +0000 (+0000) Subject: Merge remote branch 'svn/trunk' into psgi X-Git-Tag: 5.89000~14 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=182f8b1e3c426d62337e186c2409c555794152d7;hp=8865ee1205d2f74a601105ae6c85af2cceb8ad7d Merge remote branch 'svn/trunk' into psgi svn/trunk: Rename --title to --proc_title as that makes more sense. Remove -t option as it's confusing.. Update changelog Conflicts: lib/Catalyst/Engine/FastCGI.pm lib/Catalyst/Script/FastCGI.pm t/aggregate/unit_core_script_fastcgi.t --- diff --git a/Makefile.PL b/Makefile.PL index 8dbd962..c016f5a 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -19,9 +19,11 @@ requires 'namespace::clean' => '0.13'; requires 'B::Hooks::EndOfScope' => '0.08'; requires 'MooseX::Emulate::Class::Accessor::Fast' => '0.00903'; requires 'Class::MOP' => '0.95'; +requires 'Data::OptList'; requires 'Moose' => '1.03'; requires 'MooseX::MethodAttributes::Inheritable' => '0.24'; requires 'MooseX::Role::WithOverloading' => '0.05'; +requires 'MooseX::Types::LoadableClass' => '0.003'; requires 'Carp'; requires 'Class::C3::Adopt::NEXT' => '0.07'; requires 'CGI::Simple::Cookie' => '1.109'; @@ -43,6 +45,7 @@ requires 'Text::SimpleTable' => '0.03'; requires 'Time::HiRes'; requires 'Tree::Simple' => '1.15'; requires 'Tree::Simple::Visitor::FindByPath'; +requires 'Try::Tiny'; requires 'URI' => '1.35'; requires 'Task::Weaken'; requires 'Text::Balanced'; # core in 5.8.x but mentioned for completeness @@ -51,10 +54,13 @@ requires 'MooseX::Getopt' => '0.30'; requires 'MooseX::Types'; requires 'MooseX::Types::Common::Numeric'; requires 'String::RewritePrefix' => '0.004'; # Catalyst::Utils::resolve_namespace +requires 'Plack' => '0.9935'; # Setup empty PATH_INFO if needed +requires 'Plack::Middleware::ReverseProxy' => '0.04'; test_requires 'Class::Data::Inheritable'; test_requires 'Test::Exception'; test_requires 'Test::More' => '0.88'; +test_requires 'Data::Dump'; # aggregate tests if AGGREGATE_TESTS is set and a recent Test::Aggregate and a Test::Simple it works with is available if ($ENV{AGGREGATE_TESTS} && can_use('Test::Simple', '0.88') && can_use('Test::Aggregate', '0.364')) { diff --git a/TODO b/TODO index 8fd77ad..7fa2b36 100644 --- a/TODO +++ b/TODO @@ -26,6 +26,28 @@ http://github.com/willert/catalyst-plugin-log4perl-simple/tree # REFACTORING +## PSGI + +### Blockers + + * properly pass along server arguments + * Fix Test::WWW::Mechanize::Catalyst which has been broken by moving stuff + about. + * think about whether or not to generate myapp.psgi and how to configure + middleware + +### Nice to have + + * throw out Catalyst::Test's remote_request in favour of + Plack::Test::ExternalServer + * make sure we're running under a server that support psgi.streaming - maybe + just load the BufferedWrite middleware, although that might break things + relying on ->write doing an unbuffered write + * throw away the restarter and allow using the restarters Plack provides + * remove per-request state from the engine instance + * be smarter about how we use PSGI - not every response needs to be delayed + and streaming + ## The horrible hack for plugin setup - replacing it: * Have a look at the Devel::REPL BEFORE_PLUGIN stuff diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 35c6ca9..2c96b15 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -29,8 +29,10 @@ use Tree::Simple::Visitor::FindByUID; use Class::C3::Adopt::NEXT; use List::MoreUtils qw/uniq/; use attributes; +use String::RewritePrefix; use utf8; use Carp qw/croak carp shortmess/; +use Try::Tiny; BEGIN { require 5.008004; } @@ -69,10 +71,10 @@ our $GO = Catalyst::Exception::Go->new; __PACKAGE__->mk_classdata($_) for qw/components arguments dispatcher engine log dispatcher_class engine_class context_class request_class response_class stats_class - setup_finished/; + setup_finished psgi_app/; __PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); -__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->engine_class('Catalyst::Engine'); __PACKAGE__->request_class('Catalyst::Request'); __PACKAGE__->response_class('Catalyst::Response'); __PACKAGE__->stats_class('Catalyst::Stats'); @@ -1938,7 +1940,7 @@ sub handle_request { # Always expect worst case! my $status = -1; - eval { + try { if ($class->debug) { my $secs = time - $START || 1; my $av = sprintf '%.3f', $COUNT / $secs; @@ -1949,12 +1951,11 @@ sub handle_request { my $c = $class->prepare(@arguments); $c->dispatch; $status = $c->finalize; - }; - - if ( my $error = $@ ) { - chomp $error; - $class->log->error(qq/Caught exception in engine "$error"/); } + catch { + chomp(my $error = $_); + $class->log->error(qq/Caught exception in engine "$error"/); + }; $COUNT++; @@ -1991,28 +1992,38 @@ sub prepare { $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); } - #XXX reuse coderef from can - # Allow engine to direct the prepare flow (for POE) - if ( $c->engine->can('prepare') ) { - $c->engine->prepare( $c, @arguments ); - } - else { - $c->prepare_request(@arguments); - $c->prepare_connection; - $c->prepare_query_parameters; - $c->prepare_headers; - $c->prepare_cookies; - $c->prepare_path; - - # Prepare the body for reading, either by prepare_body - # or the user, if they are using $c->read - $c->prepare_read; - - # Parse the body unless the user wants it on-demand - unless ( ref($c)->config->{parse_on_demand} ) { - $c->prepare_body; + try { + # Allow engine to direct the prepare flow (for POE) + if ( my $prepare = $c->engine->can('prepare') ) { + $c->engine->$prepare( $c, @arguments ); + } + else { + $c->prepare_request(@arguments); + $c->prepare_connection; + $c->prepare_query_parameters; + $c->prepare_headers; + $c->prepare_cookies; + $c->prepare_path; + + # Prepare the body for reading, either by prepare_body + # or the user, if they are using $c->read + $c->prepare_read; + + # Parse the body unless the user wants it on-demand + unless ( ref($c)->config->{parse_on_demand} ) { + $c->prepare_body; + } } } + # VERY ugly and probably shouldn't rely on ->finalize actually working + catch { + # failed prepare is always due to an invalid request, right? + $c->response->status(400); + $c->response->content_type('text/plain'); + $c->response->body('Bad Request'); + $c->finalize; + die $_; + }; my $method = $c->req->method || ''; my $path = $c->req->path; @@ -2391,7 +2402,7 @@ Starts the engine. =cut -sub run { my $c = shift; return $c->engine->run( $c, @_ ) } +sub run { my $c = shift; return $c->engine->run( $c, $c->psgi_app, @_ ) } =head2 $c->set_action( $action, $code, $namespace, $attrs ) @@ -2576,76 +2587,16 @@ Sets up engine. =cut sub setup_engine { - my ( $class, $engine ) = @_; - - if ($engine) { - $engine = 'Catalyst::Engine::' . $engine; - } - - if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) { - $engine = 'Catalyst::Engine::' . $env; - } - - if ( $ENV{MOD_PERL} ) { - my $meta = Class::MOP::get_metaclass_by_name($class); - - # create the apache method - $meta->add_method('apache' => sub { shift->engine->apache }); - - my ( $software, $version ) = - $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; - - $version =~ s/_//g; - $version =~ s/(\.[^.]+)\./$1/g; - - if ( $software eq 'mod_perl' ) { - - if ( !$engine ) { - - if ( $version >= 1.99922 ) { - $engine = 'Catalyst::Engine::Apache2::MP20'; - } - - elsif ( $version >= 1.9901 ) { - $engine = 'Catalyst::Engine::Apache2::MP19'; - } - - elsif ( $version >= 1.24 ) { - $engine = 'Catalyst::Engine::Apache::MP13'; - } - - else { - Catalyst::Exception->throw( message => - qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); - } - - } - - # install the correct mod_perl handler - if ( $version >= 1.9901 ) { - *handler = sub : method { - shift->handle_request(@_); - }; - } - else { - *handler = sub ($$) { shift->handle_request(@_) }; - } - - } - - elsif ( $software eq 'Zeus-Perl' ) { - $engine = 'Catalyst::Engine::Zeus'; - } - - else { - Catalyst::Exception->throw( - message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ ); - } - } + my ($class, $engine) = @_; unless ($engine) { $engine = $class->engine_class; } + else { + $engine = String::RewritePrefix->rewrite( { '' => 'Catalyst::Engine::', '+' => '' }, $engine ); + } + + $engine = 'Catalyst::Engine' if $engine eq 'Catalyst::Engine::HTTP'; Class::MOP::load_class($engine); @@ -2681,8 +2632,20 @@ sub setup_engine { ); } - # engine instance + if ($ENV{MOD_PERL}) { + require 'Catalyst/Engine/Loader.pm'; + my $apache = Catalyst::Engine::Loader->auto; + # FIXME - Immutable + $class->meta->add_method(handler => sub { + my $r = shift; + my $app = $class->psgi_app; + $apache->call_app($r, $app); + }); + } + $class->engine( $engine->new ); + $class->psgi_app( $class->engine->build_psgi_app($class) ); + } =head2 $c->setup_home diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index e770f32..7a98187 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -10,12 +10,16 @@ use HTML::Entities; use HTTP::Body; use HTTP::Headers; use URI::QueryParam; +use Moose::Util::TypeConstraints; +use Plack::Loader; +use Plack::Middleware::Conditional; +use Plack::Middleware::ReverseProxy; use Encode (); use utf8; use namespace::clean -except => 'meta'; -has env => (is => 'rw'); +has env => (is => 'ro', writer => '_set_env', clearer => '_clear_env'); # input position and length has read_length => (is => 'rw'); @@ -23,6 +27,20 @@ has read_position => (is => 'rw'); has _prepared_write => (is => 'rw'); +has _response_cb => ( + is => 'ro', + isa => 'CodeRef', + writer => '_set_response_cb', + clearer => '_clear_response_cb', +); + +has _writer => ( + is => 'ro', + isa => duck_type([qw(write close)]), + writer => '_set_writer', + clearer => '_clear_writer', +); + # Amount of data to read from input on each pass our $CHUNKSIZE = 64 * 1024; @@ -61,6 +79,12 @@ sub finalize_body { else { $self->write( $c, $body ); } + + $self->_writer->close; + $self->_clear_writer; + $self->_clear_env; + + return; } =head2 $self->finalize_cookies($c) @@ -305,7 +329,17 @@ Abstract method, allows engines to write headers to response =cut -sub finalize_headers { } +sub finalize_headers { + my ($self, $ctx) = @_; + + my @headers; + $ctx->response->headers->scan(sub { push @headers, @_ }); + + $self->_set_writer($self->_response_cb->([ $ctx->response->status, \@headers ])); + $self->_clear_response_cb; + + return; +} =head2 $self->finalize_read($c) @@ -404,7 +438,22 @@ Abstract method implemented in engines. =cut -sub prepare_connection { } +sub prepare_connection { + my ($self, $ctx) = @_; + + my $env = $self->env; + my $request = $ctx->request; + + $request->address( $env->{REMOTE_ADDR} ); + $request->hostname( $env->{REMOTE_HOST} ) + if exists $env->{REMOTE_HOST}; + $request->protocol( $env->{SERVER_PROTOCOL} ); + $request->remote_user( $env->{REMOTE_USER} ); + $request->method( $env->{REQUEST_METHOD} ); + $request->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 ); + + return; +} =head2 $self->prepare_cookies($c) @@ -424,7 +473,19 @@ sub prepare_cookies { =cut -sub prepare_headers { } +sub prepare_headers { + my ($self, $ctx) = @_; + + my $env = $self->env; + my $headers = $ctx->request->headers; + + for my $header (keys %{ $env }) { + next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i; + (my $field = $header) =~ s/^HTTPS?_//; + $field =~ tr/_/-/; + $headers->header($field => $env->{$header}); + } +} =head2 $self->prepare_parameters($c) @@ -462,7 +523,61 @@ abstract method, implemented by engines. =cut -sub prepare_path { } +sub prepare_path { + my ($self, $ctx) = @_; + + my $env = $self->env; + + my $scheme = $ctx->request->secure ? 'https' : 'http'; + my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME}; + my $port = $env->{SERVER_PORT} || 80; + my $base_path = $env->{SCRIPT_NAME} || "/"; + + # set the request URI + my $path; + if (!$ctx->config->{use_request_uri_for_path}) { + my $path_info = $env->{PATH_INFO}; + if ( exists $env->{REDIRECT_URL} ) { + $base_path = $env->{REDIRECT_URL}; + $base_path =~ s/\Q$path_info\E$//; + } + $path = $base_path . $path_info; + $path =~ s{^/+}{}; + $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go; + $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE + } + else { + my $req_uri = $env->{REQUEST_URI}; + $req_uri =~ s/\?.*$//; + $path = $req_uri; + $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"; + } + + my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : ''; + my $uri = $scheme . '://' . $host . '/' . $path . $query; + + $ctx->request->uri( (bless \$uri, $uri_class)->canonical ); + + # set the base URI + # base must end in a slash + $base_path .= '/' unless $base_path =~ m{/$}; + + my $base_uri = $scheme . '://' . $host . $base_path; + + $ctx->request->base( bless \$base_uri, $uri_class ); + + return; +} =head2 $self->prepare_request($c) @@ -473,7 +588,11 @@ process the query string and extract query parameters. =cut sub prepare_query_parameters { - my ( $self, $c, $query_string ) = @_; + my ($self, $c) = @_; + + my $query_string = exists $self->env->{QUERY_STRING} + ? $self->env->{QUERY_STRING} + : ''; # Check for keywords (no = signs) # (yes, index() is faster than a regex :)) @@ -535,7 +654,10 @@ Populate the context object from the request object. =cut -sub prepare_request { } +sub prepare_request { + my ($self, $ctx, %args) = @_; + $self->_set_env($args{env}); +} =head2 $self->prepare_uploads($c) @@ -615,7 +737,7 @@ sub read { my $rc = $self->read_chunk( $c, my $buffer, $readlen ); if ( defined $rc ) { if (0 == $rc) { # Nothing more to read even though Content-Length - # said there should be. FIXME - Warn in the log here? + # said there should be. $self->finalize_read; return; } @@ -636,7 +758,10 @@ there is no more data to be read. =cut -sub read_chunk { } +sub read_chunk { + my ($self, $ctx) = (shift, shift); + return $self->env->{'psgi.input'}->read(@_); +} =head2 $self->read_length @@ -647,13 +772,55 @@ header. The amount of input data that has already been read. -=head2 $self->run($c) +=head2 $self->run($app, $server) + +Start the engine. Builds a PSGI application and calls the +run method on the server passed in.. + +=cut + +sub run { + my ($self, $app, $psgi, @args) = @_; + # FIXME - Do something sensible with the options we're passed + my $server = pop @args if blessed $args[-1]; + $server ||= Plack::Loader->auto(); # We're not being called from a script, + # so auto detect what backend to run on. + # This does *NOT* cover mod_perl. + $server->run($psgi); +} + +=head2 build_psgi_app ($app, @args) -Start the engine. Implemented by the various engine classes. +Builds and returns a PSGI application closure, wrapping it in the reverse proxy +middleware if the using_frontend_proxy config setting is set. =cut -sub run { } +sub build_psgi_app { + my ($self, $app, @args) = @_; + + my $psgi_app = sub { + my ($env) = @_; + + return sub { + my ($respond) = @_; + $self->_set_response_cb($respond); + $app->handle_request(env => $env); + }; + }; + + $psgi_app = Plack::Middleware::Conditional->wrap( + $psgi_app, + builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) }, + condition => sub { + my ($env) = @_; + return if $app->config->{ignore_frontend_proxy}; + return $env->{REMOTE_ADDR} eq '127.0.0.1' || $app->config->{using_frontend_proxy}; + }, + ); + + return $psgi_app; +} =head2 $self->write($c, $buffer) @@ -671,31 +838,10 @@ sub write { return 0 if !defined $buffer; - my $len = length($buffer); - my $wrote = syswrite STDOUT, $buffer; - - if ( !defined $wrote && $! == EWOULDBLOCK ) { - # Unable to write on the first try, will retry in the loop below - $wrote = 0; - } - - if ( defined $wrote && $wrote < $len ) { - # We didn't write the whole buffer - while (1) { - my $ret = syswrite STDOUT, $buffer, $CHUNKSIZE, $wrote; - if ( defined $ret ) { - $wrote += $ret; - } - else { - next if $! == EWOULDBLOCK; - return; - } - - last if $wrote >= $len; - } - } + my $len = length($buffer); + $self->_writer->write($buffer); - return $wrote; + return $len; } =head2 $self->unescape_uri($uri) diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm deleted file mode 100644 index 076f5b0..0000000 --- a/lib/Catalyst/Engine/CGI.pm +++ /dev/null @@ -1,325 +0,0 @@ -package Catalyst::Engine::CGI; - -use Moose; -extends 'Catalyst::Engine'; - -has _header_buf => (is => 'rw', clearer => '_clear_header_buf', predicate => '_has_header_buf'); - -=head1 NAME - -Catalyst::Engine::CGI - The CGI Engine - -=head1 SYNOPSIS - -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 Catalyst engine specialized for the CGI environment. - -=head1 PATH DECODING - -Most web server environments pass the requested path to the application using environment variables, -from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application, -exposed as C<< $c->request->base >>) and the request path below that base. - -There are two methods of doing this, both of which have advantages and disadvantages. Which method is used -is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false). - -=head2 use_request_uri_for_path => 0 - -This is the default (and the) traditional method that Catalyst has used for determining the path information. -The path is synthesised from a combination of the C and C environment variables. -The allows the application to behave correctly when C is being used to redirect requests -into the application, as these variables are adjusted by mod_rewrite to take account for the redirect. - -However this method has the major disadvantage that it is impossible to correctly decode some elements -of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot -contain path-segment parameters. >>" This means PATH_INFO is B decoded, and therefore Catalyst -can't distinguish / vs %2F in paths (in addition to other encoded values). - -=head2 use_request_uri_for_path => 1 - -This method uses the C and C environment variables. As C is never -decoded, this means that applications using this mode can correctly handle URIs including the %2F character -(i.e. with C set to C in Apache). - -Given that this method of path resolution is provably more correct, it is recommended that you use -this unless you have a specific need to deploy your application in a non-standard environment, and you are -aware of the implications of not being able to handle encoded URI paths correctly. - -However it also means that in a number of cases when the app isn't installed directly at a path, but instead -is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a -.htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed -at other URIs than that which the app is 'normally' based at with C), the resolution of -C<< $c->request->base >> will be incorrect. - -=head1 OVERLOADED METHODS - -This class overloads some methods from C. - -=head2 $self->finalize_headers($c) - -=cut - -sub finalize_headers { - my ( $self, $c ) = @_; - - $c->response->header( Status => $c->response->status ); - - $self->_header_buf($c->response->headers->as_string("\015\012") . "\015\012"); -} - -=head2 $self->prepare_connection($c) - -=cut - -sub prepare_connection { - my ( $self, $c ) = @_; - local (*ENV) = $self->env || \%ENV; - - my $request = $c->request; - $request->address( $ENV{REMOTE_ADDR} ); - - PROXY_CHECK: - { - unless ( ref($c)->config->{using_frontend_proxy} ) { - last PROXY_CHECK if $ENV{REMOTE_ADDR} ne '127.0.0.1'; - last PROXY_CHECK if ref($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); - if ( defined $ENV{HTTP_X_FORWARDED_PORT} ) { - $ENV{SERVER_PORT} = $ENV{HTTP_X_FORWARDED_PORT}; - } - } - - $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} ); - - if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { - $request->secure(1); - } - - if ( $ENV{SERVER_PORT} == 443 ) { - $request->secure(1); - } - binmode(STDOUT); # Ensure we are sending bytes. -} - -=head2 $self->prepare_headers($c) - -=cut - -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} ); - } -} - -=head2 $self->prepare_path($c) - -=cut - -# Please don't touch this method without adding tests in -# t/aggregate/unit_core_engine_cgi-prepare_path.t -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; - - # fix up for IIS - if ($ENV{SERVER_SOFTWARE} && $ENV{SERVER_SOFTWARE} =~ m{IIS/[6-9]\.\d}) { - $ENV{PATH_INFO} =~ s/^\Q$ENV{SCRIPT_NAME}\E//; - } - - my $script_name = $ENV{SCRIPT_NAME}; - $script_name =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go if $script_name; - - my $base_path; - if ( exists $ENV{REDIRECT_URL} ) { - $base_path = $ENV{REDIRECT_URL}; - $base_path =~ s/\Q$ENV{PATH_INFO}\E$//; - } - else { - $base_path = $script_name || '/'; - } - - # If we are running as a backend proxy, get the true hostname - PROXY_CHECK: - { - unless ( ref($c)->config->{using_frontend_proxy} ) { - last PROXY_CHECK if $host !~ /localhost|127.0.0.1/; - last PROXY_CHECK if ref($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; - if ( $ENV{HTTP_X_FORWARDED_PORT} ) { - $port = $ENV{HTTP_X_FORWARDED_PORT}; - } - } - - my $path_info = $ENV{PATH_INFO}; - if ($c->config->{use_request_uri_for_path}) { - # RFC 3875: "Unlike a URI path, the PATH_INFO is not URL-encoded, - # and cannot contain path-segment parameters." This means PATH_INFO - # is always decoded, and the script can't distinguish / vs %2F. - # See https://issues.apache.org/bugzilla/show_bug.cgi?id=35256 - # Here we try to resurrect the original encoded URI from REQUEST_URI. - if (my $req_uri = $ENV{REQUEST_URI}) { - if (defined $script_name) { - $req_uri =~ s/^\Q$script_name\E//; - } - $req_uri =~ s/\?.*$//; - $path_info = $req_uri if $req_uri; - } - } - - # set the request URI - my $path = $base_path . ( $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)->canonical ); - - # 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 ); -} - -=head2 $self->prepare_query_parameters($c) - -=cut - -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} ); - } -}; - -=head2 $self->prepare_request($c, (env => \%env)) - -=cut - -sub prepare_request { - my ( $self, $c, %args ) = @_; - - if ( $args{env} ) { - $self->env( $args{env} ); - } -} - -=head2 $self->prepare_write($c) - -Enable autoflush on the output handle for CGI-based engines. - -=cut - -around prepare_write => sub { - *STDOUT->autoflush(1); - return shift->(@_); -}; - -=head2 $self->write($c, $buffer) - -Writes the buffer to the client. - -=cut - -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 ); -}; - -=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( env => \%ENV ) } - -=head1 SEE ALSO - -L, L - -=head1 AUTHORS - -Catalyst Contributors, see Catalyst.pm - -=head1 COPYRIGHT - -This library is free software. You can redistribute it and/or modify it under -the same terms as Perl itself. - -=cut -no Moose; - -1; diff --git a/lib/Catalyst/Engine/HTTP.pm b/lib/Catalyst/Engine/HTTP.pm deleted file mode 100644 index 97cd8d6..0000000 --- a/lib/Catalyst/Engine/HTTP.pm +++ /dev/null @@ -1,579 +0,0 @@ -package Catalyst::Engine::HTTP; - -use Moose; -extends 'Catalyst::Engine::CGI'; - -use Data::Dump qw(dump); -use Errno 'EWOULDBLOCK'; -use HTTP::Date (); -use HTTP::Headers; -use HTTP::Status; -use Socket; -use IO::Socket::INET (); -use IO::Select (); - -use constant CHUNKSIZE => 64 * 1024; -use constant DEBUG => $ENV{CATALYST_HTTP_DEBUG} || 0; - -use namespace::clean -except => 'meta'; - -has options => ( is => 'rw' ); -has _keepalive => ( is => 'rw', predicate => '_is_keepalive', clearer => '_clear_keepalive' ); -has _write_error => ( is => 'rw', predicate => '_has_write_error' ); - -# Refactoring note - could/should Eliminate all instances of $self->{inputbuf}, -# which I haven't touched as it is used as an lvalue in a lot of places, and I guess -# doing it differently could be expensive.. Feel free to refactor and NYTProf :) - -=head1 NAME - -Catalyst::Engine::HTTP - Catalyst HTTP Engine - -=head1 SYNOPSIS - -A script using the Catalyst::Engine::HTTP module might look like: - - #!/usr/bin/perl -w - - BEGIN { $ENV{CATALYST_ENGINE} = 'HTTP' } - - use strict; - use lib '/path/to/MyApp/lib'; - use MyApp; - - MyApp->run; - -=head1 DESCRIPTION - -This is the Catalyst engine specialized for development and testing. - -=head1 METHODS - -=head2 $self->finalize_headers($c) - -=cut - -sub finalize_headers { - my ( $self, $c ) = @_; - my $protocol = $c->request->protocol; - my $status = $c->response->status; - my $message = status_message($status); - my $res_headers = $c->response->headers; - - my @headers; - push @headers, "$protocol $status $message"; - - $res_headers->header( Date => HTTP::Date::time2str(time) ); - $res_headers->header( Status => $status ); - - # Should we keep the connection open? - my $connection = $c->request->header('Connection'); - if ( $self->options - && $self->options->{keepalive} - && $connection - && $connection =~ /^keep-alive$/i - ) { - $res_headers->header( Connection => 'keep-alive' ); - $self->_keepalive(1); - } - else { - $res_headers->header( Connection => 'close' ); - } - - push @headers, $res_headers->as_string("\x0D\x0A"); - - # Buffer the headers so they are sent with the first write() call - # This reduces the number of TCP packets we are sending - $self->_header_buf( join("\x0D\x0A", @headers, '') ); -} - -=head2 $self->finalize_read($c) - -=cut - -before finalize_read => sub { - # Never ever remove this, it would result in random length output - # streams if STDIN eq STDOUT (like in the HTTP engine) - *STDIN->blocking(1); -}; - -=head2 $self->prepare_read($c) - -=cut - -before prepare_read => sub { - # Set the input handle to non-blocking - *STDIN->blocking(0); -}; - -=head2 $self->read_chunk($c, $buffer, $length) - -=cut - -sub read_chunk { - my $self = shift; - my $c = shift; - - # If we have any remaining data in the input buffer, send it back first - if ( $_[0] = delete $self->{inputbuf} ) { - my $read = length( $_[0] ); - DEBUG && warn "read_chunk: Read $read bytes from previous input buffer\n"; - return $read; - } - - # support for non-blocking IO - my $rin = ''; - vec( $rin, *STDIN->fileno, 1 ) = 1; - - READ: - { - select( $rin, undef, undef, undef ); - my $rc = *STDIN->sysread(@_); - if ( defined $rc ) { - DEBUG && warn "read_chunk: Read $rc bytes from socket\n"; - return $rc; - } - else { - next READ if $! == EWOULDBLOCK; - return; - } - } -} - -=head2 $self->write($c, $buffer) - -Writes the buffer to the client. - -=cut - -around write => sub { - my $orig = shift; - my ( $self, $c, $buffer ) = @_; - - # Avoid 'print() on closed filehandle Remote' warnings when using IE - return unless *STDOUT->opened(); - - # Prepend the headers if they have not yet been sent - if ( $self->_has_header_buf ) { - $self->_warn_on_write_error( - $self->$orig($c, $self->_clear_header_buf) - ); - } - - $self->_warn_on_write_error($self->$orig($c, $buffer)); -}; - -sub _warn_on_write_error { - my ($self, $ret) = @_; - if ( !defined $ret ) { - $self->_write_error($!); - DEBUG && warn "write: Failed to write response ($!)\n"; - } - else { - DEBUG && warn "write: Wrote response ($ret bytes)\n"; - } - return $ret; -} - -=head2 run - -=cut - -# A very very simple HTTP server that initializes a CGI environment -sub run { - my ( $self, $class, $port, $host, $options ) = @_; - - $options ||= {}; - - $self->options($options); - - if ($options->{background}) { - my $child = fork; - die "Can't fork: $!" unless defined($child); - return $child if $child; - } - - my $restart = 0; - local $SIG{CHLD} = 'IGNORE'; - - my $allowed = $options->{allowed} || { '127.0.0.1' => '255.255.255.255' }; - my $addr = $host ? inet_aton($host) : INADDR_ANY; - if ( $addr eq INADDR_ANY ) { - require Sys::Hostname; - $host = lc Sys::Hostname::hostname(); - } - else { - $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr); - } - - # Handle requests - - # Setup socket - my $daemon = IO::Socket::INET->new( - Listen => SOMAXCONN, - LocalAddr => inet_ntoa($addr), - LocalPort => $port, - Proto => 'tcp', - ReuseAddr => 1, - Type => SOCK_STREAM, - ) - or die "Couldn't create daemon: $@"; - - $port = $daemon->sockport(); - - my $url = "http://$host"; - $url .= ":$port" unless $port == 80; - - print "You can connect to your server at $url\n"; - - if ($options->{background}) { - open STDIN, "+&STDIN" or die $!; - open STDERR, ">&STDIN" or die $!; - if ( $^O !~ /MSWin32/ ) { - require POSIX; - POSIX::setsid() - or die "Can't start a new session: $!"; - } - } - - if (my $pidfile = $options->{pidfile}) { - if (! open PIDFILE, "> $pidfile") { - warn("Cannot open: $pidfile: $!"); - } - print PIDFILE "$$\n"; - close PIDFILE; - } - - my $pid = undef; - - # Ignore broken pipes as an HTTP server should - local $SIG{PIPE} = 'IGNORE'; - - # Restart on HUP - local $SIG{HUP} = sub { - $restart = 1; - warn "Restarting server on SIGHUP...\n"; - }; - - LISTEN: - while ( !$restart ) { - while ( accept( Remote, $daemon ) ) { - DEBUG && warn "New connection\n"; - - select Remote; - - Remote->blocking(1); - - # Read until we see all headers - $self->{inputbuf} = ''; - - if ( !$self->_read_headers ) { - # Error reading, give up - close Remote; - next LISTEN; - } - - my ( $method, $uri, $protocol ) = $self->_parse_request_line; - - DEBUG && warn "Parsed request: $method $uri $protocol\n"; - next unless $method; - - unless ( uc($method) eq 'RESTART' ) { - - # Fork - if ( $options->{fork} ) { - if ( $pid = fork ) { - DEBUG && warn "Forked child $pid\n"; - next; - } - } - - $self->_handler( $class, $port, $method, $uri, $protocol ); - - if ( $self->_has_write_error ) { - close Remote; - - if ( !defined $pid ) { - next LISTEN; - } - } - - if ( defined $pid ) { - # Child process, close connection and exit - DEBUG && warn "Child process exiting\n"; - $daemon->close; - exit; - } - } - else { - my $sockdata = $self->_socket_data( \*Remote ); - my $ipaddr = _inet_addr( $sockdata->{peeraddr} ); - my $ready = 0; - foreach my $ip ( keys %$allowed ) { - my $mask = $allowed->{$ip}; - $ready = ( $ipaddr & _inet_addr($mask) ) == _inet_addr($ip); - last if $ready; - } - if ($ready) { - $restart = 1; - last; - } - } - } - continue { - close Remote; - } - } - - $daemon->close; - - DEBUG && warn "Shutting down\n"; - - if ($restart) { - $SIG{CHLD} = 'DEFAULT'; - wait; - - ### if the standalone server was invoked with perl -I .. we will loose - ### those include dirs upon re-exec. So add them to PERL5LIB, so they - ### are available again for the exec'ed process --kane - use Config; - $ENV{PERL5LIB} .= join $Config{path_sep}, @INC; - - exec $^X, $0, @{ $options->{argv} || [] }; - } - - exit; -} - -sub _handler { - my ( $self, $class, $port, $method, $uri, $protocol ) = @_; - - local *STDIN = \*Remote; - local *STDOUT = \*Remote; - - # We better be careful and just use 1.0 - $protocol = '1.0'; - - my $sockdata = $self->_socket_data( \*Remote ); - my %copy_of_env = %ENV; - - my $sel = IO::Select->new; - $sel->add( \*STDIN ); - - REQUEST: - while (1) { - my ( $path, $query_string ) = split /\?/, $uri, 2; - - # URI is not the same as path. Remove scheme, domain name and port from it - $path =~ s{^https?://[^/?#]+}{}; - - # Initialize CGI environment - local %ENV = ( - PATH_INFO => $path || '', - QUERY_STRING => $query_string || '', - REMOTE_ADDR => $sockdata->{peeraddr}, - REQUEST_METHOD => $method || '', - SERVER_NAME => $sockdata->{localname}, - SERVER_PORT => $port, - SERVER_PROTOCOL => "HTTP/$protocol", - %copy_of_env, - ); - - # Parse headers - if ( $protocol >= 1 ) { - $self->_parse_headers; - } - - # Pass flow control to Catalyst - { - # FIXME: don't ignore SIGCHLD while handling requests so system() - # et al. work within actions. it might be a little risky to do that - # this far out, but then again it's only the dev server anyway. - local $SIG{CHLD} = 'DEFAULT'; - - $class->handle_request( env => \%ENV ); - } - - DEBUG && warn "Request done\n"; - - # Allow keepalive requests, this is a hack but we'll support it until - # the next major release. - if ( $self->_is_keepalive ) { - $self->_clear_keepalive; - - DEBUG && warn "Reusing previous connection for keep-alive request\n"; - - if ( $sel->can_read(1) ) { - if ( !$self->_read_headers ) { - # Error reading, give up - last REQUEST; - } - - ( $method, $uri, $protocol ) = $self->_parse_request_line; - - DEBUG && warn "Parsed request: $method $uri $protocol\n"; - - # Force HTTP/1.0 - $protocol = '1.0'; - - next REQUEST; - } - - DEBUG && warn "No keep-alive request within 1 second\n"; - } - - last REQUEST; - } - - DEBUG && warn "Closing connection\n"; - - close Remote; -} - -sub _read_headers { - my $self = shift; - - while (1) { - my $read = sysread Remote, my $buf, CHUNKSIZE; - - if ( !defined $read ) { - next if $! == EWOULDBLOCK; - DEBUG && warn "Error reading headers: $!\n"; - return; - } elsif ( $read == 0 ) { - DEBUG && warn "EOF\n"; - return; - } - - DEBUG && warn "Read $read bytes\n"; - $self->{inputbuf} .= $buf; - last if $self->{inputbuf} =~ /(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)/s; - } - - return 1; -} - -sub _parse_request_line { - my $self = shift; - - # Parse request line - # Leading CRLF sometimes sent by buggy IE versions - if ( $self->{inputbuf} !~ s/^(?:\x0D\x0A)?(\w+)[ \t]+(\S+)(?:[ \t]+(HTTP\/\d+\.\d+))?[^\012]*\012// ) { - return (); - } - - my $method = $1; - my $uri = $2; - my $proto = $3 || 'HTTP/0.9'; - - return ( $method, $uri, $proto ); -} - -sub _parse_headers { - my $self = shift; - - # Copy the buffer for header parsing, and remove the header block - # from the content buffer. - my $buf = $self->{inputbuf}; - $self->{inputbuf} =~ s/.*?(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)//s; - - # Parse headers - my $headers = HTTP::Headers->new; - my ($key, $val); - HEADER: - while ( $buf =~ s/^([^\012]*)\012// ) { - $_ = $1; - s/\015$//; - if ( /^([\w\-~]+)\s*:\s*(.*)/ ) { - $headers->push_header( $key, $val ) if $key; - ($key, $val) = ($1, $2); - } - elsif ( /^\s+(.*)/ ) { - $val .= " $1"; - } - else { - last HEADER; - } - } - $headers->push_header( $key, $val ) if $key; - - DEBUG && warn "Parsed headers: " . dump($headers) . "\n"; - - # Convert headers into ENV vars - $headers->scan( sub { - my ( $key, $val ) = @_; - - $key = uc $key; - $key = 'COOKIE' if $key eq 'COOKIES'; - $key =~ tr/-/_/; - $key = 'HTTP_' . $key - unless $key =~ m/\A(?:CONTENT_(?:LENGTH|TYPE)|COOKIE)\z/; - - if ( exists $ENV{$key} ) { - $ENV{$key} .= ", $val"; - } - else { - $ENV{$key} = $val; - } - } ); -} - -sub _socket_data { - my ( $self, $handle ) = @_; - - my $remote_sockaddr = getpeername($handle); - my ( undef, $iaddr ) = $remote_sockaddr - ? sockaddr_in($remote_sockaddr) - : (undef, undef); - - my $local_sockaddr = getsockname($handle); - my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr); - - # This mess is necessary to keep IE from crashing the server - my $data = { - peeraddr => $iaddr - ? ( inet_ntoa($iaddr) || '127.0.0.1' ) - : '127.0.0.1', - localname => _gethostbyaddr( $localiaddr ), - localaddr => inet_ntoa($localiaddr) || '127.0.0.1', - }; - - return $data; -} - -{ # If you have a crappy DNS server then these can be slow, so cache 'em - my %hostname_cache; - sub _gethostbyaddr { - my $ip = shift; - $hostname_cache{$ip} ||= gethostbyaddr( $ip, AF_INET ) || 'localhost'; - } -} - -sub _inet_addr { unpack "N*", inet_aton( $_[0] ) } - -=head2 options - -Options hash passed to the http engine to control things like if keepalive -is supported. - -=head1 SEE ALSO - -L, L - -=head1 AUTHORS - -Catalyst Contributors, see Catalyst.pm - -=head1 THANKS - -Many parts are ripped out of C by Jesse Vincent. - -=head1 COPYRIGHT - -This library is free software. You can redistribute it and/or modify it under -the same terms as Perl itself. - -=cut - -1; diff --git a/lib/Catalyst/Engine/Loader.pm b/lib/Catalyst/Engine/Loader.pm new file mode 100644 index 0000000..026a07c --- /dev/null +++ b/lib/Catalyst/Engine/Loader.pm @@ -0,0 +1,71 @@ +package Catalyst::Engine::Loader; +use Moose; +use Catalyst::Exception; +use namespace::autoclean; + +extends 'Plack::Loader'; + +around guess => sub { + my ($orig, $self) = (shift, shift); + my $engine = $self->$orig(@_); + if ($engine eq 'Standalone') { + if ( $ENV{MOD_PERL} ) { + my ( $software, $version ) = + $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; + $version =~ s/_//g; + $version =~ s/(\.[^.]+)\./$1/g; + + if ( $software eq 'mod_perl' ) { + if ( $version >= 1.99922 ) { + $engine = 'Apache2'; + } + + elsif ( $version >= 1.9901 ) { + Catalyst::Exception->throw( message => 'Plack does not have a mod_perl 1.99 handler' ); + $engine = 'Apache2::MP19'; + } + + elsif ( $version >= 1.24 ) { + $engine = 'Apache1'; + } + + else { + Catalyst::Exception->throw( message => + qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); + } + } + } + } + + return $engine; +}; + +__PACKAGE__->meta->make_immutable( inline_constructor => 0 ); + +1; + +__END__ + +=head1 NAME + +Catalyst::Engine::Loader - The Catalyst Engine Loader + +=head1 SYNOPSIS + +See L. + +=head1 DESCRIPTION + +Wrapper on L which resets the ::Engine if you are using some +version of mod_perl. + +=head1 AUTHORS + +Catalyst Contributors, see Catalyst.pm + +=head1 COPYRIGHT + +This library is free software. You can redistribute it and/or modify it under +the same terms as Perl itself. + +=cut diff --git a/lib/Catalyst/Script/CGI.pm b/lib/Catalyst/Script/CGI.pm index 60392f5..dc7f20f 100644 --- a/lib/Catalyst/Script/CGI.pm +++ b/lib/Catalyst/Script/CGI.pm @@ -1,8 +1,9 @@ package Catalyst::Script::CGI; use Moose; -BEGIN { $ENV{CATALYST_ENGINE} ||= 'CGI' } use namespace::autoclean; +sub _plack_engine_name { 'CGI' } + with 'Catalyst::ScriptRole'; __PACKAGE__->meta->make_immutable; diff --git a/lib/Catalyst/Script/FastCGI.pm b/lib/Catalyst/Script/FastCGI.pm index bad4af6..a67aa57 100644 --- a/lib/Catalyst/Script/FastCGI.pm +++ b/lib/Catalyst/Script/FastCGI.pm @@ -1,10 +1,11 @@ package Catalyst::Script::FastCGI; - -BEGIN { $ENV{CATALYST_ENGINE} ||= 'FastCGI' } use Moose; use MooseX::Types::Moose qw/Str Bool Int/; +use Data::OptList; use namespace::autoclean; +sub _plack_engine_name { 'FCGI' } + with 'Catalyst::ScriptRole'; has listen => ( @@ -59,20 +60,43 @@ has proc_title => ( traits => [qw(Getopt)], isa => Str, is => 'ro', + lazy => 1, + builder => '_build_proc_title', documentation => 'Set the process title', ); +sub _build_proc_title { + my ($self) = @_; + return sprintf 'perl-fcgi-pm [%s]', $self->application_name; +} + +sub BUILD { + my ($self) = @_; + $self->proc_title; +} + +sub _plack_loader_args { + my ($self) = shift; + return ( + map { $_->[0] => $self->${ \($_->[1] ? $_->[1]->[0] : $_->[0]) } } + Data::OptList::mkopt([ + qw/pidfile listen manager nproc keep_stderr proc_title/, + detach => [ 'daemon' ], + ]) + ); +} + sub _application_args { my ($self) = shift; return ( $self->listen, { - nproc => $self->nproc, - pidfile => $self->pidfile, - manager => $self->manager, - detach => $self->daemon, + nproc => $self->nproc, + pidfile => $self->pidfile, + manager => $self->manager, + detach => $self->daemon, keep_stderr => $self->keeperr, - proc_title => $self->proc_title, + proc_title => $self->proc_title, } ); } diff --git a/lib/Catalyst/Script/Server.pm b/lib/Catalyst/Script/Server.pm index bb4c2a5..1ec97a3 100644 --- a/lib/Catalyst/Script/Server.pm +++ b/lib/Catalyst/Script/Server.pm @@ -1,16 +1,12 @@ package Catalyst::Script::Server; - -BEGIN { - $ENV{CATALYST_ENGINE} ||= 'HTTP'; - require Catalyst::Engine::HTTP; -} - use Moose; use MooseX::Types::Common::Numeric qw/PositiveInt/; use MooseX::Types::Moose qw/ArrayRef Str Bool Int RegexpRef/; use Catalyst::Utils; use namespace::autoclean; +sub _plack_engine_name { 'Standalone' } + with 'Catalyst::ScriptRole'; has debug => ( @@ -182,6 +178,15 @@ sub run { } +sub _plack_loader_args { + my ($self) = shift; + return ( + port => $self->port, + host => $self->host, + keepalive => $self->keepalive ? 100 : 1, + ); +} + sub _application_args { my ($self) = shift; return ( diff --git a/lib/Catalyst/ScriptRole.pm b/lib/Catalyst/ScriptRole.pm index 7ae3d7d..af8c636 100644 --- a/lib/Catalyst/ScriptRole.pm +++ b/lib/Catalyst/ScriptRole.pm @@ -3,6 +3,8 @@ use Moose::Role; use MooseX::Types::Moose qw/Str Bool/; use Pod::Usage; use MooseX::Getopt; +use Catalyst::Engine::Loader; +use MooseX::Types::LoadableClass qw/LoadableClass/; use namespace::autoclean; with 'MooseX::Getopt' => { @@ -20,6 +22,26 @@ has application_name => ( required => 1, ); +has loader_class => ( + isa => LoadableClass, + is => 'ro', + coerce => 1, + default => 'Catalyst::Engine::Loader', + documentation => 'The class to use to detect and load the PSGI engine', +); + +has _loader => ( + isa => 'Plack::Loader', + default => sub { + shift->loader_class->new + }, + handles => { + load_engine => 'load', + autoload_engine => 'auto', + }, + lazy => 1, +); + sub _getopt_spec_exception {} sub _getopt_spec_warnings { @@ -42,11 +64,23 @@ sub _application_args { () } +sub _plack_loader_args { + my @app_args = shift->_application_args; + return (port => $app_args[0]); +} + sub _run_application { my $self = shift; my $app = $self->application_name; Class::MOP::load_class($app); - $app->run($self->_application_args); + my $server; + if (my $e = $self->can('_plack_engine_name') ) { + $server = $self->load_engine($self->$e, $self->_plack_loader_args); + } + else { + $server = $self->autoload_engine($self->_plack_loader_args); + } + $app->run($self->_application_args, $server); } 1; diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index d0977a3..e524840 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -4,10 +4,12 @@ use strict; use warnings; use Test::More (); +use Plack::Test; use Catalyst::Exception; use Catalyst::Utils; use Class::MOP; use Sub::Exporter; +use Carp; my $build_exports = sub { my ($self, $meth, $args, $defaults) = @_; @@ -17,15 +19,17 @@ my $build_exports = sub { if ( $ENV{CATALYST_SERVER} ) { $request = sub { remote_request(@_) }; - } elsif (! $class) { - $request = sub { Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") }; + } elsif (!$class) { + $request = sub { croak "Must specify a test app: use Catalyst::Test 'TestApp'"; } } else { unless (Class::MOP::is_class_loaded($class)) { Class::MOP::load_class($class); } $class->import; - $request = sub { local_request( $class, @_ ) }; + my $app = $class->psgi_app; + + $request = sub { local_request( $app, @_ ) }; } my $get = sub { $request->(@_)->content }; @@ -237,34 +241,41 @@ Simulate a request using L. =cut sub local_request { - my $class = shift; - - require HTTP::Request::AsCGI; - - my $request = Catalyst::Utils::request( shift(@_) ); - _customize_request($request, @_); - my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; - - $class->handle_request( env => \%ENV ); - - my $response = $cgi->restore->response; - $response->request( $request ); - - # HTML head parsing based on LWP::UserAgent - - require HTML::HeadParser; + my $app = shift; + + my $request = Catalyst::Utils::request(shift); + my %extra_env; + _customize_request($request, \%extra_env, @_); + + my $ret; + test_psgi + app => sub { $app->({ %{ $_[0] }, %extra_env }) }, + client => sub { + my $resp = shift->($request); + + # HTML head parsing based on LWP::UserAgent + # + # This is not just horrible and possibly broken, but also really + # doesn't belong here. Whoever wants this should be working on + # getting it into Plack::Test, or make a middleware out of it, or + # whatever. Seriously - horrible. + + require HTML::HeadParser; + + my $parser = HTML::HeadParser->new(); + $parser->xml_mode(1) if $resp->content_is_xhtml; + $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40; + + $parser->parse( $resp->content ); + my $h = $parser->header; + for my $f ( $h->header_field_names ) { + $resp->init_header( $f, [ $h->header($f) ] ); + } - my $parser = HTML::HeadParser->new(); - $parser->xml_mode(1) if $response->content_is_xhtml; - $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40; + $ret = $resp; + }; - $parser->parse( $response->content ); - my $h = $parser->header; - for my $f ( $h->header_field_names ) { - $response->init_header( $f, [ $h->header($f) ] ); - } - - return $response; + return $ret; } my $agent; @@ -337,11 +348,16 @@ sub remote_request { sub _customize_request { my $request = shift; + my $extra_env = shift; my $opts = pop(@_) || {}; $opts = {} unless ref($opts) eq 'HASH'; if ( my $host = exists $opts->{host} ? $opts->{host} : $default_host ) { $request->header( 'Host' => $host ); } + + if (my $extra = $opts->{extra_env}) { + @{ $extra_env }{keys %{ $extra }} = values %{ $extra }; + } } =head2 action_ok diff --git a/t/aggregate/live_component_controller_action_streaming.t b/t/aggregate/live_component_controller_action_streaming.t index 4a42e3f..1bc9cbf 100644 --- a/t/aggregate/live_component_controller_action_streaming.t +++ b/t/aggregate/live_component_controller_action_streaming.t @@ -10,7 +10,7 @@ our $iters; BEGIN { $iters = $ENV{CAT_BENCH_ITERS} || 1; } -use Test::More tests => 20*$iters; +use Test::More; use Catalyst::Test 'TestApp'; if ( $ENV{CAT_BENCHMARK} ) { @@ -29,17 +29,17 @@ sub run_tests { ok( my $response = request('http://localhost/streaming'), 'Request' ); ok( $response->is_success, 'Response Successful 2xx' ); is( $response->content_type, 'text/plain', 'Response Content-Type' ); - + SKIP: { if ( $ENV{CATALYST_SERVER} ) { skip "Using remote server", 1; } - - # XXX: Length should be undef here, but HTTP::Request::AsCGI sets it - is( $response->content_length, 12, 'Response Content-Length' ); + + ok(!defined $response->content_length, 'No Content-Length for streaming responses'); + is(length $response->content, 12, 'Response content' ); } - + is( $response->content,, <<'EOF', 'Content is a stream' ); foo bar @@ -87,3 +87,5 @@ EOF is( $response->content, "\0" x $size, 'Content is read from filehandle' ); } } + +done_testing; diff --git a/t/aggregate/live_engine_request_env.t b/t/aggregate/live_engine_request_env.t index a7de8d7..59a2219 100644 --- a/t/aggregate/live_engine_request_env.t +++ b/t/aggregate/live_engine_request_env.t @@ -13,8 +13,7 @@ use vars qw/ BEGIN { $EXPECTED_ENV_VAR = "CATALYSTTEST$$"; # has to be uppercase otherwise fails on Win32 - $EXPECTED_ENV_VAL = $ENV{$EXPECTED_ENV_VAR} - = "Test env value " . rand(100000); + $EXPECTED_ENV_VAL = "Test env value " . rand(100000); } use Test::More tests => 7; @@ -25,15 +24,18 @@ use HTTP::Headers; use HTTP::Request::Common; { - my $env; + my $response = request("http://localhost/dump/env", { + extra_env => { $EXPECTED_ENV_VAR => $EXPECTED_ENV_VAL }, + }); - ok( my $response = request("http://localhost/dump/env"), - 'Request' ); + ok( $response, 'Request' ); ok( $response->is_success, 'Response Successful 2xx' ); is( $response->content_type, 'text/plain', 'Response Content-Type' ); + + my $env; ok( eval '$env = ' . $response->content, 'Unserialize Catalyst::Request' ); is ref($env), 'HASH'; - ok exists($env->{PATH}), 'Have a PATH env var'; + ok exists($env->{PATH_INFO}), 'Have a PATH_INFO env var'; SKIP: { diff --git a/t/aggregate/live_engine_request_escaped_path.t b/t/aggregate/live_engine_request_escaped_path.t index fca5a05..e86c154 100644 --- a/t/aggregate/live_engine_request_escaped_path.t +++ b/t/aggregate/live_engine_request_escaped_path.t @@ -6,66 +6,19 @@ use FindBin; use lib "$FindBin::Bin/../lib"; use Test::More tests => 6; -use TestApp; -use HTTP::Request::AsCGI; - -=pod - -This test exposes a problem in the handling of PATH_INFO in C::Engine::CGI (and -other engines) where Catalyst does not un-escape the request correctly. -If a request is URL-encoded then Catalyst fails to decode the request -and thus will try and match actions using the URL-encoded value. - -Can NOT use Catalyst::Test as it uses HTTP::Request::AsCGI which does -correctly unescape the path (by calling $uri = $uri->canonical). - -This will fix the problem for the CGI engine, but is probably the -wrong place. And also does not fix $uri->base, either. - -Plus, the same issue is in Engine::Apache* and other engines. - -Index: lib/Catalyst/Engine/CGI.pm -=================================================================== ---- lib/Catalyst/Engine/CGI.pm (revision 7821) -+++ lib/Catalyst/Engine/CGI.pm (working copy) -@@ -157,6 +157,8 @@ - my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : ''; - my $uri = $scheme . '://' . $host . '/' . $path . $query; - -+ $uri = URI->new( $uri )->canonical; -+ - $c->request->uri( bless \$uri, $uri_class ); - - # set the base URI - -=cut +use Catalyst::Test 'TestApp'; # test that un-escaped can be feteched. { - my $request = Catalyst::Utils::request( 'http://localhost/args/params/one/two' ); - my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; - - TestApp->handle_request( env => \%ENV ); - - ok( my $response = $cgi->restore->response ); + ok( my $response = request('http://localhost/args/params/one/two') ); ok( $response->is_success, 'Response Successful 2xx' ); is( $response->content, 'onetwo' ); } # test that request with URL-escaped code works. { - my $request = Catalyst::Utils::request( 'http://localhost/args/param%73/one/two' ); - my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; - - # Reset PATH_INFO because AsCGI calls $uri = $uri->canonical which - # will unencode the path and hide the problem from the test. - $ENV{PATH_INFO} = '/args/param%73/one/two'; - - - TestApp->handle_request( env => \%ENV ); - - ok( my $response = $cgi->restore->response ); + ok( my $response = request('http://localhost/args/param%73/one/two') ); ok( $response->is_success, 'Response Successful 2xx' ); is( $response->content, 'onetwo' ); } diff --git a/t/aggregate/live_engine_request_headers.t b/t/aggregate/live_engine_request_headers.t index d0ef1f0..4e4ab74 100644 --- a/t/aggregate/live_engine_request_headers.t +++ b/t/aggregate/live_engine_request_headers.t @@ -31,7 +31,7 @@ use HTTP::Request::Common; like( $response->content, qr/^bless\( .* 'Catalyst::Request' \)$/s, 'Content is a serialized Catalyst::Request' ); ok( eval '$creq = ' . $response->content, 'Unserialize Catalyst::Request' ); isa_ok( $creq, 'Catalyst::Request' ); - ok( $creq->secure, 'Forwarded port sets securet' ); + ok( $creq->secure, 'Forwarded port sets secure' ); isa_ok( $creq->headers, 'HTTP::Headers', 'Catalyst::Request->headers' ); is( $creq->header('X-Whats-Cool'), $request->header('X-Whats-Cool'), 'Catalyst::Request->header X-Whats-Cool' ); @@ -45,7 +45,7 @@ use HTTP::Request::Common; is( $creq->header('User-Agent'), $request->header('User-Agent'), 'Catalyst::Request->header User-Agent' ); - my $host = sprintf( '%s:%d', $request->uri->host, $request->uri->port ); + my $host = sprintf( '%s:%d', $request->header('X-Forwarded-Host'), $request->header('X-Forwarded-Port') ); is( $creq->header('Host'), $host, 'Catalyst::Request->header Host' ); SKIP: diff --git a/t/aggregate/live_engine_request_remote_user.t b/t/aggregate/live_engine_request_remote_user.t index 7e5cba2..c62f607 100644 --- a/t/aggregate/live_engine_request_remote_user.t +++ b/t/aggregate/live_engine_request_remote_user.t @@ -17,12 +17,11 @@ use HTTP::Request::Common; { my $creq; - local $ENV{REMOTE_USER} = 'dwc'; my $request = GET( 'http://localhost/dump/request', ); - ok( my $response = request($request), 'Request' ); + ok( my $response = request($request, { extra_env => { REMOTE_USER => 'dwc' } }), 'Request' ); ok( $response->is_success, 'Response Successful 2xx' ); is( $response->content_type, 'text/plain', 'Response Content-Type' ); like( $response->content, qr/'Catalyst::Request'/, diff --git a/t/aggregate/unit_core_engine_cgi-prepare_path.t b/t/aggregate/unit_core_engine-prepare_path.t similarity index 80% rename from t/aggregate/unit_core_engine_cgi-prepare_path.t rename to t/aggregate/unit_core_engine-prepare_path.t index 2f30ce9..a7cad81 100644 --- a/t/aggregate/unit_core_engine_cgi-prepare_path.t +++ b/t/aggregate/unit_core_engine-prepare_path.t @@ -4,7 +4,7 @@ use Test::More; use FindBin qw/$Bin/; use lib "$Bin/../lib"; use TestApp; -use Catalyst::Engine::CGI; +use Catalyst::Engine; # mod_rewrite to app root for non / based app { @@ -13,8 +13,8 @@ use Catalyst::Engine::CGI; SCRIPT_NAME => '/comics/dispatch.cgi', REQUEST_URI => '/comics/', ); - is ''.$r->uri, 'http://www.foo.com/comics/', 'uri is correct'; - is ''.$r->base, 'http://www.foo.com/comics/', 'base is correct'; + is ''.$r->uri, 'http://www.foo.com/comics/'; + is ''.$r->base, 'http://www.foo.com/comics/'; } # mod_rewrite to sub path under app root for non / based app @@ -46,8 +46,8 @@ use Catalyst::Engine::CGI; SCRIPT_NAME => '/~bobtfish/Gitalist/script/gitalist.cgi', REQUEST_URI => '/~bobtfish/Gitalist/script/gitalist.cgi/%252F/%252F', ); - is ''.$r->uri, 'http://www.foo.com/~bobtfish/Gitalist/script/gitalist.cgi/%252F/%252F', 'uri correct'; - is ''.$r->base, 'http://www.foo.com/~bobtfish/Gitalist/script/gitalist.cgi/', 'base correct'; + is ''.$r->uri, 'http://www.foo.com/~bobtfish/Gitalist/script/gitalist.cgi/%252F/%252F'; + is ''.$r->base, 'http://www.foo.com/~bobtfish/Gitalist/script/gitalist.cgi/'; } # Using rewrite rules to ask for a sub-path in your app. @@ -85,21 +85,8 @@ use Catalyst::Engine::CGI; is ''.$r->uri, 'http://www.foo.com/oslobilder/%22foo%22', 'uri correct'; is ''.$r->base, 'http://www.foo.com/oslobilder/', 'base correct'; } - -# CGI hit on IIS for non / based app -{ - my $r = get_req(0, - SERVER_SOFTWARE => 'Microsoft-IIS/6.0', - PATH_INFO => '/bobtfish/Gitalist/script/gitalist.cgi/static/css/blueprint/screen.css', - SCRIPT_NAME => '/bobtfish/Gitalist/script/gitalist.cgi', - PATH_TRANSLATED => -'C:\\Inetpub\\vhosts\\foo.com\\httpdocs\\bobtfish\\Gitalist\\script\\gitalist.cgi\\static\\css\\blueprint\\screen.css', - ); - is ''.$r->uri, 'http://www.foo.com/bobtfish/Gitalist/script/gitalist.cgi/static/css/blueprint/screen.css'; - is ''.$r->base, 'http://www.foo.com/bobtfish/Gitalist/script/gitalist.cgi/'; -} - { + local $TODO = 'Another mod_rewrite case'; my $r = get_req (0, PATH_INFO => '/auth/login', SCRIPT_NAME => '/tx', @@ -125,6 +112,7 @@ use Catalyst::Engine::CGI; is $r->base, 'http://www.foo.com/', 'Base is correct'; } + # FIXME - Test proxy logic # - Test query string # - Test non standard port numbers @@ -139,14 +127,14 @@ sub get_req { PATH_INFO => '/', ); - local %ENV = (%template, @_); - + my $engine = Catalyst::Engine->new( + env => { %template, @_ }, + ); my $i = TestApp->new; $i->setup_finished(0); $i->config(use_request_uri_for_path => $use_request_uri_for_path); $i->setup_finished(1); - $i->engine(Catalyst::Engine::CGI->new); - $i->engine->prepare_path($i); + $engine->prepare_path($i); return $i->req; } diff --git a/t/aggregate/unit_core_script_cgi.t b/t/aggregate/unit_core_script_cgi.t index ba187e1..ffadb8a 100644 --- a/t/aggregate/unit_core_script_cgi.t +++ b/t/aggregate/unit_core_script_cgi.t @@ -15,6 +15,8 @@ lives_ok { Catalyst::Script::CGI->new_with_options(application_name => 'TestAppToTestScripts')->run; } "new_with_options"; shift @TestAppToTestScripts::RUN_ARGS; +my $server = pop @TestAppToTestScripts::RUN_ARGS; +like ref($server), qr/^Plack::Handler/, 'Is a Plack::Handler'; is_deeply \@TestAppToTestScripts::RUN_ARGS, [], "no args"; done_testing; diff --git a/t/aggregate/unit_core_script_fastcgi.t b/t/aggregate/unit_core_script_fastcgi.t index 27f245a..7201385 100644 --- a/t/aggregate/unit_core_script_fastcgi.t +++ b/t/aggregate/unit_core_script_fastcgi.t @@ -54,18 +54,16 @@ sub testOption { } "new_with_options"; # First element of RUN_ARGS will be the script name, which we don't care about shift @TestAppToTestScripts::RUN_ARGS; + my $server = pop @TestAppToTestScripts::RUN_ARGS; + like ref($server), qr/^Plack::Handler/, 'Is a Plack::Handler'; is_deeply \@TestAppToTestScripts::RUN_ARGS, $resultarray, "is_deeply comparison"; } # Returns the hash expected when no flags are passed sub opthash { return { - pidfile => undef, - keep_stderr => undef, - detach => undef, - nproc => undef, - manager => undef, - proc_title => undef, + (map { ($_ => undef) } qw(pidfile keep_stderr detach nproc manager)), + proc_title => 'perl-fcgi-pm [TestAppToTestScripts]', @_, }; } diff --git a/t/aggregate/unit_core_script_server.t b/t/aggregate/unit_core_script_server.t index b9ad60b..0623cfe 100644 --- a/t/aggregate/unit_core_script_server.t +++ b/t/aggregate/unit_core_script_server.t @@ -89,6 +89,8 @@ sub testOption { }; # First element of RUN_ARGS will be the script name, which we don't care about shift @TestAppToTestScripts::RUN_ARGS; + my $server = pop @TestAppToTestScripts::RUN_ARGS; + like ref($server), qr/^Plack::Handler/, 'Is a Plack::Handler'; # Mangle argv into the options.. $resultarray->[-1]->{argv} = $argstring; is_deeply \@TestAppToTestScripts::RUN_ARGS, $resultarray, "is_deeply comparison " . join(' ', @$argstring); diff --git a/t/aggregate/unit_load_catalyst_test.t b/t/aggregate/unit_load_catalyst_test.t index 036c3b8..399b190 100644 --- a/t/aggregate/unit_load_catalyst_test.t +++ b/t/aggregate/unit_load_catalyst_test.t @@ -107,7 +107,7 @@ use Catalyst::Test (); # FIXME - These vhosts in tests tests should be somewhere else... -sub customize { Catalyst::Test::_customize_request(@_) } +sub customize { Catalyst::Test::_customize_request($_[0], {}, @_[1 .. $#_]) } { my $req = Catalyst::Utils::request('/dummy'); diff --git a/t/lib/TestApp/View/Dump/Env.pm b/t/lib/TestApp/View/Dump/Env.pm index 0acd1df..d713b0e 100644 --- a/t/lib/TestApp/View/Dump/Env.pm +++ b/t/lib/TestApp/View/Dump/Env.pm @@ -5,7 +5,21 @@ use base qw[TestApp::View::Dump]; sub process { my ( $self, $c ) = @_; - return $self->SUPER::process( $c, $c->engine->env ); + my $env = $c->engine->env; + return $self->SUPER::process($c, { + map { ($_ => $env->{$_}) } + grep { $_ ne 'psgi.input' } + keys %{ $env }, + }); +} + +## We override Data::Dumper here since its not reliably outputting +## something that is roundtrip-able. + +sub dump { + my ( $self, $reference ) = @_; + use Data::Dump (); + return Data::Dump::dump($reference); } 1;