uri_for fixup (with thanks to phaylon)
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index 9cbf8ad..ff25f96 100644 (file)
@@ -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;
@@ -132,103 +133,120 @@ 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 };
+    }
 
-       @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' );
+    my $action;
 
-    my $action = $self->_invoke_as_path( $c, $command, $args )
-                     || $self->_invoke_as_component( $c, $command, shift );
+    # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+    $action = $self->_invoke_as_path( $c, "$command", \@args );
 
-       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;
-       }
+    # 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 );
+    }
 
-       #push @$args, @_;
 
-       local $c->request->{arguments} = $args;
-       $action->execute($c);
+    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;
+    }
+
+    #push @$args, @_;
+
+    local $c->request->{arguments} = \@args;
+    $action->dispatch( $c );
 
     return $c->state;
 }
 
 sub _action_rel2abs {
-       my ( $self, $c, $path ) = @_;
-       
-       unless ( $path =~ m#^/# ) {
-               my $namespace = $c->stack->[-1]->namespace;
-               $path = "$namespace/$path";
-       }
-
-       $path =~ s#^/##;
-       return $path;
+    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 ) = @_;
-
-       return if ref $rel_path; # it must be a string
-
-       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 {
-                       return unless $path; # if a match on the global namespace failed then the whole lookup failed
-               }
-
-               unshift @extra_args, $tail;
-       }
+    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 {
+            return
+              unless $path
+              ; # if a match on the global namespace failed then the whole lookup failed
+        }
+
+        unshift @extra_args, $tail;
+    }
 }
 
 sub _find_component_class {
-       my ( $self, $c, $component ) = @_;
+    my ( $self, $c, $component ) = @_;
 
-       return ref($component)
-       || ref( $c->component($component) )
-       || $c->component($component)
+    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;
-       $method ||= "process";
-
-       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;
-       }
+    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)
@@ -280,12 +298,25 @@ returns a named action from a given namespace.
 sub get_action {
     my ( $self, $name, $namespace ) = @_;
     return unless $name;
-    $namespace ||= '';
-    $namespace = '' if $namespace eq '/';
+
+    $namespace = join( "/", grep { length } split '/', $namespace || "" );
 
     return $self->action_hash->{"$namespace/$name"};
 }
 
+=head2 $self->get_action_by_path( $path ); 
+   
+Returns the named action by its full path. 
+
+=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 )
 
 =cut
@@ -293,8 +324,8 @@ sub get_action {
 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);
 
@@ -314,15 +345,39 @@ sub get_containers {
 
     my @containers;
 
-    do {
-        push @containers, $self->container_hash->{$namespace};
-    } while ( $namespace =~ s#/[^/]+$## );
+    if ( length $namespace ) {
+        do {
+            push @containers, $self->container_hash->{$namespace};
+        } while ( $namespace =~ s#/[^/]+$## );
+    }
 
     return reverse grep { defined } @containers, $self->container_hash->{''};
 
     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
@@ -338,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";
@@ -348,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);
@@ -367,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;
@@ -409,20 +461,20 @@ 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;
 
     my $privates = Text::SimpleTable->new(
         [ 20, 'Private' ],
-        [ 38, 'Class' ],
+        [ 36, 'Class' ],
         [ 12, 'Method' ]
     );
 
@@ -453,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;