Added a forking test
[catagits/HTTP-Request-AsCGI.git] / lib / HTTP / Request / AsCGI.pm
index 42822c7..cd7394f 100644 (file)
@@ -6,55 +6,73 @@ use bytes;
 use base 'Class::Accessor::Fast';
 
 use Carp;
+use IO::Handle;
 use IO::File;
 
 __PACKAGE__->mk_accessors(qw[ enviroment request stdin stdout stderr ]);
 
-our $VERSION = 0.1;
+our $VERSION = 0.2;
 
 sub new {
     my $class   = shift;
     my $request = shift;
+    
+    unless ( @_ % 2 == 0 && eval { $request->isa('HTTP::Request') } ) {
+        croak(qq/usage: $class->new( \$request [, key => value] )/);
+    }
+    
+    my $self = $class->SUPER::new( { restored => 0, setuped => 0 } );
+    $self->request($request);
+    $self->stdin( IO::File->new_tmpfile );
+    $self->stdout( IO::File->new_tmpfile );
+
+    my $host = $request->header('Host');
+    my $uri  = $request->uri->clone;
+    $uri->scheme('http')    unless $uri->scheme;
+    $uri->host('localhost') unless $uri->host;
+    $uri->port(80)          unless $uri->port;
+    $uri->host_port($host)  unless !$host || ( $host eq $uri->host_port );
+    
+    $uri = $uri->canonical;
 
-    my $self = {
-        request  => $request,
-        restored => 0,
-        setuped  => 0,
-        stdin    => IO::File->new_tmpfile,
-        stdout   => IO::File->new_tmpfile,
-        stderr   => IO::File->new_tmpfile
-    };
-
-    $self->{enviroment} = {
+    my $enviroment = {
         GATEWAY_INTERFACE => 'CGI/1.1',
-        HTTP_HOST         => $request->uri->host_port,
-        PATH_INFO         => $request->uri->path,
-        QUERY_STRING      => $request->uri->query || '',
+        HTTP_HOST         => $uri->host_port,
+        HTTPS             => ( $uri->scheme eq 'https' ) ? 'ON' : 'OFF',  # not in RFC 3875
+        PATH_INFO         => $uri->path,
+        QUERY_STRING      => $uri->query || '',
         SCRIPT_NAME       => '/',
-        SERVER_NAME       => $request->uri->host,
-        SERVER_PORT       => $request->uri->port,
+        SERVER_NAME       => $uri->host,
+        SERVER_PORT       => $uri->port,
         SERVER_PROTOCOL   => $request->protocol || 'HTTP/1.1',
-        SERVER_SOFTWARE   => __PACKAGE__ . "/" . $VERSION,
+        SERVER_SOFTWARE   => "HTTP-Request-AsCGI/$VERSION",
         REMOTE_ADDR       => '127.0.0.1',
         REMOTE_HOST       => 'localhost',
-        REMOTE_PORT       => int( rand(64000) + 1000 ),        # not in RFC 3875
-        REQUEST_URI       => $request->uri->path || '/',       # not in RFC 3875
+        REMOTE_PORT       => int( rand(64000) + 1000 ),                   # not in RFC 3875
+        REQUEST_URI       => $uri->path_query,                            # not in RFC 3875
         REQUEST_METHOD    => $request->method,
         @_
     };
 
     foreach my $field ( $request->headers->header_field_names ) {
 
-        my $key = uc($field);
+        my $key = uc("HTTP_$field");
         $key =~ tr/-/_/;
-        $key = 'HTTP_' . $key unless $field =~ /^Content-(Length|Type)$/;
+        $key =~ s/^HTTP_// if $field =~ /^Content-(Length|Type)$/;
 
-        unless ( exists $self->{enviroment}->{$key} ) {
-            $self->{enviroment}->{$key} = $request->headers->header($field);
+        unless ( exists $enviroment->{$key} ) {
+            $enviroment->{$key} = $request->headers->header($field);
         }
     }
 
-    return $class->SUPER::new($self);
+    unless ( $enviroment->{SCRIPT_NAME} eq '/' && $enviroment->{PATH_INFO} ) {
+        $enviroment->{PATH_INFO} =~ s/^\Q$enviroment->{SCRIPT_NAME}\E/\//;
+        $enviroment->{PATH_INFO} =~ s/^\/+/\//;
+    }
+
+    $self->enviroment($enviroment);
+
+    return $self;
 }
 
 sub setup {
@@ -62,50 +80,57 @@ sub setup {
 
     $self->{restore}->{enviroment} = {%ENV};
 
-    open( $self->{restore}->{stdin}, '>&', STDIN->fileno )
-      or croak("Can't dup stdin: $!");
-
-    open( STDIN, '<&=', $self->stdin->fileno )
-      or croak("Can't open stdin: $!");
-
-    binmode( $self->stdin, ':raw' );
-    binmode( STDIN, ':raw' );
+    binmode( $self->stdin );
 
     if ( $self->request->content_length ) {
 
-        $self->stdin->syswrite( $self->request->content )
+        syswrite( $self->stdin, $self->request->content )
           or croak("Can't write request content to stdin handle: $!");
 
-        $self->stdin->sysseek( 0, SEEK_SET )
+        sysseek( $self->stdin, 0, SEEK_SET )
           or croak("Can't seek stdin handle: $!");
     }
 
+    open( $self->{restore}->{stdin}, '>&', STDIN->fileno )
+      or croak("Can't dup stdin: $!");
+
+    open( STDIN, '<&=', $self->stdin->fileno )
+      or croak("Can't open stdin: $!");
+
+    binmode( STDIN );
+
     if ( $self->stdout ) {
+
         open( $self->{restore}->{stdout}, '>&', STDOUT->fileno )
           or croak("Can't dup stdout: $!");
 
         open( STDOUT, '>&=', $self->stdout->fileno )
           or croak("Can't open stdout: $!");
 
-        binmode( $self->stdout, ':raw' );
-        binmode( STDOUT, ':raw' );
+        binmode( $self->stdout );
+        binmode( STDOUT);
     }
 
     if ( $self->stderr ) {
+
         open( $self->{restore}->{stderr}, '>&', STDERR->fileno )
           or croak("Can't dup stderr: $!");
 
         open( STDERR, '>&=', $self->stderr->fileno )
           or croak("Can't open stderr: $!");
 
-        binmode( $self->stderr, ':raw' );
-        binmode( STDERR, ':raw' );
+        binmode( $self->stderr );
+        binmode( STDERR );
     }
 
     {
         no warnings 'uninitialized';
         %ENV = %{ $self->enviroment };
     }
+    
+    if ( $INC{'CGI.pm'} ) {
+        CGI::initialize_globals();
+    }    
 
     $self->{setuped}++;
 
@@ -115,34 +140,51 @@ sub setup {
 sub response {
     my ( $self, $callback ) = @_;
 
-    return undef unless $self->{setuped};
-    return undef unless $self->{restored};
-    return undef unless $self->{restore}->{stdout};
+    return undef unless $self->stdout;
 
     require HTTP::Response;
 
-    my $message  = undef;
-    my $position = $self->stdin->tell;
-
-    $self->stdout->sysseek( 0, SEEK_SET )
-      or croak("Can't seek stdin handle: $!");
+    seek( $self->stdout, 0, SEEK_SET )
+      or croak("Can't seek stdout handle: $!");
 
+    my $message;
     while ( my $line = $self->stdout->getline ) {
         $message .= $line;
-        last if $line =~ /^\x0d?\x0a$/;
+        last if $message =~ /\x0d?\x0a\x0d?\x0a$/;
     }
 
     unless ( $message =~ /^HTTP/ ) {
-        $message = "HTTP/1.1 200\x0d\x0a" . $message;
+        $message = "HTTP/1.1 200 OK\x0d\x0a" . $message;
+    }
+
+    my $response = HTTP::Response->new;
+    my @headers  = split( /\x0d?\x0a/, $message );
+    my $status   = shift(@headers);
+
+    unless ( $status =~ s/^(HTTP\/\d\.\d) (\d{3}) (.*)$// ) {
+        croak( "Invalid Status-Line: '$status'" );
     }
 
-    my $response = HTTP::Response->parse($message);
+    $response->protocol($1);
+    $response->code($2);
+    $response->message($3);
+
+    my $token = qr/[^][\x00-\x1f\x7f()<>@,;:\\"\/?={} \t]+/;
+
+    foreach my $header (@headers) {
+
+        unless( $header =~ s/^($token):[\t ]*// ) {
+            croak( "Invalid header field name : '$header'" );
+        }
+
+        $response->push_header( $1 => $header );
+    }    
 
     if ( my $code = $response->header('Status') ) {
         $response->code($code);
+        $response->message( HTTP::Status::status_message($code) );
     }
 
-    $response->protocol( $self->request->protocol );
     $response->headers->date( time() );
 
     if ($callback) {
@@ -159,12 +201,12 @@ sub response {
             $length += length($buffer);
             $response->add_content($buffer);
         }
-        $response->content_length($length) unless $response->content_length;
+        
+        if ( $length && !$response->content_length ) {
+            $response->content_length($length);
+        }
     }
 
-    $self->stdout->sysseek( $position, SEEK_SET )
-      or croak("Can't seek stdin handle: $!");
-
     return $response;
 }
 
@@ -176,22 +218,30 @@ sub restore {
     open( STDIN, '>&', $self->{restore}->{stdin} )
       or croak("Can't restore stdin: $!");
 
-    $self->stdin->sysseek( 0, SEEK_SET )
+    sysseek( $self->stdin, 0, SEEK_SET )
       or croak("Can't seek stdin: $!");
 
     if ( $self->{restore}->{stdout} ) {
+
+        STDOUT->flush
+          or croak("Can't flush stdout: $!");
+
         open( STDOUT, '>&', $self->{restore}->{stdout} )
           or croak("Can't restore stdout: $!");
 
-        $self->stdout->sysseek( 0, SEEK_SET )
+        sysseek( $self->stdout, 0, SEEK_SET )
           or croak("Can't seek stdout: $!");
     }
 
     if ( $self->{restore}->{stderr} ) {
+
+        STDERR->flush
+          or croak("Can't flush stderr: $!");
+
         open( STDERR, '>&', $self->{restore}->{stderr} )
           or croak("Can't restore stderr: $!");
 
-        $self->stderr->sysseek( 0, SEEK_SET )
+        sysseek( $self->stderr, 0, SEEK_SET )
           or croak("Can't seek stderr: $!");
     }
 
@@ -233,7 +283,8 @@ HTTP::Request::AsCGI - Setup a CGI enviroment from a HTTP::Request
         
         $stdout = $c->stdout;
         
-        # enviroment and descriptors will automatically be restored when $c is destructed.
+        # enviroment and descriptors will automatically be restored 
+        # when $c is destructed.
     }
     
     while ( my $line = $stdout->getline ) {
@@ -242,31 +293,70 @@ HTTP::Request::AsCGI - Setup a CGI enviroment from a HTTP::Request
     
 =head1 DESCRIPTION
 
+Provides a convinient way of setting up an CGI enviroment from a HTTP::Request.
+
 =head1 METHODS
 
 =over 4 
 
-=item new
+=item new ( $request [, key => value ] )
+
+Contructor, first argument must be a instance of HTTP::Request
+followed by optional pairs of environment key and value.
 
 =item enviroment
 
+Returns a hashref containing the environment that will be used in setup. 
+Changing the hashref after setup has been called will have no effect.
+
 =item setup
 
+Setups the environment and descriptors.
+
 =item restore
 
+Restores the enviroment and descriptors. Can only be called after setup.
+
 =item request
 
+Returns the request given to constructor.
+
 =item response
 
+Returns a HTTP::Response. Can only be called after restore.
+
 =item stdin
 
+Accessor for handle that will be used for STDIN, must be a real seekable
+handle with an file descriptor. Defaults to a tempoary IO::File instance.
+
 =item stdout
 
+Accessor for handle that will be used for STDOUT, must be a real seekable
+handle with an file descriptor. Defaults to a tempoary IO::File instance.
+
 =item stderr
 
+Accessor for handle that will be used for STDERR, must be a real seekable
+handle with an file descriptor.
+
 =back
 
-=head1 BUGS
+=head1 SEE ALSO
+
+=over 4
+
+=item examples directory in this distribution.
+
+=item L<WWW::Mechanize::CGI>
+
+=item L<Test::WWW::Mechanize::CGI>
+
+=back
+
+=head1 THANKS TO
+
+Thomas L. Shinnick for his valuable win32 testing.
 
 =head1 AUTHOR