1 package Catalyst::Engine::FastCGI;
4 extends 'Catalyst::Engine::CGI';
6 # eval { Class::MOP::load_class("FCGI") };
8 die "Unable to load the FCGI module, you may need to install it:\n$@\n" if $@;
12 Catalyst::Engine::FastCGI - FastCGI Engine
16 This is the FastCGI engine.
18 =head1 OVERLOADED METHODS
20 This class overloads some methods from C<Catalyst::Engine::CGI>.
22 =head2 $self->run($c, $listen, { option => value, ... })
24 Starts the FastCGI server. If C<$listen> is set, then it specifies a
25 location to listen for FastCGI requests;
31 listen via Unix sockets on /path
35 listen via TCP on port on all interfaces
39 listen via TCP on port bound to hostname
43 Options may also be specified;
49 Set to 1 to disable setting umask to 0 for socket open
53 Do not allow the listener to be interrupted by Ctrl+C
57 Specify a number of processes for FCGI::ProcManager
61 Specify a filename for the pid file
65 Specify a FCGI::ProcManager sub-class
73 Send STDERR to STDOUT instead of the webserver
80 my ( $self, $class, $listen, $options ) = @_;
84 my $old_umask = umask;
85 unless ( $options->{leave_umask} ) {
88 $sock = FCGI::OpenSocket( $listen, 100 )
89 or die "failed to open FastCGI socket; $!";
90 unless ( $options->{leave_umask} ) {
94 elsif ( $^O ne 'MSWin32' ) {
96 or die "STDIN is not a socket; specify a listen location";
102 my $error = \*STDERR; # send STDERR to the web server
103 $error = \*STDOUT # send STDERR to stdout (a logfile)
104 if $options->{keep_stderr}; # (if asked to)
107 FCGI::Request( \*STDIN, \*STDOUT, $error, \%env, $sock,
108 ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
114 $options->{manager} ||= "FCGI::ProcManager";
115 $options->{nproc} ||= 1;
117 $self->daemon_fork() if $options->{detach};
119 if ( $options->{manager} ) {
120 eval "use $options->{manager}; 1" or die $@;
122 $proc_manager = $options->{manager}->new(
124 n_processes => $options->{nproc},
125 pid_fname => $options->{pidfile},
129 # detach *before* the ProcManager inits
130 $self->daemon_detach() if $options->{detach};
132 $proc_manager->pm_manage();
134 # Give each child its own RNG state.
137 elsif ( $options->{detach} ) {
138 $self->daemon_detach();
142 while ( $request->Accept >= 0 ) {
143 $proc_manager && $proc_manager->pm_pre_dispatch();
145 $self->_fix_env( \%env );
147 $class->handle_request( env => \%env );
149 $proc_manager && $proc_manager->pm_post_dispatch();
153 =head2 $self->write($c, $buffer)
158 my ( $self, $c, $buffer ) = @_;
160 unless ( $self->_prepared_write ) {
161 $self->prepare_write($c);
162 $self->_prepared_write(1);
165 # XXX: We can't use Engine's write() method because syswrite
166 # appears to return bogus values instead of the number of bytes
167 # written: http://www.fastcgi.com/om_archive/mail-archive/0128.html
169 # Prepend the headers if they have not yet been sent
170 if ( $self->_has_header_buf ) {
171 $buffer = $self->_clear_header_buf . $buffer;
174 # FastCGI does not stream data properly if using 'print $handle',
175 # but a syswrite appears to work properly.
176 *STDOUT->syswrite($buffer);
179 =head2 $self->daemon_fork()
181 Performs the first part of daemon initialisation. Specifically,
182 forking. STDERR, etc are still connected to a terminal.
191 =head2 $self->daemon_detach( )
193 Performs the second part of daemon initialisation. Specifically,
194 disassociates from the terminal.
196 However, this does B<not> change the current working directory to "/",
197 as normal daemons do. It also does not close all open file
198 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
205 print "FastCGI daemon started (pid $$)\n";
206 open STDIN, "+</dev/null" or die $!;
207 open STDOUT, ">&STDIN" or die $!;
208 open STDERR, ">&STDIN" or die $!;
212 =head2 $self->_fix_env( $env )
214 Adjusts the environment variables when necessary.
223 return unless ( $env->{SERVER_SOFTWARE} );
225 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
226 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
227 # Thanks to Mark Blythe for this fix
228 if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
229 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
231 # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS 6.0
232 elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/6.0/ ) {
233 my @script_name = split(m!/!, $env->{PATH_INFO});
234 my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
237 while ($script_name[$#script_name] eq $path_translated[$#path_translated]) {
238 pop(@path_translated);
239 unshift(@path_info, pop(@script_name));
242 unshift(@path_info, '', '');
244 $env->{PATH_INFO} = join('/', @path_info);
245 $env->{SCRIPT_NAME} = join('/', @script_name);
252 =head1 WEB SERVER CONFIGURATIONS
254 =head2 Standalone FastCGI Server
256 In server mode the application runs as a standalone server and accepts
257 connections from a web server. The application can be on the same machine as
258 the web server, on a remote machine, or even on multiple remote machines.
259 Advantages of this method include running the Catalyst application as a
260 different user than the web server, and the ability to set up a scalable
263 To start your application in server mode, install the FCGI::ProcManager
264 module and then use the included fastcgi.pl script.
266 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
268 Command line options for fastcgi.pl include:
270 -d -daemon Daemonize the server.
271 -p -pidfile Write a pidfile with the pid of the process manager.
272 -l -listen Listen on a socket path, hostname:port, or :port.
273 -n -nproc The number of processes started to handle requests.
275 See below for the specific web server configurations for using the external
278 =head2 Apache 1.x, 2.x
280 Apache requires the mod_fastcgi module. The same module supports both
283 There are three ways to run your application under FastCGI on Apache: server,
286 =head3 Standalone server mode
288 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
289 Alias /myapp/ /tmp/myapp/myapp.fcgi/
291 # Or, run at the root
292 Alias / /tmp/myapp.fcgi/
294 # Optionally, rewrite the path when accessed without a trailing slash
295 RewriteRule ^/myapp$ myapp/ [R]
298 The FastCgiExternalServer directive tells Apache that when serving
299 /tmp/myapp to use the FastCGI application listenting on the socket
300 /tmp/mapp.socket. Note that /tmp/myapp.fcgi B<MUST NOT> exist --
301 it's a virtual file name. With some versions of C<mod_fastcgi> or
302 C<mod_fcgid>, you can use any name you like, but some require that the
303 virtual filename end in C<.fcgi>.
305 It's likely that Apache is not configured to serve files in /tmp, so the
306 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
307 FastCGI application. The trailing slashes are important as their use will
308 correctly set the PATH_INFO environment variable used by Catalyst to
309 determine the request path. If you would like to be able to access your app
310 without a trailing slash (http://server/myapp), you can use the above
311 RewriteRule directive.
315 The term 'static' is misleading, but in static mode Apache uses its own
316 FastCGI Process Manager to start the application processes. This happens at
317 Apache startup time. In this case you do not run your application's
318 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
319 FastCGI script to run your application.
321 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
322 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
324 FastCgiServer tells Apache to start three processes of your application at
325 startup. The Alias command maps a path to the FastCGI application. Again,
326 the trailing slashes are important.
330 In FastCGI dynamic mode, Apache will run your application on demand,
331 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
332 often use this type of setup to provide FastCGI support to many customers.
334 In this mode it is often enough to place or link your *_fastcgi.pl script in
335 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
336 must be able to run your application as a CGI script so ExecCGI must be
337 enabled for the directory.
339 AddHandler fastcgi-script .fcgi
341 The above tells Apache to run any .fcgi file as a FastCGI application.
343 Here is a complete example:
346 ServerName www.myapp.com
347 DocumentRoot /path/to/MyApp
349 # Allow CGI script to run
350 <Directory /path/to/MyApp>
354 # Tell Apache this is a FastCGI application
355 <Files myapp_fastcgi.pl>
356 SetHandler fastcgi-script
360 Then a request for /script/myapp_fastcgi.pl will run the
363 For more information on using FastCGI under Apache, visit
364 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
366 =head3 Authorization header with mod_fastcgi or mod_cgi
368 By default, mod_fastcgi/mod_cgi do not pass along the Authorization header,
369 so modules like C<Catalyst::Plugin::Authentication::Credential::HTTP> will
370 not work. To enable pass-through of this header, add the following
371 mod_rewrite directives:
373 RewriteCond %{HTTP:Authorization} ^(.+)
374 RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT]
378 These configurations were tested with Lighttpd 1.4.7.
380 =head3 Standalone server mode
382 server.document-root = "/var/www/MyApp/root"
387 "socket" => "/tmp/myapp.socket",
388 "check-local" => "disable"
395 server.document-root = "/var/www/MyApp/root"
400 "socket" => "/tmp/myapp.socket",
401 "check-local" => "disable",
402 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
410 Note that in newer versions of lighttpd, the min-procs and idle-timeout
411 values are disabled. The above example would start 5 processes.
413 =head3 Non-root configuration
415 You can also run your application at any non-root location with either of the
416 above modes. Note the required mod_rewrite rule.
418 url.rewrite = ( "myapp\$" => "myapp/" )
427 For more information on using FastCGI under Lighttpd, visit
428 L<http://www.lighttpd.net/documentation/fastcgi.html>
432 It is possible to run Catalyst under IIS with FastCGI, but we do not
433 yet have detailed instructions.
437 L<Catalyst>, L<FCGI>.
441 Catalyst Contributors, see Catalyst.pm
445 Bill Moseley, for documentation updates and testing.
449 This program is free software, you can redistribute it and/or modify it under
450 the same terms as Perl itself.