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 # we are gonna add variables from current system environment %ENV to %env
224 # that contains at this moment just variables taken from FastCGI request
225 foreach my $k (keys(%ENV)) {
226 $env->{$k} = $ENV{$k} unless defined($env->{$k});
229 return unless ( $env->{SERVER_SOFTWARE} );
231 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
232 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
233 # Thanks to Mark Blythe for this fix
234 if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
235 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
237 # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS
238 elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/[67].0/ ) {
239 my @script_name = split(m!/!, $env->{PATH_INFO});
240 my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
243 while ($script_name[$#script_name] eq $path_translated[$#path_translated]) {
244 pop(@path_translated);
245 unshift(@path_info, pop(@script_name));
248 unshift(@path_info, '', '');
250 $env->{PATH_INFO} = join('/', @path_info);
251 $env->{SCRIPT_NAME} = join('/', @script_name);
258 =head1 WEB SERVER CONFIGURATIONS
260 =head2 Standalone FastCGI Server
262 In server mode the application runs as a standalone server and accepts
263 connections from a web server. The application can be on the same machine as
264 the web server, on a remote machine, or even on multiple remote machines.
265 Advantages of this method include running the Catalyst application as a
266 different user than the web server, and the ability to set up a scalable
269 To start your application in server mode, install the FCGI::ProcManager
270 module and then use the included fastcgi.pl script.
272 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
274 Command line options for fastcgi.pl include:
276 -d -daemon Daemonize the server.
277 -p -pidfile Write a pidfile with the pid of the process manager.
278 -l -listen Listen on a socket path, hostname:port, or :port.
279 -n -nproc The number of processes started to handle requests.
281 See below for the specific web server configurations for using the external
284 =head2 Apache 1.x, 2.x
286 Apache requires the mod_fastcgi module. The same module supports both
289 There are three ways to run your application under FastCGI on Apache: server,
292 =head3 Standalone server mode
294 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
295 Alias /myapp/ /tmp/myapp/myapp.fcgi/
297 # Or, run at the root
298 Alias / /tmp/myapp.fcgi/
300 # Optionally, rewrite the path when accessed without a trailing slash
301 RewriteRule ^/myapp$ myapp/ [R]
304 The FastCgiExternalServer directive tells Apache that when serving
305 /tmp/myapp to use the FastCGI application listenting on the socket
306 /tmp/mapp.socket. Note that /tmp/myapp.fcgi B<MUST NOT> exist --
307 it's a virtual file name. With some versions of C<mod_fastcgi> or
308 C<mod_fcgid>, you can use any name you like, but some require that the
309 virtual filename end in C<.fcgi>.
311 It's likely that Apache is not configured to serve files in /tmp, so the
312 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
313 FastCGI application. The trailing slashes are important as their use will
314 correctly set the PATH_INFO environment variable used by Catalyst to
315 determine the request path. If you would like to be able to access your app
316 without a trailing slash (http://server/myapp), you can use the above
317 RewriteRule directive.
321 The term 'static' is misleading, but in static mode Apache uses its own
322 FastCGI Process Manager to start the application processes. This happens at
323 Apache startup time. In this case you do not run your application's
324 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
325 FastCGI script to run your application.
327 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
328 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
330 FastCgiServer tells Apache to start three processes of your application at
331 startup. The Alias command maps a path to the FastCGI application. Again,
332 the trailing slashes are important.
336 In FastCGI dynamic mode, Apache will run your application on demand,
337 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
338 often use this type of setup to provide FastCGI support to many customers.
340 In this mode it is often enough to place or link your *_fastcgi.pl script in
341 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
342 must be able to run your application as a CGI script so ExecCGI must be
343 enabled for the directory.
345 AddHandler fastcgi-script .fcgi
347 The above tells Apache to run any .fcgi file as a FastCGI application.
349 Here is a complete example:
352 ServerName www.myapp.com
353 DocumentRoot /path/to/MyApp
355 # Allow CGI script to run
356 <Directory /path/to/MyApp>
360 # Tell Apache this is a FastCGI application
361 <Files myapp_fastcgi.pl>
362 SetHandler fastcgi-script
366 Then a request for /script/myapp_fastcgi.pl will run the
369 For more information on using FastCGI under Apache, visit
370 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
372 =head3 Authorization header with mod_fastcgi or mod_cgi
374 By default, mod_fastcgi/mod_cgi do not pass along the Authorization header,
375 so modules like C<Catalyst::Plugin::Authentication::Credential::HTTP> will
376 not work. To enable pass-through of this header, add the following
377 mod_rewrite directives:
379 RewriteCond %{HTTP:Authorization} ^(.+)
380 RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT]
384 These configurations were tested with Lighttpd 1.4.7.
386 =head3 Standalone server mode
388 server.document-root = "/var/www/MyApp/root"
393 "socket" => "/tmp/myapp.socket",
394 "check-local" => "disable"
401 server.document-root = "/var/www/MyApp/root"
406 "socket" => "/tmp/myapp.socket",
407 "check-local" => "disable",
408 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
416 Note that in newer versions of lighttpd, the min-procs and idle-timeout
417 values are disabled. The above example would start 5 processes.
419 =head3 Non-root configuration
421 You can also run your application at any non-root location with either of the
422 above modes. Note the required mod_rewrite rule.
424 url.rewrite = ( "myapp\$" => "myapp/" )
433 For more information on using FastCGI under Lighttpd, visit
434 L<http://www.lighttpd.net/documentation/fastcgi.html>
438 It is possible to run Catalyst under IIS with FastCGI, but only on IIS 6.0
439 (Microsoft Windows 2003), IIS 7.0 (Microsoft Windows 2008 and Vista) and
440 hopefully its successors.
442 Even if it is declared that FastCGI is supported on IIS 5.1 (Windows XP) it
443 does not support some features (specifically: wildcard mappings) that prevents
444 running Catalyst application.
446 Let us assume that our server has the following layout:
448 d:\WWW\WebApp\ path to our Catalyst application
449 d:\strawberry\perl\bin\perl.exe path to perl interpreter (with Catalyst installed)
450 c:\windows Windows directory
452 =head3 Setup IIS 6.0 (Windows 2003)
456 =item Install FastCGI extension for IIS 6.0
458 FastCGI is not a standard part of IIS 6 - you have to install it separately. For
459 more info and download go to L<http://www.iis.net/extensions/FastCGI>. Choose
460 approptiate version (32-bit/64-bit), installation is quite simple
461 (in fact no questions, no options).
463 =item Create a new website
465 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager".
466 Click "Action" > "New" > "Web Site". After you finish the installation wizard
467 you need to go to the new website's properties.
469 =item Set website properties
471 On tab "Web site" set proper values for:
472 Site Description, IP Address, TCP Port, SSL Port etc.
474 On tab "Home Directory" set the following:
476 Local path: "d:\WWW\WebApp\root"
477 Local path permission flags: check only "Read" + "Log visits"
478 Execute permitions: "Scripts only"
480 Click "Configuration" button (still on Home Directory tab) then click "Insert"
481 the wildcard application mapping and in the next dialog set:
483 Executable: "c:\windows\system32\inetsrv\fcgiext.dll"
484 Uncheck: "Verify that file exists"
486 Close all dialogs with "OK".
488 =item Edit fcgiext.ini
490 Put the following lines into c:\windows\system32\inetsrv\fcgiext.ini (on 64-bit
491 system c:\windows\syswow64\inetsrv\fcgiext.ini):
495 ;replace 8 with the identification number of the newly created website
496 ;it is not so easy to get this number:
497 ; - you can use utility "c:\inetpub\adminscripts\adsutil.vbs"
498 ; to list websites: "cscript adsutil.vbs ENUM /P /W3SVC"
499 ; to get site name: "cscript adsutil.vbs GET /W3SVC/<number>/ServerComment"
500 ; to get all details: "cscript adsutil.vbs GET /W3SVC/<number>"
501 ; - or look where are the logs located:
502 ; c:\WINDOWS\SYSTEM32\Logfiles\W3SVC7\whatever.log
503 ; means that the corresponding number is "7"
504 ;if you are running just one website using FastCGI you can use '*=CatalystApp'
507 ExePath=d:\strawberry\perl\bin\perl.exe
508 Arguments="d:\WWW\WebApp\script\webapp_fastcgi.pl -e"
510 ;by setting this you can instruct IIS to serve Catalyst static files
511 ;directly not via FastCGI (in case of any problems try 1)
512 IgnoreExistingFiles=0
514 ;do not be fooled by Microsoft doc talking about "IgnoreExistingDirectories"
515 ;that does not work and use "IgnoreDirectories" instead
520 =head3 Setup IIS 7.0 (Windows 2008 and Vista)
522 Microsoft IIS 7.0 has built-in support for FastCGI so you do not have to install
527 =item Necessary steps during IIS7 installation
529 During IIS7 installation after you have added role "Web Server (IIS)"
530 you need to check to install role feature "CGI" (do not be nervous that it is
531 not FastCGI). If you already have IIS7 installed you can add "CGI" role feature
532 through "Control panel" > "Programs and Features".
534 =item Create a new website
536 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager"
539 site name: "CatalystSite"
540 content directory: "d:\WWW\WebApp\root"
541 binding: set proper IP address, port etc.
543 =item Configure FastCGI
545 You can configure FastCGI extension using commandline utility
546 "c:\windows\system32\inetsrv\appcmd.exe"
550 =item Configuring section "fastCgi" (it is a global setting)
552 appcmd.exe set config -section:system.webServer/fastCgi /+"[fullPath='d:\strawberry\perl\bin\perl.exe',arguments='d:\www\WebApp\script\webapp_fastcgi.pl -e',maxInstances='4',idleTimeout='300',activityTimeout='30',requestTimeout='90',instanceMaxRequests='1000',protocol='NamedPipe',flushNamedPipe='False']" /commit:apphost
554 =item Configuring proper handler (it is a site related setting)
556 appcmd.exe set config "CatalystSite" -section:system.webServer/handlers /+"[name='CatalystFastCGI',path='*',verb='GET,HEAD,POST',modules='FastCgiModule',scriptProcessor='d:\strawberry\perl\bin\perl.exe|d:\www\WebApp\script\webapp_fastcgi.pl -e',resourceType='Unspecified',requireAccess='Script']" /commit:apphost
558 Note: before launching the commands above do not forget to change site
559 name and paths to values relevant for your server setup.
567 L<Catalyst>, L<FCGI>.
571 Catalyst Contributors, see Catalyst.pm
575 Bill Moseley, for documentation updates and testing.
579 This library is free software. You can redistribute it and/or modify it under
580 the same terms as Perl itself.