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 Catalyst::EngineLoader;
+use Encode ();
+use utf8;
-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
=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)
+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 );
+ }
-Get a component object by name.
+ $self->_writer->close;
+ $self->_clear_writer;
+ $self->_clear_env;
- $c->comp('MyApp::Model::MyModel')->do_stuff;
+ return;
+}
-Regex search for a component.
+=head2 $self->finalize_cookies($c)
- $c->comp('mymodel')->do_stuff;
+Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
+response headers.
=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_cookies {
+ my ( $self, $c ) = @_;
+
+ my @cookies;
+ my $response = $c->response;
-=item $c->error
+ foreach my $name (keys %{ $response->cookies }) {
-=item $c->error($error, ...)
+ my $val = $response->cookies->{$name};
-=item $c->error($arrayref)
+ 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,
+ )
+ );
-Returns an arrayref containing error messages.
+ push @cookies, $cookie->as_string;
+ }
- my @error = @{ $c->error };
+ for my $cookie (@cookies) {
+ $response->headers->push_header( 'Set-Cookie' => $cookie );
+ }
+}
-Add a new error.
+=head2 $self->finalize_error($c)
- $c->error('Something bad happened');
+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 error {
- my $c = shift;
- my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
- push @{ $c->{error} }, @$error;
- return $c->{error};
+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
-
-Finalize request.
-
-=cut
+sub finalize_error {
+ my ( $self, $c ) = @_;
-sub finalize {
- my $c = shift;
+ $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.
- 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);
+ if ($c->can('encoding')) {
+ $c->{encoding} = '';
}
- if ( !$c->res->output || $#{ $c->error } >= 0 ) {
- $c->res->headers->content_type('text/html');
- my $name = $c->config->{name} || 'Catalyst Application';
- my ( $title, $error, $infos );
- if ( $c->debug ) {
- $error = join '<br/>', @{ $c->error };
- $error ||= '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 = <<"";
-<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>
+ my ( $title, $error, $infos );
+ if ( $c->debug ) {
+ # For pretty dumps
+ $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";
+ $name = "<h1>$name</h1>";
+
+ # 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++;
}
- else {
- $title = $name;
- $error = '';
- $infos = <<"";
+ $infos = join "\n", @infos;
+ }
+ else {
+ $title = $name;
+ $error = '';
+ $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) Спробуйте ще раз пізніше
</pre>
- $name = '';
- }
- $c->res->{output} = <<"";
-<html>
- <head>
- <title>$title</title>
- <style type="text/css">
- body {
- font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
- Tahoma, Arial, helvetica, sans-serif;
- color: #ddd;
- background-color: #eee;
- margin: 0px;
- padding: 0px;
- }
- div.box {
- background-color: #ccc;
- border: 1px solid #aaa;
- padding: 4px;
- margin: 10px;
- -moz-border-radius: 10px;
- }
- div.error {
- background-color: #977;
- border: 1px solid #755;
- padding: 8px;
- margin: 4px;
- margin-bottom: 10px;
- -moz-border-radius: 10px;
- }
- div.infos {
- background-color: #797;
- border: 1px solid #575;
- padding: 8px;
- margin: 4px;
- margin-bottom: 10px;
- -moz-border-radius: 10px;
+ $name = '';
+ }
+ $c->res->body( <<"" );
+<!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 = "";
}
- div.name {
- background-color: #779;
- border: 1px solid #557;
- padding: 8px;
- margin: 4px;
- -moz-border-radius: 10px;
+ else {
+ e.style.display = "none";
}
- </style>
- </head>
- <body>
- <div class="box">
- <div class="error">$error</div>
- <div class="infos">$infos</div>
- <div class="name">$name</div>
- </div>
- </body>
+ }
+ -->
+ </script>
+ <style type="text/css">
+ body {
+ font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
+ Tahoma, Arial, helvetica, sans-serif;
+ 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;
+ }
+ div.error {
+ background-color: #cce;
+ border: 1px solid #755;
+ padding: 8px;
+ margin: 4px;
+ margin-bottom: 10px;
+ }
+ div.infos {
+ background-color: #eee;
+ border: 1px solid #575;
+ padding: 8px;
+ margin: 4px;
+ margin-bottom: 10px;
+ }
+ div.name {
+ background-color: #cce;
+ border: 1px solid #557;
+ padding: 8px;
+ margin: 4px;
+ }
+ code.error {
+ display: block;
+ margin: 1em 0;
+ overflow: auto;
+ }
+ 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>
+ <div class="box">
+ <div class="error">$error</div>
+ <div class="infos">$infos</div>
+ <div class="name">$name</div>
+ </div>
+</body>
</html>
- }
- $c->res->headers->content_length( length $c->res->output );
- my $status = $c->finalize_headers;
- $c->finalize_output;
- return $status;
+ # 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.
+Abstract method, allows engines to write headers to response
=cut
-sub finalize_headers { }
+sub finalize_headers {
+ my ($self, $ctx) = @_;
-=item $c->finalize_output
+ my @headers;
+ $ctx->response->headers->scan(sub { push @headers, @_ });
-Finalize output.
+ $self->_set_writer($self->_response_cb->([ $ctx->response->status, \@headers ]));
+ $self->_clear_response_cb;
-=cut
+ return;
+}
-sub finalize_output { }
+=head2 $self->finalize_read($c)
-=item $c->forward($command)
+=cut
+
+sub finalize_read { }
-Forward processing to a private 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');
- $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);
- my $namespace = '/';
- if ( $command =~ /^\/$/ ) {
- $command =~ /^(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $command = $2;
- }
- else { $namespace = _class2prefix($caller) || '/' }
- my $results = $c->get_action( $command, $namespace );
- unless ( @{$results} ) {
- 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";
- $results = [ [ [ $class, $code ] ] ];
- }
- else {
- $c->log->debug(qq/Couldn't forward to "$class->$method"/)
- if $c->debug;
- return 0;
- }
- }
- for my $result ( @{$results} ) {
- $c->state( $c->execute( @{ $result->[0] } ) );
+sub finalize_uploads {
+ my ( $self, $c ) = @_;
+
+ # 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));
}
- return $c->state;
+
}
-=item $c->get_action( $action, $namespace )
+=head2 $self->prepare_body($c)
-Get an action in a given namespace.
+sets up the L<Catalyst::Request> object body using L<HTTP::Body>
=cut
-sub get_action {
- my ( $c, $action, $namespace ) = @_;
- $namespace ||= '';
- if ($namespace) {
- $namespace = '' if $namespace eq '/';
- 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;
+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->cleanup(1); # Make extra sure!
+ $request->_body->tmpdir( $appclass->config->{uploadtmp} )
+ if exists $appclass->config->{uploadtmp};
+ }
+
+ # Check for definedness as you could read '0'
+ while ( defined ( my $buffer = $self->read($c) ) ) {
+ $c->prepare_body_chunk($buffer);
+ }
+
+ # 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" );
}
- return \@results;
}
- elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
else {
- for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
- my $name = $c->actions->{compiled}->[$i]->[0];
- my $regex = $c->actions->{compiled}->[$i]->[1];
- 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 ] ];
- }
- }
+ # Defined but will cause all body code to be skipped
+ $c->request->_body(0);
}
- return [];
}
-=item $c->handler( $class, $r )
+=head2 $self->prepare_body_chunk($c)
-Handles the request.
+Add a chunk to the request body.
=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 $default = $action eq 'default' ? $namespace : undef;
- my $results = $c->get_action( $action, $default );
- $namespace ||= '/';
- if ( @{$results} ) {
- for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) {
- $c->state( $c->execute( @{ $begin->[0] } ) );
- }
- for my $result ( @{ $c->get_action( $action, $default ) } ) {
- $c->state( $c->execute( @{ $result->[0] } ) );
- last unless $default;
- }
- for my $end ( @{ $c->get_action( 'end', $namespace ) } ) {
- $c->state( $c->execute( @{ $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->error($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"/);
- }
- $COUNT++;
- return $status;
+sub prepare_body_chunk {
+ my ( $self, $c, $chunk ) = @_;
+
+ $c->request->_body->add($chunk);
}
-=item $c->prepare($r)
+=head2 $self->prepare_body_parameters($c)
-Turns the engine-specific request( Apache, CGI ... )
-into a Catalyst context .
+Sets up parameters from 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 => {},
- 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 );
- }
- $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_parameters {
+ my ( $self, $c ) = @_;
+
+ return unless $c->request->_body;
+
+ $c->request->body_parameters( $c->request->_body->param );
}
-=item $c->prepare_action
+=head2 $self->prepare_connection($c)
-Prepare action.
+Abstract method implemented in 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_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->prepare_connection
+=head2 $self->prepare_cookies($c)
-Prepare connection.
+Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
=cut
-sub prepare_connection { }
+sub prepare_cookies {
+ my ( $self, $c ) = @_;
-=item $c->prepare_cookies
+ if ( my $header = $c->request->header('Cookie') ) {
+ $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
+ }
+}
-Prepare cookies.
+=head2 $self->prepare_headers($c)
=cut
-sub prepare_cookies { }
+sub prepare_headers {
+ my ($self, $ctx) = @_;
-=item $c->prepare_headers
+ my $env = $self->env;
+ my $headers = $ctx->request->headers;
-Prepare 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});
+ }
+}
+
+=head2 $self->prepare_parameters($c)
+
+sets up parameters from query and post parameters.
=cut
-sub prepare_headers { }
+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;
+ }
+
+ # 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));
+ }
+ $parameters->{$name} = @values > 1 ? \@values : $values[0];
+ }
+}
-=item $c->prepare_parameters
+=head2 $self->prepare_path($c)
-Prepare parameters.
+abstract method, implemented by engines.
=cut
-sub prepare_parameters { }
+sub prepare_path {
+ my ($self, $ctx) = @_;
-=item $c->prepare_path
+ my $env = $self->env;
-Prepare path and base.
+ 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 $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$//;
+ }
+ $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";
-sub prepare_path { }
+ # HTTP_HOST will include the port even if it's 80/443
+ $host =~ s/:(?:80|443)$//;
-=item $c->prepare_request
+ if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
+ $host .= ":$port";
+ }
-Prepare the engine request.
+ my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
+ my $uri = $scheme . '://' . $host . '/' . $path . $query;
-=cut
+ $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
-sub prepare_request { }
+ # set the base URI
+ # base must end in a slash
+ $base_path .= '/' unless $base_path =~ m{/$};
-=item $c->prepare_uploads
+ my $base_uri = $scheme . '://' . $host . $base_path;
-Prepare uploads.
+ $ctx->request->base( bless \$base_uri, $uri_class );
-=cut
+ return;
+}
-sub prepare_uploads { }
+=head2 $self->prepare_request($c)
-=item $c->execute($class, $coderef)
+=head2 $self->prepare_query_parameters($c)
-Execute a coderef in given class and catch exceptions.
-Errors are available via $c->error.
+process the query string and extract query parameters.
=cut
-sub execute {
- my ( $c, $class, $code ) = @_;
- $class = $c->comp($class) || $class;
- $c->state(0);
- eval {
- if ( $c->debug )
- {
- my $action = $c->actions->{reverse}->{"$code"} || "$code";
- my ( $elapsed, @state ) =
- $c->benchmark( $code, $class, $c, @{ $c->req->args } );
- $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed )
- if $c->debug;
- $c->state(@state);
- }
- else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) }
- };
- if ( my $error = $@ ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
- $c->log->error($error);
- $c->error($error) if $c->debug;
- $c->state(0);
+sub prepare_query_parameters {
+ my ($self, $c) = @_;
+
+ my $query_string = exists $self->env->{QUERY_STRING}
+ ? $self->env->{QUERY_STRING}
+ : '';
+
+ # 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;
}
- return $c->state;
-}
-=item $c->run
+ my %query;
-Starts the engine.
+ # replace semi-colons
+ $query_string =~ s/;/&/g;
-=cut
+ my @params = grep { length $_ } split /&/, $query_string;
+
+ for my $item ( @params ) {
-sub run { }
+ my ($param, $value)
+ = map { $self->unescape_uri($_) }
+ split( /=/, $item, 2 );
-=item $c->request
+ $param = $self->unescape_uri($item) unless defined $param;
-=item $c->req
+ if ( exists $query{$param} ) {
+ if ( ref $query{$param} ) {
+ push @{ $query{$param} }, $value;
+ }
+ else {
+ $query{$param} = [ $query{$param}, $value ];
+ }
+ }
+ else {
+ $query{$param} = $value;
+ }
+ }
-Returns a C<Catalyst::Request> object.
+ $c->request->query_parameters( \%query );
+}
- my $req = $c->req;
+=head2 $self->prepare_read($c)
-=item $c->response
+prepare to read from the engine.
-=item $c->res
+=cut
-Returns a C<Catalyst::Response> object.
+sub prepare_read {
+ my ( $self, $c ) = @_;
- my $res = $c->res;
+ # Initialize the read position
+ $self->read_position(0);
-=item $c->set_action( $action, $code, $namespace, $attrs )
+ # Initialize the amount of data we think we need to read
+ $self->read_length( $c->request->header('Content-Length') || 0 );
+}
-Set an action in a given namespace.
+=head2 $self->prepare_request(@arguments)
+
+Populate the context object from the request object.
=cut
-sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
+sub prepare_request {
+ my ($self, $ctx, %args) = @_;
+ $self->_set_env($args{env});
+}
- my $prefix = _class2prefix($namespace) || '';
- my $action = 0;
- my $public = 0;
- my $regex = 0;
- my $arg = '';
- my $absolute = 0;
+=head2 $self->prepare_uploads($c)
- for my $attr ( @{$attrs} ) {
- if ( $attr =~ /^Action$/ ) {
- $action++;
- $arg = $1 if $1;
- }
- elsif ( $attr =~ /^Path\((.+)\)$/i ) {
- $arg = $1;
- $public++;
- }
- elsif ( $attr =~ /^Public$/i ) {
- $public++;
- }
- elsif ( $attr =~ /^Private$/i ) {
- $action++;
- }
- elsif ( $attr =~ /Regex(?:\((.+)\))?$/i ) {
- $regex++;
- $action++;
- $arg = $1 if $1;
+=cut
+
+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 => scalar $headers->content_type,
+ headers => $headers,
+ tempname => $upload->{tempname},
+ filename => $upload->{filename},
+ );
+ push @uploads, $u;
}
- elsif ( $attr =~ /Absolute(?:\((.+)\))?$/i ) {
- $action++;
- $absolute++;
- $public++;
- $arg = $1 if $1;
+ $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 ];
+ }
}
- elsif ( $attr =~ /Relative(?:\((.+)\))?$/i ) {
- $action++;
- $public++;
- $arg = $1 if $1;
+ else {
+ $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
}
}
+}
- return unless $action;
-
- my $parent = $c->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- 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;
+=head2 $self->prepare_write($c)
+
+Abstract method. Implemented by the engines.
+
+=cut
+
+sub prepare_write { }
+
+=head2 $self->read($c, [$maxlength])
+
+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 read {
+ my ( $self, $c, $maxlength ) = @_;
+
+ my $remaining = $self->read_length - $self->read_position;
+ $maxlength ||= $CHUNKSIZE;
+
+ # Are we done reading?
+ if ( $remaining <= 0 ) {
+ $self->finalize_read($c);
+ return;
}
- my $uid = $parent->getUID;
- $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
- my $forward = $prefix ? "$prefix/$method" : $method;
- $c->log->debug(qq|Private "/$forward" is "$namespace->$method"|)
- if $c->debug;
-
- $arg =~ s/^\w+//;
- $arg =~ s/\w+$//;
- if ( $arg =~ /^'(.*)'$/ ) { $arg = $1 }
- if ( $arg =~ /^"(.*)"$/ ) { $arg = $1 }
-
- my $reverse = $prefix ? "$method ($prefix)" : $method;
-
- if ($public) {
- my $is_absolute = 0;
- $is_absolute = 1 if $absolute;
- if ( $arg =~ /^\/(.+)/ ) {
- $arg = $1;
- $is_absolute = 1;
+
+ 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 $name =
- $is_absolute ? ( $arg || $method ) : "$prefix/" . ( $arg || $method );
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
- $c->log->debug(qq|Public "/$name" is "/$forward"|) if $c->debug;
+ $self->read_position( $self->read_position + $rc );
+ return $buffer;
}
- if ($regex) {
- push @{ $c->actions->{compiled} }, [ $arg, qr#$arg# ];
- $c->actions->{regex}->{$arg} = [ $namespace, $code ];
- $c->log->debug(qq|Public "$arg" is "/$forward"|) if $c->debug;
+ else {
+ Catalyst::Exception->throw(
+ message => "Unknown error reading input: $!" );
}
+}
- $c->actions->{reverse}->{"$code"} = $reverse;
+=head2 $self->read_chunk($c, $buffer, $length)
+
+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
-Setup.
+The amount of input data that has already been read.
- MyApp->setup;
+=head2 $self->run($app, $server)
+
+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 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, $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');
+ if (! $server ) {
+ $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto();
+ # 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?)")
}
+ $server->run($psgi, $options);
}
-=item $class->setup_actions($component)
+=head2 build_psgi_app ($app, @args)
-Setup actions for a component.
+Builds and returns a PSGI application closure, wrapping it in the reverse proxy
+middleware if the using_frontend_proxy config setting is set.
=cut
-sub setup_actions {
- my ( $self, $comp ) = @_;
- $comp = ref $comp || $comp;
- for my $action ( @{ $comp->_cache } ) {
- my ( $code, $attrs ) = @{$action};
- my $name = '';
- no strict 'refs';
- for my $sym ( values %{ $comp . '::' } ) {
- if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
- $name = *{$sym}{NAME};
- $self->set_action( $name, $code, $comp, $attrs );
- }
- }
- }
+sub build_psgi_app {
+ my ($self, $app, @args) = @_;
+
+ return sub {
+ my ($env) = @_;
+
+ return sub {
+ my ($respond) = @_;
+ $self->_set_response_cb($respond);
+ $app->handle_request(env => $env);
+ };
+ };
}
-=item $class->setup_components
+=head2 $self->write($c, $buffer)
-Setup components.
+Writes the buffer to the client.
=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->setup_actions($self);
- $self->components( {} );
- for my $comp ( $self->_components($self) ) {
- $self->components->{ ref $comp } = $comp;
- $self->setup_actions($comp);
+sub write {
+ my ( $self, $c, $buffer ) = @_;
+
+ unless ( $self->_prepared_write ) {
+ $self->prepare_write($c);
+ $self->_prepared_write(1);
}
- $self->log->debug( 'Initialized components "'
- . join( ' ', keys %{ $self->components } )
- . '"' )
- if $self->debug;
-}
-=item $c->stash
+ $buffer = q[] unless defined $buffer;
-Returns a hashref containing all your data.
+ my $len = length($buffer);
+ $self->_writer->write($buffer);
- $c->stash->{foo} ||= 'yada';
- print $c->stash->{foo};
+ return $len;
+}
+
+=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 stash {
- my $self = shift;
- if ( $_[0] ) {
- my $stash = $_[1] ? {@_} : $_[0];
- while ( my ( $key, $val ) = each %$stash ) {
- $self->{stash}->{$key} = $val;
- }
- }
- return $self->{stash};
-}
+sub unescape_uri {
+ my ( $self, $str ) = @_;
-sub _prefix {
- my ( $class, $name ) = @_;
- my $prefix = _class2prefix($class);
- $name = "$prefix/$name" if $prefix;
- return $name;
-}
+ $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
-sub _class2prefix {
- my $class = shift || '';
- $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/;
- my $prefix = lc $2 || '';
- $prefix =~ s/\:\:/\//g;
- return $prefix;
+ return $str;
}
-=back
+=head2 $self->finalize_output
+
+<obsolete>, see finalize_body
+
+=head2 $self->env
+
+Hash containing environment variables including many special variables inserted
+by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
+
+Before accessing environment 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 environment 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<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