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;
17 use Class::Load qw(load_class try_load_class);
18 use Encode 2.21 'decode_utf8';
20 use namespace::clean -except => 'meta';
23 # do these belong as package vars or should we build these via a builder method?
24 # See Catalyst-Plugin-Server for them being added to, which should be much less ugly.
26 # Preload these action types
27 our @PRELOAD = qw/Index Path/;
29 # Postload these action types
30 our @POSTLOAD = qw/Default/;
32 # Note - see back-compat methods at end of file.
33 has _tree => (is => 'rw', builder => '_build__tree');
34 has dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1);
35 has _registered_dispatch_types => (is => 'rw', default => sub { {} }, required => 1, lazy => 1);
36 has _method_action_class => (is => 'rw', default => 'Catalyst::Action');
37 has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
38 has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
40 my %dispatch_types = ( pre => \@PRELOAD, post => \@POSTLOAD );
41 foreach my $type (keys %dispatch_types) {
42 has $type . "load_dispatch_types" => (
43 is => 'rw', required => 1, lazy => 1, default => sub { $dispatch_types{$type} },
44 traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute'], # List assignment is CAF style
50 Catalyst::Dispatcher - The Catalyst Dispatcher
58 This is the class that maps public urls to actions in your Catalyst
59 application based on the attributes you set.
65 Construct a new dispatcher.
73 Catalyst::ActionContainer->new( { part => '/', actions => {} } );
75 return Tree::Simple->new($container, Tree::Simple->ROOT);
78 =head2 $self->preload_dispatch_types
80 An arrayref of pre-loaded dispatchtype classes
82 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
83 To use a custom class outside the regular C<Catalyst> namespace, prefix
84 it with a C<+>, like so:
88 =head2 $self->postload_dispatch_types
90 An arrayref of post-loaded dispatchtype classes
92 Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
93 To use a custom class outside the regular C<Catalyst> namespace, prefix
94 it with a C<+>, like so:
98 =head2 $self->dispatch($c)
100 Delegate the dispatch to the action that matched the url, or return a
101 message about unknown resource
106 my ( $self, $c ) = @_;
107 if ( my $action = $c->action ) {
108 $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
111 my $path = $c->req->path;
112 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
113 $path = decode_utf8($path);
116 ? qq/Unknown resource "$path"/
117 : "No default action defined";
118 $c->log->error($error) if $c->debug;
123 # $self->_command2action( $c, $command [, \@arguments ] )
124 # $self->_command2action( $c, $command [, \@captures, \@arguments ] )
125 # Search for an action, from the command and returns C<($action, $args, $captures)> on
126 # success. Returns C<(0)> on error.
128 sub _command2action {
129 my ( $self, $c, $command, @extra_params ) = @_;
132 $c->log->debug('Nothing to go to') if $c->debug;
136 my (@args, @captures);
138 if ( ref( $extra_params[-2] ) eq 'ARRAY' ) {
139 @captures = @{ splice @extra_params, -2, 1 };
142 if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
143 @args = @{ pop @extra_params }
145 # this is a copy, it may take some abuse from
146 # ->_invoke_as_path if the path had trailing parts
147 @args = @{ $c->request->arguments };
152 # go to a string path ("/foo/bar/gorch")
154 if (blessed($command) && $command->isa('Catalyst::Action')) {
158 $action = $self->_invoke_as_path( $c, "$command", \@args );
161 # go to a component ( "View::Foo" or $c->component("...")
162 # - a path or an object)
164 my $method = @extra_params ? $extra_params[0] : "process";
165 $action = $self->_invoke_as_component( $c, $command, $method );
168 return $action, \@args, \@captures;
171 =head2 $self->visit( $c, $command [, \@arguments ] )
173 Documented in L<Catalyst>
179 $self->_do_visit('visit', @_);
185 my ( $c, $command ) = @_;
186 my ( $action, $args, $captures ) = $self->_command2action(@_);
187 my $error = qq/Couldn't $opname("$command"): /;
190 $error .= qq/Couldn't $opname to command "$command": /
191 .qq/Invalid action or component./;
193 elsif (!defined $action->namespace) {
194 $error .= qq/Action has no namespace: cannot $opname() to a plain /
195 .qq/method or component, must be an :Action of some sort./
197 elsif (!$action->class->can('_DISPATCH')) {
198 $error .= qq/Action cannot _DISPATCH. /
199 .qq/Did you try to $opname() a non-controller action?/;
207 $c->log->debug($error) if $c->debug;
211 $action = $self->expand_action($action);
213 local $c->request->{arguments} = $args;
214 local $c->request->{captures} = $captures;
215 local $c->{namespace} = $action->{'namespace'};
216 local $c->{action} = $action;
221 =head2 $self->go( $c, $command [, \@arguments ] )
223 Documented in L<Catalyst>
229 $self->_do_visit('go', @_);
230 Catalyst::Exception::Go->throw;
233 =head2 $self->forward( $c, $command [, \@arguments ] )
235 Documented in L<Catalyst>
241 no warnings 'recursion';
242 $self->_do_forward(forward => @_);
248 my ( $c, $command ) = @_;
249 my ( $action, $args, $captures ) = $self->_command2action(@_);
252 my $error .= qq/Couldn't $opname to command "$command": /
253 .qq/Invalid action or component./;
255 $c->log->debug($error) if $c->debug;
260 local $c->request->{arguments} = $args;
261 no warnings 'recursion';
262 $action->dispatch( $c );
267 =head2 $self->detach( $c, $command [, \@arguments ] )
269 Documented in L<Catalyst>
274 my ( $self, $c, $command, @args ) = @_;
275 $self->_do_forward(detach => $c, $command, @args ) if $command;
276 Catalyst::Exception::Detach->throw;
279 sub _action_rel2abs {
280 my ( $self, $c, $path ) = @_;
282 unless ( $path =~ m#^/# ) {
283 my $namespace = $c->stack->[-1]->namespace;
284 $path = "$namespace/$path";
291 sub _invoke_as_path {
292 my ( $self, $c, $rel_path, $args ) = @_;
294 my $path = $self->_action_rel2abs( $c, $rel_path );
296 my ( $tail, @extra_args );
297 while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) )
298 { # allow $path to be empty
299 if ( my $action = $c->get_action( $tail, $path ) ) {
300 push @$args, @extra_args;
306 ; # if a match on the global namespace failed then the whole lookup failed
309 unshift @extra_args, $tail;
313 sub _find_component {
314 my ( $self, $c, $component ) = @_;
316 # fugly, why doesn't ->component('MyApp') work?
317 return $c if ($component eq blessed($c));
319 return blessed($component)
321 : $c->component($component);
324 sub _invoke_as_component {
325 my ( $self, $c, $component_or_class, $method ) = @_;
327 my $component = $self->_find_component($c, $component_or_class);
328 my $component_class = blessed $component || return 0;
330 if (my $code = $component_class->can('action_for')) {
331 my $possible_action = $component->$code($method);
332 return $possible_action if $possible_action;
335 if ( my $code = $component_class->can($method) ) {
336 return $self->_method_action_class->new(
340 reverse => "$component_class->$method",
341 class => $component_class,
342 namespace => Catalyst::Utils::class2prefix(
343 $component_class, ref($c)->config->{case_sensitive}
350 qq/Couldn't forward to "$component_class". Does not implement "$method"/;
352 $c->log->debug($error)
358 =head2 $self->prepare_action($c)
360 Find an dispatch type that matches $c->req->path, and set args from it.
365 my ( $self, $c ) = @_;
367 my $path = $req->path;
368 my @path = split /\//, $req->path;
369 $req->args( \my @args );
371 unshift( @path, '' ); # Root action
373 DESCEND: while (@path) {
374 $path = join '/', @path;
377 # Check out dispatch types to see if any will handle the path at
380 foreach my $type ( @{ $self->dispatch_types } ) {
381 last DESCEND if $type->match( $c, $path );
384 # If not, move the last part path to args
385 my $arg = pop(@path);
386 $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
390 s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
392 if($c->debug && defined $req->match && length $req->match) {
393 my $match = $req->match;
394 $match =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
395 $match = decode_utf8($match);
396 $c->log->debug( 'Path is "' . $match . '"' )
399 $c->log->debug( 'Arguments are "' . join( '/', map { decode_utf8 $_ } @args ) . '"' )
400 if ( $c->debug && @args );
403 =head2 $self->get_action( $action, $namespace )
405 returns a named action from a given namespace.
410 my ( $self, $name, $namespace ) = @_;
413 $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
415 return $self->_action_hash->{"${namespace}/${name}"};
418 =head2 $self->get_action_by_path( $path );
420 Returns the named action by its full private path.
424 sub get_action_by_path {
425 my ( $self, $path ) = @_;
427 $path = "/$path" unless $path =~ /\//;
428 $self->_action_hash->{$path};
431 =head2 $self->get_actions( $c, $action, $namespace )
436 my ( $self, $c, $action, $namespace ) = @_;
437 return [] unless $action;
439 $namespace = join( "/", grep { length } split '/', $namespace || "" );
441 my @match = $self->get_containers($namespace);
443 return map { $_->get_action($action) } @match;
446 =head2 $self->get_containers( $namespace )
448 Return all the action containers for a given namespace, inclusive
453 my ( $self, $namespace ) = @_;
455 $namespace = '' if $namespace eq '/';
459 if ( length $namespace ) {
461 push @containers, $self->_container_hash->{$namespace};
462 } while ( $namespace =~ s#/[^/]+$## );
465 return reverse grep { defined } @containers, $self->_container_hash->{''};
468 =head2 $self->uri_for_action($action, \@captures)
470 Takes a Catalyst::Action object and action parameters and returns a URI
471 part such that if $c->req->path were this URI part, this action would be
472 dispatched to with $c->req->captures set to the supplied arrayref.
474 If the action object is not available for external dispatch or the dispatcher
475 cannot determine an appropriate URI, this method will return undef.
480 my ( $self, $action, $captures) = @_;
482 foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
483 my $uri = $dispatch_type->uri_for_action( $action, $captures );
484 return( $uri eq '' ? '/' : $uri )
492 expand an action into a full representation of the dispatch.
493 mostly useful for chained, other actions will just return a
499 my ($self, $action) = @_;
501 foreach my $dispatch_type (@{ $self->dispatch_types }) {
502 my $expanded = $dispatch_type->expand_action($action);
503 return $expanded if $expanded;
509 =head2 $self->register( $c, $action )
511 Make sure all required dispatch types for this action are loaded, then
512 pass the action to our dispatch types so they can register it if required.
513 Also, set up the tree with the action containers.
518 my ( $self, $c, $action ) = @_;
520 my $registered = $self->_registered_dispatch_types;
522 foreach my $key ( keys %{ $action->attributes } ) {
523 next if $key eq 'Private';
524 my $class = "Catalyst::DispatchType::$key";
525 unless ( $registered->{$class} ) {
526 # FIXME - Some error checking and re-throwing needed here, as
527 # we eat exceptions loading dispatch types.
528 # see also try_load_class
529 eval { load_class($class) };
530 my $load_failed = $@;
531 $self->_check_deprecated_dispatch_type( $key, $load_failed );
532 push( @{ $self->dispatch_types }, $class->new ) unless $load_failed;
533 $registered->{$class} = 1;
537 my @dtypes = @{ $self->dispatch_types };
539 my @low_precedence_dtypes;
541 for my $type ( @dtypes ) {
542 if ($type->_is_low_precedence) {
543 push @low_precedence_dtypes, $type;
545 push @normal_dtypes, $type;
549 # Pass the action to our dispatch types so they can register it if reqd.
550 my $was_registered = 0;
551 foreach my $type ( @normal_dtypes ) {
552 $was_registered = 1 if $type->register( $c, $action );
555 if (not $was_registered) {
556 foreach my $type ( @low_precedence_dtypes ) {
557 $type->register( $c, $action );
561 my $namespace = $action->namespace;
562 my $name = $action->name;
564 my $container = $self->_find_or_create_action_container($namespace);
566 # Set the method value
567 $container->add_action($action);
569 $self->_action_hash->{"$namespace/$name"} = $action;
570 $self->_container_hash->{$namespace} = $container;
573 sub _find_or_create_action_container {
574 my ( $self, $namespace ) = @_;
576 my $tree ||= $self->_tree;
578 return $tree->getNodeValue unless $namespace;
580 my @namespace = split '/', $namespace;
581 return $self->_find_or_create_namespace_node( $tree, @namespace )
585 sub _find_or_create_namespace_node {
586 my ( $self, $parent, $part, @namespace ) = @_;
588 return $parent unless $part;
591 ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
594 my $container = Catalyst::ActionContainer->new($part);
595 $parent->addChild( $child = Tree::Simple->new($container) );
598 $self->_find_or_create_namespace_node( $child, @namespace );
601 =head2 $self->setup_actions( $class, $context )
603 Loads all of the pre-load dispatch types, registers their actions and then
604 loads all of the post-load dispatch types, and iterates over the tree of
605 actions, displaying the debug information if appropriate.
610 my ( $self, $c ) = @_;
613 $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
614 @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
616 foreach my $comp ( values %{ $c->components } ) {
617 $comp = $comp->() if ref($comp) eq 'CODE';
618 $comp->register_actions($c) if $comp->can('register_actions');
621 $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
623 return unless $c->debug;
624 $self->_display_action_tables($c);
627 sub _display_action_tables {
630 my $avail_width = Catalyst::Utils::term_width() - 12;
631 my $col1_width = ($avail_width * .25) < 20 ? 20 : int($avail_width * .25);
632 my $col2_width = ($avail_width * .50) < 36 ? 36 : int($avail_width * .50);
633 my $col3_width = $avail_width - $col1_width - $col2_width;
634 my $privates = Text::SimpleTable->new(
635 [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, 'Method' ]
640 my ( $walker, $parent, $prefix ) = @_;
641 $prefix .= $parent->getNodeValue || '';
642 $prefix .= '/' unless $prefix =~ /\/$/;
643 my $node = $parent->getNodeValue->actions;
645 for my $action ( keys %{$node} ) {
646 my $action_obj = $node->{$action};
648 if ( ( $action =~ /^_.*/ )
649 && ( !$c->config->{show_internal_actions} ) );
650 $privates->row( "$prefix$action", $action_obj->class, $action );
654 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
657 $walker->( $walker, $self->_tree, '' );
658 $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
661 # List all public actions
662 $_->list($c) for @{ $self->dispatch_types };
665 sub _load_dispatch_types {
666 my ( $self, @types ) = @_;
669 # Preload action types
670 for my $type (@types) {
671 # first param is undef because we cannot get the appclass
672 my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type);
674 my ($success, $error) = try_load_class($class);
675 Catalyst::Exception->throw( message => $error ) if not $success;
676 push @{ $self->dispatch_types }, $class->new;
678 push @loaded, $class;
684 =head2 $self->dispatch_type( $type )
686 Get the DispatchType object of the relevant type, i.e. passing C<$type> of
687 C<Chained> would return a L<Catalyst::DispatchType::Chained> object (assuming
688 of course it's being used.)
693 my ($self, $name) = @_;
695 # first param is undef because we cannot get the appclass
696 $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name);
698 for (@{ $self->dispatch_types }) {
699 return $_ if ref($_) eq $name;
704 sub _check_deprecated_dispatch_type {
705 my ($self, $key, $load_failed) = @_;
707 return unless $key =~ /^(Local)?Regexp?/;
709 # TODO: Should these throw an exception rather than just warning?
711 warn( "Attempt to use deprecated $key dispatch type.\n"
712 . " Use Chained methods or install the standalone\n"
713 . " Catalyst::DispatchType::Regex if necessary.\n" );
714 } elsif ( !defined $Catalyst::DispatchType::Regex::VERSION
715 || $Catalyst::DispatchType::Regex::VERSION le '5.90020' ) {
716 # We loaded the old core version of the Regex module this will break
717 warn( "The $key DispatchType has been removed from Catalyst core.\n"
718 . " An old version of the core Catalyst::DispatchType::Regex\n"
719 . " has been loaded and will likely fail. Please remove\n"
720 . " $INC{'Catalyst/DispatchType/Regex.pm'}\n"
721 . " and use Chained methods or install the standalone\n"
722 . " Catalyst::DispatchType::Regex if necessary.\n" );
728 # 5.70 backwards compatibility hacks.
730 # Various plugins (e.g. Plugin::Server and Plugin::Authorization::ACL)
731 # need the methods here which *should* be private..
733 # You should be able to use get_actions or get_containers appropriately
734 # instead of relying on these methods which expose implementation details
735 # of the dispatcher..
737 # IRC backlog included below, please come ask if this doesn't work for you.
739 # <@t0m> 5.80, the state of. There are things in the dispatcher which have
740 # been deprecated, that we yell at anyone for using, which there isn't
741 # a good alternative for yet..
742 # <@mst> er, get_actions/get_containers provides that doesn't it?
743 # <@mst> DispatchTypes are loaded on demand anyway
744 # <@t0m> I'm thinking of things like _tree which is aliased to 'tree' with
745 # warnings otherwise shit breaks.. We're issuing warnings about the
746 # correct set of things which you shouldn't be calling..
748 # <@mst> basically, I don't see there's a need for a replacement for anything
749 # <@mst> it was never a good idea to call ->tree
750 # <@mst> nothingmuch was the only one who did AFAIK
751 # <@mst> and he admitted it was a hack ;)
753 # See also t/lib/TestApp/Plugin/AddDispatchTypes.pm
755 # Alias _method_name to method_name, add a before modifier to warn..
756 foreach my $public_method_name (qw/
758 registered_dispatch_types
763 my $private_method_name = '_' . $public_method_name;
764 my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time.
765 $meta->add_method($public_method_name, $meta->get_method($private_method_name));
767 my %package_hash; # Only warn once per method, per package. These are infrequent enough that
768 # I haven't provided a way to disable them, patches welcome.
769 $meta->add_before_method_modifier($public_method_name, sub {
770 my $class = caller(2);
772 $package_hash{$class}++ || do {
773 warn("Class $class is calling the deprecated method\n"
774 . " Catalyst::Dispatcher::$public_method_name,\n"
775 . " this will be removed in Catalyst 5.9\n");
780 # End 5.70 backwards compatibility hacks.
782 __PACKAGE__->meta->make_immutable;
790 Catalyst Contributors, see Catalyst.pm
794 This library is free software. You can redistribute it and/or modify it under
795 the same terms as Perl itself.