Command line options

  -c <config_path> Full path to the directory of configuration file, the
fcgi_spawn.conf ( See 'Configuration File' below );
  -p <pid_file>    Full path and name of the process ID file name;
  -l <log_file>    Full path and name  of the log file name;
  -u <user>        Name of the system user to run the FastCGI applications;
  -g <group>       Name of the system group to run the FastCGI applications;
  -s <socket>      Name of the local UNIX socket to be created by the daemon to
listen for incoming connections. You should try :number or address:number or
host:number as a value of this option in teh case the TCP connectivity is
wanted;

Those are optional:

  -e               Redefine the exit() Perl builtin function to prevent the
spawned persistent processes from exiting and starting again when your
application(s) exit;
  -pl              Evaluate the:

Preload Scripts from the configuration directory

Preload scripts are to be located in the configuraion directory with the names "preload_nonprepared_XX.pl" and "preload_prepared_XX.pl", respectively. The "XX" here means a number of the execution sequence, as you may wish to "use SomeModule" on the followed of scripts and have its functionality on the scripts following after those. The difference between non- and prepared scripts is: the multi-processing occurs to happen in between of them ( "prepare" in FCGI::Spawn ). That means that the 'nonprepared' scripts are the best place to pre-load your applications' modules, but the handles like the data files, sockets, database handles, etc. can exist only per single process and therefore should be established in the 'prepared' scripts.

Predefined symbols for preload scripts are:

$spawn

the FCGI::Spawn object.

It is useful to do the trick like this for your CGI app:

        $FCGI::Spawn::fcgi = new CGI;
        $spawn->callout( '/path/to/your/CGI/app.pl', $FCGI::Spawn::fcgi );
        undef $FCGI::Spawn::fcgi;
    

( "CGI.pm.patch" supplied in the source package is required for this to work best. ) This loads the most of your application's code into memory in the 'nonprepared' script before the daemon to fork() which is the main to know about what the FCGI::Spawn's prepare is.

CALLED_OUT

the label to go to with the exit() Perl builtin redefined ( '-e' command line parameter ).

Should be contained in the code reference supplied as a callout property of the $spawn, the "FCGI::Spawn object". This is to keep the exit()'ed CGI application from exiting the FastCGI connection "accept()" loop before "max_requests" processed. The code use this label like this:

        $spawn->{ callout } =  sub{ do shift;
        CALLED_OUT: eval ' $Bugzilla::_request_cache = { }; '
          if defined( $Bugzilla::_request_cache ) and scalar keys %{ $Bugzilla::_request_cache };
        };
    

$OURS

Hash reference to keep scalar variables in between preload eval()s. Those are to be restored in preload scripts like this:

                                map{ ${ $main::{ $_ } }
                                                = $OURS->{  $_ } ;
                                } qw/webguiRoot bugzillaRoot skybillRoot/;
    

All of the preload scripts, if any exist, are eval()'ed after the $spawn is initialized with the values from:

Configuration File

Syntax is: spaces and tabs at the begin of the line are ignored, the "#" symbol before the rest means this line is ignored as a comment too, key and value are separated with the space(s) or tab(s) all on the same line, and if the value is multiple ( same way separated ) values, it is treated as an array reference ( wanted for "sock_chown" parameter ).

Sample configuration file, "fcgi_spawn.conf.sample", is provided in the source distribution.

WebGUI.org

Skybill

Bugzilla

Many exit()s on the blocks

Requires the exit() to be redefined with "-e" command line switch for "fcgi_spawn", and the "CALLED_OUT" label to be crafted like it is already described here.

CGI.pm ancesting

Requires the both patches to be applied, on "CGI.pm" amd "Bugzilla/CGI.pm" .

Request caching

Bugzilla's own request cache cleans only if the mod_perl is used specifically. Same about the "CALLED_OUT" here.

Environment cleaning

As an evil of Date::Manip ( I myself hate it too, since the "DateTime.pm" infrastructure is much better ), and thus the WebGUI.org too, the Bugzilla can make your system commands unavailable from your applications on your PATH environment variable. This is why you should also enable the "save_env" feature on "fcgi_spawn.conf", if it is not enabled in FCGI::Spawn by default.

Also, in some cases the Bugzilla's CGI programs use to take $0 instead of $ENV{ SCRIPT_NAME } which makes the URLs generated pointless.

Demo is located at: