Reformatted documentation
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / HTTP.pm
index 27873f2..0024009 100644 (file)
@@ -6,6 +6,12 @@ use Errno 'EWOULDBLOCK';
 use HTTP::Status;
 use NEXT;
 use Socket;
+use IO::Socket::INET ();
+use IO::Select       ();
+
+# For PAR
+require Catalyst::Engine::HTTP::Restarter;
+require Catalyst::Engine::HTTP::Restarter::Watcher;
 
 =head1 NAME
 
@@ -31,9 +37,7 @@ This is the Catalyst engine specialized for development and testing.
 
 =head1 METHODS
 
-=over 4
-
-=item $self->finalize_headers($c)
+=head2 $self->finalize_headers($c)
 
 =cut
 
@@ -44,10 +48,12 @@ sub finalize_headers {
     my $message  = status_message($status);
     print "$protocol $status $message\015\012";
     $c->response->headers->date(time);
+    $c->response->headers->header(
+        Connection => $self->_keep_alive ? 'keep-alive' : 'close' );
     $self->NEXT::finalize_headers($c);
 }
 
-=item $self->finalize_read($c)
+=head2 $self->finalize_read($c)
 
 =cut
 
@@ -56,12 +62,12 @@ sub finalize_read {
 
     # Never ever remove this, it would result in random length output
     # streams if STDIN eq STDOUT (like in the HTTP engine)
-    $c->request->handle->blocking(1);
+    *STDIN->blocking(1);
 
     return $self->NEXT::finalize_read($c);
 }
 
-=item $self->prepare_read($c)
+=head2 $self->prepare_read($c)
 
 =cut
 
@@ -69,12 +75,12 @@ sub prepare_read {
     my ( $self, $c ) = @_;
 
     # Set the input handle to non-blocking
-    $c->request->handle->blocking(0);
+    *STDIN->blocking(0);
 
     return $self->NEXT::prepare_read($c);
 }
 
-=item $self->read_chunk($c, $buffer, $length)
+=head2 $self->read_chunk($c, $buffer, $length)
 
 =cut
 
