X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=3a73c04fa2a7b8df2308410139be1c67ccba188f;hb=264bac8c94a84d7dbac9912946d1a639fa37d1cd;hp=544116d89f327d83365dc5e90be2080a80e94672;hpb=7299a7b440fa6c3084ae678e8d32f52066ee84d6;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 544116d..3a73c04 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -2,12 +2,13 @@ package Catalyst::Engine; use strict; use base 'Class::Accessor::Fast'; -use CGI::Cookie; -use Data::Dumper; +use CGI::Simple::Cookie; +use Data::Dump qw/dump/; 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/); @@ -30,13 +31,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. @@ -44,19 +40,24 @@ Finalize body. Prints the response output. sub finalize_body { my ( $self, $c ) = @_; - if ( ref $c->response->body && $c->response->body->can('read') ) { - while ( !$c->response->body->eof() ) { - $c->response->body->read( my $buffer, $CHUNKSIZE ); - $self->write( $c, $buffer ); + 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 ); } - $c->response->body->close(); + close $body; } else { - $self->write( $c, $c->response->body ); + $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 @@ -64,26 +65,37 @@ 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 + + foreach my $name ( keys %{ $c->response->cookies } ) { + + my $val = $c->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) { + $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 @@ -91,18 +103,21 @@ sub finalize_error { my ( $self, $c ) = @_; $c->res->content_type('text/html; charset=utf-8'); - my $name = $c->config->{name} || 'Catalyst Application'; + 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}; @@ -114,24 +129,15 @@ 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; - my @infos; my $i = 0; for my $dump ( $c->dump_these ) { my $name = $dump->[0]; - my $value = encode_entities( Dumper $dump->[1] ); + my $value = encode_entities( dump( $dump->[1] )); push @infos, sprintf <<"EOF", $name, $value; -
- - %s - -
-
+

%s

- 
%s
+ 
%s
EOF $i++; @@ -144,13 +150,12 @@ EOF $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 = ''; @@ -180,49 +185,68 @@ EOF body { font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana, Tahoma, Arial, helvetica, sans-serif; - color: #ddd; + color: #333; background-color: #eee; margin: 0px; padding: 0px; } :link, :link:hover, :visited, :visited:hover { - color: #ddd; + color: #000; } div.box { + position: relative; background-color: #ccc; border: 1px solid #aaa; padding: 4px; margin: 10px; - -moz-border-radius: 10px; } div.error { - background-color: #977; + background-color: #cce; border: 1px solid #755; padding: 8px; margin: 4px; margin-bottom: 10px; - -moz-border-radius: 10px; } div.infos { - background-color: #797; + background-color: #eee; border: 1px solid #575; padding: 8px; margin: 4px; margin-bottom: 10px; - -moz-border-radius: 10px; } div.name { - background-color: #779; + background-color: #cce; border: 1px solid #557; padding: 8px; margin: 4px; - -moz-border-radius: 10px; } code.error { display: block; margin: 1em 0; overflow: auto; - white-space: pre; + } + div.name h1, div.error p { + margin: 0; + } + h2 { + margin-top: 0; + margin-bottom: 10px; + font-size: medium; + font-weight: bold; + text-decoration: underline; + } + h1 { + font-size: medium; + font-weight: normal; + } + /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */ + /* Browser specific (not valid) styles to make preformatted text wrap */ + pre { + white-space: pre-wrap; /* css-3 */ + white-space: -moz-pre-wrap; /* Mozilla, since 1999 */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + word-wrap: break-word; /* Internet Explorer 5.5+ */ } @@ -235,15 +259,23 @@ EOF + + # 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 @@ -253,7 +285,9 @@ sub finalize_read { undef $self->{_prepared_read}; } -=item $self->finalize_uploads($c) +=head2 $self->finalize_uploads($c) + +Clean up after uploads, deleting temp files. =cut @@ -270,7 +304,9 @@ sub finalize_uploads { } } -=item $self->prepare_body($c) +=head2 $self->prepare_body($c) + +sets up the L object body using L =cut @@ -282,16 +318,28 @@ 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->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_chunk($c) +=head2 $self->prepare_body_chunk($c) + +Add a chunk to the request body. =cut @@ -301,7 +349,9 @@ 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 @@ -310,13 +360,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 @@ -324,17 +378,19 @@ 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 @@ -342,13 +398,15 @@ sub prepare_parameters { my ( $self, $c ) = @_; # We copy, no references - while ( my ( $name, $param ) = each %{ $c->request->query_parameters } ) { + 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; } # Merge query and body parameters - while ( my ( $name, $param ) = each %{ $c->request->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' ) { @@ -361,15 +419,19 @@ 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) -=item $self->prepare_query_parameters($c) +=head2 $self->prepare_query_parameters($c) + +process the query string and extract query parameters. =cut @@ -387,7 +449,9 @@ sub prepare_query_parameters { } } -=item $self->prepare_read($c) +=head2 $self->prepare_read($c) + +prepare to read from the engine. =cut @@ -398,13 +462,15 @@ sub prepare_read { $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 @@ -433,13 +499,15 @@ sub prepare_uploads { } } -=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 @@ -472,7 +540,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. @@ -481,22 +549,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. Can only be called once for a request. =cut @@ -511,7 +583,10 @@ sub write { print STDOUT $buffer; } -=back + +=head2 $self->finalize_output + +, see finalize_body =head1 AUTHORS