package Catalyst::Engine;
-use strict;
-use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
-use attributes ();
-use UNIVERSAL::require;
-use CGI::Cookie;
-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::Headers;
-use Time::HiRes qw/gettimeofday tv_interval/;
-use Text::ASCIITable;
-use Catalyst::Exception;
-use Catalyst::Request;
-use Catalyst::Request::Upload;
-use Catalyst::Response;
-use Catalyst::Utils;
-
-__PACKAGE__->mk_classdata('components');
-__PACKAGE__->mk_accessors(qw/counter depth request response state/);
-
-*comp = \&component;
-*req = \&request;
-*res = \&response;
-
-# For backwards compatibility
-*finalize_output = \&finalize_body;
-
-# For statistics
-our $COUNT = 1;
-our $START = time;
-our $RECURSION = 1000;
-our $DETACH = "catalyst_detach\n";
+use Plack::Loader;
+use Catalyst::EngineLoader;
+use Encode 2.21 'decode_utf8';
+use Plack::Request::Upload;
+use Hash::MultiValue;
+use namespace::clean -except => 'meta';
+use utf8;
+
+# Amount of data to read from input on each pass
+our $CHUNKSIZE = 64 * 1024;
+
+# XXX - this is only here for compat, do not use!
+has env => ( is => 'rw', writer => '_set_env' , weak_ref=>1);
+my $WARN_ABOUT_ENV = 0;
+around env => sub {
+ my ($orig, $self, @args) = @_;
+ if(@args) {
+ warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
+ unless $WARN_ABOUT_ENV++;
+ return $self->_set_env(@args);
+ }
+ return $self->$orig;
+};
+
+# XXX - Only here for Engine::PSGI compat
+sub prepare_connection {
+ my ($self, $ctx) = @_;
+ $ctx->request->prepare_connection;
+}
=head1 NAME
=head1 METHODS
-=over 4
-
-=item $c->benchmark($coderef)
-
-Takes a coderef with arguments and returns elapsed time as float.
-
- my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
- $c->log->info( sprintf "Processing took %f seconds", $elapsed );
-
-=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;
+=head2 $self->finalize_body($c)
-Regex search for a component.
+Finalize body. Prints the response output as blocking stream if it looks like
+a filehandle, otherwise write it out all in one go. If there is no body in
+the response, we assume you are handling it 'manually', such as for nonblocking
+style or asynchronous streaming responses. You do this by calling L</write>
+several times (which sends HTTP headers if needed) or you close over
+C<< $response->write_fh >>.
- $c->comp('mymodel')->do_stuff;
+See L<Catalyst::Response/write> and L<Catalyst::Response/write_fh> for more.
=cut
-sub component {
- my $c = shift;
-
- if (@_) {
-
- my $name = shift;
-
- 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 $res = $c->response; # We use this all over
+
+ ## If we've asked for the write 'filehandle' that means the application is
+ ## doing something custom and is expected to close the response
+ return if $res->_has_write_fh;
+
+ my $body = $res->body; # save some typing
+ if($res->_has_response_cb) {
+ ## we have not called the response callback yet, so we are safe to send
+ ## the whole body to PSGI
+
+ my @headers;
+ $res->headers->scan(sub { push @headers, @_ });
+
+ # We need to figure out what kind of body we have and normalize it to something
+ # PSGI can deal with
+ if(defined $body) {
+ # Handle objects first
+ if(blessed($body)) {
+ if($body->can('getline')) {
+ # Body is an IO handle that meets the PSGI spec. Nothing to normalize
+ } elsif($body->can('read')) {
+
+ # In the past, Catalyst only looked for ->read not ->getline. It is very possible
+ # that one might have an object that respected read but did not have getline.
+ # As a result, we need to handle this case for backcompat.
+
+ # We will just do the old loop for now. In a future version of Catalyst this support
+ # will be removed and one will have to rewrite their custom object or use
+ # Plack::Middleware::AdaptFilehandleRead. In anycase support for this is officially
+ # deprecated and described as such as of 5.90060
+
+ my $got;
+ do {
+ $got = read $body, my ($buffer), $CHUNKSIZE;
+ $got = 0 unless $self->write($c, $buffer );
+ } while $got > 0;
+
+ close $body;
+ return;
+ } else {
+ # Looks like for backcompat reasons we need to be able to deal
+ # with stringyfiable objects.
+ $body = ["$body"];
+ }
+ } elsif(ref $body) {
+ if( (ref($body) eq 'GLOB') or (ref($body) eq 'ARRAY')) {
+ # Again, PSGI can just accept this, no transform needed. We don't officially
+ # document the body as arrayref at this time (and there's not specific test
+ # cases. we support it because it simplifies some plack compatibility logic
+ # and we might make it official at some point.
+ } else {
+ $c->log->error("${\ref($body)} is not a valid value for Response->body");
+ return;
+ }
+ } else {
+ # Body is defined and not an object or reference. We assume a simple value
+ # and wrap it in an array for PSGI
+ $body = [$body];
}
+ } else {
+ # There's no body...
+ $body = [];
}
- }
-
- return sort keys %{ $c->components };
-}
-
-=item $c->counter
-
-Returns a hashref containing coderefs and execution counts.
-(Needed for deep recursion detection)
-
-=item $c->depth
-
-Returns the actual forward depth.
-
-=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->components->{$class} || $class;
- $c->state(0);
- my $callsub = ( caller(1) )[3];
-
- my $action = '';
- if ( $c->debug ) {
- $action = $c->actions->{reverse}->{"$code"};
- $action = "/$action" unless $action =~ /\-\>/;
- $c->counter->{"$code"}++;
-
- if ( $c->counter->{"$code"} > $RECURSION ) {
- my $error = qq/Deep recursion detected in "$action"/;
- $c->log->error($error);
- $c->error($error);
- $c->state(0);
- return $c->state;
+ $res->_response_cb->([ $res->status, \@headers, $body]);
+ $res->_clear_response_cb;
+
+ } else {
+ ## Now, if there's no response callback anymore, that means someone has
+ ## called ->write in order to stream 'some stuff along the way'. I think
+ ## for backcompat we still need to handle a ->body. I guess I could see
+ ## someone calling ->write to presend some stuff, and then doing the rest
+ ## via ->body, like in a template.
+
+ ## We'll just use the old, existing code for this (or most of it)
+
+ if(my $body = $res->body) {
+
+ if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
+
+ ## In this case we have no choice and will fall back on the old
+ ## manual streaming stuff. Not optimal. This is deprecated as of 5.900560+
+
+ my $got;
+ do {
+ $got = read $body, my ($buffer), $CHUNKSIZE;
+ $got = 0 unless $self->write($c, $buffer );
+ } while $got > 0;
+
+ close $body;
+ }
+ else {
+
+ # Case where body was set afgter calling ->write. We'd prefer not to
+ # support this, but I can see some use cases with the way most of the
+ # views work.
+
+ $self->write($c, $body );
+ }
}
- $action = "-> $action" if $callsub =~ /forward$/;
+ $res->_writer->close;
+ $res->_clear_writer;
}
- $c->{depth}++;
- eval {
- if ( $c->debug )
- {
- 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 } ) || 0 ) }
- };
- $c->{depth}--;
-
- if ( my $error = $@ ) {
-
- if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
- else {
- unless ( ref $error ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
- }
-
- $c->log->error($error);
- $c->error($error);
- $c->state(0);
- }
- }
- return $c->state;
+ return;
}
-=item $c->finalize
+=head2 $self->finalize_cookies($c)
-Finalize request.
+Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
+response headers.
=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->body && $c->response->status == 200 ) {
- $c->finalize_error;
- }
-
- if ( $c->response->body && !$c->response->content_length ) {
- $c->response->content_length( bytes::length( $c->response->body ) );
- }
+sub finalize_cookies {
+ my ( $self, $c ) = @_;
+
+ my @cookies;
+ my $response = $c->response;
+
+ foreach my $name (keys %{ $response->cookies }) {
+
+ my $val = $response->cookies->{$name};
+
+ 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,
+ )
+ );
+ if (!defined $cookie) {
+ $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
+ if $c->debug;
+ next;
+ }
- if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
- $c->response->headers->remove_header("Content-Length");
- $c->response->body('');
+ push @cookies, $cookie->as_string;
}
- if ( $c->request->method eq 'HEAD' ) {
- $c->response->body('');
+ for my $cookie (@cookies) {
+ $response->headers->push_header( 'Set-Cookie' => $cookie );
}
-
- my $status = $c->finalize_headers;
- $c->finalize_body;
- return $status;
}
-=item $c->finalize_output
-
-<obsolete>, see finalize_body
+=head2 $self->finalize_error($c)
-=item $c->finalize_body
-
-Finalize body.
+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.
=cut
-sub finalize_body { }
-
-=item $c->finalize_cookies
-
-Finalize cookies.
-
-=cut
-
-sub finalize_cookies {
- my $c = shift;
-
- 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
- );
-
- $c->res->headers->push_header( 'Set-Cookie' => $cookie->as_string );
- }
+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;
+<h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
+<div id="dump_$i">
+ <pre wrap="">%s</pre>
+</div>
+EOF
}
-=item $c->finalize_error
-
-Finalize error.
-
-=cut
-
sub finalize_error {
- my $c = shift;
+ my ( $self, $c ) = @_;
+
+ $c->res->content_type('text/html; charset=utf-8');
+ my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
+
+ # Prevent Catalyst::Plugin::Unicode::Encoding from running.
+ # This is a little nasty, but it's the best way to be clean whether or
+ # not the user has an encoding plugin.
- $c->res->headers->content_type('text/html');
- my $name = $c->config->{name} || 'Catalyst Application';
+ if ($c->can('encoding')) {
+ $c->{encoding} = '';
+ }
my ( $title, $error, $infos );
if ( $c->debug ) {
# For pretty dumps
- local $Data::Dumper::Terse = 1;
- $error = join '',
- map { '<code class="error">' . encode_entities($_) . '</code>' }
- @{ $c->error };
+ $error = join '', map {
+ '<p><code class="error">'
+ . encode_entities($_)
+ . '</code></p>'
+ } @{ $c->error };
$error ||= 'No output';
+ $error = qq{<pre wrap="">$error</pre>};
$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 = <<"";
-<br/>
-<b><u>Request</u></b><br/>
-<pre>$req</pre>
-<b><u>Response</u></b><br/>
-<pre>$res</pre>
-<b><u>Stash</u></b><br/>
-<pre>$stash</pre>
+ $name = "<h1>$name</h1>";
+
+ # Don't show context in the dump
+ $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 {
$title = $name;
$infos = <<"";
<pre>
(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
+(pt) Por favor volte mais tarde
+(ru) Попробуйте еще раз позже
+(ua) Спробуйте ще раз пізніше
+(it) Per favore riprova più tardi
</pre>
$name = '';
}
$c->res->body( <<"" );
-<html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
+ <meta http-equiv="Content-Language" content="en" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>$title</title>
+ <script type="text/javascript">
+ <!--
+ function toggleDump (dumpElement) {
+ var e = document.getElementById( dumpElement );
+ if (e.style.display == "none") {
+ e.style.display = "";
+ }
+ else {
+ e.style.display = "none";
+ }
+ }
+ -->
+ </script>
<style type="text/css">
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: #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+ */
}
</style>
</head>
</body>
</html>
+ # Trick IE. Old versions of IE would display their own error page instead
+ # of ours if we'd give it less than 512 bytes.
+ $c->res->{body} .= ( ' ' x 512 );
+
+ $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
+
+ # Return 500
+ $c->res->status(500);
}
-=item $c->finalize_headers
+=head2 $self->finalize_headers($c)
-Finalize headers.
+Allows engines to write headers to response
=cut
-sub finalize_headers { }
+sub finalize_headers {
+ my ($self, $ctx) = @_;
-=item $c->handler( $class, @arguments )
+ $ctx->finalize_headers unless $ctx->response->finalized_headers;
+ return;
+}
+
+=head2 $self->finalize_uploads($c)
-Handles the request.
+Clean up after uploads, deleting temp files.
=cut
-sub handler {
- my ( $class, @arguments ) = @_;
+sub finalize_uploads {
+ my ( $self, $c ) = @_;
- # Always expect worst case!
- my $status = -1;
- eval {
- my @stats = ();
+ # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
+ # on the HTTP::Body object.
+ 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));
+ }
- my $handler = sub {
- my $c = $class->prepare(@arguments);
- $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',
- ( $elapsed == 0 ? '??' : ( 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)\n" . $t->draw );
- }
- else { $status = &$handler }
+=head2 $self->prepare_body($c)
- };
+sets up the L<Catalyst::Request> object body using L<HTTP::Body>
- if ( my $error = $@ ) {
- chomp $error;
- $class->log->error(qq/Caught exception in engine "$error"/);
- }
+=cut
- $COUNT++;
- return $status;
+sub prepare_body {
+ my ( $self, $c ) = @_;
+
+ $c->request->prepare_body;
}
-=item $c->prepare(@arguments)
+=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, @arguments ) = @_;
-
- my $c = bless {
- counter => {},
- depth => 0,
- request => Catalyst::Request->new(
- {
- arguments => [],
- cookies => {},
- headers => HTTP::Headers->new,
- parameters => {},
- secure => 0,
- snippets => [],
- uploads => {}
- }
- ),
- response => Catalyst::Response->new(
- {
- body => '',
- cookies => {},
- headers => HTTP::Headers->new( 'Content-Length' => 0 ),
- status => 200
- }
- ),
- stash => {},
- state => 0
- }, $class;
+# XXX - Can this be deleted?
+sub prepare_body_chunk {
+ my ( $self, $c, $chunk ) = @_;
- 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->request->prepare_body_chunk($chunk);
+}
- $c->prepare_request(@arguments);
- $c->prepare_connection;
- $c->prepare_headers;
- $c->prepare_cookies;
- $c->prepare_path;
- $c->prepare_action;
+=head2 $self->prepare_body_parameters($c)
- my $method = $c->req->method || '';
- my $path = $c->req->path || '';
- my $address = $c->req->address || '';
+Sets up parameters from body.
- $c->log->debug(qq/"$method" request for "$path" from $address/)
- if $c->debug;
+=cut
- if ( $c->request->method eq 'POST' and $c->request->content_length ) {
+sub prepare_body_parameters {
+ my ( $self, $c ) = @_;
- if ( $c->req->content_type eq 'application/x-www-form-urlencoded' ) {
- $c->prepare_parameters;
- }
- elsif ( $c->req->content_type eq 'multipart/form-data' ) {
- $c->prepare_parameters;
- $c->prepare_uploads;
- }
- else {
- $c->prepare_body;
- }
- }
+ $c->request->prepare_body_parameters;
+}
- if ( $c->request->method eq 'GET' ) {
- $c->prepare_parameters;
- }
+=head2 $self->prepare_parameters($c)
- 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 ( sort keys %{ $c->req->params } ) {
- my $param = $c->req->params->{$key};
- my $value = defined($param) ? $param : '';
- $t->addRow( $key, $value );
- }
- $c->log->debug( "Parameters are:\n" . $t->draw );
- }
+Sets up parameters from query and post parameters.
+If parameters have already been set up will clear
+existing parameters and set up again.
- return $c;
+=cut
+
+sub prepare_parameters {
+ my ( $self, $c ) = @_;
+
+ $c->request->_clear_parameters;
+ return $c->request->parameters;
}
-=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 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_path {
+ my ($self, $ctx) = @_;
- else {
- $c->req->action($path);
- $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
- }
+ my $env = $ctx->request->env;
+
+ 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} || "/";
- $c->req->match($path);
- last;
+ # set the request URI
+ my $path;
+ if (!$ctx->config->{use_request_uri_for_path}) {
+ my $path_info = $env->{PATH_INFO};
+ if ( exists $env->{REDIRECT_URL} ) {
+ $base_path = $env->{REDIRECT_URL};
+ $base_path =~ s/\Q$path_info\E$//;
}
- unshift @args, pop @path;
+ $path = $base_path . $path_info;
+ $path =~ s{^/+}{};
+ $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
+ $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
}
+ else {
+ my $req_uri = $env->{REQUEST_URI};
+ $req_uri =~ s/\?.*$//;
+ $path = $req_uri;
+ $path =~ s{^/+}{};
+ }
+
+ # Using URI directly is way too slow, so we construct the URLs manually
+ my $uri_class = "URI::$scheme";
- unless ( $c->req->action ) {
- $c->req->action('default');
- $c->req->match('');
+ # HTTP_HOST will include the port even if it's 80/443
+ $host =~ s/:(?:80|443)$//;
+
+ if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
+ $host .= ":$port";
}
- $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
- if ( $c->debug && @args );
-}
+ my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
+ my $uri = $scheme . '://' . $host . '/' . $path . $query;
-=item $c->prepare_body
+ $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
-Prepare message body.
+ # set the base URI
+ # base must end in a slash
+ $base_path .= '/' unless $base_path =~ m{/$};
-=cut
+ my $base_uri = $scheme . '://' . $host . $base_path;
+
+ $ctx->request->base( bless \$base_uri, $uri_class );
+
+ return;
+}
-sub prepare_body { }
+=head2 $self->prepare_request($c)
-=item $c->prepare_connection
+=head2 $self->prepare_query_parameters($c)
-Prepare connection.
+process the query string and extract query parameters.
=cut
-sub prepare_connection { }
+sub prepare_query_parameters {
+ my ($self, $c) = @_;
+ my $env = $c->request->env;
+
+ my $query_string = exists $env->{QUERY_STRING}
+ ? $env->{QUERY_STRING}
+ : '';
+
+ # Check for keywords (no = signs)
+ # (yes, index() is faster than a regex :))
+ if ( index( $query_string, '=' ) < 0 ) {
+ my $keywords = $self->unescape_uri($query_string);
+ $keywords = decode_utf8 $keywords;
+ $c->request->query_keywords($keywords);
+ return;
+ }
+
+ $query_string =~ s/\A[&;]+//;
-=item $c->prepare_cookies
+ my $p = Hash::MultiValue->new(
+ map { defined $_ ? decode_utf8($self->unescape_uri($_)) : $_ }
+ map { ( split /=/, $_, 2 )[0,1] } # slice forces two elements
+ split /[&;]+/, $query_string
+ );
-Prepare cookies.
+ $c->request->query_parameters( $c->request->_use_hash_multivalue ? $p : $p->mixed );
+}
+
+=head2 $self->prepare_read($c)
+
+Prepare to read by initializing the Content-Length from headers.
=cut
-sub prepare_cookies {
- my $c = shift;
+sub prepare_read {
+ my ( $self, $c ) = @_;
- if ( my $header = $c->request->header('Cookie') ) {
- $c->req->cookies( { CGI::Cookie->parse($header) } );
- }
+ # Initialize the amount of data we think we need to read
+ $c->request->_read_length;
}
-=item $c->prepare_headers
+=head2 $self->prepare_request(@arguments)
-Prepare headers.
+Populate the context object from the request object.
=cut
-sub prepare_headers { }
-
-=item $c->prepare_parameters
+sub prepare_request {
+ my ($self, $ctx, %args) = @_;
+ $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
+ $ctx->request->_set_env($args{env});
+ $self->_set_env($args{env}); # Nasty back compat!
+ $ctx->response->_set_response_cb($args{response_cb});
+}
-Prepare parameters.
+=head2 $self->prepare_uploads($c)
=cut
-sub prepare_parameters { }
+sub prepare_uploads {
+ my ( $self, $c ) = @_;
+
+ my $request = $c->request;
+ return unless $request->_body;
+
+ my $enc = $c->encoding;
+ my $uploads = $request->_body->upload;
+ my $parameters = $request->parameters;
+ foreach my $name (keys %$uploads) {
+ $name = $c->_handle_unicode_decoding($name) if $enc;
+ my $files = $uploads->{$name};
+ my @uploads;
+ for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
+ my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
+ my $filename = $upload->{filename};
+ $filename = $c->_handle_unicode_decoding($filename) if $enc;
+
+ my $u = Catalyst::Request::Upload->new
+ (
+ size => $upload->{size},
+ type => scalar $headers->content_type,
+ charset => scalar $headers->content_type_charset,
+ headers => $headers,
+ tempname => $upload->{tempname},
+ filename => $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];
+ }
+ }
+}
-=item $c->prepare_path
+=head2 $self->write($c, $buffer)
-Prepare path and base.
+Writes the buffer to the client.
=cut
-sub prepare_path { }
+sub write {
+ my ( $self, $c, $buffer ) = @_;
+
+ $c->response->write($buffer);
+}
-=item $c->prepare_request
+=head2 $self->read($c, [$maxlength])
-Prepare the engine request.
+Reads from the input stream by calling C<< $self->read_chunk >>.
+
+Maintains the read_length and read_position counters as data is read.
=cut
-sub prepare_request { }
+sub read {
+ my ( $self, $c, $maxlength ) = @_;
+
+ $c->request->read($maxlength);
+}
-=item $c->prepare_uploads
+=head2 $self->read_chunk($c, \$buffer, $length)
-Prepare uploads.
+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 prepare_uploads { }
+sub read_chunk {
+ my ($self, $ctx) = (shift, shift);
+ return $ctx->request->read_chunk(@_);
+}
-=item $c->run
+=head2 $self->run($app, $server)
-Starts the engine.
+Start the engine. Builds a PSGI application and calls the
+run method on the server passed in, which then causes the
+engine to loop, handling requests..
=cut
-sub run { }
+sub run {
+ my ($self, $app, $psgi, @args) = @_;
+ # @args left here rather than just a $options, $server for back compat with the
+ # old style scripts which send a few args, then a hashref
+
+ # They should never actually be used in the normal case as the Plack engine is
+ # passed in got all the 'standard' args via the loader in the script already.
+
+ # FIXME - we should stash the options in an attribute so that custom args
+ # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
+ my $server = pop @args if (scalar @args && blessed $args[-1]);
+ my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
+ # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
+ if (scalar @args && !ref($args[0])) {
+ if (my $listen = shift @args) {
+ $options->{listen} ||= [$listen];
+ }
+ }
+ if (! $server ) {
+ $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
+ # We're not being called from a script, so auto detect what backend to
+ # run on. This should never happen, as mod_perl never calls ->run,
+ # instead the $app->handle method is called per request.
+ $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
+ }
+ $app->run_options($options);
+ $server->run($psgi, $options);
+}
+
+=head2 build_psgi_app ($app, @args)
-=item $c->request
+Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
+
+=cut
-=item $c->req
+sub build_psgi_app {
+ my ($self, $app, @args) = @_;
-Returns a C<Catalyst::Request> object.
+ return sub {
+ my ($env) = @_;
- my $req = $c->req;
+ return sub {
+ my ($respond) = @_;
+ confess("Did not get a response callback for writer, cannot continue") unless $respond;
+ $app->handle_request(env => $env, response_cb => $respond);
+ };
+ };
+}
-=item $c->response
+=head2 $self->unescape_uri($uri)
-=item $c->res
+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.
-Returns a C<Catalyst::Response> object.
+=cut
- my $res = $c->res;
+sub unescape_uri {
+ my ( $self, $str ) = @_;
-=item $c->state
+ $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
-Contains the return value of the last executed action.
+ return $str;
+}
-=item $c->stash
+=head2 $self->finalize_output
-Returns a hashref containing all your data.
+<obsolete>, see finalize_body
- $c->stash->{foo} ||= 'yada';
- print $c->stash->{foo};
+=head2 $self->env
-=cut
+Hash containing environment variables including many special variables inserted
+by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
-sub stash {
- my $self = shift;
- if (@_) {
- my $stash = @_ > 1 ? {@_} : $_[0];
- while ( my ( $key, $val ) = each %$stash ) {
- $self->{stash}->{$key} = $val;
- }
- }
- return $self->{stash};
-}
+Before accessing environment variables consider whether the same information is
+not directly available via Catalyst objects $c->request, $c->engine ...
-=back
+BEWARE: If you really need to access some environment variable from your Catalyst
+application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
+as in some environments the %ENV hash does not contain what you would expect.
-=head1 AUTHOR
+=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
+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
+__PACKAGE__->meta->make_immutable;
+
1;