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 => 'meta';
24 has options => ( is => 'rw' );
25 has _keepalive => ( is => 'rw', predicate => '_is_keepalive', clearer => '_clear_keepalive' );
26 has _write_error => ( is => 'rw', predicate => '_has_write_error' );
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 $self->_warn_on_write_error(
162 $self->$orig($self->_clear_header_buf)
166 $self->_warn_on_write_error($self->$orig($c, $buffer));
169 sub _warn_on_write_error {
170 my ($self, $ret) = @_;
171 if ( !defined $ret ) {
172 $self->_write_error($!);
173 DEBUG && warn "write: Failed to write response ($!)\n";
176 DEBUG && warn "write: Wrote response ($ret bytes)\n";
185 # A very very simple HTTP server that initializes a CGI environment
187 my ( $self, $class, $port, $host, $options ) = @_;
191 $self->options($options);
193 if ($options->{background}) {
195 die "Can't fork: $!" unless defined($child);
196 return $child if $child;
200 local $SIG{CHLD} = 'IGNORE';
202 my $allowed = $options->{allowed} || { '127.0.0.1' => '255.255.255.255' };
203 my $addr = $host ? inet_aton($host) : INADDR_ANY;
204 if ( $addr eq INADDR_ANY ) {
205 require Sys::Hostname;
206 $host = lc Sys::Hostname::hostname();
209 $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr);
215 my $daemon = IO::Socket::INET->new(
217 LocalAddr => inet_ntoa($addr),
223 or die "Couldn't create daemon: $@";
225 $port = $daemon->sockport();
227 my $url = "http://$host";
228 $url .= ":$port" unless $port == 80;
230 print "You can connect to your server at $url\n";
232 if ($options->{background}) {
233 open STDIN, "+</dev/null" or die $!;
234 open STDOUT, ">&STDIN" or die $!;
235 open STDERR, ">&STDIN" or die $!;
236 if ( $^O !~ /MSWin32/ ) {
239 or die "Can't start a new session: $!";
243 if (my $pidfile = $options->{pidfile}) {
244 if (! open PIDFILE, "> $pidfile") {
245 warn("Cannot open: $pidfile: $!");
247 print PIDFILE "$$\n";
253 # Ignore broken pipes as an HTTP server should
254 local $SIG{PIPE} = 'IGNORE';
257 local $SIG{HUP} = sub {
259 warn "Restarting server on SIGHUP...\n";
263 while ( !$restart ) {
264 while ( accept( Remote, $daemon ) ) {
265 DEBUG && warn "New connection\n";
271 # Read until we see all headers
272 $self->{inputbuf} = '';
274 if ( !$self->_read_headers ) {
275 # Error reading, give up
280 my ( $method, $uri, $protocol ) = $self->_parse_request_line;
282 DEBUG && warn "Parsed request: $method $uri $protocol\n";
285 unless ( uc($method) eq 'RESTART' ) {
288 if ( $options->{fork} ) {
290 DEBUG && warn "Forked child $pid\n";
295 $self->_handler( $class, $port, $method, $uri, $protocol );
297 if ( $self->_has_write_error ) {
300 if ( !defined $pid ) {
305 if ( defined $pid ) {
306 # Child process, close connection and exit
307 DEBUG && warn "Child process exiting\n";
313 my $sockdata = $self->_socket_data( \*Remote );
314 my $ipaddr = _inet_addr( $sockdata->{peeraddr} );
316 foreach my $ip ( keys %$allowed ) {
317 my $mask = $allowed->{$ip};
318 $ready = ( $ipaddr & _inet_addr($mask) ) == _inet_addr($ip);
334 DEBUG && warn "Shutting down\n";
337 $SIG{CHLD} = 'DEFAULT';
340 ### if the standalone server was invoked with perl -I .. we will loose
341 ### those include dirs upon re-exec. So add them to PERL5LIB, so they
342 ### are available again for the exec'ed process --kane
344 $ENV{PERL5LIB} .= join $Config{path_sep}, @INC;
346 exec $^X, $0, @{ $options->{argv} };
353 my ( $self, $class, $port, $method, $uri, $protocol ) = @_;
355 local *STDIN = \*Remote;
356 local *STDOUT = \*Remote;
358 # We better be careful and just use 1.0
361 my $sockdata = $self->_socket_data( \*Remote );
362 my %copy_of_env = %ENV;
364 my $sel = IO::Select->new;
365 $sel->add( \*STDIN );
369 my ( $path, $query_string ) = split /\?/, $uri, 2;
371 # Initialize CGI environment
373 PATH_INFO => $path || '',
374 QUERY_STRING => $query_string || '',
375 REMOTE_ADDR => $sockdata->{peeraddr},
376 REQUEST_METHOD => $method || '',
377 SERVER_NAME => $sockdata->{localname},
378 SERVER_PORT => $port,
379 SERVER_PROTOCOL => "HTTP/$protocol",
384 if ( $protocol >= 1 ) {
385 $self->_parse_headers;
388 # Pass flow control to Catalyst
390 # FIXME: don't ignore SIGCHLD while handling requests so system()
391 # et al. work within actions. it might be a little risky to do that
392 # this far out, but then again it's only the dev server anyway.
393 local $SIG{CHLD} = 'DEFAULT';
395 $class->handle_request( env => \%ENV );
398 DEBUG && warn "Request done\n";
400 # Allow keepalive requests, this is a hack but we'll support it until
401 # the next major release.
402 if ( $self->_is_keepalive ) {
403 $self->_clear_keepalive;
405 DEBUG && warn "Reusing previous connection for keep-alive request\n";
407 if ( $sel->can_read(1) ) {
408 if ( !$self->_read_headers ) {
409 # Error reading, give up
413 ( $method, $uri, $protocol ) = $self->_parse_request_line;
415 DEBUG && warn "Parsed request: $method $uri $protocol\n";
423 DEBUG && warn "No keep-alive request within 1 second\n";
429 DEBUG && warn "Closing connection\n";
438 my $read = sysread Remote, my $buf, CHUNKSIZE;
440 if ( !defined $read ) {
441 next if $! == EWOULDBLOCK;
442 DEBUG && warn "Error reading headers: $!\n";
444 } elsif ( $read == 0 ) {
445 DEBUG && warn "EOF\n";
449 DEBUG && warn "Read $read bytes\n";
450 $self->{inputbuf} .= $buf;
451 last if $self->{inputbuf} =~ /(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)/s;
457 sub _parse_request_line {
461 # Leading CRLF sometimes sent by buggy IE versions
462 if ( $self->{inputbuf} !~ s/^(?:\x0D\x0A)?(\w+)[ \t]+(\S+)(?:[ \t]+(HTTP\/\d+\.\d+))?[^\012]*\012// ) {
468 my $proto = $3 || 'HTTP/0.9';
470 return ( $method, $uri, $proto );
476 # Copy the buffer for header parsing, and remove the header block
477 # from the content buffer.
478 my $buf = $self->{inputbuf};
479 $self->{inputbuf} =~ s/.*?(\x0D\x0A?\x0D\x0A?|\x0A\x0D?\x0A\x0D?)//s;
482 my $headers = HTTP::Headers->new;
485 while ( $buf =~ s/^([^\012]*)\012// ) {
488 if ( /^([\w\-~]+)\s*:\s*(.*)/ ) {
489 $headers->push_header( $key, $val ) if $key;
490 ($key, $val) = ($1, $2);
492 elsif ( /^\s+(.*)/ ) {
499 $headers->push_header( $key, $val ) if $key;
501 DEBUG && warn "Parsed headers: " . dump($headers) . "\n";
503 # Convert headers into ENV vars
504 $headers->scan( sub {
505 my ( $key, $val ) = @_;
508 $key = 'COOKIE' if $key eq 'COOKIES';
510 $key = 'HTTP_' . $key
511 unless $key =~ m/\A(?:CONTENT_(?:LENGTH|TYPE)|COOKIE)\z/;
513 if ( exists $ENV{$key} ) {
514 $ENV{$key} .= ", $val";
523 my ( $self, $handle ) = @_;
525 my $remote_sockaddr = getpeername($handle);
526 my ( undef, $iaddr ) = $remote_sockaddr
527 ? sockaddr_in($remote_sockaddr)
530 my $local_sockaddr = getsockname($handle);
531 my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
533 # This mess is necessary to keep IE from crashing the server
536 ? ( inet_ntoa($iaddr) || '127.0.0.1' )
538 localname => gethostbyaddr( $localiaddr, AF_INET ) || 'localhost',
539 localaddr => inet_ntoa($localiaddr) || '127.0.0.1',
545 sub _inet_addr { unpack "N*", inet_aton( $_[0] ) }
549 Options hash passed to the http engine to control things like if keepalive
554 L<Catalyst>, L<Catalyst::Engine>
558 Catalyst Contributors, see Catalyst.pm
562 Many parts are ripped out of C<HTTP::Server::Simple> by Jesse Vincent.
566 This library is free software. You can redistribute it and/or modify it under
567 the same terms as Perl itself.