X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=cbc5896993ba66a413b1b9f282eac72ede2957c2;hp=8dee01f527d7cc86ff656157b00829678b36829a;hb=8fbcd90cdb30aed53d22d1cdbad95880f1c11693;hpb=81f6fc50d241d81f6c84cc8d2155f15c67868a5e
diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm
index 8dee01f..cbc5896 100644
--- a/lib/Catalyst/Engine.pm
+++ b/lib/Catalyst/Engine.pm
@@ -2,40 +2,37 @@ 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 Text::ASCIITable;
-use Tree::Simple;
-use Tree::Simple::Visitor::FindByPath;
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 backwards compatibility
+*finalize_output = \&finalize_body;
+
+# For statistics
our $COUNT = 1;
our $START = time;
-memoize('_class2prefix');
-
=head1 NAME
Catalyst::Engine - The Catalyst Engine
@@ -84,14 +81,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
@@ -126,15 +126,16 @@ Errors are available via $c->error.
sub execute {
my ( $c, $class, $code ) = @_;
- $class = $c->comp($class) || $class;
+ $class = $c->components->{$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$/;
+ $action = "-> $action" if $callsub =~ /forward$/;
my ( $elapsed, @state ) =
$c->benchmark( $code, $class, $c, @{ $c->req->args } );
push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
@@ -142,11 +143,16 @@ sub execute {
}
else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) }
};
+
if ( my $error = $@ ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
+
+ unless ( ref $error ) {
+ chomp $error;
+ $error = qq/Caught exception "$error"/;
+ }
+
$c->log->error($error);
- $c->error($error) if $c->debug;
+ $c->error($error);
$c->state(0);
}
return $c->state;
@@ -166,27 +172,38 @@ sub finalize {
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$/;
+ $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$/ ) {
+ if ( !$c->response->body_length && $c->response->status !~ /^(1|3)\d\d$/ ) {
$c->finalize_error;
}
- 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 );
+ if ( $c->response->body_length && !$c->response->content_length ) {
+ $c->response->content_length( $c->response->body_length );
}
my $status = $c->finalize_headers;
- $c->finalize_output;
+ $c->finalize_body;
return $status;
}
+=item $c->finalize_output
+
+alias to finalize_body
+
+=item $c->finalize_body
+
+Finalize body.
+
+=cut
+
+sub finalize_body { }
+
=item $c->finalize_cookies
Finalize cookies.
@@ -257,7 +274,7 @@ sub finalize_error {
$name = '';
}
- $c->res->output( <<"" );
+ $c->res->body( <<"" );
$title
@@ -321,113 +338,7 @@ Finalize headers.
sub finalize_headers { }
-=item $c->finalize_output
-
-Finalize output.
-
-=cut
-
-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 =~ /^(.*)\/(\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] } ) );
- }
- 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;
- 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 $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 )
+=item $c->handler( $class, $engine )
Handles the request.
@@ -440,69 +351,42 @@ sub handler {
my $status = -1;
eval {
my @stats = ();
+
my $handler = sub {
my $c = $class->prepare($engine);
$c->{stats} = \@stats;
- 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 ) }[-1] )
- {
- $c->state( $c->execute( @{ $result->[0] } ) );
- last unless $default;
- }
- for my $end ( reverse @{ $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);
- }
+ $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;
+ my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : (1 / $elapsed) );
my $t = Text::ASCIITable->new;
$t->setCols( 'Action', 'Time' );
- for my $stat (@stats) {
- $t->addRow(@$stat);
- }
+ $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;
}
-=item $c->prepare($r)
+=item $c->prepare($engine)
Turns the engine-specific request( Apache, CGI ... )
into a Catalyst context .
@@ -510,11 +394,13 @@ into a Catalyst context .
=cut
sub prepare {
- my ( $class, $r ) = @_;
+ my ( $class, $engine ) = @_;
+
my $c = bless {
request => Catalyst::Request->new(
{
arguments => [],
+ body => undef,
cookies => {},
headers => HTTP::Headers->new,
parameters => {},
@@ -523,43 +409,72 @@ sub prepare {
}
),
response => Catalyst::Response->new(
- { cookies => {}, headers => HTTP::Headers->new, status => 200 }
+ {
+ body => undef,
+ 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('**********************************');
$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_request($engine);
+ $c->prepare_connection;
$c->prepare_headers;
$c->prepare_cookies;
- $c->prepare_connection;
+ $c->prepare_path;
+ $c->prepare_action;
+
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->request->method eq 'POST' and $c->request->content_length ) {
+
+ 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;
+ }
+ }
+
+ if ( $c->request->method eq 'GET' ) {
+ $c->prepare_parameters;
+ }
if ( $c->debug && keys %{ $c->req->params } ) {
my $t = Text::ASCIITable->new;
$t->setCols( 'Key', 'Value' );
- for my $key ( keys %{ $c->req->params } ) {
- my $value = $c->req->params->{$key} || '';
+ $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', $t->draw );
}
- $c->prepare_uploads;
+
return $c;
}
@@ -574,6 +489,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] ) {
@@ -591,23 +507,35 @@ sub prepare_action {
$c->req->action($match);
$c->req->snippets( \@snippets );
}
+
else {
$c->req->action($path);
$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 );
}
+=item $c->prepare_body
+
+Prepare message body.
+
+=cut
+
+sub prepare_body { }
+
=item $c->prepare_connection
Prepare connection.
@@ -694,80 +622,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 %flags;
-
- for my $attr ( @{$attrs} ) {
- if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
- elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
- elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
- elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
- elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
- }
-
- return unless keys %flags;
-
- 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;
-
- if ( $flags{path} ) {
- $flags{path} =~ s/^\w+//;
- $flags{path} =~ s/\w+$//;
- if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
- if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
- }
- if ( $flags{regex} ) {
- $flags{regex} =~ s/^\w+//;
- $flags{regex} =~ s/\w+$//;
- if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
- if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
- }
-
- my $reverse = $prefix ? "$prefix/$method" : $method;
-
- if ( $flags{local} || $flags{global} || $flags{path} ) {
- my $path = $flags{path} || $method;
- my $absolute = 0;
- if ( $path =~ /^\/(.+)/ ) {
- $path = $1;
- $absolute = 1;
- }
- $absolute = 1 if $flags{global};
- my $name = $absolute ? $path : "$prefix/$path";
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
- }
- if ( my $regex = $flags{regex} ) {
- push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
- $c->actions->{regex}->{$regex} = [ $namespace, $code ];
- }
-
- $c->actions->{reverse}->{"$code"} = $reverse;
-}
-
=item $class->setup
Setup.
@@ -785,41 +639,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';
- my @cache = ( $comp, @{"$comp\::ISA"} );
- my %namespaces;
- while ( my $namespace = shift @cache ) {
- $namespaces{$namespace}++;
- for my $isa ( @{"$comp\::ISA"} ) {
- next if $namespaces{$isa};
- push @cache, $isa;
- $namespaces{$isa}++;
- }
- }
- for my $namespace ( keys %namespaces ) {
- for my $sym ( values %{ $namespace . '::' } ) {
- if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
- $name = *{$sym}{NAME};
- $self->set_action( $name, $code, $comp, $attrs );
- last;
- }
- }
- }
- }
-}
-
=item $class->setup_components
Setup components.
@@ -843,55 +662,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;
}
- my $t = Text::ASCIITable->new;
+
+ 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 );
- my $actions = $self->actions;
- my $privates = Text::ASCIITable->new;
- $privates->setCols( 'Action', 'Class', 'Code' );
- my $walker = sub {
- my ( $walker, $parent, $prefix ) = @_;
- $prefix .= $parent->getNodeValue || '';
- $prefix .= '/' unless $prefix =~ /\/$/;
- my $uid = $parent->getUID;
- for my $action ( keys %{ $actions->{private}->{$uid} } ) {
- my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
- $privates->addRow( "$prefix$action", $class, $code );
- }
- $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
- };
- $walker->( $walker, $self->tree, '' );
- $self->log->debug( 'Loaded private actions', $privates->draw )
- if ( @{ $privates->{tbl_rows} } && $self->debug );
- my $publics = Text::ASCIITable->new;
- $publics->setCols( 'Action', 'Class', 'Code' );
- for my $plain ( sort keys %{ $actions->{plain} } ) {
- my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
- $publics->addRow( "/$plain", $class, $code );
- }
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
- my $regexes = Text::ASCIITable->new;
- $regexes->setCols( 'Action', 'Class', 'Code' );
- for my $regex ( sort keys %{ $actions->{regex} } ) {
- my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
- $regexes->addRow( $regex, $class, $code );
- }
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{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.
@@ -912,23 +706,6 @@ 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 || '';
- my $prefix;
- if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
- $prefix = lc $2;
- $prefix =~ s/\:\:/\//g;
- }
- return $prefix;
-}
-
=back
=head1 AUTHOR