1 package Catalyst::Engine::FastCGI;
4 use base 'Catalyst::Engine::CGI';
6 die "Unable to load the FCGI module, you may need to install it:\n$@\n" if $@;
10 Catalyst::Engine::FastCGI - FastCGI Engine
14 This is the FastCGI engine.
16 =head1 OVERLOADED METHODS
18 This class overloads some methods from C<Catalyst::Engine::CGI>.
20 =head2 $self->run($c, $listen, { option => value, ... })
22 Starts the FastCGI server. If C<$listen> is set, then it specifies a
23 location to listen for FastCGI requests;
29 listen via Unix sockets on /path
33 listen via TCP on port on all interfaces
37 listen via TCP on port bound to hostname
41 Options may also be specified;
47 Set to 1 to disable setting umask to 0 for socket open =item nointr
49 Do not allow the listener to be interrupted by Ctrl+C
53 Specify a number of processes for FCGI::ProcManager
57 Specify a filename for the pid file
61 Specify a FCGI::ProcManager sub-class
69 Send STDERR to STDOUT instead of the webserver
76 my ( $self, $class, $listen, $options ) = @_;
80 my $old_umask = umask;
81 unless ( $options->{leave_umask} ) {
84 $sock = FCGI::OpenSocket( $listen, 100 )
85 or die "failed to open FastCGI socket; $!";
86 unless ( $options->{leave_umask} ) {
90 elsif ( $^O ne 'MSWin32' ) {
92 or die "STDIN is not a socket; specify a listen location";
98 my $error = \*STDERR; # send STDERR to the web server
99 $error = \*STDOUT # send STDERR to stdout (a logfile)
100 if $options->{keep_stderr}; # (if asked to)
103 FCGI::Request( \*STDIN, \*STDOUT, $error, \%env, $sock,
104 ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
110 $options->{manager} ||= "FCGI::ProcManager";
111 $options->{nproc} ||= 1;
113 $self->daemon_fork() if $options->{detach};
115 if ( $options->{manager} ) {
116 eval "use $options->{manager}; 1" or die $@;
118 $proc_manager = $options->{manager}->new(
120 n_processes => $options->{nproc},
121 pid_fname => $options->{pidfile},
125 # detach *before* the ProcManager inits
126 $self->daemon_detach() if $options->{detach};
128 $proc_manager->pm_manage();
130 elsif ( $options->{detach} ) {
131 $self->daemon_detach();
135 while ( $request->Accept >= 0 ) {
136 $proc_manager && $proc_manager->pm_pre_dispatch();
138 $self->_fix_env( \%env );
140 $class->handle_request( env => \%env );
142 $proc_manager && $proc_manager->pm_post_dispatch();
146 =head2 $self->write($c, $buffer)
151 my ( $self, $c, $buffer ) = @_;
153 unless ( $self->{_prepared_write} ) {
154 $self->prepare_write($c);
155 $self->{_prepared_write} = 1;
158 # XXX: We can't use Engine's write() method because syswrite
159 # appears to return bogus values instead of the number of bytes
160 # written: http://www.fastcgi.com/om_archive/mail-archive/0128.html
162 # Prepend the headers if they have not yet been sent
163 if ( my $headers = delete $self->{_header_buf} ) {
164 $buffer = $headers . $buffer;
167 # FastCGI does not stream data properly if using 'print $handle',
168 # but a syswrite appears to work properly.
169 *STDOUT->syswrite($buffer);
172 =head2 $self->daemon_fork()
174 Performs the first part of daemon initialisation. Specifically,
175 forking. STDERR, etc are still connected to a terminal.
184 =head2 $self->daemon_detach( )
186 Performs the second part of daemon initialisation. Specifically,
187 disassociates from the terminal.
189 However, this does B<not> change the current working directory to "/",
190 as normal daemons do. It also does not close all open file
191 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
198 print "FastCGI daemon started (pid $$)\n";
199 open STDIN, "+</dev/null" or die $!;
200 open STDOUT, ">&STDIN" or die $!;
201 open STDERR, ">&STDIN" or die $!;
205 =head2 $self->_fix_env( $env )
207 Adjusts the environment variables when necessary.
216 return unless ( $env->{SERVER_SOFTWARE} );
218 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
219 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
220 # Thanks to Mark Blythe for this fix
221 if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
222 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
224 # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS 6.0
225 elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/6.0/ ) {
226 my @script_name = split(m!/!, $env->{PATH_INFO});
227 my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
230 while ($script_name[$#script_name] eq $path_translated[$#path_translated]) {
231 pop(@path_translated);
232 unshift(@path_info, pop(@script_name));
235 unshift(@path_info, '', '');
237 $env->{PATH_INFO} = join('/', @path_info);
238 $env->{SCRIPT_NAME} = join('/', @script_name);
245 =head1 WEB SERVER CONFIGURATIONS
247 =head2 Standalone FastCGI Server
249 In server mode the application runs as a standalone server and accepts
250 connections from a web server. The application can be on the same machine as
251 the web server, on a remote machine, or even on multiple remote machines.
252 Advantages of this method include running the Catalyst application as a
253 different user than the web server, and the ability to set up a scalable
256 To start your application in server mode, install the FCGI::ProcManager
257 module and then use the included fastcgi.pl script.
259 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
261 Command line options for fastcgi.pl include:
263 -d -daemon Daemonize the server.
264 -p -pidfile Write a pidfile with the pid of the process manager.
265 -l -listen Listen on a socket path, hostname:port, or :port.
266 -n -nproc The number of processes started to handle requests.
268 See below for the specific web server configurations for using the external
271 =head2 Apache 1.x, 2.x
273 Apache requires the mod_fastcgi module. The same module supports both
276 There are three ways to run your application under FastCGI on Apache: server,
279 =head3 Standalone server mode
281 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
282 Alias /myapp/ /tmp/myapp/myapp.fcgi/
284 # Or, run at the root
285 Alias / /tmp/myapp.fcgi/
287 # Optionally, rewrite the path when accessed without a trailing slash
288 RewriteRule ^/myapp$ myapp/ [R]
291 The FastCgiExternalServer directive tells Apache that when serving
292 /tmp/myapp to use the FastCGI application listenting on the socket
293 /tmp/mapp.socket. Note that /tmp/myapp.fcgi does not need to exist --
294 it's a virtual file name. With some versions of C<mod_fastcgi> or
295 C<mod_fcgid>, you can use any name you like, but most require that the
296 virtual filename end in C<.fcgi>.
298 It's likely that Apache is not configured to serve files in /tmp, so the
299 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
300 FastCGI application. The trailing slashes are important as their use will
301 correctly set the PATH_INFO environment variable used by Catalyst to
302 determine the request path. If you would like to be able to access your app
303 without a trailing slash (http://server/myapp), you can use the above
304 RewriteRule directive.
308 The term 'static' is misleading, but in static mode Apache uses its own
309 FastCGI Process Manager to start the application processes. This happens at
310 Apache startup time. In this case you do not run your application's
311 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
312 FastCGI script to run your application.
314 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
315 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
317 FastCgiServer tells Apache to start three processes of your application at
318 startup. The Alias command maps a path to the FastCGI application. Again,
319 the trailing slashes are important.
323 In FastCGI dynamic mode, Apache will run your application on demand,
324 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
325 often use this type of setup to provide FastCGI support to many customers.
327 In this mode it is often enough to place or link your *_fastcgi.pl script in
328 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
329 must be able to run your application as a CGI script so ExecCGI must be
330 enabled for the directory.
332 AddHandler fastcgi-script .fcgi
334 The above tells Apache to run any .fcgi file as a FastCGI application.
336 Here is a complete example:
339 ServerName www.myapp.com
340 DocumentRoot /path/to/MyApp
342 # Allow CGI script to run
343 <Directory /path/to/MyApp>
347 # Tell Apache this is a FastCGI application
348 <Files myapp_fastcgi.pl>
349 SetHandler fastcgi-script
353 Then a request for /script/myapp_fastcgi.pl will run the
356 For more information on using FastCGI under Apache, visit
357 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
359 =head3 Authorization header with mod_fastcgi or mod_cgi
361 By default, mod_fastcgi/mod_cgi do not pass along the Authorization header,
362 so modules like C<Catalyst::Plugin::Authentication::Credential::HTTP> will
363 not work. To enable pass-through of this header, add the following
364 mod_rewrite directives:
366 RewriteCond %{HTTP:Authorization} ^(.+)
367 RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT]
371 These configurations were tested with Lighttpd 1.4.7.
373 =head3 Standalone server mode
375 server.document-root = "/var/www/MyApp/root"
380 "socket" => "/tmp/myapp.socket",
381 "check-local" => "disable"
388 server.document-root = "/var/www/MyApp/root"
393 "socket" => "/tmp/myapp.socket",
394 "check-local" => "disable",
395 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
403 Note that in newer versions of lighttpd, the min-procs and idle-timeout
404 values are disabled. The above example would start 5 processes.
406 =head3 Non-root configuration
408 You can also run your application at any non-root location with either of the
409 above modes. Note the required mod_rewrite rule.
411 url.rewrite = ( "myapp\$" => "myapp/" )
420 For more information on using FastCGI under Lighttpd, visit
421 L<http://www.lighttpd.net/documentation/fastcgi.html>
425 It is possible to run Catalyst under IIS with FastCGI, but we do not
426 yet have detailed instructions.
430 L<Catalyst>, L<FCGI>.
434 Catalyst Contributors, see Catalyst.pm
438 Bill Moseley, for documentation updates and testing.
442 This program is free software, you can redistribute it and/or modify it under
443 the same terms as Perl itself.