X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=0389367c3092713fb1e284965051452d3618ead4;hp=ba408f9b56cc517f862b6968400353bc73df59ce;hb=f3414019f472b55682ef3af53f761b6db7955887;hpb=4f5ebacdba8bc446f80d0e8999d117d80f9d2c98 diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index ba408f9..0389367 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,21 +1,26 @@ package Catalyst::Engine; -use strict; -use base 'Class::Accessor::Fast'; -use CGI::Cookie; -use Data::Dumper; +use Class::C3; +use Moose; +with 'MooseX::Emulate::Class::Accessor::Fast'; + +use CGI::Simple::Cookie; +use Data::Dump qw/dump/; +use Errno 'EWOULDBLOCK'; use HTML::Entities; use HTTP::Body; use HTTP::Headers; +use URI::QueryParam; +use Scalar::Util (); # input position and length -__PACKAGE__->mk_accessors(qw/read_position read_length/); +has read_length => (is => 'rw'); +has read_position => (is => 'rw'); -# Stringify to class -use overload '""' => sub { return ref shift }, fallback => 1; +no Moose; # Amount of data to read from input on each pass -our $CHUNKSIZE = 4096; +our $CHUNKSIZE = 64 * 1024; =head1 NAME @@ -29,13 +34,8 @@ See L. =head1 METHODS -=over 4 - -=item $self->finalize_output - -, see finalize_body -=item $self->finalize_body($c) +=head2 $self->finalize_body($c) Finalize body. Prints the response output. @@ -43,11 +43,24 @@ Finalize body. Prints the response output. sub finalize_body { my ( $self, $c ) = @_; - - $self->write( $c, $c->response->output ); + my $body = $c->response->body; + no warnings 'uninitialized'; + if ( Scalar::Util::blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) { + while ( !eof $body ) { + read $body, my ($buffer), $CHUNKSIZE; + last unless $self->write( $c, $buffer ); + } + close $body; + } + else { + $self->write( $c, $body ); + } } -=item $self->finalize_cookies($c) +=head2 $self->finalize_cookies($c) + +Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as +response headers. =cut @@ -55,45 +68,60 @@ sub finalize_cookies { my ( $self, $c ) = @_; my @cookies; - while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) { - - my $cookie = CGI::Cookie->new( - -name => $name, - -value => $cookie->{value}, - -expires => $cookie->{expires}, - -domain => $cookie->{domain}, - -path => $cookie->{path}, - -secure => $cookie->{secure} || 0 + my $response = $c->response; + + foreach my $name (keys %{ $response->cookies }) { + + my $val = $response->cookies->{$name}; + + my $cookie = ( + Scalar::Util::blessed($val) + ? $val + : CGI::Simple::Cookie->new( + -name => $name, + -value => $val->{value}, + -expires => $val->{expires}, + -domain => $val->{domain}, + -path => $val->{path}, + -secure => $val->{secure} || 0 + ) ); push @cookies, $cookie->as_string; } - if (@cookies) { - $c->res->headers->push_header( 'Set-Cookie' => join ',', @cookies ); + for my $cookie (@cookies) { + $response->headers->push_header( 'Set-Cookie' => $cookie ); } } -=item $self->finalize_error($c) +=head2 $self->finalize_error($c) + +Output an apropriate error message, called if there's an error in $c +after the dispatch has finished. Will output debug messages if Catalyst +is in debug mode, or a `please come back later` message otherwise. =cut sub finalize_error { my ( $self, $c ) = @_; - $c->res->headers->content_type('text/html'); - my $name = $c->config->{name} || 'Catalyst Application'; + $c->res->content_type('text/html; charset=utf-8'); + my $name = $c->config->{name} || join(' ', split('::', ref $c)); my ( $title, $error, $infos ); if ( $c->debug ) { # For pretty dumps - local $Data::Dumper::Terse = 1; - $error = join '', - map { '' . encode_entities($_) . '' } - @{ $c->error }; + $error = join '', map { + '

' + . encode_entities($_) + . '

' + } @{ $c->error }; $error ||= 'No output'; + $error = qq{
$error
}; $title = $name = "$name on Catalyst $Catalyst::VERSION"; + $name = "

$name

