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 Text::ASCIITable::Wrap 'wrap';
-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
=head1 DESCRIPTION
-This is the core of catalyst. The various drivers are subclasses
-of this class.
-
=head1 METHODS
=over 4
=item $c->comp($name)
-Shortcut for $c->component
-
=item $c->component($name)
Get a component object by name.
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->dispatch
-
-Dispatch request to actions.
-
-=cut
-
-sub dispatch {
- my $c = shift;
- 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} ) {
-
- # Execute last begin
- $c->state(1);
- if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
- $c->execute( @{ $begin->[0] } );
- return if scalar @{ $c->error };
- }
-
- # Execute the auto chain
- for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
- $c->execute( @{ $auto->[0] } );
- return if scalar @{ $c->error };
- last unless $c->state;
- }
-
- # Execute the action or last default
- if ( ( my $action = $c->req->action ) && $c->state ) {
- if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) {
- $c->execute( @{ $result->[0] } );
- }
- }
- # Execute last end
- if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
- $c->execute( @{ $end->[0] } );
- return if scalar @{ $c->error };
- }
- }
- 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);
- }
}
=item $c->error
$class = $c->comp($class) || $class;
$c->state(0);
my $callsub = ( caller(1) )[3];
+
eval {
if ( $c->debug )
{
}
else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) }
};
+
if ( my $error = $@ ) {
unless ( ref $error ) {
=item $c->finalize
-Finalize request. This function can typically be overloaded with
-NEXT by plugins that need to do something at the end of the request.
+Finalize request.
=cut
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 && $c->response->status !~ /^(1|3)\d\d$/ ) {
$c->finalize_error;
}
- if ( $c->response->output && !$c->response->content_length ) {
+ if ( $c->response->body && !$c->response->content_length ) {
use bytes; # play safe with a utf8 aware perl
- $c->response->content_length( length $c->response->output );
+ $c->response->content_length( length $c->response->body );
}
my $status = $c->finalize_headers;
- $c->finalize_output;
+ $c->finalize_body;
return $status;
}
+=item $c->finalize_body
+
+Finalize body.
+
+=cut
+
+sub finalize_body { }
+
=item $c->finalize_cookies
Finalize cookies.
=item $c->finalize_error
-This is the default error screen displayed from finalize. Override
-with your own output if you need something special.
+Finalize error.
=cut
$name = '';
}
- $c->res->output( <<"" );
+ $c->res->body( <<"" );
<html>
<head>
<title>$title</title>
=item $c->finalize_headers
-Finalize headers. Null action by default.
+Finalize headers.
=cut
sub finalize_headers { }
-=item $c->finalize_output
-
-Finalize output. Null action by default
-
-=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('/controller/action');
- $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 $global = $command =~ /^\// ? 0 : 1;
- my $namespace = '/';
- if ( $command =~ /^\// ) {
- $command =~ /^(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $command = $2;
- }
- else { $namespace = _class2prefix($caller) || '/' }
- my $results = $c->get_action( $command, $namespace, $global );
- 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->execute( @{ $result->[0] } );
- return if scalar @{ $c->error };
- last unless $c->state;
- }
- return $c->state;
-}
-
-=item $c->get_action( $action, $namespace, $global )
-
-Get an action in a given namespace.
-
-=cut
-
-sub get_action {
- my ( $c, $action, $namespace, $global ) = @_;
- return [] unless $action;
- $namespace ||= '';
- if ($namespace) {
- if ($global) {
- my @results;
- for my $uid ( keys %{ $c->actions->{private} } ) {
- if ( my $result = $c->actions->{private}->{$uid}->{$action} ) {
- push @results, [$result];
- }
- }
- return \@results;
- }
- else {
- $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 )
-The main request handler.
+Handles the request.
=cut
my $status = -1;
eval {
my @stats = ();
+
my $handler = sub {
my $c = $class->prepare($engine);
$c->{stats} = \@stats;
$c->dispatch;
return $c->finalize;
};
+
if ( $class->debug ) {
my $elapsed;
( $elapsed, $status ) = $class->benchmark($handler);
$t->setColWidth( 'Action', 64, 1 );
$t->setColWidth( 'Time', 9, 1 );
- for my $stat (@stats) {
- $t->addRow( wrap( $stat->[0], 64 ), wrap( $stat->[1], 9 ) );
- }
+ 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;
}
sub prepare {
my ( $class, $r ) = @_;
+
my $c = bless {
request => Catalyst::Request->new(
{
stash => {},
state => 0
}, $class;
+
if ( $c->debug ) {
my $secs = time - $START || 1;
my $av = sprintf '%.3f', $COUNT / $secs;
$c->log->debug('**********************************');
$c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
}
+
$c->prepare_request($r);
$c->prepare_path;
$c->prepare_headers;
$c->prepare_cookies;
$c->prepare_connection;
+ $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->setColWidth( 'Value', 36, 1 );
for my $key ( keys %{ $c->req->params } ) {
my $value = $c->req->params->{$key} || '';
- $t->addRow( wrap( $key, 37 ), wrap( $value, 36 ) );
+ $t->addRow( $key, $value );
}
$c->log->debug( 'Parameters are', $t->draw );
}
- $c->prepare_uploads;
+
return $c;
}
=item $c->prepare_action
-Prepare action for processing.
+Prepare action.
=cut
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] ) {
$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. Null action by default
+Prepare connection.
=cut
=item $c->prepare_cookies
-Prepare cookies.
+Prepare cookies.
=cut
=item $c->prepare_headers
-Prepare headers. Null action by default
+Prepare headers.
=cut
=item $c->prepare_parameters
-Prepare parameters. Null action by default
+Prepare parameters.
=cut
=item $c->prepare_path
-Prepare path and base. Null action by default
+Prepare path and base.
=cut
=item $c->prepare_request
-Prepare the engine request. Null action by default
+Prepare the engine request.
=cut
=item $c->prepare_uploads
-Prepare uploads. Null action by default
+Prepare uploads.
=cut
=item $c->run
-Starts the engine. Null action by default
+Starts the engine.
=cut
sub run { }
-=item $c->req
-
-Shortcut for $c->request
-
=item $c->request
-Returns a C<Catalyst::Request> object.
-
- my $req = $c->request;
+=item $c->req
-=item $c->res
+Returns a C<Catalyst::Request> object.
-Shortcut for $c->response
+ my $req = $c->req;
=item $c->response
+=item $c->res
+
Returns a C<Catalyst::Response> object.
my $res = $c->res;
-=item $c->set_action( $action, $code, $namespace, $attrs )
-
-Set an action in a given namespace. Used to defined the actions
-in the attribute handlers.
-
-=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 ? "$prefix/$path" : $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 the application. required to initialize actions.
+Setup.
MyApp->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 all the components in YourApp::(M|V|C|Model|View|Controller)::*
+Setup components.
=cut
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( { hide_HeadRow => 1, hide_HeadLine => 1 } );
$t->setCols('Class');
$t->setColWidth( 'Class', 75, 1 );
- $t->addRow( wrap( $_, 75 ) ) for keys %{ $self->components };
+ $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( 'Private', 'Class', 'Code' );
- $privates->setColWidth( 'Private', 28, 1 );
- $privates->setColWidth( 'Class', 28, 1 );
- $privates->setColWidth( 'Code', 14, 1 );
- 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(
- wrap( "$prefix$action", 28 ),
- wrap( $class, 28 ),
- wrap( $code, 14 )
- );
- }
- $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( 'Public', 'Private' );
- $publics->setColWidth( 'Public', 37, 1 );
- $publics->setColWidth( 'Private', 36, 1 );
-
- for my $plain ( sort keys %{ $actions->{plain} } ) {
- my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
- $publics->addRow( wrap( "/$plain", 37 ),
- wrap( $self->actions->{reverse}->{$code} || $code, 36 ) );
- }
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
- my $regexes = Text::ASCIITable->new;
- $regexes->setCols( 'Regex', 'Private' );
- $regexes->setColWidth( 'Regex', 37, 1 );
- $regexes->setColWidth( 'Private', 36, 1 );
- for my $regex ( sort keys %{ $actions->{regex} } ) {
- my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
- $regexes->addRow( wrap( $regex, 37 ),
- wrap( $self->actions->{reverse}->{$class} || $class, 36 ) );
- }
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
+
+ $self->setup_actions( [ $self, @comps ] );
}
=item $c->state
=item $c->stash
-The stash is a global hash which can be used to pass around data
-between your components.
+Returns a hashref containing all your data.
$c->stash->{foo} ||= 'yada';
print $c->stash->{foo};
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 SEE ALSO
-
-=over 4
-
-=item L<Catalyst::Engine::Apache> - Apache Engines for MP1/2
-=item L<Catalyst::Engine::CGI> - CGI Engine
-=item L<Catalyst::Engine::FCGI> - FastCGI Engine
-=item L<Catalyst::Engine::HTTP> - Standalone Catalyst Server
-=item L<Catalyst::Engine::Test> - Engine for testing
-
=back
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>
-Marcus Ramberg, C<mramberg@cpan.org>
=head1 COPYRIGHT
projects / catagits/Catalyst-Runtime.git / blobdiff