X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=a687dd8380c3a9e74321ebe3678e1fc8934343d8;hb=a13e21ab238a2752262dda5773d5be7a6273d875;hp=05101b93520cb969b3fe36a0c58e0b79a8a081ba;hpb=855ed93153e2b0c0e88d9bb8f23822c914393048;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 05101b9..a687dd8 100644
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -17,7 +17,10 @@ use overload '""' => sub { return ref shift }, fallback => 1;
 
 __PACKAGE__->mk_accessors(
     qw/tree dispatch_types registered_dispatch_types
-      method_action_class action_container_class/
+      method_action_class action_container_class
+      preload_dispatch_types postload_dispatch_types
+      action_hash container_hash
+      /
 );
 
 # Preload these action types
@@ -36,10 +39,61 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
+
 =head1 METHODS
 
+=head2 new 
+
+Construct a new dispatcher.
+
+=cut
+
+sub new {
+    my $self  = shift;
+    my $class = ref($self) || $self;
+
+    my $obj = $class->SUPER::new(@_);
+
+    # 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;
+}
+
+=head2 $self->preload_dispatch_types
+
+An arrayref of pre-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
+
+    +My::Dispatch::Type
+
+=head2 $self->postload_dispatch_types
+
+An arrayref of post-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
+
+    +My::Dispatch::Type
+
 =head2 $self->detach( $c, $command [, \@arguments ] )
 
