afab264ccd78b16f35ad6e88b8f941de4623ffc5
[catagits/fcgi2.git] / libfcgi / fcgiapp.c
1 /*
2  * fcgiapp.c --
3  *
4  *      FastCGI application library: request-at-a-time
5  *
6  *
7  * Copyright (c) 1996 Open Market, Inc.
8  *
9  * See the file "LICENSE.TERMS" for information on usage and redistribution
10  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
11  *
12  */
13
14 #ifndef lint
15 static const char rcsid[] = "$Id: fcgiapp.c,v 1.6 1999/07/27 15:00:17 roberts Exp $";
16 #endif /* not lint */
17
18 #ifdef _WIN32
19 #define DLLAPI  __declspec(dllexport)
20 #endif
21
22 #include <stdio.h>
23 #include <sys/types.h>
24 #ifdef HAVE_SYS_TIME_H
25 #include <sys/time.h>
26 #endif
27
28 #include "fcgi_config.h"
29 #ifdef HAVE_UNISTD_H
30 #include <unistd.h>
31 #endif
32
33 #include <assert.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <memory.h>     /* for memchr() */
37 #include <errno.h>
38 #include <stdarg.h>
39 #include <math.h>
40 #ifdef HAVE_SYS_SOCKET_H
41 #include <sys/socket.h> /* for getpeername */
42 #endif
43 #include <fcntl.h>      /* for fcntl */
44
45 #include "fcgimisc.h"
46 #include "fcgiapp.h"
47 #include "fcgiappmisc.h"
48 #include "fastcgi.h"
49 #include "fcgios.h"
50
51 /*
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.
55  */
56 #ifdef HAVE_VA_ARG_LONG_DOUBLE_BUG
57 #define LONG_DOUBLE double
58 #else
59 #define LONG_DOUBLE long double
60 #endif
61
62
63 /*
64  * Globals
65  */
66 static int libInitialized = 0;
67 static char *webServerAddressList = NULL;
68 static FCGX_Request reqData;
69 static FCGX_Request *reqDataPtr = &reqData;
70
71
72 static void *Malloc(size_t size)
73 {
74     void *result = malloc(size);
75     ASSERT(size == 0 || result != NULL);
76     return result;
77 }
78
79 static char *StringCopy(char *str)
80 {
81     int strLen = strlen(str);
82     char *newString = (char *)Malloc(strLen + 1);
83     memcpy(newString, str, strLen);
84     newString[strLen] = '\000';
85     return newString;
86 }
87
88 \f
89 /*
90  *----------------------------------------------------------------------
91  *
92  * FCGX_GetChar --
93  *
94  *      Reads a byte from the input stream and returns it.
95  *
96  * Results:
97  *      The byte, or EOF (-1) if the end of input has been reached.
98  *
99  *----------------------------------------------------------------------
100  */
101 int FCGX_GetChar(FCGX_Stream *stream)
102 {
103     if(stream->rdNext != stream->stop)
104         return *stream->rdNext++;
105     if(stream->isClosed || !stream->isReader)
106         return EOF;
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 */
112     return EOF;
113 }
114 \f
115 /*
116  *----------------------------------------------------------------------
117  *
118  * FCGX_GetStr --
119  *
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.
123  *
124  * Results:
125  *      Number of bytes read.  If result is smaller than n,
126  *      the end of input has been reached.
127  *
128  *----------------------------------------------------------------------
129  */
130 int FCGX_GetStr(char *str, int n, FCGX_Stream *stream)
131 {
132     int m, bytesMoved;
133
134     if(n <= 0) {
135         return 0;
136     }
137     /*
138      * Fast path: n bytes are already available
139      */
140     if(n <= (stream->stop - stream->rdNext)) {
141         memcpy(str, stream->rdNext, n);
142         stream->rdNext += n;
143         return n;
144     }
145     /*
146      * General case: stream is closed or buffer fill procedure
147      * needs to be called
148      */
149     bytesMoved = 0;
150     for (;;) {
151         if(stream->rdNext != stream->stop) {
152             m = min(n - bytesMoved, stream->stop - stream->rdNext);
153             memcpy(str, stream->rdNext, m);
154             bytesMoved += m;
155             stream->rdNext += m;
156             if(bytesMoved == n)
157                 return bytesMoved;
158             str += m;
159         }
160         if(stream->isClosed || !stream->isReader)
161             return bytesMoved;
162         stream->fillBuffProc(stream);
163         stream->stopUnget = stream->rdNext;
164     }
165 }
166 \f
167 /*
168  *----------------------------------------------------------------------
169  *
170  * FCGX_GetLine --
171  *
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.
177  *
178  * Results:
179  *      NULL if EOF is the first thing read from the input stream,
180  *      str otherwise.
181  *
182  *----------------------------------------------------------------------
183  */
184 char *FCGX_GetLine(char *str, int n, FCGX_Stream *stream)
185 {
186     int c;
187     char *p = str;
188     n--;
189     while (n > 0) {
190         c = FCGX_GetChar(stream);
191         if(c == EOF) {
192             if(p == str)
193                 return NULL;
194             else
195                 break;
196         }
197         *p++ = c;
198         n--;
199         if(c == '\n')
200             break;
201     }
202     *p = '\0';
203     return str;
204 }
205 \f
206 /*
207  *----------------------------------------------------------------------
208  *
209  * FCGX_UnGetChar --
210  *
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.
214  *
215  * Results:
216  *      Returns c if the pushback succeeded, EOF if not.
217  *
218  *----------------------------------------------------------------------
219  */
220 int FCGX_UnGetChar(int c, FCGX_Stream *stream) {
221     if(c == EOF
222             || stream->isClosed
223             || !stream->isReader
224             || stream->rdNext == stream->stopUnget)
225         return EOF;
226     --(stream->rdNext);
227     *stream->rdNext = c;
228     return c;
229 }
230
231 /*
232  *----------------------------------------------------------------------
233  *
234  * FCGX_HasSeenEOF --
235  *
236  *      Returns EOF if end-of-file has been detected while reading
237  *      from stream; otherwise returns 0.
238  *
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.
243  *
244  * Results:
245  *      EOF if end-of-file has been detected, 0 if not.
246  *
247  *----------------------------------------------------------------------
248  */
249 int FCGX_HasSeenEOF(FCGX_Stream *stream) {
250     return (stream->isClosed) ? EOF : 0;
251 }
252 \f
253 /*
254  *----------------------------------------------------------------------
255  *
256  * FCGX_PutChar --
257  *
258  *      Writes a byte to the output stream.
259  *
260  * Results:
261  *      The byte, or EOF (-1) if an error occurred.
262  *
263  *----------------------------------------------------------------------
264  */
265 int FCGX_PutChar(int c, FCGX_Stream *stream)
266 {
267     if(stream->wrNext != stream->stop)
268         return (*stream->wrNext++ = c);
269     if(stream->isClosed || stream->isReader)
270         return EOF;
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 */
275     return EOF;
276 }
277 \f
278 /*
279  *----------------------------------------------------------------------
280  *
281  * FCGX_PutStr --
282  *
283  *      Writes n consecutive bytes from the character array str
284  *      into the output stream.  Performs no interpretation
285  *      of the output bytes.
286  *
287  * Results:
288  *      Number of bytes written (n) for normal return,
289  *      EOF (-1) if an error occurred.
290  *
291  *----------------------------------------------------------------------
292  */
293 int FCGX_PutStr(const char *str, int n, FCGX_Stream *stream)
294 {
295     int m, bytesMoved;
296
297     /*
298      * Fast path: room for n bytes in the buffer
299      */
300     if(n <= (stream->stop - stream->wrNext)) {
301         memcpy(stream->wrNext, str, n);
302         stream->wrNext += n;
303         return n;
304     }
305     /*
306      * General case: stream is closed or buffer empty procedure
307      * needs to be called
308      */
309     bytesMoved = 0;
310     for (;;) {
311         if(stream->wrNext != stream->stop) {
312             m = min(n - bytesMoved, stream->stop - stream->wrNext);
313             memcpy(stream->wrNext, str, m);
314             bytesMoved += m;
315             stream->wrNext += m;
316             if(bytesMoved == n)
317                 return bytesMoved;
318             str += m;
319         }
320         if(stream->isClosed || stream->isReader)
321             return -1;
322         stream->emptyBuffProc(stream, FALSE);
323     }
324 }
325 \f
326 /*
327  *----------------------------------------------------------------------
328  *
329  * FCGX_PutS --
330  *
331  *      Writes a character string to the output stream.
332  *
333  * Results:
334  *      number of bytes written for normal return,
335  *      EOF (-1) if an error occurred.
336  *
337  *----------------------------------------------------------------------
338  */
339 int FCGX_PutS(const char *str, FCGX_Stream *stream)
340 {
341     return FCGX_PutStr(str, strlen(str), stream);
342 }
343 \f
344 /*
345  *----------------------------------------------------------------------
346  *
347  * FCGX_FPrintF --
348  *
349  *      Performs output formatting and writes the results
350  *      to the output stream.
351  *
352  * Results:
353  *      number of bytes written for normal return,
354  *      EOF (-1) if an error occurred.
355  *
356  *----------------------------------------------------------------------
357  */
358 int FCGX_FPrintF(FCGX_Stream *stream, const char *format, ...)
359 {
360     int result;
361     va_list ap;
362     va_start(ap, format);
363     result = FCGX_VFPrintF(stream, format, ap);
364     va_end(ap);
365     return result;
366 }
367
368 /*
369  *----------------------------------------------------------------------
370  *
371  * FCGX_VFPrintF --
372  *
373  *      Performs output formatting and writes the results
374  *      to the output stream.
375  *
376  * Results:
377  *      number of bytes written for normal return,
378  *      EOF (-1) if an error occurred.
379  *
380  *----------------------------------------------------------------------
381  */
382
383 #define PRINTF_BUFFLEN 100
384     /*
385      * More than sufficient space for all unmodified conversions
386      * except %s and %f.
387      */
388 #define FMT_BUFFLEN 25
389     /*
390      * Max size of a format specifier is 1 + 5 + 7 + 7 + 2 + 1 + slop
391      */
392 static void CopyAndAdvance(char **destPtr, char **srcPtr, int n);
393
394 int FCGX_VFPrintF(FCGX_Stream *stream, const char *format, va_list arg)
395 {
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;
400     int streamCount = 0;
401     char fmtBuff[FMT_BUFFLEN];
402     char buff[PRINTF_BUFFLEN];
403
404     int intArg;
405     short shortArg;
406     long longArg;
407     unsigned unsignedArg;
408     unsigned long uLongArg;
409     unsigned short uShortArg;
410     char *charPtrArg;
411     void *voidPtrArg;
412     int *intPtrArg;
413     long *longPtrArg;
414     short *shortPtrArg;
415     double doubleArg;
416     LONG_DOUBLE lDoubleArg;
417
418     fmtBuff[0] = '%';
419     f = (char *) format;
420     fStop = f + strlen(f);
421     while (f != fStop) {
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;
427             f = percentPtr;
428             if(f == fStop) break;
429         }
430         fastPath = TRUE;
431         /*
432          * The following loop always executes either once or twice.
433          */
434         for (;;) {
435             if(fastPath) {
436                 /*
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.
446                  */
447                 op = *(percentPtr + 1);
448                 switch(op) {
449                     case 'l':
450                     case 'L':
451                     case 'h':
452                         sizeModifier = op;
453                         op = *(percentPtr + 2);
454                         fmtBuff[1] = sizeModifier;
455                         fmtBuff[2] = op;
456                         fmtBuff[3] = '\0';
457                         specifierLength = 3;
458                         break;
459                     default:
460                         sizeModifier = ' ';
461                         fmtBuff[1] = op;
462                         fmtBuff[2] = '\0';
463                         specifierLength = 2;
464                         break;
465                 }
466                 buffPtr = buff;
467                 buffLen = PRINTF_BUFFLEN;
468             } else {
469                 /*
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.
474                  */
475                 p = percentPtr + 1;
476                 fmtBuffPtr = &fmtBuff[1];
477                 /*
478                  * Scan flags
479                  */
480                 n = strspn(p, "-0+ #");
481                 if(n > 5) goto ErrorReturn;
482                 CopyAndAdvance(&fmtBuffPtr, &p, n);
483                 /*
484                  * Scan minimum field width
485                  */
486                 n = strspn(p, "0123456789");
487                 if(n == 0) {
488                     if(*p == '*') {
489                         minWidth = va_arg(arg, int);
490                         if(abs(minWidth) > 999999) goto ErrorReturn;
491                         /*
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.
495                          */
496                         sprintf(fmtBuffPtr, "%d", minWidth);
497                         fmtBuffPtr += strlen(fmtBuffPtr);
498                         p++;
499                     } else {
500                         minWidth = 0;
501                     }
502                 } else if(n <= 6) {
503                     minWidth = strtol(p, NULL, 10);
504                     CopyAndAdvance(&fmtBuffPtr, &p, n);
505                 } else {
506                     goto ErrorReturn;
507                 }
508                 /*
509                  * Scan precision
510                  */
511                 if(*p == '.') {
512                     CopyAndAdvance(&fmtBuffPtr, &p, 1);
513                     n = strspn(p, "0123456789");
514                     if(n == 0) {
515                         if(*p == '*') {
516                             precision = va_arg(arg, int);
517                             if(precision < 0) precision = 0;
518                             if(precision > 999999) goto ErrorReturn;
519                         /*
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.
523                          */
524                             sprintf(fmtBuffPtr, "%d", precision);
525                             fmtBuffPtr += strlen(fmtBuffPtr);
526                             p++;
527                         } else {
528                             precision = 0;
529                         }
530                     } else if(n <= 6) {
531                         precision = strtol(p, NULL, 10);
532                         CopyAndAdvance(&fmtBuffPtr, &p, n);
533                     } else {
534                         goto ErrorReturn;
535                     }
536                 } else {
537                     precision = -1;
538                 }
539                 /*
540                  * Scan size modifier and conversion operation
541                  */
542                 switch(*p) {
543                     case 'l':
544                     case 'L':
545                     case 'h':
546                         sizeModifier = *p;
547                         CopyAndAdvance(&fmtBuffPtr, &p, 1);
548                         break;
549                     default:
550                         sizeModifier = ' ';
551                         break;
552                 }
553                 op = *p;
554                 CopyAndAdvance(&fmtBuffPtr, &p, 1);
555                 ASSERT(fmtBuffPtr - fmtBuff < FMT_BUFFLEN);
556                 *fmtBuffPtr = '\0';
557                 specifierLength = p - percentPtr;
558                 /*
559                  * Bound the required buffer size.  For s and f
560                  * conversions this requires examining the argument.
561                  */
562                 switch(op) {
563                     case 'd':
564                     case 'i':
565                     case 'u':
566                     case 'o':
567                     case 'x':
568                     case 'X':
569                     case 'c':
570                     case 'p':
571                         buffReqd = max(precision, 46);
572                         break;
573                     case 's':
574                         charPtrArg = va_arg(arg, char *);
575                         if(precision == -1) {
576                             buffReqd = strlen(charPtrArg);
577                         } else {
578                             p = (char *)memchr(charPtrArg, '\0', precision);
579                             buffReqd =
580                               (p == NULL) ? precision : p - charPtrArg;
581                         }
582                         break;
583                     case 'f':
584                         switch(sizeModifier) {
585                             case ' ':
586                                 doubleArg = va_arg(arg, double);
587                                 frexp(doubleArg, &exp);
588                                 break;
589                             case 'L':
590                                 lDoubleArg = va_arg(arg, LONG_DOUBLE);
591                                 frexp(lDoubleArg, &exp);
592                                 break;
593                             default:
594                                 goto ErrorReturn;
595                         }
596                         if(precision == -1) precision = 6;
597                         buffReqd = precision + 3 + ((exp > 0) ? exp/3 : 0);
598                         break;
599                     case 'e':
600                     case 'E':
601                     case 'g':
602                     case 'G':
603                         if(precision == -1) precision = 6;
604                         buffReqd = precision + 8;
605                         break;
606                     case 'n':
607                     case '%':
608                     default:
609                         goto ErrorReturn;
610                         break;
611                 }
612                 buffReqd = max(buffReqd + 10, minWidth);
613                 /*
614                  * Allocate the buffer
615                  */
616                 if(buffReqd <= PRINTF_BUFFLEN) {
617                     buffPtr = buff;
618                     buffLen = PRINTF_BUFFLEN;
619                 } else {
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;
625                     }
626                     buffPtr = auxBuffPtr;
627                     buffLen = auxBuffLen;
628                 }
629             }
630             /*
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).
639              *
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.
642              */
643             performedOp = TRUE;
644             switch(op) {
645                 case 'd':
646                 case 'i':
647                     switch(sizeModifier) {
648                         case ' ':
649                             intArg = va_arg(arg, int);
650                             sprintf(buffPtr, fmtBuff, intArg);
651                             buffCount = strlen(buffPtr);
652                             break;
653                         case 'l':
654                             longArg = va_arg(arg, long);
655                             sprintf(buffPtr, fmtBuff, longArg);
656                             buffCount = strlen(buffPtr);
657                             break;
658                         case 'h':
659                             shortArg = va_arg(arg, short);
660                             sprintf(buffPtr, fmtBuff, shortArg);
661                             buffCount = strlen(buffPtr);
662                             break;
663                         default:
664                             goto ErrorReturn;
665                     }
666                     break;
667                 case 'u':
668                 case 'o':
669                 case 'x':
670                 case 'X':
671                     switch(sizeModifier) {
672                         case ' ':
673                             unsignedArg = va_arg(arg, unsigned);
674                             sprintf(buffPtr, fmtBuff, unsignedArg);
675                             buffCount = strlen(buffPtr);
676                             break;
677                         case 'l':
678                             uLongArg = va_arg(arg, unsigned long);
679                             sprintf(buffPtr, fmtBuff, uLongArg);
680                             buffCount = strlen(buffPtr);
681                             break;
682                         case 'h':
683                             uShortArg = va_arg(arg, unsigned short);
684                             sprintf(buffPtr, fmtBuff, uShortArg);
685                             buffCount = strlen(buffPtr);
686                             break;
687                         default:
688                             goto ErrorReturn;
689                     }
690                     break;
691                 case 'c':
692                     switch(sizeModifier) {
693                         case ' ':
694                             intArg = va_arg(arg, int);
695                             sprintf(buffPtr, fmtBuff, intArg);
696                             buffCount = strlen(buffPtr);
697                             break;
698                         case 'l':
699                             /*
700                              * XXX: Allowed by ISO C Amendment 1, but
701                              * many platforms don't yet support wint_t
702                              */
703                             goto ErrorReturn;
704                     default:
705                             goto ErrorReturn;
706                     }
707                     break;
708                 case 's':
709                     switch(sizeModifier) {
710                         case ' ':
711                             if(fastPath) {
712                                 buffPtr = va_arg(arg, char *);
713                                 buffCount = strlen(buffPtr);
714                                 buffLen = buffCount + 1;
715                             } else {
716                                 sprintf(buffPtr, fmtBuff, charPtrArg);
717                                 buffCount = strlen(buffPtr);
718                             }
719                             break;
720                         case 'l':
721                             /*
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.
725                              */
726                             goto ErrorReturn;
727                         default:
728                             goto ErrorReturn;
729                     }
730                     break;
731                 case 'p':
732                     if(sizeModifier != ' ') goto ErrorReturn;
733                     voidPtrArg = va_arg(arg, void *);
734                     sprintf(buffPtr, fmtBuff, voidPtrArg);
735                     buffCount = strlen(buffPtr);
736                     break;
737                 case 'n':
738                     switch(sizeModifier) {
739                         case ' ':
740                             intPtrArg = va_arg(arg, int *);
741                             *intPtrArg = streamCount;
742                             break;
743                         case 'l':
744                             longPtrArg = va_arg(arg, long *);
745                             *longPtrArg = streamCount;
746                             break;
747                         case 'h':
748                             shortPtrArg = va_arg(arg, short *);
749                             *shortPtrArg = streamCount;
750                             break;
751                         default:
752                             goto ErrorReturn;
753                     }
754                     buffCount = 0;
755                     break;
756                 case 'f':
757                     if(fastPath) {
758                         performedOp = FALSE;
759                         break;
760                     }
761                     switch(sizeModifier) {
762                         case ' ':
763                             sprintf(buffPtr, fmtBuff, doubleArg);
764                             buffCount = strlen(buffPtr);
765                             break;
766                         case 'L':
767                             sprintf(buffPtr, fmtBuff, lDoubleArg);
768                             buffCount = strlen(buffPtr);
769                             break;
770                         default:
771                             goto ErrorReturn;
772                     }
773                     break;
774                 case 'e':
775                 case 'E':
776                 case 'g':
777                 case 'G':
778                     switch(sizeModifier) {
779                         case ' ':
780                             doubleArg = va_arg(arg, double);
781                             sprintf(buffPtr, fmtBuff, doubleArg);
782                             buffCount = strlen(buffPtr);
783                             break;
784                         case 'L':
785                             lDoubleArg = va_arg(arg, LONG_DOUBLE);
786                             sprintf(buffPtr, fmtBuff, lDoubleArg);
787                             buffCount = strlen(buffPtr);
788                             break;
789                         default:
790                             goto ErrorReturn;
791                     }
792                     break;
793                 case '%':
794                     if(sizeModifier != ' ')
795                         goto ErrorReturn;
796                     buff[0] = '%';
797                     buffCount = 1;
798                     break;
799                 case '\0':
800                     goto ErrorReturn;
801                 default:
802                     performedOp = FALSE;
803                     break;
804             } /* switch(op) */
805             if(performedOp) break;
806             if(!fastPath) goto ErrorReturn;
807             fastPath = FALSE;
808         } /* for (;;) */
809         ASSERT(buffCount < buffLen);
810         if(buffCount > 0) {
811             if(FCGX_PutStr(buffPtr, buffCount, stream) < 0)
812                 goto ErrorReturn;
813             streamCount += buffCount;
814         } else if(buffCount < 0) {
815             goto ErrorReturn;
816         }
817         f += specifierLength;
818     } /* while(f != fStop) */
819     goto NormalReturn;
820   ErrorReturn:
821     streamCount = -1;
822   NormalReturn:
823     if(auxBuffPtr != NULL) free(auxBuffPtr);
824     return streamCount;
825 }
826
827 /*
828  * Copy n characters from *srcPtr to *destPtr, then increment
829  * both *srcPtr and *destPtr by n.
830  */
831 static void CopyAndAdvance(char **destPtr, char **srcPtr, int n)
832 {
833     char *dest = *destPtr;
834     char *src = *srcPtr;
835     int i;
836     for (i = 0; i < n; i++)
837         *dest++ = *src++;
838     *destPtr = dest;
839     *srcPtr = src;
840 }
841 \f
842 /*
843  *----------------------------------------------------------------------
844  *
845  * FCGX_FFlush --
846  *
847  *      Flushes any buffered output.
848  *
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.
854  *
855  * Results:
856  *      EOF (-1) if an error occurred.
857  *
858  *----------------------------------------------------------------------
859  */
860 int FCGX_FFlush(FCGX_Stream *stream)
861 {
862     if(stream->isClosed || stream->isReader)
863         return 0;
864     stream->emptyBuffProc(stream, FALSE);
865     return (stream->isClosed) ? -1 : 0;
866 }
867 \f
868 /*
869  *----------------------------------------------------------------------
870  *
871  * FCGX_FClose --
872  *
873  *      Performs FCGX_FFlush and closes the stream.
874  *
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.
879  *
880  * Results:
881  *      EOF (-1) if an error occurred.
882  *
883  *----------------------------------------------------------------------
884  */
885 int FCGX_FClose(FCGX_Stream *stream)
886 {
887     if(!stream->wasFCloseCalled) {
888         if(!stream->isReader) {
889             stream->emptyBuffProc(stream, TRUE);
890         }
891         stream->wasFCloseCalled = TRUE;
892         stream->isClosed = TRUE;
893         if(stream->isReader) {
894             stream->wrNext = stream->stop = stream->rdNext;
895         } else {
896             stream->rdNext = stream->stop = stream->wrNext;
897         }
898     }
899     return (stream->FCGI_errno == 0) ? 0 : EOF;
900 }
901 \f
902 /*
903  *----------------------------------------------------------------------
904  *
905  * SetError --
906  *
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.
910  *
911  *----------------------------------------------------------------------
912  */
913 static void SetError(FCGX_Stream *stream, int FCGI_errno)
914 {
915     /*
916      * Preserve only the first error.
917      */
918     if(stream->FCGI_errno == 0) {
919         stream->FCGI_errno = FCGI_errno;
920         stream->isClosed = TRUE;
921     }
922 }
923
924 /*
925  *----------------------------------------------------------------------
926  *
927  * FCGX_GetError --
928  *
929  *      Return the stream error code.  0 means no error, > 0
930  *      is an errno(2) error, < 0 is an FCGX_errno error.
931  *
932  *----------------------------------------------------------------------
933  */
934 int FCGX_GetError(FCGX_Stream *stream) {
935     return stream->FCGI_errno;
936 }
937
938 /*
939  *----------------------------------------------------------------------
940  *
941  * FCGX_ClearError --
942  *
943  *      Clear the stream error code and end-of-file indication.
944  *
945  *----------------------------------------------------------------------
946  */
947 void FCGX_ClearError(FCGX_Stream *stream) {
948     stream->FCGI_errno = 0;
949     /*
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.
959      */
960 }
961 \f
962 /*
963  *======================================================================
964  * Parameters
965  *======================================================================
966  */
967
968 /*
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.
972  */
973
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 */
978 } Params;
979 typedef Params *ParamsPtr;
980 \f
981 /*
982  *----------------------------------------------------------------------
983  *
984  * NewParams --
985  *
986  *      Creates a new Params structure.
987  *
988  * Results:
989  *      Pointer to the new structure.
990  *
991  *----------------------------------------------------------------------
992  */
993 static ParamsPtr NewParams(int length)
994 {
995     ParamsPtr result;
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;
1001     return result;
1002 }
1003 \f
1004 /*
1005  *----------------------------------------------------------------------
1006  *
1007  * FreeParams --
1008  *
1009  *      Frees a Params structure and all the parameters it contains.
1010  *
1011  * Side effects:
1012  *      paramsPtr becomes invalid.
1013  *
1014  *----------------------------------------------------------------------
1015  */
1016 static void FreeParams(ParamsPtr *paramsPtrPtr)
1017 {
1018     ParamsPtr paramsPtr = *paramsPtrPtr;
1019     char **p;
1020     if(paramsPtr == NULL) {
1021         return;
1022     }
1023     for (p = paramsPtr->vec; p < paramsPtr->cur; p++) {
1024         free(*p);
1025     }
1026     free(paramsPtr->vec);
1027     free(paramsPtr);
1028     *paramsPtrPtr = NULL;
1029 }
1030 \f
1031 /*
1032  *----------------------------------------------------------------------
1033  *
1034  * PutParam --
1035  *
1036  *      Add a name/value pair to a Params structure.
1037  *
1038  * Results:
1039  *      None.
1040  *
1041  * Side effects:
1042  *      Parameters structure updated.
1043  *
1044  *----------------------------------------------------------------------
1045  */
1046 static void PutParam(ParamsPtr paramsPtr, char *nameValue)
1047 {
1048     int size;
1049
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;
1056     }
1057     *paramsPtr->cur = NULL;
1058 }
1059 \f
1060 /*
1061  *----------------------------------------------------------------------
1062  *
1063  * FCGX_GetParam -- obtain value of FCGI parameter in environment
1064  *
1065  *
1066  * Results:
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.
1070  *
1071  *----------------------------------------------------------------------
1072  */
1073 char *FCGX_GetParam(const char *name, FCGX_ParamArray envp)
1074 {
1075     int len;
1076     char **p;
1077     len = strlen(name);
1078     if(len == 0) return NULL;
1079     for (p = envp; *p != NULL; p++) {
1080         if((strncmp(name, *p, len) == 0) && ((*p)[len] == '=')) {
1081             return *p+len+1;
1082         }
1083     }
1084     return NULL;
1085 }
1086 \f
1087 /*
1088  *----------------------------------------------------------------------
1089  *
1090  * Start of FastCGI-specific code
1091  *
1092  *----------------------------------------------------------------------
1093  */
1094 \f
1095 /*
1096  *----------------------------------------------------------------------
1097  *
1098  * ReadParams --
1099  *
1100  *      Reads FastCGI name-value pairs from stream until EOF.  Converts
1101  *      each pair to name=value format and adds it to Params structure.
1102  *
1103  *----------------------------------------------------------------------
1104  */
1105 static int ReadParams(Params *paramsPtr, FCGX_Stream *stream)
1106 {
1107     int nameLen, valueLen;
1108     unsigned char lenBuff[3];
1109     char *nameValue;
1110
1111     while((nameLen = FCGX_GetChar(stream)) != EOF) {
1112         /*
1113          * Read name length (one or four bytes) and value length
1114          * (one or four bytes) from stream.
1115          */
1116         if((nameLen & 0x80) != 0) {
1117             if(FCGX_GetStr((char *) &lenBuff[0], 3, stream) != 3) {
1118                 SetError(stream, FCGX_PARAMS_ERROR);
1119                 return -1;
1120             }
1121             nameLen = ((nameLen & 0x7f) << 24) + (lenBuff[0] << 16)
1122                     + (lenBuff[1] << 8) + lenBuff[2];
1123         }
1124         if((valueLen = FCGX_GetChar(stream)) == EOF) {
1125             SetError(stream, FCGX_PARAMS_ERROR);
1126             return -1;
1127         }
1128         if((valueLen & 0x80) != 0) {
1129             if(FCGX_GetStr((char *) &lenBuff[0], 3, stream) != 3) {
1130                 SetError(stream, FCGX_PARAMS_ERROR);
1131                 return -1;
1132             }
1133             valueLen = ((valueLen & 0x7f) << 24) + (lenBuff[0] << 16)
1134                     + (lenBuff[1] << 8) + lenBuff[2];
1135         }
1136         /*
1137          * nameLen and valueLen are now valid; read the name and value
1138          * from stream and construct a standard environment entry.
1139          */
1140         nameValue = (char *)Malloc(nameLen + valueLen + 2);
1141         if(FCGX_GetStr(nameValue, nameLen, stream) != nameLen) {
1142             SetError(stream, FCGX_PARAMS_ERROR);
1143             free(nameValue);
1144             return -1;
1145         }
1146         *(nameValue + nameLen) = '=';
1147         if(FCGX_GetStr(nameValue + nameLen + 1, valueLen, stream)
1148                 != valueLen) {
1149             SetError(stream, FCGX_PARAMS_ERROR);
1150             free(nameValue);
1151             return -1;
1152         }
1153         *(nameValue + nameLen + valueLen + 1) = '\0';
1154         PutParam(paramsPtr, nameValue);
1155     }
1156     return 0;
1157 }
1158 \f
1159 /*
1160  *----------------------------------------------------------------------
1161  *
1162  * MakeHeader --
1163  *
1164  *      Constructs an FCGI_Header struct.
1165  *
1166  *----------------------------------------------------------------------
1167  */
1168 static FCGI_Header MakeHeader(
1169         int type,
1170         int requestId,
1171         int contentLength,
1172         int paddingLength)
1173 {
1174     FCGI_Header header;
1175     ASSERT(contentLength >= 0 && contentLength <= FCGI_MAX_LENGTH);
1176     ASSERT(paddingLength >= 0 && paddingLength <= 0xff);
1177     header.version = FCGI_VERSION_1;
1178     header.type             =  type;
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;
1185     return header;
1186 }
1187 \f
1188 /*
1189  *----------------------------------------------------------------------
1190  *
1191  * MakeEndRequestBody --
1192  *
1193  *      Constructs an FCGI_EndRequestBody struct.
1194  *
1195  *----------------------------------------------------------------------
1196  */
1197 static FCGI_EndRequestBody MakeEndRequestBody(
1198         int appStatus,
1199         int protocolStatus)
1200 {
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));
1208     return body;
1209 }
1210 \f
1211 /*
1212  *----------------------------------------------------------------------
1213  *
1214  * MakeUnknownTypeBody --
1215  *
1216  *      Constructs an FCGI_MakeUnknownTypeBody struct.
1217  *
1218  *----------------------------------------------------------------------
1219  */
1220 static FCGI_UnknownTypeBody MakeUnknownTypeBody(
1221         int type)
1222 {
1223     FCGI_UnknownTypeBody body;
1224     body.type = type;
1225     memset(body.reserved, 0, sizeof(body.reserved));
1226     return body;
1227 }
1228 \f
1229 /*
1230  *----------------------------------------------------------------------
1231  *
1232  * AlignInt8 --
1233  *
1234  *      Returns the smallest integer greater than or equal to n
1235  *      that's a multiple of 8.
1236  *
1237  *----------------------------------------------------------------------
1238  */
1239 static int AlignInt8(unsigned n) {
1240     return (n + 7) & (UINT_MAX - 7);
1241 }
1242
1243 /*
1244  *----------------------------------------------------------------------
1245  *
1246  * AlignPtr8 --
1247  *
1248  *      Returns the smallest pointer greater than or equal to p
1249  *      that's a multiple of 8.
1250  *
1251  *----------------------------------------------------------------------
1252  */
1253 static unsigned char *AlignPtr8(unsigned char *p) {
1254     unsigned long u = (unsigned long) p;
1255     u = ((u + 7) & (ULONG_MAX - 7)) - u;
1256     return p + u;
1257 }
1258 \f
1259
1260 /*
1261  * State associated with a stream
1262  */
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 */
1280 } FCGX_Stream_Data;
1281 \f
1282 /*
1283  *----------------------------------------------------------------------
1284  *
1285  * WriteCloseRecords --
1286  *
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
1289  *      record.
1290  *
1291  *----------------------------------------------------------------------
1292  */
1293 static void WriteCloseRecords(struct FCGX_Stream *stream)
1294 {
1295     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1296     /*
1297      * Enter rawWrite mode so final records won't be encapsulated as
1298      * stream data.
1299      */
1300     data->rawWrite = TRUE;
1301     /*
1302      * Generate EOF for stream content if needed.
1303      */
1304     if(!(data->type == FCGI_STDERR
1305             && stream->wrNext == data->buff
1306             && !data->isAnythingWritten)) {
1307         FCGI_Header header;
1308         header = MakeHeader(data->type, data->reqDataPtr->requestId, 0, 0);
1309         FCGX_PutStr((char *) &header, sizeof(header), stream);
1310     };
1311     /*
1312      * Generate FCGI_END_REQUEST record if needed.
1313      */
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);
1323     }
1324     data->reqDataPtr->nWriters--;
1325 }
1326 \f
1327
1328
1329 static int write_it_all(int fd, char *buf, int len)
1330 {
1331     int wrote;
1332
1333     while (len) {
1334         wrote = OS_Write(fd, buf, len);
1335         if (wrote < 0)
1336             return wrote;
1337         len -= wrote;
1338         buf += wrote;
1339     }
1340     return len;
1341 }
1342
1343 /*
1344  *----------------------------------------------------------------------
1345  *
1346  * EmptyBuffProc --
1347  *
1348  *      Encapsulates any buffered stream content in a FastCGI
1349  *      record.  Writes the data, making the buffer empty.
1350  *
1351  *----------------------------------------------------------------------
1352  */
1353 static void EmptyBuffProc(struct FCGX_Stream *stream, int doClose)
1354 {
1355     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1356     int cLen, eLen;
1357     /*
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.
1363      */
1364     if(!data->rawWrite) {
1365         cLen = stream->wrNext - data->buff - sizeof(FCGI_Header);
1366         if(cLen > 0) {
1367             eLen = AlignInt8(cLen);
1368             /*
1369              * Giving the padding a well-defined value keeps Purify happy.
1370              */
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);
1376         } else {
1377             stream->wrNext = data->buff;
1378         }
1379     }
1380     if(doClose) {
1381         WriteCloseRecords(stream);
1382     };
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);
1387             return;
1388         }
1389         stream->wrNext = data->buff;
1390     }
1391     /*
1392      * The buffer is empty.
1393      */
1394     if(!data->rawWrite) {
1395         stream->wrNext += sizeof(FCGI_Header);
1396     }
1397 }
1398 \f
1399 /*
1400  * Return codes for Process* functions
1401  */
1402 #define STREAM_RECORD 0
1403 #define SKIP          1
1404 #define BEGIN_RECORD  2
1405 #define MGMT_RECORD   3
1406
1407 /*
1408  *----------------------------------------------------------------------
1409  *
1410  * ProcessManagementRecord --
1411  *
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.
1418  *
1419  *----------------------------------------------------------------------
1420  */
1421 static int ProcessManagementRecord(int type, FCGX_Stream *stream)
1422 {
1423     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1424     ParamsPtr paramsPtr = NewParams(3);
1425     char **pPtr;
1426     char response[64]; /* 64 = 8 + 3*(1+1+14+1)* + padding */
1427     char *responseP = &response[FCGI_HEADER_LEN];
1428     char *name, value;
1429     int len, paddedLen;
1430     if(type == FCGI_GET_VALUES) {
1431         ReadParams(paramsPtr, stream);
1432         if((FCGX_GetError(stream) != 0) || (data->contentLen != 0)) {
1433             FreeParams(&paramsPtr);
1434             return FCGX_PROTOCOL_ERROR;
1435         }
1436         for (pPtr = paramsPtr->vec; pPtr < paramsPtr->cur; pPtr++) {
1437             name = *pPtr;
1438             *(strchr(name, '=')) = '\0';
1439             if(strcmp(name, FCGI_MAX_CONNS) == 0) {
1440                 value = '1';
1441             } else if(strcmp(name, FCGI_MAX_REQS) == 0) {
1442                 value = '1';
1443             } else if(strcmp(name, FCGI_MPXS_CONNS) == 0) {
1444                 value = '0';
1445             } else {
1446                 name = NULL;
1447             }
1448             if(name != NULL) {
1449                 len = strlen(name);
1450                 sprintf(responseP, "%c%c%s%c", len, 1, name, value);
1451                 responseP += len + 3;
1452             }
1453         }
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(&paramsPtr);
1460     } else {
1461         paddedLen = len = sizeof(FCGI_UnknownTypeBody);
1462         ((FCGI_UnknownTypeRecord *) response)->header
1463             = MakeHeader(FCGI_UNKNOWN_TYPE, FCGI_NULL_REQUEST_ID,
1464                          len, 0);
1465         ((FCGI_UnknownTypeRecord *) response)->body
1466             = MakeUnknownTypeBody(type);
1467     }
1468     if (write_it_all(data->reqDataPtr->ipcFd, response, FCGI_HEADER_LEN + paddedLen) < 0) {
1469         SetError(stream, OS_Errno);
1470         return -1;
1471     }
1472
1473     return MGMT_RECORD;
1474 }
1475 \f
1476 /*
1477  *----------------------------------------------------------------------
1478  *
1479  * ProcessBeginRecord --
1480  *
1481  *      Reads an FCGI_BEGIN_REQUEST record.
1482  *
1483  * Results:
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).
1487  *
1488  * Side effects:
1489  *      In case of BEGIN_RECORD return, stores requestId, role,
1490  *      keepConnection values, and sets isBeginProcessed = TRUE.
1491  *
1492  *----------------------------------------------------------------------
1493  */
1494 static int ProcessBeginRecord(int requestId, FCGX_Stream *stream)
1495 {
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;
1500     }
1501     if(data->reqDataPtr->isBeginProcessed) {
1502         /*
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}
1506          */
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);
1514             return -1;
1515         }
1516
1517         return SKIP;
1518     }
1519     /*
1520      * Accept this new request.  Read the record body.
1521      */
1522     data->reqDataPtr->requestId = requestId;
1523     if(FCGX_GetStr((char *) &body, sizeof(body), stream)
1524             != sizeof(body)) {
1525         return FCGX_PROTOCOL_ERROR;
1526     }
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;
1531 }
1532 \f
1533 /*
1534  *----------------------------------------------------------------------
1535  *
1536  * ProcessHeader --
1537  *
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.
1541  *
1542  * Results:
1543  *      >= 0 for a normal return, < 0 for error
1544  *
1545  * Side effects:
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
1551  *      paddingLength.
1552  *
1553  *----------------------------------------------------------------------
1554  */
1555 static int ProcessHeader(FCGI_Header header, FCGX_Stream *stream)
1556 {
1557     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1558     int requestId;
1559     if(header.version != FCGI_VERSION_1) {
1560         return FCGX_UNSUPPORTED_VERSION;
1561     }
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);
1569     }
1570     if(requestId  == FCGI_NULL_REQUEST_ID) {
1571         return ProcessManagementRecord(header.type, stream);
1572     }
1573     if(requestId != data->reqDataPtr->requestId) {
1574         return SKIP;
1575     }
1576     if(header.type != data->type) {
1577         return FCGX_PROTOCOL_ERROR;
1578     }
1579     return STREAM_RECORD;
1580 }
1581 \f
1582 /*
1583  *----------------------------------------------------------------------
1584  *
1585  * FillBuffProc --
1586  *
1587  *      Reads bytes from the ipcFd, supplies bytes to a stream client.
1588  *
1589  *----------------------------------------------------------------------
1590  */
1591 static void FillBuffProc(FCGX_Stream *stream)
1592 {
1593     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1594     FCGI_Header header;
1595     int headerLen = 0;
1596     int status, count;
1597
1598     for (;;) {
1599         /*
1600          * If data->buff is empty, do a read.
1601          */
1602         if(stream->rdNext == data->buffStop) {
1603             count = OS_Read(data->reqDataPtr->ipcFd, (char *)data->buff,
1604                             data->bufflen);
1605             if(count <= 0) {
1606                 SetError(stream, (count == 0 ? FCGX_PROTOCOL_ERROR : OS_Errno));
1607                 return;
1608             }
1609             stream->rdNext = data->buff;
1610             data->buffStop = data->buff + count;
1611         }
1612         /*
1613          * Now data->buff is not empty.  If the current record contains
1614          * more content bytes, deliver all that are present in data->buff.
1615          */
1616         if(data->contentLen > 0) {
1617             count = min(data->contentLen, data->buffStop - stream->rdNext);
1618             data->contentLen -= count;
1619             if(!data->skip) {
1620                 stream->wrNext = stream->stop = stream->rdNext + count;
1621                 return;
1622             } else {
1623                 stream->rdNext += count;
1624                 if(data->contentLen > 0) {
1625                     continue;
1626                 } else {
1627                     data->skip = FALSE;
1628                 }
1629             }
1630         }
1631         /*
1632          * If the current record (whose content has been fully consumed by
1633          * the client) was padded, skip over the padding bytes.
1634          */
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) {
1640                 continue;
1641             }
1642         }
1643         /*
1644          * All done with the current record, including the padding.
1645          * If we're in a recursive call from ProcessHeader, deliver EOF.
1646          */
1647         if(data->eorStop) {
1648             stream->stop = stream->rdNext;
1649             stream->isClosed = TRUE;
1650             return;
1651         }
1652         /*
1653          * Fill header with bytes from the input buffer.
1654          */
1655         count = min((int)sizeof(header) - headerLen,
1656                         data->buffStop - stream->rdNext);
1657         memcpy(((char *)(&header)) + headerLen, stream->rdNext, count);
1658         headerLen += count;
1659         stream->rdNext += count;
1660         if(headerLen < sizeof(header)) {
1661             continue;
1662         };
1663         headerLen = 0;
1664         /*
1665          * Interpret header.  eorStop prevents ProcessHeader from reading
1666          * past the end-of-record when using stream to read content.
1667          */
1668         data->eorStop = TRUE;
1669         stream->stop = stream->rdNext;
1670         status = ProcessHeader(header, stream);
1671         data->eorStop = FALSE;
1672         stream->isClosed = FALSE;
1673         switch(status) {
1674             case STREAM_RECORD:
1675                 /*
1676                  * If this stream record header marked the end of stream
1677                  * data deliver EOF to the stream client, otherwise loop
1678                  * and deliver data.
1679                  *
1680                  * XXX: If this is final stream and
1681                  * stream->rdNext != data->buffStop, buffered
1682                  * data is next request (server pipelining)?
1683                  */
1684                 if(data->contentLen == 0) {
1685                     stream->wrNext = stream->stop = stream->rdNext;
1686                     stream->isClosed = TRUE;
1687                     return;
1688                 }
1689                 break;
1690             case SKIP:
1691                 data->skip = TRUE;
1692                 break;
1693             case BEGIN_RECORD:
1694                 /*
1695                  * If this header marked the beginning of a new
1696                  * request, return role information to caller.
1697                  */
1698                 return;
1699                 break;
1700             case MGMT_RECORD:
1701                 break;
1702             default:
1703                 ASSERT(status < 0);
1704                 SetError(stream, status);
1705                 return;
1706                 break;
1707         }
1708     }
1709 }
1710 \f
1711 /*
1712  *----------------------------------------------------------------------
1713  *
1714  * NewStream --
1715  *
1716  *      Creates a stream to read or write from an open ipcFd.
1717  *      The stream performs reads/writes of up to bufflen bytes.
1718  *
1719  *----------------------------------------------------------------------
1720  */
1721 static FCGX_Stream *NewStream(
1722         FCGX_Request *reqDataPtr, int bufflen, int isReader, int streamType)
1723 {
1724     /*
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.
1731      */
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) {
1740         data->bufflen -= 8;
1741     }
1742     if(isReader) {
1743         data->buffStop = data->buff;
1744     } else {
1745         data->buffStop = data->buff + data->bufflen;
1746     }
1747     data->type = streamType;
1748     data->eorStop = FALSE;
1749     data->skip = FALSE;
1750     data->contentLen = 0;
1751     data->paddingLen = 0;
1752     data->isAnythingWritten = FALSE;
1753     data->rawWrite = FALSE;
1754
1755     stream->data = data;
1756     stream->isReader = isReader;
1757     stream->isClosed = FALSE;
1758     stream->wasFCloseCalled = FALSE;
1759     stream->FCGI_errno = 0;
1760     if(isReader) {
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;
1767     } else {
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;
1774     }
1775     return stream;
1776 }
1777 \f
1778 /*
1779  *----------------------------------------------------------------------
1780  *
1781  * FreeStream --
1782  *
1783  *      Frees all storage allocated when *streamPtr was created,
1784  *      and nulls out *streamPtr.
1785  *
1786  *----------------------------------------------------------------------
1787  */
1788 void FreeStream(FCGX_Stream **streamPtr)
1789 {
1790     FCGX_Stream *stream = *streamPtr;
1791     FCGX_Stream_Data *data;
1792     if(stream == NULL) {
1793         return;
1794     }
1795     data = (FCGX_Stream_Data *)stream->data;
1796     data->reqDataPtr = NULL;
1797     free(data->mBuff);
1798     free(data);
1799     free(stream);
1800     *streamPtr = NULL;
1801 }
1802 \f
1803 /*
1804  *----------------------------------------------------------------------
1805  *
1806  * SetReaderType --
1807  *
1808  *      Re-initializes the stream to read data of the specified type.
1809  *
1810  *----------------------------------------------------------------------
1811  */
1812 static FCGX_Stream *SetReaderType(FCGX_Stream *stream, int streamType)
1813 {
1814     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
1815     ASSERT(stream->isReader);
1816     data->type = streamType;
1817     data->eorStop = FALSE;
1818     data->skip = FALSE;
1819     data->contentLen = 0;
1820     data->paddingLen = 0;
1821     stream->wrNext = stream->stop = stream->rdNext;
1822     stream->isClosed = FALSE;
1823     return stream;
1824 }
1825 \f
1826 /*
1827  *----------------------------------------------------------------------
1828  *
1829  * NewReader --
1830  *
1831  *      Creates a stream to read streamType records for the given
1832  *      request.  The stream performs OS reads of up to bufflen bytes.
1833  *
1834  *----------------------------------------------------------------------
1835  */
1836 static FCGX_Stream *NewReader(FCGX_Request *reqDataPtr, int bufflen, int streamType)
1837 {
1838     return NewStream(reqDataPtr, bufflen, TRUE, streamType);
1839 }
1840
1841
1842 /*
1843  *----------------------------------------------------------------------
1844  *
1845  * NewWriter --
1846  *
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.
1850  *
1851  *----------------------------------------------------------------------
1852  */
1853 static FCGX_Stream *NewWriter(FCGX_Request *reqDataPtr, int bufflen, int streamType)
1854 {
1855     return NewStream(reqDataPtr, bufflen, FALSE, streamType);
1856 }
1857
1858
1859 /*
1860  *----------------------------------------------------------------------
1861  *
1862  * CreateWriter --
1863  *
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.
1868  *
1869  *----------------------------------------------------------------------
1870  */
1871 FCGX_Stream *CreateWriter(
1872         int ipcFd,
1873         int requestId,
1874         int bufflen,
1875         int streamType)
1876 {
1877     FCGX_Request *reqDataPtr = (FCGX_Request *)Malloc(sizeof(FCGX_Request));
1878     reqDataPtr->ipcFd = ipcFd;
1879     reqDataPtr->requestId = requestId;
1880     /*
1881      * Suppress writing an FCGI_END_REQUEST record.
1882      */
1883     reqDataPtr->nWriters = 2;
1884     return NewWriter(reqDataPtr, bufflen, streamType);
1885 }
1886 \f
1887 /*
1888  *======================================================================
1889  * Control
1890  *======================================================================
1891  */
1892
1893 /*
1894  *----------------------------------------------------------------------
1895  *
1896  * FCGX_IsCGI --
1897  *
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).
1902  *
1903  * Results:
1904  *      TRUE if the process is a CGI process, FALSE if FastCGI.
1905  *
1906  * Side effects:
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.
1910  *
1911  *----------------------------------------------------------------------
1912  */
1913 int FCGX_IsCGI(void)
1914 {
1915     static int isFastCGI = -1;
1916
1917     if (isFastCGI != -1) {
1918         return !isFastCGI;
1919     }
1920
1921     if (!libInitialized) {
1922         int rc = FCGX_Init();
1923         if (rc) {
1924             /* exit() isn't great, but hey */
1925             exit((rc < 0) ? rc : -rc);
1926         }
1927     }
1928
1929     isFastCGI = OS_IsFcgi();
1930
1931     return !isFastCGI;
1932 }
1933 \f
1934 /*
1935  *----------------------------------------------------------------------
1936  *
1937  * FCGX_Finish --
1938  *
1939  *      Finishes the current request from the HTTP server.
1940  *
1941  * Side effects:
1942  *
1943  *      Finishes the request accepted by (and frees any
1944  *      storage allocated by) the previous call to FCGX_Accept.
1945  *
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
1949  *      or FCGX_Accept.
1950  *
1951  *----------------------------------------------------------------------
1952  */
1953
1954 void FCGX_Finish(void)
1955 {
1956     FCGX_Finish_r(reqDataPtr);
1957 }
1958
1959 /*
1960  *----------------------------------------------------------------------
1961  *
1962  * FCGX_Finish_r --
1963  *
1964  *      Finishes the current request from the HTTP server.
1965  *
1966  * Side effects:
1967  *
1968  *      Finishes the request accepted by (and frees any
1969  *      storage allocated by) the previous call to FCGX_Accept.
1970  *
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
1974  *      or FCGX_Accept.
1975  *
1976  *----------------------------------------------------------------------
1977  */
1978 void FCGX_Finish_r(FCGX_Request *reqDataPtr)
1979 {
1980     if (reqDataPtr == NULL) {
1981         return;
1982     }
1983
1984     if (reqDataPtr->inStream) {
1985         int errStatus = FCGX_FClose(reqDataPtr->errStream);
1986         int outStatus = FCGX_FClose(reqDataPtr->outStream);
1987
1988         if (errStatus  || outStatus
1989             || FCGX_GetError(reqDataPtr->inStream)
1990             || !reqDataPtr->keepConnection)
1991         {
1992             OS_IpcClose(reqDataPtr->ipcFd);
1993         }
1994
1995         ASSERT(reqDataPtr->nWriters == 0);
1996
1997         FreeStream(&reqDataPtr->inStream);
1998         FreeStream(&reqDataPtr->outStream);
1999         FreeStream(&reqDataPtr->errStream);
2000
2001         FreeParams(&reqDataPtr->paramsPtr);
2002     }
2003
2004     if (!reqDataPtr->keepConnection) {
2005         reqDataPtr->ipcFd = -1;
2006     }
2007 }
2008 \f
2009
2010 void FCGX_InitRequest(FCGX_Request *request)
2011 {
2012     memset(request, 0, sizeof(FCGX_Request));
2013 }
2014
2015 /*
2016  *----------------------------------------------------------------------
2017  *
2018  * FCGX_Init --
2019  *
2020  *      Initilize the FCGX library.  This is called by FCGX_Accept()
2021  *      but must be called by the user when using FCGX_Accept_r().
2022  *
2023  * Results:
2024  *          0 for successful call.
2025  *
2026  *----------------------------------------------------------------------
2027  */
2028 int FCGX_Init(void)
2029 {
2030     char *p;
2031
2032     if (libInitialized) {
2033         return 0;
2034     }
2035
2036     /* If our compiler doesn't play by the ISO rules for struct layout, halt. */
2037     ASSERT(sizeof(FCGI_Header) == FCGI_HEADER_LEN);
2038
2039     FCGX_InitRequest(&reqData);
2040
2041     if (OS_LibInit(NULL) == -1) {
2042         return OS_Errno ? OS_Errno : -9997;
2043     }
2044
2045     p = getenv("FCGI_WEB_SERVER_ADDRS");
2046     webServerAddressList = p ? StringCopy(p) : "";
2047
2048     libInitialized = 1;
2049     return 0;
2050 }
2051
2052 /*
2053  *----------------------------------------------------------------------
2054  *
2055  * FCGX_Accept --
2056  *
2057  *      Accepts a new request from the HTTP server.
2058  *
2059  * Results:
2060  *      0 for successful call, -1 for error.
2061  *
2062  * Side effects:
2063  *
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.
2071  *
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
2075  *      or FCGX_Accept.
2076  *
2077  *----------------------------------------------------------------------
2078  */
2079
2080 int FCGX_Accept(
2081         FCGX_Stream **in,
2082         FCGX_Stream **out,
2083         FCGX_Stream **err,
2084         FCGX_ParamArray *envp)
2085 {
2086     if (!libInitialized) {
2087         int rc = FCGX_Init();
2088         if (rc) {
2089             return (rc < 0) ? rc : -rc;
2090         }
2091     }
2092
2093     return FCGX_Accept_r(in, out, err, envp, &reqData);
2094 }
2095
2096 /*
2097  *----------------------------------------------------------------------
2098  *
2099  * FCGX_Accept_r --
2100  *
2101  *      Accepts a new request from the HTTP server.
2102  *
2103  * Results:
2104  *      0 for successful call, -1 for error.
2105  *
2106  * Side effects:
2107  *
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.
2115  *
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
2119  *      or FCGX_Accept.
2120  *
2121  *----------------------------------------------------------------------
2122  */
2123 int FCGX_Accept_r(
2124         FCGX_Stream **in,
2125         FCGX_Stream **out,
2126         FCGX_Stream **err,
2127         FCGX_ParamArray *envp,
2128         FCGX_Request *reqDataPtr)
2129 {
2130     if (!libInitialized) {
2131         return -9998;
2132     }
2133
2134     /* Finish the current request, if any. */
2135     FCGX_Finish_r(reqDataPtr);
2136
2137     for (;;) {
2138         /*
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.
2142          */
2143         if (reqDataPtr->ipcFd < 0) {
2144             reqDataPtr->ipcFd = OS_FcgiIpcAccept(webServerAddressList);
2145             if (reqDataPtr->ipcFd < 0) {
2146                 return (errno > 0) ? (0 - errno) : -9999;
2147             }
2148         }
2149         /*
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.
2153          */
2154         reqDataPtr->isBeginProcessed = FALSE;
2155         reqDataPtr->inStream = NewReader(reqDataPtr, 8192, 0);
2156         FillBuffProc(reqDataPtr->inStream);
2157         if(!reqDataPtr->isBeginProcessed) {
2158             goto TryAgain;
2159         }
2160         {
2161             char *roleStr;
2162             switch(reqDataPtr->role) {
2163                 case FCGI_RESPONDER:
2164                     roleStr = "FCGI_ROLE=RESPONDER";
2165                     break;
2166                 case FCGI_AUTHORIZER:
2167                     roleStr = "FCGI_ROLE=AUTHORIZER";
2168                     break;
2169                 case FCGI_FILTER:
2170                     roleStr = "FCGI_ROLE=FILTER";
2171                     break;
2172                 default:
2173                     goto TryAgain;
2174             }
2175             reqDataPtr->paramsPtr = NewParams(30);
2176             PutParam(reqDataPtr->paramsPtr, StringCopy(roleStr));
2177         }
2178         SetReaderType(reqDataPtr->inStream, FCGI_PARAMS);
2179         if(ReadParams(reqDataPtr->paramsPtr, reqDataPtr->inStream) >= 0) {
2180             /*
2181              * Finished reading the environment.  No errors occurred, so
2182              * leave the connection-retry loop.
2183              */
2184             break;
2185         }
2186         /*
2187          * Close the connection and try again.
2188          */
2189       TryAgain:
2190         FreeParams(&reqDataPtr->paramsPtr);
2191         FreeStream(&reqDataPtr->inStream);
2192         OS_Close(reqDataPtr->ipcFd);
2193         reqDataPtr->ipcFd = -1;
2194     } /* for (;;) */
2195     /*
2196      * Build the remaining data structures representing the new
2197      * request and return successfully to the caller.
2198      */
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;
2207     return 0;
2208 }
2209 \f
2210 /*
2211  *----------------------------------------------------------------------
2212  *
2213  * FCGX_StartFilterData --
2214  *
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.
2221  *
2222  * Results:
2223  *      0 for a normal return, < 0 for error
2224  *
2225  *----------------------------------------------------------------------
2226  */
2227
2228 int FCGX_StartFilterData(FCGX_Stream *stream)
2229 {
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);
2236         return -1;
2237     }
2238     SetReaderType(reqDataPtr->inStream, FCGI_DATA);
2239     return 0;
2240 }
2241 \f
2242 /*
2243  *----------------------------------------------------------------------
2244  *
2245  * FCGX_SetExitStatus --
2246  *
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.
2252  *
2253  *----------------------------------------------------------------------
2254  */
2255
2256 void FCGX_SetExitStatus(int status, FCGX_Stream *stream)
2257 {
2258     FCGX_Stream_Data *data = (FCGX_Stream_Data *)stream->data;
2259     data->reqDataPtr->appStatus = status;
2260 }
2261