X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=86ac3b974e14ae4f27276bfa875780ead491ac60;hp=9cbf8ad8b1065e3cb959db42bdae8a856cc70d08;hb=e5ecd5bc38bac3e2fcfaf643ea2a4c6ab46d7e57;hpb=adb53907bc24efd5107242b120799325ed67e448

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 9cbf8ad..86ac3b9 100644
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -1,7 +1,8 @@
 package Catalyst::Dispatcher;
 
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
+use Class::MOP;
+
 use Catalyst::Exception;
 use Catalyst::Utils;
 use Catalyst::Action;
@@ -11,17 +12,11 @@ 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;
+use overload '""' => sub { return ref(shift) }, fallback => 1;
 
-__PACKAGE__->mk_accessors(
-    qw/tree dispatch_types registered_dispatch_types
-      method_action_class action_container_class
-      preload_dispatch_types postload_dispatch_types
-      action_hash container_hash
-      /
-);
 
 # Preload these action types
 our @PRELOAD = qw/Index Path Regex/;
@@ -29,6 +24,18 @@ our @PRELOAD = qw/Index Path Regex/;
 # Postload these action types
 our @POSTLOAD = qw/Default/;
 
+has _tree                       => (is => 'rw');
+has _dispatch_types             => (is => 'rw');
+has _registered_dispatch_types  => (is => 'rw');
+has _method_action_class        => (is => 'rw');
+has _action_container_class     => (is => 'rw');
+has preload_dispatch_types      => (is => 'rw', required => 1, lazy => 1, default => sub { [@PRELOAD] });
+has postload_dispatch_types     => (is => 'rw', required => 1, lazy => 1, default => sub { [@POSTLOAD] });
+has _action_hash                => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+has _container_hash             => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+
+no Moose;
+
 =head1 NAME
 
 Catalyst::Dispatcher - The Catalyst Dispatcher
@@ -44,30 +51,19 @@ application based on the attributes you set.
 
 =head1 METHODS
 
-=head2 new 
+=head2 new
 
 Construct a new dispatcher.
 
 =cut
 
