uri_for fixup (with thanks to phaylon)

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 96dc2ad..ff25f96 100644 (file)
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -11,6 +11,7 @@ use Catalyst::DispatchType::Index;
 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;
@@ -133,19 +134,33 @@ Documented in L<Catalyst>
 =cut
 
 sub forward {
-    my ( $self, $c, $command ) = splice( @_, 0, 3 );
+    my ( $self, $c, $command, @extra_params ) = @_;
 
     unless ($command) {
         $c->log->debug('Nothing to forward to') if $c->debug;
         return 0;
     }
 
-    my $args = [ @{ $c->request->arguments } ];
+    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 $action;
 
-    @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' );
+    # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+    $action = $self->_invoke_as_path( $c, "$command", \@args );
+
+    # 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 );
+    }
 
-    my $action = $self->_invoke_as_path( $c, $command, $args )
-      || $self->_invoke_as_component( $c, $command, shift );
 
     unless ($action) {
         my $error =
@@ -158,8 +173,8 @@ sub forward {
 
     #push @$args, @_;
 
-    local $c->request->{arguments} = $args;
-    $action->execute($c);
+    local $c->request->{arguments} = \@args;
+    $action->dispatch( $c );
 
     return $c->state;
 }
@@ -179,8 +194,6 @@ sub _action_rel2abs {
 sub _invoke_as_path {
     my ( $self, $c, $rel_path, $args ) = @_;
 
-    return if ref $rel_path;    # it must be a string
-
     my $path = $self->_action_rel2abs( $c, $rel_path );
 
     my ( $tail, @extra_args );
@@ -212,7 +225,6 @@ sub _invoke_as_component {
     my ( $self, $c, $component, $method ) = @_;
 
     my $class = $self->_find_component_class( $c, $component ) || return 0;
-    $method ||= "process";
 
     if ( my $code = $class->can($method) ) {
         return $self->method_action_class->new(
@@ -300,6 +312,7 @@ Returns the named action by its full path.
 
 sub get_action_by_path {
     my ( $self, $path ) = @_;
+    $path =~ s/^\///;
     $path = "/$path" unless $path =~ /\//;
     $self->action_hash->{$path};
 }
@@ -343,6 +356,28 @@ sub get_containers {
     my @parts = split '/', $namespace;
 }
 
+=head2 $self->uri_for_action($action, \@captures)
+
+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 the action object is not available for external dispatch or the dispatcher
+cannot determine an appropriate URI, this method will return undef.
+
+=cut
+
+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 )
 
 Make sure all required dispatch types for this action are loaded, then
@@ -358,7 +393,7 @@ sub register {
 
     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";
@@ -368,17 +403,14 @@ sub register {
     }
 
     # 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 $name      = $action->name;
 
-    my $container = $self->find_or_create_action_container($namespace);
+    my $container = $self->_find_or_create_action_container($namespace);
 
     # Set the method value
     $container->add_action($action);
@@ -387,7 +419,7 @@ sub register {
     $self->container_hash->{$namespace} = $container;
 }
 
-sub find_or_create_action_container {
+sub _find_or_create_action_container {
     my ( $self, $namespace ) = @_;
 
     my $tree ||= $self->tree;
@@ -429,14 +461,14 @@ sub setup_actions {
     $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;
 
     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;
 
@@ -473,7 +505,7 @@ sub setup_actions {
     $_->list($c) for @{ $self->dispatch_types };
 }
 
-sub do_load_dispatch_types {
+sub _load_dispatch_types {
     my ( $self, @types ) = @_;
 
     my @loaded;