Allow forward with arguments.
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index 01f4bed..af4f7ce 100644 (file)
@@ -2,26 +2,17 @@ package Catalyst::Dispatcher;
 
 use strict;
 use base 'Class::Data::Inheritable';
-use Memoize;
+use Catalyst::Exception;
+use Catalyst::Utils;
 use Text::ASCIITable;
 use Tree::Simple;
 use Tree::Simple::Visitor::FindByPath;
 
 __PACKAGE__->mk_classdata($_) for qw/actions tree/;
 
-# These are the core structures
-__PACKAGE__->actions(
-    { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-
-# We use a tree
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
-
-memoize('_class2prefix');
-
 =head1 NAME
 
-Catalyst::Dispatch - The Catalyst Dispatcher
+Catalyst::Dispatcher - The Catalyst Dispatcher
 
 =head1 SYNOPSIS
 
@@ -33,6 +24,18 @@ See L<Catalyst>.
 
 =over 4
 
+=item $c->detach($command)
+
+Like C<forward> but doesn't return.
+
+=cut
+
+sub detach {
+    my ( $c, $command ) = @_;
+    $c->forward($command) if $command;
+    die $Catalyst::Engine::DETACH;
+}
+
 =item $c->dispatch
 
 Dispatch request to actions.
@@ -48,42 +51,44 @@ sub dispatch {
 
     unless ($namespace) {
         if ( my $result = $c->get_action($action) ) {
-            $namespace = _class2prefix( $result->[0]->[0]->[0] );
+            $namespace = Catalyst::Utils::class2prefix( $result->[0]->[0]->[0],
+                $c->config->{case_sensitive} );
         }
     }
 
     my $default = $action eq 'default' ? $namespace : undef;
-    my $results = $c->get_action( $action, $default );
+    my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
     $namespace ||= '/';
 
     if ( @{$results} ) {
 
         # Execute last begin
         $c->state(1);
-        if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
+        if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
             $c->execute( @{ $begin->[0] } );
             return if scalar @{ $c->error };
         }
 
         # Execute the auto chain
-        my $auto = 0;
-        for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
+        my $autorun = 0;
+        for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
+            $autorun++;
             $c->execute( @{ $auto->[0] } );
             return if scalar @{ $c->error };
             last unless $c->state;
-            $auto++;
         }
 
         # Execute the action or last default
-        my $mkay = $auto ? $c->state ? 1 : 0 : 1;
+        my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
         if ( ( my $action = $c->req->action ) && $mkay ) {
-            if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) {
+            if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
+            {
                 $c->execute( @{ $result->[0] } );
             }
         }
 
         # Execute last end
-        if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
+        if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
             $c->execute( @{ $end->[0] } );
             return if scalar @{ $c->error };
         }
@@ -99,10 +104,13 @@ sub dispatch {
     }
 }
 
-=item $c->forward($command)
+=item $c->forward($command [args]))
 
 Forward processing to a private action or a method from a class.
 If you define a class without method it will default to process().
+also takes an optional arrayref containing arguments to be passed
+to the new function. $c->req->args will be reset upon returning 
+from the function.
 
     $c->forward('/foo');
     $c->forward('index');
