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=d66bb5defaf4ad9737debefe16235ab19bf64c93;hp=5c8b17f8d4433859395f698d17d1f62cc3f7d9e4;hb=536bee890cf24e0e4bcda7562e7b70cc03ca0620;hpb=94b8f5dec021a418afb9c086b6286f22f18ff1a1 diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 5c8b17f..d66bb5d 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,21 +1,25 @@ package Catalyst::Engine; -use strict; -use base 'Class::Accessor::Fast'; +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::Escape (); use URI::QueryParam; -use Scalar::Util (); + +use namespace::clean -except => 'meta'; + +has env => (is => 'rw'); # 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; +has _prepared_write => (is => 'rw'); # Amount of data to read from input on each pass our $CHUNKSIZE = 64 * 1024; @@ -43,7 +47,7 @@ sub finalize_body { my ( $self, $c ) = @_; my $body = $c->response->body; no warnings 'uninitialized'; - if ( Scalar::Util::blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) { + if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) { while ( !eof $body ) { read $body, my ($buffer), $CHUNKSIZE; last unless $self->write( $c, $buffer ); @@ -66,13 +70,14 @@ sub finalize_cookies { my ( $self, $c ) = @_; my @cookies; + my $response = $c->response; - foreach my $name ( keys %{ $c->response->cookies } ) { + foreach my $name (keys %{ $response->cookies }) { - my $val = $c->response->cookies->{$name}; + my $val = $response->cookies->{$name}; my $cookie = ( - Scalar::Util::blessed($val) + blessed($val) ? $val : CGI::Simple::Cookie->new( -name => $name, @@ -80,7 +85,8 @@ sub finalize_cookies { -expires => $val->{expires}, -domain => $val->{domain}, -path => $val->{path}, - -secure => $val->{secure} || 0 + -secure => $val->{secure} || 0, + -httponly => $val->{httponly} || 0, ) ); @@ -88,13 +94,13 @@ sub finalize_cookies { } for my $cookie (@cookies) { - $c->res->headers->push_header( 'Set-Cookie' => $cookie ); + $response->headers->push_header( 'Set-Cookie' => $cookie ); } } =head2 $self->finalize_error($c) -Output an apropriate error message, called if there's an error in $c +Output an appropriate 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. @@ -121,14 +127,11 @@ sub finalize_error { $name = "

$name

