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 # hack for perl libraries that use FILENO (e.g. IPC::Run)
148 # trying to patch FCGI.pm, but not got there yet :/
149 local *FCGI::Stream::FILENO = sub { -2 }
150 unless FCGI::Stream->can('FILENO');
152 $class->handle_request( env => \%env );
154 $proc_manager && $proc_manager->pm_post_dispatch();
158 =head2 $self->write($c, $buffer)
163 my ( $self, $c, $buffer ) = @_;
165 unless ( $self->_prepared_write ) {
166 $self->prepare_write($c);
167 $self->_prepared_write(1);
170 # XXX: We can't use Engine's write() method because syswrite
171 # appears to return bogus values instead of the number of bytes
172 # written: http://www.fastcgi.com/om_archive/mail-archive/0128.html
174 # Prepend the headers if they have not yet been sent
175 if ( $self->_has_header_buf ) {
176 $buffer = $self->_clear_header_buf . $buffer;
179 # FastCGI does not stream data properly if using 'print $handle',
180 # but a syswrite appears to work properly.
181 *STDOUT->syswrite($buffer);
184 =head2 $self->daemon_fork()
186 Performs the first part of daemon initialisation. Specifically,
187 forking. STDERR, etc are still connected to a terminal.
196 =head2 $self->daemon_detach( )
198 Performs the second part of daemon initialisation. Specifically,
199 disassociates from the terminal.
201 However, this does B<not> change the current working directory to "/",
202 as normal daemons do. It also does not close all open file
203 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
210 print "FastCGI daemon started (pid $$)\n";
211 open STDIN, "+</dev/null" or die $!;
212 open STDOUT, ">&STDIN" or die $!;
213 open STDERR, ">&STDIN" or die $!;
217 =head2 $self->_fix_env( $env )
219 Adjusts the environment variables when necessary.
228 # we are gonna add variables from current system environment %ENV to %env
229 # that contains at this moment just variables taken from FastCGI request
230 foreach my $k (keys(%ENV)) {
231 $env->{$k} = $ENV{$k} unless defined($env->{$k});
234 return unless ( $env->{SERVER_SOFTWARE} );
236 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
237 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
238 # Thanks to Mark Blythe for this fix
239 if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
240 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
242 elsif ( $env->{SERVER_SOFTWARE} =~ /^nginx/ ) {
243 my $script_name = $env->{SCRIPT_NAME};
244 $env->{PATH_INFO} =~ s/^$script_name//g;
246 # Fix the environment variables PATH_INFO and SCRIPT_NAME when running
248 elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/[6-9]\.[0-9]/ ) {
249 my @script_name = split(m!/!, $env->{PATH_INFO});
250 my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
253 while ($script_name[$#script_name] eq $path_translated[$#path_translated]) {
254 pop(@path_translated);
255 unshift(@path_info, pop(@script_name));
258 unshift(@path_info, '', '');
260 $env->{PATH_INFO} = join('/', @path_info);
261 $env->{SCRIPT_NAME} = join('/', @script_name);
268 =head1 WEB SERVER CONFIGURATIONS
270 =head2 Standalone FastCGI Server
272 In server mode the application runs as a standalone server and accepts
273 connections from a web server. The application can be on the same machine as
274 the web server, on a remote machine, or even on multiple remote machines.
275 Advantages of this method include running the Catalyst application as a
276 different user than the web server, and the ability to set up a scalable
279 To start your application in server mode, install the FCGI::ProcManager
280 module and then use the included fastcgi.pl script.
282 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
284 Command line options for fastcgi.pl include:
286 -d -daemon Daemonize the server.
287 -p -pidfile Write a pidfile with the pid of the process manager.
288 -l -listen Listen on a socket path, hostname:port, or :port.
289 -n -nproc The number of processes started to handle requests.
291 See below for the specific web server configurations for using the external
294 =head2 Apache 1.x, 2.x
296 Apache requires the mod_fastcgi module. The same module supports both
299 There are three ways to run your application under FastCGI on Apache: server,
302 =head3 Standalone server mode
304 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
305 Alias /myapp/ /tmp/myapp/myapp.fcgi/
307 # Or, run at the root
308 Alias / /tmp/myapp.fcgi/
310 # Optionally, rewrite the path when accessed without a trailing slash
311 RewriteRule ^/myapp$ myapp/ [R]
314 The FastCgiExternalServer directive tells Apache that when serving
315 /tmp/myapp to use the FastCGI application listenting on the socket
316 /tmp/mapp.socket. Note that /tmp/myapp.fcgi B<MUST NOT> exist --
317 it's a virtual file name. With some versions of C<mod_fastcgi> or
318 C<mod_fcgid>, you can use any name you like, but some require that the
319 virtual filename end in C<.fcgi>.
321 It's likely that Apache is not configured to serve files in /tmp, so the
322 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
323 FastCGI application. The trailing slashes are important as their use will
324 correctly set the PATH_INFO environment variable used by Catalyst to
325 determine the request path. If you would like to be able to access your app
326 without a trailing slash (http://server/myapp), you can use the above
327 RewriteRule directive.
331 The term 'static' is misleading, but in static mode Apache uses its own
332 FastCGI Process Manager to start the application processes. This happens at
333 Apache startup time. In this case you do not run your application's
334 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
335 FastCGI script to run your application.
337 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
338 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
340 FastCgiServer tells Apache to start three processes of your application at
341 startup. The Alias command maps a path to the FastCGI application. Again,
342 the trailing slashes are important.
346 In FastCGI dynamic mode, Apache will run your application on demand,
347 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
348 often use this type of setup to provide FastCGI support to many customers.
350 In this mode it is often enough to place or link your *_fastcgi.pl script in
351 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
352 must be able to run your application as a CGI script so ExecCGI must be
353 enabled for the directory.
355 AddHandler fastcgi-script .fcgi
357 The above tells Apache to run any .fcgi file as a FastCGI application.
359 Here is a complete example:
362 ServerName www.myapp.com
363 DocumentRoot /path/to/MyApp
365 # Allow CGI script to run
366 <Directory /path/to/MyApp>
370 # Tell Apache this is a FastCGI application
371 <Files myapp_fastcgi.pl>
372 SetHandler fastcgi-script
376 Then a request for /script/myapp_fastcgi.pl will run the
379 For more information on using FastCGI under Apache, visit
380 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
382 =head3 Authorization header with mod_fastcgi or mod_cgi
384 By default, mod_fastcgi/mod_cgi do not pass along the Authorization header,
385 so modules like C<Catalyst::Plugin::Authentication::Credential::HTTP> will
386 not work. To enable pass-through of this header, add the following
387 mod_rewrite directives:
389 RewriteCond %{HTTP:Authorization} ^(.+)
390 RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT]
394 These configurations were tested with Lighttpd 1.4.7.
396 =head3 Standalone server mode
398 server.document-root = "/var/www/MyApp/root"
403 "socket" => "/tmp/myapp.socket",
404 "check-local" => "disable"
411 server.document-root = "/var/www/MyApp/root"
416 "socket" => "/tmp/myapp.socket",
417 "check-local" => "disable",
418 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
426 Note that in newer versions of lighttpd, the min-procs and idle-timeout
427 values are disabled. The above example would start 5 processes.
429 =head3 Non-root configuration
431 You can also run your application at any non-root location with either of the
432 above modes. Note the required mod_rewrite rule.
434 url.rewrite = ( "myapp\$" => "myapp/" )
443 For more information on using FastCGI under Lighttpd, visit
444 L<http://www.lighttpd.net/documentation/fastcgi.html>
448 Catalyst runs under nginx via FastCGI in a similar fashion as the lighttpd
449 standalone server as described above.
451 nginx does not have its own internal FastCGI process manager, so you must run
452 the FastCGI service separately.
456 To configure nginx, you must configure the FastCGI parameters and also the
457 socket your FastCGI daemon is listening on. It can be either a TCP socket
458 or a Unix file socket.
460 The server configuration block should look roughly like:
466 fastcgi_param QUERY_STRING $query_string;
467 fastcgi_param REQUEST_METHOD $request_method;
468 fastcgi_param CONTENT_TYPE $content_type;
469 fastcgi_param CONTENT_LENGTH $content_length;
471 fastcgi_param PATH_INFO $fastcgi_script_name;
472 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
473 fastcgi_param REQUEST_URI $request_uri;
474 fastcgi_param DOCUMENT_URI $document_uri;
475 fastcgi_param DOCUMENT_ROOT $document_root;
476 fastcgi_param SERVER_PROTOCOL $server_protocol;
478 fastcgi_param GATEWAY_INTERFACE CGI/1.1;
479 fastcgi_param SERVER_SOFTWARE nginx/$nginx_version;
481 fastcgi_param REMOTE_ADDR $remote_addr;
482 fastcgi_param REMOTE_PORT $remote_port;
483 fastcgi_param SERVER_ADDR $server_addr;
484 fastcgi_param SERVER_PORT $server_port;
485 fastcgi_param SERVER_NAME $server_name;
487 # Adjust the socket for your applications!
488 fastcgi_pass unix:$docroot/myapp.socket;
492 It is the standard convention of nginx to include the fastcgi_params in a
493 separate file (usually something like C</etc/nginx/fastcgi_params>) and
494 simply include that file.
496 =head3 Non-root configuration
498 If you properly specify the PATH_INFO and SCRIPT_NAME parameters your
499 application will be accessible at any path. The SCRIPT_NAME variable is the
500 prefix of your application, and PATH_INFO would be everything in addition.
502 As an example, if your application is rooted at /myapp, you would configure:
504 fastcgi_param PATH_INFO /myapp/;
505 fastcgi_param SCRIPT_NAME $fastcgi_script_name;
507 C<$fastcgi_script_name> would be "/myapp/path/of/the/action". Catalyst will
508 process this accordingly and setup the application base as expected.
510 This behavior is somewhat different than Apache and Lighttpd, but is still
513 For more information on nginx, visit:
518 It is possible to run Catalyst under IIS with FastCGI, but only on IIS 6.0
519 (Microsoft Windows 2003), IIS 7.0 (Microsoft Windows 2008 and Vista) and
520 hopefully its successors.
522 Even if it is declared that FastCGI is supported on IIS 5.1 (Windows XP) it
523 does not support some features (specifically: wildcard mappings) that prevents
524 running Catalyst application.
526 Let us assume that our server has the following layout:
528 d:\WWW\WebApp\ path to our Catalyst application
529 d:\strawberry\perl\bin\perl.exe path to perl interpreter (with Catalyst installed)
530 c:\windows Windows directory
532 =head3 Setup IIS 6.0 (Windows 2003)
536 =item Install FastCGI extension for IIS 6.0
538 FastCGI is not a standard part of IIS 6 - you have to install it separately. For
539 more info and download go to L<http://www.iis.net/extensions/FastCGI>. Choose
540 approptiate version (32-bit/64-bit), installation is quite simple
541 (in fact no questions, no options).
543 =item Create a new website
545 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager".
546 Click "Action" > "New" > "Web Site". After you finish the installation wizard
547 you need to go to the new website's properties.
549 =item Set website properties
551 On tab "Web site" set proper values for:
552 Site Description, IP Address, TCP Port, SSL Port etc.
554 On tab "Home Directory" set the following:
556 Local path: "d:\WWW\WebApp\root"
557 Local path permission flags: check only "Read" + "Log visits"
558 Execute permitions: "Scripts only"
560 Click "Configuration" button (still on Home Directory tab) then click "Insert"
561 the wildcard application mapping and in the next dialog set:
563 Executable: "c:\windows\system32\inetsrv\fcgiext.dll"
564 Uncheck: "Verify that file exists"
566 Close all dialogs with "OK".
568 =item Edit fcgiext.ini
570 Put the following lines into c:\windows\system32\inetsrv\fcgiext.ini (on 64-bit
571 system c:\windows\syswow64\inetsrv\fcgiext.ini):
575 ;replace 8 with the identification number of the newly created website
576 ;it is not so easy to get this number:
577 ; - you can use utility "c:\inetpub\adminscripts\adsutil.vbs"
578 ; to list websites: "cscript adsutil.vbs ENUM /P /W3SVC"
579 ; to get site name: "cscript adsutil.vbs GET /W3SVC/<number>/ServerComment"
580 ; to get all details: "cscript adsutil.vbs GET /W3SVC/<number>"
581 ; - or look where are the logs located:
582 ; c:\WINDOWS\SYSTEM32\Logfiles\W3SVC7\whatever.log
583 ; means that the corresponding number is "7"
584 ;if you are running just one website using FastCGI you can use '*=CatalystApp'
587 ExePath=d:\strawberry\perl\bin\perl.exe
588 Arguments="d:\WWW\WebApp\script\webapp_fastcgi.pl -e"
590 ;by setting this you can instruct IIS to serve Catalyst static files
591 ;directly not via FastCGI (in case of any problems try 1)
592 IgnoreExistingFiles=0
594 ;do not be fooled by Microsoft doc talking about "IgnoreExistingDirectories"
595 ;that does not work and use "IgnoreDirectories" instead
600 =head3 Setup IIS 7.0 (Windows 2008 and Vista)
602 Microsoft IIS 7.0 has built-in support for FastCGI so you do not have to install
607 =item Necessary steps during IIS7 installation
609 During IIS7 installation after you have added role "Web Server (IIS)"
610 you need to check to install role feature "CGI" (do not be nervous that it is
611 not FastCGI). If you already have IIS7 installed you can add "CGI" role feature
612 through "Control panel" > "Programs and Features".
614 =item Create a new website
616 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager"
619 site name: "CatalystSite"
620 content directory: "d:\WWW\WebApp\root"
621 binding: set proper IP address, port etc.
623 =item Configure FastCGI
625 You can configure FastCGI extension using commandline utility
626 "c:\windows\system32\inetsrv\appcmd.exe"
630 =item Configuring section "fastCgi" (it is a global setting)
632 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
634 =item Configuring proper handler (it is a site related setting)
636 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
638 Note: before launching the commands above do not forget to change site
639 name and paths to values relevant for your server setup.
647 L<Catalyst>, L<FCGI>.
651 Catalyst Contributors, see Catalyst.pm
655 Bill Moseley, for documentation updates and testing.
659 This library is free software. You can redistribute it and/or modify it under
660 the same terms as Perl itself.