Contained WithinFind More DocumentationFeatured Support Resources |  PDF로 이 문서 다운로드 (2845 KB)
Appendix B FastCGI Plug-inIntroductionFastCGI is an enhancement to the existing CGI (Common Gateway Interface), which is a standard for interfacing external applications with Web Servers. Like CGI, FastCGI applications run in separate, isolated processes. Some of the advantages of using FastCGI are as follows:
FastCGI plug-in allows Web Server to safely work with popular third-party dynamic content generation technologies (such as Perl and Python) in a scalable way. For more information on FastCGI, refer to the specification at http://www.fastcgi.com/devkit/doc/fcgi-spec.html. Plug-in Functions (SAFs)FastCGI plug-in provides the following Server Application Functions (SAFs): The various parameters and "error-reason" strings for the FastCGI SAFs are described in the following sections: auth-fastcgiauth-fastcgi is a PatchCheck function. This function is used to forward the request to an “Authorizer” FastCGI application. On successful authorization, a return code of 200 is sent. Otherwise, the response from the “Authorizer” FastCGI application is sent back to the user agent. More information on the FastCGI Roles can be found here http://www.fastcgi.com/devkit/doc/fcgi-spec.html#S6. The parameters accepted by auth-fastcgi SAF, are available at: FastCGI SAF Parameters. The following obj.conf code example demonstrates the use of auth-fastcgi: PathCheck fn="auth-fastcgi" app-path="/usr/bin/perl" app-args="/fastcgi/apps/auth/SimpleAuth.pl" bind-path="localhost:3432". responder-fastcgiThe responder-fastcgi is a Service function. This function is used to forward the request to a FastCGI application that acts as a “Responder”. The response from the Responder application is sent back to the user agent. More information on the FastCGI Roles can be found at http://www.fastcgi.com/devkit/doc/fcgi-spec.html#S6. The list of parameters accepted by responder-fastcgi SAF, are available at:FastCGI SAF Parameters . The following obj.conf code example demonstrates the use of responder-fastcgi: Service fn="responder-fastcgi" app-path="/fastcgi-enabled-php-installation/bin/php" bind-path="localhost:3433" app-env="PHP_FCGI_CHILDREN=8" app-env="PHP_FCGI_MAX_REQUEST=500". filter-fastcgiThe filter-fastcgi is a Service function. This function is used to forward the request to a “Filter” type of FastCGI application. The “Filter” application receives the information associated with the HTTP request and also the data from the file stored on the server. The “Filter” application then generates a “filtered” version of the data stream as the response. This is sent back to the user agent. More information on the FastCGI Roles can be found at http://www.fastcgi.com/devkit/doc/fcgi-spec.html#S6. The list of parameters accepted by filter-fastcgi SAF, are available at:FastCGI SAF Parameters . The following obj.conf code example demonstrates the use of filter-fastcgi: Service fn="filter-fastcgi" app-path="/fastcgi/apps/filter/SimpleFilter" bind-path="localhost:3434" app-env="LD_LIBRARY_PATH=/fastcgi/fcgi-2.4/libfcgi/.libs" min-procs=2 error-fastcgiThe error-fastcgi is an Error function. The error-fastcgi SAF handles the errors specific to the FastCGI plug-in. This function however does not handle the HTTP errors. On error, FastCGI plug-in can be configured to display a specific page or redirect the request to a specific URL. The list of parameters accepted by error-fastcgi SAF, are available at: FastCGI SAF Parameters. The following obj.conf snippet demonstrates the use of error-fastcgi: Error fn="error-fastcgi" error-reason="Invalid Parameters" error-url="http://www.foo.com/errorPage.html" See FastCGI SAF Parameters for information on the error-fastcgi parameters. FastCGI SAF ParametersThe FastCGI plug-in SAFs, "auth-fastcgi“ , “responder-fastcgi” and “filter-fastcgi”, all accept the following parameters unless otherwise mentioned explicitly: Note that parameters chroot, user, group and nice are applicable to only UNIX platforms. On Windows platforms, these parameters are ignored.
The error-fastcgi Server Application Function (SAF) accepts the following parameters:
error-fastcgi SAF Error Reason StringsThis section provides a list of all the valid "error-reason" strings and their descriptions:
Configuring FastCGI Plug-in on Web ServerFastCGI plug-in is bundled with Web Server 7.0. The plug-in is installed at the following location:
The following FastCGI binaries are installed :
The FastCGI plug-in is configured using the Web Server configuration files located under <instance-dir>/config directory. To configure the FastCGI plug-in, perform the following steps: Modify the magnus.confUse “load-modules” Init function to load the FastCGI plug-in shared library. Init fn=flex-init access="access" format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] \"%Req->reqpb.clf-request%\" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%" Init fn="load-modules" shlib="libJava EEplugin.so" shlib_flags="(global|now)" Init fn="load-modules" shlib="libfastcgi.so" shlib_flags="(global|now)" Modify the MIME Type (Optional)Edit the mime.types file to specify the MIME mapping. Modifying the MIME type mapping is an optional step. For Example, #--Sun Microsystems Inc. MIME Information # Do not delete the above line. It is used to identify the file type. # # Copyright 2006 Sun Microsystems, Inc. All rights reserved. # Use is subject to license terms. # type=application/octet-stream exts=bin type=application/astound exts=asd,asn ... ... type=magnus-internal/fastcgi exts=php ... ... Modify the obj.confEdit obj.conf file to configure FastCGI specific requests using the plug-in SAFs described in the earlier sections. An example of modified obj.conf file is shown below: # # Copyright 2006 Sun Microsystems, Inc. All rights reserved. # Use is subject to license terms. # # You can edit this file, but comments and formatting changes # might be lost when you use the administration GUI or CLI. <object name = "default"> AuthTrans fn="match-browser" browser="*MSIE*" ssl-unclean-shutdown="true" NameTrans fn="ntrans-Java EE" name="Java EE" NameTrans fn="pfx2dir" from="/mc-icons" dir="/ws7/lib/icons" name="es-internal" NameTrans fn="assign-name" from="/fcgi/*" name="fcgi.config" </object> <Object name="fcgi.config"> AuthTrans fn="auth-fastcgi" app-path="/fastcgi/apps/c/simpleAuth" bind-path="localhost:2111" Service fn="responder-fastcgi" app-path="/fastcgi_enabled_php_installation_dir/bin/php" app-env="name1=abc" </object> ... Note that FastCGI SAFs can be invoked in different ways by defining different objects for different URL patterns or mapping the SAFs to different MIME types. For more information on obj.conf configuration and syntax, refer to the Administration Configuration File Reference Guide. Troubleshooting FastCGI Plug-inFastcgistub is a process manager that manages the lifecycle of the FastCGI application processes. Fastcgistub logs its messages into Fastcgistub.log file under Web Server's temporary directory. In case of any errors, checking this file can help in debugging the problem. Problem: FastCGI requests are not getting served Possible cause and solutions are as follows:
If any library dependency errors are thrown, specify the LD_LIBRARY_PATH in the obj.conf as app-env parameter with LD_LIBRARY_PATH=<dependency library paths> value . Problem: FastCGI application is not getting started. Possible cause and solutions are as follows:
.. <pid> process startup failure, trying to restart ... Even after trying <n> time(s), <application path> process failed to start...no more retries One of the reasons for startup failures can be due to the failure to load the dependent library. This issue can be resolved by specifying the appropriate library path(s) as a app-env parameter value to the FastCGI application configured in the obj.conf file. For example:
Developing FastCGI ApplicationsFastCGI applications can be developed using Perl, PHP, C and Java. The following sections briefly describe the procedure to develop the application using some of the popular programming languages.
|
Executing a FastCGI Application
./configure <other-options> --enable-fastcgi gmake |
After compilation, the php binary will be FastCGI enabled.
When using PHP versions 5.1.2 or earlier (including PHP 4.x) the FastCGI plug-in should be configured with bind-path in host:port format. For example, bind-path = “localhost:3333”.
For PHP versions 5.1.3 and later, the bind-path is optional. If specified, it should not be in “host:port” format. It can be a string. For example, bind-path = “myphpbindpath”.
Using C/Java
FastCGI development kit provides APIs to write FastCGI C/Java applications. You can download the kit from http://www.fastcgi.com/devkit/doc/fcgi-devel-kit.htm.
To build the downloaded FastCGI development kit, perform the following steps:
-
Unpack the tar file. This action creates a new directory called fcgi-devel-kit
-
Execute this sequence of commands in the fcgi-devel-kit directory:
-
./configure
-
make
-
For more information on writing FastCGI applications using C, see http://www.fastcgi.com/devkit/doc/fcgi-devel-kit.htm#S3
For more information on writing FastCGI applications using Java, see http://www.fastcgi.com/devkit/doc/fcgi-java.htm
Sample FastCGI Applications
This section contains sample FastCGI applications written using PHP, Perl and C.
Responder application in PHP (ListDir.php)
<?php
$dir = "/tmp/";
// Open a known directory, and proceed to read its contents
if (is_dir($dir)) {
if ($dh = opendir($dir)) {
while (($file = readdir($dh)) !== false) {
echo "filename: $file : filetype: " . filetype($dir . $file) . "\n";
}
closedir($dh);
}
}
?>
obj.conf snippet for the above example:
<Object name="default"> NameTrans fn="assign-name" from="/fcgi/*" name="responder.fcgi" </Object> <Object name="responder.fcgi"> Service fn="responder-fastcgi" app-path="/foo/fastcgi-enabled-php-installation/bin/php" bind-path="localhost:3431" min-procs=3 </Object>
Authorizer application in Perl (SimpleAuth.pl)
#!/usr/bin/perl
use FCGI;
while (FCGI::accept >= 0) {
if( $ENV{'HTTP_AUTHORIZATION'} ) {
# This value can be further decoded to get the actual username and password and then
# perform some kind of user validation. This program only checks for the presence of
# of this environment param and is not really bothered about its value
print( "Status: 200\r\n" );
print( "\r\n" );
} else {
print( "Status: 401\r\n" );
print( "WWW-Authenticate: basic realm=\"foo\"\r\n" );
print( "\r\n" );
}
}
Example obj.conf settings for the above example:
obj.conf snippet for the above example:
<Object name="responder.fcgi"> AuthTrans fn="auth-fastcgi" app-path="/fastcgi/apps/auth/SimpleAuth.pl" bind-path="localhost:3432" Service fn="responder-fastcgi" app-path="/foo/fastcgi-enabled-php-installation/bin/php" bind-path="localhost:3433" app-env="PHP_FCGI_CHILDREN=8" min-procs=1 </Object>
On first request to http://localhost/fcgi/php/ListDir.php, the authentication dialogue box is displayed by the browser. After the user enters the username and password, the contents of "/tmp" directory gets listed.
Filter application in C (SimpleFilter.c)
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <fcgi_stdio.h>
void main(void) {
size_t PageSize = 1024 * 3;
char *page;
FCGX_Stream *in, *out, *err;
FCGX_ParamArray envp;
int count=0;
page = (char *)malloc(PageSize);
if (page == NULL) {
printf("Content-type: text/x-server-parsed-html\r\n");
printf("<title>malloc failure</title>");
printf("<h1>Cannot allocate memory to run filter. exiting</h1>");
printf("\r\n\r\n");
exit(2);
}
while(FCGI_Accept() >= 0) {
char *tmp;
char *execcgi;
char *dataLenStr = NULL;
int numchars = 0;
int stdinDataSize = 0;
int filterDataLen = 0;
int dataToBeRead = 0;
int x = 0;
int loopCount = 0;
count++;
dataLenStr = getenv("FCGI_DATA_LENGTH");
if(dataLenStr)
filterDataLen = atoi(dataLenStr);
/* clear out stdin */
while (EOF != getc(stdin)) {
stdinDataSize++;
}
dataToBeRead = filterDataLen;
FCGI_StartFilterData();
tmp = page; /** just in case fread or fwrite moves our pointer **/
//start responding
printf("Content-type: text/plain\r\n");
printf("\r\n"); /** send a new line at the beginning **/
printf("<title>SIMPLE FILTER</title>");
printf(<h1>This page was Filtered by SimpleFilter FastCGI filter</h1>");
printf("file size=%d<br>", filterDatalen);
printf("stdin size=%d<br>, stdinDataSize);
while(dataToBeRead > 0 ) {
x = 0;
page = tmp;
if(dataToBeRead > PageSize)
x = PageSize;
else
x = dataToBeRead;
numchars = fread((void *)(page), 1, x, stdin);
if( numchars == 0 )
continue;
/** at this point your data is in page pointer, so do
whatever you want
with it before sending it back to the server.
In this example, no data is manipulated. Only the count of number of
times the filter data is read and the total bytes read
at the end of every
loop is printed. **/
dataToBeRead -= numchars;
loopCount++;
printf("loop count = %d ... so far read %d bytes <br>", loopCount,
(filterDatalen - dataToBeRead));
}
printf("\r\n\r\n"); /** send a new line at the end of transfer **/
fflush(stdout);
page = tmp; /** restore page pointer **/
memset(page,NULL,numchars);
}
free(page);
}
Example obj.conf settings for the above example.
If this FastCGI application is available on the same machine as where the Web Server is running, then
<Object name=<"filter.fcgi">
Service fn="filter-fastcgi" app-path="/fastcgi/apps/filter/SimpleFilter.exe"
bind-path="localhost:3434" app-env="LD_LIBRARY_PATH=/fastcgi/fcgi-2.4/libfcgi/.libs"
</Object>
If the application is running on a remote machine, then the following lines of code must be included in the obj.conf file:
<Object name="filter.fcgi"> Service fn="filter-fastcgi" bind-path="<remote-host>:<remote-port>" </Object>
If "FilterThisFile" of size "26868" bytes located under fcgi directory under the Web Server instance's docroot directory, is the file to be filtered, a request to "http://localhost/fcgi/filter/FilterThisFile", produces the following output:
This page was Filtered by SimpleFilter FastCGI filter
|
file size = 26868 |
|
stdin size = 0 |
|
loop count = 1... so far read 3072 bytes |
|
loop count = 2... so far read 6144 bytes |
|
loop count = 3... so far read 9216 bytes |
|
loop count = 4... so far read 12288 bytes |
|
loop count = 5... so far read 15360 bytes |
|
loop count = 6... so far read 18432 bytes |
|
loop count = 7... so far read 21504 bytes |
|
loop count = 8... so far read 24576 bytes |
|
loop count = 9... so far read 26868 bytes |