4 * FastCGI application library: request-at-a-time
7 * Copyright (c) 1996 Open Market, Inc.
9 * See the file "LICENSE.TERMS" for information on usage and redistribution
10 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
15 static const char rcsid[] = "$Id: fcgiapp.c,v 1.6 1999/07/27 15:00:17 roberts Exp $";
19 #define DLLAPI __declspec(dllexport)
23 #include <sys/types.h>
24 #ifdef HAVE_SYS_TIME_H
28 #include "fcgi_config.h"
36 #include <memory.h> /* for memchr() */
40 #ifdef HAVE_SYS_SOCKET_H
41 #include <sys/socket.h> /* for getpeername */
43 #include <fcntl.h> /* for fcntl */
47 #include "fcgiappmisc.h"
52 * This is a workaround for one version of the HP C compiler
53 * (c89 on HP-UX 9.04, also Stratus FTX), which will dump core
54 * if given 'long double' for varargs.
56 #ifdef HAVE_VA_ARG_LONG_DOUBLE_BUG
57 #define LONG_DOUBLE double
59 #define LONG_DOUBLE long double
66 static int libInitialized = 0;
67 static char *webServerAddressList = NULL;
68 static FCGX_Request reqData;
69 static FCGX_Request *reqDataPtr = &reqData;
72 static void *Malloc(size_t size)
74 void *result = malloc(size);
75 ASSERT(size == 0 || result != NULL);
79 static char *StringCopy(char *str)
81 int strLen = strlen(str);
82 char *newString = (char *)Malloc(strLen + 1);
83 memcpy(newString, str, strLen);
84 newString[strLen] = '\000';
90 *----------------------------------------------------------------------
94 * Reads a byte from the input stream and returns it.
97 * The byte, or EOF (-1) if the end of input has been reached.
99 *----------------------------------------------------------------------
101 int FCGX_GetChar(FCGX_Stream *stream)
103 if(stream->rdNext != stream->stop)
104 return *stream->rdNext++;
105 if(stream->isClosed || !stream->isReader)
107 stream->fillBuffProc(stream);
108 stream->stopUnget = stream->rdNext;
109 if(stream->rdNext != stream->stop)
110 return *stream->rdNext++;
111 ASSERT(stream->isClosed); /* bug in fillBufProc if not */
116 *----------------------------------------------------------------------
120 * Reads up to n consecutive bytes from the input stream
121 * into the character array str. Performs no interpretation
122 * of the input bytes.
125 * Number of bytes read. If result is smaller than n,
126 * the end of input has been reached.
128 *----------------------------------------------------------------------
130 int FCGX_GetStr(char *str, int n, FCGX_Stream *stream)
138 * Fast path: n bytes are already available
140 if(n <= (stream->stop - stream->rdNext)) {
141 memcpy(str, stream->rdNext, n);
146 * General case: stream is closed or buffer fill procedure
151 if(stream->rdNext != stream->stop) {
152 m = min(n - bytesMoved, stream->stop - stream->rdNext);
153 memcpy(str, stream->rdNext, m);
160 if(stream->isClosed || !stream->isReader)
162 stream->fillBuffProc(stream);
163 stream->stopUnget = stream->rdNext;
168 *----------------------------------------------------------------------
172 * Reads up to n-1 consecutive bytes from the input stream
173 * into the character array str. Stops before n-1 bytes
174 * have been read if '\n' or EOF is read. The terminating '\n'
175 * is copied to str. After copying the last byte into str,
176 * stores a '\0' terminator.
179 * NULL if EOF is the first thing read from the input stream,
182 *----------------------------------------------------------------------
184 char *FCGX_GetLine(char *str, int n, FCGX_Stream *stream)
190 c = FCGX_GetChar(stream);
207 *----------------------------------------------------------------------
211 * Pushes back the character c onto the input stream. One
212 * character of pushback is guaranteed once a character
213 * has been read. No pushback is possible for EOF.
216 * Returns c if the pushback succeeded, EOF if not.
218 *----------------------------------------------------------------------
220 int FCGX_UnGetChar(int c, FCGX_Stream *stream) {
224 || stream->rdNext == stream->stopUnget)
232 *----------------------------------------------------------------------
236 * Returns EOF if end-of-file has been detected while reading
237 * from stream; otherwise returns 0.
239 * Note that FCGX_HasSeenEOF(s) may return 0, yet an immediately
240 * following FCGX_GetChar(s) may return EOF. This function, like
241 * the standard C stdio function feof, does not provide the
242 * ability to peek ahead.
245 * EOF if end-of-file has been detected, 0 if not.
247 *----------------------------------------------------------------------
249 int FCGX_HasSeenEOF(FCGX_Stream *stream) {
250 return (stream->isClosed) ? EOF : 0;
254 *----------------------------------------------------------------------
258 * Writes a byte to the output stream.
261 * The byte, or EOF (-1) if an error occurred.
263 *----------------------------------------------------------------------
265 int FCGX_PutChar(int c, FCGX_Stream *stream)
267 if(stream->wrNext != stream->stop)
268 return (*stream->wrNext++ = c);
269 if(stream->isClosed || stream->isReader)
271 stream->emptyBuffProc(stream, FALSE);
272 if(stream->wrNext != stream->stop)
273 return (*stream->wrNext++ = c);
274 ASSERT(stream->isClosed); /* bug in emptyBuffProc if not */
279 *----------------------------------------------------------------------
283 * Writes n consecutive bytes from the character array str
284 * into the output stream. Performs no interpretation
285 * of the output bytes.
288 * Number of bytes written (n) for normal return,
289 * EOF (-1) if an error occurred.
291 *----------------------------------------------------------------------
293 int FCGX_PutStr(const char *str, int n, FCGX_Stream *stream)
298 * Fast path: room for n bytes in the buffer
300 if(n <= (stream->stop - stream->wrNext)) {
301 memcpy(stream->wrNext, str, n);
306 * General case: stream is closed or buffer empty procedure
311 if(stream->wrNext != stream->stop) {
312 m = min(n - bytesMoved, stream->stop - stream->wrNext);
313 memcpy(stream->wrNext, str, m);
320 if(stream->isClosed || stream->isReader)
322 stream->emptyBuffProc(stream, FALSE);
327 *----------------------------------------------------------------------
331 * Writes a character string to the output stream.
334 * number of bytes written for normal return,
335 * EOF (-1) if an error occurred.
337 *----------------------------------------------------------------------
339 int FCGX_PutS(const char *str, FCGX_Stream *stream)
341 return FCGX_PutStr(str, strlen(str), stream);
345 *----------------------------------------------------------------------
349 * Performs output formatting and writes the results
350 * to the output stream.
353 * number of bytes written for normal return,
354 * EOF (-1) if an error occurred.
356 *----------------------------------------------------------------------
358 int FCGX_FPrintF(FCGX_Stream *stream, const char *format, ...)
362 va_start(ap, format);
363 result = FCGX_VFPrintF(stream, format, ap);
369 *----------------------------------------------------------------------
373 * Performs output formatting and writes the results
374 * to the output stream.
377 * number of bytes written for normal return,
378 * EOF (-1) if an error occurred.
380 *----------------------------------------------------------------------
383 #define PRINTF_BUFFLEN 100
385 * More than sufficient space for all unmodified conversions
388 #define FMT_BUFFLEN 25
390 * Max size of a format specifier is 1 + 5 + 7 + 7 + 2 + 1 + slop
392 static void CopyAndAdvance(char **destPtr, char **srcPtr, int n);
394 int FCGX_VFPrintF(FCGX_Stream *stream, const char *format, va_list arg)
396 char *f, *fStop, *percentPtr, *p, *fmtBuffPtr, *buffPtr;
397 int op, performedOp, sizeModifier, buffCount, buffLen, specifierLength;
398 int fastPath, n, auxBuffLen, buffReqd, minWidth, precision, exp;
399 char *auxBuffPtr = NULL;
401 char fmtBuff[FMT_BUFFLEN];
402 char buff[PRINTF_BUFFLEN];
407 unsigned unsignedArg;
408 unsigned long uLongArg;
409 unsigned short uShortArg;
416 LONG_DOUBLE lDoubleArg;
420 fStop = f + strlen(f);
422 percentPtr = (char *)memchr(f, '%', fStop - f);
423 if(percentPtr == NULL) percentPtr = fStop;
424 if(percentPtr != f) {
425 if(FCGX_PutStr(f, percentPtr - f, stream) < 0) goto ErrorReturn;
426 streamCount += percentPtr - f;
428 if(f == fStop) break;
432 * The following loop always executes either once or twice.
437 * Fast path: Scan optimistically, hoping that no flags,
438 * minimum field width, or precision are specified.
439 * Use the preallocated buffer, which is large enough
440 * for all fast path cases. If the conversion specifier
441 * is really more complex, run the loop a second time
442 * using the slow path.
443 * Note that fast path execution of %s bypasses the buffer
444 * and %f is not attempted on the fast path due to
445 * its large buffering requirements.
447 op = *(percentPtr + 1);
453 op = *(percentPtr + 2);
454 fmtBuff[1] = sizeModifier;
467 buffLen = PRINTF_BUFFLEN;
470 * Slow path: Scan the conversion specifier and construct
471 * a new format string, compute an upper bound on the
472 * amount of buffering that sprintf will require,
473 * and allocate a larger buffer if necessary.
476 fmtBuffPtr = &fmtBuff[1];
480 n = strspn(p, "-0+ #");
481 if(n > 5) goto ErrorReturn;
482 CopyAndAdvance(&fmtBuffPtr, &p, n);
484 * Scan minimum field width
486 n = strspn(p, "0123456789");
489 minWidth = va_arg(arg, int);
490 if(abs(minWidth) > 999999) goto ErrorReturn;
492 * The following use of strlen rather than the
493 * value returned from sprintf is because SUNOS4
494 * returns a char * instead of an int count.
496 sprintf(fmtBuffPtr, "%d", minWidth);
497 fmtBuffPtr += strlen(fmtBuffPtr);
503 minWidth = strtol(p, NULL, 10);
504 CopyAndAdvance(&fmtBuffPtr, &p, n);
512 CopyAndAdvance(&fmtBuffPtr, &p, 1);
513 n = strspn(p, "0123456789");
516 precision = va_arg(arg, int);
517 if(precision < 0) precision = 0;
518 if(precision > 999999) goto ErrorReturn;
520 * The following use of strlen rather than the
521 * value returned from sprintf is because SUNOS4
522 * returns a char * instead of an int count.
524 sprintf(fmtBuffPtr, "%d", precision);
525 fmtBuffPtr += strlen(fmtBuffPtr);
531 precision = strtol(p, NULL, 10);
532 CopyAndAdvance(&fmtBuffPtr, &p, n);
540 * Scan size modifier and conversion operation
547 CopyAndAdvance(&fmtBuffPtr, &p, 1);
554 CopyAndAdvance(&fmtBuffPtr, &p, 1);
555 ASSERT(fmtBuffPtr - fmtBuff < FMT_BUFFLEN);
557 specifierLength = p - percentPtr;
559 * Bound the required buffer size. For s and f
560 * conversions this requires examining the argument.
571 buffReqd = max(precision, 46);
574 charPtrArg = va_arg(arg, char *);
575 if(precision == -1) {
576 buffReqd = strlen(charPtrArg);
578 p = (char *)memchr(charPtrArg, '\0', precision);
580 (p == NULL) ? precision : p - charPtrArg;
584 switch(sizeModifier) {
586 doubleArg = va_arg(arg, double);
587 frexp(doubleArg, &exp);
590 lDoubleArg = va_arg(arg, LONG_DOUBLE);
591 frexp(lDoubleArg, &exp);
596 if(precision == -1) precision = 6;
597 buffReqd = precision + 3 + ((exp > 0) ? exp/3 : 0);
603 if(precision == -1) precision = 6;
604 buffReqd = precision + 8;
612 buffReqd = max(buffReqd + 10, minWidth);
614 * Allocate the buffer
616 if(buffReqd <= PRINTF_BUFFLEN) {
618 buffLen = PRINTF_BUFFLEN;
620 if(auxBuffPtr == NULL || buffReqd > auxBuffLen) {
621 if(auxBuffPtr != NULL) free(auxBuffPtr);
622 auxBuffPtr = (char *)Malloc(buffReqd);
623 auxBuffLen = buffReqd;
624 if(auxBuffPtr == NULL) goto ErrorReturn;
626 buffPtr = auxBuffPtr;
627 buffLen = auxBuffLen;
631 * This giant switch statement requires the following variables
632 * to be set up: op, sizeModifier, arg, buffPtr, fmtBuff.
633 * When fastPath == FALSE and op == 's' or 'f', the argument
634 * has been read into charPtrArg, doubleArg, or lDoubleArg.
635 * The statement produces the boolean performedOp, TRUE iff
636 * the op/sizeModifier were executed and argument consumed;
637 * if performedOp, the characters written into buffPtr[]
638 * and the character count buffCount (== EOF meaning error).
640 * The switch cases are arranged in the same order as in the
641 * description of fprintf in section 15.11 of Harbison and Steele.
647 switch(sizeModifier) {
649 intArg = va_arg(arg, int);
650 sprintf(buffPtr, fmtBuff, intArg);
651 buffCount = strlen(buffPtr);
654 longArg = va_arg(arg, long);
655 sprintf(buffPtr, fmtBuff, longArg);
656 buffCount = strlen(buffPtr);
659 shortArg = va_arg(arg, short);
660 sprintf(buffPtr, fmtBuff, shortArg);
661 buffCount = strlen(buffPtr);
671 switch(sizeModifier) {
673 unsignedArg = va_arg(arg, unsigned);
674 sprintf(buffPtr, fmtBuff, unsignedArg);
675 buffCount = strlen(buffPtr);
678 uLongArg = va_arg(arg, unsigned long);
679 sprintf(buffPtr, fmtBuff, uLongArg);
680 buffCount = strlen(buffPtr);
683 uShortArg = va_arg(arg, unsigned short);
684 sprintf(buffPtr, fmtBuff, uShortArg);
685 buffCount = strlen(buffPtr);
692 switch(sizeModifier) {
694 intArg = va_arg(arg, int);
695 sprintf(buffPtr, fmtBuff, intArg);
696 buffCount = strlen(buffPtr);
700 * XXX: Allowed by ISO C Amendment 1, but
701 * many platforms don't yet support wint_t
709 switch(sizeModifier) {
712 buffPtr = va_arg(arg, char *);
713 buffCount = strlen(buffPtr);
714 buffLen = buffCount + 1;
716 sprintf(buffPtr, fmtBuff, charPtrArg);
717 buffCount = strlen(buffPtr);
722 * XXX: Don't know how to convert a sequence
723 * of wide characters into a byte stream, or
724 * even how to predict the buffering required.
732 if(sizeModifier != ' ') goto ErrorReturn;
733 voidPtrArg = va_arg(arg, void *);
734 sprintf(buffPtr, fmtBuff, voidPtrArg);
735 buffCount = strlen(buffPtr);
738 switch(sizeModifier) {
740 intPtrArg = va_arg(arg, int *);
741 *intPtrArg = streamCount;
744 longPtrArg = va_arg(arg, long *);
745 *longPtrArg = streamCount;
748 shortPtrArg = va_arg(arg, short *);
749 *shortPtrArg = streamCount;
761 switch(sizeModifier) {
763 sprintf(buffPtr, fmtBuff, doubleArg);
764 buffCount = strlen(buffPtr);
767 sprintf(buffPtr, fmtBuff, lDoubleArg);
768 buffCount = strlen(buffPtr);
778 switch(sizeModifier) {
780 doubleArg = va_arg(arg, double);
781 sprintf(buffPtr, fmtBuff, doubleArg);
782 buffCount = strlen(buffPtr);
785 lDoubleArg = va_arg(arg, LONG_DOUBLE);
786 sprintf(buffPtr, fmtBuff, lDoubleArg);
787 buffCount = strlen(buffPtr);
794 if(sizeModifier != ' ')
805 if(performedOp) break;
806 if(!fastPath) goto ErrorReturn;
809 ASSERT(buffCount < buffLen);
811 if(FCGX_PutStr(buffPtr, buffCount, stream) < 0)
813 streamCount += buffCount;
814 } else if(buffCount < 0) {
817 f += specifierLength;
818 } /* while(f != fStop) */
823 if(auxBuffPtr != NULL) free(auxBuffPtr);
828 * Copy n characters from *srcPtr to *destPtr, then increment
829 * both *srcPtr and *destPtr by n.
831 static void CopyAndAdvance(char **destPtr, char **srcPtr, int n)
833 char *dest = *destPtr;
836 for (i = 0; i < n; i++)
843 *----------------------------------------------------------------------
847 * Flushes any buffered output.
849 * Server-push is a legitimate application of FCGX_FFlush.
850 * Otherwise, FCGX_FFlush is not very useful, since FCGX_Accept
851 * does it implicitly. FCGX_FFlush may reduce performance
852 * by increasing the total number of operating system calls
853 * the application makes.
856 * EOF (-1) if an error occurred.
858 *----------------------------------------------------------------------
860 int FCGX_FFlush(FCGX_Stream *stream)
862 if(stream->isClosed || stream->isReader)
864 stream->emptyBuffProc(stream, FALSE);
865 return (stream->isClosed) ? -1 : 0;
869 *----------------------------------------------------------------------
873 * Performs FCGX_FFlush and closes the stream.
875 * This is not a very useful operation, since FCGX_Accept
876 * does it implicitly. Closing the out stream before the
877 * err stream results in an extra write if there's nothing
878 * in the err stream, and therefore reduces performance.
881 * EOF (-1) if an error occurred.
883 *----------------------------------------------------------------------
885 int FCGX_FClose(FCGX_Stream *stream)
887 if(!stream->wasFCloseCalled) {
888 if(!stream->isReader) {
889 stream->emptyBuffProc(stream, TRUE);
891 stream->wasFCloseCalled = TRUE;
892 stream->isClosed = TRUE;
893 if(stream->isReader) {
894 stream->wrNext = stream->stop = stream->rdNext;
896 stream->rdNext = stream->stop = stream->wrNext;
899 return (stream->FCGI_errno == 0) ? 0 : EOF;
903 *----------------------------------------------------------------------
907 * An error has occurred; save the error code in the stream
908 * for diagnostic purposes and set the stream state so that
909 * reads return EOF and writes have no effect.
911 *----------------------------------------------------------------------
913 static void SetError(FCGX_Stream *stream, int FCGI_errno)
916 * Preserve only the first error.
918 if(stream->FCGI_errno == 0) {
919 stream->FCGI_errno = FCGI_errno;
920 stream->isClosed = TRUE;
925 *----------------------------------------------------------------------
929 * Return the stream error code. 0 means no error, > 0
930 * is an errno(2) error, < 0 is an FCGX_errno error.
932 *----------------------------------------------------------------------
934 int FCGX_GetError(FCGX_Stream *stream) {
935 return stream->FCGI_errno;
939 *----------------------------------------------------------------------
943 * Clear the stream error code and end-of-file indication.
945 *----------------------------------------------------------------------
947 void FCGX_ClearError(FCGX_Stream *stream) {
948 stream->FCGI_errno = 0;
950 * stream->isClosed = FALSE;
951 * XXX: should clear isClosed but work is needed to make it safe
952 * to do so. For example, if an application calls FClose, gets
953 * an I/O error on the write, calls ClearError and retries
954 * the FClose, FClose (really EmptyBuffProc) will write a second
955 * EOF record. If an application calls PutChar instead of FClose
956 * after the ClearError, the application will write more data.
957 * The stream's state must discriminate between various states
958 * of the stream that are now all lumped under isClosed.
963 *======================================================================
965 *======================================================================
969 * A vector of pointers representing the parameters received
970 * by a FastCGI application server, with the vector's length
971 * and last valid element so adding new parameters is efficient.
974 typedef struct Params {
975 FCGX_ParamArray vec; /* vector of strings */
976 int length; /* number of string vec can hold */
977 char **cur; /* current item in vec; *cur == NULL */
979 typedef Params *ParamsPtr;
982 *----------------------------------------------------------------------
986 * Creates a new Params structure.
989 * Pointer to the new structure.
991 *----------------------------------------------------------------------
993 static ParamsPtr NewParams(int length)
996 result = (Params *)Malloc(sizeof(Params));
997 result->vec = (char **)Malloc(length * sizeof(char *));
998 result->length = length;
999 result->cur = result->vec;
1000 *result->cur = NULL;
1005 *----------------------------------------------------------------------
1009 * Frees a Params structure and all the parameters it contains.
1012 * paramsPtr becomes invalid.
1014 *----------------------------------------------------------------------
1016 static void FreeParams(ParamsPtr *paramsPtrPtr)
1018 ParamsPtr paramsPtr = *paramsPtrPtr;
1020 if(paramsPtr == NULL) {
1023 for (p = paramsPtr->vec; p < paramsPtr->cur; p++) {
1026 free(paramsPtr->vec);
1028 *paramsPtrPtr = NULL;
1032 *----------------------------------------------------------------------
1036 * Add a name/value pair to a Params structure.
1042 * Parameters structure updated.
1044 *----------------------------------------------------------------------
1046 static void PutParam(ParamsPtr paramsPtr, char *nameValue)
1050 *paramsPtr->cur++ = nameValue;
1051 size = paramsPtr->cur - paramsPtr->vec;
1052 if(size >= paramsPtr->length) {
1053 paramsPtr->length *= 2;
1054 paramsPtr->vec = (FCGX_ParamArray)realloc(paramsPtr->vec, paramsPtr->length * sizeof(char *));
1055 paramsPtr->cur = paramsPtr->vec + size;
1057 *paramsPtr->cur = NULL;
1061 *----------------------------------------------------------------------
1063 * FCGX_GetParam -- obtain value of FCGI parameter in environment
1067 * Value bound to name, NULL if name not present in the
1068 * environment envp. Caller must not mutate the result
1069 * or retain it past the end of this request.
1071 *----------------------------------------------------------------------
1073 char *FCGX_GetParam(const char *name, FCGX_ParamArray envp)
1078 if(len == 0) return NULL;
1079 for (p = envp; *p != NULL; p++) {
1080 if((strncmp(name, *p, len) == 0) && ((*p)[len] == '=')) {
1088 *----------------------------------------------------------------------
1090 * Start of FastCGI-specific code
1092 *----------------------------------------------------------------------
1096 *----------------------------------------------------------------------
1100 * Reads FastCGI name-value pairs from stream until EOF. Converts
1101 * each pair to name=value format and adds it to Params structure.
1103 *----------------------------------------------------------------------
1105 static int ReadParams(Params *paramsPtr, FCGX_Stream *stream)
1107 int nameLen, valueLen;
1108 unsigned char lenBuff[3];
1111 while((nameLen = FCGX_GetChar(stream)) != EOF) {
1113 * Read name length (one or four bytes) and value length
1114 * (one or four bytes) from stream.
1116 if((nameLen & 0x80) != 0) {
1117 if(FCGX_GetStr((char *) &lenBuff[0], 3, stream) != 3) {
1118 SetError(stream, FCGX_PARAMS_ERROR);
1121 nameLen = ((nameLen & 0x7f) << 24) + (lenBuff[0] << 16)
1122 + (lenBuff[1] << 8) + lenBuff[2];
1124 if((valueLen = FCGX_GetChar(stream)) == EOF) {
1125 SetError(stream, FCGX_PARAMS_ERROR);
1128 if((valueLen & 0x80) != 0) {
1129 if(FCGX_GetStr((char *) &lenBuff[0], 3, stream) != 3) {
1130 SetError(stream, FCGX_PARAMS_ERROR);
1133 valueLen = ((valueLen & 0x7f) << 24) + (lenBuff[0] << 16)
1134 + (lenBuff[1] << 8) + lenBuff[2];
1137 * nameLen and valueLen are now valid; read the name and value
1138 * from stream and construct a standard environment entry.
1140 nameValue = (char *)Malloc(nameLen + valueLen + 2);
1141 if(FCGX_GetStr(nameValue, nameLen, stream) != nameLen) {
1142 SetError(stream, FCGX_PARAMS_ERROR);
1146 *(nameValue + nameLen) = '=';
1147 if(FCGX_GetStr(nameValue + nameLen + 1, valueLen, stream)
1149 SetError(stream, FCGX_PARAMS_ERROR);
1153 *(nameValue + nameLen + valueLen + 1) = '\0';
1154 PutParam(paramsPtr, nameValue);
1160 *----------------------------------------------------------------------
1164 * Constructs an FCGI_Header struct.
1166 *----------------------------------------------------------------------
1168 static FCGI_Header MakeHeader(
1175 ASSERT(contentLength >= 0 && contentLength <= FCGI_MAX_LENGTH);
1176 ASSERT(paddingLength >= 0 && paddingLength <= 0xff);
1177 header.version = FCGI_VERSION_1;
1179 header.requestIdB1 = (requestId >> 8) & 0xff;
1180 header.requestIdB0 = (requestId ) & 0xff;
1181 header.contentLengthB1 = (contentLength >> 8) & 0xff;
1182 header.contentLengthB0 = (contentLength ) & 0xff;
1183 header.paddingLength = paddingLength;
1184 header.reserved = 0;
1189 *----------------------------------------------------------------------
1191 * MakeEndRequestBody --
1193 * Constructs an FCGI_EndRequestBody struct.
1195 *----------------------------------------------------------------------
1197 static FCGI_EndRequestBody MakeEndRequestBody(
1201 FCGI_EndRequestBody body;
1202 body.appStatusB3 = (appStatus >> 24) & 0xff;
1203 body.appStatusB2 = (appStatus >> 16) & 0xff;
1204 body.appStatusB1 = (appStatus >> 8) & 0xff;
1205 body.appStatusB0 = (appStatus ) & 0xff;
1206 body.protocolStatus = protocolStatus;
1207 memset(body.reserved, 0, sizeof(body.reserved));
1212 *----------------------------------------------------------------------
1214 * MakeUnknownTypeBody --
1216 * Constructs an FCGI_MakeUnknownTypeBody struct.
1218 *----------------------------------------------------------------------
1220 static FCGI_UnknownTypeBody MakeUnknownTypeBody(
1223 FCGI_UnknownTypeBody body;
1225 memset(body.reserved, 0, sizeof(body.reserved));
1230 *----------------------------------------------------------------------
1234 * Returns the smallest integer greater than or equal to n
1235 * that's a multiple of 8.
1237 *----------------------------------------------------------------------
1239 static int AlignInt8(unsigned n) {
1240 return (n + 7) & (UINT_MAX - 7);
1244 *----------------------------------------------------------------------
1248 * Returns the smallest pointer greater than or equal to p
1249 * that's a multiple of 8.
1251 *----------------------------------------------------------------------
1253 static unsigned char *AlignPtr8(unsigned char *p) {
1254 unsigned long u = (unsigned long) p;
1255 u = ((u + 7) & (ULONG_MAX - 7)) - u;
1261 * State associated with a stream
1263 typedef struct FCGX_Stream_Data {
1264 unsigned char *buff; /* buffer after alignment */
1265 int bufflen; /* number of bytes buff can store */
1266 unsigned char *mBuff; /* buffer as returned by Malloc */
1267 unsigned char *buffStop; /* reader: last valid byte + 1 of entire buffer.
1268 * stop generally differs from buffStop for
1269 * readers because of record structure.
1270 * writer: buff + bufflen */
1271 int type; /* reader: FCGI_PARAMS or FCGI_STDIN
1272 * writer: FCGI_STDOUT or FCGI_STDERR */
1273 int eorStop; /* reader: stop stream at end-of-record */
1274 int skip; /* reader: don't deliver content bytes */
1275 int contentLen; /* reader: bytes of unread content */
1276 int paddingLen; /* reader: bytes of unread padding */
1277 int isAnythingWritten; /* writer: data has been written to ipcFd */
1278 int rawWrite; /* writer: write data without stream headers */
1279 FCGX_Request *reqDataPtr; /* request data not specific to one stream */
1283 *----------------------------------------------------------------------
1285 * WriteCloseRecords --
1287 * Writes an EOF record for the stream content if necessary.
1288 * If this is the last writer to close, writes an FCGI_END_REQUEST
1291 *----------------------------------------------------------------------
1293 static void WriteCloseRecords(struct FCGX_Stream *stream)
1295 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1297 * Enter rawWrite mode so final records won't be encapsulated as
1300 data->rawWrite = TRUE;
1302 * Generate EOF for stream content if needed.
1304 if(!(data->type == FCGI_STDERR
1305 && stream->wrNext == data->buff
1306 && !data->isAnythingWritten)) {
1308 header = MakeHeader(data->type, data->reqDataPtr->requestId, 0, 0);
1309 FCGX_PutStr((char *) &header, sizeof(header), stream);
1312 * Generate FCGI_END_REQUEST record if needed.
1314 if(data->reqDataPtr->nWriters == 1) {
1315 FCGI_EndRequestRecord endRequestRecord;
1316 endRequestRecord.header = MakeHeader(FCGI_END_REQUEST,
1317 data->reqDataPtr->requestId,
1318 sizeof(endRequestRecord.body), 0);
1319 endRequestRecord.body = MakeEndRequestBody(
1320 data->reqDataPtr->appStatus, FCGI_REQUEST_COMPLETE);
1321 FCGX_PutStr((char *) &endRequestRecord,
1322 sizeof(endRequestRecord), stream);
1324 data->reqDataPtr->nWriters--;
1329 static int write_it_all(int fd, char *buf, int len)
1334 wrote = OS_Write(fd, buf, len);
1344 *----------------------------------------------------------------------
1348 * Encapsulates any buffered stream content in a FastCGI
1349 * record. Writes the data, making the buffer empty.
1351 *----------------------------------------------------------------------
1353 static void EmptyBuffProc(struct FCGX_Stream *stream, int doClose)
1355 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1358 * If the buffer contains stream data, fill in the header.
1359 * Pad the record to a multiple of 8 bytes in length. Padding
1360 * can't overflow the buffer because the buffer is a multiple
1361 * of 8 bytes in length. If the buffer contains no stream
1362 * data, reclaim the space reserved for the header.
1364 if(!data->rawWrite) {
1365 cLen = stream->wrNext - data->buff - sizeof(FCGI_Header);
1367 eLen = AlignInt8(cLen);
1369 * Giving the padding a well-defined value keeps Purify happy.
1371 memset(stream->wrNext, 0, eLen - cLen);
1372 stream->wrNext += eLen - cLen;
1373 *((FCGI_Header *) data->buff)
1374 = MakeHeader(data->type,
1375 data->reqDataPtr->requestId, cLen, eLen - cLen);
1377 stream->wrNext = data->buff;
1381 WriteCloseRecords(stream);
1383 if (stream->wrNext != data->buff) {
1384 data->isAnythingWritten = TRUE;
1385 if (write_it_all(data->reqDataPtr->ipcFd, (char *)data->buff, stream->wrNext - data->buff) < 0) {
1386 SetError(stream, OS_Errno);
1389 stream->wrNext = data->buff;
1392 * The buffer is empty.
1394 if(!data->rawWrite) {
1395 stream->wrNext += sizeof(FCGI_Header);
1400 * Return codes for Process* functions
1402 #define STREAM_RECORD 0
1404 #define BEGIN_RECORD 2
1405 #define MGMT_RECORD 3
1408 *----------------------------------------------------------------------
1410 * ProcessManagementRecord --
1412 * Reads and responds to a management record. The only type of
1413 * management record this library understands is FCGI_GET_VALUES.
1414 * The only variables that this library's FCGI_GET_VALUES
1415 * understands are FCGI_MAX_CONNS, FCGI_MAX_REQS, and FCGI_MPXS_CONNS.
1416 * Ignore other FCGI_GET_VALUES variables; respond to other
1417 * management records with a FCGI_UNKNOWN_TYPE record.
1419 *----------------------------------------------------------------------
1421 static int ProcessManagementRecord(int type, FCGX_Stream *stream)
1423 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1424 ParamsPtr paramsPtr = NewParams(3);
1426 char response[64]; /* 64 = 8 + 3*(1+1+14+1)* + padding */
1427 char *responseP = &response[FCGI_HEADER_LEN];
1430 if(type == FCGI_GET_VALUES) {
1431 ReadParams(paramsPtr, stream);
1432 if((FCGX_GetError(stream) != 0) || (data->contentLen != 0)) {
1433 FreeParams(¶msPtr);
1434 return FCGX_PROTOCOL_ERROR;
1436 for (pPtr = paramsPtr->vec; pPtr < paramsPtr->cur; pPtr++) {
1438 *(strchr(name, '=')) = '\0';
1439 if(strcmp(name, FCGI_MAX_CONNS) == 0) {
1441 } else if(strcmp(name, FCGI_MAX_REQS) == 0) {
1443 } else if(strcmp(name, FCGI_MPXS_CONNS) == 0) {
1450 sprintf(responseP, "%c%c%s%c", len, 1, name, value);
1451 responseP += len + 3;
1454 len = responseP - &response[FCGI_HEADER_LEN];
1455 paddedLen = AlignInt8(len);
1456 *((FCGI_Header *) response)
1457 = MakeHeader(FCGI_GET_VALUES_RESULT, FCGI_NULL_REQUEST_ID,
1458 len, paddedLen - len);
1459 FreeParams(¶msPtr);
1461 paddedLen = len = sizeof(FCGI_UnknownTypeBody);
1462 ((FCGI_UnknownTypeRecord *) response)->header
1463 = MakeHeader(FCGI_UNKNOWN_TYPE, FCGI_NULL_REQUEST_ID,
1465 ((FCGI_UnknownTypeRecord *) response)->body
1466 = MakeUnknownTypeBody(type);
1468 if (write_it_all(data->reqDataPtr->ipcFd, response, FCGI_HEADER_LEN + paddedLen) < 0) {
1469 SetError(stream, OS_Errno);
1477 *----------------------------------------------------------------------
1479 * ProcessBeginRecord --
1481 * Reads an FCGI_BEGIN_REQUEST record.
1484 * BEGIN_RECORD for normal return. FCGX_PROTOCOL_ERROR for
1485 * protocol error. SKIP for attempt to multiplex
1486 * connection. -1 for error from write (errno in stream).
1489 * In case of BEGIN_RECORD return, stores requestId, role,
1490 * keepConnection values, and sets isBeginProcessed = TRUE.
1492 *----------------------------------------------------------------------
1494 static int ProcessBeginRecord(int requestId, FCGX_Stream *stream)
1496 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1497 FCGI_BeginRequestBody body;
1498 if(requestId == 0 || data->contentLen != sizeof(body)) {
1499 return FCGX_PROTOCOL_ERROR;
1501 if(data->reqDataPtr->isBeginProcessed) {
1503 * The Web server is multiplexing the connection. This library
1504 * doesn't know how to handle multiplexing, so respond with
1505 * FCGI_END_REQUEST{protocolStatus = FCGI_CANT_MPX_CONN}
1507 FCGI_EndRequestRecord endRequestRecord;
1508 endRequestRecord.header = MakeHeader(FCGI_END_REQUEST,
1509 requestId, sizeof(endRequestRecord.body), 0);
1510 endRequestRecord.body
1511 = MakeEndRequestBody(0, FCGI_CANT_MPX_CONN);
1512 if (write_it_all(data->reqDataPtr->ipcFd, (char *)&endRequestRecord, sizeof(endRequestRecord)) < 0) {
1513 SetError(stream, OS_Errno);
1520 * Accept this new request. Read the record body.
1522 data->reqDataPtr->requestId = requestId;
1523 if(FCGX_GetStr((char *) &body, sizeof(body), stream)
1525 return FCGX_PROTOCOL_ERROR;
1527 data->reqDataPtr->keepConnection = (body.flags & FCGI_KEEP_CONN);
1528 data->reqDataPtr->role = (body.roleB1 << 8) + body.roleB0;
1529 data->reqDataPtr->isBeginProcessed = TRUE;
1530 return BEGIN_RECORD;
1534 *----------------------------------------------------------------------
1538 * Interprets FCGI_Header. Processes FCGI_BEGIN_REQUEST and
1539 * management records here; extracts information from stream
1540 * records (FCGI_PARAMS, FCGI_STDIN) into stream.
1543 * >= 0 for a normal return, < 0 for error
1546 * XXX: Many (more than there used to be).
1547 * If !stream->isRequestIdSet, ProcessHeader initializes
1548 * stream->requestId from header and sets stream->isRequestIdSet
1549 * to TRUE. ProcessHeader also sets stream->contentLen to header's
1550 * contentLength, and sets stream->paddingLen to the header's
1553 *----------------------------------------------------------------------
1555 static int ProcessHeader(FCGI_Header header, FCGX_Stream *stream)
1557 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1559 if(header.version != FCGI_VERSION_1) {
1560 return FCGX_UNSUPPORTED_VERSION;
1562 requestId = (header.requestIdB1 << 8)
1563 + header.requestIdB0;
1564 data->contentLen = (header.contentLengthB1 << 8)
1565 + header.contentLengthB0;
1566 data->paddingLen = header.paddingLength;
1567 if(header.type == FCGI_BEGIN_REQUEST) {
1568 return ProcessBeginRecord(requestId, stream);
1570 if(requestId == FCGI_NULL_REQUEST_ID) {
1571 return ProcessManagementRecord(header.type, stream);
1573 if(requestId != data->reqDataPtr->requestId) {
1576 if(header.type != data->type) {
1577 return FCGX_PROTOCOL_ERROR;
1579 return STREAM_RECORD;
1583 *----------------------------------------------------------------------
1587 * Reads bytes from the ipcFd, supplies bytes to a stream client.
1589 *----------------------------------------------------------------------
1591 static void FillBuffProc(FCGX_Stream *stream)
1593 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1600 * If data->buff is empty, do a read.
1602 if(stream->rdNext == data->buffStop) {
1603 count = OS_Read(data->reqDataPtr->ipcFd, (char *)data->buff,
1606 SetError(stream, (count == 0 ? FCGX_PROTOCOL_ERROR : OS_Errno));
1609 stream->rdNext = data->buff;
1610 data->buffStop = data->buff + count;
1613 * Now data->buff is not empty. If the current record contains
1614 * more content bytes, deliver all that are present in data->buff.
1616 if(data->contentLen > 0) {
1617 count = min(data->contentLen, data->buffStop - stream->rdNext);
1618 data->contentLen -= count;
1620 stream->wrNext = stream->stop = stream->rdNext + count;
1623 stream->rdNext += count;
1624 if(data->contentLen > 0) {
1632 * If the current record (whose content has been fully consumed by
1633 * the client) was padded, skip over the padding bytes.
1635 if(data->paddingLen > 0) {
1636 count = min(data->paddingLen, data->buffStop - stream->rdNext);
1637 data->paddingLen -= count;
1638 stream->rdNext += count;
1639 if(data->paddingLen > 0) {
1644 * All done with the current record, including the padding.
1645 * If we're in a recursive call from ProcessHeader, deliver EOF.
1648 stream->stop = stream->rdNext;
1649 stream->isClosed = TRUE;
1653 * Fill header with bytes from the input buffer.
1655 count = min((int)sizeof(header) - headerLen,
1656 data->buffStop - stream->rdNext);
1657 memcpy(((char *)(&header)) + headerLen, stream->rdNext, count);
1659 stream->rdNext += count;
1660 if(headerLen < sizeof(header)) {
1665 * Interpret header. eorStop prevents ProcessHeader from reading
1666 * past the end-of-record when using stream to read content.
1668 data->eorStop = TRUE;
1669 stream->stop = stream->rdNext;
1670 status = ProcessHeader(header, stream);
1671 data->eorStop = FALSE;
1672 stream->isClosed = FALSE;
1676 * If this stream record header marked the end of stream
1677 * data deliver EOF to the stream client, otherwise loop
1680 * XXX: If this is final stream and
1681 * stream->rdNext != data->buffStop, buffered
1682 * data is next request (server pipelining)?
1684 if(data->contentLen == 0) {
1685 stream->wrNext = stream->stop = stream->rdNext;
1686 stream->isClosed = TRUE;
1695 * If this header marked the beginning of a new
1696 * request, return role information to caller.
1704 SetError(stream, status);
1712 *----------------------------------------------------------------------
1716 * Creates a stream to read or write from an open ipcFd.
1717 * The stream performs reads/writes of up to bufflen bytes.
1719 *----------------------------------------------------------------------
1721 static FCGX_Stream *NewStream(
1722 FCGX_Request *reqDataPtr, int bufflen, int isReader, int streamType)
1725 * XXX: It would be a lot cleaner to have a NewStream that only
1726 * knows about the type FCGX_Stream, with all other
1727 * necessary data passed in. It appears that not just
1728 * data and the two procs are needed for initializing stream,
1729 * but also data->buff and data->buffStop. This has implications
1730 * for procs that want to swap buffers, too.
1732 FCGX_Stream *stream = (FCGX_Stream *)Malloc(sizeof(FCGX_Stream));
1733 FCGX_Stream_Data *data = (FCGX_Stream_Data *)Malloc(sizeof(FCGX_Stream_Data));
1734 data->reqDataPtr = reqDataPtr;
1735 bufflen = AlignInt8(min(max(bufflen, 32), FCGI_MAX_LENGTH + 1));
1736 data->bufflen = bufflen;
1737 data->mBuff = (unsigned char *)Malloc(bufflen);
1738 data->buff = AlignPtr8(data->mBuff);
1739 if(data->buff != data->mBuff) {
1743 data->buffStop = data->buff;
1745 data->buffStop = data->buff + data->bufflen;
1747 data->type = streamType;
1748 data->eorStop = FALSE;
1750 data->contentLen = 0;
1751 data->paddingLen = 0;
1752 data->isAnythingWritten = FALSE;
1753 data->rawWrite = FALSE;
1755 stream->data = data;
1756 stream->isReader = isReader;
1757 stream->isClosed = FALSE;
1758 stream->wasFCloseCalled = FALSE;
1759 stream->FCGI_errno = 0;
1761 stream->fillBuffProc = FillBuffProc;
1762 stream->emptyBuffProc = NULL;
1763 stream->rdNext = data->buff;
1764 stream->stop = stream->rdNext;
1765 stream->stopUnget = data->buff;
1766 stream->wrNext = stream->stop;
1768 stream->fillBuffProc = NULL;
1769 stream->emptyBuffProc = EmptyBuffProc;
1770 stream->wrNext = data->buff + sizeof(FCGI_Header);
1771 stream->stop = data->buffStop;
1772 stream->stopUnget = NULL;
1773 stream->rdNext = stream->stop;
1779 *----------------------------------------------------------------------
1783 * Frees all storage allocated when *streamPtr was created,
1784 * and nulls out *streamPtr.
1786 *----------------------------------------------------------------------
1788 void FreeStream(FCGX_Stream **streamPtr)
1790 FCGX_Stream *stream = *streamPtr;
1791 FCGX_Stream_Data *data;
1792 if(stream == NULL) {
1795 data = (FCGX_Stream_Data *)stream->data;
1796 data->reqDataPtr = NULL;
1804 *----------------------------------------------------------------------
1808 * Re-initializes the stream to read data of the specified type.
1810 *----------------------------------------------------------------------
1812 static FCGX_Stream *SetReaderType(FCGX_Stream *stream, int streamType)
1814 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1815 ASSERT(stream->isReader);
1816 data->type = streamType;
1817 data->eorStop = FALSE;
1819 data->contentLen = 0;
1820 data->paddingLen = 0;
1821 stream->wrNext = stream->stop = stream->rdNext;
1822 stream->isClosed = FALSE;
1827 *----------------------------------------------------------------------
1831 * Creates a stream to read streamType records for the given
1832 * request. The stream performs OS reads of up to bufflen bytes.
1834 *----------------------------------------------------------------------
1836 static FCGX_Stream *NewReader(FCGX_Request *reqDataPtr, int bufflen, int streamType)
1838 return NewStream(reqDataPtr, bufflen, TRUE, streamType);
1843 *----------------------------------------------------------------------
1847 * Creates a stream to write streamType FastCGI records, using
1848 * the ipcFd and RequestId contained in *reqDataPtr.
1849 * The stream performs OS writes of up to bufflen bytes.
1851 *----------------------------------------------------------------------
1853 static FCGX_Stream *NewWriter(FCGX_Request *reqDataPtr, int bufflen, int streamType)
1855 return NewStream(reqDataPtr, bufflen, FALSE, streamType);
1860 *----------------------------------------------------------------------
1864 * Creates a stream to write streamType FastCGI records, using
1865 * the given ipcFd and request Id. This function is provided
1866 * for use by cgi-fcgi. In order to be defensive against misuse,
1867 * this function leaks a little storage; cgi-fcgi doesn't care.
1869 *----------------------------------------------------------------------
1871 FCGX_Stream *CreateWriter(
1877 FCGX_Request *reqDataPtr = (FCGX_Request *)Malloc(sizeof(FCGX_Request));
1878 reqDataPtr->ipcFd = ipcFd;
1879 reqDataPtr->requestId = requestId;
1881 * Suppress writing an FCGI_END_REQUEST record.
1883 reqDataPtr->nWriters = 2;
1884 return NewWriter(reqDataPtr, bufflen, streamType);
1888 *======================================================================
1890 *======================================================================
1894 *----------------------------------------------------------------------
1898 * This routine determines if the process is running as a CGI or
1899 * FastCGI process. The distinction is made by determining whether
1900 * FCGI_LISTENSOCK_FILENO is a listener ipcFd or the end of a
1901 * pipe (ie. standard in).
1904 * TRUE if the process is a CGI process, FALSE if FastCGI.
1907 * If this is a FastCGI process there's a chance that a connection
1908 * will be accepted while performing the test. If this occurs,
1909 * the connection is saved and used later by the FCGX_Accept logic.
1911 *----------------------------------------------------------------------
1913 int FCGX_IsCGI(void)
1915 static int isFastCGI = -1;
1917 if (isFastCGI != -1) {
1921 if (!libInitialized) {
1922 int rc = FCGX_Init();
1924 /* exit() isn't great, but hey */
1925 exit((rc < 0) ? rc : -rc);
1929 isFastCGI = OS_IsFcgi();
1935 *----------------------------------------------------------------------
1939 * Finishes the current request from the HTTP server.
1943 * Finishes the request accepted by (and frees any
1944 * storage allocated by) the previous call to FCGX_Accept.
1946 * DO NOT retain pointers to the envp array or any strings
1947 * contained in it (e.g. to the result of calling FCGX_GetParam),
1948 * since these will be freed by the next call to FCGX_Finish
1951 *----------------------------------------------------------------------
1954 void FCGX_Finish(void)
1956 FCGX_Finish_r(reqDataPtr);
1960 *----------------------------------------------------------------------
1964 * Finishes the current request from the HTTP server.
1968 * Finishes the request accepted by (and frees any
1969 * storage allocated by) the previous call to FCGX_Accept.
1971 * DO NOT retain pointers to the envp array or any strings
1972 * contained in it (e.g. to the result of calling FCGX_GetParam),
1973 * since these will be freed by the next call to FCGX_Finish
1976 *----------------------------------------------------------------------
1978 void FCGX_Finish_r(FCGX_Request *reqDataPtr)
1980 if (reqDataPtr == NULL) {
1984 if (reqDataPtr->inStream) {
1985 int errStatus = FCGX_FClose(reqDataPtr->errStream);
1986 int outStatus = FCGX_FClose(reqDataPtr->outStream);
1988 if (errStatus || outStatus
1989 || FCGX_GetError(reqDataPtr->inStream)
1990 || !reqDataPtr->keepConnection)
1992 OS_IpcClose(reqDataPtr->ipcFd);
1995 ASSERT(reqDataPtr->nWriters == 0);
1997 FreeStream(&reqDataPtr->inStream);
1998 FreeStream(&reqDataPtr->outStream);
1999 FreeStream(&reqDataPtr->errStream);
2001 FreeParams(&reqDataPtr->paramsPtr);
2004 if (!reqDataPtr->keepConnection) {
2005 reqDataPtr->ipcFd = -1;
2010 void FCGX_InitRequest(FCGX_Request *request)
2012 memset(request, 0, sizeof(FCGX_Request));
2016 *----------------------------------------------------------------------
2020 * Initilize the FCGX library. This is called by FCGX_Accept()
2021 * but must be called by the user when using FCGX_Accept_r().
2024 * 0 for successful call.
2026 *----------------------------------------------------------------------
2032 if (libInitialized) {
2036 /* If our compiler doesn't play by the ISO rules for struct layout, halt. */
2037 ASSERT(sizeof(FCGI_Header) == FCGI_HEADER_LEN);
2039 FCGX_InitRequest(&reqData);
2041 if (OS_LibInit(NULL) == -1) {
2042 return OS_Errno ? OS_Errno : -9997;
2045 p = getenv("FCGI_WEB_SERVER_ADDRS");
2046 webServerAddressList = p ? StringCopy(p) : "";
2053 *----------------------------------------------------------------------
2057 * Accepts a new request from the HTTP server.
2060 * 0 for successful call, -1 for error.
2064 * Finishes the request accepted by (and frees any
2065 * storage allocated by) the previous call to FCGX_Accept.
2066 * Creates input, output, and error streams and
2067 * assigns them to *in, *out, and *err respectively.
2068 * Creates a parameters data structure to be accessed
2069 * via getenv(3) (if assigned to environ) or by FCGX_GetParam
2070 * and assigns it to *envp.
2072 * DO NOT retain pointers to the envp array or any strings
2073 * contained in it (e.g. to the result of calling FCGX_GetParam),
2074 * since these will be freed by the next call to FCGX_Finish
2077 *----------------------------------------------------------------------
2084 FCGX_ParamArray *envp)
2086 if (!libInitialized) {
2087 int rc = FCGX_Init();
2089 return (rc < 0) ? rc : -rc;
2093 return FCGX_Accept_r(in, out, err, envp, &reqData);
2097 *----------------------------------------------------------------------
2101 * Accepts a new request from the HTTP server.
2104 * 0 for successful call, -1 for error.
2108 * Finishes the request accepted by (and frees any
2109 * storage allocated by) the previous call to FCGX_Accept.
2110 * Creates input, output, and error streams and
2111 * assigns them to *in, *out, and *err respectively.
2112 * Creates a parameters data structure to be accessed
2113 * via getenv(3) (if assigned to environ) or by FCGX_GetParam
2114 * and assigns it to *envp.
2116 * DO NOT retain pointers to the envp array or any strings
2117 * contained in it (e.g. to the result of calling FCGX_GetParam),
2118 * since these will be freed by the next call to FCGX_Finish
2121 *----------------------------------------------------------------------
2127 FCGX_ParamArray *envp,
2128 FCGX_Request *reqDataPtr)
2130 if (!libInitialized) {
2134 /* Finish the current request, if any. */
2135 FCGX_Finish_r(reqDataPtr);
2139 * If a connection isn't open, accept a new connection (blocking).
2140 * If an OS error occurs in accepting the connection,
2141 * return -1 to the caller, who should exit.
2143 if (reqDataPtr->ipcFd < 0) {
2144 reqDataPtr->ipcFd = OS_FcgiIpcAccept(webServerAddressList);
2145 if (reqDataPtr->ipcFd < 0) {
2146 return (errno > 0) ? (0 - errno) : -9999;
2150 * A connection is open. Read from the connection in order to
2151 * get the request's role and environment. If protocol or other
2152 * errors occur, close the connection and try again.
2154 reqDataPtr->isBeginProcessed = FALSE;
2155 reqDataPtr->inStream = NewReader(reqDataPtr, 8192, 0);
2156 FillBuffProc(reqDataPtr->inStream);
2157 if(!reqDataPtr->isBeginProcessed) {
2162 switch(reqDataPtr->role) {
2163 case FCGI_RESPONDER:
2164 roleStr = "FCGI_ROLE=RESPONDER";
2166 case FCGI_AUTHORIZER:
2167 roleStr = "FCGI_ROLE=AUTHORIZER";
2170 roleStr = "FCGI_ROLE=FILTER";
2175 reqDataPtr->paramsPtr = NewParams(30);
2176 PutParam(reqDataPtr->paramsPtr, StringCopy(roleStr));
2178 SetReaderType(reqDataPtr->inStream, FCGI_PARAMS);
2179 if(ReadParams(reqDataPtr->paramsPtr, reqDataPtr->inStream) >= 0) {
2181 * Finished reading the environment. No errors occurred, so
2182 * leave the connection-retry loop.
2187 * Close the connection and try again.
2190 FreeParams(&reqDataPtr->paramsPtr);
2191 FreeStream(&reqDataPtr->inStream);
2192 OS_Close(reqDataPtr->ipcFd);
2193 reqDataPtr->ipcFd = -1;
2196 * Build the remaining data structures representing the new
2197 * request and return successfully to the caller.
2199 SetReaderType(reqDataPtr->inStream, FCGI_STDIN);
2200 reqDataPtr->outStream = NewWriter(reqDataPtr, 8192, FCGI_STDOUT);
2201 reqDataPtr->errStream = NewWriter(reqDataPtr, 512, FCGI_STDERR);
2202 reqDataPtr->nWriters = 2;
2203 *in = reqDataPtr->inStream;
2204 *out = reqDataPtr->outStream;
2205 *err = reqDataPtr->errStream;
2206 *envp = reqDataPtr->paramsPtr->vec;
2211 *----------------------------------------------------------------------
2213 * FCGX_StartFilterData --
2215 * stream is an input stream for a FCGI_FILTER request.
2216 * stream is positioned at EOF on FCGI_STDIN.
2217 * Repositions stream to the start of FCGI_DATA.
2218 * If the preconditions are not met (e.g. FCGI_STDIN has not
2219 * been read to EOF) sets the stream error code to
2220 * FCGX_CALL_SEQ_ERROR.
2223 * 0 for a normal return, < 0 for error
2225 *----------------------------------------------------------------------
2228 int FCGX_StartFilterData(FCGX_Stream *stream)
2230 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
2231 if(data->reqDataPtr->role != FCGI_FILTER
2232 || !stream->isReader
2233 || !stream->isClosed
2234 || data->type != FCGI_STDIN) {
2235 SetError(stream, FCGX_CALL_SEQ_ERROR);
2238 SetReaderType(reqDataPtr->inStream, FCGI_DATA);
2243 *----------------------------------------------------------------------
2245 * FCGX_SetExitStatus --
2247 * Sets the exit status for stream's request. The exit status
2248 * is the status code the request would have exited with, had
2249 * the request been run as a CGI program. You can call
2250 * SetExitStatus several times during a request; the last call
2251 * before the request ends determines the value.
2253 *----------------------------------------------------------------------
2256 void FCGX_SetExitStatus(int status, FCGX_Stream *stream)
2258 FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
2259 data->reqDataPtr->appStatus = status;