use strict;
use warnings;
+use bytes;
use base 'Class::Accessor::Fast';
use Carp;
+use IO::Handle;
use IO::File;
-__PACKAGE__->mk_accessors( qw[ enviroment request stdin stdout stderr ] );
+__PACKAGE__->mk_accessors(qw[ enviroment request stdin stdout stderr ]);
our $VERSION = 0.1;
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 = {
request => $request,
restored => 0,
+ setuped => 0,
stdin => IO::File->new_tmpfile,
- stdout => IO::File->new_tmpfile,
- stderr => IO::File->new_tmpfile
+ 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 );
+
$self->{enviroment} = {
GATEWAY_INTERFACE => 'CGI/1.1',
- HTTP_HOST => $request->uri->host_port,
- QUERY_STRING => $request->uri->query || '',
- SCRIPT_NAME => $request->uri->path || '/',
- SERVER_NAME => $request->uri->host,
- SERVER_PORT => $request->uri->port,
+ 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 => $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);
- $key =~ tr/_/-/;
+ $key =~ tr/-/_/;
$key = 'HTTP_' . $key unless $field =~ /^Content-(Length|Type)$/;
unless ( exists $self->{enviroment}->{$key} ) {
sub setup {
my $self = shift;
- open( my $stdin, '>&', STDIN->fileno )
- or croak("Can't dup stdin: $!");
+ $self->{restore}->{enviroment} = {%ENV};
- open( my $stdout, '>&', STDOUT->fileno )
- or croak("Can't dup stdout: $!");
+ open( $self->{restore}->{stdin}, '>&', STDIN->fileno )
+ or croak("Can't dup stdin: $!");
- open( my $stderr, '>&', STDERR->fileno )
- or croak("Can't dup stderr: $!");
+ open( STDIN, '<&=', $self->stdin->fileno )
+ or croak("Can't open stdin: $!");
- $self->{restore} = {
- stdin => $stdin,
- stdout => $stdout,
- stderr => $stderr,
- enviroment => {%ENV}
- };
+ binmode( $self->stdin );
+ binmode( STDIN );
if ( $self->request->content_length ) {
- $self->stdin->write( $self->request->content )
- or croak("Can't write content: $!");
+ syswrite( $self->stdin, $self->request->content )
+ or croak("Can't write request content to stdin handle: $!");
- seek( $self->stdin, 0, 0 )
- or croak("Can't seek stdin: $!");
+ sysseek( $self->stdin, 0, SEEK_SET )
+ or croak("Can't seek stdin handle: $!");
}
- %ENV = %{ $self->enviroment };
+ if ( $self->stdout ) {
- open( STDIN, '<&=', $self->stdin->fileno )
- or croak("Can't open stdin: $!");
+ open( $self->{restore}->{stdout}, '>&', STDOUT->fileno )
+ or croak("Can't dup stdout: $!");
- open( STDOUT, '>&=', $self->stdout->fileno )
- or croak("Can't open stdout: $!");
+ open( STDOUT, '>&=', $self->stdout->fileno )
+ or croak("Can't open stdout: $!");
- open( STDERR, '>&=', $self->stderr->fileno )
- or croak("Can't open stderr: $!");
+ 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 );
+ binmode( STDERR );
+ }
+
+ {
+ no warnings 'uninitialized';
+ %ENV = %{ $self->enviroment };
+ }
+
+ if ( $INC{'CGI.pm'} ) {
+ CGI::initialize_globals();
+ }
+
+ $self->{setuped}++;
return $self;
}
+sub response {
+ my ( $self, $callback ) = @_;
+
+ return undef unless $self->{setuped};
+ return undef unless $self->{restored};
+ return undef unless $self->{restore}->{stdout};
+
+ require HTTP::Response;
+
+ 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 $message =~ /\x0d?\x0a\x0d?\x0a$/;
+ }
+
+ unless ( $message =~ /^HTTP/ ) {
+ $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'" );
+ }
+
+ $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->headers->date( time() );
+
+ if ($callback) {
+ $response->content( sub {
+ if ( $self->stdout->read( my $buffer, 4096 ) ) {
+ return $buffer;
+ }
+ return undef;
+ });
+ }
+ else {
+ my $length = 0;
+ while ( $self->stdout->read( my $buffer, 4096 ) ) {
+ $length += length($buffer);
+ $response->add_content($buffer);
+ }
+
+ if ( $length && !$response->content_length ) {
+ $response->content_length($length);
+ }
+ }
+
+ return $response;
+}
+
sub restore {
my $self = shift;
open( STDIN, '>&', $self->{restore}->{stdin} )
or croak("Can't restore stdin: $!");
- open( STDOUT, '>&', $self->{restore}->{stdout} )
- or croak("Can't restore stdout: $!");
+ 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: $!");
+
+ 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: $!");
+
+ sysseek( $self->stderr, 0, SEEK_SET )
+ or croak("Can't seek stderr: $!");
+ }
- open( STDERR, '>&', $self->{restore}->{stderr} )
- or croak("Can't restore stderr: $!");
-
$self->{restored}++;
+
+ return $self;
}
sub DESTROY {
my $self = shift;
- $self->restore unless $self->{restored};
+ $self->restore if $self->{setuped} && !$self->{restored};
}
1;
$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.
}
- $stdout->seek( 0, 0 );
-
while ( my $line = $stdout->getline ) {
print $line;
}
=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 keys and values.
=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 THANKS TO
+
+Thomas L. Shinnick for his valuable win32 testing.
=head1 AUTHOR