1 package Catalyst::Dispatcher;
6 use Catalyst::Exception;
9 use Catalyst::ActionContainer;
10 use Catalyst::DispatchType::Default;
11 use Catalyst::DispatchType::Index;
12 use Text::SimpleTable;
14 use Tree::Simple::Visitor::FindByPath;
18 use overload '""' => sub { return ref shift }, fallback => 1;
21 # Preload these action types
22 our @PRELOAD = qw/Index Path Regex/;
24 # Postload these action types
25 our @POSTLOAD = qw/Default/;
27 has _tree => (is => 'rw');
28 has _dispatch_types => (is => 'rw');
29 has _registered_dispatch_types => (is => 'rw');
30 has _method_action_class => (is => 'rw');
31 has _action_container_class => (is => 'rw');
32 has preload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@PRELOAD] });
33 has postload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@POSTLOAD] });
34 has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
35 has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
41 Catalyst::Dispatcher - The Catalyst Dispatcher
49 This is the class that maps public urls to actions in your Catalyst
50 application based on the attributes you set.
56 Construct a new dispatcher.
61 my ($self, $params) = @_;
64 Catalyst::ActionContainer->new( { part => '/', actions => {} } );
66 $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
69 =head2 $self->preload_dispatch_types
71 An arrayref of pre-loaded dispatchtype classes
73 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
74 To use a custom class outside the regular C<Catalyst> namespace, prefix
75 it with a C<+>, like so:
79 =head2 $self->postload_dispatch_types
81 An arrayref of post-loaded dispatchtype classes
83 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
84 To use a custom class outside the regular C<Catalyst> namespace, prefix
85 it with a C<+>, like so:
89 =head2 $self->detach( $c, $command [, \@arguments ] )
91 Documented in L<Catalyst>
96 my ( $self, $c, $command, @args ) = @_;
97 $c->forward( $command, @args ) if $command;
98 die $Catalyst::DETACH;
101 =head2 $self->dispatch($c)
103 Delegate the dispatch to the action that matched the url, or return a
104 message about unknown resource
110 my ( $self, $c ) = @_;
112 $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
116 my $path = $c->req->path;
118 ? qq/Unknown resource "$path"/
119 : "No default action defined";
120 $c->log->error($error) if $c->debug;
125 =head2 $self->forward( $c, $command [, \@arguments ] )
127 Documented in L<Catalyst>
132 my ( $self, $c, $command, @extra_params ) = @_;
135 $c->log->debug('Nothing to forward to') if $c->debug;
141 if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
142 @args = @{ pop @extra_params }
144 # this is a copy, it may take some abuse from ->_invoke_as_path if the path had trailing parts
145 @args = @{ $c->request->arguments };
150 # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
151 $action = $self->_invoke_as_path( $c, "$command", \@args );
153 # forward to a component ( "MyApp::*::Foo" or $c->component("...") - a path or an object)
155 my $method = @extra_params ? $extra_params[0] : "process";
156 $action = $self->_invoke_as_component( $c, $command, $method );
162 qq/Couldn't forward to command "$command": /
163 . qq/Invalid action or component./;
165 $c->log->debug($error) if $c->debug;
171 no warnings 'recursion';
173 local $c->request->{arguments} = \@args;
174 $action->dispatch( $c );
179 sub _action_rel2abs {
180 my ( $self, $c, $path ) = @_;
182 unless ( $path =~ m#^/# ) {
183 my $namespace = $c->stack->[-1]->namespace;
184 $path = "$namespace/$path";
191 sub _invoke_as_path {
192 my ( $self, $c, $rel_path, $args ) = @_;
194 my $path = $self->_action_rel2abs( $c, $rel_path );
196 my ( $tail, @extra_args );
197 while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) )
198 { # allow $path to be empty
199 if ( my $action = $c->get_action( $tail, $path ) ) {
200 push @$args, @extra_args;
206 ; # if a match on the global namespace failed then the whole lookup failed
209 unshift @extra_args, $tail;
213 sub _find_component_class {
214 my ( $self, $c, $component ) = @_;
216 return ref($component)
217 || ref( $c->component($component) )
218 || $c->component($component);
221 sub _invoke_as_component {
222 my ( $self, $c, $component, $method ) = @_;
224 my $class = $self->_find_component_class( $c, $component ) || return 0;
226 if ( my $code = $class->can($method) ) {
227 return $self->_method_action_class->new(
231 reverse => "$class->$method",
233 namespace => Catalyst::Utils::class2prefix(
234 $class, $c->config->{case_sensitive}
241 qq/Couldn't forward to "$class". Does not implement "$method"/;
243 $c->log->debug($error)
249 =head2 $self->prepare_action($c)
251 Find an dispatch type that matches $c->req->path, and set args from it.
256 my ( $self, $c ) = @_;
257 my $path = $c->req->path;
258 my @path = split /\//, $c->req->path;
259 $c->req->args( \my @args );
261 unshift( @path, '' ); # Root action
263 DESCEND: while (@path) {
264 $path = join '/', @path;
267 $path = '' if $path eq '/'; # Root action
269 # Check out dispatch types to see if any will handle the path at
272 foreach my $type ( @{ $self->_dispatch_types } ) {
273 last DESCEND if $type->match( $c, $path );
276 # If not, move the last part path to args
277 my $arg = pop(@path);
278 $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
282 s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$c->req->captures||[]};
284 $c->log->debug( 'Path is "' . $c->req->match . '"' )
285 if ( $c->debug && $c->req->match );
287 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
288 if ( $c->debug && @args );
291 =head2 $self->get_action( $action, $namespace )
293 returns a named action from a given namespace.
298 my ( $self, $name, $namespace ) = @_;
301 $namespace = join( "/", grep { length } split '/', $namespace || "" );
303 return $self->_action_hash->{"$namespace/$name"};
306 =head2 $self->get_action_by_path( $path );
308 Returns the named action by its full path.
312 sub get_action_by_path {
313 my ( $self, $path ) = @_;
315 $path = "/$path" unless $path =~ /\//;
316 $self->_action_hash->{$path};
319 =head2 $self->get_actions( $c, $action, $namespace )
324 my ( $self, $c, $action, $namespace ) = @_;
325 return [] unless $action;
327 $namespace = join( "/", grep { length } split '/', $namespace || "" );
329 my @match = $self->get_containers($namespace);
331 return map { $_->get_action($action) } @match;
334 =head2 $self->get_containers( $namespace )
336 Return all the action containers for a given namespace, inclusive
341 my ( $self, $namespace ) = @_;
343 $namespace = '' if $namespace eq '/';
347 if ( length $namespace ) {
349 push @containers, $self->_container_hash->{$namespace};
350 } while ( $namespace =~ s#/[^/]+$## );
353 return reverse grep { defined } @containers, $self->_container_hash->{''};
355 my @parts = split '/', $namespace;
358 =head2 $self->uri_for_action($action, \@captures)
360 Takes a Catalyst::Action object and action parameters and returns a URI
361 part such that if $c->req->path were this URI part, this action would be
362 dispatched to with $c->req->captures set to the supplied arrayref.
364 If the action object is not available for external dispatch or the dispatcher
365 cannot determine an appropriate URI, this method will return undef.
370 my ( $self, $action, $captures) = @_;
372 foreach my $dispatch_type ( @{ $self->_dispatch_types } ) {
373 my $uri = $dispatch_type->uri_for_action( $action, $captures );
374 return( $uri eq '' ? '/' : $uri )
380 =head2 $self->register( $c, $action )
382 Make sure all required dispatch types for this action are loaded, then
383 pass the action to our dispatch types so they can register it if required.
384 Also, set up the tree with the action containers.
389 my ( $self, $c, $action ) = @_;
391 my $registered = $self->_registered_dispatch_types;
394 foreach my $key ( keys %{ $action->attributes } ) {
395 next if $key eq 'Private';
396 my $class = "Catalyst::DispatchType::$key";
397 unless ( $registered->{$class} ) {
398 eval { Class::MOP::load_class($class) };
399 push( @{ $self->_dispatch_types }, $class->new ) unless $@;
400 $registered->{$class} = 1;
404 # Pass the action to our dispatch types so they can register it if reqd.
405 foreach my $type ( @{ $self->_dispatch_types } ) {
406 $type->register( $c, $action );
409 my $namespace = $action->namespace;
410 my $name = $action->name;
412 my $container = $self->_find_or_create_action_container($namespace);
414 # Set the method value
415 $container->add_action($action);
417 $self->_action_hash->{"$namespace/$name"} = $action;
418 $self->_container_hash->{$namespace} = $container;
421 sub _find_or_create_action_container {
422 my ( $self, $namespace ) = @_;
424 my $tree ||= $self->_tree;
426 return $tree->getNodeValue unless $namespace;
428 my @namespace = split '/', $namespace;
429 return $self->_find_or_create_namespace_node( $tree, @namespace )
433 sub _find_or_create_namespace_node {
434 my ( $self, $parent, $part, @namespace ) = @_;
436 return $parent unless $part;
439 ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
442 my $container = Catalyst::ActionContainer->new($part);
443 $parent->addChild( $child = Tree::Simple->new($container) );
446 $self->_find_or_create_namespace_node( $child, @namespace );
449 =head2 $self->setup_actions( $class, $context )
455 my ( $self, $c ) = @_;
457 $self->_dispatch_types( [] );
458 $self->_registered_dispatch_types( {} );
459 $self->_method_action_class('Catalyst::Action');
460 $self->_action_container_class('Catalyst::ActionContainer');
463 $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
464 @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
466 foreach my $comp ( values %{ $c->components } ) {
467 $comp->register_actions($c) if $comp->can('register_actions');
470 $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
472 return unless $c->debug;
474 my $privates = Text::SimpleTable->new(
482 my ( $walker, $parent, $prefix ) = @_;
483 $prefix .= $parent->getNodeValue || '';
484 $prefix .= '/' unless $prefix =~ /\/$/;
485 my $node = $parent->getNodeValue->actions;
487 for my $action ( keys %{$node} ) {
488 my $action_obj = $node->{$action};
490 if ( ( $action =~ /^_.*/ )
491 && ( !$c->config->{show_internal_actions} ) );
492 $privates->row( "$prefix$action", $action_obj->class, $action );
496 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
499 $walker->( $walker, $self->_tree, '' );
500 $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
503 # List all public actions
504 $_->list($c) for @{ $self->_dispatch_types };
507 sub _load_dispatch_types {
508 my ( $self, @types ) = @_;
512 # Preload action types
513 for my $type (@types) {
515 ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
516 eval { Class::MOP::load_class($class) };
517 Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
519 push @{ $self->_dispatch_types }, $class->new;
521 push @loaded, $class;
533 Sebastian Riedel, C<sri@cpan.org>
534 Matt S Trout, C<mst@shadowcatsystems.co.uk>
538 This program is free software, you can redistribute it and/or modify it under
539 the same terms as Perl itself.