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=de506cb54af73eff4b1601153098817888eb5fa0;hp=f378d57d6f4de367b7ac872bcaa21c7c0f20f61b;hb=f63c03e47ae0278e50d513b90ecbbdfd67d1a021;hpb=fbcc39ad23f2bbecf5d84c9ba581e6af86fcd460 diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index f378d57..de506cb 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -3,17 +3,21 @@ package Catalyst::Engine; use strict; use base 'Class::Accessor::Fast'; use CGI::Cookie; -use Data::Dumper; +use Data::Dump qw/dump/; use HTML::Entities; use HTTP::Body; use HTTP::Headers; +use URI::QueryParam; # input position and length -__PACKAGE__->mk_accessors( qw/read_position read_length/ ); +__PACKAGE__->mk_accessors(qw/read_position read_length/); # Stringify to class use overload '""' => sub { return ref shift }, fallback => 1; +# Amount of data to read from input on each pass +our $CHUNKSIZE = 4096; + =head1 NAME Catalyst::Engine - The Catalyst Engine @@ -26,13 +30,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. @@ -40,11 +39,22 @@ Finalize body. Prints the response output. sub finalize_body { my ( $self, $c ) = @_; - - $self->write( $c, $c->response->output ); + my $body = $c->response->body; + if ( ref $body && ( $body->can('read') || 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::Cookies from $c->res->cookies, and set them as response headers. =cut @@ -66,31 +76,38 @@ sub finalize_cookies { push @cookies, $cookie->as_string; } - if (@cookies) { - $c->res->headers->push_header( 'Set-Cookie' => join ',', @cookies ); + for my $cookie (@cookies) { + $c->res->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,18 +119,20 @@ sub finalize_error { # 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; @@ -121,65 +140,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 + @@ -192,25 +249,35 @@ 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 ) = @_; - + undef $self->{_prepared_read}; } -=item $self->finalize_uploads($c) +=head2 $self->finalize_uploads($c) + +Clean up after uploads, deleting temp files. =cut @@ -227,7 +294,9 @@ sub finalize_uploads { } } -=item $self->prepare_body($c) +=head2 $self->prepare_body($c) + +sets up the L object body using L =cut @@ -239,16 +308,40 @@ sub prepare_body { unless ( $c->request->{_body} ) { $c->request->{_body} = HTTP::Body->new( $type, $self->read_length ); + $c->request->{_body}->{tmpdir} = $c->config->{uploadtmp} + if exists $c->config->{uploadtmp}; } - + if ( $self->read_length > 0 ) { - while ( my $buffer = $self->read( $c ) ) { - $c->request->{_body}->add( $buffer ); + while ( my $buffer = $self->read($c) ) { + $c->prepare_body_chunk($buffer); + } + + # paranoia against wrong Content-Length header + my $remaining = $self->read_length - $self->read_position; + if ( $remaining > 0 ) { + $self->finalize_read($c); + Catalyst::Exception->throw( + "Wrong Content-Length value: " . $self->read_length ); } } } -=item $self->prepare_body_parameters($c) +=head2 $self->prepare_body_chunk($c) + +Add a chunk to the request body. + +=cut + +sub prepare_body_chunk { + my ( $self, $c, $chunk ) = @_; + + $c->request->{_body}->add($chunk); +} + +=head2 $self->prepare_body_parameters($c) + +Sets up parameters from body. =cut @@ -257,13 +350,17 @@ sub prepare_body_parameters { $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 @@ -275,13 +372,15 @@ sub prepare_cookies { } } -=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 @@ -308,38 +407,58 @@ sub prepare_parameters { } } -=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 ) = @_; + + # replace semi-colons + $query_string =~ s/;/&/g; + + my $u = URI->new( '', 'http' ); + $u->query($query_string); + for my $key ( $u->query_param ) { + my @vals = $u->query_param($key); + $c->request->query_parameters->{$key} = @vals > 1 ? [@vals] : $vals[0]; + } +} + +=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 - $self->read_position( 0 ); + $self->read_position(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 @@ -360,33 +479,40 @@ sub prepare_uploads { push @uploads, $u; } $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0]; + + # support access to the filename as a normal param + my @filenames = map { $_->{filename} } @uploads; + $c->request->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->prepare_read($c); $self->{_prepared_read} = 1; } - + my $remaining = $self->read_length - $self->read_position; - $maxlength ||= $self->read_length; - + $maxlength ||= $CHUNKSIZE; + # Are we done reading? if ( $remaining <= 0 ) { - $self->finalize_read( $c ); + $self->finalize_read($c); return; } @@ -397,13 +523,12 @@ sub read { return $buffer; } else { - Catalyst::Exception->throw( - message => "Unknown error reading input: $!" - ); + Catalyst::Exception->throw( + message => "Unknown error reading input: $!" ); } } -=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. @@ -412,39 +537,44 @@ 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. Can only be called once for a request. =cut sub write { my ( $self, $c, $buffer ) = @_; - + unless ( $self->{_prepared_write} ) { - $self->prepare_write( $c ); + $self->prepare_write($c); $self->{_prepared_write} = 1; } - - my $handle = $c->response->handle; - - print $handle $buffer; + + print STDOUT $buffer; } -=back + +=head2 $self->finalize_output + +, see finalize_body =head1 AUTHORS