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=e4f22da1a8bbbcd0c0c004d768d935c22abfd6ec;hb=f63c03e47ae0278e50d513b90ecbbdfd67d1a021;hpb=f05af9ba770db5ada00fc0fb593560f39cc6b817 diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index e4f22da..de506cb 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,34 +1,22 @@ package Catalyst::Engine; use strict; -use base qw/Class::Data::Inheritable Class::Accessor::Fast/; -use attributes (); -use UNIVERSAL::require; +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 Time::HiRes qw/gettimeofday tv_interval/; -use Text::ASCIITable; -use Catalyst::Request; -use Catalyst::Request::Upload; -use Catalyst::Response; +use URI::QueryParam; -require Module::Pluggable::Fast; +# input position and length +__PACKAGE__->mk_accessors(qw/read_position read_length/); -# For pretty dumps -$Data::Dumper::Terse = 1; +# Stringify to class +use overload '""' => sub { return ref shift }, fallback => 1; -__PACKAGE__->mk_classdata('components'); -__PACKAGE__->mk_accessors(qw/request response state/); - -*comp = \&component; -*req = \&request; -*res = \&response; - -# For statistics -our $COUNT = 1; -our $START = time; +# Amount of data to read from input on each pass +our $CHUNKSIZE = 4096; =head1 NAME @@ -42,164 +30,40 @@ See L. =head1 METHODS -=over 4 - -=item $c->benchmark($coderef) -Takes a coderef with arguments and returns elapsed time as float. +=head2 $self->finalize_body($c) - my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } ); - $c->log->info( sprintf "Processing took %f seconds", $elapsed ); +Finalize body. Prints the response output. =cut -sub benchmark { - my $c = shift; - my $code = shift; - my $time = [gettimeofday]; - my @return = &$code(@_); - my $elapsed = tv_interval $time; - return wantarray ? ( $elapsed, @return ) : $elapsed; -} - -=item $c->comp($name) - -=item $c->component($name) - -Get a component object by name. - - $c->comp('MyApp::Model::MyModel')->do_stuff; - -Regex search for a component. - - $c->comp('mymodel')->do_stuff; - -=cut - -sub component { - my ( $c, $name ) = @_; - - if ( my $component = $c->components->{$name} ) { - return $component; - } - - else { - for my $component ( keys %{ $c->components } ) { - return $c->components->{$component} if $component =~ /$name/i; +sub finalize_body { + my ( $self, $c ) = @_; + 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; } - -} - -=item $c->error - -=item $c->error($error, ...) - -=item $c->error($arrayref) - -Returns an arrayref containing error messages. - - my @error = @{ $c->error }; - -Add a new error. - - $c->error('Something bad happened'); - -=cut - -sub error { - my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; -} - -=item $c->execute($class, $coderef) - -Execute a coderef in given class and catch exceptions. -Errors are available via $c->error. - -=cut - -sub execute { - my ( $c, $class, $code ) = @_; - $class = $c->comp($class) || $class; - $c->state(0); - my $callsub = ( caller(1) )[3]; - - eval { - if ( $c->debug ) - { - my $action = $c->actions->{reverse}->{"$code"}; - $action = "/$action" unless $action =~ /\-\>/; - $action = "-> $action" if $callsub =~ /forward$/; - my ( $elapsed, @state ) = - $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; - $c->state(@state); - } - else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) } - }; - - if ( my $error = $@ ) { - - unless ( ref $error ) { - chomp $error; - $error = qq/Caught exception "$error"/; - } - - $c->log->error($error); - $c->error($error); - $c->state(0); - } - return $c->state; -} - -=item $c->finalize - -Finalize request. - -=cut - -sub finalize { - my $c = shift; - - $c->finalize_cookies; - - if ( my $location = $c->response->redirect ) { - $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; - $c->response->header( Location => $location ); - $c->response->status(302) if $c->response->status !~ /^3\d\d$/; - } - - if ( $#{ $c->error } >= 0 ) { - $c->finalize_error; - } - - if ( !$c->response->output && $c->response->status !~ /^(1|3)\d\d$/ ) { - $c->finalize_error; - } - - if ( $c->response->output && !$c->response->content_length ) { - use bytes; # play safe with a utf8 aware perl - $c->response->content_length( length $c->response->output ); + else { + $self->write( $c, $body ); } - - my $status = $c->finalize_headers; - $c->finalize_output; - return $status; } -=item $c->finalize_cookies +=head2 $self->finalize_cookies($c) -Finalize cookies. +Create CGI::Cookies from $c->res->cookies, and set them as response headers. =cut sub finalize_cookies { - my $c = shift; + my ( $self, $c ) = @_; + my @cookies; while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) { + my $cookie = CGI::Cookie->new( -name => $name, -value => $cookie->{value}, @@ -209,39 +73,66 @@ sub finalize_cookies { -secure => $cookie->{secure} || 0 ); - $c->res->headers->push_header( 'Set-Cookie' => $cookie->as_string ); + push @cookies, $cookie->as_string; + } + + for my $cookie (@cookies) { + $c->res->headers->push_header( 'Set-Cookie' => $cookie ); } } -=item $c->finalize_error +=head2 $self->finalize_error($c) -Finalize error. +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 $c = shift; + 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 ) { - $error = join '
', @{ $c->error }; + + # For pretty dumps + $error = join '', map { + '

