X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=2933de909c30bf0a92a0bb0b37b7c2397a6f9be1;hb=c71165175d6b8e7e722d0ef1c58ddddf14c6a4c1;hp=070f0844701ae6ded66dbdd01f25a0fd06696a74;hpb=d3f21b2f502a23b1e8025d1415362907733bb806;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 070f084..2933de9 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -17,14 +17,17 @@ use overload '""' => sub { return ref shift }, fallback => 1; __PACKAGE__->mk_accessors( qw/tree dispatch_types registered_dispatch_types - method_action_class action_container_class/ + method_action_class action_container_class + preload_dispatch_types postload_dispatch_types + action_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 @@ -36,11 +39,53 @@ 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({}); + return $obj; +} + +=head2 $self->preload_dispatch_types -=item $self->detach( $c, $command [, \@arguments ] ) +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 + +=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 @@ -50,13 +95,16 @@ 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->action->namespace, '_DISPATCH' ) ); } @@ -71,7 +119,9 @@ sub dispatch { } } -=item $self->forward( $c, $command [, \@arguments ] ) +=head2 $self->forward( $c, $command [, \@arguments ] ) + +Documented in L =cut @@ -123,8 +173,10 @@ sub forward { unless ($result) { - my $class = ref($command) || ref( $c->component($command) ); - my $method = shift || 'process'; + my $class = ref($command) + || ref( $c->component($command) ) + || $c->component($command); + my $method = shift || 'process'; unless ($class) { my $error = @@ -169,7 +221,9 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return $c->state; } -=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 @@ -179,12 +233,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 @@ -194,15 +249,21 @@ 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( $action, $namespace ) +=head2 $self->get_action( $action, $namespace ) + +returns a named action from a given namespace. =cut @@ -212,16 +273,10 @@ sub get_action { $namespace ||= ''; $namespace = '' if $namespace eq '/'; - my @match = $self->get_containers($namespace); - - return unless @match; - - if ( my $action = $match[-1]->get_action($name) ) { - return $action if $action->namespace eq $namespace; - } + return $self->action_hash->{ "$namespace/$name" }; } -=item $self->get_actions( $c, $action, $namespace ) +=head2 $self->get_actions( $c, $action, $namespace ) =cut @@ -236,7 +291,9 @@ sub get_actions { 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 @@ -278,7 +335,11 @@ sub get_containers { return map { $_->getNodeValue } @match; } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) + +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. =cut @@ -307,38 +368,56 @@ sub register { 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 $node = $self->find_or_create_namespace_node( $namespace ); # Set the method value - $parent->getNodeValue->actions->{ $action->name } = $action; + $node->getNodeValue->actions->{ $name } = $action; + + my $path = "$namespace/$name"; + + if ( exists $self->action_hash->{$path} and $self->action_hash->{$path} != $action ) { + warn "inconsistency: $path is already registered"; + } + + $self->action_hash->{$path} = $action; +} + +sub find_or_create_namespace_node { + my ( $self, $namespace ) = @_; + + my $tree ||= $self->tree; + + return $tree unless $namespace; + + my @namespace = split '/', $namespace; + return $self->_find_or_create_namespace_node( $tree, @namespace ); +} + +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) { + # Create a new tree node and an ActionContainer to form + # its value. + + my $container = + Catalyst::ActionContainer->new( + { part => $part, actions => {} } ); + + $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 @@ -350,17 +429,11 @@ sub setup_actions { $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; - } + my @classes = + $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } ); + @{ $self->registered_dispatch_types }{@classes} = (1) x @classes; - # We use a tree + # Create the root node of the tree my $container = Catalyst::ActionContainer->new( { part => '/', actions => {} } ); $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); @@ -369,14 +442,7 @@ sub setup_actions { $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; @@ -413,7 +479,25 @@ sub setup_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