@@ -122,24 +130,47 @@ sub forward {
 
     my $caller    = caller(0);
     my $namespace = '/';
+    my $args;
+
+    if ( ref( $_[0] ) eq 'ARRAY' ) {
+        $args=$c->req->args();
+        $c->req->args( shift );
+    } elsif ( ref( $_[1] ) eq 'ARRAY' ) {
+        $args=$c->req->args();
+        $c->req->args( $_[1] );
+    }
 
     if ( $command =~ /^\// ) {
         $command =~ /^\/(.*)\/(\w+)$/;
         $namespace = $1 || '/';
         $command   = $2 || $command;
         $command =~ s/^\///;
-        warn "NAMESPACE: $namespace COMMAND: $command";
     }
 
-    else { $namespace = _class2prefix($caller) || '/' }
+    else {
+        $namespace =
+          Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
+          || '/';
+    }
 
     my $results = $c->get_action( $command, $namespace );
 
     unless ( @{$results} ) {
         my $class = $command || '';
+        my $path = $class . '.pm';
+        $path =~ s/::/\//g;
+
+        unless ( $INC{$path} ) {
+            my $error =
+              qq/Couldn't forward to "$class". Invalid or not loaded./;
+            $c->error($error);
+            $c->log->debug($error) if $c->debug;
+            return 0;
+        }
 
-        if ( $class =~ /[^\w\:]/ ) {
-            my $error = qq/Couldn't forward to "$class"/;
+        unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) {
+            my $error =
+              qq/Can't forward to "$class". Class is not a Catalyst component./;
             $c->error($error);
             $c->log->debug($error) if $c->debug;
             return 0;
@@ -153,7 +184,8 @@ sub forward {
         }
 
         else {
-            my $error = qq/Couldn't forward to "$class"/;
+            my $error =
+              qq/Couldn't forward to "$class". Does not implement "$method"/;
             $c->error($error);
             $c->log->debug($error)
               if $c->debug;
@@ -164,31 +196,33 @@ sub forward {
 
     for my $result ( @{$results} ) {
         $c->execute( @{ $result->[0] } );
-        return if scalar @{ $c->error };
+        last if scalar @{ $c->error };
         last unless $c->state;
     }
+    $c->req->args( $args ) if $args;
 
+    return if scalar @{ $c->error };
     return $c->state;
 }
 
-=item $c->get_action( $action, $namespace )
+=item $c->get_action( $action, $namespace, $inherit )
 
 Get an action in a given namespace.
 
 =cut
 
 sub get_action {
-    my ( $c, $action, $namespace ) = @_;
+    my ( $c, $action, $namespace, $inherit ) = @_;
     return [] unless $action;
     $namespace ||= '';
+    $inherit   ||= 0;
 
     if ($namespace) {
         $namespace = '' if $namespace eq '/';
         my $parent = $c->tree;
         my @results;
-        my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
 
-        if ( $allowed{$action} ) {
+        if ($inherit) {
             my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
             push @results, [$result] if $result;
             my $visitor = Tree::Simple::Visitor::FindByPath->new;
@@ -237,13 +271,7 @@ sub get_action {
             my $name  = $c->actions->{compiled}->[$i]->[0];
             my $regex = $c->actions->{compiled}->[$i]->[1];
 
-            if ( $action =~ $regex ) {
-                my @snippets;
-                for my $i ( 1 .. 9 ) {
-                    no strict 'refs';
-                    last unless ${$i};
-                    push @snippets, ${$i};
-                }
+            if ( my @snippets = ( $action =~ $regex ) ) {
                 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
             }
 
@@ -261,15 +289,19 @@ Set an action in a given namespace.
 sub set_action {
     my ( $c, $method, $code, $namespace, $attrs ) = @_;
 
-    my $prefix = _class2prefix($namespace) || '';
+    my $prefix =
+      Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
+      || '';
     my %flags;
 
     for my $attr ( @{$attrs} ) {
-        if    ( $attr =~ /^(Local|Relative)$/ )        { $flags{local}++ }
-        elsif ( $attr =~ /^(Global|Absolute)$/ )       { $flags{global}++ }
-        elsif ( $attr =~ /^Path\((.+)\)$/i )           { $flags{path} = $1 }
-        elsif ( $attr =~ /^Private$/i )                { $flags{private}++ }
-        elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
+        if    ( $attr =~ /^(Local|Relative)$/ )    { $flags{local}++ }
+        elsif ( $attr =~ /^(Global|Absolute)$/ )   { $flags{global}++ }
+        elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 }
+        elsif ( $attr =~ /^Private$/i )            { $flags{private}++ }
+        elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
+            $flags{regex} = $2;
+        }
     }
 
     if ( $flags{private} && ( keys %flags > 1 ) ) {
@@ -348,12 +380,28 @@ Setup actions for a component.
 =cut
 
 sub setup_actions {
-    my ( $self, $comps ) = @_;
+    my $self = shift;
+
+    # These are the core structures
+    $self->actions(
+        {
+            plain    => {},
+            private  => {},
+            regex    => {},
+            compiled => [],
+            reverse  => {}
+        }
+    );
+
+    # We use a tree
+    $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
 
-    for my $comp (@$comps) {
-        $comp = ref $comp || $comp;
+    for my $comp ( keys %{ $self->components } ) {
 
-        for my $action ( @{ $comp->_cache } ) {
+        # We only setup components that inherit from Catalyst::Base
+        next unless $comp->isa('Catalyst::Base');
+
+        for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
             my ( $code, $attrs ) = @{$action};
             my $name = '';
             no strict 'refs';
@@ -388,6 +436,8 @@ sub setup_actions {
 
     }
 
+    return unless $self->debug;
+
     my $actions  = $self->actions;
     my $privates = Text::ASCIITable->new;
     $privates->setCols( 'Private', 'Class' );
@@ -409,8 +459,8 @@ sub setup_actions {
     };
 
     $walker->( $walker, $self->tree, '' );
-    $self->log->debug( 'Loaded private actions', $privates->draw )
-      if ( @{ $privates->{tbl_rows} } && $self->debug );
+    $self->log->debug( "Loaded private actions:\n" . $privates->draw )
+      if ( @{ $privates->{tbl_rows} } );
 
     my $publics = Text::ASCIITable->new;
     $publics->setCols( 'Public', 'Private' );
@@ -424,8 +474,8 @@ sub setup_actions {
         $publics->addRow( "/$plain", $reverse );
     }
 
-    $self->log->debug( 'Loaded public actions', $publics->draw )
-      if ( @{ $publics->{tbl_rows} } && $self->debug );
+    $self->log->debug( "Loaded public actions:\n" . $publics->draw )
+      if ( @{ $publics->{tbl_rows} } );
 
     my $regexes = Text::ASCIITable->new;
     $regexes->setCols( 'Regex', 'Private' );
@@ -439,25 +489,8 @@ sub setup_actions {
         $regexes->addRow( $regex, $reverse );
     }
 
-    $self->log->debug( 'Loaded regex actions', $regexes->draw )
-      if ( @{ $regexes->{tbl_rows} } && $self->debug );
-}
-
-sub _prefix {
-    my ( $class, $name ) = @_;
-    my $prefix = _class2prefix($class);
-    $name = "$prefix/$name" if $prefix;
-    return $name;
-}
-
-sub _class2prefix {
-    my $class = shift || '';
-    my $prefix;
-    if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
-        $prefix = lc $2;
-        $prefix =~ s/\:\:/\//g;
-    }
-    return $prefix;
+    $self->log->debug( "Loaded regex actions:\n" . $regexes->draw )
+      if ( @{ $regexes->{tbl_rows} } );
 }
 
 =back