' + . encode_entities($_) + . '

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

$name

"; + + # Don't show context in the dump + delete $c->req->{_context}; + delete $c->res->{_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}; + + 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; @@ -249,59 +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->output( <<"" ); - + $c->res->body( <<"" ); + + + + $title + @@ -314,375 +249,338 @@ sub finalize_error { + + # Trick IE + $c->res->{body} .= ( ' ' x 512 ); + + # Return 500 + $c->res->status(500); } -=item $c->finalize_headers +=head2 $self->finalize_headers($c) -Finalize headers. +Abstract method, allows engines to write headers to response =cut sub finalize_headers { } -=item $c->finalize_output - -Finalize output. +=head2 $self->finalize_read($c) =cut -sub finalize_output { } +sub finalize_read { + my ( $self, $c ) = @_; -=item $c->handler( $class, $r ) + undef $self->{_prepared_read}; +} -Handles the request. +=head2 $self->finalize_uploads($c) -=cut +Clean up after uploads, deleting temp files. -sub handler { - my ( $class, $engine ) = @_; - - # Always expect worst case! - my $status = -1; - eval { - my @stats = (); - - my $handler = sub { - my $c = $class->prepare($engine); - $c->{stats} = \@stats; - $c->dispatch; - return $c->finalize; - }; - - if ( $class->debug ) { - my $elapsed; - ( $elapsed, $status ) = $class->benchmark($handler); - $elapsed = sprintf '%f', $elapsed; - my $av = sprintf '%.3f', 1 / $elapsed; - my $t = Text::ASCIITable->new; - $t->setCols( 'Action', 'Time' ); - $t->setColWidth( 'Action', 64, 1 ); - $t->setColWidth( 'Time', 9, 1 ); - - for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) } - $class->log->info( "Request took $elapsed" . "s ($av/s)", - $t->draw ); - } - else { $status = &$handler } +=cut - }; +sub finalize_uploads { + my ( $self, $c ) = @_; - if ( my $error = $@ ) { - chomp $error; - $class->log->error(qq/Caught exception in engine "$error"/); + 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); + } } - - $COUNT++; - return $status; } -=item $c->prepare($r) +=head2 $self->prepare_body($c) -Turns the engine-specific request( Apache, CGI ... ) -into a Catalyst context . +sets up the L object body using L =cut -sub prepare { - my ( $class, $r ) = @_; - - my $c = bless { - request => Catalyst::Request->new( - { - arguments => [], - cookies => {}, - headers => HTTP::Headers->new, - parameters => {}, - snippets => [], - uploads => {} - } - ), - response => Catalyst::Response->new( - { cookies => {}, headers => HTTP::Headers->new, status => 200 } - ), - stash => {}, - state => 0 - }, $class; +sub prepare_body { + my ( $self, $c ) = @_; - if ( $c->debug ) { - my $secs = time - $START || 1; - my $av = sprintf '%.3f', $COUNT / $secs; - $c->log->debug('**********************************'); - $c->log->debug("* Request $COUNT ($av/s) [$$]"); - $c->log->debug('**********************************'); - $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); + $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 ); + $c->request->{_body}->{tmpdir} = $c->config->{uploadtmp} + if exists $c->config->{uploadtmp}; } - $c->prepare_request($r); - $c->prepare_path; - $c->prepare_headers; - $c->prepare_input; - $c->prepare_cookies; - $c->prepare_connection; - - my $method = $c->req->method || ''; - my $path = $c->req->path || ''; - my $hostname = $c->req->hostname || ''; - my $address = $c->req->address || ''; - $c->log->debug(qq/"$method" request for "$path" from $hostname($address)/) - if $c->debug; - - $c->prepare_action; - $c->prepare_parameters; - - if ( $c->debug && keys %{ $c->req->params } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Value' ); - $t->setColWidth( 'Key', 37, 1 ); - $t->setColWidth( 'Value', 36, 1 ); - for my $key ( keys %{ $c->req->params } ) { - my $value = $c->req->params->{$key} || ''; - $t->addRow( $key, $value ); + if ( $self->read_length > 0 ) { + while ( my $buffer = $self->read($c) ) { + $c->prepare_body_chunk($buffer); } - $c->log->debug( 'Parameters are', $t->draw ); - } - $c->prepare_uploads; - return $c; + # 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 $c->prepare_action +=head2 $self->prepare_body_chunk($c) -Prepare action. +Add a chunk to the request body. =cut -sub prepare_action { - my $c = shift; - my $path = $c->req->path; - my @path = split /\//, $c->req->path; - $c->req->args( \my @args ); - - while (@path) { - $path = join '/', @path; - if ( my $result = ${ $c->get_action($path) }[0] ) { - - # It's a regex - if ($#$result) { - my $match = $result->[1]; - my @snippets = @{ $result->[2] }; - $c->log->debug( - qq/Requested action is "$path" and matched "$match"/) - if $c->debug; - $c->log->debug( - 'Snippets are "' . join( ' ', @snippets ) . '"' ) - if ( $c->debug && @snippets ); - $c->req->action($match); - $c->req->snippets( \@snippets ); - } +sub prepare_body_chunk { + my ( $self, $c, $chunk ) = @_; - else { - $c->req->action($path); - $c->log->debug(qq/Requested action is "$path"/) if $c->debug; - } + $c->request->{_body}->add($chunk); +} - $c->req->match($path); - last; - } - unshift @args, pop @path; - } +=head2 $self->prepare_body_parameters($c) - unless ( $c->req->action ) { - $c->req->action('default'); - $c->req->match(''); - } +Sets up parameters from body. + +=cut - $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) - if ( $c->debug && @args ); +sub prepare_body_parameters { + my ( $self, $c ) = @_; + $c->request->body_parameters( $c->request->{_body}->param ); } -=item $c->prepare_connection +=head2 $self->prepare_connection($c) -Prepare connection. +Abstract method implemented in engines. =cut sub prepare_connection { } -=item $c->prepare_cookies +=head2 $self->prepare_cookies($c) -Prepare cookies. +Parse cookies from header. Sets a L object. =cut sub prepare_cookies { - my $c = shift; + my ( $self, $c ) = @_; if ( my $header = $c->request->header('Cookie') ) { $c->req->cookies( { CGI::Cookie->parse($header) } ); } } -=item $c->prepare_headers - -Prepare headers. +=head2 $self->prepare_headers($c) =cut sub prepare_headers { } -=item $c->prepare_parameters +=head2 $self->prepare_parameters($c) -Prepare parameters. +sets up parameters from query and post parameters. =cut -sub prepare_input { } - -=item $c->prepare_input - -Prepare message body. +sub prepare_parameters { + my ( $self, $c ) = @_; -=cut + # 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; + } -sub prepare_parameters { } + # 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 ] } + } + else { $c->request->parameters->{$name} = $param } + } +} -=item $c->prepare_path +=head2 $self->prepare_path($c) -Prepare path and base. +abstract method, implemented by engines. =cut sub prepare_path { } -=item $c->prepare_request +=head2 $self->prepare_request($c) -Prepare the engine request. +=head2 $self->prepare_query_parameters($c) + +process the query string and extract query parameters. =cut -sub prepare_request { } +sub prepare_query_parameters { + my ( $self, $c, $query_string ) = @_; + + # replace semi-colons + $query_string =~ s/;/&/g; -=item $c->prepare_uploads + 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]; + } +} -Prepare uploads. +=head2 $self->prepare_read($c) + +prepare to read from the engine. =cut -sub prepare_uploads { } +sub prepare_read { + my ( $self, $c ) = @_; + + # Reset the read position + $self->read_position(0); +} -=item $c->run +=head2 $self->prepare_request(@arguments) -Starts the engine. +Populate the context object from the request object. =cut -sub run { } +sub prepare_request { } -=item $c->request +=head2 $self->prepare_uploads($c) -=item $c->req +=cut -Returns a C object. +sub prepare_uploads { + my ( $self, $c ) = @_; + my $uploads = $c->request->{_body}->upload; + for 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} ); + push @uploads, $u; + } + $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0]; - my $req = $c->req; + # support access to the filename as a normal param + my @filenames = map { $_->{filename} } @uploads; + $c->request->parameters->{$name} = + @filenames > 1 ? \@filenames : $filenames[0]; + } +} -=item $c->response +=head2 $self->prepare_write($c) -=item $c->res +Abstract method. Implemented by the engines. -Returns a C object. +=cut - my $res = $c->res; +sub prepare_write { } -=item $class->setup +=head2 $self->read($c, [$maxlength]) -Setup. +=cut - MyApp->setup; +sub read { + my ( $self, $c, $maxlength ) = @_; -=cut + unless ( $self->{_prepared_read} ) { + $self->prepare_read($c); + $self->{_prepared_read} = 1; + } -sub setup { - my $self = shift; - $self->setup_components; - if ( $self->debug ) { - my $name = $self->config->{name} || 'Application'; - $self->log->info("$name powered by Catalyst $Catalyst::VERSION"); + my $remaining = $self->read_length - $self->read_position; + $maxlength ||= $CHUNKSIZE; + + # Are we done reading? + if ( $remaining <= 0 ) { + $self->finalize_read($c); + return; + } + + my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining; + my $rc = $self->read_chunk( $c, my $buffer, $readlen ); + if ( defined $rc ) { + $self->read_position( $self->read_position + $rc ); + return $buffer; + } + else { + Catalyst::Exception->throw( + message => "Unknown error reading input: $!" ); } } -=item $class->setup_components +=head2 $self->read_chunk($c, $buffer, $length) -Setup components. +Each engine inplements read_chunk as its preferred way of reading a chunk +of data. =cut -sub setup_components { - my $self = shift; - - # Components - my $class = ref $self || $self; - eval <<""; - package $class; - import Module::Pluggable::Fast - name => '_components', - search => [ - '$class\::Controller', '$class\::C', - '$class\::Model', '$class\::M', - '$class\::View', '$class\::V' - ]; - - if ( my $error = $@ ) { - chomp $error; - die qq/Couldn't load components "$error"/; - } +sub read_chunk { } - $self->components( {} ); - my @comps; - for my $comp ( $self->_components($self) ) { - $self->components->{ ref $comp } = $comp; - push @comps, $comp; - } +=head2 $self->read_length - my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for keys %{ $self->components }; - $self->log->debug( 'Loaded components', $t->draw ) - if ( @{ $t->{tbl_rows} } && $self->debug ); +The length of input data to be read. This is obtained from the Content-Length +header. - $self->setup_actions( [ $self, @comps ] ); -} +=head2 $self->read_position + +The amount of input data that has already been read. -=item $c->state +=head2 $self->run($c) -Contains the return value of the last executed action. +Start the engine. Implemented by the various engine classes. -=item $c->stash +=cut + +sub run { } -Returns a hashref containing all your data. +=head2 $self->write($c, $buffer) - $c->stash->{foo} ||= 'yada'; - print $c->stash->{foo}; +Writes the buffer to the client. Can only be called once for a request. =cut -sub stash { - my $self = shift; - if ( $_[0] ) { - my $stash = $_[1] ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $self->{stash}->{$key} = $val; - } +sub write { + my ( $self, $c, $buffer ) = @_; + + unless ( $self->{_prepared_write} ) { + $self->prepare_write($c); + $self->{_prepared_write} = 1; } - return $self->{stash}; + + print STDOUT $buffer; } -=back -=head1 AUTHOR +=head2 $self->finalize_output + +, see finalize_body + +=head1 AUTHORS + +Sebastian Riedel, -Sebastian Riedel, C +Andy Grundman, =head1 COPYRIGHT