package Catalyst::Dispatcher;
use strict;
-use base 'Class::Data::Inheritable';
+use base 'Class::Accessor::Fast';
+use Catalyst::Exception;
use Catalyst::Utils;
+use Catalyst::Action;
use Text::ASCIITable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
-__PACKAGE__->mk_classdata($_) for qw/actions tree/;
+# Stringify to class
+use overload '""' => sub { return ref shift }, fallback => 1;
-# These are the core structures
-__PACKAGE__->actions(
- { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-
-# We use a tree
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
+__PACKAGE__->mk_accessors(qw/actions tree/);
=head1 NAME
=over 4
-=item $c->dispatch
+=item $self->detach( $c, $command [, \@arguments ] )
+
+=cut
-Dispatch request to actions.
+sub detach {
+ my ( $self, $c, $command, @args ) = @_;
+ $c->forward( $command, @args ) if $command;
+ die $Catalyst::DETACH;
+}
+
+=item $self->dispatch($c)
=cut
sub dispatch {
- my $c = shift;
+ my ( $self, $c ) = @_;
my $action = $c->req->action;
my $namespace = '';
$namespace = ( join( '/', @{ $c->req->args } ) || '/' )
unless ($namespace) {
if ( my $result = $c->get_action($action) ) {
$namespace =
- Catalyst::Utils::class2prefix( $result->[0]->[0]->[0] );
+ Catalyst::Utils::class2prefix( $result->[0]->[0]->namespace,
+ $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} ) {
+ # Errors break the normal flow and the end action is instantly run
+ my $error = 0;
+
# Execute last begin
$c->state(1);
- if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
- $c->execute( @{ $begin->[0] } );
- return if scalar @{ $c->error };
+ if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
+ $begin->[0]->execute($c);
+ $error++ if scalar @{ $c->error };
}
# Execute the auto chain
- my $auto = 0;
- for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
- $c->execute( @{ $auto->[0] } );
- return if scalar @{ $c->error };
+ my $autorun = 0;
+ for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
+ last if $error;
+ $autorun++;
+ $auto->[0]->execute($c);
+ $error++ if scalar @{ $c->error };
last unless $c->state;
- $auto++;
}
# Execute the action or last default
- my $mkay = $auto ? $c->state ? 1 : 0 : 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] ) {
- $c->execute( @{ $result->[0] } );
+ unless ($error) {
+ if ( my $result =
+ @{ $c->get_action( $action, $default, 1 ) }[-1] )
+ {
+ $result->[0]->execute($c);
+ $error++ if scalar @{ $c->error };
+ }
}
}
# Execute last end
- if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
- $c->execute( @{ $end->[0] } );
- return if scalar @{ $c->error };
+ if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
+ $end->[0]->execute($c);
}
}
}
}
-=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');
+=item $self->forward( $c, $command [, \@arguments ] )
=cut
sub forward {
+ my $self = shift;
my $c = shift;
my $command = shift;
return 0;
}
- my $caller = caller(0);
+ # Relative forwards from detach
+ my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher')
+ && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1);
+
my $namespace = '/';
+ my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
+
+ my $results = [];
if ( $command =~ /^\// ) {
- $command =~ /^\/(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $command = $2 || $command;
+ if ( $command =~ /^\/(\w+)$/ ) {
+ $results = $c->get_action( $1, $namespace );
+ }
+ else {
+ my $command_copy = $command;
+ my @extra_args;
+ DESCEND: while ( $command_copy =~ s/^\/(.*)\/(\w+)$/\/$1/ ) {
+ my $tail = $2;
+ $results = $c->get_action( $tail, $1 );
+ if ( @{$results} ) {
+ $command = $tail;
+ $namespace = $command_copy;
+ push( @{$arguments}, @extra_args );
+ last DESCEND;
+ }
+ unshift( @extra_args, $tail );
+ }
+ }
$command =~ s/^\///;
}
- else { $namespace = Catalyst::Utils::class2prefix($caller) || '/' }
-
- my $results = $c->get_action( $command, $namespace );
+ else {
+ $namespace =
+ Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
+ || '/';
+ $results = $c->get_action( $command, $namespace );
+ }
unless ( @{$results} ) {
- my $class = $command || '';
- my $path = $class . '.pm';
- $path =~ s/::/\//g;
- unless ( $INC{ $path } ) {
- my $error = qq/Unknown class "$class"/;
+ unless ( $c->components->{$command} ) {
+ my $error =
+qq/Couldn't forward to command "$command". Invalid action or component./;
$c->error($error);
$c->log->debug($error) if $c->debug;
return 0;
}
+ my $class = $command;
my $method = shift || 'process';
- if ( my $code = $class->can($method) ) {
- $c->actions->{reverse}->{"$code"} = "$class->$method";
- $results = [ [ [ $class, $code ] ] ];
+ if ( my $code = $c->components->{$class}->can($method) ) {
+ my $action = Catalyst::Action->new(
+ {
+ code => $code,
+ reverse => "$class->$method",
+ namespace => $class,
+ }
+ );
+ $results = [ [$action] ];
}
else {
- my $error = qq/Couldn't forward to "$class". Does not implement "$method"/;
+ my $error =
+ qq/Couldn't forward to "$class". Does not implement "$method"/;
$c->error($error);
$c->log->debug($error)
if $c->debug;
}
+ local $c->request->{arguments} = [ @{$arguments} ];
+
for my $result ( @{$results} ) {
- $c->execute( @{ $result->[0] } );
+ $result->[0]->execute($c);
return if scalar @{ $c->error };
last unless $c->state;
}
return $c->state;
}
-=item $c->get_action( $action, $namespace )
+=item $self->prepare_action($c)
+
+=cut
+
+sub prepare_action {
+ my ( $self, $c ) = @_;
+ 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] ) {
+
+ # It's a regex
+ if ($#$result) {
+ my $match = $result->[1];
+ my @snippets = @{ $result->[2] };
+ $c->log->debug(
+ qq/Requested action is "$path" and matched "$match"/)
+ if $c->debug;
+ $c->log->debug(
+ 'Snippets are "' . join( ' ', @snippets ) . '"' )
+ if ( $c->debug && @snippets );
+ $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 );
+}
-Get an action in a given namespace.
+=item $self->get_action( $c, $action, $namespace, $inherit )
=cut
sub get_action {
- my ( $c, $action, $namespace ) = @_;
+ my ( $self, $c, $action, $namespace, $inherit ) = @_;
return [] unless $action;
$namespace ||= '';
+ $inherit ||= 0;
if ($namespace) {
$namespace = '' if $namespace eq '/';
- my $parent = $c->tree;
+ my $parent = $self->tree;
my @results;
- my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
- if ( $allowed{$action} ) {
- my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
+ if ($inherit) {
+ my $result =
+ $self->actions->{private}->{ $parent->getUID }->{$action};
push @results, [$result] if $result;
my $visitor = Tree::Simple::Visitor::FindByPath->new;
+ SEARCH:
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;
+ my $match = $self->actions->{private}->{$uid}->{$action}
+ if $uid;
push @results, [$match] if $match;
- $parent = $child if $child;
+ if ($child) {
+ $parent = $child;
+ }
+ else {
+ last SEARCH;
+ }
}
}
$parent->accept($visitor);
my $child = $visitor->getResult;
my $uid = $child->getUID if $child;
- my $match = $c->actions->{private}->{$uid}->{$action}
+ my $match = $self->actions->{private}->{$uid}->{$action}
if $uid;
push @results, [$match] if $match;
}
else {
my $result =
- $c->actions->{private}->{ $parent->getUID }->{$action};
+ $self->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] ] }
+ elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
+ elsif ( my $r = $self->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];
+ for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
+ my $name = $self->actions->{compiled}->[$i]->[0];
+ my $regex = $self->actions->{compiled}->[$i]->[1];
if ( my @snippets = ( $action =~ $regex ) ) {
- return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
+ return [
+ [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
}
}
return [];
}
-=item $c->set_action( $action, $code, $namespace, $attrs )
-
-Set an action in a given namespace.
+=item $self->set_action( $c, $action, $code, $namespace, $attrs )
=cut
sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
+ my ( $self, $c, $method, $code, $namespace, $attrs ) = @_;
- my $prefix = Catalyst::Utils::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 ) {
+ push @{ $flags{path} }, $1;
+ }
+ elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
+ elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
+ push @{ $flags{regex} }, $2;
+ }
}
if ( $flags{private} && ( keys %flags > 1 ) ) {
}
return unless keys %flags;
- my $parent = $c->tree;
+ my $parent = $self->tree;
my $visitor = Tree::Simple::Visitor::FindByPath->new;
for my $part ( split '/', $prefix ) {
$parent = $child;
}
+ my $reverse = $prefix ? "$prefix/$method" : $method;
+
+ my $action = Catalyst::Action->new(
+ {
+ code => $code,
+ reverse => $reverse,
+ namespace => $namespace,
+ }
+ );
+
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 }
+ $self->actions->{private}->{$uid}->{$method} = $action;
+
+ my @path;
+ for my $path ( @{ $flags{path} } ) {
+ $path =~ s/^\w+//;
+ $path =~ s/\w+$//;
+ if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 }
+ if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 }
+ push @path, $path;
}
-
- if ( $flags{regex} ) {
- $flags{regex} =~ s/^\w+//;
- $flags{regex} =~ s/\w+$//;
- if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
- if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
+ $flags{path} = \@path;
+
+ my @regex;
+ for my $regex ( @{ $flags{regex} } ) {
+ $regex =~ s/^\w+//;
+ $regex =~ s/\w+$//;
+ if ( $regex =~ /^\s*'(.*)'\s*$/ ) { $regex = $1 }
+ if ( $regex =~ /^\s*"(.*)"\s*$/ ) { $regex = $1 }
+ push @regex, $regex;
}
+ $flags{regex} = \@regex;
- 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;
- }
+ if ( $flags{local} || $flags{global} ) {
+ push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
+ if $flags{local};
- $absolute = 1 if $flags{global};
- my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
+ push( @{ $flags{path} }, "/$method" ) if $flags{global};
}
- if ( my $regex = $flags{regex} ) {
- push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
- $c->actions->{regex}->{$regex} = [ $namespace, $code ];
+ for my $path ( @{ $flags{path} } ) {
+ if ( $path =~ /^\// ) { $path =~ s/^\/// }
+ else { $path = $prefix ? "$prefix/$path" : $path }
+ $self->actions->{plain}->{$path} = $action;
}
- $c->actions->{reverse}->{"$code"} = $reverse;
+ for my $regex ( @{ $flags{regex} } ) {
+ push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
+ $self->actions->{regex}->{$regex} = $action;
+ }
}
-=item $class->setup_actions($component)
-
-Setup actions for a component.
+=item $self->setup_actions( $class, $component )
=cut
sub setup_actions {
- my ( $self, $comps ) = @_;
+ my ( $self, $class ) = @_;
+
+ # These are the core structures
+ $self->actions(
+ {
+ plain => {},
+ private => {},
+ regex => {},
+ compiled => []
+ }
+ );
- for my $comp (@$comps) {
- $comp = ref $comp || $comp;
+ # We use a tree
+ $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
- for my $action ( @{ $comp->_cache } ) {
+ for my $comp ( keys %{ $class->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';
if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
$name = *{$sym}{NAME};
- $self->set_action( $name, $code, $comp, $attrs );
+ $class->set_action( $name, $code, $comp, $attrs );
last;
}
}
+ return unless $class->debug;
+
my $actions = $self->actions;
my $privates = Text::ASCIITable->new;
$privates->setCols( 'Private', 'Class' );
my $uid = $parent->getUID;
for my $action ( keys %{ $actions->{private}->{$uid} } ) {
- my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
- $privates->addRow( "$prefix$action", $class );
+ my $action_obj = $actions->{private}->{$uid}->{$action};
+ $privates->addRow( "$prefix$action", $action_obj->namespace );
}
$walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
};
$walker->( $walker, $self->tree, '' );
- $self->log->debug( 'Loaded private actions', $privates->draw )
- if ( @{ $privates->{tbl_rows} } && $self->debug );
+ $class->log->debug( "Loaded private actions:\n" . $privates->draw )
+ if ( @{ $privates->{tbl_rows} } );
my $publics = Text::ASCIITable->new;
$publics->setCols( 'Public', 'Private' );
$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( "/$plain", $reverse );
+ my $action = $actions->{plain}->{$plain};
+ $publics->addRow( "/$plain", "/$action" );
}
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
+ $class->log->debug( "Loaded public actions:\n" . $publics->draw )
+ if ( @{ $publics->{tbl_rows} } );
my $regexes = Text::ASCIITable->new;
$regexes->setCols( 'Regex', 'Private' );
$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( $regex, $reverse );
+ my $action = $actions->{regex}->{$regex};
+ $regexes->addRow( $regex, "/$action" );
}
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
+ $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
+ if ( @{ $regexes->{tbl_rows} } );
}
=back