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;
325 if( my $code = $c->application->can($method) ){
326 return $self->_method_action_class->new(
330 reverse => "$component_or_class->$method",
331 class => $component_or_class,
332 namespace => Catalyst::Utils::class2prefix(
339 my $component = $self->_find_component($c, $component_or_class);
340 my $component_class = blessed $component || return 0;
342 if (my $code = $component_class->can('action_for')) {
343 my $possible_action = $component->$code($method);
344 return $possible_action if $possible_action;
347 if ( my $code = $component_class->can($method) ) {
348 return $self->_method_action_class->new(
352 reverse => "$component_class->$method",
353 class => $component_class,
354 namespace => Catalyst::Utils::class2prefix( $component_class ),
360 qq/Couldn't forward to "$component_class". Does not implement "$method"/;
362 $c->log->debug($error)
368 =head2 $self->prepare_action($c)
370 Find an dispatch type that matches $c->req->path, and set args from it.
375 my ( $self, $c ) = @_;
377 my $path = $req->path;
378 my @path = split /\//, $req->path;
379 $req->args( \my @args );
381 unshift( @path, '' ); # Root action
383 DESCEND: while (@path) {
384 $path = join '/', @path;
387 # Check out dispatch types to see if any will handle the path at
390 foreach my $type ( @{ $self->dispatch_types } ) {
391 last DESCEND if $type->match( $c, $path );
394 # If not, move the last part path to args
395 my $arg = pop(@path);
396 $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
400 s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
402 $c->log->debug( 'Path is "' . $req->match . '"' )
403 if ( $c->debug && defined $req->match && length $req->match );
405 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
406 if ( $c->debug && @args );
409 =head2 $self->get_action( $action, $namespace )
411 returns a named action from a given namespace.
416 my ( $self, $name, $namespace ) = @_;
419 $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
421 return $self->_action_hash->{"${namespace}/${name}"};
424 =head2 $self->get_action_by_path( $path );
426 Returns the named action by its full private path.
430 sub get_action_by_path {
431 my ( $self, $path ) = @_;
433 $path = "/$path" unless $path =~ /\//;
434 $self->_action_hash->{$path};
437 =head2 $self->get_actions( $c, $action, $namespace )
442 my ( $self, $c, $action, $namespace ) = @_;
443 return [] unless $action;
445 $namespace = join( "/", grep { length } split '/', $namespace || "" );
447 my @match = $self->get_containers($namespace);
449 return map { $_->get_action($action) } @match;
452 =head2 $self->get_containers( $namespace )
454 Return all the action containers for a given namespace, inclusive
459 my ( $self, $namespace ) = @_;
461 $namespace = '' if $namespace eq '/';
465 if ( length $namespace ) {
467 push @containers, $self->_container_hash->{$namespace};
468 } while ( $namespace =~ s#/[^/]+$## );
471 return reverse grep { defined } @containers, $self->_container_hash->{''};
474 =head2 $self->uri_for_action($action, \@captures)
476 Takes a Catalyst::Action object and action parameters and returns a URI
477 part such that if $c->req->path were this URI part, this action would be
478 dispatched to with $c->req->captures set to the supplied arrayref.
480 If the action object is not available for external dispatch or the dispatcher
481 cannot determine an appropriate URI, this method will return undef.
486 my ( $self, $action, $captures) = @_;
488 foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
489 my $uri = $dispatch_type->uri_for_action( $action, $captures );
490 return( $uri eq '' ? '/' : $uri )
498 expand an action into a full representation of the dispatch.
499 mostly useful for chained, other actions will just return a
505 my ($self, $action) = @_;
507 foreach my $dispatch_type (@{ $self->dispatch_types }) {
508 my $expanded = $dispatch_type->expand_action($action);
509 return $expanded if $expanded;
515 =head2 $self->register( $c, $action )
517 Make sure all required dispatch types for this action are loaded, then
518 pass the action to our dispatch types so they can register it if required.
519 Also, set up the tree with the action containers.
524 my ( $self, $c, $action ) = @_;
526 my $registered = $self->_registered_dispatch_types;
528 #my $priv = 0; #seems to be unused
529 foreach my $key ( keys %{ $action->attributes } ) {
530 next if $key eq 'Private';
531 my $class = "Catalyst::DispatchType::$key";
532 unless ( $registered->{$class} ) {
533 # FIXME - Some error checking and re-throwing needed here, as
534 # we eat exceptions loading dispatch types.
535 eval { Class::MOP::load_class($class) };
536 push( @{ $self->dispatch_types }, $class->new ) unless $@;
537 $registered->{$class} = 1;
541 my @dtypes = @{ $self->dispatch_types };
543 my @low_precedence_dtypes;
545 for my $type ( @dtypes ) {
546 if ($type->_is_low_precedence) {
547 push @low_precedence_dtypes, $type;
549 push @normal_dtypes, $type;
553 # Pass the action to our dispatch types so they can register it if reqd.
554 my $was_registered = 0;
555 foreach my $type ( @normal_dtypes ) {
556 $was_registered = 1 if $type->register( $c, $action );
559 if (not $was_registered) {
560 foreach my $type ( @low_precedence_dtypes ) {
561 $type->register( $c, $action );
565 my $namespace = $action->namespace;
566 my $name = $action->name;
568 my $container = $self->_find_or_create_action_container($namespace);
570 # Set the method value
571 $container->add_action($action);
573 $self->_action_hash->{"$namespace/$name"} = $action;
574 $self->_container_hash->{$namespace} = $container;
577 sub _find_or_create_action_container {
578 my ( $self, $namespace ) = @_;
580 my $tree ||= $self->_tree;
582 return $tree->getNodeValue unless $namespace;
584 my @namespace = split '/', $namespace;
585 return $self->_find_or_create_namespace_node( $tree, @namespace )
589 sub _find_or_create_namespace_node {
590 my ( $self, $parent, $part, @namespace ) = @_;
592 return $parent unless $part;
595 ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
598 my $container = Catalyst::ActionContainer->new($part);
599 $parent->addChild( $child = Tree::Simple->new($container) );
602 $self->_find_or_create_namespace_node( $child, @namespace );
605 =head2 $self->setup_actions( $class, $context )
607 Loads all of the preload dispatch types, registers their actions and then
608 loads all of the postload dispatch types, and iterates over the tree of
609 actions, displaying the debug information if appropriate.
614 my ( $self, $c ) = @_;
617 $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
618 @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
620 foreach my $comp ( values %{ $c->components } ) {
621 $comp->register_actions($c) if $comp->can('register_actions');
624 $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
626 return unless $c->debug;
627 $self->_display_action_tables($c);
630 sub _display_action_tables {
633 my $avail_width = Catalyst::Utils::term_width() - 12;
634 my $col1_width = ($avail_width * .25) < 20 ? 20 : int($avail_width * .25);
635 my $col2_width = ($avail_width * .50) < 36 ? 36 : int($avail_width * .50);
636 my $col3_width = $avail_width - $col1_width - $col2_width;
637 my $privates = Text::SimpleTable->new(
638 [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, 'Method' ]
643 my ( $walker, $parent, $prefix ) = @_;
644 $prefix .= $parent->getNodeValue || '';
645 $prefix .= '/' unless $prefix =~ /\/$/;
646 my $node = $parent->getNodeValue->actions;
648 for my $action ( keys %{$node} ) {
649 my $action_obj = $node->{$action};
651 if ( ( $action =~ /^_.*/ )
652 && ( !$c->config->{show_internal_actions} ) );
653 $privates->row( "$prefix$action", $action_obj->class, $action );
657 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
660 $walker->( $walker, $self->_tree, '' );
661 $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
664 # List all public actions
665 $_->list($c) for @{ $self->dispatch_types };
668 sub _load_dispatch_types {
669 my ( $self, @types ) = @_;
672 # Preload action types
673 for my $type (@types) {
674 # first param is undef because we cannot get the appclass
675 my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type);
677 eval { Class::MOP::load_class($class) };
678 Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
680 push @{ $self->dispatch_types }, $class->new;
682 push @loaded, $class;
688 =head2 $self->dispatch_type( $type )
690 Get the DispatchType object of the relevant type, i.e. passing C<$type> of
691 C<Chained> would return a L<Catalyst::DispatchType::Chained> object (assuming
692 of course it's being used.)
697 my ($self, $name) = @_;
699 # first param is undef because we cannot get the appclass
700 $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name);
702 for (@{ $self->dispatch_types }) {
703 return $_ if ref($_) eq $name;
710 # 5.70 backwards compatibility hacks.
712 # Various plugins (e.g. Plugin::Server and Plugin::Authorization::ACL)
713 # need the methods here which *should* be private..
715 # You should be able to use get_actions or get_containers appropriately
716 # instead of relying on these methods which expose implementation details
717 # of the dispatcher..
719 # IRC backlog included below, please come ask if this doesn't work for you.
721 # <@t0m> 5.80, the state of. There are things in the dispatcher which have
722 # been deprecated, that we yell at anyone for using, which there isn't
723 # a good alternative for yet..
724 # <@mst> er, get_actions/get_containers provides that doesn't it?
725 # <@mst> DispatchTypes are loaded on demand anyway
726 # <@t0m> I'm thinking of things like _tree which is aliased to 'tree' with
727 # warnings otherwise shit breaks.. We're issuing warnings about the
728 # correct set of things which you shouldn't be calling..
730 # <@mst> basically, I don't see there's a need for a replacement for anything
731 # <@mst> it was never a good idea to call ->tree
732 # <@mst> nothingmuch was the only one who did AFAIK
733 # <@mst> and he admitted it was a hack ;)
735 # See also t/lib/TestApp/Plugin/AddDispatchTypes.pm
737 # Alias _method_name to method_name, add a before modifier to warn..
738 foreach my $public_method_name (qw/
740 registered_dispatch_types
745 my $private_method_name = '_' . $public_method_name;
746 my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time.
747 $meta->add_method($public_method_name, $meta->get_method($private_method_name));
749 my %package_hash; # Only warn once per method, per package. These are infrequent enough that
750 # I haven't provided a way to disable them, patches welcome.
751 $meta->add_before_method_modifier($public_method_name, sub {
752 my $class = caller(2);
754 $package_hash{$class}++ || do {
755 warn("Class $class is calling the deprecated method\n"
756 . " Catalyst::Dispatcher::$public_method_name,\n"
757 . " this will be removed in Catalyst 5.9X\n");
762 # End 5.70 backwards compatibility hacks.
764 __PACKAGE__->meta->make_immutable;
772 Catalyst Contributors, see Catalyst.pm
776 This library is free software. You can redistribute it and/or modify it under
777 the same terms as Perl itself.