0.57 release
[catagits/fcgi2.git] / perl / FCGI.PL
CommitLineData
1b64d24d 1use Config;
2
3open OUT, ">FCGI.xs";
4
5print "Generating FCGI.xs for Perl version $]\n";
6#unless (exists $Config{apiversion} && $Config{apiversion} >= 5.005)
7unless ($] >= 5.005) {
8 for (qw(sv_undef diehook warnhook in_eval)) {
9 print OUT "#define PL_$_ $_\n"
10 }
11}
12print OUT while <DATA>;
13close OUT;
14__END__
a635480d 15/* $Id: FCGI.PL,v 1.19 2000/11/05 19:11:58 skimo Exp $ */
1b64d24d 16
17#include "EXTERN.h"
18#include "perl.h"
19#include "XSUB.h"
20
b716743a 21#include "fcgi_config.h"
1b64d24d 22#include "fcgiapp.h"
5baeeca7 23#include "fastcgi.h"
1b64d24d 24
25#ifndef FALSE
26#define FALSE (0)
27#endif
28
29#ifndef TRUE
30#define TRUE (1)
31#endif
32
b716743a 33#ifndef dTHX
34#define dTHX
35#endif
36
1b64d24d 37#ifdef USE_SFIO
38typedef struct
39{
40 Sfdisc_t disc;
41 FCGX_Stream *stream;
42} FCGI_Disc;
43
44static ssize_t
45sffcgiread(f, buf, n, disc)
46Sfio_t* f; /* stream involved */
47Void_t* buf; /* buffer to read into */
48size_t n; /* number of bytes to read */
49Sfdisc_t* disc; /* discipline */
50{
51 return FCGX_GetStr(buf, n, ((FCGI_Disc *)disc)->stream);
52}
53
54static ssize_t
55sffcgiwrite(f, buf, n, disc)
56Sfio_t* f; /* stream involved */
57const Void_t* buf; /* buffer to read into */
58size_t n; /* number of bytes to read */
59Sfdisc_t* disc; /* discipline */
60{
61 n = FCGX_PutStr(buf, n, ((FCGI_Disc *)disc)->stream);
62 FCGX_FFlush(((FCGI_Disc *)disc)->stream);
63 return n;
64}
65
66Sfdisc_t *
67sfdcnewfcgi(stream)
68 FCGX_Stream *stream;
69{
70 FCGI_Disc* disc;
71
72 New(1000,disc,1,FCGI_Disc);
73 if (!disc) return (Sfdisc_t *)disc;
74
75 disc->disc.exceptf = (Sfexcept_f)NULL;
76 disc->disc.seekf = (Sfseek_f)NULL;
77 disc->disc.readf = sffcgiread;
78 disc->disc.writef = sffcgiwrite;
79 disc->stream = stream;
80 return (Sfdisc_t *)disc;
81}
82
83Sfdisc_t *
84sfdcdelfcgi(disc)
85 Sfdisc_t* disc;
86{
87 Safefree(disc);
88 return 0;
89}
90#endif
91
b716743a 92#if defined(USE_LOCKING) && defined(USE_THREADS)
93static perl_mutex accept_mutex;
94#endif
95
90a18d65 96typedef struct FCGP_Request {
5baeeca7 97 int accepted;
b716743a 98 int bound;
90a18d65 99 SV* svin;
100 SV* svout;
101 SV* sverr;
eede4b76 102 GV* gv[3];
34bfd355 103 HV* hvEnv;
90a18d65 104 FCGX_Request* requestPtr;
2c38ecd7 105#ifdef USE_SFIO
106 int sfcreated[3];
5baeeca7 107 IO* io[3];
2c38ecd7 108#endif
90a18d65 109} FCGP_Request;
110
5baeeca7 111static void FCGI_Finish(FCGP_Request* request);
112
1b64d24d 113static int
90a18d65 114FCGI_Flush(FCGP_Request* request)
1b64d24d 115{
b716743a 116 dTHX;
117
118 if(!request->bound) {
1b64d24d 119 return;
120 }
121#ifdef USE_SFIO
2c38ecd7 122 sfsync(IoOFP(GvIOp(request->gv[1])));
123 sfsync(IoOFP(GvIOp(request->gv[2])));
1b64d24d 124#else
90a18d65 125 FCGX_FFlush((FCGX_Stream *) SvIV((SV*) SvRV(request->svout)));
126 FCGX_FFlush((FCGX_Stream *) SvIV((SV*) SvRV(request->sverr)));
1b64d24d 127#endif
128}
129
34bfd355 130static void
131FCGI_UndoBinding(FCGP_Request* request)
132{
b716743a 133 dTHX;
2c38ecd7 134
135#ifdef USE_SFIO
5baeeca7 136 sfdcdelfcgi(sfdisc(IoIFP(request->io[0]), SF_POPDISC));
137 sfdcdelfcgi(sfdisc(IoOFP(request->io[1]), SF_POPDISC));
138 sfdcdelfcgi(sfdisc(IoOFP(request->io[2]), SF_POPDISC));
34bfd355 139#else
34bfd355 140 sv_unmagic((SV *)request->gv[0], 'q');
141 sv_unmagic((SV *)request->gv[1], 'q');
142 sv_unmagic((SV *)request->gv[2], 'q');
143#endif
b716743a 144 request->bound = FALSE;
145}
146
147static void
5baeeca7 148FCGI_Bind(FCGP_Request* request)
149{
150 dTHX;
151
152#ifdef USE_SFIO
37a69de1 153 sfdisc(IoIFP(request->io[0]), sfdcnewfcgi(request->requestPtr->in));
154 sfdisc(IoOFP(request->io[1]), sfdcnewfcgi(request->requestPtr->out));
155 sfdisc(IoOFP(request->io[2]), sfdcnewfcgi(request->requestPtr->err));
5baeeca7 156#else
157 sv_magic((SV *)request->gv[1], request->svout, 'q', Nullch, 0);
158 sv_magic((SV *)request->gv[2], request->sverr, 'q', Nullch, 0);
159 sv_magic((SV *)request->gv[0], request->svin, 'q', Nullch, 0);
160#endif
161 request->bound = TRUE;
162}
163
164static void
b716743a 165populate_env(envp, hv)
166char **envp;
167HV *hv;
168{
169 int i;
170 char *p, *p1;
171 SV *sv;
172 dTHX;
173
6ff77aff 174 hv_clear(hv);
b716743a 175 for(i = 0; ; i++) {
176 if((p = envp[i]) == NULL) {
177 break;
178 }
179 p1 = strchr(p, '=');
180 assert(p1 != NULL);
181 sv = newSVpv(p1 + 1, 0);
182 /* call magic for this value ourselves */
183 hv_store(hv, p, p1 - p, sv, 0);
184 SvSETMAGIC(sv);
185 }
34bfd355 186}
187
1d209997 188static int
189FCGI_IsFastCGI(FCGP_Request* request)
1b64d24d 190{
e40fb02c 191 static int isCGI = -1; /* -1: not checked; 0: FCGI; 1: CGI */
5baeeca7 192
1d209997 193 if (request->requestPtr->listen_sock == FCGI_LISTENSOCK_FILENO) {
194 if (isCGI == -1)
195 isCGI = FCGX_IsCGI();
196 return !isCGI;
197 }
198
199 /* A explicit socket is being used -> assume FastCGI */
200 return 1;
201}
5baeeca7 202
1d209997 203static int
204FCGI_Accept(FCGP_Request* request)
205{
794c66be 206 dTHX;
207
1d209997 208 if (!FCGI_IsFastCGI(request)) {
209 static int been_here = 0;
210
1b64d24d 211 /*
212 * Not first call to FCGI_Accept and running as CGI means
213 * application is done.
214 */
1d209997 215 if (been_here)
216 return EOF;
217
218 been_here = 1;
219 } else {
37a69de1 220#ifdef USE_SFIO
221 int i;
222#endif
6ff77aff 223 FCGX_Request *fcgx_req = request->requestPtr;
b716743a 224 int acceptResult;
225
5baeeca7 226 FCGI_Finish(request);
b716743a 227#if defined(USE_LOCKING) && defined(USE_THREADS)
228 MUTEX_LOCK(&accept_mutex);
229#endif
6ff77aff 230 acceptResult = FCGX_Accept_r(fcgx_req);
b716743a 231#if defined(USE_LOCKING) && defined(USE_THREADS)
232 MUTEX_UNLOCK(&accept_mutex);
233#endif
1b64d24d 234 if(acceptResult < 0) {
235 return acceptResult;
236 }
d8cc97fb 237
6ff77aff 238 populate_env(fcgx_req->envp, request->hvEnv);
d8cc97fb 239
1b64d24d 240#ifdef USE_SFIO
2c38ecd7 241 for (i = 0; i < 3; ++i) {
5baeeca7 242 request->io[i] = GvIOn(request->gv[i]);
243 if (!(i == 0 ? IoIFP(request->io[i])
244 : IoOFP(request->io[i]))) {
245 IoIFP(request->io[i]) = sftmp(0);
246 /*IoIFP(request->io[i]) = sfnew(NULL, NULL, SF_UNBOUND, 0,
2c38ecd7 247 SF_STRING | (i ? SF_WRITE : SF_READ));*/
5baeeca7 248 if (i != 0)
249 IoOFP(request->io[i]) = IoIFP(request->io[i]);
2c38ecd7 250 request->sfcreated[i] = TRUE;
251 }
252 }
1b64d24d 253#else
90a18d65 254 if (!request->svout) {
eede4b76 255 newSVrv(request->svout = newSV(0), "FCGI::Stream");
eede4b76 256 newSVrv(request->sverr = newSV(0), "FCGI::Stream");
eede4b76 257 newSVrv(request->svin = newSV(0), "FCGI::Stream");
1b64d24d 258 }
6ff77aff 259 sv_setiv(SvRV(request->svout), (IV) fcgx_req->out);
260 sv_setiv(SvRV(request->sverr), (IV) fcgx_req->err);
261 sv_setiv(SvRV(request->svin), (IV) fcgx_req->in);
1b64d24d 262#endif
5baeeca7 263 FCGI_Bind(request);
264 request->accepted = TRUE;
1b64d24d 265 }
1b64d24d 266 return 0;
267}
268
269static void
90a18d65 270FCGI_Finish(FCGP_Request* request)
1b64d24d 271{
37a69de1 272#ifdef USE_SFIO
273 int i;
274#endif
b716743a 275 dTHX;
276
5baeeca7 277 if(!request->accepted) {
1b64d24d 278 return;
279 }
5baeeca7 280
281 if (request->bound) {
282 FCGI_UndoBinding(request);
283 }
284#ifdef USE_SFIO
285 for (i = 0; i < 3; ++i) {
286 if (request->sfcreated[i]) {
287 sfclose(IoIFP(request->io[i]));
288 IoIFP(request->io[i]) = IoOFP(request->io[i]) = Nullfp;
289 request->sfcreated[i] = FALSE;
290 }
291 }
292#endif
a635480d 293 if (request->bound)
294 FCGX_Finish_r(request->requestPtr);
295 else
296 FCGX_Free(request->requestPtr);
5baeeca7 297 request->accepted = FALSE;
1b64d24d 298}
299
300static int
90a18d65 301FCGI_StartFilterData(FCGP_Request* request)
302{
6ff77aff 303 return request->requestPtr->in ?
304 FCGX_StartFilterData(request->requestPtr->in) : -1;
90a18d65 305}
306
307static FCGP_Request *
6ff77aff 308FCGI_Request(in, out, err, env, socket, flags)
309 GV* in;
310 GV* out;
311 GV* err;
312 HV* env;
313 int socket;
314 int flags;
1b64d24d 315{
90a18d65 316 FCGX_Request* fcgx_req;
317 FCGP_Request* req;
318
319 Newz(551, fcgx_req, 1, FCGX_Request);
6ff77aff 320 FCGX_InitRequest(fcgx_req, socket, flags);
90a18d65 321 Newz(551, req, 1, FCGP_Request);
322 req->requestPtr = fcgx_req;
6ff77aff 323 req->gv[0] = in;
324 req->gv[1] = out;
325 req->gv[2] = err;
326 req->hvEnv = env;
90a18d65 327
328 return req;
1b64d24d 329}
330
331static void
90a18d65 332FCGI_Release_Request(FCGP_Request *req)
1b64d24d 333{
6ff77aff 334 FCGI_Finish(req);
90a18d65 335 Safefree(req->requestPtr);
336 Safefree(req);
1b64d24d 337}
338
34bfd355 339static void
b716743a 340FCGI_Init()
34bfd355 341{
b716743a 342#if defined(USE_LOCKING) && defined(USE_THREADS)
343 dTHX;
34bfd355 344
b716743a 345 MUTEX_INIT(&accept_mutex);
346#endif
e40fb02c 347
348 FCGX_Init();
34bfd355 349}
350
eede4b76 351typedef FCGX_Stream * FCGI__Stream;
352typedef FCGP_Request * FCGI;
d8cc97fb 353typedef GV* GLOBREF;
354typedef HV* HASHREF;
1b64d24d 355
1d209997 356MODULE = FCGI PACKAGE = FCGI PREFIX = FCGI_
1b64d24d 357
b716743a 358BOOT:
359 FCGI_Init();
eede4b76 360
361SV *
6ff77aff 362RequestX(in, out, err, env, socket, flags)
363 GLOBREF in;
364 GLOBREF out;
365 GLOBREF err;
366 HASHREF env;
367 int socket;
368 int flags;
eede4b76 369
6ff77aff 370 PROTOTYPE: ***$$$
eede4b76 371 CODE:
6ff77aff 372 RETVAL = sv_setref_pv(newSV(0), "FCGI",
373 FCGI_Request(in, out, err, env, socket, flags));
eede4b76 374
375 OUTPUT:
376 RETVAL
377
6b312a77 378int
379OpenSocket(path, backlog)
380 char* path;
381 int backlog;
382
383 PROTOTYPE: $$
384 CODE:
385 RETVAL = FCGX_OpenSocket(path, backlog);
386 OUTPUT:
387 RETVAL
388
389void
390CloseSocket(socket)
391 int socket;
392
393 PROTOTYPE: $
394 CODE:
395 close(socket);
eede4b76 396
397int
1d209997 398FCGI_Accept(request)
eede4b76 399
d8cc97fb 400 FCGI request;
eede4b76 401
6ff77aff 402 PROTOTYPE: $
eede4b76 403
eede4b76 404void
1d209997 405FCGI_Finish(request)
d8cc97fb 406 FCGI request;
eede4b76 407
d8cc97fb 408 PROTOTYPE: $
eede4b76 409
eede4b76 410void
1d209997 411FCGI_Flush(request)
d8cc97fb 412 FCGI request;
eede4b76 413
d8cc97fb 414 PROTOTYPE: $
eede4b76 415
9915cd6d 416HV *
417GetEnvironment(request)
418 FCGI request;
419
420 PROTOTYPE: $
421
422 CODE:
423 RETVAL = request->hvEnv;
424
425 OUTPUT:
426 RETVAL
427
428void
429GetHandles(request)
430 FCGI request;
431
432 PROTOTYPE: $
433
434 PREINIT:
435 int i;
436
437 PPCODE:
438 EXTEND(sp,3);
439 for (i = 0; i < 3; ++i)
1d209997 440 PUSHs(sv_2mortal(newRV((SV *) request->gv[i])));
441
442int
443FCGI_IsFastCGI(request)
444 FCGI request;
445
446 PROTOTYPE: $
9915cd6d 447
5baeeca7 448void
449Detach(request)
450
451 FCGI request;
452
453 PROTOTYPE: $
454
455 CODE:
456 if (request->accepted && request->bound)
457 FCGI_UndoBinding(request);
458
459void
460Attach(request)
461
462 FCGI request;
463
464 PROTOTYPE: $
465
466 CODE:
467 if (request->accepted && !request->bound)
468 FCGI_Bind(request);
469
eede4b76 470
471int
1d209997 472FCGI_StartFilterData(request)
eede4b76 473
d8cc97fb 474 FCGI request;
eede4b76 475
d8cc97fb 476 PROTOTYPE: $
eede4b76 477
eede4b76 478void
479DESTROY(request)
480 FCGI request;
481
482 CODE:
483 FCGI_Release_Request(request);
484
485
486
487MODULE = FCGI PACKAGE = FCGI::Stream
90a18d65 488
1b64d24d 489#ifndef USE_SFIO
1b64d24d 490
491void
492PRINT(stream, ...)
eede4b76 493 FCGI::Stream stream;
1b64d24d 494
495 PREINIT:
496 int n;
497
498 CODE:
499 for (n = 1; n < items; ++n) {
500 STRLEN len;
501 register char *tmps = (char *)SvPV(ST(n),len);
502 FCGX_PutStr(tmps, len, stream);
503 }
504 if (SvTRUEx(perl_get_sv("|", FALSE)))
505 FCGX_FFlush(stream);
506
507int
508WRITE(stream, bufsv, len, ...)
eede4b76 509 FCGI::Stream stream;
1b64d24d 510 SV * bufsv;
511 int len;
512
513 PREINIT:
514 int offset;
515 char * buf;
516 STRLEN blen;
517 int n;
518
519 CODE:
520 offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
521 buf = SvPV(bufsv, blen);
522 if (offset < 0) offset += blen;
523 if (len > blen - offset)
524 len = blen - offset;
525 if (offset < 0 || offset >= blen ||
526 (n = FCGX_PutStr(buf+offset, len, stream)) < 0)
527 ST(0) = &PL_sv_undef;
528 else {
529 ST(0) = sv_newmortal();
530 sv_setpvf(ST(0), "%c", n);
531 }
532
533int
534READ(stream, bufsv, len, ...)
eede4b76 535 FCGI::Stream stream;
1b64d24d 536 SV * bufsv;
537 int len;
538
539 PREINIT:
540 int offset;
541 char * buf;
542
543 CODE:
544 offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
545 if (! SvOK(bufsv))
546 sv_setpvn(bufsv, "", 0);
547 buf = SvGROW(bufsv, len+offset+1);
548 len = FCGX_GetStr(buf+offset, len, stream);
549 SvCUR_set(bufsv, len+offset);
550 *SvEND(bufsv) = '\0';
551 (void)SvPOK_only(bufsv);
552 SvSETMAGIC(bufsv);
553 RETVAL = len;
554
555 OUTPUT:
556 RETVAL
557
558SV *
559GETC(stream)
eede4b76 560 FCGI::Stream stream;
1b64d24d 561
562 PREINIT:
563 int retval;
564
565 CODE:
566 if ((retval = FCGX_GetChar(stream)) != -1) {
567 ST(0) = sv_newmortal();
568 sv_setpvf(ST(0), "%c", retval);
569 } else ST(0) = &PL_sv_undef;
570
571bool
572CLOSE(stream)
eede4b76 573 FCGI::Stream stream;
1b64d24d 574
5baeeca7 575# ALIAS:
576# DESTROY = 1
1b64d24d 577
578 CODE:
579 RETVAL = FCGX_FClose(stream) != -1;
580
581 OUTPUT:
582 RETVAL
583
584#endif