X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=575b1a6a91238088a8f3cd2e55c7f597bf8efe5d;hb=3ea37672f96be0393a84199bf098d0111b347f33;hp=99c432a5c8164d292d41c5920e76a35a8fc95f65;hpb=8c80e4f8ed93daf2d635c0480bdc97adf24e49c1;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 99c432a..575b1a6 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -14,10 +14,6 @@ use Tree::Simple; use Tree::Simple::Visitor::FindByPath; use Scalar::Util (); -# Stringify to class -use overload '""' => sub { return ref(shift) }, fallback => 1; - - #do these belong as package vars or should we build these via a builder method? # Preload these action types our @PRELOAD = qw/Index Path Regex/; @@ -88,18 +84,6 @@ it with a C<+>, like so: +My::Dispatch::Type -=head2 $self->detach( $c, $command [, \@arguments ] ) - -Documented in L - -=cut - -sub detach { - my ( $self, $c, $command, @args ) = @_; - $c->forward( $command, @args ) if $command; - die $Catalyst::DETACH; -} - =head2 $self->dispatch($c) Delegate the dispatch to the action that matched the url, or return a @@ -124,17 +108,15 @@ sub dispatch { } } -=head2 $self->forward( $c, $command [, \@arguments ] ) - -Documented in L - -=cut +# $self->_command2action( $c, $command [, \@arguments ] ) +# Search for an action, from the command and returns C<($action, $args)> on +# success. Returns C<(0)> on error. -sub forward { +sub _command2action { my ( $self, $c, $command, @extra_params ) = @_; unless ($command) { - $c->log->debug('Nothing to forward to') if $c->debug; + $c->log->debug('Nothing to go to') if $c->debug; return 0; } @@ -143,43 +125,135 @@ sub forward { 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 + # 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; - # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that + # go 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) + # go 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 ); } + return $action, \@args; +} - unless ($action) { - my $error = - qq/Couldn't forward to command "$command": / - . qq/Invalid action or component./; +=head2 $self->visit( $c, $command [, \@arguments ] ) + +Documented in L + +=cut + +sub visit { + my $self = shift; + $self->_do_visit('visit', @_); +} + +sub _do_visit { + my $self = shift; + my $opname = shift; + my ( $c, $command ) = @_; + my ( $action, $args ) = $self->_command2action(@_); + my $error = qq/Couldn't $opname("$command"): /; + + if (!$action) { + $error .= qq/Couldn't $opname to command "$command": / + .qq/Invalid action or component./; + } + elsif (!defined $action->namespace) { + $error .= qq/Action has no namespace: cannot $opname() to a plain / + .qq/method or component, must be a :Action or some sort./ + } + elsif (!$action->class->can('_DISPATCH')) { + $error .= qq/Action cannot _DISPATCH. / + .qq/Did you try to $opname() a non-controller action?/; + } + else { + $error = q(); + } + + if($error) { $c->error($error); $c->log->debug($error) if $c->debug; return 0; } - #push @$args, @_; + $action = $self->expand_action($action); + + local $c->request->{arguments} = $args; + local $c->{namespace} = $action->{'namespace'}; + local $c->{action} = $action; + + $self->dispatch($c); +} + +=head2 $self->go( $c, $command [, \@arguments ] ) + +Documented in L + +=cut + +sub go { + my $self = shift; + $self->_do_visit('go', @_); + die $Catalyst::GO; +} + +=head2 $self->forward( $c, $command [, \@arguments ] ) + +Documented in L + +=cut + +sub forward { + my $self = shift; + $self->_do_forward(forward => @_); +} + +sub _do_forward { + my $self = shift; + my $opname = shift; + my ( $c, $command ) = @_; + my ( $action, $args ) = $self->_command2action(@_); + + if (!$action) { + my $error .= qq/Couldn't $opname to command "$command": / + .qq/Invalid action or component./; + $c->error($error); + $c->log->debug($error) if $c->debug; + return 0; + } no warnings 'recursion'; my $orig_args = $c->request->arguments(); - $c->request->arguments(\@args); + $c->request->arguments($args); $action->dispatch( $c ); $c->request->arguments($orig_args); - + return $c->state; } +=head2 $self->detach( $c, $command [, \@arguments ] ) + +Documented in L + +=cut + +sub detach { + my ( $self, $c, $command, @args ) = @_; + $self->_do_forward(detach => $c, $command, @args ) if $command; + die $Catalyst::DETACH; +} + sub _action_rel2abs { my ( $self, $c, $path ) = @_; @@ -287,7 +361,7 @@ sub prepare_action { 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 ); + if ( $c->debug && defined $req->match && length $req->match ); $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) if ( $c->debug && @args ); @@ -303,7 +377,7 @@ sub get_action { my ( $self, $name, $namespace ) = @_; return unless $name; - $namespace = join( "/", grep { length } split '/', $namespace || "" ); + $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) ); return $self->_action_hash->{"${namespace}/${name}"}; } @@ -383,6 +457,25 @@ sub uri_for_action { return undef; } +=head2 expand_action + +expand an action into a full representation of the dispatch. +mostly useful for chained, other actions will just return a +single action. + +=cut + +sub expand_action { + my ($self, $action) = @_; + + foreach my $dispatch_type (@{ $self->_dispatch_types }) { + my $expanded = $dispatch_type->expand_action($action); + return $expanded if $expanded; + } + + return $action; +} + =head2 $self->register( $c, $action ) Make sure all required dispatch types for this action are loaded, then @@ -535,10 +628,9 @@ __PACKAGE__->meta->make_immutable; Provided by Moose -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C -Matt S Trout, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT