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=d038d9efd3d1b9a4938c999a4602804052f3a329;hp=966a4e2046ef4ed564f78a48d26f380158580336;hb=28928de92c8bfea34d7e995bc92f1bf5632242d6;hpb=d6e0d7e606b6789fab9a1879a75497d8bbcf7941 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 966a4e2..d038d9e 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -8,20 +8,26 @@ use Catalyst::Action; use Catalyst::ActionContainer; use Catalyst::DispatchType::Default; use Catalyst::DispatchType::Index; -use Text::ASCIITable; +use Text::SimpleTable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; # Stringify to class use overload '""' => sub { return ref shift }, fallback => 1; -__PACKAGE__->mk_accessors(qw/tree dispatch_types registered_dispatch_types/); +__PACKAGE__->mk_accessors( + qw/tree dispatch_types registered_dispatch_types + method_action_class action_container_class + preload_dispatch_types postload_dispatch_types + action_hash container_hash + / +); # Preload these action types -our @PRELOAD = qw/Path Regex/; +our @PRELOAD = qw/Index Path Regex/; # Postload these action types -our @POSTLOAD = qw/Index Default/; +our @POSTLOAD = qw/Default/; =head1 NAME @@ -33,11 +39,60 @@ See L. =head1 DESCRIPTION +This is the class that maps public urls to actions in your Catalyst +application based on the attributes you set. + =head1 METHODS -=over 4 +=head2 new + +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 ); + $obj->action_hash( {} ); + $obj->container_hash( {} ); + + # Create the root node of the tree + my $container = + Catalyst::ActionContainer->new( { part => '/', actions => {} } ); + $obj->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); + + return $obj; +} + +=head2 $self->preload_dispatch_types + +An arrayref of pre-loaded dispatchtype classes + +Entries are considered to be available as C +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type -=item $self->detach( $c, $command [, \@arguments ] ) +=head2 $self->postload_dispatch_types + +An arrayref of post-loaded dispatchtype classes + +Entries are considered to be available as C +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type + +=head2 $self->detach( $c, $command [, \@arguments ] ) + +Documented in L =cut @@ -47,15 +102,18 @@ sub detach { die $Catalyst::DETACH; } -=item $self->dispatch($c) +=head2 $self->dispatch($c) + +Delegate the dispatch to the action that matched the url, or return a +message about unknown resource + =cut sub dispatch { my ( $self, $c ) = @_; - if ( $c->action ) { - $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) ); + $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) ); } else { @@ -68,96 +126,120 @@ sub dispatch { } } -=item $self->forward( $c, $command [, \@arguments ] ) +=head2 $self->forward( $c, $command [, \@arguments ] ) + +Documented in L =cut sub forward { - my $self = shift; - my $c = shift; - my $command = shift; + my ( $self, $c, $command ) = splice( @_, 0, 3 ); unless ($command) { $c->log->debug('Nothing to forward to') if $c->debug; return 0; } - my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; + my $args = [ @{ $c->request->arguments } ]; - my $result; + @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' ); - my $command_copy = $command; + my $action = $self->_invoke_as_path( $c, $command, $args ) + || $self->_invoke_as_component( $c, $command, shift ); - unless ( $command_copy =~ s/^\/// ) { - my $namespace = $c->namespace; - $command_copy = "${namespace}/${command}"; + 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 ( $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 ) { - $command = $tail; - push( @{$arguments}, @extra_args ); - last DESCEND; - } - unshift( @extra_args, $tail ); - } + #push @$args, @_; + + local $c->request->{arguments} = $args; + $action->execute($c); + + return $c->state; +} + +sub _action_rel2abs { + my ( $self, $c, $path ) = @_; + + unless ( $path =~ m#^/# ) { + my $namespace = $c->stack->[-1]->namespace; + $path = "$namespace/$path"; } - unless ( $result ) { + $path =~ s#^/##; + return $path; +} - my $comp; +sub _invoke_as_path { + my ( $self, $c, $rel_path, $args ) = @_; - unless ( $comp = $c->component($command) ) { - 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; - } + return if ref $rel_path; # it must be a string - my $class = ref $comp; - my $method = shift || 'process'; - - if ( my $code = $class->can($method) ) { - my $action = Catalyst::Action->new( - { - name => $method, - code => $code, - reverse => "$class->$method", - class => $class, - namespace => $class, - } - ); - $result = $action; - } + 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; } +} - local $c->request->{arguments} = [ @{$arguments} ]; - local $c->{namespace} = $result->namespace; +sub _find_component_class { + my ( $self, $c, $component ) = @_; - $result->execute($c); + return ref($component) + || ref( $c->component($component) ) + || $c->component($component); +} - return $c->state; +sub _invoke_as_component { + my ( $self, $c, $component, $method ) = @_; + + my $class = $self->_find_component_class( $c, $component ) || return 0; + $method ||= "process"; + + 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; + } } -=item $self->prepare_action($c) +=head2 $self->prepare_action($c) + +Find an dispatch type that matches $c->req->path, and set args from it. =cut @@ -167,12 +249,13 @@ sub prepare_action { my @path = split /\//, $c->req->path; $c->req->args( \my @args ); - push( @path, '/' ) unless @path; # Root action + unshift( @path, '' ); # Root action DESCEND: while (@path) { $path = join '/', @path; + $path =~ s#^/##; - $path = '' if $path eq '/'; # Root action + $path = '' if $path eq '/'; # Root action # Check out dispatch types to see if any will handle the path at # this level @@ -182,143 +265,156 @@ sub prepare_action { } # If not, move the last part path to args - - unshift @args, pop @path; + my $arg = pop(@path); + $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; + unshift @args, $arg; } + $c->log->debug( 'Path is "' . $c->req->match . '"' ) + if ( $c->debug && $c->req->match ); + $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) if ( $c->debug && @args ); } -=item $self->get_action( $c, $action, $namespace ) +=head2 $self->get_action( $action, $namespace ) + +returns a named action from a given namespace. =cut sub get_action { - my ( $self, $c, $name, $namespace ) = @_; + 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( $c, $name ) ) - { - return $action if $action->namespace eq $namespace; - } +returns the named action by it's full path. + +=cut + +sub get_action_by_path { + my ( $self, $path ) = @_; + $path = "/$path" unless $path =~ /\//; + $self->action_hash->{$path}; } -=item $self->get_actions( $c, $action, $namespace ) +=head2 $self->get_actions( $c, $action, $namespace ) =cut 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); - return map { $_->get_action($c, $action) } @match; + return map { $_->get_action($action) } @match; } -=item $self->get_containers( $namespace ) +=head2 $self->get_containers( $namespace ) + +Return all the action containers for a given namespace, inclusive =cut sub get_containers { my ( $self, $namespace ) = @_; + $namespace ||= ''; + $namespace = '' if $namespace eq '/'; - # If the namespace is / just return the root ActionContainer - - return ( $self->tree->getNodeValue ) - if ( !$namespace || ( $namespace eq '/' ) ); - - # Use a visitor to recurse down the tree finding the ActionContainers - # for each namespace in the chain. + my @containers; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - my @path = split( '/', $namespace ); - $visitor->setSearchPath(@path); - $self->tree->accept($visitor); + do { + push @containers, $self->container_hash->{$namespace}; + } while ( $namespace =~ s#/[^/]+$## ); - my @match = $visitor->getResults; - @match = ( $self->tree ) unless @match; + return reverse grep { defined } @containers, $self->container_hash->{''}; - if ( !defined $visitor->getResult ) { + my @parts = split '/', $namespace; +} - # 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. +=head2 $self->register( $c, $action ) - my $extra = $path[ ( scalar @match ) - 1 ]; - last unless $extra; - $visitor->setSearchPath($extra); - $match[-1]->accept($visitor); - push( @match, $visitor->getResult ) if defined $visitor->getResult; - } +Make sure all required dispatch types for this action are loaded, then +pass the action to our dispatch types so they can register it if required. +Also, set up the tree with the action containers. - return map { $_->getNodeValue } @match; -} +=cut sub register { my ( $self, $c, $action ) = @_; - 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 $registered = $self->registered_dispatch_types; - $parent = $child; + my $priv = 0; + foreach my $key ( keys %{ $action->attributes } ) { + $priv++ if $key eq 'Private'; + my $class = "Catalyst::DispatchType::$key"; + unless ( $registered->{$class} ) { + eval "require $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 ); + } + + return unless $reg + $priv; + + my $namespace = $action->namespace; + my $name = $action->name; + + my $container = $self->find_or_create_action_container($namespace); + # Set the method value - $parent->getNodeValue->actions->{$action->name} = $action; + $container->add_action($action); - my $registered = $self->registered_dispatch_types; + $self->action_hash->{"$namespace/$name"} = $action; + $self->container_hash->{$namespace} = $container; +} - foreach my $key (keys %{$action->attributes}) { - my $class = "Catalyst::DispatchType::$key"; - unless ( $registered->{$class} ) { - eval "require $class"; - push( @{ $self->dispatch_types }, $class->new ) unless $@; - $registered->{$class} = 1; - } - } +sub find_or_create_action_container { + my ( $self, $namespace ) = @_; - # Pass the action to our dispatch types so they can register it if reqd. - foreach my $type ( @{ $self->dispatch_types } ) { - $type->register( $c, $action ); + 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 ); } -=item $self->setup_actions( $class, $component ) +=head2 $self->setup_actions( $class, $context ) + =cut @@ -327,44 +423,28 @@ sub setup_actions { $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 (@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; - $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 ) ); - - $c->register_actions( $c ); + my @classes = + $self->do_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'); + foreach my $comp ( values %{ $c->components } ) { + $comp->register_actions($c) if $comp->can('register_actions'); } - # 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; - } + $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } ); return unless $c->debug; - my $privates = Text::ASCIITable->new; - $privates->setCols( 'Private', 'Class' ); - $privates->setColWidth( 'Private', 36, 1 ); - $privates->setColWidth( 'Class', 37, 1 ); + my $privates = Text::SimpleTable->new( + [ 20, 'Private' ], + [ 38, 'Class' ], + [ 12, 'Method' ] + ); + my $has_private = 0; my $walker = sub { my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; @@ -376,7 +456,8 @@ sub setup_actions { next if ( ( $action =~ /^_.*/ ) && ( !$c->config->{show_internal_actions} ) ); - $privates->addRow( "$prefix$action", $action_obj->class ); + $privates->row( "$prefix$action", $action_obj->class, $action ); + $has_private = 1; } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; @@ -384,13 +465,31 @@ sub setup_actions { $walker->( $walker, $self->tree, '' ); $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) - if ( @{ $privates->{tbl_rows} } ); + if ($has_private); # List all public actions $_->list($c) for @{ $self->dispatch_types }; } -=back +sub do_load_dispatch_types { + my ( $self, @types ) = @_; + + my @loaded; + + # Preload action types + for my $type (@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; + + push @loaded, $class; + } + + return @loaded; +} =head1 AUTHOR