use strict;
use base 'Class::Data::Inheritable';
+use Catalyst::Exception;
use Catalyst::Utils;
use Text::ASCIITable;
use Tree::Simple;
__PACKAGE__->mk_classdata($_) for qw/actions tree/;
-# 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 ) );
-
=head1 NAME
Catalyst::Dispatcher - The Catalyst Dispatcher
=over 4
+=item $c->detach( $command [, \@arguments ] )
+
+Like C<forward> but doesn't return.
+
+=cut
+
+sub detach {
+ my ( $c, $command, @args ) = @_;
+ $c->forward( $command, @args ) if $command;
+ # die with DETACH signal, which will be caught in dispatching.
+ die $Catalyst::Engine::DETACH;
+}
+
=item $c->dispatch
Dispatch request to actions.
unless ($namespace) {
if ( my $result = $c->get_action($action) ) {
- $namespace =
- Catalyst::Utils::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
- my $auto;
- for $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
- my $mkay = defined $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] ) {
+ 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 {
+ } else {
my $path = $c->req->path;
my $error = $path
? qq/Unknown resource "$path"/
}
}
-=item $c->forward($command)
+=item $c->forward( $command [, \@arguments ] )
Forward processing to a private action or a method from a class.
If you define a class without method it will default to process().
+also takes an optional arrayref containing arguments to be passed
+to the new function. $c->req->args will be reset upon returning
+from the function.
$c->forward('/foo');
$c->forward('index');
return 0;
}
- my $caller = caller(0);
+ # Relative forwards from detach
+ my $caller = ( caller(0) )[0]->isa('Catalyst::Dispatcher')
+ && ( ( caller(1) )[3] =~ /::detach$/ ) ? caller(1) : caller(0);
+
my $namespace = '/';
+ my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
if ( $command =~ /^\// ) {
$command =~ /^\/(.*)\/(\w+)$/;
$command =~ s/^\///;
}
- else { $namespace = Catalyst::Utils::class2prefix($caller) || '/' }
+ else {
+ $namespace =
+ Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
+ || '/';
+ }
my $results = $c->get_action( $command, $namespace );
unless ( @{$results} ) {
- my $class = $command || '';
- my $path = $class . '.pm';
- $path =~ s/::/\//g;
- unless ( $INC{$path} ) {
+ unless ( defined( $c->components->{$command} ) ) {
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./;
+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) ) {
+ if ( my $code = $c->components->{$class}->can($method) ) {
$c->actions->{reverse}->{"$code"} = "$class->$method";
$results = [ [ [ $class, $code ] ] ];
- }
-
- else {
+ } else {
my $error =
qq/Couldn't forward to "$class". Does not implement "$method"/;
$c->error($error);
}
+ local $c->request->{arguments} = [ @{$arguments} ];
+
for my $result ( @{$results} ) {
$c->execute( @{ $result->[0] } );
return if scalar @{ $c->error };
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;
+ SEARCH:
for my $part ( split '/', $namespace ) {
$visitor->setSearchPath($part);
$parent->accept($visitor);
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 ($child) {
+ $parent = $child;
+ }
+ else {
+ last SEARCH;
+ }
}
}
sub set_action {
my ( $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 ) { $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 ) ) {
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{path} =~ /^\s*'(.*)'\s*$/ ) { $flags{path} = $1 }
+ if ( $flags{path} =~ /^\s*"(.*)"\s*$/ ) { $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 }
+ if ( $flags{regex} =~ /^\s*'(.*)'\s*$/ ) { $flags{regex} = $1 }
+ if ( $flags{regex} =~ /^\s*"(.*)"\s*$/ ) { $flags{regex} = $1 }
}
my $reverse = $prefix ? "$prefix/$method" : $method;
=cut
sub setup_actions {
- my ( $self, $comps ) = @_;
+ my $self = shift;
+
+ # These are the core structures
+ $self->actions(
+ {
+ plain => {},
+ private => {},
+ regex => {},
+ compiled => [],
+ reverse => {}
+ }
+ );
- for my $comp (@$comps) {
- $comp = ref $comp || $comp;
+ # 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};
}
+ return unless $self->debug;
+
my $actions = $self->actions;
my $privates = Text::ASCIITable->new;
$privates->setCols( 'Private', 'Class' );
};
$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->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->addRow( $regex, $reverse );
}
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
+ $self->log->debug( "Loaded regex actions:\n" . $regexes->draw )
+ if ( @{ $regexes->{tbl_rows} } );
}
=back