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=ce51791b978404696b8e0215ab6e6ddf0efaa3df;hb=f63c03e47ae0278e50d513b90ecbbdfd67d1a021;hpb=4b4faf7254aa67192e7d491d8ed65f92dbc62b4a diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index ce51791..de506cb 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,38 +1,22 @@ package Catalyst::Engine; use strict; -use base qw/Class::Data::Inheritable Class::Accessor::Fast/; -use UNIVERSAL::require; -use Data::Dumper; +use base 'Class::Accessor::Fast'; +use CGI::Cookie; +use Data::Dump qw/dump/; use HTML::Entities; +use HTTP::Body; use HTTP::Headers; -use Memoize; -use Time::HiRes qw/gettimeofday tv_interval/; -use Tree::Simple; -use Tree::Simple::Visitor::FindByPath; -use Catalyst::Request; -use Catalyst::Response; +use URI::QueryParam; -require Module::Pluggable::Fast; +# input position and length +__PACKAGE__->mk_accessors(qw/read_position read_length/); -$Data::Dumper::Terse = 1; +# Stringify to class +use overload '""' => sub { return ref shift }, fallback => 1; -__PACKAGE__->mk_classdata($_) for qw/actions components tree/; -__PACKAGE__->mk_accessors(qw/request response/); - -__PACKAGE__->actions( - { plain => {}, private => {}, regex => {}, compiled => {}, reverse => {} } -); -__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); - -*comp = \&component; -*req = \&request; -*res = \&response; - -our $COUNT = 1; -our $START = time; - -memoize('_class2prefix'); +# Amount of data to read from input on each pass +our $CHUNKSIZE = 4096; =head1 NAME @@ -46,727 +30,557 @@ See L. =head1 METHODS -=over 4 - -=item $c->action( $name => $coderef, ... ) -Add one or more actions. +=head2 $self->finalize_body($c) - $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } ); - -It also automatically calls setup() if needed. - -See L for more informations about actions. +Finalize body. Prints the response output. =cut -sub action { - my $self = shift; - $self->setup unless $self->components; - $self->actions( {} ) unless $self->actions; - my $action; - $_[1] ? ( $action = {@_} ) : ( $action = shift ); - if ( ref $action eq 'HASH' ) { - while ( my ( $name, $code ) = each %$action ) { - my $prefix = ''; - my $class = caller(0); - if ( $name =~ /^\?(.*)$/ ) { - my $prefix = $1 || ''; - $name = $2; - $name = $prefix . _prefix( $class, $name ); - $self->actions->{plain}->{$name} = [ $class, $code ]; - } - if ( $name =~ /^\/(.*)\/$/ ) { - my $regex = $1; - $self->actions->{compiled}->{qr#$regex#} = $name; - $self->actions->{regex}->{$name} = [ $class, $code ]; - } - elsif ( $name =~ /^\!(.*)$/ ) { - $name = $1; - my $parent = $self->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - $prefix = _class2prefix($class); - for my $part ( split '/', $prefix ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - unless ($child) { - $child = $parent->addChild( Tree::Simple->new($part) ); - $visitor->setSearchPath($part); - $parent->accept($visitor); - $child = $visitor->getResult; - } - $parent = $child; - } - my $uid = $parent->getUID; - $self->actions->{private}->{$uid}->{$name} = [ $class, $code ]; - $name = "!$name"; - } - else { $self->actions->{plain}->{$name} = [ $class, $code ] } - my $reverse = $prefix ? "$name ($prefix)" : $name; - $self->actions->{reverse}->{"$code"} = $reverse; - $self->log->debug(qq/"$class" defined "$name" as "$code"/) - if $self->debug; +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; } - return 1; -} - -=item $c->find_action( $name, $namespace ) - -Find an action in a given namespace. - -=cut - -sub find_action { - my ( $c, $action, $namespace ) = @_; - $namespace ||= ''; - if ( $action =~ /^\!(.*)/ ) { - $action = $1; - my $parent = $c->tree; - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - for my $part ( split '/', $namespace ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $c->actions->{private}->{$uid}->{$action} if $uid; - $result = $match if $match; - $parent = $child if $child; - } - return [$result] if $result; - } - elsif ( my $p = $c->actions->{plain}->{$action} ) { return [$p] } - elsif ( my $r = $c->actions->{regex}->{$action} ) { return [$r] } else { - for my $regex ( keys %{ $c->actions->{compiled} } ) { - my $name = $c->actions->{compiled}->{$regex}; - if ( $action =~ $regex ) { - my @snippets; - for my $i ( 1 .. 9 ) { - no strict 'refs'; - last unless ${$i}; - push @snippets, ${$i}; - } - return [ $c->actions->{regex}->{$name}, $name, \@snippets ]; - } - } + $self->write( $c, $body ); } - return 0; } -=item $c->benchmark($coderef) - -Takes a coderef with arguments and returns elapsed time as float. +=head2 $self->finalize_cookies($c) - my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } ); - $c->log->info( sprintf "Processing took %f seconds", $elapsed ); +Create CGI::Cookies from $c->res->cookies, and set them as response headers. =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) +sub finalize_cookies { + my ( $self, $c ) = @_; -Get a component object by name. + my @cookies; + while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) { - $c->comp('MyApp::Model::MyModel')->do_stuff; + my $cookie = CGI::Cookie->new( + -name => $name, + -value => $cookie->{value}, + -expires => $cookie->{expires}, + -domain => $cookie->{domain}, + -path => $cookie->{path}, + -secure => $cookie->{secure} || 0 + ); -Regex search for a component. - - $c->comp('mymodel')->do_stuff; - -=cut - -sub component { - my ( $c, $name ) = @_; - if ( my $component = $c->components->{$name} ) { - return $component; + push @cookies, $cookie->as_string; } - else { - for my $component ( keys %{ $c->components } ) { - return $c->components->{$component} if $component =~ /$name/i; - } - } -} - -=item $c->errors - -=item $c->errors($error, ...) - -=item $c->errors($arrayref) - -Returns an arrayref containing errors messages. - - my @errors = @{ $c->errors }; - -Add a new error. - $c->errors('Something bad happened'); - -=cut - -sub errors { - my $c = shift; - my $errors = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{errors} }, @$errors; - return $c->{errors}; + for my $cookie (@cookies) { + $c->res->headers->push_header( 'Set-Cookie' => $cookie ); + } } -=item $c->finalize +=head2 $self->finalize_error($c) -Finalize request. +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 { - my $c = shift; +sub finalize_error { + my ( $self, $c ) = @_; - if ( my $location = $c->res->redirect ) { - $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; - $c->res->headers->header( Location => $location ); - $c->res->status(302); - } + $c->res->content_type('text/html; charset=utf-8'); + my $name = $c->config->{name} || join(' ', split('::', ref $c)); - if ( !$c->res->output || $#{ $c->errors } >= 0 ) { - $c->res->headers->content_type('text/html'); - my $name = $c->config->{name} || 'Catalyst Application'; - my ( $title, $errors, $infos ); - if ( $c->debug ) { - $errors = join '
', @{ $c->errors }; - $errors ||= 'No output'; - $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
+ my ( $title, $error, $infos ); + if ( $c->debug ) { + # For pretty dumps + $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}; + 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++; } - else { - $title = $name; - $errors = ''; - $infos = <<""; + $infos = join "\n", @infos; + } + else { + $title = $name; + $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} = <<""; - - - $title - - - -
-
$errors
-
$infos
-
$name
-
- + } + --> + + + + +
+
$error
+
$infos
+
$name
+
+ - } - $c->res->headers->content_length( length $c->res->output ); - my $status = $c->finalize_headers; - $c->finalize_output; - return $status; + + # 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->forward($command) + undef $self->{_prepared_read}; +} -Forward processing to a private/public action or a method from a class. -If you define a class without method it will default to process(). +=head2 $self->finalize_uploads($c) - $c->forward('!foo'); - $c->forward('index.html'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +Clean up after uploads, deleting temp files. =cut -sub forward { - my $c = shift; - my $command = shift; - unless ($command) { - $c->log->debug('Nothing to forward to') if $c->debug; - return 0; - } - my $caller = caller(0); - if ( $command =~ /^\?(.*)$/ ) { - $command = $1; - $command = _prefix( $caller, $command ); - } - my $namespace = ''; - if ( $command =~ /^\!/ ) { - $namespace = _class2prefix($caller); - } - my ( $class, $code ); - if ( my $action = $c->find_action( $command, $namespace ) ) { - if ( $action->[2] ) { - $c->log->debug(qq/Couldn't forward "$command" to regex action/) - if $c->debug; - return 0; - } - ( $class, $code ) = @{ $action->[0] }; - } - else { - $class = $command; - if ( $class =~ /[^\w\:]/ ) { - $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; - return 0; - } - my $method = shift || 'process'; - if ( $code = $class->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - } - else { - $c->log->debug(qq/Couldn't forward to "$class->$method"/) - if $c->debug; - return 0; +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); } } - $class = $c->components->{$class} || $class; - return $c->process( $class, $code ); } -=item $c->handler($r) +=head2 $self->prepare_body($c) -Handles the request. +sets up the L object body using L =cut -sub handler { - my ( $class, $r ) = @_; - - # Always expect worst case! - my $status = -1; - eval { - my $handler = sub { - my $c = $class->prepare($r); - my $action = $c->req->action; - my $namespace = ''; - $namespace = join '/', @{ $c->req->args } if $action eq '!default'; - unless ($namespace) { - if ( my $result = $c->find_action($action) ) { - $namespace = _class2prefix( $result->[0]->[0] ); - } - } - if ( my $begin = $c->find_action( '!begin', $namespace ) ) { - $c->process( @{ $begin->[0] } ); - } - if ( my $result = $c->find_action( $action, $namespace ) ) { - $c->process( @{ $result->[0] } ); - } - else { - my $path = $c->req->path; - my $error = $path - ? qq/Unknown resource "$path"/ - : "No default action defined"; - $c->log->error($error) if $c->debug; - $c->errors($error); - } - if ( my $end = $c->find_action( '!end', $namespace ) ) { - $c->process( @{ $end->[0] } ); - } - return $c->finalize; - }; - if ( $class->debug ) { - my $elapsed; - ( $elapsed, $status ) = $class->benchmark($handler); - $elapsed = sprintf '%f', $elapsed; - my $av = sprintf '%.3f', 1 / $elapsed; - $class->log->info( "Request took $elapsed" . "s ($av/s)" ); +sub prepare_body { + my ( $self, $c ) = @_; + + $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}; + } + + 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 ); } - else { $status = &$handler } - }; - if ( my $error = $@ ) { - chomp $error; - $class->log->error(qq/Caught exception in engine "$error"/); } - $COUNT++; - return $status; } -=item $c->prepare($r) +=head2 $self->prepare_body_chunk($c) -Turns the engine-specific request (Apache, CGI...) into a Catalyst context. +Add a chunk to the request body. =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 => {} - }, $class; - 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 ); - } - $c->prepare_request($r); - $c->prepare_path; - $c->prepare_cookies; - $c->prepare_headers; - $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 @params; - for my $key ( keys %{ $c->req->params } ) { - my $value = $c->req->params->{$key} || ''; - push @params, "$key=$value"; - } - $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' ); - } - $c->prepare_uploads; - return $c; +sub prepare_body_chunk { + my ( $self, $c, $chunk ) = @_; + + $c->request->{_body}->add($chunk); } -=item $c->prepare_action +=head2 $self->prepare_body_parameters($c) -Prepare action. +Sets up parameters from 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->find_action($path) ) { - - # It's a regex - if ($#$result) { - my $match = $result->[1]; - my @snippets = @{ $result->[2] }; - $c->log->debug(qq/Requested action "$path" matched "$match"/) - if $c->debug; - $c->log->debug( - 'Snippets are "' . join( ' ', @snippets ) . '"' ) - if ( $c->debug && @snippets ); - $c->req->action($match); - $c->req->snippets( \@snippets ); - } - else { - $c->req->action($path); - $c->log->debug(qq/Requested action "$path"/) if $c->debug; - } - $c->req->match($path); - last; - } - unshift @args, pop @path; - } - unless ( $c->req->action ) { - $c->req->action('!default'); - $c->req->match(''); - } - $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 { } +sub prepare_cookies { + my ( $self, $c ) = @_; -=item $c->prepare_headers + if ( my $header = $c->request->header('Cookie') ) { + $c->req->cookies( { CGI::Cookie->parse($header) } ); + } +} -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_parameters { } +sub prepare_parameters { + my ( $self, $c ) = @_; -=item $c->prepare_path + # 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; + } -Prepare path and base. + # 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 } + } +} + +=head2 $self->prepare_path($c) + +abstract method, implemented by engines. =cut sub prepare_path { } -=item $c->prepare_request +=head2 $self->prepare_request($c) + +=head2 $self->prepare_query_parameters($c) -Prepare the engine request. +process the query string and extract query parameters. =cut -sub prepare_request { } +sub prepare_query_parameters { + my ( $self, $c, $query_string ) = @_; -=item $c->prepare_uploads + # replace semi-colons + $query_string =~ s/;/&/g; -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]; + } +} + +=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); +} + +=head2 $self->prepare_request(@arguments) + +Populate the context object from the request object. -=item $c->process($class, $coderef) +=cut + +sub prepare_request { } -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. +=head2 $self->prepare_uploads($c) =cut -sub process { - my ( $c, $class, $code ) = @_; - my $status; - eval { - if ( $c->debug ) - { - my $action = $c->actions->{reverse}->{"$code"} || "$code"; - my $elapsed; - ( $elapsed, $status ) = - $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed ) - if $c->debug; +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; } - else { $status = &$code( $class, $c, @{ $c->req->args } ) } - }; - if ( my $error = $@ ) { - chomp $error; - $error = qq/Caught exception "$error"/; - $c->log->error($error); - $c->errors($error) if $c->debug; - return 0; + $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]; } - return $status; } -=item $c->request - -=item $c->req - -Returns a C object. +=head2 $self->prepare_write($c) - my $req = $c->req; +Abstract method. Implemented by the engines. -=item $c->response +=cut -=item $c->res +sub prepare_write { } -Returns a C object. +=head2 $self->read($c, [$maxlength]) - my $res = $c->res; +=cut -=item $class->setup +sub read { + my ( $self, $c, $maxlength ) = @_; -Setup. + unless ( $self->{_prepared_read} ) { + $self->prepare_read($c); + $self->{_prepared_read} = 1; + } - MyApp->setup; + my $remaining = $self->read_length - $self->read_position; + $maxlength ||= $CHUNKSIZE; -=cut + # Are we done reading? + if ( $remaining <= 0 ) { + $self->finalize_read($c); + return; + } -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 $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; - $self->log->error( - qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/); - } - $self->components( {} ); - for my $component ( $self->_components($self) ) { - $self->components->{ ref $component } = $component; - } - $self->log->debug( 'Initialized components "' - . join( ' ', keys %{ $self->components } ) - . '"' ) - if $self->debug; -} +sub read_chunk { } + +=head2 $self->read_length -=item $c->stash +The length of input data to be read. This is obtained from the Content-Length +header. -Returns a hashref containing all your data. +=head2 $self->read_position - $c->stash->{foo} ||= 'yada'; - print $c->stash->{foo}; +The amount of input data that has already been read. + +=head2 $self->run($c) + +Start the engine. Implemented by the various engine classes. =cut -sub stash { - my $self = shift; - if ( $_[0] ) { - my $stash = $_[1] ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $self->{stash}->{$key} = $val; - } +sub run { } + +=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->{_prepared_write} = 1; } - return $self->{stash}; -} -sub _prefix { - my ( $class, $name ) = @_; - my $prefix = _class2prefix($class); - $name = "$prefix/$name" if $prefix; - return $name; + print STDOUT $buffer; } -sub _class2prefix { - my $class = shift; - $class =~ /^.*::([MVC]|Model|View|Controller)+::(.*)$/; - my $prefix = lc $2 || ''; - $prefix =~ s/\:\:/\//g; - return $prefix; -} -=back +=head2 $self->finalize_output + +, see finalize_body + +=head1 AUTHORS -=head1 AUTHOR +Sebastian Riedel, -Sebastian Riedel, C +Andy Grundman, =head1 COPYRIGHT