use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
+use Scalar::Util ();
# Stringify to class
use overload '""' => sub { return ref shift }, fallback => 1;
qw/tree dispatch_types registered_dispatch_types
method_action_class action_container_class
preload_dispatch_types postload_dispatch_types
+ action_hash container_hash
/
);
# set the default pre- and and postloads
$obj->preload_dispatch_types( \@PRELOAD );
$obj->postload_dispatch_types( \@POSTLOAD );
+ $obj->action_hash( {} );
+ $obj->container_hash( {} );
+
+ # Create the root node of the tree
+ my $container =
+ Catalyst::ActionContainer->new( { part => '/', actions => {} } );
+ $obj->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
+
return $obj;
}
=cut
sub forward {
- my $self = shift;
- my $c = shift;
- my $command = shift;
+ my ( $self, $c, $command, @extra_params ) = @_;
unless ($command) {
$c->log->debug('Nothing to forward to') if $c->debug;
return 0;
}
- my $local_args = 0;
- my $arguments = $c->req->args;
- if ( ref( $_[-1] ) eq 'ARRAY' ) {
- $arguments = pop(@_);
- $local_args = 1;
+ my @args;
+
+ if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
+ @args = @{ pop @extra_params }
+ } else {
+ # this is a copy, it may take some abuse from ->_invoke_as_path if the path had trailing parts
+ @args = @{ $c->request->arguments };
}
- my $result;
+ my $action;
- unless ( ref $command ) {
- my $command_copy = $command;
+ # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+ $action = $self->_invoke_as_path( $c, "$command", \@args );
- unless ( $command_copy =~ s/^\/// ) {
- my $namespace = $c->stack->[-1]->namespace;
- $command_copy = "${namespace}/${command}";
- }
+ # forward to a component ( "MyApp::*::Foo" or $c->component("...") - a path or an object)
+ unless ($action) {
+ my $method = @extra_params ? $extra_params[0] : "process";
+ $action = $self->_invoke_as_component( $c, $command, $method );
+ }
- unless ( $command_copy =~ /\// ) {
- $result = $c->get_action( $command_copy, '/' );
- }
- else {
- my @extra_args;
- DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
- my $tail = $2;
- $result = $c->get_action( $tail, $1 );
- if ($result) {
- $local_args = 1;
- $command = $tail;
- unshift( @{$arguments}, @extra_args );
- last DESCEND;
- }
- unshift( @extra_args, $tail );
- }
- }
+
+ unless ($action) {
+ my $error =
+ qq/Couldn't forward to command "$command": /
+ . qq/Invalid action or component./;
+ $c->error($error);
+ $c->log->debug($error) if $c->debug;
+ return 0;
}
- unless ($result) {
+ #push @$args, @_;
- my $class = ref($command)
- || ref( $c->component($command) )
- || $c->component($command);
- my $method = shift || 'process';
+ local $c->request->{arguments} = \@args;
+ $action->dispatch( $c );
- unless ($class) {
- 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;
- }
+ return $c->state;
+}
- if ( my $code = $class->can($method) ) {
- my $action = $self->method_action_class->new(
- {
- name => $method,
- code => $code,
- reverse => "$class->$method",
- class => $class,
- namespace => Catalyst::Utils::class2prefix(
- $class, $c->config->{case_sensitive}
- ),
- }
- );
- $result = $action;
- }
+sub _action_rel2abs {
+ my ( $self, $c, $path ) = @_;
+
+ unless ( $path =~ m#^/# ) {
+ my $namespace = $c->stack->[-1]->namespace;
+ $path = "$namespace/$path";
+ }
+
+ $path =~ s#^/##;
+ return $path;
+}
+
+sub _invoke_as_path {
+ my ( $self, $c, $rel_path, $args ) = @_;
+ my $path = $self->_action_rel2abs( $c, $rel_path );
+
+ my ( $tail, @extra_args );
+ while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) )
+ { # allow $path to be empty
+ if ( my $action = $c->get_action( $tail, $path ) ) {
+ push @$args, @extra_args;
+ return $action;
+ }
else {
- my $error =
- qq/Couldn't forward to "$class". Does not implement "$method"/;
- $c->error($error);
- $c->log->debug($error)
- if $c->debug;
- return 0;
+ return
+ unless $path
+ ; # if a match on the global namespace failed then the whole lookup failed
}
+ unshift @extra_args, $tail;
}
+}
- if ($local_args) {
- local $c->request->{arguments} = [ @{$arguments} ];
- $result->execute($c);
- }
- else { $result->execute($c) }
+sub _find_component_class {
+ my ( $self, $c, $component ) = @_;
- return $c->state;
+ return ref($component)
+ || ref( $c->component($component) )
+ || $c->component($component);
+}
+
+sub _invoke_as_component {
+ my ( $self, $c, $component, $method ) = @_;
+
+ my $class = $self->_find_component_class( $c, $component ) || return 0;
+
+ if ( my $code = $class->can($method) ) {
+ return $self->method_action_class->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => "$class->$method",
+ class => $class,
+ namespace => Catalyst::Utils::class2prefix(
+ $class, $c->config->{case_sensitive}
+ ),
+ }
+ );
+ }
+ else {
+ my $error =
+ qq/Couldn't forward to "$class". Does not implement "$method"/;
+ $c->error($error);
+ $c->log->debug($error)
+ if $c->debug;
+ return 0;
+ }
}
=head2 $self->prepare_action($c)
sub get_action {
my ( $self, $name, $namespace ) = @_;
return unless $name;
- $namespace ||= '';
- $namespace = '' if $namespace eq '/';
- my @match = $self->get_containers($namespace);
+ $namespace = join( "/", grep { length } split '/', $namespace || "" );
+
+ return $self->action_hash->{"$namespace/$name"};
+}
- return unless @match;
+=head2 $self->get_action_by_path( $path );
+
+Returns the named action by its full path.
- if ( my $action = $match[-1]->get_action($name) ) {
- return $action if $action->namespace eq $namespace;
- }
+=cut
+
+sub get_action_by_path {
+ my ( $self, $path ) = @_;
+ $path =~ s/^\///;
+ $path = "/$path" unless $path =~ /\//;
+ $self->action_hash->{$path};
}
=head2 $self->get_actions( $c, $action, $namespace )
sub get_actions {
my ( $self, $c, $action, $namespace ) = @_;
return [] unless $action;
- $namespace ||= '';
- $namespace = '' if $namespace eq '/';
+
+ $namespace = join( "/", grep { length } split '/', $namespace || "" );
my @match = $self->get_containers($namespace);
sub get_containers {
my ( $self, $namespace ) = @_;
+ $namespace ||= '';
+ $namespace = '' if $namespace eq '/';
- # If the namespace is / just return the root ActionContainer
+ my @containers;
- return ( $self->tree->getNodeValue )
- if ( !$namespace || ( $namespace eq '/' ) );
+ if ( length $namespace ) {
+ do {
+ push @containers, $self->container_hash->{$namespace};
+ } while ( $namespace =~ s#/[^/]+$## );
+ }
- # Use a visitor to recurse down the tree finding the ActionContainers
- # for each namespace in the chain.
+ return reverse grep { defined } @containers, $self->container_hash->{''};
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- my @path = split( '/', $namespace );
- $visitor->setSearchPath(@path);
- $self->tree->accept($visitor);
+ my @parts = split '/', $namespace;
+}
- my @match = $visitor->getResults;
- @match = ( $self->tree ) unless @match;
+=head2 $self->uri_for_action($action, \@captures)
- if ( !defined $visitor->getResult ) {
+Takes a Catalyst::Action object and action parameters and returns a URI
+part such that if $c->req->path were this URI part, this action would be
+dispatched to with $c->req->captures set to the supplied arrayref.
- # If we don't manage to match, the visitor doesn't return the last
- # node is matched, so foo/bar/baz would only find the 'foo' node,
- # not the foo and foo/bar nodes as it should. This does another
- # single-level search to see if that's the case, and the 'last unless'
- # should catch any failures - or short-circuit this if this *is* a
- # bug in the visitor and gets fixed.
+If the action object is not available for external dispatch or the dispatcher
+cannot determine an appropriate URI, this method will return undef.
- if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
- $visitor->setSearchPath($extra);
- $match[-1]->accept($visitor);
- push( @match, $visitor->getResult ) if defined $visitor->getResult;
- }
- }
+=cut
- return map { $_->getNodeValue } @match;
+sub uri_for_action {
+ my ( $self, $action, $captures) = @_;
+ $captures ||= [];
+ foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
+ my $uri = $dispatch_type->uri_for_action( $action, $captures );
+ return( $uri eq '' ? '/' : $uri )
+ if defined($uri);
+ }
+ return undef;
}
=head2 $self->register( $c, $action )
my $priv = 0;
foreach my $key ( keys %{ $action->attributes } ) {
- $priv++ if $key eq 'Private';
+ next if $key eq 'Private';
my $class = "Catalyst::DispatchType::$key";
unless ( $registered->{$class} ) {
eval "require $class";
}
# Pass the action to our dispatch types so they can register it if reqd.
- my $reg = 0;
foreach my $type ( @{ $self->dispatch_types } ) {
- $reg++ if $type->register( $c, $action );
+ $type->register( $c, $action );
}
- return unless $reg + $priv;
-
my $namespace = $action->namespace;
- my $node = $self->find_or_create_namespace_node( $namespace );
+ my $name = $action->name;
+
+ my $container = $self->_find_or_create_action_container($namespace);
# Set the method value
- $node->getNodeValue->actions->{ $action->name } = $action;
+ $container->add_action($action);
+
+ $self->action_hash->{"$namespace/$name"} = $action;
+ $self->container_hash->{$namespace} = $container;
}
-sub find_or_create_namespace_node {
- my ( $self, $namespace ) = @_;
-
- my $tree ||= $self->tree;
+sub _find_or_create_action_container {
+ my ( $self, $namespace ) = @_;
+
+ my $tree ||= $self->tree;
- return $tree unless $namespace;
+ return $tree->getNodeValue unless $namespace;
- my @namespace = split '/', $namespace;
- return $self->_find_or_create_namespace_node( $tree, @namespace );
+ my @namespace = split '/', $namespace;
+ return $self->_find_or_create_namespace_node( $tree, @namespace )
+ ->getNodeValue;
}
sub _find_or_create_namespace_node {
- my ( $self, $parent, $part, @namespace ) = @_;
-
- return $parent unless $part;
+ my ( $self, $parent, $part, @namespace ) = @_;
- my $child = ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
+ return $parent unless $part;
- unless ($child) {
- # Create a new tree node and an ActionContainer to form
- # its value.
+ my $child =
+ ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
- my $container =
- Catalyst::ActionContainer->new(
- { part => $part, actions => {} } );
-
- $parent->addChild( $child = Tree::Simple->new($container) );
- }
+ unless ($child) {
+ my $container = Catalyst::ActionContainer->new($part);
+ $parent->addChild( $child = Tree::Simple->new($container) );
+ }
- $self->_find_or_create_namespace_node( $child, @namespace );
+ $self->_find_or_create_namespace_node( $child, @namespace );
}
=head2 $self->setup_actions( $class, $context )
$self->action_container_class('Catalyst::ActionContainer');
my @classes =
- $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } );
+ $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
@{ $self->registered_dispatch_types }{@classes} = (1) x @classes;
- # Create the root node of the tree
- my $container =
- Catalyst::ActionContainer->new( { part => '/', actions => {} } );
- $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
-
foreach my $comp ( values %{ $c->components } ) {
$comp->register_actions($c) if $comp->can('register_actions');
}
- $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } );
+ $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
return unless $c->debug;
my $privates = Text::SimpleTable->new(
[ 20, 'Private' ],
- [ 38, 'Class' ],
+ [ 36, 'Class' ],
[ 12, 'Method' ]
);
$_->list($c) for @{ $self->dispatch_types };
}
-sub do_load_dispatch_types {
+sub _load_dispatch_types {
my ( $self, @types ) = @_;
my @loaded;
push @loaded, $class;
}
- return @loaded;
+ return @loaded;
}
=head1 AUTHOR