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=509585f218c4dcdc9814e0fa67ae24484945a2ea;hp=1f22735f53a5dd151bcad801102d34da026c9aab;hb=671123ba662cd4d38ee2590baad2b9f46947cb4e;hpb=7fa2c9c1b85c98786655ad5169708d8dc84e8353 diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 1f22735..509585f 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -10,14 +10,16 @@ use HTML::Entities; use HTTP::Body; use HTTP::Headers; use URI::QueryParam; -use Scalar::Util (); + +use namespace::clean -except => 'meta'; + +has env => (is => 'rw'); # input position and 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; @@ -45,11 +47,13 @@ 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' ) { - while ( !eof $body ) { - read $body, my ($buffer), $CHUNKSIZE; - last unless $self->write( $c, $buffer ); - } + if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) { + my $got; + do { + $got = read $body, my ($buffer), $CHUNKSIZE; + $got = 0 unless $self->write( $c, $buffer ); + } while $got > 0; + close $body; } else { @@ -70,10 +74,12 @@ sub finalize_cookies { my @cookies; my $response = $c->response; - while( my($name, $val) = each %{ $response->cookies } ) { + foreach my $name (keys %{ $response->cookies }) { + + my $val = $response->cookies->{$name}; my $cookie = ( - Scalar::Util::blessed($val) + blessed($val) ? $val : CGI::Simple::Cookie->new( -name => $name, @@ -81,7 +87,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, ) ); @@ -95,17 +102,35 @@ sub finalize_cookies { =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. =cut +sub _dump_error_page_element { + my ($self, $i, $element) = @_; + my ($name, $val) = @{ $element }; + + # This is fugly, but the metaclass is _HUGE_ and demands waaay too much + # scrolling. Suggestions for more pleasant ways to do this welcome. + local $val->{'__MOP__'} = "Stringified: " + . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'}; + + my $text = encode_entities( dump( $val )); + sprintf <<"EOF", $name, $text; +

%s

+
+ 
%s
+
+EOF +} + sub finalize_error { my ( $self, $c ) = @_; $c->res->content_type('text/html; charset=utf-8'); - my $name = $c->config->{name} || join(' ', split('::', ref $c)); + my $name = ref($c)->config->{name} || join(' ', split('::', ref $c)); my ( $title, $error, $infos ); if ( $c->debug ) { @@ -122,26 +147,16 @@ 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; 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 + push @infos, $self->_dump_error_page_element($i, $dump); $i++; } $infos = join "\n", @infos; @@ -158,6 +173,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 = ''; @@ -262,7 +280,8 @@ EOF - # Trick IE + # Trick IE. Old versions of IE would display their own error page instead + # of ours if we'd give it less than 512 bytes. $c->res->{body} .= ( ' ' x 512 ); # Return 500 @@ -292,8 +311,11 @@ Clean up after uploads, deleting temp files. sub finalize_uploads { my ( $self, $c ) = @_; + # N.B. This code is theoretically entirely unneeded due to ->cleanup(1) + # on the HTTP::Body object. my $request = $c->request; - while( my($key,$upload) = each %{ $request->uploads } ) { + foreach my $key (keys %{ $request->uploads }) { + my $upload = $request->uploads->{$key}; unlink grep { -e $_ } map { $_->tempname } (ref $upload eq 'ARRAY' ? @{$upload} : ($upload)); } @@ -309,16 +331,19 @@ sets up the L object body using L sub prepare_body { my ( $self, $c ) = @_; + my $appclass = ref($c) || $c; if ( my $length = $self->read_length ) { my $request = $c->request; - unless ( $request->{_body} ) { + 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}; + $request->_body(HTTP::Body->new( $type, $length )); + $request->_body->cleanup(1); # Make extra sure! + $request->_body->tmpdir( $appclass->config->{uploadtmp} ) + if exists $appclass->config->{uploadtmp}; } - while ( my $buffer = $self->read($c) ) { + # Check for definedness as you could read '0' + while ( defined ( my $buffer = $self->read($c) ) ) { $c->prepare_body_chunk($buffer); } @@ -332,7 +357,7 @@ sub prepare_body { } else { # Defined but will cause all body code to be skipped - $c->request->{_body} = 0; + $c->request->_body(0); } } @@ -345,7 +370,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) @@ -357,9 +382,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) @@ -404,12 +429,14 @@ sub prepare_parameters { my $body_parameters = $request->body_parameters; my $query_parameters = $request->query_parameters; # We copy, no references - while( my($name, $param) = each(%$query_parameters) ) { + 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(%$body_parameters) ) { + 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)); @@ -449,7 +476,7 @@ 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 ) { @@ -507,18 +534,19 @@ sub prepare_uploads { my ( $self, $c ) = @_; my $request = $c->request; - return unless $request->{_body}; + return unless $request->_body; - my $uploads = $request->{_body}->upload; + my $uploads = $request->_body->upload; my $parameters = $request->parameters; - while(my($name,$files) = each(%$uploads) ) { + foreach my $name (keys %$uploads) { + my $files = $uploads->{$name}; my @uploads; 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, + type => scalar $headers->content_type, headers => $headers, tempname => $upload->{tempname}, filename => $upload->{filename}, @@ -554,6 +582,10 @@ sub prepare_write { } =head2 $self->read($c, [$maxlength]) +Reads from the input stream by calling C<< $self->read_chunk >>. + +Maintains the read_length and read_position counters as data is read. + =cut sub read { @@ -571,6 +603,11 @@ sub read { my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining; my $rc = $self->read_chunk( $c, my $buffer, $readlen ); if ( defined $rc ) { + if (0 == $rc) { # Nothing more to read even though Content-Length + # said there should be. FIXME - Warn in the log here? + $self->finalize_read; + return; + } $self->read_position( $self->read_position + $rc ); return $buffer; } @@ -582,8 +619,9 @@ sub read { =head2 $self->read_chunk($c, $buffer, $length) -Each engine inplements read_chunk as its preferred way of reading a chunk -of data. +Each engine implements read_chunk as its preferred way of reading a chunk +of data. Returns the number of bytes read. A return of 0 indicates that +there is no more data to be read. =cut @@ -615,11 +653,13 @@ Writes the buffer to the client. 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); } + return 0 if !defined $buffer; + my $len = length($buffer); my $wrote = syswrite STDOUT, $buffer; @@ -666,15 +706,25 @@ sub unescape_uri { , see finalize_body -=head1 AUTHORS +=head2 $self->env + +Hash containing environment variables including many special variables inserted +by WWW server - like SERVER_*, REMOTE_*, HTTP_* ... -Sebastian Riedel, +Before accessing environment variables consider whether the same information is +not directly available via Catalyst objects $c->request, $c->engine ... + +BEWARE: If you really need to access some environment 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