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;
+use IO::Socket::INET ();
+use IO::Select ();
+
+# For PAR
+require Catalyst::Engine::HTTP::Restarter;
+require Catalyst::Engine::HTTP::Restarter::Watcher;
=head1 NAME
=head1 SYNOPSIS
-L<Catalyst>.
+A script using the Catalyst::Engine::HTTP module might look like:
-=head1 DESCRIPTION
+ #!/usr/bin/perl -w
-This Catalyst engine is meant to be subclassed.
+ BEGIN { $ENV{CATALYST_ENGINE} = 'HTTP' }
-=head1 OVERLOADED METHODS
+ use strict;
+ use lib '/path/to/MyApp/lib';
+ use MyApp;
-This class overloads some methods from C<Catalyst::Engine>.
+ MyApp->run;
-=over 4
+=head1 DESCRIPTION
-=item $c->finalize_headers
+This is the Catalyst engine specialized for development and testing.
-=cut
+=head1 METHODS
-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
- );
+=head2 $self->finalize_headers($c)
- $response->header( 'Set-Cookie' => $cookie->as_string );
- }
+=cut
- $c->http->response($response);
+sub finalize_headers {
+ 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);
+ $c->response->headers->header(
+ Connection => $self->_keep_alive ? 'keep-alive' : 'close' );
+ $self->NEXT::finalize_headers($c);
}
-=item $c->finalize_output
+=head2 $self->finalize_read($c)
=cut
-sub finalize_output {
- my $c = shift;
- $c->http->response->content_ref( \$c->response->{output} );
+sub finalize_read {
+ my ( $self, $c ) = @_;
+
+ # Never ever remove this, it would result in random length output
+ # streams if STDIN eq STDOUT (like in the HTTP engine)
+ *STDIN->blocking(1);
+
+ return $self->NEXT::finalize_read($c);
}
-=item $c->prepare_connection
+=head2 $self->prepare_read($c)
=cut
-sub prepare_connection {
- my $c = shift;
- $c->req->hostname( $c->http->hostname );
- $c->req->address( $c->http->address );
+sub prepare_read {
+ my ( $self, $c ) = @_;
+
+ # Set the input handle to non-blocking
+ *STDIN->blocking(0);
+
+ return $self->NEXT::prepare_read($c);
}
-=item $c->prepare_cookies
+=head2 $self->read_chunk($c, $buffer, $length)
=cut
-sub prepare_cookies {
- my $c = shift;
+sub read_chunk {
+ my $self = shift;
+ my $c = shift;
- if ( my $header = $c->http->request->header('Cookie') ) {
- $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
+ # support for non-blocking IO
+ my $rin = '';
+ vec( $rin, *STDIN->fileno, 1 ) = 1;
+
+ READ:
+ {
+ select( $rin, undef, undef, undef );
+ my $rc = *STDIN->sysread(@_);
+ if ( defined $rc ) {
+ return $rc;
+ }
+ else {
+ next READ if $! == EWOULDBLOCK;
+ return;
+ }
}
}
-=item $c->prepare_headers
+=head2 run
=cut
-sub prepare_headers {
- my $c = shift;
- $c->req->method( $c->http->request->method );
- $c->req->headers( $c->http->request->headers );
-}
+# A very very simple HTTP server that initializes a CGI environment
+sub run {
+ my ( $self, $class, $port, $host, $options ) = @_;
-=item $c->prepare_parameters
+ $options ||= {};
-=cut
+ my $restart = 0;
+ local $SIG{CHLD} = 'IGNORE';
-sub prepare_parameters {
- my $c = shift;
+ 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;
+ $host = lc Sys::Hostname::hostname();
+ }
+ else {
+ $host = gethostbyaddr( $addr, AF_INET ) || inet_ntoa($addr);
+ }
- my @params = ();
- my $request = $c->http->request;
+ # Handle requests
- push( @params, $request->uri->query_form );
+ # 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: $!";
- if ( $request->content_type eq 'application/x-www-form-urlencoded' ) {
- my $uri = URI->new('http:');
- $uri->query( $request->content );
- push( @params, $uri->query_form );
- }
+ my $url = "http://$host";
+ $url .= ":$port" unless $port == 80;
- if ( $request->content_type eq 'multipart/form-data' ) {
+ print "You can connect to your server at $url\n";
- for my $part ( $request->parts ) {
+ $self->_keep_alive( $options->{keepalive} || 0 );
- my $disposition = $part->header('Content-Disposition');
- my %parameters = @{ ( split_header_words($disposition) )[0] };
+ my $parent = $$;
+ my $pid = undef;
+ while ( accept( Remote, $daemon ) )
+ { # TODO: get while ( my $remote = $daemon->accept ) to work
- if ( $parameters{filename} ) {
+ select Remote;
- my $fh = IO::File->new_tmpfile;
- $fh->write( $part->content ) or die $!;
- $fh->seek( SEEK_SET, 0 ) or die $!;
+ # Request data
- $c->req->uploads->{ $parameters{filename} } = {
- fh => $fh,
- size => ( stat $fh )[7],
- type => $part->content_type
- };
+ Remote->blocking(1);
- push( @params, $parameters{filename}, $fh );
- }
- else {
- push( @params, $parameters{name}, $part->content );
- }
- }
- }
+ next
+ unless my ( $method, $uri, $protocol ) =
+ $self->_parse_request_line( \*Remote );
- my $parameters = $c->req->parameters;
+ unless ( uc($method) eq 'RESTART' ) {
- while ( my ( $name, $value ) = splice( @params, 0, 2 ) ) {
+ # Fork
+ if ( $options->{fork} ) { next if $pid = fork }
+
+ $self->_handler( $class, $port, $method, $uri, $protocol );
+
+ $daemon->close if defined $pid;
- if ( exists $parameters->{$name} ) {
- for ( $parameters->{$name} ) {
- $_ = [$_] unless ref($_) eq "ARRAY";
- push( @$_, $value );
- }
}
else {
- $parameters->{$name} = $value;
+ 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;
}
-=item $c->prepare_path
+sub _handler {
+ my ( $self, $class, $port, $method, $uri, $protocol ) = @_;
-=cut
+ # Ignore broken pipes as an HTTP server should
+ local $SIG{PIPE} = sub { close Remote };
-sub prepare_path {
- my $c = shift;
+ local *STDIN = \*Remote;
+ local *STDOUT = \*Remote;
- my $base;
- {
- my $scheme = $c->http->request->uri->scheme;
- my $host = $c->http->request->uri->host;
- my $port = $c->http->request->uri->port;
+ # We better be careful and just use 1.0
+ $protocol = '1.0';
+
+ my $sockdata = $self->_socket_data( \*Remote );
+ my %copy_of_env = %ENV;
+
+ my $sel = IO::Select->new;
+ $sel->add( \*STDIN );
- $base = URI->new;
- $base->scheme($scheme);
- $base->host($host);
- $base->port($port);
+ while (1) {
+ my ( $path, $query_string ) = split /\?/, $uri, 2;
- $base = $base->canonical->as_string;
+ # Initialize CGI environment
+ local %ENV = (
+ 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",
+ %copy_of_env,
+ );
+
+ # 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;
+ }
+ }
+ }
+
+ # Pass flow control to Catalyst
+ $class->handle_request;
+
+ 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 );
}
- my $path = $c->http->request->uri->path || '/';
- $path =~ s/^\///;
+ close Remote;
+}
+
+sub _keep_alive {
+ my ( $self, $keepalive ) = @_;
+
+ my $r = $self->{_keepalive} || 0;
+ $self->{_keepalive} = $keepalive if defined $keepalive;
+
+ return $r;
- $c->req->base($base);
- $c->req->path($path);
}
-=item $c->prepare_request($r)
+sub _parse_request_line {
+ my ( $self, $handle ) = @_;
-=cut
+ # 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",
+ };
-sub prepare_request {
- my ( $c, $http ) = @_;
- $c->http($http);
+ return $data;
}
-=item $c->prepare_uploads
+sub _get_line {
+ my ( $self, $handle ) = @_;
-=cut
+ my $line = '';
+
+ while ( sysread( $handle, my $byte, 1 ) ) {
+ last if $byte eq "\012"; # eol
+ $line .= $byte;
+ }
+
+ 1 while $line =~ s/\s\z//;
-sub prepare_uploads {
- my $c = shift;
+ return $line;
}
-=back
+sub _inet_addr { unpack "N*", inet_aton( $_[0] ) }
=head1 SEE ALSO
-L<Catalyst>.
+L<Catalyst>, L<Catalyst::Engine>.
+
+=head1 AUTHORS
+
+Sebastian Riedel, <sri@cpan.org>
+
+Dan Kubb, <dan.kubb-cpan@onautopilot.com>
+
+Sascha Kiefer, <esskar@cpan.org>
-=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
projects / catagits/Catalyst-Runtime.git / blobdiff