use strict;
use base 'Class::Data::Inheritable';
-use Memoize;
+use Catalyst::Exception;
+use Catalyst::Utils;
use Text::ASCIITable;
-use Text::ASCIITable::Wrap 'wrap';
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
__PACKAGE__->mk_classdata($_) for qw/actions tree/;
-__PACKAGE__->actions(
- { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
-
-memoize('_class2prefix');
-
=head1 NAME
-Catalyst::Dispatch - The Catalyst Dispatcher
+Catalyst::Dispatcher - The Catalyst Dispatcher
=head1 SYNOPSIS
=over 4
+=item $c->detach($command)
+
+Like C<forward> but doesn't return.
+
+=cut
+
+sub detach {
+ my ( $c, $command ) = @_;
+ $c->forward($command) if $command;
+ die $Catalyst::Engine::DETACH;
+}
+
=item $c->dispatch
Dispatch request to actions.
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] );
+ $namespace = Catalyst::Utils::class2prefix( $result->[0]->[0]->[0],
+ $c->config->{case_sensitive} );
}
}
+
my $default = $action eq 'default' ? $namespace : undef;
- my $results = $c->get_action( $action, $default );
+ my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
$namespace ||= '/';
+
if ( @{$results} ) {
# Execute last begin
$c->state(1);
- if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
+ if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
$c->execute( @{ $begin->[0] } );
return if scalar @{ $c->error };
}
# Execute the auto chain
- for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
+ my $autorun = 0;
+ for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
+ $autorun++;
$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] ) {
+ my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
+ if ( ( my $action = $c->req->action ) && $mkay ) {
+ if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
+ {
$c->execute( @{ $result->[0] } );
}
}
# Execute last end
- if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
+ if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
$c->execute( @{ $end->[0] } );
return if scalar @{ $c->error };
}
}
+
else {
my $path = $c->req->path;
my $error = $path
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+)$/;
+ $command =~ /^\/(.*)\/(\w+)$/;
$namespace = $1 || '/';
- $command = $2;
+ $command = $2 || $command;
+ $command =~ s/^\///;
+ }
+
+ else {
+ $namespace =
+ Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
+ || '/';
}
- else { $namespace = _class2prefix($caller) || '/' }
+
my $results = $c->get_action( $command, $namespace );
+
unless ( @{$results} ) {
- my $class = $command;
- if ( $class =~ /[^\w\:]/ ) {
- my $error = qq/Couldn't forward to "$class"/;
+ my $class = $command || '';
+ my $path = $class . '.pm';
+ $path =~ s/::/\//g;
+
+ unless ( $INC{$path} ) {
+ my $error =
+ qq/Couldn't forward to "$class". Invalid or not loaded./;
$c->error($error);
$c->log->debug($error) if $c->debug;
return 0;
}
+
+ unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) {
+ my $error =
+ qq/Can't forward to "$class". Class is not a Catalyst component./;
+ $c->error($error);
+ $c->log->debug($error) 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 {
- my $error = qq/Couldn't forward to "$class->$method"/;
+ my $error =
+ qq/Couldn't forward to "$class". Does not implement "$method"/;
$c->error($error);
$c->log->debug($error)
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 )
+=item $c->get_action( $action, $namespace, $inherit )
Get an action in a given namespace.
=cut
sub get_action {
- my ( $c, $action, $namespace ) = @_;
+ my ( $c, $action, $namespace, $inherit ) = @_;
return [] unless $action;
$namespace ||= '';
+ $inherit ||= 0;
+
if ($namespace) {
$namespace = '' if $namespace eq '/';
my $parent = $c->tree;
my @results;
- my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
- if ( $allowed{$action} ) {
+
+ if ($inherit) {
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);
push @results, [$match] if $match;
$parent = $child if $child;
}
+
}
+
else {
+
if ($namespace) {
my $visitor = Tree::Simple::Visitor::FindByPath->new;
$visitor->setSearchPath( split '/', $namespace );
if $uid;
push @results, [$match] if $match;
}
+
else {
my $result =
$c->actions->{private}->{ $parent->getUID }->{$action};
push @results, [$result] if $result;
}
+
}
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};
- }
+
+ if ( my @snippets = ( $action =~ $regex ) ) {
return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
}
+
}
}
return [];
sub set_action {
my ( $c, $method, $code, $namespace, $attrs ) = @_;
- my $prefix = _class2prefix($namespace) || '';
+ my $prefix =
+ Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
+ || '';
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 }
+ if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
+ elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
+ elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 }
+ elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
+ elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
+ $flags{regex} = $2;
+ }
}
if ( $flags{private} && ( keys %flags > 1 ) ) {
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} = $1 }
if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
}
+
if ( $flags{regex} ) {
$flags{regex} =~ s/^\w+//;
$flags{regex} =~ s/\w+$//;
my $reverse = $prefix ? "$prefix/$method" : $method;
if ( $flags{local} || $flags{global} || $flags{path} ) {
- my $path = $flags{path} || $method;
+ 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 ];
=cut
sub setup_actions {
- my ( $self, $comps ) = @_;
- for my $comp (@$comps) {
- $comp = ref $comp || $comp;
- for my $action ( @{ $comp->_cache } ) {
+ my $self = shift;
+
+ # These are the core structures
+ $self->actions(
+ {
+ plain => {},
+ private => {},
+ regex => {},
+ compiled => [],
+ reverse => {}
+ }
+ );
+
+ # We use a tree
+ $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
+
+ for my $comp ( keys %{ $self->components } ) {
+
+ # We only setup components that inherit from Catalyst::Base
+ next unless $comp->isa('Catalyst::Base');
+
+ for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
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"} ) {
$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;
}
+
}
+
}
+
}
+
}
+
+ return unless $self->debug;
+
my $actions = $self->actions;
my $privates = Text::ASCIITable->new;
$privates->setCols( 'Private', 'Class' );
$privates->setColWidth( 'Private', 36, 1 );
$privates->setColWidth( 'Class', 37, 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", 36 ),
- wrap( $class, 37 ) );
+ $privates->addRow( "$prefix$action", $class );
}
+
$walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
};
+
$walker->( $walker, $self->tree, '' );
- $self->log->debug( 'Loaded private actions', $privates->draw )
- if ( @{ $privates->{tbl_rows} } && $self->debug );
+ $self->log->debug( "Loaded private actions:\n" . $privates->draw )
+ if ( @{ $privates->{tbl_rows} } );
+
my $publics = Text::ASCIITable->new;
$publics->setCols( 'Public', 'Private' );
$publics->setColWidth( 'Public', 36, 1 );
$publics->setColWidth( 'Private', 37, 1 );
+
for my $plain ( sort keys %{ $actions->{plain} } ) {
my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
my $reverse = $self->actions->{reverse}->{$code};
$reverse = $reverse ? "/$reverse" : $code;
- $publics->addRow( wrap( "/$plain", 36 ), wrap( $reverse, 37 ) );
+ $publics->addRow( "/$plain", $reverse );
}
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
+
+ $self->log->debug( "Loaded public actions:\n" . $publics->draw )
+ if ( @{ $publics->{tbl_rows} } );
+
my $regexes = Text::ASCIITable->new;
$regexes->setCols( 'Regex', 'Private' );
$regexes->setColWidth( 'Regex', 36, 1 );
$regexes->setColWidth( 'Private', 37, 1 );
+
for my $regex ( sort keys %{ $actions->{regex} } ) {
my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
my $reverse = $self->actions->{reverse}->{$code};
$reverse = $reverse ? "/$reverse" : $code;
- $regexes->addRow( wrap( $regex, 36 ), wrap( $reverse, 37 ) );
+ $regexes->addRow( $regex, $reverse );
}
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
-}
-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;
+ $self->log->debug( "Loaded regex actions:\n" . $regexes->draw )
+ if ( @{ $regexes->{tbl_rows} } );
}
=back