X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=486bbf77485924dcc36fa6450246b9ce3841aa5a;hb=61bacdcc9ec458cabeba0cf4ce0d40cb5eb9b8d4;hp=b477b4c5921e499f84db979c0a9fe1e482746c08;hpb=f8568ac8fb1ae94ac4ed01a5ac1812b93af422be;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm
index b477b4c..486bbf7 100644
--- a/lib/Catalyst/Engine.pm
+++ b/lib/Catalyst/Engine.pm
@@ -2,38 +2,34 @@ 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 HTML::Entities;
use HTTP::Headers;
-use Memoize;
use Time::HiRes qw/gettimeofday tv_interval/;
-use Tree::Simple;
-use Tree::Simple::Visitor::FindByPath;
+use Text::ASCIITable;
use Catalyst::Request;
+use Catalyst::Request::Upload;
use Catalyst::Response;
require Module::Pluggable::Fast;
+# For pretty dumps
$Data::Dumper::Terse = 1;
-__PACKAGE__->mk_classdata($_) for qw/actions components tree/;
+__PACKAGE__->mk_classdata('components');
__PACKAGE__->mk_accessors(qw/request response state/);
-__PACKAGE__->actions(
- { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
-
*comp = \&component;
*req = \&request;
*res = \&response;
+# For statistics
our $COUNT = 1;
our $START = time;
-memoize('_class2prefix');
-
=head1 NAME
Catalyst::Engine - The Catalyst Engine
@@ -82,14 +78,17 @@ Regex search for a component.
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;
}
}
+
}
=item $c->error
@@ -115,6 +114,47 @@ sub error {
return $c->{error};
}
+=item $c->execute($class, $coderef)
+
+Execute a coderef in given class and catch exceptions.
+Errors are available via $c->error.
+
+=cut
+
+sub execute {
+ my ( $c, $class, $code ) = @_;
+ $class = $c->comp($class) || $class;
+ $c->state(0);
+ my $callsub = ( caller(1) )[3];
+
+ eval {
+ if ( $c->debug )
+ {
+ my $action = $c->actions->{reverse}->{"$code"};
+ $action = "/$action" unless $action =~ /\-\>/;
+ $action = "-> $action" if $callsub =~ /forward$/;
+ my ( $elapsed, @state ) =
+ $c->benchmark( $code, $class, $c, @{ $c->req->args } );
+ push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
+ $c->state(@state);
+ }
+ else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) }
+ };
+
+ if ( my $error = $@ ) {
+
+ unless ( ref $error ) {
+ chomp $error;
+ $error = qq/Caught exception "$error"/;
+ }
+
+ $c->log->error($error);
+ $c->error($error);
+ $c->state(0);
+ }
+ return $c->state;
+}
+
=item $c->finalize
Finalize request.
@@ -124,24 +164,76 @@ Finalize request.
sub finalize {
my $c = shift;
- if ( my $location = $c->res->redirect ) {
+ $c->finalize_cookies;
+
+ if ( my $location = $c->response->redirect ) {
$c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
- $c->res->headers->header( Location => $location );
- $c->res->status(302);
+ $c->response->header( Location => $location );
+ $c->response->status(302) if $c->response->status !~ /^3\d\d$/;
+ }
+
+ if ( $#{ $c->error } >= 0 ) {
+ $c->finalize_error;
+ }
+
+ if ( !$c->response->output && $c->response->status !~ /^(1|3)\d\d$/ ) {
+ $c->finalize_error;
}
- if ( !$c->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 '
', @{ $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 = <<"";
+ if ( $c->response->output && !$c->response->content_length ) {
+ use bytes; # play safe with a utf8 aware perl
+ $c->response->content_length( length $c->response->output );
+ }
+
+ my $status = $c->finalize_headers;
+ $c->finalize_output;
+ return $status;
+}
+
+=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 );
+ }
+}
+
+=item $c->finalize_error
+
+Finalize error.
+
+=cut
+
+sub finalize_error {
+ my $c = shift;
+
+ $c->res->headers->content_type('text/html');
+ my $name = $c->config->{name} || 'Catalyst Application';
+
+ my ( $title, $error, $infos );
+ if ( $c->debug ) {
+ $error = join '
', @{ $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 = <<"";
Request
$req
@@ -150,11 +242,11 @@ sub finalize {
Stash
$stash
- }
- else {
- $title = $name;
- $error = '';
- $infos = <<"";
+ }
+ else {
+ $title = $name;
+ $error = '';
+ $infos = <<"";
(en) Please come back later
(de) Bitte versuchen sie es spaeter nocheinmal
@@ -166,67 +258,62 @@ sub finalize {
(it) Ritornato prego piĆ¹ successivamente
- $name = '';
- }
- $c->res->{output} = <<"";
+ $name = '';
+ }
+ $c->res->output( <<"" );
-
- $title
-
-
-
-
-
$error
-
$infos
-
$name
-
-
+
+ $title
+
+
+
+
+
$error
+
$infos
+
$name
+
+
- }
- $c->res->headers->content_length( length $c->res->output );
- my $status = $c->finalize_headers;
- $c->finalize_output;
- return $status;
}
=item $c->finalize_headers
@@ -245,164 +332,50 @@ Finalize output.
sub finalize_output { }
-=item $c->forward($command)
-
-Forward processing to a private action or a method from a class.
-If you define a class without method it will default to process().
-
- $c->forward('foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
-
-=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 = $1 }
- 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] } ) );
- }
- return $c->state;
-}
-
-=item $c->get_action( $action, $namespace )
-
-Get an action in a given namespace.
-
-=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;
- if ($match) {
- $action eq 'end' ? unshift @results, [$match] : push @results,
- [$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 $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 ] ];
- }
- }
- }
- return [];
-}
-
=item $c->handler( $class, $r )
Handles the request.
=cut
-sub handler ($$) {
- my ( $class, $r ) = @_;
+sub handler {
+ my ( $class, $engine ) = @_;
# Always expect worst case!
my $status = -1;
eval {
+ my @stats = ();
+
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);
- }
+ my $c = $class->prepare($engine);
+ $c->{stats} = \@stats;
+ $c->dispatch;
return $c->finalize;
};
+
if ( $class->debug ) {
my $elapsed;
( $elapsed, $status ) = $class->benchmark($handler);
$elapsed = sprintf '%f', $elapsed;
my $av = sprintf '%.3f', 1 / $elapsed;
- $class->log->info( "Request took $elapsed" . "s ($av/s)" );
+ my $t = Text::ASCIITable->new;
+ $t->setCols( 'Action', 'Time' );
+ $t->setColWidth( 'Action', 64, 1 );
+ $t->setColWidth( 'Time', 9, 1 );
+
+ for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
+ $class->log->info( "Request took $elapsed" . "s ($av/s)",
+ $t->draw );
}
else { $status = &$handler }
+
};
+
if ( my $error = $@ ) {
chomp $error;
$class->log->error(qq/Caught exception in engine "$error"/);
}
+
$COUNT++;
return $status;
}
@@ -416,6 +389,7 @@ into a Catalyst context .
sub prepare {
my ( $class, $r ) = @_;
+
my $c = bless {
request => Catalyst::Request->new(
{
@@ -433,36 +407,45 @@ sub prepare {
stash => {},
state => 0
}, $class;
+
if ( $c->debug ) {
my $secs = time - $START || 1;
my $av = sprintf '%.3f', $COUNT / $secs;
- $c->log->debug('********************************');
+ $c->log->debug('**********************************');
$c->log->debug("* Request $COUNT ($av/s) [$$]");
- $c->log->debug('********************************');
+ $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_input;
+ $c->prepare_cookies;
$c->prepare_connection;
+
my $method = $c->req->method || '';
my $path = $c->req->path || '';
my $hostname = $c->req->hostname || '';
my $address = $c->req->address || '';
$c->log->debug(qq/"$method" request for "$path" from $hostname($address)/)
if $c->debug;
+
$c->prepare_action;
$c->prepare_parameters;
if ( $c->debug && keys %{ $c->req->params } ) {
- my @params;
+ my $t = Text::ASCIITable->new;
+ $t->setCols( 'Key', 'Value' );
+ $t->setColWidth( 'Key', 37, 1 );
+ $t->setColWidth( 'Value', 36, 1 );
for my $key ( keys %{ $c->req->params } ) {
my $value = $c->req->params->{$key} || '';
- push @params, "$key=$value";
+ $t->addRow( $key, $value );
}
- $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' );
+ $c->log->debug( 'Parameters are', $t->draw );
}
+
$c->prepare_uploads;
return $c;
}
@@ -478,6 +461,7 @@ sub prepare_action {
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] ) {
@@ -486,7 +470,8 @@ sub prepare_action {
if ($#$result) {
my $match = $result->[1];
my @snippets = @{ $result->[2] };
- $c->log->debug(qq/Requested action "$path" matched "$match"/)
+ $c->log->debug(
+ qq/Requested action is "$path" and matched "$match"/)
if $c->debug;
$c->log->debug(
'Snippets are "' . join( ' ', @snippets ) . '"' )
@@ -494,19 +479,23 @@ sub prepare_action {
$c->req->action($match);
$c->req->snippets( \@snippets );
}
+
else {
$c->req->action($path);
- $c->log->debug(qq/Requested action "$path"/) if $c->debug;
+ $c->log->debug(qq/Requested action is "$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 );
}
@@ -525,7 +514,13 @@ Prepare cookies.
=cut
-sub prepare_cookies { }
+sub prepare_cookies {
+ my $c = shift;
+
+ if ( my $header = $c->request->header('Cookie') ) {
+ $c->req->cookies( { CGI::Cookie->parse($header) } );
+ }
+}
=item $c->prepare_headers
@@ -541,6 +536,14 @@ Prepare parameters.
=cut
+sub prepare_input { }
+
+=item $c->prepare_input
+
+Prepare message body.
+
+=cut
+
sub prepare_parameters { }
=item $c->prepare_path
@@ -567,39 +570,6 @@ Prepare uploads.
sub prepare_uploads { }
-=item $c->execute($class, $coderef)
-
-Execute a coderef in given class and catch exceptions.
-Errors are available via $c->error.
-
-=cut
-
-sub execute {
- my ( $c, $class, $code ) = @_;
- $class = $c->comp($class) || $class;
- $c->state(0);
- 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);
- }
- return $c->state;
-}
-
=item $c->run
Starts the engine.
@@ -624,105 +594,6 @@ Returns a C object.
my $res = $c->res;
-=item $c->set_action( $action, $code, $namespace, $attrs )
-
-Set an action in a given namespace.
-
-=cut
-
-sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
-
- my $prefix = _class2prefix($namespace) || '';
- my $action = 0;
- my $public = 0;
- my $regex = 0;
- my $arg = '';
- my $absolute = 0;
-
- 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;
- }
- elsif ( $attr =~ /Absolute(?:\((.+)\))?$/i ) {
- $action++;
- $absolute++;
- $public++;
- $arg = $1 if $1;
- }
- elsif ( $attr =~ /Relative(?:\((.+)\))?$/i ) {
- $action++;
- $public++;
- $arg = $1 if $1;
- }
- }
-
- 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;
- }
- 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 $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;
- }
- 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;
- }
-
- $c->actions->{reverse}->{"$code"} = $reverse;
-}
-
=item $class->setup
Setup.
@@ -740,28 +611,6 @@ sub setup {
}
}
-=item $class->setup_actions($component)
-
-Setup actions for a component.
-
-=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 );
- }
- }
- }
-}
-
=item $class->setup_components
Setup components.
@@ -785,21 +634,30 @@ sub setup_components {
if ( my $error = $@ ) {
chomp $error;
- $self->log->error(
- qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/);
+ die qq/Couldn't load components "$error"/;
}
- $self->setup_actions($self);
+
$self->components( {} );
+ my @comps;
for my $comp ( $self->_components($self) ) {
$self->components->{ ref $comp } = $comp;
- $self->setup_actions($comp);
+ push @comps, $comp;
}
- $self->log->debug( 'Initialized components "'
- . join( ' ', keys %{ $self->components } )
- . '"' )
- if $self->debug;
+
+ my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } );
+ $t->setCols('Class');
+ $t->setColWidth( 'Class', 75, 1 );
+ $t->addRow($_) for keys %{ $self->components };
+ $self->log->debug( 'Loaded components', $t->draw )
+ if ( @{ $t->{tbl_rows} } && $self->debug );
+
+ $self->setup_actions( [ $self, @comps ] );
}
+=item $c->state
+
+Contains the return value of the last executed action.
+
=item $c->stash
Returns a hashref containing all your data.
@@ -820,20 +678,8 @@ sub stash {
return $self->{stash};
}
-sub _prefix {
- my ( $class, $name ) = @_;
- my $prefix = _class2prefix($class);
- $name = "$prefix/$name" if $prefix;
- return $name;
-}
-
-sub _class2prefix {
- my $class = shift || '';
- $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/;
- my $prefix = lc $2 || '';
- $prefix =~ s/\:\:/\//g;
- return $prefix;
-}
+# Takes a coderef and returns an arrayref containing attributes
+sub _get_attrs { attributes::get( $_[0] ) || [] }
=back