1 package Catalyst::Engine::HTTP;
4 extends 'Catalyst::Engine::CGI';
6 use Data::Dump qw(dump);
7 use Errno 'EWOULDBLOCK';
12 use IO::Socket::INET ();
16 require Catalyst::Engine::HTTP::Restarter;
17 require Catalyst::Engine::HTTP::Restarter::Watcher;
19 use constant CHUNKSIZE => 64 * 1024;
20 use constant DEBUG => $ENV{CATALYST_HTTP_DEBUG} || 0;
22 use namespace::clean -except => [qw/meta/];
26 Catalyst::Engine::HTTP - Catalyst HTTP Engine
30 A script using the Catalyst::Engine::HTTP module might look like:
34 BEGIN { $ENV{CATALYST_ENGINE} = 'HTTP' }
37 use lib '/path/to/MyApp/lib';
44 This is the Catalyst engine specialized for development and testing.
48 =head2 $self->finalize_headers($c)
52 sub finalize_headers {
53 my ( $self, $c ) = @_;
54 my $protocol = $c->request->protocol;
55 my $status = $c->response->status;
56 my $message = status_message($status);
57 my $res_headers = $c->response->headers;
60 push @headers, "$protocol $status $message";
62 $res_headers->header( Date => HTTP::Date::time2str(time) );
63 $res_headers->header( Status => $status );
65 # Should we keep the connection open?
66 my $connection = $c->request->header('Connection');
67 if ( $self->{options}->{keepalive}
69 && $connection =~ /^keep-alive$/i
71 $res_headers->header( Connection => 'keep-alive' );
72 $self->{_keepalive} = 1;
75 $res_headers->header( Connection => 'close' );
78 push @headers, $res_headers->as_string("\x0D\x0A");
80 # Buffer the headers so they are sent with the first write() call
81 # This reduces the number of TCP packets we are sending
82 $self->{_header_buf} = join("\x0D\x0A", @headers, '');
85 =head2 $self->finalize_read($c)
89 before finalize_read => sub {
90 # Never ever remove this, it would result in random length output
91 # streams if STDIN eq STDOUT (like in the HTTP engine)
95 =head2 $self->prepare_read($c)
99 before prepare_read => sub {
100 # Set the input handle to non-blocking
104 =head2 $self->read_chunk($c, $buffer, $length)
112 # If we have any remaining data in the input buffer, send it back first
113 if ( $_[0] = delete $self->{inputbuf} ) {
114 my $read = length( $_[0] );
115 DEBUG && warn "read_chunk: Read $read bytes from previous input buffer\n";
119 # support for non-blocking IO
121 vec( $rin, *STDIN->fileno, 1 ) = 1;
125 select( $rin, undef, undef, undef );
126 my $rc = *STDIN->sysread(@_);
128 DEBUG && warn "read_chunk: Read $rc bytes from socket\n";
132 next READ if $! == EWOULDBLOCK;
138 =head2 $self->write($c, $buffer)
140 Writes the buffer to the client.
144 around write => sub {
146 my ( $self, $c, $buffer ) = @_;
148 # Avoid 'print() on closed filehandle Remote' warnings when using IE
149 return unless *STDOUT->opened();
151 # Prepend the headers if they have not yet been sent
152 if ( my $headers = delete $self->{_header_buf} ) {
153 $buffer = $headers . $buffer;
156 my $ret = $self->$orig($c, $buffer);
158 if ( !defined $ret ) {
159 $self->{_write_error} = $!;
160 DEBUG && warn "write: Failed to write response ($!)\n";
163 DEBUG && warn "write: Wrote response ($ret bytes)\n";
173 # A very very simple HTTP server that initializes a CGI environment
175 my ( $self, $class, $port, $host, $options ) = @_;
179 $self->{options} = $options;
181 if ($options->{background}) {
183 die "Can't fork: $!" unless defined($child);
184 return $child if $child;
188 local $SIG{CHLD} = 'IGNORE';
190 my $allowed = $options->{allowed} || { '127.0.0.1' => '255.255.255.255' };
191 my $addr = $host ? inet_aton($host) : INADDR_ANY;
192 if ( $addr eq INADDR_ANY ) {
193 require Sys::Hostname;
194 $host = lc Sys::Hostname::hostname();
197 $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr);
203 my $daemon = IO::Socket::INET->new(
205 LocalAddr => inet_ntoa($addr),
211 or die "Couldn't create daemon: $!";
213 my $url = "http://$host";
214 $url .= ":$port" unless $port == 80;
216 print "You can connect to your server at $url\n";
218 if ($options->{background}) {
219 open STDIN, "+</dev/null" or die $!;
220 open STDOUT, ">&STDIN" or die $!;
221 open STDERR, ">&STDIN" or die $!;
222 if ( $^O !~ /MSWin32/ ) {
225 or die "Can't start a new session: $!";
229 if (my $pidfile = $options->{pidfile}) {
230 if (! open PIDFILE, "> $pidfile") {
231 warn("Cannot open: $pidfile: $!");
233 print PIDFILE "$$\n";
239 # Ignore broken pipes as an HTTP server should
240 local $SIG{PIPE} = 'IGNORE';
243 local $SIG{HUP} = sub {
245 warn "Restarting server on SIGHUP...\n";
249 while ( !$restart ) {
250 while ( accept( Remote, $daemon ) ) {
251 DEBUG && warn "New connection\n";
257 # Read until we see all headers
258 $self->{inputbuf} = '';
260 if ( !$self->_read_headers ) {
261 # Error reading, give up
266 my ( $method, $uri, $protocol ) = $self->_parse_request_line;
268 DEBUG && warn "Parsed request: $method $uri $protocol\n";
271 unless ( uc($method) eq 'RESTART' ) {
274 if ( $options->{fork} ) {
276 DEBUG && warn "Forked child $pid\n";
281 $self->_handler( $class, $port, $method, $uri, $protocol );
283 if ( my $error = delete $self->{_write_error} ) {
286 if ( !defined $pid ) {
291 if ( defined $pid ) {
292 # Child process, close connection and exit
293 DEBUG && warn "Child process exiting\n";
299 my $sockdata = $self->_socket_data( \*Remote );
300 my $ipaddr = _inet_addr( $sockdata->{peeraddr} );
302 foreach my $ip ( keys %$allowed ) {
303 my $mask = $allowed->{$ip};
304 $ready = ( $ipaddr & _inet_addr($mask) ) == _inet_addr($ip);
320 DEBUG && warn "Shutting down\n";
323 $SIG{CHLD} = 'DEFAULT';
326 ### if the standalone server was invoked with perl -I .. we will loose
327 ### those include dirs upon re-exec. So add them to PERL5LIB, so they
328 ### are available again for the exec'ed process --kane
330 $ENV{PERL5LIB} .= join $Config{path_sep}, @INC;
332 exec $^X, $0, @{ $options->{argv} };
339 my ( $self, $class, $port, $method, $uri, $protocol ) = @_;
341 local *STDIN = \*Remote;
342 local *STDOUT = \*Remote;
344 # We better be careful and just use 1.0
347 my $sockdata = $self->_socket_data( \*Remote );
348 my %copy_of_env = %ENV;
350 my $sel = IO::Select->new;
351 $sel->add( \*STDIN );
355 my ( $path, $query_string ) = split /\?/, $uri, 2;
357 # Initialize CGI environment
359 PATH_INFO => $path || '',
360 QUERY_STRING => $query_string || '',
361 REMOTE_ADDR => $sockdata->{peeraddr},
362 REMOTE_HOST => $sockdata->{peername},
363 REQUEST_METHOD => $method || '',
364 SERVER_NAME => $sockdata->{localname},
365 SERVER_PORT => $port,
366 SERVER_PROTOCOL => "HTTP/$protocol",
371 if ( $protocol >= 1 ) {
372 $self->_parse_headers;
375 # Pass flow control to Catalyst
376 $class->handle_request;
378 DEBUG && warn "Request done\n";
380 # Allow keepalive requests, this is a hack but we'll support it until
381 # the next major release.
382 if ( delete $self->{_keepalive} ) {
384 DEBUG && warn "Reusing previous connection for keep-alive request\n";
386 if ( $sel->can_read(1) ) {
387 if ( !$self->_read_headers ) {
388 # Error reading, give up
392 ( $method, $uri, $protocol ) = $self->_parse_request_line;
394 DEBUG && warn "Parsed request: $method $uri $protocol\n";
402 DEBUG && warn "No keep-alive request within 1 second\n";
408 DEBUG && warn "Closing connection\n";
417 my $read = sysread Remote, my $buf, CHUNKSIZE;
419 if ( !defined $read ) {
420 next if $! == EWOULDBLOCK;
421 DEBUG && warn "Error reading headers: $!\n";
423 } elsif ( $read == 0 ) {
424 DEBUG && warn "EOF\n";
428 DEBUG && warn "Read $read bytes\n";
429 $self->{inputbuf} .= $buf;
430 last if $self->{inputbuf} =~ /(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)/s;
436 sub _parse_request_line {
440 if ( $self->{inputbuf} !~ s/^(\w+)[ \t]+(\S+)(?:[ \t]+(HTTP\/\d+\.\d+))?[^\012]*\012// ) {
446 my $proto = $3 || 'HTTP/0.9';
448 return ( $method, $uri, $proto );
454 # Copy the buffer for header parsing, and remove the header block
455 # from the content buffer.
456 my $buf = $self->{inputbuf};
457 $self->{inputbuf} =~ s/.*?(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)//s;
460 my $headers = HTTP::Headers->new;
463 while ( $buf =~ s/^([^\012]*)\012// ) {
466 if ( /^([\w\-~]+)\s*:\s*(.*)/ ) {
467 $headers->push_header( $key, $val ) if $key;
468 ($key, $val) = ($1, $2);
470 elsif ( /^\s+(.*)/ ) {
477 $headers->push_header( $key, $val ) if $key;
479 DEBUG && warn "Parsed headers: " . dump($headers) . "\n";
481 # Convert headers into ENV vars
482 $headers->scan( sub {
483 my ( $key, $val ) = @_;
486 $key = 'COOKIE' if $key eq 'COOKIES';
488 $key = 'HTTP_' . $key
489 unless $key =~ m/\A(?:CONTENT_(?:LENGTH|TYPE)|COOKIE)\z/;
491 if ( exists $ENV{$key} ) {
492 $ENV{$key} .= ", $val";
501 my ( $self, $handle ) = @_;
503 my $remote_sockaddr = getpeername($handle);
504 my ( undef, $iaddr ) = $remote_sockaddr
505 ? sockaddr_in($remote_sockaddr)
508 my $local_sockaddr = getsockname($handle);
509 my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
511 # This mess is necessary to keep IE from crashing the server
514 ? ( gethostbyaddr( $iaddr, AF_INET ) || 'localhost' )
517 ? ( inet_ntoa($iaddr) || '127.0.0.1' )
519 localname => gethostbyaddr( $localiaddr, AF_INET ) || 'localhost',
520 localaddr => inet_ntoa($localiaddr) || '127.0.0.1',
526 sub _inet_addr { unpack "N*", inet_aton( $_[0] ) }
532 L<Catalyst>, L<Catalyst::Engine>
536 Catalyst Contributors, see Catalyst.pm
540 Many parts are ripped out of C<HTTP::Server::Simple> by Jesse Vincent.
544 This program is free software, you can redistribute it and/or modify it under
545 the same terms as Perl itself.