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;
=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.
}
}
+=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->error($error, ...)
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} },
- _prettify( $action, sprintf( '%fs', $elapsed ), '' );
+ push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
$c->state(@state);
}
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;
=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
}
if ( $c->response->output && !$c->response->content_length ) {
- use bytes; # play safe with a utf8 aware perl
+ use bytes; # play safe with a utf8 aware perl
$c->response->content_length( length $c->response->output );
}
=item $c->finalize_error
-Finalize error.
+This is the default error screen displayed from finalize. Override
+with your own output if you need something special.
=cut
=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
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');
return 0;
}
my $caller = caller(0);
+ my $global = $command =~ /^\// ? 0 : 1;
my $namespace = '/';
if ( $command =~ /^\// ) {
$command =~ /^(.*)\/(\w+)$/;
$command = $2;
}
else { $namespace = _class2prefix($caller) || '/' }
- my $results = $c->get_action( $command, $namespace );
+ my $results = $c->get_action( $command, $namespace, $global );
unless ( @{$results} ) {
my $class = $command;
if ( $class =~ /[^\w\:]/ ) {
}
}
for my $result ( @{$results} ) {
- $c->state( $c->execute( @{ $result->[0] } ) );
+ $c->execute( @{ $result->[0] } );
+ return if scalar @{ $c->error };
+ last unless $c->state;
}
return $c->state;
}
-=item $c->get_action( $action, $namespace )
+=item $c->get_action( $action, $namespace, $global )
Get an action in a given namespace.
=cut
sub get_action {
- my ( $c, $action, $namespace ) = @_;
+ my ( $c, $action, $namespace, $global ) = @_;
+ return [] unless $action;
$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;
+ 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;
}
- return \@results;
}
elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
=item $c->handler( $class, $r )
-Handles the request.
+The main request handler.
=cut
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 ) {
( $elapsed, $status ) = $class->benchmark($handler);
$elapsed = sprintf '%f', $elapsed;
my $av = sprintf '%.3f', 1 / $elapsed;
- $class->log->info( "Request took $elapsed" . "s ($av/s)", @stats );
+ 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 }
};
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_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', @params );
+ $c->log->debug( 'Parameters are', $t->draw );
}
$c->prepare_uploads;
return $c;
=item $c->prepare_action
-Prepare action.
+Prepare action for processing.
=cut
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;
=item $c->prepare_connection
-Prepare connection.
+Prepare connection. Null action by default
=cut
=item $c->prepare_cookies
-Prepare cookies.
+Prepare cookies.
=cut
=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
=item $c->run
-Starts the engine.
+Starts the engine. Null action by default
=cut
sub run { }
-=item $c->request
-
=item $c->req
-Returns a C<Catalyst::Request> object.
+Shortcut for $c->request
- my $req = $c->req;
+=item $c->request
-=item $c->response
+Returns a C<Catalyst::Request> object.
+
+ 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.
+Set an action in a given namespace. Used to defined the actions
+in the attribute handlers.
=cut
$absolute = 1;
}
$absolute = 1 if $flags{global};
- my $name = $absolute ? $path : "$prefix/$path";
+ my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
$c->actions->{plain}->{$name} = [ $namespace, $code ];
}
if ( my $regex = $flags{regex} ) {
=item $class->setup
-Setup.
+Setup the application. required to initialize actions.
MyApp->setup;
=item $class->setup_components
-Setup components.
+Setup all the components in YourApp::(M|V|C|Model|View|Controller)::*
=cut
$self->components->{ ref $comp } = $comp;
$self->setup_actions($comp);
}
- my @comps;
- push @comps, " $_" for keys %{ $self->components };
- $self->log->debug( 'Loaded components', @comps )
- if ( @comps && $self->debug );
+ 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 @messages = ('Loaded private actions');
- my $walker = sub {
- my ( $walker, $parent, $messages, $prefix ) = @_;
+ 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} };
- push @$messages, _prettify( "$prefix$action", $class, $code );
+ $privates->addRow(
+ wrap( "$prefix$action", 28 ),
+ wrap( $class, 28 ),
+ wrap( $code, 14 )
+ );
}
- $walker->( $walker, $_, $messages, $prefix )
- for $parent->getAllChildren;
+ $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
};
- $walker->( $walker, $self->tree, \@messages, '' );
- $self->log->debug(@messages) if ( $#messages && $self->debug );
- @messages = ('Loaded plain actions');
+ $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} };
- push @messages, _prettify( "/$plain", $class, $code );
+ $publics->addRow( wrap( "/$plain", 37 ),
+ wrap( $self->actions->{reverse}->{$code} || $code, 36 ) );
}
- $self->log->debug(@messages) if ( $#messages && $self->debug );
- @messages = ('Loaded regex actions');
+ $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} };
- push @messages, _prettify( $regex, $class, $code );
+ $regexes->addRow( wrap( $regex, 37 ),
+ wrap( $self->actions->{reverse}->{$class} || $class, 36 ) );
}
- $self->log->debug(@messages) if ( $#messages && $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};
return $prefix;
}
-sub _prettify {
- my ( $val1, $val2, $val3 ) = @_;
- formline
-' @<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<<<<<<<<<<<<<< @>>>>>>>>>>>>>> ',
- $val1, $val2, $val3;
- my $formatted = $^A;
- $^A = '';
- return $formatted;
-}
+=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