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=7c5134be1463365e13358b65d4bc40e2f5804ae0;hp=5e1f9ae38a5811730269f4b2484490705752c413;hb=f3414019f472b55682ef3af53f761b6db7955887;hpb=76ddf86be66ed259d24226618a1d357e6f606fa1 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 5e1f9ae..7c5134b 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -1,7 +1,8 @@ package Catalyst::Dispatcher; -use strict; -use base 'Class::Accessor::Fast'; +use Moose; +use Class::MOP; + use Catalyst::Exception; use Catalyst::Utils; use Catalyst::Action; @@ -11,23 +12,28 @@ use Catalyst::DispatchType::Index; use Text::SimpleTable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; +use Scalar::Util (); -# Stringify to class -use overload '""' => sub { return ref shift }, fallback => 1; - -__PACKAGE__->mk_accessors( - qw/tree dispatch_types registered_dispatch_types - method_action_class action_container_class - preload_dispatch_types postload_dispatch_types - / -); - +#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/; # Postload these action types our @POSTLOAD = qw/Default/; +has _tree => (is => 'rw'); +has _dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1); +has _registered_dispatch_types => (is => 'rw', default => sub { {} }, required => 1, lazy => 1); +has _method_action_class => (is => 'rw', default => 'Catalyst::Action'); +has _action_container_class => (is => 'rw', default => 'Catalyst::ActionContainer'); + +has preload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@PRELOAD] }); +has postload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@POSTLOAD] }); +has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} }); +has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} }); + +no Moose; + =head1 NAME Catalyst::Dispatcher - The Catalyst Dispatcher @@ -49,16 +55,13 @@ 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 ); - return $obj; +sub BUILD { + my ($self, $params) = @_; + + my $container = + Catalyst::ActionContainer->new( { part => '/', actions => {} } ); + + $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); } =head2 $self->preload_dispatch_types @@ -103,8 +106,8 @@ message about unknown resource sub dispatch { my ( $self, $c ) = @_; - if ( $c->action ) { - $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) ); + if ( my $action = $c->action ) { + $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) ); } else { @@ -124,99 +127,123 @@ Documented in L =cut sub forward { - my $self = shift; - my $c = shift; - my $command = shift; + my ( $self, $c, $command, @extra_params ) = @_; unless ($command) { $c->log->debug('Nothing to forward to') if $c->debug; return 0; } - my $local_args = 0; - my $arguments = $c->req->args; - if ( ref( $_[-1] ) eq 'ARRAY' ) { - $arguments = pop(@_); - $local_args = 1; + my @args; + + 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 + @args = @{ $c->request->arguments }; } - my $result; + my $action; - unless ( ref $command ) { - my $command_copy = $command; + # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that + $action = $self->_invoke_as_path( $c, "$command", \@args ); - unless ( $command_copy =~ s/^\/// ) { - my $namespace = $c->stack->[-1]->namespace; - $command_copy = "${namespace}/${command}"; - } + # forward 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 ); + } - unless ( $command_copy =~ /\// ) { - $result = $c->get_action( $command_copy, '/' ); - } - else { - my @extra_args; - DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { - my $tail = $2; - $result = $c->get_action( $tail, $1 ); - if ($result) { - $local_args = 1; - $command = $tail; - unshift( @{$arguments}, @extra_args ); - last DESCEND; - } - unshift( @extra_args, $tail ); - } - } + + unless ($action) { + my $error = + qq/Couldn't forward to command "$command": / + . qq/Invalid action or component./; + $c->error($error); + $c->log->debug($error) if $c->debug; + return 0; } - unless ($result) { + #push @$args, @_; - my $class = ref($command) - || ref( $c->component($command) ) - || $c->component($command); - my $method = shift || 'process'; + no warnings 'recursion'; - unless ($class) { - my $error = -qq/Couldn't forward to command "$command". Invalid action or component./; - $c->error($error); - $c->log->debug($error) if $c->debug; - return 0; - } + my $orig_args = $c->request->arguments(); + $c->request->arguments(\@args); + $action->dispatch( $c ); + $c->request->arguments($orig_args); + + return $c->state; +} - if ( my $code = $class->can($method) ) { - my $action = $self->method_action_class->new( - { - name => $method, - code => $code, - reverse => "$class->$method", - class => $class, - namespace => Catalyst::Utils::class2prefix( - $class, $c->config->{case_sensitive} - ), - } - ); - $result = $action; - } +sub _action_rel2abs { + my ( $self, $c, $path ) = @_; + + unless ( $path =~ m#^/# ) { + my $namespace = $c->stack->[-1]->namespace; + $path = "$namespace/$path"; + } + + $path =~ s#^/##; + return $path; +} +sub _invoke_as_path { + my ( $self, $c, $rel_path, $args ) = @_; + + my $path = $self->_action_rel2abs( $c, $rel_path ); + + my ( $tail, @extra_args ); + while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) ) + { # allow $path to be empty + if ( my $action = $c->get_action( $tail, $path ) ) { + push @$args, @extra_args; + return $action; + } else { - my $error = - qq/Couldn't forward to "$class". Does not implement "$method"/; - $c->error($error); - $c->log->debug($error) - if $c->debug; - return 0; + return + unless $path + ; # if a match on the global namespace failed then the whole lookup failed } + unshift @extra_args, $tail; } +} - if ($local_args) { - local $c->request->{arguments} = [ @{$arguments} ]; - $result->execute($c); - } - else { $result->execute($c) } +sub _find_component_class { + my ( $self, $c, $component ) = @_; - return $c->state; + return ref($component) + || ref( $c->component($component) ) + || $c->component($component); +} + +sub _invoke_as_component { + my ( $self, $c, $component, $method ) = @_; + + my $class = $self->_find_component_class( $c, $component ) || return 0; + + if ( my $code = $class->can($method) ) { + return $self->_method_action_class->new( + { + name => $method, + code => $code, + reverse => "$class->$method", + class => $class, + namespace => Catalyst::Utils::class2prefix( + $class, $c->config->{case_sensitive} + ), + } + ); + } + else { + my $error = + qq/Couldn't forward to "$class". Does not implement "$method"/; + $c->error($error); + $c->log->debug($error) + if $c->debug; + return 0; + } } =head2 $self->prepare_action($c) @@ -227,9 +254,10 @@ Find an dispatch type that matches $c->req->path, and set args from it. sub prepare_action { my ( $self, $c ) = @_; - my $path = $c->req->path; - my @path = split /\//, $c->req->path; - $c->req->args( \my @args ); + my $req = $c->req; + my $path = $req->path; + my @path = split /\//, $req->path; + $req->args( \my @args ); unshift( @path, '' ); # Root action @@ -242,7 +270,7 @@ sub prepare_action { # Check out dispatch types to see if any will handle the path at # this level - foreach my $type ( @{ $self->dispatch_types } ) { + foreach my $type ( @{ $self->_dispatch_types } ) { last DESCEND if $type->match( $c, $path ); } @@ -252,8 +280,10 @@ sub prepare_action { unshift @args, $arg; } - $c->log->debug( 'Path is "' . $c->req->match . '"' ) - if ( $c->debug && $c->req->match ); + 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 ); $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) if ( $c->debug && @args ); @@ -268,16 +298,23 @@ returns a named action from a given namespace. sub get_action { my ( $self, $name, $namespace ) = @_; return unless $name; - $namespace ||= ''; - $namespace = '' if $namespace eq '/'; - my @match = $self->get_containers($namespace); + $namespace = join( "/", grep { length } split '/', $namespace || "" ); + + return $self->_action_hash->{"${namespace}/${name}"}; +} - return unless @match; +=head2 $self->get_action_by_path( $path ); - if ( my $action = $match[-1]->get_action($name) ) { - return $action if $action->namespace eq $namespace; - } +Returns the named action by its full path. + +=cut + +sub get_action_by_path { + my ( $self, $path ) = @_; + $path =~ s/^\///; + $path = "/$path" unless $path =~ /\//; + $self->_action_hash->{$path}; } =head2 $self->get_actions( $c, $action, $namespace ) @@ -287,8 +324,8 @@ sub get_action { sub get_actions { my ( $self, $c, $action, $namespace ) = @_; return [] unless $action; - $namespace ||= ''; - $namespace = '' if $namespace eq '/'; + + $namespace = join( "/", grep { length } split '/', $namespace || "" ); my @match = $self->get_containers($namespace); @@ -303,40 +340,43 @@ Return all the action containers for a given namespace, inclusive sub get_containers { my ( $self, $namespace ) = @_; + $namespace ||= ''; + $namespace = '' if $namespace eq '/'; - # If the namespace is / just return the root ActionContainer + my @containers; - return ( $self->tree->getNodeValue ) - if ( !$namespace || ( $namespace eq '/' ) ); + if ( length $namespace ) { + do { + push @containers, $self->_container_hash->{$namespace}; + } while ( $namespace =~ s#/[^/]+$## ); + } - # Use a visitor to recurse down the tree finding the ActionContainers - # for each namespace in the chain. + return reverse grep { defined } @containers, $self->_container_hash->{''}; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - my @path = split( '/', $namespace ); - $visitor->setSearchPath(@path); - $self->tree->accept($visitor); + #return (split '/', $namespace); # isnt this more clear? + my @parts = split '/', $namespace; +} - my @match = $visitor->getResults; - @match = ( $self->tree ) unless @match; +=head2 $self->uri_for_action($action, \@captures) - if ( !defined $visitor->getResult ) { +Takes a Catalyst::Action object and action parameters and returns a URI +part such that if $c->req->path were this URI part, this action would be +dispatched to with $c->req->captures set to the supplied arrayref. - # 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. +If the action object is not available for external dispatch or the dispatcher +cannot determine an appropriate URI, this method will return undef. - if ( my $extra = $path[ ( scalar @match ) - 1 ] ) { - $visitor->setSearchPath($extra); - $match[-1]->accept($visitor); - push( @match, $visitor->getResult ) if defined $visitor->getResult; - } - } +=cut - return map { $_->getNodeValue } @match; +sub uri_for_action { + my ( $self, $action, $captures) = @_; + $captures ||= []; + foreach my $dispatch_type ( @{ $self->_dispatch_types } ) { + my $uri = $dispatch_type->uri_for_action( $action, $captures ); + return( $uri eq '' ? '/' : $uri ) + if defined($uri); + } + return undef; } =head2 $self->register( $c, $action ) @@ -350,57 +390,63 @@ Also, set up the tree with the action containers. sub register { my ( $self, $c, $action ) = @_; - my $registered = $self->registered_dispatch_types; + my $registered = $self->_registered_dispatch_types; - my $priv = 0; + #my $priv = 0; #seems to be unused foreach my $key ( keys %{ $action->attributes } ) { - $priv++ if $key eq 'Private'; + next if $key eq 'Private'; my $class = "Catalyst::DispatchType::$key"; unless ( $registered->{$class} ) { - eval "require $class"; - push( @{ $self->dispatch_types }, $class->new ) unless $@; + #some error checking rethrowing here wouldn't hurt. + eval { Class::MOP::load_class($class) }; + push( @{ $self->_dispatch_types }, $class->new ) unless $@; $registered->{$class} = 1; } } # Pass the action to our dispatch types so they can register it if reqd. - my $reg = 0; - foreach my $type ( @{ $self->dispatch_types } ) { - $reg++ if $type->register( $c, $action ); + foreach my $type ( @{ $self->_dispatch_types } ) { + $type->register( $c, $action ); } - 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, $context ) @@ -411,44 +457,22 @@ sub register { sub setup_actions { my ( $self, $c ) = @_; - $self->dispatch_types( [] ); - $self->registered_dispatch_types( {} ); - $self->method_action_class('Catalyst::Action'); - $self->action_container_class('Catalyst::ActionContainer'); - # Preload action types - for my $type ( @{$self->preload_dispatch_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; - $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->_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 ( @{$self->postload_dispatch_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; - } + $self->_load_dispatch_types( @{ $self->postload_dispatch_types } ); return unless $c->debug; my $privates = Text::SimpleTable->new( [ 20, 'Private' ], - [ 38, 'Class' ], + [ 36, 'Class' ], [ 12, 'Method' ] ); @@ -471,14 +495,42 @@ sub setup_actions { $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; - $walker->( $walker, $self->tree, '' ); - $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) - if ($has_private); + $walker->( $walker, $self->_tree, '' ); + $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" ) + if $has_private; # List all public actions - $_->list($c) for @{ $self->dispatch_types }; + $_->list($c) for @{ $self->_dispatch_types }; } +sub _load_dispatch_types { + my ( $self, @types ) = @_; + + my @loaded; + + # Preload action types + for my $type (@types) { + my $class = + ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}"; + + eval { Class::MOP::load_class($class) }; + Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) + if $@; + push @{ $self->_dispatch_types }, $class->new; + + push @loaded, $class; + } + + return @loaded; +} + +no Moose; +__PACKAGE__->meta->make_immutable; + +=head2 meta + +Provided by Moose + =head1 AUTHOR Sebastian Riedel, C