X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=ca836f97c3a42340117933738b4e1f8890881a86;hb=2e1d8aebc95c5800fe98b1dfb99f109c877cfe17;hp=be5c580cd2811b4e75619bebc1f77fa7d7d18a53;hpb=b76d7db825981c235ff6cfa02b3d393424eaea0e;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index be5c580..ca836f9 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,38 +1,46 @@ package Catalyst::Engine; -use strict; -use base qw/Class::Data::Inheritable Class::Accessor::Fast/; -use UNIVERSAL::require; -use Data::Dumper; +use Moose; +with 'MooseX::Emulate::Class::Accessor::Fast'; + +use CGI::Simple::Cookie; +use Data::Dump qw/dump/; +use Errno 'EWOULDBLOCK'; 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; +use Moose::Util::TypeConstraints; +use Plack::Loader; +use Plack::Middleware::Conditional; +use Plack::Middleware::ReverseProxy; -require Module::Pluggable::Fast; +use namespace::clean -except => 'meta'; -$Data::Dumper::Terse = 1; +has env => (is => 'ro', writer => '_set_env', clearer => '_clear_env'); -__PACKAGE__->mk_classdata($_) for qw/actions components tree/; -__PACKAGE__->mk_accessors(qw/request response state/); +# input position and length +has read_length => (is => 'rw'); +has read_position => (is => 'rw'); -__PACKAGE__->actions( - { plain => {}, private => {}, regex => {}, compiled => {}, reverse => {} } -); -__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); +has _prepared_write => (is => 'rw'); -*comp = \&component; -*req = \&request; -*res = \&response; +has _response_cb => ( + is => 'ro', + isa => 'CodeRef', + writer => '_set_response_cb', + clearer => '_clear_response_cb', +); -our $COUNT = 1; -our $START = time; +has _writer => ( + is => 'ro', + isa => duck_type([qw(write close)]), + writer => '_set_writer', + clearer => '_clear_writer', +); -memoize('_class2prefix'); +# Amount of data to read from input on each pass +our $CHUNKSIZE = 64 * 1024; =head1 NAME @@ -46,772 +54,799 @@ See L. =head1 METHODS -=over 4 -=item $c->action( $name => $coderef, ... ) +=head2 $self->finalize_body($c) + +Finalize body. Prints the response output. + +=cut + +sub finalize_body { + my ( $self, $c ) = @_; + my $body = $c->response->body; + no warnings 'uninitialized'; + 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 { + $self->write( $c, $body ); + } -Add one or more actions. + $self->_writer->close; + $self->_clear_writer; + $self->_clear_env; - $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } ); + return; +} -It also automatically calls setup() if needed. +=head2 $self->finalize_cookies($c) -See L for more informations about actions. +Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as +response headers. =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 ) { - $self->set_action( $name, $code, caller(0) ); - } - } - return 1; -} +sub finalize_cookies { + my ( $self, $c ) = @_; -=item $c->benchmark($coderef) + my @cookies; + my $response = $c->response; -Takes a coderef with arguments and returns elapsed time as float. + foreach my $name (keys %{ $response->cookies }) { - my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } ); - $c->log->info( sprintf "Processing took %f seconds", $elapsed ); + my $val = $response->cookies->{$name}; -=cut + my $cookie = ( + 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, + -httponly => $val->{httponly} || 0, + ) + ); + + push @cookies, $cookie->as_string; + } -sub benchmark { - my $c = shift; - my $code = shift; - my $time = [gettimeofday]; - my @return = &$code(@_); - my $elapsed = tv_interval $time; - return wantarray ? ( $elapsed, @return ) : $elapsed; + for my $cookie (@cookies) { + $response->headers->push_header( 'Set-Cookie' => $cookie ); + } } -=item $c->comp($name) +=head2 $self->finalize_error($c) -=item $c->component($name) +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. -Get a component object by name. +=cut - $c->comp('MyApp::Model::MyModel')->do_stuff; +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 +} -Regex search for a component. +sub finalize_error { + my ( $self, $c ) = @_; - $c->comp('mymodel')->do_stuff; + $c->res->content_type('text/html; charset=utf-8'); + my $name = ref($c)->config->{name} || join(' ', split('::', ref $c)); -=cut + my ( $title, $error, $infos ); + if ( $c->debug ) { -sub component { - my ( $c, $name ) = @_; - if ( my $component = $c->components->{$name} ) { - return $component; + # 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 + $c->req->_clear_context; + $c->res->_clear_context; + + # Don't show body parser in the dump + $c->req->_clear_body; + + my @infos; + my $i = 0; + for my $dump ( $c->dump_these ) { + push @infos, $self->_dump_error_page_element($i, $dump); + $i++; + } + $infos = join "\n", @infos; } else { - for my $component ( keys %{ $c->components } ) { - return $c->components->{$component} if $component =~ /$name/i; - } + $title = $name; + $error = ''; + $infos = <<""; +
+(en) Please come back later
+(fr) SVP veuillez revenir plus tard
+(de) Bitte versuchen sie es spaeter nocheinmal
+(at) Konnten's bitt'schoen spaeter nochmal reinschauen
+(no) Vennligst prov igjen senere
+(dk) Venligst prov igen senere
+(pl) Prosze sprobowac pozniej
+(pt) Por favor volte mais tarde
+(ru) Попробуйте еще раз позже
+(ua) Спробуйте ще раз пізніше
+
+ + $name = ''; } + $c->res->body( <<"" ); + + + + + + $title + + + + +
+
$error
+
$infos
+
$name
+
+ + + + + # Trick IE + $c->res->{body} .= ( ' ' x 512 ); + + # Return 500 + $c->res->status(500); } -=item $c->errors +=head2 $self->finalize_headers($c) + +Abstract method, allows engines to write headers to response -=item $c->errors($error, ...) +=cut -=item $c->errors($arrayref) +sub finalize_headers { + my ($self, $ctx) = @_; -Returns an arrayref containing errors messages. + my @headers; + $ctx->response->headers->scan(sub { push @headers, @_ }); - my @errors = @{ $c->errors }; + $self->_set_writer($self->_response_cb->([ $ctx->response->status, \@headers ])); + $self->_clear_response_cb; -Add a new error. + return; +} - $c->errors('Something bad happened'); +=head2 $self->finalize_read($c) =cut -sub errors { - my $c = shift; - my $errors = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{errors} }, @$errors; - return $c->{errors}; -} +sub finalize_read { } -=item $c->finalize +=head2 $self->finalize_uploads($c) -Finalize request. +Clean up after uploads, deleting temp files. =cut -sub finalize { - my $c = shift; +sub finalize_uploads { + 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); + my $request = $c->request; + foreach my $key (keys %{ $request->uploads }) { + my $upload = $request->uploads->{$key}; + unlink grep { -e $_ } map { $_->tempname } + (ref $upload eq 'ARRAY' ? @{$upload} : ($upload)); } - 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
+} + +=head2 $self->prepare_body($c) + +sets up the L object body using L +=cut + +sub prepare_body { + my ( $self, $c ) = @_; + + my $appclass = ref($c) || $c; + if ( my $length = $self->read_length ) { + my $request = $c->request; + unless ( $request->_body ) { + my $type = $request->header('Content-Type'); + $request->_body(HTTP::Body->new( $type, $length )); + $request->_body->tmpdir( $appclass->config->{uploadtmp} ) + if exists $appclass->config->{uploadtmp}; } - else { - $title = $name; - $errors = ''; - $infos = <<""; -
-(en) Please come back later
-(de) Bitte versuchen sie es spaeter nocheinmal
-(nl) Gelieve te komen later terug
-(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
-
- $name = ''; + # Check for definedness as you could read '0' + while ( defined ( my $buffer = $self->read($c) ) ) { + $c->prepare_body_chunk($buffer); } - $c->res->{output} = <<""; - - - $title - - - -
-
$errors
-
$infos
-
$name
-
- - + # paranoia against wrong Content-Length header + my $remaining = $length - $self->read_position; + if ( $remaining > 0 ) { + $self->finalize_read($c); + Catalyst::Exception->throw( + "Wrong Content-Length value: $length" ); + } + } + else { + # Defined but will cause all body code to be skipped + $c->request->_body(0); } - $c->res->headers->content_length( length $c->res->output ); - my $status = $c->finalize_headers; - $c->finalize_output; - return $status; } -=item $c->finalize_headers +=head2 $self->prepare_body_chunk($c) -Finalize headers. +Add a chunk to the request body. =cut -sub finalize_headers { } +sub prepare_body_chunk { + my ( $self, $c, $chunk ) = @_; + + $c->request->_body->add($chunk); +} -=item $c->finalize_output +=head2 $self->prepare_body_parameters($c) -Finalize output. +Sets up parameters from body. =cut -sub finalize_output { } +sub prepare_body_parameters { + my ( $self, $c ) = @_; + + return unless $c->request->_body; -=item $c->forward($command) + $c->request->body_parameters( $c->request->_body->param ); +} -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->prepare_connection($c) - $c->forward('!foo'); - $c->forward('index.html'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +Abstract method implemented in engines. =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 $results = $c->get_action( $command, $namespace ); - if ( @{$results} ) { - if ( $command =~ /^\!/ ) { - for my $result ( @{$results} ) { - my ( $class, $code ) = @{ $result->[0] }; - $c->state( $c->process( $class, $code ) ); - } - } - else { - return 0 unless my $result = $results->[0]; - if ( $result->[2] ) { - $c->log->debug(qq/Couldn't forward "$command" to regex action/) - if $c->debug; - return 0; - } - my ( $class, $code ) = @{ $result->[0] }; - $class = $c->components->{$class} || $class; - $c->state( $c->process( $class, $code ) ); - } - } - else { - my $class = $command; - if ( $class =~ /[^\w\:]/ ) { - $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; - return 0; - } - my $method = shift || 'process'; - if ( my $code = $class->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - $class = $c->comp($class) || $class; - $c->state( $c->process( $class, $code ) ); - } - else { - $c->log->debug(qq/Couldn't forward to "$class->$method"/) - if $c->debug; - return 0; - } - } - return $c->state; +sub prepare_connection { + my ($self, $ctx) = @_; + + my $env = $self->env; + my $request = $ctx->request; + + $request->address( $env->{REMOTE_ADDR} ); + $request->hostname( $env->{REMOTE_HOST} ) + if exists $env->{REMOTE_HOST}; + $request->protocol( $env->{SERVER_PROTOCOL} ); + $request->remote_user( $env->{REMOTE_USER} ); + $request->method( $env->{REQUEST_METHOD} ); + $request->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 ); + + return; } -=item $c->get_action( $action, $namespace ) +=head2 $self->prepare_cookies($c) -Get an action in a given namespace. +Parse cookies from header. Sets a L object. =cut -sub get_action { - my ( $c, $action, $namespace ) = @_; - $namespace ||= ''; - if ( $action =~ /^\!(.*)/ ) { - $action = $1; - my $parent = $c->tree; - my @results; - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - 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; - push @results, [$match] if $match; - $parent = $child if $child; - } - return \@results; - } - 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 ] ]; - } - } +sub prepare_cookies { + my ( $self, $c ) = @_; + + if ( my $header = $c->request->header('Cookie') ) { + $c->req->cookies( { CGI::Simple::Cookie->parse($header) } ); } - return []; } -=item $c->handler( $class, $r ) - -Handles the request. +=head2 $self->prepare_headers($c) =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->get_action($action) ) { - $namespace = _class2prefix( $result->[0]->[0]->[0] ); - } - } - my $results = $c->get_action( $action, $namespace ); - if ( @{$results} ) { - for my $begin ( @{ $c->get_action( '!begin', $namespace ) } ) { - $c->state( $c->process( @{ $begin->[0] } ) ); - } - for my $result ( @{ $c->get_action( $action, $namespace ) } ) { - $c->state( $c->process( @{ $result->[0] } ) ); - } - for my $end ( @{ $c->get_action( '!end', $namespace ) } ) { - $c->state( $c->process( @{ $end->[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); - } - 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)" ); - } - else { $status = &$handler } - }; - if ( my $error = $@ ) { - chomp $error; - $class->log->error(qq/Caught exception in engine "$error"/); +sub prepare_headers { + my ($self, $ctx) = @_; + + my $env = $self->env; + my $headers = $ctx->request->headers; + + for my $header (keys %{ $env }) { + next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i; + (my $field = $header) =~ s/^HTTPS?_//; + $field =~ tr/_/-/; + $headers->header($field => $env->{$header}); } - $COUNT++; - return $status; } -=item $c->prepare($r) +=head2 $self->prepare_parameters($c) -Turns the engine-specific request (Apache, CGI...) into a Catalyst context. +sets up parameters from query and post parameters. =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; - 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 ); +sub prepare_parameters { + my ( $self, $c ) = @_; + + my $request = $c->request; + my $parameters = $request->parameters; + my $body_parameters = $request->body_parameters; + my $query_parameters = $request->query_parameters; + # We copy, no references + foreach my $name (keys %$query_parameters) { + my $param = $query_parameters->{$name}; + $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param; } - $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"; + + # Merge query and 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)); } - $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' ); + $parameters->{$name} = @values > 1 ? \@values : $values[0]; } - $c->prepare_uploads; - return $c; } -=item $c->prepare_action +=head2 $self->prepare_path($c) -Prepare action. +abstract method, implemented by engines. =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 "$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_path { + my ($self, $ctx) = @_; -=item $c->prepare_connection + my $env = $self->env; -Prepare connection. + my $scheme = $ctx->request->secure ? 'https' : 'http'; + my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME}; + my $port = $env->{SERVER_PORT} || 80; + my $base_path = $env->{SCRIPT_NAME} || "/"; -=cut + # set the request URI + my $req_uri = $env->{REQUEST_URI}; + $req_uri =~ s/\?.*$//; + my $path = $req_uri; + $path =~ s{^/+}{}; -sub prepare_connection { } + # Using URI directly is way too slow, so we construct the URLs manually + my $uri_class = "URI::$scheme"; -=item $c->prepare_cookies + # HTTP_HOST will include the port even if it's 80/443 + $host =~ s/:(?:80|443)$//; -Prepare cookies. + if ($port !~ /^(?:80|443)$/ && $host !~ /:/) { + $host .= ":$port"; + } -=cut + my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : ''; + my $uri = $scheme . '://' . $host . '/' . $path . $query; -sub prepare_cookies { } + $ctx->request->uri( bless \$uri, $uri_class ); -=item $c->prepare_headers + # set the base URI + # base must end in a slash + $base_path .= '/' unless $base_path =~ m{/$}; -Prepare headers. + my $base_uri = $scheme . '://' . $host . $base_path; -=cut + $ctx->request->base( bless \$base_uri, $uri_class ); -sub prepare_headers { } + return; +} + +=head2 $self->prepare_request($c) -=item $c->prepare_parameters +=head2 $self->prepare_query_parameters($c) -Prepare parameters. +process the query string and extract query parameters. =cut -sub prepare_parameters { } +sub prepare_query_parameters { + my ($self, $c) = @_; -=item $c->prepare_path + my $query_string = exists $self->env->{QUERY_STRING} + ? $self->env->{QUERY_STRING} + : ''; -Prepare path and base. + # Check for keywords (no = signs) + # (yes, index() is faster than a regex :)) + if ( index( $query_string, '=' ) < 0 ) { + $c->request->query_keywords( $self->unescape_uri($query_string) ); + return; + } -=cut + my %query; -sub prepare_path { } + # replace semi-colons + $query_string =~ s/;/&/g; -=item $c->prepare_request + my @params = grep { length $_ } split /&/, $query_string; -Prepare the engine request. + for my $item ( @params ) { -=cut + my ($param, $value) + = map { $self->unescape_uri($_) } + split( /=/, $item, 2 ); -sub prepare_request { } + $param = $self->unescape_uri($item) unless defined $param; -=item $c->prepare_uploads + if ( exists $query{$param} ) { + if ( ref $query{$param} ) { + push @{ $query{$param} }, $value; + } + else { + $query{$param} = [ $query{$param}, $value ]; + } + } + else { + $query{$param} = $value; + } + } -Prepare uploads. + $c->request->query_parameters( \%query ); +} -=cut +=head2 $self->prepare_read($c) -sub prepare_uploads { } +prepare to read from the engine. -=item $c->process($class, $coderef) +=cut -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. +sub prepare_read { + my ( $self, $c ) = @_; -=cut + # Initialize the read position + $self->read_position(0); -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; - } - 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; - } - return $status; + # Initialize the amount of data we think we need to read + $self->read_length( $c->request->header('Content-Length') || 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 { + my ($self, $ctx, %args) = @_; + $self->_set_env($args{env}); +} -=item $c->request +=head2 $self->prepare_uploads($c) -=item $c->req +=cut -Returns a C object. +sub prepare_uploads { + my ( $self, $c ) = @_; + + my $request = $c->request; + return unless $request->_body; + + my $uploads = $request->_body->upload; + my $parameters = $request->parameters; + 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, + headers => $headers, + tempname => $upload->{tempname}, + filename => $upload->{filename}, + ); + push @uploads, $u; + } + $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0]; + + # support access to the filename as a normal param + my @filenames = map { $_->{filename} } @uploads; + # append, if there's already params with this name + if (exists $parameters->{$name}) { + if (ref $parameters->{$name} eq 'ARRAY') { + push @{ $parameters->{$name} }, @filenames; + } + else { + $parameters->{$name} = [ $parameters->{$name}, @filenames ]; + } + } + else { + $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0]; + } + } +} - my $req = $c->req; +=head2 $self->prepare_write($c) -=item $c->response +Abstract method. Implemented by the engines. -=item $c->res +=cut -Returns a C object. +sub prepare_write { } - my $res = $c->res; +=head2 $self->read($c, [$maxlength]) -=item $c->set_action( $action, $code, $namespace ) +Reads from the input stream by calling C<< $self->read_chunk >>. -Set an action in a given namespace. +Maintains the read_length and read_position counters as data is read. =cut -sub set_action { - my ( $c, $action, $code, $namespace ) = @_; +sub read { + my ( $self, $c, $maxlength ) = @_; - my $prefix = ''; - if ( $action =~ /^\?(.*)$/ ) { - my $prefix = $1 || ''; - $action = $2; - $action = $prefix . _prefix( $namespace, $action ); - $c->actions->{plain}->{$action} = [ $namespace, $code ]; - } - if ( $action =~ /^\/(.*)\/$/ ) { - my $regex = $1; - $c->actions->{compiled}->{qr#$regex#} = $action; - $c->actions->{regex}->{$action} = [ $namespace, $code ]; + my $remaining = $self->read_length - $self->read_position; + $maxlength ||= $CHUNKSIZE; + + # Are we done reading? + if ( $remaining <= 0 ) { + $self->finalize_read($c); + return; } - elsif ( $action =~ /^\!(.*)$/ ) { - $action = $1; - my $parent = $c->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - $prefix = _class2prefix($namespace); - 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 $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. + $self->finalize_read; + return; } - my $uid = $parent->getUID; - $c->actions->{private}->{$uid}->{$action} = [ $namespace, $code ]; - $action = "!$action"; + $self->read_position( $self->read_position + $rc ); + return $buffer; } else { - $c->actions->{plain}->{$action} = [ $namespace, $code ]; + Catalyst::Exception->throw( + message => "Unknown error reading input: $!" ); } +} - my $reverse = $prefix ? "$action ($prefix)" : $action; - $c->actions->{reverse}->{"$code"} = $reverse; +=head2 $self->read_chunk($c, $buffer, $length) - $c->log->debug(qq/"$namespace" defined "$action" as "$code"/) - if $c->debug; +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 + +sub read_chunk { + my ($self, $ctx) = (shift, shift); + return $self->env->{'psgi.input'}->read(@_); } -=item $class->setup +=head2 $self->read_length + +The length of input data to be read. This is obtained from the Content-Length +header. + +=head2 $self->read_position + +The amount of input data that has already been read. -Setup. +=head2 $self->run($c) - MyApp->setup; +Start the engine. Implemented by the various engine classes. =cut -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"); - } +sub run { + my ($self, $app, @args) = @_; + # FIXME - Do something sensible with the options we're passed + $self->_run_psgi_app($self->_build_psgi_app($app, @args), @args); } -=item $class->setup_components +sub _build_psgi_app { + my ($self, $app, @args) = @_; -Setup components. + my $psgi_app = sub { + my ($env) = @_; -=cut + return sub { + my ($respond) = @_; + $self->_set_response_cb($respond); + $app->handle_request(env => $env); + }; + }; -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; + $psgi_app = Plack::Middleware::Conditional->wrap( + $psgi_app, + condition => sub { + my ($env) = @_; + return if $app->config->{ignore_frontend_proxy}; + return $env->{REMOTE_ADDR} eq '127.0.0.1' || $app->config->{using_frontend_proxy}; + }, + builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) }, + ); + + return $psgi_app; } -=item $c->stash +sub _run_psgi_app { + my ($self, $psgi_app, @args) = @_; + # FIXME - Need to be able to specify engine and pass options.. + Plack::Loader->auto(port => $args[0])->run($psgi_app); +} -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. =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}; -} -sub _prefix { - my ( $class, $name ) = @_; - my $prefix = _class2prefix($class); - $name = "$prefix/$name" if $prefix; - return $name; + return 0 if !defined $buffer; + + my $len = length($buffer); + $self->_writer->write($buffer); + + return $len; } -sub _class2prefix { - my $class = shift || ''; - $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/; - my $prefix = lc $2 || ''; - $prefix =~ s/\:\:/\//g; - return $prefix; +=head2 $self->unescape_uri($uri) + +Unescapes a given URI using the most efficient method available. Engines such +as Apache may implement this using Apache's C-based modules, for example. + +=cut + +sub unescape_uri { + my ( $self, $str ) = @_; + + $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg; + + return $str; } -=back +=head2 $self->finalize_output + +, see finalize_body + +=head2 $self->env + +Hash containing enviroment variables including many special variables inserted +by WWW server - like SERVER_*, REMOTE_*, HTTP_* ... + +Before accesing enviroment 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 enviroment 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 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +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