4 * FastCGI-stdio compatibility package
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: fcgi_stdio.c,v 1.3 1998/03/09 16:38:15 roberts Exp $";
19 #define DLLAPI __declspec(dllexport)
22 #define NO_FCGI_DEFINES
23 #include "fcgi_stdio.h"
24 #undef NO_FCGI_DEFINES
52 FCGI_FILE _fcgi_sF[3];
54 FCGI_FILE _fcgi_sF[3] = {{stdin, NULL}, {stdout, NULL}, {stderr, NULL}};
62 *----------------------------------------------------------------------
66 * Accepts a new request from the HTTP server and creates
67 * a conventional execution environment for the request.
69 * If the application was invoked as a FastCGI server,
70 * the first call to FCGI_Accept indicates that the application
71 * has completed its initialization and is ready to accept
72 * a request. Subsequent calls to FCGI_Accept indicate that
73 * the application has completed its processing of the
74 * current request and is ready to accept a new request.
76 * If the application was invoked as a CGI program, the first
77 * call to FCGI_Accept is essentially a no-op and the second
78 * call returns EOF (-1).
81 * 0 for successful call, -1 for error (application should exit).
84 * If the application was invoked as a FastCGI server,
85 * and this is not the first call to this procedure,
86 * FCGI_Accept first performs the equivalent of FCGI_Finish.
88 * On every call, FCGI_Accept accepts the new request and
89 * reads the FCGI_PARAMS stream into an environment array,
90 * i.e. a NULL-terminated array of strings of the form
91 * ``name=value''. It assigns a pointer to this array
92 * to the global variable environ, used by the standard
93 * library function getenv. It creates new FCGI_FILE *s
94 * representing input from the HTTP server, output to the HTTP
95 * server, and error output to the HTTP server, and assigns these
96 * new files to stdin, stdout, and stderr respectively.
98 * DO NOT mutate or retain pointers to environ or any values
99 * contained in it (e.g. to the result of calling getenv(3)),
100 * since these are freed by the next call to FCGI_Finish or
101 * FCGI_Accept. In particular do not use setenv(3) or putenv(3)
102 * in conjunction with FCGI_Accept.
104 *----------------------------------------------------------------------
106 static int acceptCalled = FALSE;
107 static int isCGI = FALSE;
109 extern char **environ;
112 int FCGI_Accept(void)
116 * First call to FCGI_Accept. Is application running
117 * as FastCGI or as CGI?
119 isCGI = FCGX_IsCGI();
123 * Not first call to FCGI_Accept and running as CGI means
124 * application is done.
129 FCGI_stdin->stdio_stream = stdin;
130 FCGI_stdin->fcgx_stream = NULL;
131 FCGI_stdout->stdio_stream = stdout;
132 FCGI_stdout->fcgx_stream = NULL;
133 FCGI_stderr->stdio_stream = stderr;
134 FCGI_stderr->fcgx_stream = NULL;
136 FCGX_Stream *in, *out, *error;
137 FCGX_ParamArray envp;
138 int acceptResult = FCGX_Accept(&in, &out, &error, &envp);
139 if(acceptResult < 0) {
142 FCGI_stdin->stdio_stream = NULL;
143 FCGI_stdin->fcgx_stream = in;
144 FCGI_stdout->stdio_stream = NULL;
145 FCGI_stdout->fcgx_stream = out;
146 FCGI_stderr->stdio_stream = NULL;
147 FCGI_stderr->fcgx_stream = error;
154 *----------------------------------------------------------------------
158 * Finishes the current request from the HTTP server.
162 * Flushes any buffered output to the HTTP server. Then frees
163 * all storage allocated by the previous call, including all
164 * storage reachable from the value of environ set by the previous
165 * call to FCGI_Accept.
167 * DO NOT use stdin, stdout, stderr, or environ between calling
168 * FCGI_Finish and calling FCGI_Accept.
170 * DO NOT mutate or retain pointers to environ or any values
171 * contained in it (e.g. to the result of calling getenv(3)),
172 * since these are freed by the next call to FCGI_Finish or
173 * FCGI_Accept. In particular do not use setenv(3) or putenv(3)
174 * in conjunction with FCGI_Accept.
176 *----------------------------------------------------------------------
178 void FCGI_Finish(void)
180 if(!acceptCalled || isCGI) {
184 FCGI_stdin->fcgx_stream = NULL;
185 FCGI_stdout->fcgx_stream = NULL;
186 FCGI_stderr->fcgx_stream = NULL;
191 *----------------------------------------------------------------------
193 * FCGI_StartFilterData --
196 * The current request is for the filter role, and stdin is
197 * positioned at EOF of FCGI_STDIN. The call repositions
198 * stdin to the start of FCGI_DATA.
199 * If the preconditions are not met (e.g. FCGI_STDIN has not
200 * been read to EOF), the call sets the stream error code to
201 * FCGX_CALL_SEQ_ERROR.
204 * 0 for a normal return, < 0 for error
206 *----------------------------------------------------------------------
209 int FCGI_StartFilterData(void)
211 if(FCGI_stdin->stdio_stream) {
214 return FCGX_StartFilterData(FCGI_stdin->fcgx_stream);
219 *----------------------------------------------------------------------
221 * FCGI_SetExitStatus --
223 * Sets the exit status for the current request. The exit status
224 * is the status code the request would have exited with, had
225 * the request been run as a CGI program. You can call
226 * FCGI_SetExitStatus several times during a request; the last call
227 * before the request ends (by calling FCGI_Accept) determines the
230 *----------------------------------------------------------------------
233 void FCGI_SetExitStatus(int status)
235 if(FCGI_stdin->fcgx_stream) {
236 FCGX_SetExitStatus(status, FCGI_stdin->fcgx_stream);
241 *----------------------------------------------------------------------
245 * Wrapper for function defined in H&S Section 11.2
247 *----------------------------------------------------------------------
250 void FCGI_perror(const char *str)
252 FCGI_fputs(str, FCGI_stderr);
253 FCGI_fputs(": ", FCGI_stderr);
254 FCGI_fputs(strerror(OS_Errno), FCGI_stderr);
259 *----------------------------------------------------------------------
261 * FCGI_OpenFromFILE --
263 * Constructs a new FCGI_FILE * from the FILE *stream.
266 * NULL if stream == NULL or storage could not be allocated,
267 * otherwise the new FCGI_FILE *.
269 *----------------------------------------------------------------------
272 static FCGI_FILE *FCGI_OpenFromFILE(FILE *stream)
277 fp = malloc(sizeof(FCGI_FILE));
280 fp->stdio_stream = stream;
281 fp->fcgx_stream = NULL;
286 *----------------------------------------------------------------------
288 * FCGI_fopen, FCGI_fclose, FCGI_fflush, FCGI_freopen --
290 * Wrappers for functions defined in H&S Section 15.2
292 *----------------------------------------------------------------------
295 FCGI_FILE *FCGI_fopen(const char *path, const char *mode)
297 return FCGI_OpenFromFILE(fopen(path, mode));
300 int FCGI_fclose(FCGI_FILE *fp)
303 if(fp->stdio_stream) {
304 n = fclose(fp->stdio_stream);
305 fp->stdio_stream = NULL;
306 } else if(fp->fcgx_stream) {
307 n = FCGX_FClose(fp->fcgx_stream);
308 fp->fcgx_stream = NULL;
310 if((fp != FCGI_stdin) && (fp != FCGI_stdout) && (fp != FCGI_stderr)) {
316 int FCGI_fflush(FCGI_FILE *fp)
319 return fflush(NULL);
\r
321 return fflush(fp->stdio_stream);
322 else if(fp->fcgx_stream)
323 return FCGX_FFlush(fp->fcgx_stream);
327 FCGI_FILE *FCGI_freopen(const char *path, const char *mode,
330 if(fp->stdio_stream) {
331 if(freopen(path, mode, fp->stdio_stream) == NULL)
335 } else if(fp->fcgx_stream) {
336 (void) FCGX_FClose(fp->fcgx_stream);
337 fp->stdio_stream = fopen(path, mode);
338 if(fp->stdio_stream == NULL)
341 fp->fcgx_stream = NULL;
349 *----------------------------------------------------------------------
351 * FCGI_setvbuf, FCGI_setbuf --
353 * Wrappers for functions defined in H&S Section 15.3
355 *----------------------------------------------------------------------
357 int FCGI_setvbuf(FCGI_FILE *fp, char *buf, int bufmode, size_t size)
360 return setvbuf(fp->stdio_stream, buf, bufmode, size);
366 void FCGI_setbuf(FCGI_FILE *fp, char *buf)
369 setbuf(fp->stdio_stream, buf);
373 *----------------------------------------------------------------------
375 * FCGI_fseek, FCGI_ftell, FCGI_rewind, FCGI_fgetpos, FCGI_fsetpos --
377 * Wrappers for functions defined in H&S Section 15.5
379 *----------------------------------------------------------------------
382 int FCGI_fseek(FCGI_FILE *fp, long offset, int whence)
385 return fseek(fp->stdio_stream, offset, whence);
392 int FCGI_ftell(FCGI_FILE *fp)
395 return ftell(fp->stdio_stream);
402 void FCGI_rewind(FCGI_FILE *fp)
405 rewind(fp->stdio_stream);
411 int FCGI_fgetpos(FCGI_FILE *fp, fpos_t *pos)
414 return fgetpos(fp->stdio_stream, pos);
421 int FCGI_fsetpos(FCGI_FILE *fp, const fpos_t *pos)
424 return fsetpos(fp->stdio_stream, pos);
433 *----------------------------------------------------------------------
435 * FCGI_fgetc, FCGI_getchar, FCGI_ungetc --
437 * Wrappers for functions defined in H&S Section 15.6
439 * XXX: getc and getchar are generally defined as macros
440 * for performance reasons
442 *----------------------------------------------------------------------
445 int FCGI_fgetc(FCGI_FILE *fp)
448 return fgetc(fp->stdio_stream);
449 else if(fp->fcgx_stream)
450 return FCGX_GetChar(fp->fcgx_stream);
454 int FCGI_getchar(void)
456 return FCGI_fgetc(FCGI_stdin);
459 int FCGI_ungetc(int c, FCGI_FILE *fp)
462 return ungetc(c, fp->stdio_stream);
463 else if(fp->fcgx_stream)
464 return FCGX_UnGetChar(c, fp->fcgx_stream);
469 *----------------------------------------------------------------------
471 * FCGI_fgets, FCGI_gets --
473 * Wrappers for functions defined in H&S Section 15.7
475 *----------------------------------------------------------------------
478 char *FCGI_fgets(char *str, int size, FCGI_FILE *fp)
481 return fgets(str, size, fp->stdio_stream);
482 else if(fp->fcgx_stream)
483 return FCGX_GetLine(str, size, fp->fcgx_stream);
488 * There is no standard equivalent of gets that takes an explicit
489 * FILE * argument, so the following "wrapper" implements
490 * gets for both FILE * and FCGX_Stream * in terms of FCGI_getchar.
493 char *FCGI_gets(char *str)
497 for (s = str; ((c = FCGI_getchar()) != '\n');) {
511 *----------------------------------------------------------------------
515 * Wrappers for functions defined in H&S Section 15.8
517 * XXX: missing: fscanf, scanf
519 *----------------------------------------------------------------------
524 *----------------------------------------------------------------------
526 * FCGI_fputc, FCGI_putchar --
528 * Wrappers for functions defined in H&S Section 15.9
530 * XXX: putc and putchar are generally defined as macros
531 * for performance reasons
533 *----------------------------------------------------------------------
536 int FCGI_fputc(int c, FCGI_FILE *fp)
539 return fputc(c, fp->stdio_stream);
540 else if(fp->fcgx_stream)
541 return FCGX_PutChar(c, fp->fcgx_stream);
545 int FCGI_putchar(int c)
547 return FCGI_fputc(c, FCGI_stdout);
551 *----------------------------------------------------------------------
553 * FCGI_fputs, FCGI_puts
555 * Wrappers for functions defined in H&S Section 15.10
557 *----------------------------------------------------------------------
560 int FCGI_fputs(const char *str, FCGI_FILE *fp)
563 return fputs(str, fp->stdio_stream);
564 else if(fp->fcgx_stream)
565 return FCGX_PutS(str, fp->fcgx_stream);
569 int FCGI_puts(const char *str)
572 if(FCGI_stdout->stdio_stream) {
573 n = fputs(str, FCGI_stdout->stdio_stream);
577 return fputc('\n', FCGI_stdout->stdio_stream);
578 } else if(FCGI_stdout->fcgx_stream) {
579 n = FCGX_PutS(str, FCGI_stdout->fcgx_stream);
583 return FCGX_PutChar('\n', FCGI_stdout->fcgx_stream);
589 *----------------------------------------------------------------------
591 * FCGI_fprintf, FCGI_printf --
593 * Wrappers for functions defined in H&S Section 15.11
595 *----------------------------------------------------------------------
598 int FCGI_fprintf(FCGI_FILE *fp, const char *format, ...)
602 va_start(ap, format);
604 n = vfprintf(fp->stdio_stream, format, ap);
605 else if(fp->fcgx_stream)
606 n = FCGX_VFPrintF(fp->fcgx_stream, format, ap);
611 int FCGI_printf(const char *format, ...)
615 va_start(ap, format);
616 n = FCGI_vfprintf(FCGI_stdout, format, ap);
622 *----------------------------------------------------------------------
624 * FCGI_vfprintf, FCGI_vprintf --
626 * Wrappers for functions defined in H&S Section 15.12
628 *----------------------------------------------------------------------
631 int FCGI_vfprintf(FCGI_FILE *fp, const char *format, va_list ap)
634 return vfprintf(fp->stdio_stream, format, ap);
635 else if(fp->fcgx_stream)
636 return FCGX_VFPrintF(fp->fcgx_stream, format, ap);
640 int FCGI_vprintf(const char *format, va_list ap)
642 if(FCGI_stdout->stdio_stream)
643 return vfprintf(FCGI_stdout->stdio_stream, format, ap);
644 else if(FCGI_stdout->fcgx_stream)
645 return FCGX_VFPrintF(FCGI_stdout->fcgx_stream, format, ap);
650 *----------------------------------------------------------------------
652 * FCGI_fread, FCGI_fwrite --
654 * Wrappers for functions defined in H&S Section 15.13
656 *----------------------------------------------------------------------
659 size_t FCGI_fread(void *ptr, size_t size, size_t nmemb, FCGI_FILE *fp)
663 return fread(ptr, size, nmemb, fp->stdio_stream);
664 else if(fp->fcgx_stream) {
665 if((size * nmemb) == 0) {
668 n = FCGX_GetStr((char *) ptr, size * nmemb, fp->fcgx_stream);
674 size_t FCGI_fwrite(void *ptr, size_t size, size_t nmemb, FCGI_FILE *fp)
678 return fwrite(ptr, size, nmemb, fp->stdio_stream);
679 else if(fp->fcgx_stream) {
680 if((size * nmemb) == 0) {
683 n = FCGX_PutStr((char *) ptr, size * nmemb, fp->fcgx_stream);
690 *----------------------------------------------------------------------
692 * FCGI_feof, FCGI_ferror, FCGI_clearerr --
694 * Wrappers for functions defined in H&S Section 15.14
696 *----------------------------------------------------------------------
698 int FCGI_feof(FCGI_FILE *fp)
700 if(fp->stdio_stream) {
701 return feof(fp->stdio_stream);
702 } else if (fp->fcgx_stream){
703 return FCGX_HasSeenEOF(fp->fcgx_stream);
709 int FCGI_ferror(FCGI_FILE *fp)
711 if(fp->stdio_stream) {
712 return ferror(fp->stdio_stream);
713 } else if(fp->fcgx_stream) {
714 return FCGX_GetError(fp->fcgx_stream);
719 void FCGI_clearerr(FCGI_FILE *fp)
721 if(fp->stdio_stream) {
722 clearerr(fp->stdio_stream);
723 } else if(fp->fcgx_stream) {
724 FCGX_ClearError(fp->fcgx_stream);
730 *----------------------------------------------------------------------
734 * Wrappers for function defined in H&S Section 15.16
736 *----------------------------------------------------------------------
738 FCGI_FILE *FCGI_tmpfile(void)
740 return FCGI_OpenFromFile(tmpfile());
745 *----------------------------------------------------------------------
747 * FCGI_fileno, FCGI_fdopen, FCGI_popen, FCGI_pclose --
749 * Wrappers for POSIX, X/OPEN functions not in ISO C
751 *----------------------------------------------------------------------
755 * These definitions should be supplied by stdio.h but for some
756 * reason they get lost on certain platforms.
759 * XXX: Need to find the right way to handle this for NT
763 extern int fileno(FILE *stream);
765 extern FILE *fdopen(int fildes, const char *type);
766 extern FILE *popen(const char *command, const char *type);
767 extern int pclose(FILE *stream);
770 int FCGI_fileno(FCGI_FILE *fp)
773 return fileno(fp->stdio_stream);
778 FCGI_FILE *FCGI_fdopen(int fd, const char *mode)
781 return FCGI_OpenFromFILE(fdopen(fd, mode));
787 FCGI_FILE *FCGI_popen(const char *cmd, const char *type)
789 return FCGI_OpenFromFILE(popen(cmd, type));
792 int FCGI_pclose(FCGI_FILE *fp)
795 if(fp->stdio_stream) {
797 n = pclose(fp->stdio_stream);
799 fp->stdio_stream = NULL;
800 } else if(fp->fcgx_stream) {
802 * The caller is deeply confused; don't free the storage.
806 if((fp != FCGI_stdin) && (fp != FCGI_stdout) && (fp != FCGI_stderr)) {
813 *----------------------------------------------------------------------