"; # Don't show context in the dump delete $c->req->{_context}; @@ -102,21 +130,20 @@ sub finalize_error { # Don't show body parser in the dump delete $c->req->{_body}; - # Don't show response header state in dump - delete $c->res->{_finalized_headers}; - - my $req = encode_entities Dumper $c->req; - my $res = encode_entities Dumper $c->res; - my $stash = encode_entities Dumper $c->stash; - $infos = <<""; -
-Request
-
$req
-Response
-
$res
-Stash
-
$stash
- + my @infos; + my $i = 0; + for my $dump ( $c->dump_these ) { + my $name = $dump->[0]; + my $value = encode_entities( dump( $dump->[1] )); + push @infos, sprintf <<"EOF", $name, $value; +

%s

+
+ 
%s
+
+EOF + $i++; + } + $infos = join "\n", @infos; } else { $title = $name; @@ -124,65 +151,103 @@ sub finalize_error { $infos = <<""; 
 (en) Please come back later
+(fr) SVP veuillez revenir plus tard
 (de) Bitte versuchen sie es spaeter nocheinmal
-(nl) Gelieve te komen later terug
+(at) Konnten's bitt'schoen spaeter nochmal reinschauen
 (no) Vennligst prov igjen senere
-(fr) Veuillez revenir plus tard
-(es) Vuelto por favor mas adelante
-(pt) Voltado por favor mais tarde
-(it) Ritornato prego più successivamente
+(dk) Venligst prov igen senere
+(pl) Prosze sprobowac pozniej
$name = ''; } $c->res->body( <<"" ); - + + + + $title + @@ -195,63 +260,85 @@ sub finalize_error { + + # Trick IE + $c->res->{body} .= ( ' ' x 512 ); + + # Return 500 + $c->res->status(500); } -=item $self->finalize_headers($c) +=head2 $self->finalize_headers($c) + +Abstract method, allows engines to write headers to response =cut sub finalize_headers { } -=item $self->finalize_read($c) +=head2 $self->finalize_read($c) =cut -sub finalize_read { - my ( $self, $c ) = @_; +sub finalize_read { } - undef $self->{_prepared_read}; -} +=head2 $self->finalize_uploads($c) -=item $self->finalize_uploads($c) +Clean up after uploads, deleting temp files. =cut sub finalize_uploads { my ( $self, $c ) = @_; - if ( keys %{ $c->request->uploads } ) { - for my $key ( keys %{ $c->request->uploads } ) { - my $upload = $c->request->uploads->{$key}; - unlink map { $_->tempname } - grep { -e $_->tempname } - ref $upload eq 'ARRAY' ? @{$upload} : ($upload); - } + my $request = $c->request; + foreach my $key (keys %{ $request->uploads }) { + my $upload = $request->uploads->{$key}; + unlink grep { -e $_ } map { $_->tempname } + (ref $upload eq 'ARRAY' ? @{$upload} : ($upload)); } + } -=item $self->prepare_body($c) +=head2 $self->prepare_body($c) + +sets up the L object body using L =cut sub prepare_body { my ( $self, $c ) = @_; - $self->read_length( $c->request->header('Content-Length') || 0 ); - my $type = $c->request->header('Content-Type'); - - unless ( $c->request->{_body} ) { - $c->request->{_body} = HTTP::Body->new( $type, $self->read_length ); - } - - if ( $self->read_length > 0 ) { + if ( my $length = $self->read_length ) { + my $request = $c->request; + unless ( $request->{_body} ) { + my $type = $request->header('Content-Type'); + $request->{_body} = HTTP::Body->new( $type, $length ); + $request->{_body}->{tmpdir} = $c->config->{uploadtmp} + if exists $c->config->{uploadtmp}; + } + while ( my $buffer = $self->read($c) ) { $c->prepare_body_chunk($buffer); } + + # paranoia against wrong Content-Length header + my $remaining = $length - $self->read_position; + if ( $remaining > 0 ) { + $self->finalize_read($c); + Catalyst::Exception->throw( + "Wrong Content-Length value: $length" ); + } + } + else { + # Defined but will cause all body code to be skipped + $c->request->{_body} = 0; } } -=item $self->prepare_body_chunk($c) +=head2 $self->prepare_body_chunk($c) + +Add a chunk to the request body. =cut @@ -261,22 +348,31 @@ sub prepare_body_chunk { $c->request->{_body}->add($chunk); } -=item $self->prepare_body_parameters($c) +=head2 $self->prepare_body_parameters($c) + +Sets up parameters from body. =cut sub prepare_body_parameters { my ( $self, $c ) = @_; + + return unless $c->request->{_body}; + $c->request->body_parameters( $c->request->{_body}->param ); } -=item $self->prepare_connection($c) +=head2 $self->prepare_connection($c) + +Abstract method implemented in engines. =cut sub prepare_connection { } -=item $self->prepare_cookies($c) +=head2 $self->prepare_cookies($c) + +Parse cookies from header. Sets a L object. =cut @@ -284,116 +380,188 @@ sub prepare_cookies { my ( $self, $c ) = @_; if ( my $header = $c->request->header('Cookie') ) { - $c->req->cookies( { CGI::Cookie->parse($header) } ); + $c->req->cookies( { CGI::Simple::Cookie->parse($header) } ); } } -=item $self->prepare_headers($c) +=head2 $self->prepare_headers($c) =cut sub prepare_headers { } -=item $self->prepare_parameters($c) +=head2 $self->prepare_parameters($c) + +sets up parameters from query and post parameters. =cut sub prepare_parameters { my ( $self, $c ) = @_; + my $request = $c->request; + my $parameters = $request->parameters; + my $body_parameters = $request->body_parameters; + my $query_parameters = $request->query_parameters; # We copy, no references - while ( my ( $name, $param ) = each %{ $c->request->query_parameters } ) { - $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param; - $c->request->parameters->{$name} = $param; + foreach my $name (keys %$query_parameters) { + my $param = $query_parameters->{$name}; + $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param; } # Merge query and body parameters - while ( my ( $name, $param ) = each %{ $c->request->body_parameters } ) { - $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param; - if ( my $old_param = $c->request->parameters->{$name} ) { - if ( ref $old_param eq 'ARRAY' ) { - push @{ $c->request->parameters->{$name} }, - ref $param eq 'ARRAY' ? @$param : $param; - } - else { $c->request->parameters->{$name} = [ $old_param, $param ] } + foreach my $name (keys %$body_parameters) { + my $param = $body_parameters->{$name}; + my @values = ref $param eq 'ARRAY' ? @$param : ($param); + if ( my $existing = $parameters->{$name} ) { + unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing)); } - else { $c->request->parameters->{$name} = $param } + $parameters->{$name} = @values > 1 ? \@values : $values[0]; } } -=item $self->prepare_path($c) +=head2 $self->prepare_path($c) + +abstract method, implemented by engines. =cut sub prepare_path { } -=item $self->prepare_request($c) +=head2 $self->prepare_request($c) + +=head2 $self->prepare_query_parameters($c) -=item $self->prepare_query_parameters($c) +process the query string and extract query parameters. =cut -sub prepare_query_parameters { } +sub prepare_query_parameters { + my ( $self, $c, $query_string ) = @_; + + # Check for keywords (no = signs) + # (yes, index() is faster than a regex :)) + if ( index( $query_string, '=' ) < 0 ) { + $c->request->query_keywords( $self->unescape_uri($query_string) ); + return; + } + + my %query; + + # replace semi-colons + $query_string =~ s/;/&/g; + + my @params = split /&/, $query_string; + + for my $item ( @params ) { + + my ($param, $value) + = map { $self->unescape_uri($_) } + split( /=/, $item, 2 ); + + $param = $self->unescape_uri($item) unless defined $param; + + if ( exists $query{$param} ) { + if ( ref $query{$param} ) { + push @{ $query{$param} }, $value; + } + else { + $query{$param} = [ $query{$param}, $value ]; + } + } + else { + $query{$param} = $value; + } + } + + $c->request->query_parameters( \%query ); +} + +=head2 $self->prepare_read($c) -=item $self->prepare_read($c) +prepare to read from the engine. =cut sub prepare_read { my ( $self, $c ) = @_; - # Reset the read position + # Initialize the read position $self->read_position(0); + + # Initialize the amount of data we think we need to read + $self->read_length( $c->request->header('Content-Length') || 0 ); } -=item $self->prepare_request(@arguments) +=head2 $self->prepare_request(@arguments) + +Populate the context object from the request object. =cut sub prepare_request { } -=item $self->prepare_uploads($c) +=head2 $self->prepare_uploads($c) =cut sub prepare_uploads { my ( $self, $c ) = @_; - my $uploads = $c->request->{_body}->upload; - for my $name ( keys %$uploads ) { + + my $request = $c->request; + return unless $request->{_body}; + + my $uploads = $request->{_body}->upload; + my $parameters = $request->parameters; + foreach my $name (keys %$uploads) { my $files = $uploads->{$name}; - $files = ref $files eq 'ARRAY' ? $files : [$files]; my @uploads; - for my $upload (@$files) { - my $u = Catalyst::Request::Upload->new; - $u->headers( HTTP::Headers->new( %{ $upload->{headers} } ) ); - $u->type( $u->headers->content_type ); - $u->tempname( $upload->{tempname} ); - $u->size( $upload->{size} ); - $u->filename( $upload->{filename} ); + for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) { + my $headers = HTTP::Headers->new( %{ $upload->{headers} } ); + my $u = Catalyst::Request::Upload->new + ( + size => $upload->{size}, + type => $headers->content_type, + headers => $headers, + tempname => $upload->{tempname}, + filename => $upload->{filename}, + ); push @uploads, $u; } - $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0]; + $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0]; + + # support access to the filename as a normal param + my @filenames = map { $_->{filename} } @uploads; + # append, if there's already params with this name + if (exists $parameters->{$name}) { + if (ref $parameters->{$name} eq 'ARRAY') { + push @{ $parameters->{$name} }, @filenames; + } + else { + $parameters->{$name} = [ $parameters->{$name}, @filenames ]; + } + } + else { + $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0]; + } } } -=item $self->prepare_write($c) +=head2 $self->prepare_write($c) + +Abstract method. Implemented by the engines. =cut sub prepare_write { } -=item $self->read($c, [$maxlength]) +=head2 $self->read($c, [$maxlength]) =cut sub read { my ( $self, $c, $maxlength ) = @_; - unless ( $self->{_prepared_read} ) { - $self->prepare_read($c); - $self->{_prepared_read} = 1; - } - my $remaining = $self->read_length - $self->read_position; $maxlength ||= $CHUNKSIZE; @@ -415,7 +583,7 @@ sub read { } } -=item $self->read_chunk($c, $buffer, $length) +=head2 $self->read_chunk($c, $buffer, $length) Each engine inplements read_chunk as its preferred way of reading a chunk of data. @@ -424,22 +592,26 @@ of data. sub read_chunk { } -=item $self->read_length +=head2 $self->read_length The length of input data to be read. This is obtained from the Content-Length header. -=item $self->read_position +=head2 $self->read_position The amount of input data that has already been read. -=item $self->run($c) +=head2 $self->run($c) + +Start the engine. Implemented by the various engine classes. =cut sub run { } -=item $self->write($c, $buffer) +=head2 $self->write($c, $buffer) + +Writes the buffer to the client. =cut @@ -450,11 +622,52 @@ sub write { $self->prepare_write($c); $self->{_prepared_write} = 1; } + + my $len = length($buffer); + my $wrote = syswrite STDOUT, $buffer; + + if ( !defined $wrote && $! == EWOULDBLOCK ) { + # Unable to write on the first try, will retry in the loop below + $wrote = 0; + } + + if ( defined $wrote && $wrote < $len ) { + # We didn't write the whole buffer + while (1) { + my $ret = syswrite STDOUT, $buffer, $CHUNKSIZE, $wrote; + if ( defined $ret ) { + $wrote += $ret; + } + else { + next if $! == EWOULDBLOCK; + return; + } + + last if $wrote >= $len; + } + } + + return $wrote; +} - print STDOUT $buffer; +=head2 $self->unescape_uri($uri) + +Unescapes a given URI using the most efficient method available. Engines such +as Apache may implement this using Apache's C-based modules, for example. + +=cut + +sub unescape_uri { + my ( $self, $str ) = @_; + + $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg; + + return $str; } -=back +=head2 $self->finalize_output + +, see finalize_body =head1 AUTHORS