-sub new {
-    my $self  = shift;
-    my $class = ref($self) || $self;
-
-    my $obj = $class->SUPER::new(@_);
+sub BUILD {
+  my ($self, $params) = @_;
 
-    # set the default pre- and and postloads
-    $obj->preload_dispatch_types( \@PRELOAD );
-    $obj->postload_dispatch_types( \@POSTLOAD );
-    $obj->action_hash(    {} );
-    $obj->container_hash( {} );
+  my $container =
+    Catalyst::ActionContainer->new( { part => '/', actions => {} } );
 
-    # 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;
+  $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
 }
 
 =head2 $self->preload_dispatch_types
@@ -112,8 +108,8 @@ message about unknown resource
 
 sub dispatch {
     my ( $self, $c ) = @_;
-    if ( $c->action ) {
-        $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
+    if ( my $action = $c->action ) {
+        $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
     }
 
     else {
@@ -132,103 +128,123 @@ 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 = 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 ($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, @_;
 
-	#push @$args, @_;
+    no warnings 'recursion';
 
-	local $c->request->{arguments} = $args;
-	$action->execute($c);
+    #moose todo: reaching inside another object is bad
+    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)
@@ -239,9 +255,10 @@ Find an dispatch type that matches $c->req->path, and set args from it.
 
 sub prepare_action {
     my ( $self, $c ) = @_;
-    my $path = $c->req->path;
-    my @path = split /\//, $c->req->path;
-    $c->req->args( \my @args );
+    my $req = $c->req;
+    my $path = $req->path;
+    my @path = split /\//, $req->path;
+    $req->args( \my @args );
 
     unshift( @path, '' );    # Root action
 
@@ -254,7 +271,7 @@ sub prepare_action {
         # Check out dispatch types to see if any will handle the path at
         # this level
 
-        foreach my $type ( @{ $self->dispatch_types } ) {
+        foreach my $type ( @{ $self->_dispatch_types } ) {
             last DESCEND if $type->match( $c, $path );
         }
 
@@ -264,8 +281,11 @@ sub prepare_action {
         unshift @args, $arg;
     }
 
-    $c->log->debug( 'Path is "' . $c->req->match . '"' )
-      if ( $c->debug && $c->req->match );
+    #Moose todo: This seems illegible, even if efficient.
+    s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
+
+    $c->log->debug( 'Path is "' . $req->match . '"' )
+      if ( $c->debug && $req->match );
 
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
       if ( $c->debug && @args );
@@ -280,10 +300,23 @@ returns a named action from a given namespace.
 sub get_action {
     my ( $self, $name, $namespace ) = @_;
     return unless $name;
-    $namespace ||= '';
-    $namespace = '' if $namespace eq '/';
 
-    return $self->action_hash->{"$namespace/$name"};
+    $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 )
@@ -293,8 +326,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 +347,40 @@ 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->{''};
+    return reverse grep { defined } @containers, $self->_container_hash->{''};
 
+    #return (split '/', $namespace); # isnt this more clear?
     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
@@ -334,43 +392,41 @@ Also, set up the tree with the action containers.
 sub register {
     my ( $self, $c, $action ) = @_;
 
-    my $registered = $self->registered_dispatch_types;
+    my $registered = $self->_registered_dispatch_types;
 
-    my $priv = 0;
+    #my $priv = 0; #seems to be unused
     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";
-            push( @{ $self->dispatch_types }, $class->new ) unless $@;
+            #some error checking rethrowing here wouldn't hurt.
+            eval { Class::MOP::load_class($class) };
+            push( @{ $self->_dispatch_types }, $class->new ) unless $@;
             $registered->{$class} = 1;
         }
     }
 
     # 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 );
+    foreach my $type ( @{ $self->_dispatch_types } ) {
+        $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);
 
-    $self->action_hash->{"$namespace/$name"} = $action;
-    $self->container_hash->{$namespace} = $container;
+    $self->_action_hash->{"$namespace/$name"} = $action;
+    $self->_container_hash->{$namespace} = $container;
 }
 
-sub find_or_create_action_container {
+sub _find_or_create_action_container {
     my ( $self, $namespace ) = @_;
 
-    my $tree ||= $self->tree;
+    my $tree ||= $self->_tree;
 
     return $tree->getNodeValue unless $namespace;
 
@@ -403,26 +459,26 @@ sub _find_or_create_namespace_node {
 sub setup_actions {
     my ( $self, $c ) = @_;
 
-    $self->dispatch_types( [] );
-    $self->registered_dispatch_types( {} );
-    $self->method_action_class('Catalyst::Action');
-    $self->action_container_class('Catalyst::ActionContainer');
+    $self->_dispatch_types( [] );
+    $self->_registered_dispatch_types( {} );
+    $self->_method_action_class('Catalyst::Action');
+    $self->_action_container_class('Catalyst::ActionContainer');
 
     my @classes =
-      $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } );
-    @{ $self->registered_dispatch_types }{@classes} = (1) x @classes;
+      $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' ]
     );
 
@@ -445,15 +501,15 @@ sub setup_actions {
         $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
     };
 
-    $walker->( $walker, $self->tree, '' );
-    $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
-      if ($has_private);
+    $walker->( $walker, $self->_tree, '' );
+    $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
+      if $has_private;
 
     # List all public actions
-    $_->list($c) for @{ $self->dispatch_types };
+    $_->list($c) for @{ $self->_dispatch_types };
 }
 
-sub do_load_dispatch_types {
+sub _load_dispatch_types {
     my ( $self, @types ) = @_;
 
     my @loaded;
@@ -462,10 +518,11 @@ sub do_load_dispatch_types {
     for my $type (@types) {
         my $class =
           ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
-        eval "require $class";
+        #eval "require $class";
+        eval { Class::MOP::load_class($class) };
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;
-        push @{ $self->dispatch_types }, $class->new;
+        push @{ $self->_dispatch_types }, $class->new;
 
         push @loaded, $class;
     }
@@ -473,6 +530,12 @@ sub do_load_dispatch_types {
     return @loaded;
 }
 
+__PACKAGE__->meta->make_immutable;
+
+=head2 meta
+
+Provided by Moose
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>