- Shifted Path dispatch into a DispatchType and nuked old set_action stuff
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index 23e15a0..e129748 100644 (file)
@@ -6,6 +6,9 @@ use Catalyst::Exception;
 use Catalyst::Utils;
 use Catalyst::Action;
 use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Path;
+use Catalyst::DispatchType::Regex;
+use Catalyst::DispatchType::Default;
 use Text::ASCIITable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
@@ -13,7 +16,7 @@ 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/actions tree dispatch_types/);
 
 =head1 NAME
 
@@ -45,61 +48,58 @@ 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 ) {
 
-    if ( @{$results} ) {
+        my @containers = $self->get_containers( $c->namespace );
+        my %actions;
+        foreach my $name (qw/begin auto end/) {
+
+            # 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);
         }
     }
 
@@ -176,9 +176,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] ];
@@ -216,38 +218,14 @@ sub prepare_action {
     my @path = split /\//, $c->req->path;
     $c->req->args( \my @args );
 
-    while (@path) {
+  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;
-            }
 
-            $c->req->match($path);
-            last;
+        foreach my $type (@{$self->dispatch_types}) {
+            last DESCEND if $type->prepare_action($c, $path);
         }
-        unshift @args, pop @path;
-    }
 
-    unless ( $c->req->action ) {
-        $c->req->action('default');
-        $c->req->match('');
+        unshift @args, pop @path;
     }
 
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
@@ -266,62 +244,59 @@ sub get_action {
 
     if ($namespace) {
 
-        my $parent = $self->tree;
-        my @match;
-
-        if ($namespace ne '/') {
-
-            my $visitor = Tree::Simple::Visitor::FindByPath->new;
-            my @path = split('/', $namespace);
-            $visitor->setSearchPath( @path );
-            $parent->accept($visitor);
-
-            if ($inherit) {
-
-                @match = $visitor->getResults;
-                @match = ($parent) unless @match;
-
-                if (!defined $visitor->getResult) {
-                    my $extra = $path[(scalar @match) - 1];
-                    last unless $extra;
-                    $visitor->setSearchPath($extra);
-                    $match[-1]->accept($visitor);
-                    push(@match, $visitor->getResult) if defined $visitor->getResult;
-                }
-            } else {
-                @match = ($visitor->getResult) if $visitor->getResult;
-            }
-
-        }
-
-        @match = ($parent) unless @match;
+        my @match = $self->get_containers( $namespace );
 
         my @results;
 
-        foreach my $child (@match) {
-            my $node = $child->getNodeValue->actions;
+        foreach my $child ($inherit ? @match: $match[-1]) {
+            my $node = $child->actions;
             push(@results, [ $node->{$action} ]) if defined $node->{$action};
         }
         return \@results;
     }
 
-    elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
-    elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
+    return [];
+}
 
-    else {
+=item $self->get_containers( $namespace )
+
+=cut
 
-        for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
-            my $name  = $self->actions->{compiled}->[$i]->[0];
-            my $regex = $self->actions->{compiled}->[$i]->[1];
+sub get_containers {
+    my ( $self, $namespace ) = @_;
 
-            if ( my @snippets = ( $action =~ $regex ) ) {
-                return [
-                    [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
-            }
+    # If the namespace is / just return the root ActionContainer
 
-        }
+    return ($self->tree->getNodeValue) if $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) {
+
+        # 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 )
@@ -334,28 +309,25 @@ 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;
+        if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) {
+            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;
@@ -367,6 +339,10 @@ sub set_action {
             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) );
@@ -383,50 +359,20 @@ sub set_action {
 
     my $action = Catalyst::Action->new(
         {
-            code      => $code,
-            reverse   => $reverse,
-            namespace => $namespace,
+            name       => $method,
+            code       => $code,
+            reverse    => $reverse,
+            namespace  => $namespace,
+            prefix     => $prefix,
+            attributes => \%attributes,
         }
     );
 
+    # Set the method value
     $parent->getNodeValue->actions->{$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;
-    }
-
-    for my $regex ( @{ $flags{regex} } ) {
-        push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
-        $self->actions->{regex}->{$regex} = $action;
+    foreach my $type ( @{ $self->dispatch_types } ) {
+        $type->register_action($c, $action);
     }
 }
 
@@ -447,6 +393,10 @@ sub setup_actions {
         }
     );
 
+    $self->dispatch_types([
+        map { "Catalyst::DispatchType::$_"->new }
+            qw/Path Regex Default/ ]);
+
     # We use a tree
     my $container = Catalyst::ActionContainer->new(
                         { part => '/', actions => {} } );