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=0fe6c32a337907ea923826049972e621bcaed856;hp=89de3caa22e02c84b734ba3984657f470161732b;hb=74dafab798a163c251e09de7fcc21a267d1678a6;hpb=8199eac32fd36ac2eb0754ef934d7159de23277d

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index 89de3ca..0fe6c32 100644
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -5,6 +5,9 @@ use base 'Class::Accessor::Fast';
 use Catalyst::Exception;
 use Catalyst::Utils;
 use Catalyst::Action;
+use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Default;
+use Catalyst::DispatchType::Index;
 use Text::ASCIITable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
@@ -12,7 +15,13 @@ use Tree::Simple::Visitor::FindByPath;
 # Stringify to class
 use overload '""' => sub { return ref shift }, fallback => 1;
 
-__PACKAGE__->mk_accessors(qw/actions tree/);
+__PACKAGE__->mk_accessors(qw/tree dispatch_types/);
+
+# Preload these action types
+our @PRELOAD = qw/Path Regex/;
+
+# Postload these action types
+our @POSTLOAD = qw/Index Default/;
 
 =head1 NAME
 
@@ -44,61 +53,57 @@ sub detach {
 
 sub dispatch {
     my ( $self, $c ) = @_;
-    my $action    = $c->req->action;
-    my $namespace = '';
-    $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
-      if $action eq 'default';
-
-    unless ($namespace) {
-        if ( my $result = $c->get_action($action) ) {
-            $namespace =
-              Catalyst::Utils::class2prefix( $result->[0]->[0]->namespace,
-                $c->config->{case_sensitive} );
-        }
-    }
 
-    my $default = $action eq 'default' ? $namespace : undef;
-    my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
-    $namespace ||= '/';
+    if ( $c->action ) {
+
+        my @containers = $self->get_containers( $c->namespace );
+        my %actions;
+        foreach my $name (qw/begin auto end/) {
 
-    if ( @{$results} ) {
+            # Go down the container list representing each part of the
+            # current namespace inheritance tree, grabbing the actions hash
+            # of the ActionContainer object and looking for actions of the
+            # appropriate name registered to the namespace
+
+            $actions{$name} = [
+                map    { $_->{$name} }
+                  grep { exists $_->{$name} }
+                  map  { $_->actions } @containers
+            ];
+        }
 
         # Errors break the normal flow and the end action is instantly run
         my $error = 0;
 
         # Execute last begin
         $c->state(1);
-        if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
-            $begin->[0]->execute($c);
+        if ( my $begin = @{ $actions{begin} }[-1] ) {
+            $begin->execute($c);
             $error++ if scalar @{ $c->error };
         }
 
         # Execute the auto chain
         my $autorun = 0;
-        for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
+        for my $auto ( @{ $actions{auto} } ) {
             last if $error;
             $autorun++;
-            $auto->[0]->execute($c);
+            $auto->execute($c);
             $error++ if scalar @{ $c->error };
             last unless $c->state;
         }
 
         # Execute the action or last default
         my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
-        if ( ( my $action = $c->req->action ) && $mkay ) {
+        if ($mkay) {
             unless ($error) {
-                if ( my $result =
-                    @{ $c->get_action( $action, $default, 1 ) }[-1] )
-                {
-                    $result->[0]->execute($c);
-                    $error++ if scalar @{ $c->error };
-                }
+                $c->action->execute($c);
+                $error++ if scalar @{ $c->error };
             }
         }
 
         # Execute last end
-        if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
-            $end->[0]->execute($c);
+        if ( my $end = @{ $actions{end} }[-1] ) {
+            $end->execute($c);
         }
     }
 
@@ -137,9 +142,10 @@ sub forward {
     my $command_copy = $command;
 
     unless ( $command_copy =~ s/^\/// ) {
-        $command_copy =
+        my $namespace =
           Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
-          . "/${command}";
+          || '';
+        $command_copy = "${namespace}/${command}";
     }
 
     unless ( $command_copy =~ /\// ) {
@@ -175,9 +181,11 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
         if ( my $code = $c->components->{$class}->can($method) ) {
             my $action = Catalyst::Action->new(
                 {
+                    name      => $method,
                     code      => $code,
                     reverse   => "$class->$method",
                     namespace => $class,
+                    prefix    => $class,
                 }
             );
             $results = [ [$action] ];
@@ -215,38 +223,23 @@ sub prepare_action {
     my @path = split /\//, $c->req->path;
     $c->req->args( \my @args );
 
-    while (@path) {
+    push( @path, '/' ) unless @path;    # Root action
+
+  DESCEND: while (@path) {
         $path = join '/', @path;
-        if ( my $result = ${ $c->get_action($path) }[0] ) {
-
-            # It's a regex
-            if ($#$result) {
-                my $match    = $result->[1];
-                my @snippets = @{ $result->[2] };
-                $c->log->debug(
-                    qq/Requested action is "$path" and matched "$match"/)
-                  if $c->debug;
-                $c->log->debug(
-                    'Snippets are "' . join( ' ', @snippets ) . '"' )
-                  if ( $c->debug && @snippets );
-                $c->req->action($match);
-                $c->req->snippets( \@snippets );
-            }
 
-            else {
-                $c->req->action($path);
-                $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
-            }
+        $path = '' if $path eq '/';     # Root action
+
+        # Check out dispatch types to see if any will handle the path at
+        # this level
 
-            $c->req->match($path);
-            last;
+        foreach my $type ( @{ $self->dispatch_types } ) {
+            last DESCEND if $type->match( $c, $path );
         }
-        unshift @args, pop @path;
-    }
 
-    unless ( $c->req->action ) {
-        $c->req->action('default');
-        $c->req->match('');
+        # If not, move the last part path to args
+
+        unshift @args, pop @path;
     }
 
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
@@ -263,76 +256,69 @@ sub get_action {
     $namespace ||= '';
     $inherit   ||= 0;
 
-    if ($namespace) {
-        $namespace = '' if $namespace eq '/';
-        my $parent = $self->tree;
-        my @results;
-
-        if ($inherit) {
-            my $result =
-              $self->actions->{private}->{ $parent->getUID }->{$action};
-            push @results, [$result] if $result;
-            my $visitor = Tree::Simple::Visitor::FindByPath->new;
-
-          SEARCH:
-            for my $part ( split '/', $namespace ) {
-                $visitor->setSearchPath($part);
-                $parent->accept($visitor);
-                my $child = $visitor->getResult;
-                my $uid   = $child->getUID if $child;
-                my $match = $self->actions->{private}->{$uid}->{$action}
-                  if $uid;
-                push @results, [$match] if $match;
-                if ($child) {
-                    $parent = $child;
-                }
-                else {
-                    last SEARCH;
-                }
+    my @match = $self->get_containers($namespace);
+
+    my @results;
+
+    foreach my $child ( $inherit ? @match : $match[-1] ) {
+        my $node = $child->actions;
+        if ( defined $node->{$action} ) {
+            unless ($inherit) {
+                $namespace = '' if $namespace eq '/';
+                my $reverse = $node->{$action}->reverse;
+                my $name    = $namespace
+                  ? $namespace =~ /\/$/
+                  ? "$namespace$action"
+                  : "$namespace/$action"
+                  : $action;
+                last unless $name eq $reverse;
             }
-
+            push( @results, [ $node->{$action} ] );
         }
+    }
+    return \@results;
+}
 
-        else {
-
-            if ($namespace) {
-                my $visitor = Tree::Simple::Visitor::FindByPath->new;
-                $visitor->setSearchPath( split '/', $namespace );
-                $parent->accept($visitor);
-                my $child = $visitor->getResult;
-                my $uid   = $child->getUID if $child;
-                my $match = $self->actions->{private}->{$uid}->{$action}
-                  if $uid;
-                push @results, [$match] if $match;
-            }
-
-            else {
-                my $result =
-                  $self->actions->{private}->{ $parent->getUID }->{$action};
-                push @results, [$result] if $result;
-            }
+=item $self->get_containers( $namespace )
 
-        }
-        return \@results;
-    }
+=cut
 
-    elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
-    elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
+sub get_containers {
+    my ( $self, $namespace ) = @_;
 
-    else {
+    # If the namespace is / just return the root ActionContainer
 
-        for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
-            my $name  = $self->actions->{compiled}->[$i]->[0];
-            my $regex = $self->actions->{compiled}->[$i]->[1];
+    return ( $self->tree->getNodeValue )
+      if ( !$namespace || ( $namespace eq '/' ) );
 
-            if ( my @snippets = ( $action =~ $regex ) ) {
-                return [
-                    [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
-            }
+    # 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 ) {
+
+        # 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.
+
+        my $extra = $path[ ( scalar @match ) - 1 ];
+        last unless $extra;
+        $visitor->setSearchPath($extra);
+        $match[-1]->accept($visitor);
+        push( @match, $visitor->getResult ) if defined $visitor->getResult;
     }
-    return [];
+
+    return map { $_->getNodeValue } @match;
 }
 
 =item $self->set_action( $c, $action, $code, $namespace, $attrs )
@@ -345,96 +331,87 @@ sub set_action {
     my $prefix =
       Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
       || '';
-    my %flags;
+    my %attributes;
 
     for my $attr ( @{$attrs} ) {
-        if    ( $attr =~ /^(Local|Relative)$/ )    { $flags{local}++ }
-        elsif ( $attr =~ /^(Global|Absolute)$/ )   { $flags{global}++ }
-        elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) {
-            push @{ $flags{path} }, $1;
-        }
-        elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
-        elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
-            push @{ $flags{regex} }, $2;
+
+        # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
+
+        my %initialized;
+        $initialized{ ref $_ }++ for @{ $self->dispatch_types };
+
+        if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) {
+
+            # Initialize types
+            my $class = "Catalyst::DispatchType::$key";
+            unless ( $initialized{$class} ) {
+                eval "require $class";
+                push( @{ $self->dispatch_types }, $class->new ) unless $@;
+                $initialized{$class}++;
+            }
+
+            if ( defined $value ) {
+                ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
+            }
+            push( @{ $attributes{$key} }, $value );
         }
     }
 
-    if ( $flags{private} && ( keys %flags > 1 ) ) {
+    if ( $attributes{Private} && ( keys %attributes > 1 ) ) {
         $c->log->debug( 'Bad action definition "'
               . join( ' ', @{$attrs} )
               . qq/" for "$namespace->$method"/ )
           if $c->debug;
         return;
     }
-    return unless keys %flags;
+    return unless keys %attributes;
 
     my $parent  = $self->tree;
     my $visitor = Tree::Simple::Visitor::FindByPath->new;
 
-    for my $part ( split '/', $prefix ) {
-        $visitor->setSearchPath($part);
-        $parent->accept($visitor);
-        my $child = $visitor->getResult;
-
-        unless ($child) {
-            $child = $parent->addChild( Tree::Simple->new($part) );
+    if ($prefix) {
+        for my $part ( split '/', $prefix ) {
             $visitor->setSearchPath($part);
             $parent->accept($visitor);
-            $child = $visitor->getResult;
-        }
+            my $child = $visitor->getResult;
+
+            unless ($child) {
 
-        $parent = $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;
+            }
+
+            $parent = $child;
+        }
     }
 
     my $reverse = $prefix ? "$prefix/$method" : $method;
 
     my $action = Catalyst::Action->new(
         {
-            code      => $code,
-            reverse   => $reverse,
-            namespace => $namespace,
+            name       => $method,
+            code       => $code,
+            reverse    => $reverse,
+            namespace  => $namespace,
+            prefix     => $prefix,
+            attributes => \%attributes,
         }
     );
 
-    my $uid = $parent->getUID;
-    $self->actions->{private}->{$uid}->{$method} = $action;
-
-    my @path;
-    for my $path ( @{ $flags{path} } ) {
-        $path =~ s/^\w+//;
-        $path =~ s/\w+$//;
-        if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 }
-        if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 }
-        push @path, $path;
-    }
-    $flags{path} = \@path;
-
-    my @regex;
-    for my $regex ( @{ $flags{regex} } ) {
-        $regex =~ s/^\w+//;
-        $regex =~ s/\w+$//;
-        if ( $regex =~ /^\s*'(.*)'\s*$/ ) { $regex = $1 }
-        if ( $regex =~ /^\s*"(.*)"\s*$/ ) { $regex = $1 }
-        push @regex, $regex;
-    }
-    $flags{regex} = \@regex;
-
-    if ( $flags{local} || $flags{global} ) {
-        push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
-          if $flags{local};
-
-        push( @{ $flags{path} }, "/$method" ) if $flags{global};
-    }
-
-    for my $path ( @{ $flags{path} } ) {
-        if ( $path =~ /^\// ) { $path =~ s/^\/// }
-        else { $path = $prefix ? "$prefix/$path" : $path }
-        $self->actions->{plain}->{$path} = $action;
-    }
+    # Set the method value
+    $parent->getNodeValue->actions->{$method} = $action;
 
-    for my $regex ( @{ $flags{regex} } ) {
-        push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
-        $self->actions->{regex}->{$regex} = $action;
+    # Pass the action to our dispatch types so they can register it if reqd.
+    foreach my $type ( @{ $self->dispatch_types } ) {
+        $type->register( $c, $action );
     }
 }
 
@@ -445,18 +422,21 @@ sub set_action {
 sub setup_actions {
     my ( $self, $class ) = @_;
 
-    # These are the core structures
-    $self->actions(
-        {
-            plain    => {},
-            private  => {},
-            regex    => {},
-            compiled => []
-        }
-    );
+    $self->dispatch_types( [] );
+
+    # 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;
+    }
 
     # We use a tree
-    $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
+    my $container =
+      Catalyst::ActionContainer->new( { part => '/', actions => {} } );
+    $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
 
     for my $comp ( keys %{ $class->components } ) {
 
@@ -480,27 +460,28 @@ sub setup_actions {
             }
 
             for my $namespace ( keys %namespaces ) {
-
                 for my $sym ( values %{ $namespace . '::' } ) {
-
                     if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
-
                         $name = *{$sym}{NAME};
                         $class->set_action( $name, $code, $comp, $attrs );
                         last;
                     }
-
                 }
-
             }
-
         }
+    }
 
+    # 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;
     }
 
     return unless $class->debug;
 
-    my $actions  = $self->actions;
     my $privates = Text::ASCIITable->new;
     $privates->setCols( 'Private', 'Class' );
     $privates->setColWidth( 'Private', 36, 1 );
@@ -510,10 +491,10 @@ sub setup_actions {
         my ( $walker, $parent, $prefix ) = @_;
         $prefix .= $parent->getNodeValue || '';
         $prefix .= '/' unless $prefix =~ /\/$/;
-        my $uid = $parent->getUID;
+        my $node = $parent->getNodeValue->actions;
 
-        for my $action ( keys %{ $actions->{private}->{$uid} } ) {
-            my $action_obj = $actions->{private}->{$uid}->{$action};
+        for my $action ( keys %{$node} ) {
+            my $action_obj = $node->{$action};
             $privates->addRow( "$prefix$action", $action_obj->namespace );
         }
 
@@ -521,34 +502,11 @@ sub setup_actions {
     };
 
     $walker->( $walker, $self->tree, '' );
-    $class->log->debug( "Loaded private actions:\n" . $privates->draw )
+    $class->log->debug( "Loaded Private actions:\n" . $privates->draw )
       if ( @{ $privates->{tbl_rows} } );
 
-    my $publics = Text::ASCIITable->new;
-    $publics->setCols( 'Public', 'Private' );
-    $publics->setColWidth( 'Public',  36, 1 );
-    $publics->setColWidth( 'Private', 37, 1 );
-
-    for my $plain ( sort keys %{ $actions->{plain} } ) {
-        my $action = $actions->{plain}->{$plain};
-        $publics->addRow( "/$plain", "/$action" );
-    }
-
-    $class->log->debug( "Loaded public actions:\n" . $publics->draw )
-      if ( @{ $publics->{tbl_rows} } );
-
-    my $regexes = Text::ASCIITable->new;
-    $regexes->setCols( 'Regex', 'Private' );
-    $regexes->setColWidth( 'Regex',   36, 1 );
-    $regexes->setColWidth( 'Private', 37, 1 );
-
-    for my $regex ( sort keys %{ $actions->{regex} } ) {
-        my $action = $actions->{regex}->{$regex};
-        $regexes->addRow( $regex, "/$action" );
-    }
-
-    $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
-      if ( @{ $regexes->{tbl_rows} } );
+    # List all public actions
+    $_->list($class) for @{ $self->dispatch_types };
 }
 
 =back