3 do 'FCGI.cfg' or die "no FCGI.cfg";
7 print "Generating FCGI.pm\n";
9 # $Id: FCGI.PL,v 1.23 2001/03/27 11:49:11 skimo Exp $
16 @ISA = qw(Exporter DynaLoader);
17 # Items to export into callers namespace by default. Note: do not export
18 # names by default without a very good reason. Use EXPORT_OK instead.
19 # Do not simply export all your public functions/methods/constants.
28 print OUT "bootstrap FCGI;\n" unless ($pure);
30 print OUT <<'EOP' if ($pure);
34 use constant VERSION_1 => 1;
36 use constant BEGIN_REQUEST => 1;
37 use constant PARAMS => 4;
38 use constant FCGI_STDIN => 5;
39 use constant FCGI_STDOUT => 6;
40 use constant FCGI_STDERR => 7;
42 use constant RESPONDER => 1;
43 use constant AUTHORIZER => 2;
44 use constant FILTER => 3;
46 %FCGI::rolenames = (RESPONDER, "RESPONDER",
47 AUTHORIZER, "AUTHORIZER",
53 (!defined getpeername shift->{listen_sock}) && $! == ENOTCONN
54 unless exists $req->{isfastcgi};
55 return $req->{isfastcgi};
61 return undef unless read $stream, $buf, 1, 0;
62 my ($len) = unpack("C", $buf);
64 return undef unless read $stream, $buf, 3, 1;
65 $len = unpack("N", $buf);
79 open $self->{listen_sock}, "<&=0";
88 unless ($req->IsFastCGI()) {
89 return -1 if $run_once;
95 $req->{socket} = gensym();
96 if (!accept($req->{socket}, $req->{listen_sock})) {
97 $req->{error} = "accept";
100 my ($type, $id, $body) = $req->read_record();
101 if ($type != BEGIN_REQUEST) {
102 $req->{error} = "begin request";
105 my ($role, $flags) = unpack("nC", $body);
106 $req->{role} = $role;
107 $req->{flags} = $flags;
111 $req->{env}{FCGI_ROLE} = $FCGI::rolenames{$req->{role}};
112 my $param = FCGI::Stream->new($req, PARAMS);
114 while (defined($nlen = read_nv_len($param)) &&
115 defined($vlen = read_nv_len($param))) {
117 read $param, $name, $nlen;
118 read $param, $val, $vlen;
119 $req->{env}{$name} = $val;
122 $req->{accepted} = 1;
130 untie ${$req->{out}};
131 untie ${$req->{err}};
137 tie ${$req->{in}}, 'FCGI::Stream', $req, FCGI_STDIN;
138 tie ${$req->{out}}, 'FCGI::Stream', $req, FCGI_STDOUT;
139 tie ${$req->{err}}, 'FCGI::Stream', $req, FCGI_STDERR;
145 $req->Bind() if ($req->{accepted} && !$req->{bound});
150 $req->UndoBindings() if ($req->{accepted} && $req->{bound});
155 return unless $req->{accepted};
157 $req->UndoBindings();
158 close ${$req->{out}};
159 close ${$req->{err}};
161 $req->{accepted} = 0;
172 read($self->{socket}, $header, 8);
173 my ($version, $type, $id, $clen, $plen) = unpack("CCnnC", $header);
174 read($self->{socket}, $body, $clen+$plen);
175 $body = undef if $clen == 0;
180 my ($self, $rtype, $len) = @_;
181 while (length $self->{buf} < $len) {
182 my ($type, $id, $buf) = $self->read_record();
183 return undef unless defined $buf;
184 if ($type != $rtype) {
185 $self->{error} = "unexpected stream type";
188 $self->{buf} .= $buf;
190 my ($newbuf, $result) = (substr($self->{buf}, $len),
191 substr($self->{buf}, 0, $len));
192 $self->{buf} = $newbuf;
201 my ($self, $type, $content, $len) = @_;
202 return unless $len > 0;
203 $self->write_record($type, $content, $len);
207 my ($self, $type, $content, $len) = @_;
208 my $padlen = (8 - ($len % 8)) % 8;
209 my $templ = "CCnnCxa${len}x$padlen";
210 my $data = pack($templ,
211 VERSION_1, $type, $self->{id}, $len, $padlen, $content);
212 syswrite $self->{socket}, $data;
215 { package FCGI::Stream;
218 my ($class, $src, $type) = @_;
219 my $handle = do { \local *FH };
220 tie($$handle, $class, $src, $type);
225 my ($class, $src, $type) = @_;
226 bless { src => $src, type => $type }, $class;
230 my ($stream, undef, $len, $offset) = @_;
232 my $buf = $stream->{src}->read($stream->{type}, $len);
233 return undef unless defined $buf;
234 substr($$ref, $offset, 0, $buf);
239 my ($stream) = shift;
241 $stream->{src}->write($stream->{type}, $_, length($_));
247 $stream->{src}->write_record($stream->{type}, undef, 0);
253 print OUT while <DATA>;
257 # Preloaded methods go here.
259 # Autoload methods go after __END__, and are processed by the autosplit program.
261 *FAIL_ACCEPT_ON_INTR = sub() { 1 };
263 sub Request(;***$$$) {
264 my @defaults = (\*STDIN, \*STDOUT, \*STDERR, \%ENV, 0, 0);
265 splice @defaults,0,@_,@_;
270 warn "accept called as a method; you probably wanted to call Accept" if @_;
271 if (defined %FCGI::ENV) {
276 my $rc = Accept($global_request);
277 for (keys %FCGI::ENV) {
278 $ENV{$_} = $FCGI::ENV{$_} unless exists $ENV{$_};
282 $SIG{__WARN__} = $warn_handler if (tied (*STDIN));
283 $SIG{__DIE__} = $die_handler if (tied (*STDIN));
289 warn "finish called as a method; you probably wanted to call Finish" if @_;
290 %ENV = %FCGI::ENV if (defined %FCGI::ENV);
294 delete $SIG{__WARN__} if ($SIG{__WARN__} == $warn_handler);
295 delete $SIG{__DIE__} if ($SIG{__DIE__} == $die_handler);
298 Finish ($global_request);
302 warn "flush called as a method; you probably wanted to call Flush" if @_;
303 Flush($global_request);
307 warn "detach called as a method; you probably wanted to call Detach" if @_;
308 Detach($global_request);
312 warn "attach called as a method; you probably wanted to call Attach" if @_;
313 Attach($global_request);
317 sub set_exit_status {
320 sub start_filter_data() {
321 StartFilterData($global_request);
324 $global_request = Request();
325 $warn_handler = sub { print STDERR @_ };
326 $die_handler = sub { print STDERR @_ unless $^S };
328 package FCGI::Stream;
331 shift->PRINT(sprintf(shift, @_));
340 my $rs = $/ eq '' ? "\n\n" : $/;
341 my $l = substr $rs, -1;
342 my $len = length $rs;
344 $c = $stream->GETC();
347 $c = $stream->GETC();
352 last if $c eq $l and substr($s, -$len) eq $rs;
353 $c = $stream->GETC();
361 return open($_[0], $_[1]);
364 eval("$rc = open($_[0], $_[1], $_[2])");
376 FCGI - Fast CGI module
383 my $request = FCGI::Request();
385 while($request->Accept() >= 0) {
386 print("Content-type: text/html\r\n\r\n", ++$count);
397 Creates a request handle. It has the following optional parameters:
401 =item input perl file handle (default: \*STDIN)
403 =item output perl file handle (default: \*STDOUT)
405 =item error perl file handle (default: \*STDERR)
407 These filehandles will be setup to act as input/output/error
410 =item environment hash reference (default: \%ENV)
412 The hash will be populated with the environment.
414 =item socket (default: 0)
416 Socket to communicate with the server.
417 Can be the result of the OpenSocket function.
418 For the moment, it's the file descriptor of the socket
419 that should be passed. This may change in the future.
421 =item flags (default: 0)
427 =item FCGI::FAIL_ACCEPT_ON_INTR
429 If set, Accept will fail if interrupted.
430 It not set, it will just keep on waiting.
437 my $req = FCGI::Request;
441 my $in = new IO::Handle;
442 my $out = new IO::Handle;
443 my $err = new IO::Handle;
444 my $req = FCGI::Request($in, $out, $err, \%env);
446 =item FCGI::OpenSocket(path, backlog)
448 Creates a socket suitable to use as an argument to Request.
454 Pathname of socket or colon followed by local tcp port.
455 Note that some systems take file permissions into account
456 on Unix domain sockets, so you'll have to make sure that
457 the server can write to the created file, by changing
458 the umask before the call and/or changing permissions and/or
459 group of the file afterwards.
463 Maximum length of the queue of pending connections.
465 request arrives with the queue full the client may receive
466 an error with an indication of ECONNREFUSED.
470 =item FCGI::CloseSocket(socket)
472 Close a socket opened with OpenSocket.
476 Accepts a connection on $req, attaching the filehandles and
477 populating the environment hash.
478 Returns 0 on success.
479 If a connection has been accepted before, the old
480 one will be finished first.
482 Note that unlike with the old interface, no die and warn
483 handlers are installed by default. This means that if
484 you are not running an sfio enabled perl, any warn or
485 die message will not end up in the server's log by default.
486 It is advised you set up die and warn handlers yourself.
487 FCGI.pm contains an example of die and warn handlers.
491 Finishes accepted connection.
492 Also detaches filehandles.
496 Flushes accepted connection.
500 Temporarily detaches filehandles on an accepted connection.
504 Re-attaches filehandles on an accepted connection.
506 =item $env = $req->GetEnvironment()
508 Returns the environment parameter passed to FCGI::Request.
510 =item ($in, $out, $err) = $req->GetHandles()
512 Returns the file handle parameters passed to FCGI::Request.
514 =item $isfcgi = $req->IsFastCGI()
516 Returns whether or not the program was run as a FastCGI.
522 Sven Verdoolaege <skimo@kotnet.org>