X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine%2FFastCGI.pm;h=4af5470c396ae6b740fbebef855803ee98296853;hb=c46dd4e827ae611b4e5047d236507a4470bf43a5;hp=f71049c712b04b3d3d3298bd01bd7307b9c85a7a;hpb=9f7782709390d6a809fab7224d6333775322dd5c;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm index f71049c..4af5470 100644 --- a/lib/Catalyst/Engine/FastCGI.pm +++ b/lib/Catalyst/Engine/FastCGI.pm @@ -1,9 +1,11 @@ package Catalyst::Engine::FastCGI; -use strict; -use base 'Catalyst::Engine::CGI'; +use Moose; +extends 'Catalyst::Engine::CGI'; + +# eval { Class::MOP::load_class("FCGI") }; eval "use FCGI"; -die "Please install FCGI\n" if $@; +die "Unable to load the FCGI module, you may need to install it:\n$@\n" if $@; =head1 NAME @@ -22,30 +24,62 @@ This class overloads some methods from C. Starts the FastCGI server. If C<$listen> is set, then it specifies a location to listen for FastCGI requests; - Form Meaning - /path listen via Unix sockets on /path - :port listen via TCP on port on all interfaces - hostname:port listen via TCP on port bound to hostname +=over 4 + +=item /path + +listen via Unix sockets on /path + +=item :port + +listen via TCP on port on all interfaces + +=item hostname:port + +listen via TCP on port bound to hostname + +=back Options may also be specified; - Option Meaning - leave_umask Set to 1 to disable setting umask to 0 - for socket open - nointr Do not allow the listener to be - interrupted by Ctrl+C - nproc Specify a number of processes for - FCGI::ProcManager - pidfile Specify a filename for the pid file - manager Specify a FCGI::ProcManager sub-class - detach Detach from console +=over 4 + +=item leave_umask + +Set to 1 to disable setting umask to 0 for socket open + +=item nointr + +Do not allow the listener to be interrupted by Ctrl+C + +=item nproc + +Specify a number of processes for FCGI::ProcManager + +=item pidfile + +Specify a filename for the pid file + +=item manager + +Specify a FCGI::ProcManager sub-class + +=item detach + +Detach from console + +=item keep_stderr + +Send STDERR to STDOUT instead of the webserver + +=back =cut sub run { my ( $self, $class, $listen, $options ) = @_; - my $sock; + my $sock = 0; if ($listen) { my $old_umask = umask; unless ( $options->{leave_umask} ) { @@ -65,9 +99,12 @@ sub run { $options ||= {}; my %env; - + my $error = \*STDERR; # send STDERR to the web server + $error = \*STDOUT # send STDERR to stdout (a logfile) + if $options->{keep_stderr}; # (if asked to) + my $request = - FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%env, $sock, + FCGI::Request( \*STDIN, \*STDOUT, $error, \%env, $sock, ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ), ); @@ -101,7 +138,11 @@ sub run { while ( $request->Accept >= 0 ) { $proc_manager && $proc_manager->pm_pre_dispatch(); + + $self->_fix_env( \%env ); + $class->handle_request( env => \%env ); + $proc_manager && $proc_manager->pm_post_dispatch(); } } @@ -113,9 +154,18 @@ sub run { sub write { my ( $self, $c, $buffer ) = @_; - unless ( $self->{_prepared_write} ) { + unless ( $self->_prepared_write ) { $self->prepare_write($c); - $self->{_prepared_write} = 1; + $self->_prepared_write(1); + } + + # XXX: We can't use Engine's write() method because syswrite + # appears to return bogus values instead of the number of bytes + # written: http://www.fastcgi.com/om_archive/mail-archive/0128.html + + # Prepend the headers if they have not yet been sent + if ( $self->_has_header_buf ) { + $buffer = $self->_clear_header_buf . $buffer; } # FastCGI does not stream data properly if using 'print $handle', @@ -156,6 +206,43 @@ sub daemon_detach { POSIX::setsid(); } +=head2 $self->_fix_env( $env ) + +Adjusts the environment variables when necessary. + +=cut + +sub _fix_env +{ + my $self = shift; + my $env = shift; + + return unless ( $env->{SERVER_SOFTWARE} ); + + # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME + # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html + # Thanks to Mark Blythe for this fix + if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) { + $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME}; + } + # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS 6.0 + elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/6.0/ ) { + my @script_name = split(m!/!, $env->{PATH_INFO}); + my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED}); + my @path_info; + + while ($script_name[$#script_name] eq $path_translated[$#path_translated]) { + pop(@path_translated); + unshift(@path_info, pop(@script_name)); + } + + unshift(@path_info, '', ''); + + $env->{PATH_INFO} = join('/', @path_info); + $env->{SCRIPT_NAME} = join('/', @script_name); + } +} + 1; __END__ @@ -195,18 +282,22 @@ static, and dynamic. =head3 Standalone server mode - FastCgiExternalServer /tmp/myapp -socket /tmp/myapp.socket - Alias /myapp/ /tmp/myapp/ + FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket + Alias /myapp/ /tmp/myapp/myapp.fcgi/ # Or, run at the root - Alias / /tmp/myapp/ + Alias / /tmp/myapp.fcgi/ # Optionally, rewrite the path when accessed without a trailing slash RewriteRule ^/myapp$ myapp/ [R] -The FastCgiExternalServer directive tells Apache that when serving /tmp/myapp -to use the FastCGI application listenting on the socket /tmp/mapp.socket. -Note that /tmp/myapp does not need to exist -- it's a virtual file name. + +The FastCgiExternalServer directive tells Apache that when serving +/tmp/myapp to use the FastCGI application listenting on the socket +/tmp/mapp.socket. Note that /tmp/myapp.fcgi does not need to exist -- +it's a virtual file name. With some versions of C or +C, you can use any name you like, but most require that the +virtual filename end in C<.fcgi>. It's likely that Apache is not configured to serve files in /tmp, so the Alias directive maps the url path /myapp/ to the (virtual) file that runs the @@ -269,6 +360,16 @@ application. For more information on using FastCGI under Apache, visit L +=head3 Authorization header with mod_fastcgi or mod_cgi + +By default, mod_fastcgi/mod_cgi do not pass along the Authorization header, +so modules like C will +not work. To enable pass-through of this header, add the following +mod_rewrite directives: + + RewriteCond %{HTTP:Authorization} ^(.+) + RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT] + =head2 Lighttpd These configurations were tested with Lighttpd 1.4.7. @@ -309,8 +410,9 @@ values are disabled. The above example would start 5 processes. =head3 Non-root configuration You can also run your application at any non-root location with either of the -above modes. +above modes. Note the required mod_rewrite rule. + url.rewrite = ( "myapp\$" => "myapp/" ) fastcgi.server = ( "/myapp" => ( "MyApp" => ( @@ -333,11 +435,7 @@ L, L. =head1 AUTHORS -Sebastian Riedel, - -Christian Hansen, - -Andy Grundman, +Catalyst Contributors, see Catalyst.pm =head1 THANKS