Fixed bug in mod_fastcgi config

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / FastCGI.pm

diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm
index 9f31da1..469d5dc 100644 (file)
--- a/lib/Catalyst/Engine/FastCGI.pm
+++ b/lib/Catalyst/Engine/FastCGI.pm
@@ -18,17 +18,70 @@ This class overloads some methods from C<Catalyst::Engine::CGI>.
 
 =over 4
 
-=item $self->run($c)
+=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;
+
+  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
+
+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
 
 =cut
 
 sub run {
-    my ( $self, $class ) = @_;
+    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";
+    }
+
+    $options ||= {};
+    
+    my %env;
+
+    my $request =
+      FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%env, $sock,
+        ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
+      );
 
-    my $request = FCGI::Request();
+    my $proc_manager;
+
+    if ( $listen and ( $options->{nproc} || 1 ) > 1 ) {
+        require FCGI::ProcManager;
+        $proc_manager =
+          FCGI::ProcManager->new( { n_processes => $options->{nproc} } );
+        $proc_manager->pm_manage();
+    }
 
     while ( $request->Accept >= 0 ) {
-        $class->handle_request;
+        $proc_manager && $proc_manager->pm_pre_dispatch();
+        $class->handle_request( env => \%env );
+        $proc_manager && $proc_manager->pm_pre_dispatch();
     }
 }
 
@@ -38,19 +91,106 @@ sub run {
 
 sub write {
     my ( $self, $c, $buffer ) = @_;
-    
+
     unless ( $self->{_prepared_write} ) {
-        $self->prepare_write( $c );
+        $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.
-    $c->response->handle->syswrite( $buffer );
+    *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
+    
+    <VirtualHost *>
+        ScriptAlias / /var/www/MyApp/script/myapp_fastcgi.pl/
+    </VirtualHost>
+    
+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
+    
+    <VirtualHost *>
+        ScriptAlias / /tmp/myapp_fastcgi.pl/
+    </VirtualHost>
+    
+For more information on using FastCGI under Apache, visit
+L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
+
+=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<http://www.lighttpd.net/documentation/fastcgi.html>
+
+=head2 IIS
+
+It is possible to run Catalyst under IIS with FastCGI, but we do not
+yet have detailed instructions.
+
 =head1 SEE ALSO
 
 L<Catalyst>, L<FCGI>.
@@ -69,5 +209,3 @@ This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
-
-1;