+Documented in L<Catalyst>
+
 =cut
 
 sub detach {
@@ -50,6 +104,10 @@ sub detach {
 
 =head2 $self->dispatch($c)
 
+Delegate the dispatch to the action that matched the url, or return a
+message about unknown resource
+
+
 =cut
 
 sub dispatch {
@@ -70,6 +128,8 @@ sub dispatch {
 
 =head2 $self->forward( $c, $command [, \@arguments ] )
 
+Documented in L<Catalyst>
+
 =cut
 
 sub forward {
@@ -170,6 +230,8 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
 
 =head2 $self->prepare_action($c)
 
+Find an dispatch type that matches $c->req->path, and set args from it.
+
 =cut
 
 sub prepare_action {
@@ -194,9 +256,10 @@ sub prepare_action {
         }
 
         # If not, move the last part path to args
-        unshift @args, pop @path;
+        my $arg = pop(@path);
+        $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+        unshift @args, $arg;
     }
-    s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for @args;
 
     $c->log->debug( 'Path is "' . $c->req->match . '"' )
       if ( $c->debug && $c->req->match );
@@ -207,6 +270,8 @@ sub prepare_action {
 
 =head2 $self->get_action( $action, $namespace )
 
+returns a named action from a given namespace.
+
 =cut
 
 sub get_action {
@@ -215,13 +280,7 @@ sub get_action {
     $namespace ||= '';
     $namespace = '' if $namespace eq '/';
 
-    my @match = $self->get_containers($namespace);
-
-    return unless @match;
-
-    if ( my $action = $match[-1]->get_action($name) ) {
-        return $action if $action->namespace eq $namespace;
-    }
+    return $self->action_hash->{"$namespace/$name"};
 }
 
 =head2 $self->get_actions( $c, $action, $namespace )
@@ -241,48 +300,32 @@ sub get_actions {
 
 =head2 $self->get_containers( $namespace )
 
+Return all the action containers for a given namespace, inclusive
+
 =cut
 
 sub get_containers {
     my ( $self, $namespace ) = @_;
+    $namespace ||= '';
+    $namespace = '' if $namespace eq '/';
 
-    # If the namespace is / just return the root ActionContainer
-
-    return ( $self->tree->getNodeValue )
-      if ( !$namespace || ( $namespace eq '/' ) );
-
-    # Use a visitor to recurse down the tree finding the ActionContainers
-    # for each namespace in the chain.
-
-    my $visitor = Tree::Simple::Visitor::FindByPath->new;
-    my @path = split( '/', $namespace );
-    $visitor->setSearchPath(@path);
-    $self->tree->accept($visitor);
-
-    my @match = $visitor->getResults;
-    @match = ( $self->tree ) unless @match;
-
-    if ( !defined $visitor->getResult ) {
+    my @containers;
 
-        # 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.
+    do {
+        push @containers, $self->container_hash->{$namespace};
+    } while ( $namespace =~ s#/[^/]+$## );
 
-        if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
-            $visitor->setSearchPath($extra);
-            $match[-1]->accept($visitor);
-            push( @match, $visitor->getResult ) if defined $visitor->getResult;
-        }
-    }
+    return reverse grep { defined } @containers, $self->container_hash->{''};
 
-    return map { $_->getNodeValue } @match;
+    my @parts = split '/', $namespace;
 }
 
 =head2 $self->register( $c, $action )
 
+Make sure all required dispatch types for this action are loaded, then
+pass the action to our dispatch types so they can register it if required.
+Also, set up the tree with the action containers.
+
 =cut
 
 sub register {
@@ -310,38 +353,47 @@ sub register {
     return unless $reg + $priv;
 
     my $namespace = $action->namespace;
-    my $parent    = $self->tree;
-    my $visitor   = Tree::Simple::Visitor::FindByPath->new;
-
-    if ($namespace) {
-        for my $part ( split '/', $namespace ) {
-            $visitor->setSearchPath($part);
-            $parent->accept($visitor);
-            my $child = $visitor->getResult;
-
-            unless ($child) {
-
-                # Create a new tree node and an ActionContainer to form
-                # its value.
-
-                my $container =
-                  Catalyst::ActionContainer->new(
-                    { part => $part, actions => {} } );
-                $child = $parent->addChild( Tree::Simple->new($container) );
-                $visitor->setSearchPath($part);
-                $parent->accept($visitor);
-                $child = $visitor->getResult;
-            }
+    my $name      = $action->name;
 
-            $parent = $child;
-        }
-    }
+    my $container = $self->find_or_create_action_container($namespace);
 
     # Set the method value
-    $parent->getNodeValue->actions->{ $action->name } = $action;
+    $container->add_action($action);
+
+    $self->action_hash->{"$namespace/$name"} = $action;
+    $self->container_hash->{$namespace} = $container;
+}
+
+sub find_or_create_action_container {
+    my ( $self, $namespace ) = @_;
+
+    my $tree ||= $self->tree;
+
+    return $tree->getNodeValue unless $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 $child =
+      ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
+
+    unless ($child) {
+        my $container = Catalyst::ActionContainer->new($part);
+        $parent->addChild( $child = Tree::Simple->new($container) );
+    }
+
+    $self->_find_or_create_namespace_node( $child, @namespace );
 }
 
-=head2 $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $context )
+
 
 =cut
 
@@ -353,33 +405,15 @@ sub setup_actions {
     $self->method_action_class('Catalyst::Action');
     $self->action_container_class('Catalyst::ActionContainer');
 
-    # Preload action types
-    for my $type (@PRELOAD) {
-        my $class = "Catalyst::DispatchType::$type";
-        eval "require $class";
-        Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
-          if $@;
-        push @{ $self->dispatch_types }, $class->new;
-        $self->registered_dispatch_types->{$class} = 1;
-    }
-
-    # We use a tree
-    my $container =
-      Catalyst::ActionContainer->new( { part => '/', actions => {} } );
-    $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
+    my @classes =
+      $self->do_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');
     }
 
-    # Postload action types
-    for my $type (@POSTLOAD) {
-        my $class = "Catalyst::DispatchType::$type";
-        eval "require $class";
-        Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
-          if $@;
-        push @{ $self->dispatch_types }, $class->new;
-    }
+    $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } );
 
     return unless $c->debug;
 
@@ -416,6 +450,26 @@ sub setup_actions {
     $_->list($c) for @{ $self->dispatch_types };
 }
 
+sub do_load_dispatch_types {
+    my ( $self, @types ) = @_;
+
+    my @loaded;
+
+    # Preload action types
+    for my $type (@types) {
+        my $class =
+          ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
+        eval "require $class";
+        Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
+          if $@;
+        push @{ $self->dispatch_types }, $class->new;
+
+        push @loaded, $class;
+    }
+
+    return @loaded;
+}
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>