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;
116 $options->{proc_title} ||= "perl-fcgi-pm [$class]";
118 $self->daemon_fork() if $options->{detach};
120 if ( $options->{manager} ) {
121 eval "use $options->{manager}; 1" or die $@;
123 $proc_manager = $options->{manager}->new(
125 n_processes => $options->{nproc},
126 pid_fname => $options->{pidfile},
127 pm_title => $options->{proc_title},
131 # detach *before* the ProcManager inits
132 $self->daemon_detach() if $options->{detach};
134 $proc_manager->pm_manage();
136 # Give each child its own RNG state.
139 elsif ( $options->{detach} ) {
140 $self->daemon_detach();
144 while ( $request->Accept >= 0 ) {
145 $proc_manager && $proc_manager->pm_pre_dispatch();
147 $self->_fix_env( \%env );
149 $class->handle_request( env => \%env );
151 $proc_manager && $proc_manager->pm_post_dispatch();
155 =head2 $self->write($c, $buffer)
160 my ( $self, $c, $buffer ) = @_;
162 unless ( $self->_prepared_write ) {
163 $self->prepare_write($c);
164 $self->_prepared_write(1);
167 # XXX: We can't use Engine's write() method because syswrite
168 # appears to return bogus values instead of the number of bytes
169 # written: http://www.fastcgi.com/om_archive/mail-archive/0128.html
171 # Prepend the headers if they have not yet been sent
172 if ( $self->_has_header_buf ) {
173 $buffer = $self->_clear_header_buf . $buffer;
176 # FastCGI does not stream data properly if using 'print $handle',
177 # but a syswrite appears to work properly.
178 *STDOUT->syswrite($buffer);
181 =head2 $self->daemon_fork()
183 Performs the first part of daemon initialisation. Specifically,
184 forking. STDERR, etc are still connected to a terminal.
193 =head2 $self->daemon_detach( )
195 Performs the second part of daemon initialisation. Specifically,
196 disassociates from the terminal.
198 However, this does B<not> change the current working directory to "/",
199 as normal daemons do. It also does not close all open file
200 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
207 print "FastCGI daemon started (pid $$)\n";
208 open STDIN, "+</dev/null" or die $!;
209 open STDOUT, ">&STDIN" or die $!;
210 open STDERR, ">&STDIN" or die $!;
214 =head2 $self->_fix_env( $env )
216 Adjusts the environment variables when necessary.
225 # we are gonna add variables from current system environment %ENV to %env
226 # that contains at this moment just variables taken from FastCGI request
227 foreach my $k (keys(%ENV)) {
228 $env->{$k} = $ENV{$k} unless defined($env->{$k});
231 return unless ( $env->{SERVER_SOFTWARE} );
233 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
234 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
235 # Thanks to Mark Blythe for this fix
236 if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
237 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
239 elsif ( $env->{SERVER_SOFTWARE} =~ /^nginx/ ) {
240 my $script_name = $env->{SCRIPT_NAME};
241 $env->{PATH_INFO} =~ s/^$script_name//g;
243 # Fix the environment variables PATH_INFO and SCRIPT_NAME when running
245 elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/[6-9]\.[0-9]/ ) {
246 my @script_name = split(m!/!, $env->{PATH_INFO});
247 my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
250 while ($script_name[$#script_name] eq $path_translated[$#path_translated]) {
251 pop(@path_translated);
252 unshift(@path_info, pop(@script_name));
255 unshift(@path_info, '', '');
257 $env->{PATH_INFO} = join('/', @path_info);
258 $env->{SCRIPT_NAME} = join('/', @script_name);
265 =head1 WEB SERVER CONFIGURATIONS
267 =head2 Standalone FastCGI Server
269 In server mode the application runs as a standalone server and accepts
270 connections from a web server. The application can be on the same machine as
271 the web server, on a remote machine, or even on multiple remote machines.
272 Advantages of this method include running the Catalyst application as a
273 different user than the web server, and the ability to set up a scalable
276 To start your application in server mode, install the FCGI::ProcManager
277 module and then use the included fastcgi.pl script.
279 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
281 Command line options for fastcgi.pl include:
283 -d -daemon Daemonize the server.
284 -p -pidfile Write a pidfile with the pid of the process manager.
285 -l -listen Listen on a socket path, hostname:port, or :port.
286 -n -nproc The number of processes started to handle requests.
288 See below for the specific web server configurations for using the external
291 =head2 Apache 1.x, 2.x
293 Apache requires the mod_fastcgi module. The same module supports both
296 There are three ways to run your application under FastCGI on Apache: server,
299 =head3 Standalone server mode
301 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
302 Alias /myapp/ /tmp/myapp.fcgi/
304 # Or, run at the root
305 Alias / /tmp/myapp.fcgi/
307 # Optionally, rewrite the path when accessed without a trailing slash
308 RewriteRule ^/myapp$ myapp/ [R]
311 The FastCgiExternalServer directive tells Apache that when serving
312 /tmp/myapp to use the FastCGI application listenting on the socket
313 /tmp/mapp.socket. Note that /tmp/myapp.fcgi B<MUST NOT> exist --
314 it's a virtual file name. With some versions of C<mod_fastcgi> or
315 C<mod_fcgid>, you can use any name you like, but some require that the
316 virtual filename end in C<.fcgi>.
318 It's likely that Apache is not configured to serve files in /tmp, so the
319 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
320 FastCGI application. The trailing slashes are important as their use will
321 correctly set the PATH_INFO environment variable used by Catalyst to
322 determine the request path. If you would like to be able to access your app
323 without a trailing slash (http://server/myapp), you can use the above
324 RewriteRule directive.
328 The term 'static' is misleading, but in static mode Apache uses its own
329 FastCGI Process Manager to start the application processes. This happens at
330 Apache startup time. In this case you do not run your application's
331 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
332 FastCGI script to run your application.
334 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
335 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
337 FastCgiServer tells Apache to start three processes of your application at
338 startup. The Alias command maps a path to the FastCGI application. Again,
339 the trailing slashes are important.
343 In FastCGI dynamic mode, Apache will run your application on demand,
344 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
345 often use this type of setup to provide FastCGI support to many customers.
347 In this mode it is often enough to place or link your *_fastcgi.pl script in
348 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
349 must be able to run your application as a CGI script so ExecCGI must be
350 enabled for the directory.
352 AddHandler fastcgi-script .fcgi
354 The above tells Apache to run any .fcgi file as a FastCGI application.
356 Here is a complete example:
359 ServerName www.myapp.com
360 DocumentRoot /path/to/MyApp
362 # Allow CGI script to run
363 <Directory /path/to/MyApp>
367 # Tell Apache this is a FastCGI application
368 <Files myapp_fastcgi.pl>
369 SetHandler fastcgi-script
373 Then a request for /script/myapp_fastcgi.pl will run the
376 For more information on using FastCGI under Apache, visit
377 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
379 =head3 Authorization header with mod_fastcgi or mod_cgi
381 By default, mod_fastcgi/mod_cgi do not pass along the Authorization header,
382 so modules like C<Catalyst::Plugin::Authentication::Credential::HTTP> will
383 not work. To enable pass-through of this header, add the following
384 mod_rewrite directives:
386 RewriteCond %{HTTP:Authorization} ^(.+)
387 RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT]
391 These configurations were tested with Lighttpd 1.4.7.
393 =head3 Standalone server mode
395 server.document-root = "/var/www/MyApp/root"
400 "socket" => "/tmp/myapp.socket",
401 "check-local" => "disable"
408 server.document-root = "/var/www/MyApp/root"
413 "socket" => "/tmp/myapp.socket",
414 "check-local" => "disable",
415 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
423 Note that in newer versions of lighttpd, the min-procs and idle-timeout
424 values are disabled. The above example would start 5 processes.
426 =head3 Non-root configuration
428 You can also run your application at any non-root location with either of the
429 above modes. Note the required mod_rewrite rule.
431 url.rewrite = ( "myapp\$" => "myapp/" )
440 For more information on using FastCGI under Lighttpd, visit
441 L<http://www.lighttpd.net/documentation/fastcgi.html>
445 Catalyst runs under nginx via FastCGI in a similar fashion as the lighttpd
446 standalone server as described above.
448 nginx does not have its own internal FastCGI process manager, so you must run
449 the FastCGI service separately.
453 To configure nginx, you must configure the FastCGI parameters and also the
454 socket your FastCGI daemon is listening on. It can be either a TCP socket
455 or a Unix file socket.
457 The server configuration block should look roughly like:
463 fastcgi_param QUERY_STRING $query_string;
464 fastcgi_param REQUEST_METHOD $request_method;
465 fastcgi_param CONTENT_TYPE $content_type;
466 fastcgi_param CONTENT_LENGTH $content_length;
468 fastcgi_param SCRIPT_NAME /;
469 fastcgi_param PATH_INFO $fastcgi_script_name;
470 fastcgi_param REQUEST_URI $request_uri;
471 fastcgi_param DOCUMENT_URI $document_uri;
472 fastcgi_param DOCUMENT_ROOT $document_root;
473 fastcgi_param SERVER_PROTOCOL $server_protocol;
475 fastcgi_param GATEWAY_INTERFACE CGI/1.1;
476 fastcgi_param SERVER_SOFTWARE nginx/$nginx_version;
478 fastcgi_param REMOTE_ADDR $remote_addr;
479 fastcgi_param REMOTE_PORT $remote_port;
480 fastcgi_param SERVER_ADDR $server_addr;
481 fastcgi_param SERVER_PORT $server_port;
482 fastcgi_param SERVER_NAME $server_name;
484 # Adjust the socket for your applications!
485 fastcgi_pass unix:$docroot/myapp.socket;
489 It is the standard convention of nginx to include the fastcgi_params in a
490 separate file (usually something like C</etc/nginx/fastcgi_params>) and
491 simply include that file.
493 =head3 Non-root configuration
495 If you properly specify the PATH_INFO and SCRIPT_NAME parameters your
496 application will be accessible at any path. The SCRIPT_NAME variable is the
497 prefix of your application, and PATH_INFO would be everything in addition.
499 As an example, if your application is rooted at /myapp, you would configure:
501 fastcgi_param SCRIPT_NAME /myapp/;
502 fastcgi_param PATH_INFO $fastcgi_script_name;
504 C<$fastcgi_script_name> would be "/myapp/path/of/the/action". Catalyst will
505 process this accordingly and setup the application base as expected.
507 This behavior is somewhat different than Apache and Lighttpd, but is still
510 For more information on nginx, visit:
515 It is possible to run Catalyst under IIS with FastCGI, but only on IIS 6.0
516 (Microsoft Windows 2003), IIS 7.0 (Microsoft Windows 2008 and Vista) and
517 hopefully its successors.
519 Even if it is declared that FastCGI is supported on IIS 5.1 (Windows XP) it
520 does not support some features (specifically: wildcard mappings) that prevents
521 running Catalyst application.
523 Let us assume that our server has the following layout:
525 d:\WWW\WebApp\ path to our Catalyst application
526 d:\strawberry\perl\bin\perl.exe path to perl interpreter (with Catalyst installed)
527 c:\windows Windows directory
529 =head3 Setup IIS 6.0 (Windows 2003)
533 =item Install FastCGI extension for IIS 6.0
535 FastCGI is not a standard part of IIS 6 - you have to install it separately. For
536 more info and download go to L<http://www.iis.net/extensions/FastCGI>. Choose
537 approptiate version (32-bit/64-bit), installation is quite simple
538 (in fact no questions, no options).
540 =item Create a new website
542 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager".
543 Click "Action" > "New" > "Web Site". After you finish the installation wizard
544 you need to go to the new website's properties.
546 =item Set website properties
548 On tab "Web site" set proper values for:
549 Site Description, IP Address, TCP Port, SSL Port etc.
551 On tab "Home Directory" set the following:
553 Local path: "d:\WWW\WebApp\root"
554 Local path permission flags: check only "Read" + "Log visits"
555 Execute permitions: "Scripts only"
557 Click "Configuration" button (still on Home Directory tab) then click "Insert"
558 the wildcard application mapping and in the next dialog set:
560 Executable: "c:\windows\system32\inetsrv\fcgiext.dll"
561 Uncheck: "Verify that file exists"
563 Close all dialogs with "OK".
565 =item Edit fcgiext.ini
567 Put the following lines into c:\windows\system32\inetsrv\fcgiext.ini (on 64-bit
568 system c:\windows\syswow64\inetsrv\fcgiext.ini):
572 ;replace 8 with the identification number of the newly created website
573 ;it is not so easy to get this number:
574 ; - you can use utility "c:\inetpub\adminscripts\adsutil.vbs"
575 ; to list websites: "cscript adsutil.vbs ENUM /P /W3SVC"
576 ; to get site name: "cscript adsutil.vbs GET /W3SVC/<number>/ServerComment"
577 ; to get all details: "cscript adsutil.vbs GET /W3SVC/<number>"
578 ; - or look where are the logs located:
579 ; c:\WINDOWS\SYSTEM32\Logfiles\W3SVC7\whatever.log
580 ; means that the corresponding number is "7"
581 ;if you are running just one website using FastCGI you can use '*=CatalystApp'
584 ExePath=d:\strawberry\perl\bin\perl.exe
585 Arguments="d:\WWW\WebApp\script\webapp_fastcgi.pl -e"
587 ;by setting this you can instruct IIS to serve Catalyst static files
588 ;directly not via FastCGI (in case of any problems try 1)
589 IgnoreExistingFiles=0
591 ;do not be fooled by Microsoft doc talking about "IgnoreExistingDirectories"
592 ;that does not work and use "IgnoreDirectories" instead
597 =head3 Setup IIS 7.0 (Windows 2008 and Vista)
599 Microsoft IIS 7.0 has built-in support for FastCGI so you do not have to install
604 =item Necessary steps during IIS7 installation
606 During IIS7 installation after you have added role "Web Server (IIS)"
607 you need to check to install role feature "CGI" (do not be nervous that it is
608 not FastCGI). If you already have IIS7 installed you can add "CGI" role feature
609 through "Control panel" > "Programs and Features".
611 =item Create a new website
613 Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager"
616 site name: "CatalystSite"
617 content directory: "d:\WWW\WebApp\root"
618 binding: set proper IP address, port etc.
620 =item Configure FastCGI
622 You can configure FastCGI extension using commandline utility
623 "c:\windows\system32\inetsrv\appcmd.exe"
627 =item Configuring section "fastCgi" (it is a global setting)
629 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
631 =item Configuring proper handler (it is a site related setting)
633 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
635 Note: before launching the commands above do not forget to change site
636 name and paths to values relevant for your server setup.
644 L<Catalyst>, L<FCGI>.
648 Catalyst Contributors, see Catalyst.pm
652 Bill Moseley, for documentation updates and testing.
656 This library is free software. You can redistribute it and/or modify it under
657 the same terms as Perl itself.