"; # Don't show context in the dump - delete $c->req->{_context}; - delete $c->res->{_context}; + $c->req->_clear_context; + $c->res->_clear_context; # 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}; + $c->req->_clear_body; my @infos; my $i = 0; @@ -157,6 +160,9 @@ EOF (no) Vennligst prov igjen senere (dk) Venligst prov igen senere (pl) Prosze sprobowac pozniej +(pt) Por favor volte mais tarde +(ru) Попробуйте еще раз позже +(ua) Спробуйте ще раз пізніше $name = ''; @@ -280,11 +286,7 @@ sub finalize_headers { } =cut -sub finalize_read { - my ( $self, $c ) = @_; - - undef $self->{_prepared_read}; -} +sub finalize_read { } =head2 $self->finalize_uploads($c) @@ -295,14 +297,13 @@ Clean up after uploads, deleting temp files. 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)); } + } =head2 $self->prepare_body($c) @@ -313,16 +314,13 @@ sets up the L object body using L sub prepare_body { my ( $self, $c ) = @_; - - my $length = $c->request->header('Content-Length') || 0; - $self->read_length( $length ); - - if ( $length > 0 ) { - unless ( $c->request->{_body} ) { - my $type = $c->request->header('Content-Type'); - $c->request->{_body} = HTTP::Body->new( $type, $length ); - $c->request->{_body}->{tmpdir} = $c->config->{uploadtmp} + 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}; } @@ -340,7 +338,7 @@ sub prepare_body { } else { # Defined but will cause all body code to be skipped - $c->request->{_body} = 0; + $c->request->_body(0); } } @@ -353,7 +351,7 @@ Add a chunk to the request body. sub prepare_body_chunk { my ( $self, $c, $chunk ) = @_; - $c->request->{_body}->add($chunk); + $c->request->_body->add($chunk); } =head2 $self->prepare_body_parameters($c) @@ -365,9 +363,9 @@ Sets up parameters from body. sub prepare_body_parameters { my ( $self, $c ) = @_; - return unless $c->request->{_body}; + return unless $c->request->_body; - $c->request->body_parameters( $c->request->{_body}->param ); + $c->request->body_parameters( $c->request->_body->param ); } =head2 $self->prepare_connection($c) @@ -407,25 +405,24 @@ sets up parameters from query and post parameters. 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 - foreach my $name ( keys %{ $c->request->query_parameters } ) { - my $param = $c->request->query_parameters->{$name}; - $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 - foreach my $name ( keys %{ $c->request->body_parameters } ) { - my $param = $c->request->body_parameters->{$name}; - $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]; } } @@ -448,8 +445,10 @@ process the query string and extract query parameters. sub prepare_query_parameters { my ( $self, $c, $query_string ) = @_; - # Make sure query has params + # 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; } @@ -458,13 +457,13 @@ sub prepare_query_parameters { # replace semi-colons $query_string =~ s/;/&/g; - my @params = split /&/, $query_string; + my @params = grep { length $_ } split /&/, $query_string; for my $item ( @params ) { my ($param, $value) = map { $self->unescape_uri($_) } - split( /=/, $item ); + split( /=/, $item, 2 ); $param = $self->unescape_uri($item) unless defined $param; @@ -493,8 +492,11 @@ prepare to read from the engine. 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 ); } =head2 $self->prepare_request(@arguments) @@ -511,40 +513,42 @@ sub prepare_request { } sub prepare_uploads { my ( $self, $c ) = @_; - - return unless $c->request->{_body}; - - 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 $c->request->parameters->{$name}) { - if (ref $c->request->parameters->{$name} eq 'ARRAY') { - push @{ $c->request->parameters->{$name} }, @filenames; + if (exists $parameters->{$name}) { + if (ref $parameters->{$name} eq 'ARRAY') { + push @{ $parameters->{$name} }, @filenames; } else { - $c->request->parameters->{$name} = - [ $c->request->parameters->{$name}, @filenames ]; + $parameters->{$name} = [ $parameters->{$name}, @filenames ]; } } else { - $c->request->parameters->{$name} = - @filenames > 1 ? \@filenames : $filenames[0]; + $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0]; } } } @@ -564,11 +568,6 @@ sub prepare_write { } 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; @@ -592,7 +591,7 @@ sub read { =head2 $self->read_chunk($c, $buffer, $length) -Each engine inplements read_chunk as its preferred way of reading a chunk +Each engine implements read_chunk as its preferred way of reading a chunk of data. =cut @@ -618,19 +617,45 @@ sub run { } =head2 $self->write($c, $buffer) -Writes the buffer to the client. Can only be called once for a request. +Writes the buffer to the client. =cut sub write { my ( $self, $c, $buffer ) = @_; - unless ( $self->{_prepared_write} ) { + unless ( $self->_prepared_write ) { $self->prepare_write($c); - $self->{_prepared_write} = 1; + $self->_prepared_write(1); } - - print STDOUT $buffer; + + return 0 if !defined $buffer; + + 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; } =head2 $self->unescape_uri($uri) @@ -641,27 +666,36 @@ as Apache may implement this using Apache's C-based modules, for example. =cut sub unescape_uri { - my $self = shift; - - my $e = URI::Escape::uri_unescape(@_); - $e =~ s/\+/ /g; - - return $e; + my ( $self, $str ) = @_; + + $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg; + + return $str; } =head2 $self->finalize_output , see finalize_body -=head1 AUTHORS +=head2 $self->env + +Hash containing enviroment variables including many special variables inserted +by WWW server - like SERVER_*, REMOTE_*, HTTP_* ... + +Before accesing enviroment variables consider whether the same information is +not directly available via Catalyst objects $c->request, $c->engine ... -Sebastian Riedel, +BEWARE: If you really need to access some enviroment variable from your Catalyst +application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME}, +as in some enviroments the %ENV hash does not contain what you would expect. + +=head1 AUTHORS -Andy Grundman, +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut