Merged 5.49_01 (r1339) from refactored branch to trunk
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / HTTP.pm
index 861ec5a..27873f2 100644 (file)
@@ -1,24 +1,11 @@
 package Catalyst::Engine::HTTP;
 
 use strict;
-use base 'Catalyst::Engine';
-
-use CGI::Simple::Cookie;
-use Class::Struct ();
-use HTTP::Headers::Util 'split_header_words';
-use HTTP::Request;
-use HTTP::Response;
-use IO::File;
-use URI;
-
-__PACKAGE__->mk_accessors(qw/http/);
-
-Class::Struct::struct 'Catalyst::Engine::HTTP::LWP' => {
-    request  => 'HTTP::Request',
-    response => 'HTTP::Response',
-    hostname => '$',
-    address  => '$'
-};
+use base 'Catalyst::Engine::CGI';
+use Errno 'EWOULDBLOCK';
+use HTTP::Status;
+use NEXT;
+use Socket;
 
 =head1 NAME
 
@@ -26,202 +13,244 @@ Catalyst::Engine::HTTP - Catalyst HTTP Engine
 
 =head1 SYNOPSIS
 
-L<Catalyst>.
+A script using the Catalyst::Engine::HTTP module might look like:
 
-=head1 DESCRIPTION
+    #!/usr/bin/perl -w
+
+    BEGIN {  $ENV{CATALYST_ENGINE} = 'HTTP' }
+
+    use strict;
+    use lib '/path/to/MyApp/lib';
+    use MyApp;
+
+    MyApp->run;
 
-This Catalyst engine is meant to be subclassed.
+=head1 DESCRIPTION
 
-=head1 OVERLOADED METHODS
+This is the Catalyst engine specialized for development and testing.
 
-This class overloads some methods from C<Catalyst::Engine>.
+=head1 METHODS
 
 =over 4
 
-=item $c->finalize_headers
+=item $self->finalize_headers($c)
 
 =cut
 
 sub finalize_headers {
-    my $c = shift;
-
-    my $status   = $c->response->status || 200;
-    my $headers  = $c->response->headers;
-    my $response = HTTP::Response->new( $status, undef, $headers );
-
-    while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) {
-        my $cookie = CGI::Simple::Cookie->new(
-            -name    => $name,
-            -value   => $cookie->{value},
-            -expires => $cookie->{expires},
-            -domain  => $cookie->{domain},
-            -path    => $cookie->{path},
-            -secure  => $cookie->{secure} || 0
-        );
-
-        $response->header( 'Set-Cookie' => $cookie->as_string );
-    }
-
-    $c->http->response($response);
+    my ( $self, $c ) = @_;
+    my $protocol = $c->request->protocol;
+    my $status   = $c->response->status;
+    my $message  = status_message($status);
+    print "$protocol $status $message\015\012";
+    $c->response->headers->date(time);
+    $self->NEXT::finalize_headers($c);
 }
 
-=item $c->finalize_output
+=item $self->finalize_read($c)
 
 =cut
 
-sub finalize_output {
-    my $c = shift;
-    $c->http->response->content_ref( \$c->response->{output} );
-}
-
-=item $c->prepare_connection
+sub finalize_read {
+    my ( $self, $c ) = @_;
 
-=cut
+    # 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);
 
-sub prepare_connection {
-    my $c = shift;
-    $c->req->hostname( $c->http->hostname );
-    $c->req->address( $c->http->address );
+    return $self->NEXT::finalize_read($c);
 }
 
-=item $c->prepare_cookies
+=item $self->prepare_read($c)
 
 =cut
 
-sub prepare_cookies {
-    my $c = shift;
-
-    if ( my $header = $c->http->request->header('Cookie') ) {
-        $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
-    }
-}
+sub prepare_read {
+    my ( $self, $c ) = @_;
 
-=item $c->prepare_headers
+    # Set the input handle to non-blocking
+    $c->request->handle->blocking(0);
 
-=cut
-
-sub prepare_headers {
-    my $c = shift;
-    $c->req->method( $c->http->request->method );
-    $c->req->headers( $c->http->request->headers );
+    return $self->NEXT::prepare_read($c);
 }
 
-=item $c->prepare_parameters
+=item $self->read_chunk($c, $buffer, $length)
 
 =cut
 
-sub prepare_parameters {
-    my $c = shift;
-
-    my @params  = ();
-    my $request = $c->http->request;
-
-    push( @params, $request->uri->query_form );
-
-    if ( $request->content_type eq 'application/x-www-form-urlencoded' ) {
-        my $uri = URI->new('http:');
-        $uri->query( $request->content );
-        push( @params, $uri->query_form );
-    }
-
-    if ( $request->content_type eq 'multipart/form-data' ) {
-
-        for my $part ( $request->parts ) {
-
-            my $disposition = $part->header('Content-Disposition');
-            my %parameters  = @{ ( split_header_words($disposition) )[0] };
-
-            if ( $parameters{filename} ) {
+sub read_chunk {
+    my $self = shift;
+    my $c    = shift;
 
-                my $fh = IO::File->new_tmpfile;
-                $fh->write( $part->content ) or die $!;
-                $fh->seek( SEEK_SET, 0 ) or die $!;
+    # support for non-blocking IO
+    my $handle = $c->request->handle;
+    my $rin    = '';
+    vec( $rin, $handle->fileno, 1 ) = 1;
 
-                $c->req->uploads->{ $parameters{filename} } = {
-                    fh   => $fh,
-                    size => ( stat $fh )[7],
-                    type => $part->content_type
-                };
-
-                push( @params, $parameters{filename}, $fh );
-            }
-            else {
-                push( @params, $parameters{name}, $part->content );
-            }
-        }
-    }
-
-    my $parameters = $c->req->parameters;
-
-    while ( my ( $name, $value ) = splice( @params, 0, 2 ) ) {
-
-        if ( exists $parameters->{$name} ) {
-            for ( $parameters->{$name} ) {
-                $_ = [$_] unless ref($_) eq "ARRAY";
-                push( @$_, $value );
-            }
+  READ:
+    {
+        select( $rin, undef, undef, undef );
+        my $rc = $handle->sysread(@_);
+        if ( defined $rc ) {
+            return $rc;
         }
         else {
-            $parameters->{$name} = $value;
+            next READ if $! == EWOULDBLOCK;
+            return;
         }
     }
 }
 
-=item $c->prepare_path
+=item run
 
 =cut
 
-sub prepare_path {
-    my $c = shift;
+# A very very simple HTTP server that initializes a CGI environment
+sub run {
+    my ( $self, $class, $port, $host, $fork ) = @_;
 
-    my $base;
-    {
-        my $scheme = $c->http->request->uri->scheme;
-        my $host   = $c->http->request->uri->host;
-        my $port   = $c->http->request->uri->port;
+    our $GOT_HUP;
+    local $GOT_HUP = 0;
 
-        $base = URI->new;
-        $base->scheme($scheme);
-        $base->host($host);
-        $base->port($port);
+    local $SIG{HUP} = sub { $GOT_HUP = 1; };
 
-        $base = $base->canonical->as_string;
+    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 ) {
+        require Sys::Hostname;
+        $url .= lc Sys::Hostname::hostname();
+    }
+    else {
+        $url .= gethostbyaddr( $host, AF_INET ) || inet_ntoa($host);
     }
+    $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 }
+
+        close HTTPDaemon if defined $pid;
+
+        # Ignore broken pipes as an HTTP server should
+        local $SIG{PIPE} = sub { close Remote };
+        local $SIG{HUP} = (defined $pid ? 'IGNORE' : $SIG{HUP});
+
+        local *STDIN  = \*Remote;
+        local *STDOUT = \*Remote;
+        select STDOUT;
+
+        # 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 );
+        next
+          unless my ( $method, $uri, $protocol ) =
+          $line =~ m/\A(\w+)\s+(\S+)(?:\s+HTTP\/(\d+(?:\.\d+)?))?\z/;
+
+        # We better be careful and just use 1.0
+        $protocol = '1.0';
+
+        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,
+            SERVER_PROTOCOL => "HTTP/$protocol",
+            %ENV,
+        );
 
-    my $path = $c->http->request->uri->path || '/';
-    $path =~ s/^\///;
+        # Parse headers
+        if ( $protocol >= 1 ) {
+            while (1) {
+                my $line = $self->_get_line( \*STDIN );
+                last if $line eq '';
+                next
+                  unless my ( $name, $value ) =
+                  $line =~ m/\A(\w(?:-?\w+)*):\s(.+)\z/;
+
+                $name = uc $name;
+                $name = 'COOKIE' if $name eq 'COOKIES';
+                $name =~ tr/-/_/;
+                $name = 'HTTP_' . $name
+                  unless $name =~ m/\A(?:CONTENT_(?:LENGTH|TYPE)|COOKIE)\z/;
+                if ( exists $ENV{$name} ) {
+                    $ENV{$name} .= "; $value";
+                }
+                else {
+                    $ENV{$name} = $value;
+                }
+            }
+        }
 
-    $c->req->base($base);
-    $c->req->path($path);
+        # Pass flow control to Catalyst
+        $class->handle_request;
+        exit if defined $pid;
+    }
+    continue {
+        close Remote;
+    }
+    close HTTPDaemon;
+    exec {$0}( ( ( -x $0 ) ? () : ($^X) ), $0, @ARGV ) if $GOT_HUP;
 }
 
-=item $c->prepare_request($r)
+sub _get_line {
+    my ( $self, $handle ) = @_;
 
-=cut
+    my $line = '';
 
-sub prepare_request {
-    my ( $c, $http ) = @_;
-    $c->http($http);
-}
-
-=item $c->prepare_uploads
+    while ( sysread( $handle, my $byte, 1 ) ) {
+        last if $byte eq "\012";    # eol
+        $line .= $byte;
+    }
 
-=cut
+    1 while $line =~ s/\s\z//;
 
-sub prepare_uploads {
-    my $c = shift;
+    return $line;
 }
 
 =back
 
 =head1 SEE ALSO
 
-L<Catalyst>.
+L<Catalyst>, L<Catalyst::Engine>.
+
+=head1 AUTHORS
+
+Sebastian Riedel, <sri@cpan.org>
+
+Dan Kubb, <dan.kubb-cpan@onautopilot.com>
 
-=head1 AUTHOR
+=head1 THANKS
 
-Sebastian Riedel, C<sri@cpan.org>
-Christian Hansen, C<ch@ngmedia.com>
+Many parts are ripped out of C<HTTP::Server::Simple> by Jesse Vincent.
 
 =head1 COPYRIGHT