@@ -83,14 +89,13 @@ sub read_chunk {
     my $c    = shift;
 
     # support for non-blocking IO
-    my $handle = $c->request->handle;
-    my $rin    = '';
-    vec( $rin, $handle->fileno, 1 ) = 1;
+    my $rin = '';
+    vec( $rin, *STDIN->fileno, 1 ) = 1;
 
   READ:
     {
         select( $rin, undef, undef, undef );
-        my $rc = $handle->sysread(@_);
+        my $rc = *STDIN->sysread(@_);
         if ( defined $rc ) {
             return $rc;
         }
@@ -101,90 +106,135 @@ sub read_chunk {
     }
 }
 
-=item run
+=head2 run
 
 =cut
 
 # A very very simple HTTP server that initializes a CGI environment
 sub run {
-    my ( $self, $class, $port, $host, $fork ) = @_;
+    my ( $self, $class, $port, $host, $options ) = @_;
 
-    our $GOT_HUP;
-    local $GOT_HUP = 0;
-
-    local $SIG{HUP} = sub { $GOT_HUP = 1; };
+    $options ||= {};
 
+    my $restart = 0;
     local $SIG{CHLD} = 'IGNORE';
 
-    # Handle requests
-
-    # Setup socket
-    $host = $host ? inet_aton($host) : INADDR_ANY;
-    socket( HTTPDaemon, PF_INET, SOCK_STREAM, getprotobyname('tcp') );
-    setsockopt( HTTPDaemon, SOL_SOCKET, SO_REUSEADDR, pack( "l", 1 ) );
-    bind( HTTPDaemon, sockaddr_in( $port, $host ) );
-    listen( HTTPDaemon, SOMAXCONN );
-    my $url = 'http://';
-    if ( $host eq INADDR_ANY ) {
+    my $allowed = $options->{allowed} || { '127.0.0.1' => '255.255.255.255' };
+    my $addr = $host ? inet_aton($host) : INADDR_ANY;
+    if ( $addr eq INADDR_ANY ) {
         require Sys::Hostname;
-        $url .= lc Sys::Hostname::hostname();
+        $host = lc Sys::Hostname::hostname();
     }
     else {
-        $url .= gethostbyaddr( $host, AF_INET ) || inet_ntoa($host);
+        $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr);
     }
-    $url .= ":$port";
-    print "You can connect to your server at $url\n";
-    my $pid = undef;
-    while ( accept( Remote, HTTPDaemon ) ) {
 
-        # Fork
-        if ($fork) { next if $pid = fork }
+    # Handle requests
+
+    # Setup socket
+    my $daemon = IO::Socket::INET->new(
+        Listen    => SOMAXCONN,
+        LocalAddr => inet_ntoa($addr),
+        LocalPort => $port,
+        Proto     => 'tcp',
+        ReuseAddr => 1,
+        Type      => SOCK_STREAM,
+      )
+      or die "Couldn't create daemon: $!";
+
+    my $url = "http://$host";
+    $url .= ":$port" unless $port == 80;
+
+    print "You can connect to your server at $url\n";
 
-        close HTTPDaemon if defined $pid;
+    $self->_keep_alive( $options->{keepalive} || 0 );
 
-        # Ignore broken pipes as an HTTP server should
-        local $SIG{PIPE} = sub { close Remote };
-        local $SIG{HUP} = (defined $pid ? 'IGNORE' : $SIG{HUP});
+    my $parent = $$;
+    my $pid    = undef;
+    while ( accept( Remote, $daemon ) )
+    {    # TODO: get while ( my $remote = $daemon->accept ) to work
 
-        local *STDIN  = \*Remote;
-        local *STDOUT = \*Remote;
-        select STDOUT;
+        select Remote;
 
         # Request data
-        my $remote_sockaddr = getpeername( \*Remote );
-        my ( undef, $iaddr ) = sockaddr_in($remote_sockaddr);
-        my $peername = gethostbyaddr( $iaddr, AF_INET ) || "localhost";
-        my $peeraddr = inet_ntoa($iaddr) || "127.0.0.1";
-        my $local_sockaddr = getsockname( \*Remote );
-        my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
-        my $localname = gethostbyaddr( $localiaddr, AF_INET )
-          || "localhost";
-        my $localaddr = inet_ntoa($localiaddr) || "127.0.0.1";
-
-        STDIN->blocking(1);
-
-        # Parse request line
-        my $line = $self->_get_line( \*STDIN );
+
+        Remote->blocking(1);
+
         next
           unless my ( $method, $uri, $protocol ) =
-          $line =~ m/\A(\w+)\s+(\S+)(?:\s+HTTP\/(\d+(?:\.\d+)?))?\z/;
+          $self->_parse_request_line( \*Remote );
+
+        unless ( uc($method) eq 'RESTART' ) {
+
+            # Fork
+            if ( $options->{fork} ) { next if $pid = fork }
+
+            $self->_handler( $class, $port, $method, $uri, $protocol );
+
+            $daemon->close if defined $pid;
+
+        }
+        else {
+            my $sockdata = $self->_socket_data( \*Remote );
+            my $ipaddr   = _inet_addr( $sockdata->{peeraddr} );
+            my $ready    = 0;
+            while ( my ( $ip, $mask ) = each %$allowed and not $ready ) {
+                $ready = ( $ipaddr & _inet_addr($mask) ) == _inet_addr($ip);
+            }
+            if ($ready) {
+                $restart = 1;
+                last;
+            }
+        }
+
+        exit if defined $pid;
+    }
+    continue {
+        close Remote;
+    }
+    $daemon->close;
+
+    if ($restart) {
+        $SIG{CHLD} = 'DEFAULT';
+        wait;
+        exec $^X . ' "' . $0 . '" ' . join( ' ', @{ $options->{argv} } );
+    }
+
+    exit;
+}
+
+sub _handler {
+    my ( $self, $class, $port, $method, $uri, $protocol ) = @_;
+
+    # Ignore broken pipes as an HTTP server should
+    local $SIG{PIPE} = sub { close Remote };
+
+    local *STDIN  = \*Remote;
+    local *STDOUT = \*Remote;
+
+    # We better be careful and just use 1.0
+    $protocol = '1.0';
+
+    my $sockdata    = $self->_socket_data( \*Remote );
+    my %copy_of_env = %ENV;
 
-        # We better be careful and just use 1.0
-        $protocol = '1.0';
+    my $sel = IO::Select->new;
+    $sel->add( \*STDIN );
 
+    while (1) {
         my ( $path, $query_string ) = split /\?/, $uri, 2;
 
         # Initialize CGI environment
         local %ENV = (
-            PATH_INFO      => $path         || '',
-            QUERY_STRING   => $query_string || '',
-            REMOTE_ADDR    => $peeraddr,
-            REMOTE_HOST    => $peername,
-            REQUEST_METHOD => $method       || '',
-            SERVER_NAME    => $localname,
-            SERVER_PORT    => $port,
+            PATH_INFO    => $path         || '',
+            QUERY_STRING => $query_string || '',
+            REMOTE_ADDR     => $sockdata->{peeraddr},
+            REMOTE_HOST     => $sockdata->{peername},
+            REQUEST_METHOD  => $method || '',
+            SERVER_NAME     => $sockdata->{localname},
+            SERVER_PORT     => $port,
             SERVER_PROTOCOL => "HTTP/$protocol",
-            %ENV,
+            %copy_of_env,
         );
 
         # Parse headers
@@ -212,13 +262,59 @@ sub run {
 
         # Pass flow control to Catalyst
         $class->handle_request;
-        exit if defined $pid;
-    }
-    continue {
-        close Remote;
+
+        my $connection = lc $ENV{HTTP_CONNECTION};
+        last
+          unless $self->_keep_alive()
+          && index( $connection, 'keep-alive' ) > -1
+          && index( $connection, 'te' ) == -1          # opera stuff
+          && $sel->can_read(5);
+
+        last
+          unless ( $method, $uri, $protocol ) =
+          $self->_parse_request_line( \*STDIN );
     }
-    close HTTPDaemon;
-    exec {$0}( ( ( -x $0 ) ? () : ($^X) ), $0, @ARGV ) if $GOT_HUP;
+
+    close Remote;
+}
+
+sub _keep_alive {
+    my ( $self, $keepalive ) = @_;
+
+    my $r = $self->{_keepalive} || 0;
+    $self->{_keepalive} = $keepalive if defined $keepalive;
+
+    return $r;
+
+}
+
+sub _parse_request_line {
+    my ( $self, $handle ) = @_;
+
+    # Parse request line
+    my $line = $self->_get_line($handle);
+    return ()
+      unless my ( $method, $uri, $protocol ) =
+      $line =~ m/\A(\w+)\s+(\S+)(?:\s+HTTP\/(\d+(?:\.\d+)?))?\z/;
+    return ( $method, $uri, $protocol );
+}
+
+sub _socket_data {
+    my ( $self, $handle ) = @_;
+
+    my $remote_sockaddr = getpeername($handle);
+    my ( undef, $iaddr ) = sockaddr_in($remote_sockaddr);
+    my $local_sockaddr = getsockname($handle);
+    my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
+
+    my $data = {
+        peername => gethostbyaddr( $iaddr, AF_INET ) || "localhost",
+        peeraddr => inet_ntoa($iaddr) || "127.0.0.1",
+        localname => gethostbyaddr( $localiaddr, AF_INET ) || "localhost",
+        localaddr => inet_ntoa($localiaddr) || "127.0.0.1",
+    };
+
+    return $data;
 }
 
 sub _get_line {
@@ -236,7 +332,7 @@ sub _get_line {
     return $line;
 }
 
-=back
+sub _inet_addr { unpack "N*", inet_aton( $_[0] ) }
 
 =head1 SEE ALSO
 
@@ -248,6 +344,8 @@ Sebastian Riedel, <sri@cpan.org>
 
 Dan Kubb, <dan.kubb-cpan@onautopilot.com>
 
+Sascha Kiefer, <esskar@cpan.org>
+
 =head1 THANKS
 
 Many parts are ripped out of C<HTTP::Server::Simple> by Jesse Vincent.