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 has options => ( is => 'rw' );
23 has _keepalive => ( is => 'rw', predicate => '_is_keepalive', clearer => '_clear_keepalive' );
24 has _write_error => ( is => 'rw', predicate => '_has_write_error' );
26 use namespace::clean -except => [qw/meta/];
28 # Refactoring note - could/should Eliminate all instances of $self->{inputbuf},
29 # which I haven't touched as it is used as an lvalue in a lot of places, and I guess
30 # doing it differently could be expensive.. Feel free to refactor and NYTProf :)
34 Catalyst::Engine::HTTP - Catalyst HTTP Engine
38 A script using the Catalyst::Engine::HTTP module might look like:
42 BEGIN { $ENV{CATALYST_ENGINE} = 'HTTP' }
45 use lib '/path/to/MyApp/lib';
52 This is the Catalyst engine specialized for development and testing.
56 =head2 $self->finalize_headers($c)
60 sub finalize_headers {
61 my ( $self, $c ) = @_;
62 my $protocol = $c->request->protocol;
63 my $status = $c->response->status;
64 my $message = status_message($status);
65 my $res_headers = $c->response->headers;
68 push @headers, "$protocol $status $message";
70 $res_headers->header( Date => HTTP::Date::time2str(time) );
71 $res_headers->header( Status => $status );
73 # Should we keep the connection open?
74 my $connection = $c->request->header('Connection');
75 if ( $self->options->{keepalive}
77 && $connection =~ /^keep-alive$/i
79 $res_headers->header( Connection => 'keep-alive' );
83 $res_headers->header( Connection => 'close' );
86 push @headers, $res_headers->as_string("\x0D\x0A");
88 # Buffer the headers so they are sent with the first write() call
89 # This reduces the number of TCP packets we are sending
90 $self->_header_buf( join("\x0D\x0A", @headers, '') );
93 =head2 $self->finalize_read($c)
97 before finalize_read => sub {
98 # Never ever remove this, it would result in random length output
99 # streams if STDIN eq STDOUT (like in the HTTP engine)
103 =head2 $self->prepare_read($c)
107 before prepare_read => sub {
108 # Set the input handle to non-blocking
112 =head2 $self->read_chunk($c, $buffer, $length)
120 # If we have any remaining data in the input buffer, send it back first
121 if ( $_[0] = delete $self->{inputbuf} ) {
122 my $read = length( $_[0] );
123 DEBUG && warn "read_chunk: Read $read bytes from previous input buffer\n";
127 # support for non-blocking IO
129 vec( $rin, *STDIN->fileno, 1 ) = 1;
133 select( $rin, undef, undef, undef );
134 my $rc = *STDIN->sysread(@_);
136 DEBUG && warn "read_chunk: Read $rc bytes from socket\n";
140 next READ if $! == EWOULDBLOCK;
146 =head2 $self->write($c, $buffer)
148 Writes the buffer to the client.
152 around write => sub {
154 my ( $self, $c, $buffer ) = @_;
156 # Avoid 'print() on closed filehandle Remote' warnings when using IE
157 return unless *STDOUT->opened();
159 # Prepend the headers if they have not yet been sent
160 if ( $self->_has_header_buf ) {
161 $buffer = $self->_clear_header_buf . $buffer;
164 my $ret = $self->$orig($c, $buffer);
166 if ( !defined $ret ) {
167 $self->_write_error($!);
168 DEBUG && warn "write: Failed to write response ($!)\n";
171 DEBUG && warn "write: Wrote response ($ret bytes)\n";
181 # A very very simple HTTP server that initializes a CGI environment
183 my ( $self, $class, $port, $host, $options ) = @_;
187 $self->options($options);
189 if ($options->{background}) {
191 die "Can't fork: $!" unless defined($child);
192 return $child if $child;
196 local $SIG{CHLD} = 'IGNORE';
198 my $allowed = $options->{allowed} || { '127.0.0.1' => '255.255.255.255' };
199 my $addr = $host ? inet_aton($host) : INADDR_ANY;
200 if ( $addr eq INADDR_ANY ) {
201 require Sys::Hostname;
202 $host = lc Sys::Hostname::hostname();
205 $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr);
211 my $daemon = IO::Socket::INET->new(
213 LocalAddr => inet_ntoa($addr),
219 or die "Couldn't create daemon: $!";
221 my $url = "http://$host";
222 $url .= ":$port" unless $port == 80;
224 print "You can connect to your server at $url\n";
226 if ($options->{background}) {
227 open STDIN, "+</dev/null" or die $!;
228 open STDOUT, ">&STDIN" or die $!;
229 open STDERR, ">&STDIN" or die $!;
230 if ( $^O !~ /MSWin32/ ) {
233 or die "Can't start a new session: $!";
237 if (my $pidfile = $options->{pidfile}) {
238 if (! open PIDFILE, "> $pidfile") {
239 warn("Cannot open: $pidfile: $!");
241 print PIDFILE "$$\n";
247 # Ignore broken pipes as an HTTP server should
248 local $SIG{PIPE} = 'IGNORE';
251 local $SIG{HUP} = sub {
253 warn "Restarting server on SIGHUP...\n";
257 while ( !$restart ) {
258 while ( accept( Remote, $daemon ) ) {
259 DEBUG && warn "New connection\n";
265 # Read until we see all headers
266 $self->{inputbuf} = '';
268 if ( !$self->_read_headers ) {
269 # Error reading, give up
274 my ( $method, $uri, $protocol ) = $self->_parse_request_line;
276 DEBUG && warn "Parsed request: $method $uri $protocol\n";
279 unless ( uc($method) eq 'RESTART' ) {
282 if ( $options->{fork} ) {
284 DEBUG && warn "Forked child $pid\n";
289 $self->_handler( $class, $port, $method, $uri, $protocol );
291 if ( $self->_has_write_error ) {
294 if ( !defined $pid ) {
299 if ( defined $pid ) {
300 # Child process, close connection and exit
301 DEBUG && warn "Child process exiting\n";
307 my $sockdata = $self->_socket_data( \*Remote );
308 my $ipaddr = _inet_addr( $sockdata->{peeraddr} );
310 foreach my $ip ( keys %$allowed ) {
311 my $mask = $allowed->{$ip};
312 $ready = ( $ipaddr & _inet_addr($mask) ) == _inet_addr($ip);
328 DEBUG && warn "Shutting down\n";
331 $SIG{CHLD} = 'DEFAULT';
334 ### if the standalone server was invoked with perl -I .. we will loose
335 ### those include dirs upon re-exec. So add them to PERL5LIB, so they
336 ### are available again for the exec'ed process --kane
338 $ENV{PERL5LIB} .= join $Config{path_sep}, @INC;
340 exec $^X, $0, @{ $options->{argv} };
347 my ( $self, $class, $port, $method, $uri, $protocol ) = @_;
349 local *STDIN = \*Remote;
350 local *STDOUT = \*Remote;
352 # We better be careful and just use 1.0
355 my $sockdata = $self->_socket_data( \*Remote );
356 my %copy_of_env = %ENV;
358 my $sel = IO::Select->new;
359 $sel->add( \*STDIN );
363 my ( $path, $query_string ) = split /\?/, $uri, 2;
365 # Initialize CGI environment
367 PATH_INFO => $path || '',
368 QUERY_STRING => $query_string || '',
369 REMOTE_ADDR => $sockdata->{peeraddr},
370 REQUEST_METHOD => $method || '',
371 SERVER_NAME => $sockdata->{localname},
372 SERVER_PORT => $port,
373 SERVER_PROTOCOL => "HTTP/$protocol",
378 if ( $protocol >= 1 ) {
379 $self->_parse_headers;
382 # Pass flow control to Catalyst
383 $class->handle_request;
385 DEBUG && warn "Request done\n";
387 # Allow keepalive requests, this is a hack but we'll support it until
388 # the next major release.
389 if ( $self->_is_keepalive ) {
390 $self->_clear_keepalive;
392 DEBUG && warn "Reusing previous connection for keep-alive request\n";
394 if ( $sel->can_read(1) ) {
395 if ( !$self->_read_headers ) {
396 # Error reading, give up
400 ( $method, $uri, $protocol ) = $self->_parse_request_line;
402 DEBUG && warn "Parsed request: $method $uri $protocol\n";
410 DEBUG && warn "No keep-alive request within 1 second\n";
416 DEBUG && warn "Closing connection\n";
425 my $read = sysread Remote, my $buf, CHUNKSIZE;
427 if ( !defined $read ) {
428 next if $! == EWOULDBLOCK;
429 DEBUG && warn "Error reading headers: $!\n";
431 } elsif ( $read == 0 ) {
432 DEBUG && warn "EOF\n";
436 DEBUG && warn "Read $read bytes\n";
437 $self->{inputbuf} .= $buf;
438 last if $self->{inputbuf} =~ /(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)/s;
444 sub _parse_request_line {
448 # Leading CRLF sometimes sent by buggy IE versions
449 if ( $self->{inputbuf} !~ s/^(?:\x0D\x0A)?(\w+)[ \t]+(\S+)(?:[ \t]+(HTTP\/\d+\.\d+))?[^\012]*\012// ) {
455 my $proto = $3 || 'HTTP/0.9';
457 return ( $method, $uri, $proto );
463 # Copy the buffer for header parsing, and remove the header block
464 # from the content buffer.
465 my $buf = $self->{inputbuf};
466 $self->{inputbuf} =~ s/.*?(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)//s;
469 my $headers = HTTP::Headers->new;
472 while ( $buf =~ s/^([^\012]*)\012// ) {
475 if ( /^([\w\-~]+)\s*:\s*(.*)/ ) {
476 $headers->push_header( $key, $val ) if $key;
477 ($key, $val) = ($1, $2);
479 elsif ( /^\s+(.*)/ ) {
486 $headers->push_header( $key, $val ) if $key;
488 DEBUG && warn "Parsed headers: " . dump($headers) . "\n";
490 # Convert headers into ENV vars
491 $headers->scan( sub {
492 my ( $key, $val ) = @_;
495 $key = 'COOKIE' if $key eq 'COOKIES';
497 $key = 'HTTP_' . $key
498 unless $key =~ m/\A(?:CONTENT_(?:LENGTH|TYPE)|COOKIE)\z/;
500 if ( exists $ENV{$key} ) {
501 $ENV{$key} .= ", $val";
510 my ( $self, $handle ) = @_;
512 my $remote_sockaddr = getpeername($handle);
513 my ( undef, $iaddr ) = $remote_sockaddr
514 ? sockaddr_in($remote_sockaddr)
517 my $local_sockaddr = getsockname($handle);
518 my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
520 # This mess is necessary to keep IE from crashing the server
523 ? ( inet_ntoa($iaddr) || '127.0.0.1' )
525 localname => gethostbyaddr( $localiaddr, AF_INET ) || 'localhost',
526 localaddr => inet_ntoa($localiaddr) || '127.0.0.1',
532 sub _inet_addr { unpack "N*", inet_aton( $_[0] ) }
538 Options hash passed to the http engine to control things like if keepalive
543 L<Catalyst>, L<Catalyst::Engine>
547 Catalyst Contributors, see Catalyst.pm
551 Many parts are ripped out of C<HTTP::Server::Simple> by Jesse Vincent.
555 This program is free software, you can redistribute it and/or modify it under
556 the same terms as Perl itself.