1 package Catalyst::Dispatcher;
5 with 'MooseX::Emulate::Class::Accessor::Fast';
7 use Catalyst::Exception;
10 use Catalyst::ActionContainer;
11 use Catalyst::DispatchType::Default;
12 use Catalyst::DispatchType::Index;
14 use Text::SimpleTable;
16 use Tree::Simple::Visitor::FindByPath;
18 use namespace::clean -except => 'meta';
21 # do these belong as package vars or should we build these via a builder method?
22 # See Catalyst-Plugin-Server for them being added to, which should be much less ugly.
24 # Preload these action types
25 our @PRELOAD = qw/Index Path Regex/;
27 # Postload these action types
28 our @POSTLOAD = qw/Default/;
30 # Note - see back-compat methods at end of file.
31 has _tree => (is => 'rw', builder => '_build__tree');
32 has dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1);
33 has _registered_dispatch_types => (is => 'rw', default => sub { {} }, required => 1, lazy => 1);
34 has _method_action_class => (is => 'rw', default => 'Catalyst::Action');
35 has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
36 has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
38 my %dispatch_types = ( pre => \@PRELOAD, post => \@POSTLOAD );
39 foreach my $type (keys %dispatch_types) {
40 has $type . "load_dispatch_types" => (
41 is => 'rw', required => 1, lazy => 1, default => sub { $dispatch_types{$type} },
42 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute'], # List assignment is CAF style
48 Catalyst::Dispatcher - The Catalyst Dispatcher
56 This is the class that maps public urls to actions in your Catalyst
57 application based on the attributes you set.
63 Construct a new dispatcher.
71 Catalyst::ActionContainer->new( { part => '/', actions => {} } );
73 return Tree::Simple->new($container, Tree::Simple->ROOT);
76 =head2 $self->preload_dispatch_types
78 An arrayref of pre-loaded dispatchtype classes
80 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
81 To use a custom class outside the regular C<Catalyst> namespace, prefix
82 it with a C<+>, like so:
86 =head2 $self->postload_dispatch_types
88 An arrayref of post-loaded dispatchtype classes
90 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
91 To use a custom class outside the regular C<Catalyst> namespace, prefix
92 it with a C<+>, like so:
96 =head2 $self->dispatch($c)
98 Delegate the dispatch to the action that matched the url, or return a
99 message about unknown resource
104 my ( $self, $c ) = @_;
105 if ( my $action = $c->action ) {
106 $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
109 my $path = $c->req->path;
111 ? qq/Unknown resource "$path"/
112 : "No default action defined";
113 $c->log->error($error) if $c->debug;
118 # $self->_command2action( $c, $command [, \@arguments ] )
119 # $self->_command2action( $c, $command [, \@captures, \@arguments ] )
120 # Search for an action, from the command and returns C<($action, $args, $captures)> on
121 # success. Returns C<(0)> on error.
123 sub _command2action {
124 my ( $self, $c, $command, @extra_params ) = @_;
127 $c->log->debug('Nothing to go to') if $c->debug;
131 my (@args, @captures);
133 if ( ref( $extra_params[-2] ) eq 'ARRAY' ) {
134 @captures = @{ splice @extra_params, -2, 1 };
137 if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
138 @args = @{ pop @extra_params }
140 # this is a copy, it may take some abuse from
141 # ->_invoke_as_path if the path had trailing parts
142 @args = @{ $c->request->arguments };
147 # go to a string path ("/foo/bar/gorch")
149 if (blessed($command) && $command->isa('Catalyst::Action')) {
153 $action = $self->_invoke_as_path( $c, "$command", \@args );
156 # go to a component ( "MyApp::*::Foo" or $c->component("...")
157 # - a path or an object)
159 my $method = @extra_params ? $extra_params[0] : "process";
160 $action = $self->_invoke_as_component( $c, $command, $method );
163 return $action, \@args, \@captures;
166 =head2 $self->visit( $c, $command [, \@arguments ] )
168 Documented in L<Catalyst>
174 $self->_do_visit('visit', @_);
180 my ( $c, $command ) = @_;
181 my ( $action, $args, $captures ) = $self->_command2action(@_);
182 my $error = qq/Couldn't $opname("$command"): /;
185 $error .= qq/Couldn't $opname to command "$command": /
186 .qq/Invalid action or component./;
188 elsif (!defined $action->namespace) {
189 $error .= qq/Action has no namespace: cannot $opname() to a plain /
190 .qq/method or component, must be an :Action of some sort./
192 elsif (!$action->class->can('_DISPATCH')) {
193 $error .= qq/Action cannot _DISPATCH. /
194 .qq/Did you try to $opname() a non-controller action?/;
202 $c->log->debug($error) if $c->debug;
206 $action = $self->expand_action($action);
208 local $c->request->{arguments} = $args;
209 local $c->request->{captures} = $captures;
210 local $c->{namespace} = $action->{'namespace'};
211 local $c->{action} = $action;
216 =head2 $self->go( $c, $command [, \@arguments ] )
218 Documented in L<Catalyst>
224 $self->_do_visit('go', @_);
225 Catalyst::Exception::Go->throw;
228 =head2 $self->forward( $c, $command [, \@arguments ] )
230 Documented in L<Catalyst>
236 no warnings 'recursion';
237 $self->_do_forward(forward => @_);
243 my ( $c, $command ) = @_;
244 my ( $action, $args, $captures ) = $self->_command2action(@_);
247 my $error .= qq/Couldn't $opname to command "$command": /
248 .qq/Invalid action or component./;
250 $c->log->debug($error) if $c->debug;
255 local $c->request->{arguments} = $args;
256 no warnings 'recursion';
257 $action->dispatch( $c );
262 =head2 $self->detach( $c, $command [, \@arguments ] )
264 Documented in L<Catalyst>
269 my ( $self, $c, $command, @args ) = @_;
270 $self->_do_forward(detach => $c, $command, @args ) if $command;
271 Catalyst::Exception::Detach->throw;
274 sub _action_rel2abs {
275 my ( $self, $c, $path ) = @_;
277 unless ( $path =~ m#^/# ) {
278 my $namespace = $c->stack->[-1]->namespace;
279 $path = "$namespace/$path";
286 sub _invoke_as_path {
287 my ( $self, $c, $rel_path, $args ) = @_;
289 my $path = $self->_action_rel2abs( $c, $rel_path );
291 my ( $tail, @extra_args );
292 while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) )
293 { # allow $path to be empty
294 if ( my $action = $c->get_action( $tail, $path ) ) {
295 push @$args, @extra_args;
301 ; # if a match on the global namespace failed then the whole lookup failed
304 unshift @extra_args, $tail;
308 sub _find_component {
309 my ( $self, $c, $component ) = @_;
311 # fugly, why doesn't ->component('MyApp') work?
312 return $c if ($component eq blessed($c));
314 return blessed($component)
316 : $c->component($component);
319 sub _invoke_as_component {
320 my ( $self, $c, $component_or_class, $method ) = @_;
322 if( $component_or_class eq blessed($c->application) ){
323 my $possible_action = $c->application->action_for($method);
324 return $possible_action if $possible_action;
326 my $component = $self->_find_component($c, $component_or_class);
327 my $component_class = blessed $component || return 0;
329 if (my $code = $component_class->can('action_for')) {
330 my $possible_action = $component->$code($method);
331 return $possible_action if $possible_action;
334 if ( my $code = $component_class->can($method) ) {
335 return $self->_method_action_class->new(
339 reverse => "$component_class->$method",
340 class => $component_class,
341 namespace => Catalyst::Utils::class2prefix( $component_class ),
347 qq/Couldn't forward to "$component_class". Does not implement "$method"/;
349 $c->log->debug($error)
355 =head2 $self->prepare_action($c)
357 Find an dispatch type that matches $c->req->path, and set args from it.
362 my ( $self, $c ) = @_;
364 my $path = $req->path;
365 my @path = split /\//, $req->path;
366 $req->args( \my @args );
368 unshift( @path, '' ); # Root action
370 DESCEND: while (@path) {
371 $path = join '/', @path;
374 # Check out dispatch types to see if any will handle the path at
377 foreach my $type ( @{ $self->dispatch_types } ) {
378 last DESCEND if $type->match( $c, $path );
381 # If not, move the last part path to args
382 my $arg = pop(@path);
383 $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
387 s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
389 $c->log->debug( 'Path is "' . $req->match . '"' )
390 if ( $c->debug && defined $req->match && length $req->match );
392 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
393 if ( $c->debug && @args );
396 =head2 $self->get_action( $action, $namespace )
398 returns a named action from a given namespace.
403 my ( $self, $name, $namespace ) = @_;
406 $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
408 return $self->_action_hash->{"${namespace}/${name}"};
411 =head2 $self->get_action_by_path( $path );
413 Returns the named action by its full private path.
417 sub get_action_by_path {
418 my ( $self, $path ) = @_;
420 $path = "/$path" unless $path =~ /\//;
421 $self->_action_hash->{$path};
424 =head2 $self->get_actions( $c, $action, $namespace )
429 my ( $self, $c, $action, $namespace ) = @_;
430 return [] unless $action;
432 $namespace = join( "/", grep { length } split '/', $namespace || "" );
434 my @match = $self->get_containers($namespace);
436 return map { $_->get_action($action) } @match;
439 =head2 $self->get_containers( $namespace )
441 Return all the action containers for a given namespace, inclusive
446 my ( $self, $namespace ) = @_;
448 $namespace = '' if $namespace eq '/';
452 if ( length $namespace ) {
454 push @containers, $self->_container_hash->{$namespace};
455 } while ( $namespace =~ s#/[^/]+$## );
458 return reverse grep { defined } @containers, $self->_container_hash->{''};
461 =head2 $self->uri_for_action($action, \@captures)
463 Takes a Catalyst::Action object and action parameters and returns a URI
464 part such that if $c->req->path were this URI part, this action would be
465 dispatched to with $c->req->captures set to the supplied arrayref.
467 If the action object is not available for external dispatch or the dispatcher
468 cannot determine an appropriate URI, this method will return undef.
473 my ( $self, $action, $captures) = @_;
475 foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
476 my $uri = $dispatch_type->uri_for_action( $action, $captures );
477 return( $uri eq '' ? '/' : $uri )
485 expand an action into a full representation of the dispatch.
486 mostly useful for chained, other actions will just return a
492 my ($self, $action) = @_;
494 foreach my $dispatch_type (@{ $self->dispatch_types }) {
495 my $expanded = $dispatch_type->expand_action($action);
496 return $expanded if $expanded;
502 =head2 $self->register( $c, $action )
504 Make sure all required dispatch types for this action are loaded, then
505 pass the action to our dispatch types so they can register it if required.
506 Also, set up the tree with the action containers.
511 my ( $self, $c, $action ) = @_;
513 my $registered = $self->_registered_dispatch_types;
515 #my $priv = 0; #seems to be unused
516 foreach my $key ( keys %{ $action->attributes } ) {
517 next if $key eq 'Private';
518 my $class = "Catalyst::DispatchType::$key";
519 unless ( $registered->{$class} ) {
520 # FIXME - Some error checking and re-throwing needed here, as
521 # we eat exceptions loading dispatch types.
522 eval { Class::MOP::load_class($class) };
523 push( @{ $self->dispatch_types }, $class->new ) unless $@;
524 $registered->{$class} = 1;
528 my @dtypes = @{ $self->dispatch_types };
530 my @low_precedence_dtypes;
532 for my $type ( @dtypes ) {
533 if ($type->_is_low_precedence) {
534 push @low_precedence_dtypes, $type;
536 push @normal_dtypes, $type;
540 # Pass the action to our dispatch types so they can register it if reqd.
541 my $was_registered = 0;
542 foreach my $type ( @normal_dtypes ) {
543 $was_registered = 1 if $type->register( $c, $action );
546 if (not $was_registered) {
547 foreach my $type ( @low_precedence_dtypes ) {
548 $type->register( $c, $action );
552 my $namespace = $action->namespace;
553 my $name = $action->name;
555 my $container = $self->_find_or_create_action_container($namespace);
557 # Set the method value
558 $container->add_action($action);
560 $self->_action_hash->{"$namespace/$name"} = $action;
561 $self->_container_hash->{$namespace} = $container;
564 sub _find_or_create_action_container {
565 my ( $self, $namespace ) = @_;
567 my $tree ||= $self->_tree;
569 return $tree->getNodeValue unless $namespace;
571 my @namespace = split '/', $namespace;
572 return $self->_find_or_create_namespace_node( $tree, @namespace )
576 sub _find_or_create_namespace_node {
577 my ( $self, $parent, $part, @namespace ) = @_;
579 return $parent unless $part;
582 ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
585 my $container = Catalyst::ActionContainer->new($part);
586 $parent->addChild( $child = Tree::Simple->new($container) );
589 $self->_find_or_create_namespace_node( $child, @namespace );
592 =head2 $self->setup_actions( $class, $context )
594 Loads all of the preload dispatch types, registers their actions and then
595 loads all of the postload dispatch types, and iterates over the tree of
596 actions, displaying the debug information if appropriate.
601 my ( $self, $c ) = @_;
604 $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
605 @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
607 foreach my $comp ( values %{ $c->components } ) {
608 $comp->register_actions($c) if $comp->can('register_actions');
611 $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
613 return unless $c->debug;
614 $self->_display_action_tables($c);
617 sub _display_action_tables {
620 my $avail_width = Catalyst::Utils::term_width() - 12;
621 my $col1_width = ($avail_width * .25) < 20 ? 20 : int($avail_width * .25);
622 my $col2_width = ($avail_width * .50) < 36 ? 36 : int($avail_width * .50);
623 my $col3_width = $avail_width - $col1_width - $col2_width;
624 my $privates = Text::SimpleTable->new(
625 [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, 'Method' ]
630 my ( $walker, $parent, $prefix ) = @_;
631 $prefix .= $parent->getNodeValue || '';
632 $prefix .= '/' unless $prefix =~ /\/$/;
633 my $node = $parent->getNodeValue->actions;
635 for my $action ( keys %{$node} ) {
636 my $action_obj = $node->{$action};
638 if ( ( $action =~ /^_.*/ )
639 && ( !$c->config->{show_internal_actions} ) );
640 $privates->row( "$prefix$action", $action_obj->class, $action );
644 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
647 $walker->( $walker, $self->_tree, '' );
648 $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
651 # List all public actions
652 $_->list($c) for @{ $self->dispatch_types };
655 sub _load_dispatch_types {
656 my ( $self, @types ) = @_;
659 # Preload action types
660 for my $type (@types) {
661 # first param is undef because we cannot get the appclass
662 my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type);
664 eval { Class::MOP::load_class($class) };
665 Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
667 push @{ $self->dispatch_types }, $class->new;
669 push @loaded, $class;
675 =head2 $self->dispatch_type( $type )
677 Get the DispatchType object of the relevant type, i.e. passing C<$type> of
678 C<Chained> would return a L<Catalyst::DispatchType::Chained> object (assuming
679 of course it's being used.)
684 my ($self, $name) = @_;
686 # first param is undef because we cannot get the appclass
687 $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name);
689 for (@{ $self->dispatch_types }) {
690 return $_ if ref($_) eq $name;
697 # 5.70 backwards compatibility hacks.
699 # Various plugins (e.g. Plugin::Server and Plugin::Authorization::ACL)
700 # need the methods here which *should* be private..
702 # You should be able to use get_actions or get_containers appropriately
703 # instead of relying on these methods which expose implementation details
704 # of the dispatcher..
706 # IRC backlog included below, please come ask if this doesn't work for you.
708 # <@t0m> 5.80, the state of. There are things in the dispatcher which have
709 # been deprecated, that we yell at anyone for using, which there isn't
710 # a good alternative for yet..
711 # <@mst> er, get_actions/get_containers provides that doesn't it?
712 # <@mst> DispatchTypes are loaded on demand anyway
713 # <@t0m> I'm thinking of things like _tree which is aliased to 'tree' with
714 # warnings otherwise shit breaks.. We're issuing warnings about the
715 # correct set of things which you shouldn't be calling..
717 # <@mst> basically, I don't see there's a need for a replacement for anything
718 # <@mst> it was never a good idea to call ->tree
719 # <@mst> nothingmuch was the only one who did AFAIK
720 # <@mst> and he admitted it was a hack ;)
722 # See also t/lib/TestApp/Plugin/AddDispatchTypes.pm
724 # Alias _method_name to method_name, add a before modifier to warn..
725 foreach my $public_method_name (qw/
727 registered_dispatch_types
732 my $private_method_name = '_' . $public_method_name;
733 my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time.
734 $meta->add_method($public_method_name, $meta->get_method($private_method_name));
736 my %package_hash; # Only warn once per method, per package. These are infrequent enough that
737 # I haven't provided a way to disable them, patches welcome.
738 $meta->add_before_method_modifier($public_method_name, sub {
739 my $class = caller(2);
741 $package_hash{$class}++ || do {
742 warn("Class $class is calling the deprecated method\n"
743 . " Catalyst::Dispatcher::$public_method_name,\n"
744 . " this will be removed in Catalyst 5.9X\n");
749 # End 5.70 backwards compatibility hacks.
751 __PACKAGE__->meta->make_immutable;
759 Catalyst Contributors, see Catalyst.pm
763 This library is free software. You can redistribute it and/or modify it under
764 the same terms as Perl itself.