use strict;
use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
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::Response;
$Data::Dumper::Terse = 1;
-__PACKAGE__->mk_classdata($_) for qw/actions components/;
-__PACKAGE__->mk_accessors(qw/request response/);
+__PACKAGE__->mk_classdata($_) for qw/actions components tree/;
+__PACKAGE__->mk_accessors(qw/request response state/);
__PACKAGE__->actions(
- { plain => {}, regex => {}, compiled => {}, reverse => {} } );
+ { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
+);
+__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
*comp = \&component;
*req = \&request;
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->action( $name => $coderef, ... )
-
-=item $c->action( $name )
-
-=item $c->action
-
-Add one or more actions.
-
- $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } );
-
-Get an action's class and coderef.
-
- my ($class, $code) = @{ $c->action('foo') };
-
-Get a list of available actions.
-
- my @actions = $c->action;
-
-It also automatically calls setup() if needed.
-
-See L<Catalyst::Manual::Intro> for more informations about actions.
-
-=cut
-
-sub action {
- my $self = shift;
- $self->setup unless $self->components;
- $self->actions( {} ) unless $self->actions;
- my $action;
- $_[1] ? ( $action = {@_} ) : ( $action = shift );
- if ( ref $action eq 'HASH' ) {
- while ( my ( $name, $code ) = each %$action ) {
- my $class = caller(0);
- if ( $name =~ /^\/(.*)\/$/ ) {
- my $regex = $1;
- $self->actions->{compiled}->{qr/$regex/} = $name;
- $self->actions->{regex}->{$name} = [ $class, $code ];
- }
- elsif ( $name =~ /^\?(.*)$/ ) {
- $name = $1;
- $name = _prefix( $class, $name );
- $self->actions->{plain}->{$name} = [ $class, $code ];
- }
- elsif ( $name =~ /^\!\?(.*)$/ ) {
- $name = $1;
- $name = _prefix( $class, $name );
- $name = "\!$name";
- $self->actions->{plain}->{$name} = [ $class, $code ];
- }
- else { $self->actions->{plain}->{$name} = [ $class, $code ] }
- $self->actions->{reverse}->{"$code"} = $name;
- $self->log->debug(qq/"$class" defined "$name" as "$code"/)
- if $self->debug;
- }
- }
- elsif ($action) {
- if ( my $p = $self->actions->{plain}->{$action} ) { return [$p] }
- elsif ( my $r = $self->actions->{regex}->{$action} ) { return [$r] }
- else {
- for my $regex ( keys %{ $self->actions->{compiled} } ) {
- my $name = $self->actions->{compiled}->{$regex};
- if ( $action =~ $regex ) {
- my @snippets;
- for my $i ( 1 .. 9 ) {
- no strict 'refs';
- last unless ${$i};
- push @snippets, ${$i};
- }
- return [ $self->actions->{regex}->{$name},
- $name, \@snippets ];
- }
- }
- }
- return 0;
- }
- else {
- return (
- keys %{ $self->actions->{plain} },
- keys %{ $self->actions->{regex} }
- );
- }
-}
-
=item $c->benchmark($coderef)
Takes a coderef with arguments and returns elapsed time as float.
=item $c->comp($name)
+Shortcut for $c->component
+
=item $c->component($name)
Get a component object by name.
}
}
-=item $c->errors
+=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
-=item $c->errors($error, ...)
+=item $c->error($error, ...)
-=item $c->errors($arrayref)
+=item $c->error($arrayref)
-Returns an arrayref containing errors messages.
+Returns an arrayref containing error messages.
- my @errors = @{ $c->errors };
+ my @error = @{ $c->error };
Add a new error.
- $c->errors('Something bad happened');
+ $c->error('Something bad happened');
=cut
-sub errors {
+sub error {
my $c = shift;
- my $errors = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
- push @{ $c->{errors} }, @$errors;
- return $c->{errors};
+ my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
+ push @{ $c->{error} }, @$error;
+ return $c->{error};
+}
+
+=item $c->execute($class, $coderef)
+
+Execute a coderef in given class and catch exceptions.
+Errors are available via $c->error.
+
+=cut
+
+sub execute {
+ my ( $c, $class, $code ) = @_;
+ $class = $c->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.
+Finalize request. This function can typically be overloaded with
+NEXT by plugins that need to do something at the end of the request.
=cut
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);
- }
-
- if ( !$c->res->output || $#{ $c->errors } >= 0 ) {
- $c->res->headers->content_type('text/html');
- my $name = $c->config->{name} || 'Catalyst Application';
- my ( $title, $errors, $infos );
- if ( $c->debug ) {
- $errors = join '<br/>', @{ $c->errors };
- $errors ||= '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 = <<"";
+ $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->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
+
+This is the default error screen displayed from finalize. Override
+with your own output if you need something special.
+
+=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 '<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>Stash</u></b><br/>
<pre>$stash</pre>
- }
- else {
- $title = $name;
- $errors = '';
- $infos = <<"";
+ }
+ else {
+ $title = $name;
+ $error = '';
+ $infos = <<"";
<pre>
(en) Please come back later
(de) Bitte versuchen sie es spaeter nocheinmal
(it) Ritornato prego più successivamente
</pre>
- $name = '';
- }
- $c->res->{output} = <<"";
+ $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.errors {
- 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;
- }
- div.name {
- background-color: #779;
- border: 1px solid #557;
- padding: 8px;
- margin: 4px;
- -moz-border-radius: 10px;
- }
- </style>
- </head>
- <body>
- <div class="box">
- <div class="errors">$errors</div>
- <div class="infos">$infos</div>
- <div class="name">$name</div>
- </div>
- </body>
+<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;
+ }
+ div.name {
+ background-color: #779;
+ border: 1px solid #557;
+ padding: 8px;
+ margin: 4px;
+ -moz-border-radius: 10px;
+ }
+ </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;
}
=item $c->finalize_headers
-Finalize headers.
+Finalize headers. Null action by default.
=cut
=item $c->finalize_output
-Finalize output.
+Finalize output. Null action by default
=cut
=item $c->forward($command)
-Forward processing to a private/public action or a method from a class.
+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.html');
+ $c->forward('/foo');
+ $c->forward('/controller/action');
+ $c->forward('index');
$c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
$c->forward('MyApp::View::TT');
$c->log->debug('Nothing to forward to') if $c->debug;
return 0;
}
- if ( $command =~ /^\?(.*)$/ ) {
- $command = $1;
- my $caller = caller(0);
- $command = _prefix( $caller, $command );
- }
- elsif ( $command =~ /^\!\?(.*)$/ ) {
- $command = $1;
- my $caller = caller(0);
- $command = _prefix( $caller, $command );
- $command = "\!$command";
- }
- elsif ( $command =~ /^\!(.*)$/ ) {
- my $try = $1;
- my $caller = caller(0);
- my $prefix = _class2prefix($caller);
- $try = "!$prefix/$command";
- $command = $try if $c->actions->{plain}->{$try};
- }
- my ( $class, $code );
- if ( my $action = $c->action($command) ) {
- if ( $action->[2] ) {
- $c->log->debug(qq/Couldn't forward "$command" to regex action/)
- if $c->debug;
- return 0;
- }
- ( $class, $code ) = @{ $action->[0] };
+ my $caller = caller(0);
+ my $global = $command =~ /^\// ? 0 : 1;
+ my $namespace = '/';
+ if ( $command =~ /^\// ) {
+ $command =~ /^(.*)\/(\w+)$/;
+ $namespace = $1 || '/';
+ $command = $2;
}
- else {
- $class = $command;
+ 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 ( $code = $class->can($method) ) {
+ 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"/)
return 0;
}
}
- $class = $c->components->{$class} || $class;
- return $c->process( $class, $code );
+ for my $result ( @{$results} ) {
+ $c->execute( @{ $result->[0] } );
+ return if scalar @{ $c->error };
+ last unless $c->state;
+ }
+ return $c->state;
}
-=item $c->handler($r)
+=item $c->get_action( $action, $namespace, $global )
-Handles the request.
+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.
=cut
sub handler {
- my ( $class, $r ) = @_;
+ my ( $class, $engine ) = @_;
# Always expect worst case!
my $status = -1;
eval {
+ my @stats = ();
my $handler = sub {
- my $c = $class->prepare($r);
- if ( my $action = $c->action( $c->req->action ) ) {
- my ( $begin, $end );
- my $class = ${ $action->[0] }[0];
- my $prefix = _class2prefix($class);
- if ($prefix) {
- if ( $c->actions->{plain}->{"\!$prefix/begin"} ) {
- $begin = "\!$prefix/begin";
- }
- elsif ( $c->actions->{plain}->{'!begin'} ) {
- $begin = '!begin';
- }
- if ( $c->actions->{plain}->{"\!$prefix/end"} ) {
- $end = "\!$prefix/end";
- }
- elsif ( $c->actions->{plain}->{'!end'} ) { $end = '!end' }
- }
- else {
- if ( $c->actions->{plain}->{'!begin'} ) {
- $begin = '!begin';
- }
- if ( $c->actions->{plain}->{'!end'} ) { $end = '!end' }
- }
- $c->forward($begin) if $begin;
- $c->forward( $c->req->action ) if $c->req->action;
- $c->forward($end) if $end;
- }
- else {
- my $action = $c->req->path;
- my $error = $action
- ? qq/Unknown resource "$action"/
- : "No default action defined";
- $c->log->error($error) if $c->debug;
- $c->errors($error);
- }
+ my $c = $class->prepare($engine);
+ $c->{stats} = \@stats;
+ $c->dispatch;
return $c->finalize;
};
if ( $class->debug ) {
( $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( wrap( $stat->[0], 64 ), wrap( $stat->[1], 9 ) );
+ }
+ $class->log->info( "Request took $elapsed" . "s ($av/s)",
+ $t->draw );
}
else { $status = &$handler }
};
=item $c->prepare($r)
-Turns the engine-specific request (Apache, CGI...) into a Catalyst context.
+Turns the engine-specific request( Apache, CGI ... )
+into a Catalyst context .
=cut
response => Catalyst::Response->new(
{ cookies => {}, headers => HTTP::Headers->new, status => 200 }
),
- stash => {}
+ 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_cookies;
$c->prepare_connection;
my $method = $c->req->method || '';
my $path = $c->req->path || '';
$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( wrap( $key, 37 ), wrap( $value, 36 ) );
}
- $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' );
+ $c->log->debug( 'Parameters are', $t->draw );
}
$c->prepare_uploads;
return $c;
=item $c->prepare_action
-Prepare action.
+Prepare action for processing.
=cut
$c->req->args( \my @args );
while (@path) {
$path = join '/', @path;
- if ( my $result = $c->action($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"/)
+ $c->log->debug(
+ qq/Requested action is "$path" and matched "$match"/)
if $c->debug;
$c->log->debug(
'Snippets are "' . join( ' ', @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 ) {
- my $prefix = $c->req->args->[0];
- if ( $prefix && $c->actions->{plain}->{"\!$prefix/default"} ) {
- $c->req->match('');
- $c->req->action("\!$prefix/default");
- $c->log->debug('Using prefixed default action') if $c->debug;
- }
- elsif ( $c->actions->{plain}->{'!default'} ) {
- $c->req->match('');
- $c->req->action('!default');
- $c->log->debug('Using default action') if $c->debug;
- }
+ $c->req->action('default');
+ $c->req->match('');
}
$c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
if ( $c->debug && @args );
}
-=item $c->prepare_connection;
+=item $c->prepare_connection
-Prepare connection.
+Prepare connection. Null action by default
=cut
sub prepare_connection { }
-=item $c->prepare_cookies;
+=item $c->prepare_cookies
-Prepare cookies.
+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
-Prepare headers.
+Prepare headers. Null action by default
=cut
=item $c->prepare_parameters
-Prepare parameters.
+Prepare parameters. Null action by default
=cut
=item $c->prepare_path
-Prepare path and base.
+Prepare path and base. Null action by default
=cut
=item $c->prepare_request
-Prepare the engine request.
+Prepare the engine request. Null action by default
=cut
=item $c->prepare_uploads
-Prepare uploads.
+Prepare uploads. Null action by default
=cut
sub prepare_uploads { }
-=item $c->process($class, $coderef)
+=item $c->run
-Process a coderef in given class and catch exceptions.
-Errors are available via $c->errors.
+Starts the engine. Null action by default
=cut
-sub process {
- my ( $c, $class, $code ) = @_;
- my $status;
- eval {
- if ( $c->debug )
- {
- my $action = $c->actions->{reverse}->{"$code"} || "$code";
- my $elapsed;
- ( $elapsed, $status ) =
- $c->benchmark( $code, $class, $c, @{ $c->req->args } );
- $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed )
- if $c->debug;
- }
- else { $status = &$code( $class, $c, @{ $c->req->args } ) }
- };
- if ( my $error = $@ ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
- $c->log->error($error);
- $c->errors($error) if $c->debug;
- return 0;
- }
- return $status;
-}
-
-=item $c->remove_action($action)
-
-Remove an action.
-
- $c->remove_action('!foo');
+sub run { }
-=cut
+=item $c->req
-sub remove_action {
- my ( $self, $action ) = @_;
- if ( delete $self->actions->{regex}->{$action} ) {
- while ( my ( $regex, $name ) = each %{ $self->actions->{compiled} } ) {
- if ( $name eq $action ) {
- delete $self->actions->{compiled}->{$regex};
- last;
- }
- }
- }
- else {
- delete $self->actions->{plain}->{$action};
- }
-}
+Shortcut for $c->request
=item $c->request
-=item $c->req
-
Returns a C<Catalyst::Request> object.
- my $req = $c->req;
-
-=item $c->response
+ my $req = $c->request;
=item $c->res
+Shortcut for $c->response
+
+=item $c->response
+
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.
+Setup the application. required to initialize actions.
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 components.
+Setup all the components in YourApp::(M|V|C|Model|View|Controller)::*
=cut
$self->log->error(
qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/);
}
+ $self->setup_actions($self);
$self->components( {} );
- for my $component ( $self->_components($self) ) {
- $self->components->{ ref $component } = $component;
+ for my $comp ( $self->_components($self) ) {
+ $self->components->{ ref $comp } = $comp;
+ $self->setup_actions($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 };
+ $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( 'Initialized components "'
- . join( ' ', keys %{ $self->components } )
- . '"' )
- if $self->debug;
+ $self->log->debug( 'Loaded regex actions', $regexes->draw )
+ if ( @{ $regexes->{tbl_rows} } && $self->debug );
}
+=item $c->state
+
+Contains the return value of the last executed action.
+
=item $c->stash
-Returns a hashref containing all your data.
+The stash is a global hash which can be used to pass around data
+between your components.
$c->stash->{foo} ||= 'yada';
print $c->stash->{foo};
}
sub _class2prefix {
- my $class = shift;
- $class =~ /^.*::[(M)(Model)(V)(View)(C)(Controller)]+::(.*)$/;
- my $prefix = lc $1 || '';
- $prefix =~ s/\:\:/_/g;
+ 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