forgot to add remote.PL to the repository
[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__
dd2ef7d9 15/* $Id: FCGI.PL,v 1.20 2000/11/14 23:15:20 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
dd2ef7d9 275 int was_bound;
b716743a 276 dTHX;
277
5baeeca7 278 if(!request->accepted) {
1b64d24d 279 return;
280 }
5baeeca7 281
dd2ef7d9 282 if (was_bound = request->bound) {
5baeeca7 283 FCGI_UndoBinding(request);
284 }
285#ifdef USE_SFIO
286 for (i = 0; i < 3; ++i) {
287 if (request->sfcreated[i]) {
288 sfclose(IoIFP(request->io[i]));
289 IoIFP(request->io[i]) = IoOFP(request->io[i]) = Nullfp;
290 request->sfcreated[i] = FALSE;
291 }
292 }
293#endif
dd2ef7d9 294 if (was_bound)
a635480d 295 FCGX_Finish_r(request->requestPtr);
296 else
297 FCGX_Free(request->requestPtr);
5baeeca7 298 request->accepted = FALSE;
1b64d24d 299}
300
301static int
90a18d65 302FCGI_StartFilterData(FCGP_Request* request)
303{
6ff77aff 304 return request->requestPtr->in ?
305 FCGX_StartFilterData(request->requestPtr->in) : -1;
90a18d65 306}
307
308static FCGP_Request *
6ff77aff 309FCGI_Request(in, out, err, env, socket, flags)
310 GV* in;
311 GV* out;
312 GV* err;
313 HV* env;
314 int socket;
315 int flags;
1b64d24d 316{
90a18d65 317 FCGX_Request* fcgx_req;
318 FCGP_Request* req;
319
320 Newz(551, fcgx_req, 1, FCGX_Request);
6ff77aff 321 FCGX_InitRequest(fcgx_req, socket, flags);
90a18d65 322 Newz(551, req, 1, FCGP_Request);
323 req->requestPtr = fcgx_req;
6ff77aff 324 req->gv[0] = in;
325 req->gv[1] = out;
326 req->gv[2] = err;
327 req->hvEnv = env;
90a18d65 328
329 return req;
1b64d24d 330}
331
332static void
90a18d65 333FCGI_Release_Request(FCGP_Request *req)
1b64d24d 334{
6ff77aff 335 FCGI_Finish(req);
90a18d65 336 Safefree(req->requestPtr);
337 Safefree(req);
1b64d24d 338}
339
34bfd355 340static void
b716743a 341FCGI_Init()
34bfd355 342{
b716743a 343#if defined(USE_LOCKING) && defined(USE_THREADS)
344 dTHX;
34bfd355 345
b716743a 346 MUTEX_INIT(&accept_mutex);
347#endif
e40fb02c 348
349 FCGX_Init();
34bfd355 350}
351
eede4b76 352typedef FCGX_Stream * FCGI__Stream;
353typedef FCGP_Request * FCGI;
d8cc97fb 354typedef GV* GLOBREF;
355typedef HV* HASHREF;
1b64d24d 356
1d209997 357MODULE = FCGI PACKAGE = FCGI PREFIX = FCGI_
1b64d24d 358
b716743a 359BOOT:
360 FCGI_Init();
eede4b76 361
362SV *
6ff77aff 363RequestX(in, out, err, env, socket, flags)
364 GLOBREF in;
365 GLOBREF out;
366 GLOBREF err;
367 HASHREF env;
368 int socket;
369 int flags;
eede4b76 370
6ff77aff 371 PROTOTYPE: ***$$$
eede4b76 372 CODE:
6ff77aff 373 RETVAL = sv_setref_pv(newSV(0), "FCGI",
374 FCGI_Request(in, out, err, env, socket, flags));
eede4b76 375
376 OUTPUT:
377 RETVAL
378
6b312a77 379int
380OpenSocket(path, backlog)
381 char* path;
382 int backlog;
383
384 PROTOTYPE: $$
385 CODE:
386 RETVAL = FCGX_OpenSocket(path, backlog);
387 OUTPUT:
388 RETVAL
389
390void
391CloseSocket(socket)
392 int socket;
393
394 PROTOTYPE: $
395 CODE:
396 close(socket);
eede4b76 397
398int
1d209997 399FCGI_Accept(request)
eede4b76 400
d8cc97fb 401 FCGI request;
eede4b76 402
6ff77aff 403 PROTOTYPE: $
eede4b76 404
eede4b76 405void
1d209997 406FCGI_Finish(request)
d8cc97fb 407 FCGI request;
eede4b76 408
d8cc97fb 409 PROTOTYPE: $
eede4b76 410
eede4b76 411void
1d209997 412FCGI_Flush(request)
d8cc97fb 413 FCGI request;
eede4b76 414
d8cc97fb 415 PROTOTYPE: $
eede4b76 416
9915cd6d 417HV *
418GetEnvironment(request)
419 FCGI request;
420
421 PROTOTYPE: $
422
423 CODE:
424 RETVAL = request->hvEnv;
425
426 OUTPUT:
427 RETVAL
428
429void
430GetHandles(request)
431 FCGI request;
432
433 PROTOTYPE: $
434
435 PREINIT:
436 int i;
437
438 PPCODE:
439 EXTEND(sp,3);
440 for (i = 0; i < 3; ++i)
1d209997 441 PUSHs(sv_2mortal(newRV((SV *) request->gv[i])));
442
443int
444FCGI_IsFastCGI(request)
445 FCGI request;
446
447 PROTOTYPE: $
9915cd6d 448
5baeeca7 449void
450Detach(request)
451
452 FCGI request;
453
454 PROTOTYPE: $
455
456 CODE:
457 if (request->accepted && request->bound)
458 FCGI_UndoBinding(request);
459
460void
461Attach(request)
462
463 FCGI request;
464
465 PROTOTYPE: $
466
467 CODE:
468 if (request->accepted && !request->bound)
469 FCGI_Bind(request);
470
eede4b76 471
472int
1d209997 473FCGI_StartFilterData(request)
eede4b76 474
d8cc97fb 475 FCGI request;
eede4b76 476
d8cc97fb 477 PROTOTYPE: $
eede4b76 478
eede4b76 479void
480DESTROY(request)
481 FCGI request;
482
483 CODE:
484 FCGI_Release_Request(request);
485
486
487
488MODULE = FCGI PACKAGE = FCGI::Stream
90a18d65 489
1b64d24d 490#ifndef USE_SFIO
1b64d24d 491
492void
493PRINT(stream, ...)
eede4b76 494 FCGI::Stream stream;
1b64d24d 495
496 PREINIT:
497 int n;
498
499 CODE:
500 for (n = 1; n < items; ++n) {
501 STRLEN len;
502 register char *tmps = (char *)SvPV(ST(n),len);
503 FCGX_PutStr(tmps, len, stream);
504 }
505 if (SvTRUEx(perl_get_sv("|", FALSE)))
506 FCGX_FFlush(stream);
507
508int
509WRITE(stream, bufsv, len, ...)
eede4b76 510 FCGI::Stream stream;
1b64d24d 511 SV * bufsv;
512 int len;
513
514 PREINIT:
515 int offset;
516 char * buf;
517 STRLEN blen;
518 int n;
519
520 CODE:
521 offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
522 buf = SvPV(bufsv, blen);
523 if (offset < 0) offset += blen;
524 if (len > blen - offset)
525 len = blen - offset;
526 if (offset < 0 || offset >= blen ||
527 (n = FCGX_PutStr(buf+offset, len, stream)) < 0)
528 ST(0) = &PL_sv_undef;
529 else {
530 ST(0) = sv_newmortal();
531 sv_setpvf(ST(0), "%c", n);
532 }
533
534int
535READ(stream, bufsv, len, ...)
eede4b76 536 FCGI::Stream stream;
1b64d24d 537 SV * bufsv;
538 int len;
539
540 PREINIT:
541 int offset;
542 char * buf;
543
544 CODE:
545 offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
546 if (! SvOK(bufsv))
547 sv_setpvn(bufsv, "", 0);
548 buf = SvGROW(bufsv, len+offset+1);
549 len = FCGX_GetStr(buf+offset, len, stream);
550 SvCUR_set(bufsv, len+offset);
551 *SvEND(bufsv) = '\0';
552 (void)SvPOK_only(bufsv);
553 SvSETMAGIC(bufsv);
554 RETVAL = len;
555
556 OUTPUT:
557 RETVAL
558
559SV *
560GETC(stream)
eede4b76 561 FCGI::Stream stream;
1b64d24d 562
563 PREINIT:
564 int retval;
565
566 CODE:
567 if ((retval = FCGX_GetChar(stream)) != -1) {
568 ST(0) = sv_newmortal();
569 sv_setpvf(ST(0), "%c", retval);
570 } else ST(0) = &PL_sv_undef;
571
572bool
573CLOSE(stream)
eede4b76 574 FCGI::Stream stream;
1b64d24d 575
5baeeca7 576# ALIAS:
577# DESTROY = 1
1b64d24d 578
579 CODE:
580 RETVAL = FCGX_FClose(stream) != -1;
581
582 OUTPUT:
583 RETVAL
584
585#endif