X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine%2FFastCGI.pm;h=2eb34cda3ad34ca7e3a0bee1ea00d16755927c44;hb=6f409682667c23a00552d0573c157ee3487c29bc;hp=1bf8d189d9f68b4286469a8929ff4443caf10b9c;hpb=316bf0f004c0de103e628994a4384e6cf4b45377;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm index 1bf8d18..2eb34cd 100644 --- a/lib/Catalyst/Engine/FastCGI.pm +++ b/lib/Catalyst/Engine/FastCGI.pm @@ -1,81 +1,216 @@ package Catalyst::Engine::FastCGI; use strict; -use base qw(Catalyst::Engine::FastCGI::Base Catalyst::Engine::CGI); +use base 'Catalyst::Engine::CGI'; +eval "use FCGI"; +die "Please install FCGI\n" if $@; =head1 NAME -Catalyst::Engine::FastCGI - Catalyst FastCGI Engine +Catalyst::Engine::FastCGI - FastCGI Engine -=head1 SYNOPSIS +=head1 DESCRIPTION -A script using the Catalyst::Engine::FastCGI module might look like: +This is the FastCGI engine. - #!/usr/bin/perl -w +=head1 OVERLOADED METHODS - BEGIN { - $ENV{CATALYST_ENGINE} = 'FastCGI'; - } +This class overloads some methods from C. - use strict; - use lib '/path/to/MyApp/lib'; - use MyApp; +=over 4 - MyApp->run; +=item $self->run($c, $listen, { option => value, ... }) + +Starts the FastCGI server. If C<$listen> is set, then it specifies a +location to listen for FastCGI requests; -=head1 DESCRIPTION + 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 -This is the Catalyst engine for FastCGI. +Options may also be specified; -=head1 OVERLOADED METHODS + 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 -This class overloads some methods from C. +=cut -=over 4 +sub run { + my ( $self, $class, $listen, $options ) = @_; + + my $sock; + if ($listen) { + my $old_umask = umask; + unless ( $options->{leave_umask} ) { + umask(0); + } + $sock = FCGI::OpenSocket( $listen, 100 ) + or die "failed to open FastCGI socket; $!"; + unless ( $options->{leave_umask} ) { + umask($old_umask); + } + } + else { + -S STDIN + or die "STDIN is not a socket; specify a listen location"; + } -=item $c->prepare_body + $options ||= {}; -=cut + my %env; -sub prepare_body { - shift->Catalyst::Engine::CGI::prepare_body(@_); -} + my $request = + FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%env, $sock, + ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ), + ); -=item $c->prepare_parameters + my $proc_manager; -=cut + if ($listen) { + require FCGI::ProcManager; + $options->{nproc} ||= 1; -sub prepare_parameters { - shift->Catalyst::Engine::CGI::prepare_parameters(@_); -} + $proc_manager = + FCGI::ProcManager->new( { n_processes => $options->{nproc} } ); -=item $c->prepare_request + if ( $options->{pidfile} ) { + $proc_manager->pm_write_pid_file( $options->{pidfile} ); + } -=cut + $proc_manager->pm_manage(); + } -sub prepare_request { - my ( $c, $fastcgi, @arguments ) = @_; - CGI::_reset_globals(); - $c->SUPER::prepare_request($fastcgi); - $c->Catalyst::Engine::CGI::prepare_request(@arguments); + while ( $request->Accept >= 0 ) { + $proc_manager && $proc_manager->pm_pre_dispatch(); + $class->handle_request( env => \%env ); + $proc_manager && $proc_manager->pm_pre_dispatch(); + } } -=item $c->prepare_uploads +=item $self->write($c, $buffer) =cut -sub prepare_uploads { - shift->Catalyst::Engine::CGI::prepare_uploads(@_); +sub write { + my ( $self, $c, $buffer ) = @_; + + unless ( $self->{_prepared_write} ) { + $self->prepare_write($c); + $self->{_prepared_write} = 1; + } + + # FastCGI does not stream data properly if using 'print $handle', + # but a syswrite appears to work properly. + *STDOUT->syswrite($buffer); } +1; +__END__ + +=back + +=head1 WEB SERVER CONFIGURATIONS + +=head2 Apache 1.x, 2.x + +Apache requires the mod_fastcgi module. The following config will let Apache +control the running of your FastCGI processes. + + # Launch the FastCGI processes + FastCgiIpcDir /tmp + FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -idle-timeout 300 -processes 5 + + + ScriptAlias / /var/www/MyApp/script/myapp_fastcgi.pl/ + + +You can also tell Apache to connect to an external FastCGI server: + + # Start the external server (requires FCGI::ProcManager) + $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 + + # Note that the path used in FastCgiExternalServer can be any path + FastCgiIpcDir /tmp + FastCgiExternalServer /tmp/myapp_fastcgi.pl -socket /tmp/myapp.socket + + + ScriptAlias / /tmp/myapp_fastcgi.pl/ + + +For more information on using FastCGI under Apache, visit +L + +=head2 Lighttpd + +This configuration was tested with Lighttpd 1.4.7. + + server.document-root = "/var/www/MyApp/root" + + fastcgi.server = ( + "" => ( + "MyApp" => ( + "socket" => "/tmp/myapp.socket", + "check-local" => "disable", + "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl", + "min-procs" => 2, + "max-procs" => 5, + "idle-timeout" => 20 + ) + ) + ) + +You can also run your application at any non-root location. + + fastcgi.server = ( + "/myapp" => ( + "MyApp" => ( + # same as above + ) + ) + ) + +You can also use an external server: + + # Start the external server (requires FCGI::ProcManager) + $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 + + server.document-root = "/var/www/MyApp/root" + + fastcgi.server = ( + "" => ( + "MyApp" => ( + "socket" => "/tmp/myapp.socket", + "check-local" => "disable" + ) + ) + ) + +For more information on using FastCGI under Lighttpd, visit +L + +=head2 IIS + +It is possible to run Catalyst under IIS with FastCGI, but we do not +yet have detailed instructions. + =head1 SEE ALSO -L, L, L. +L, L. + +=head1 AUTHORS -=head1 AUTHOR +Sebastian Riedel, -Sebastian Riedel, C -Christian Hansen, C +Christian Hansen, + +Andy Grundman, =head1 COPYRIGHT @@ -83,5 +218,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;