1 package Catalyst::Dispatcher;
4 use base 'Class::Accessor::Fast';
5 use Catalyst::Exception;
8 use Catalyst::ActionContainer;
9 use Catalyst::DispatchType::Default;
10 use Catalyst::DispatchType::Index;
11 use Text::SimpleTable;
13 use Tree::Simple::Visitor::FindByPath;
16 use overload '""' => sub { return ref shift }, fallback => 1;
18 __PACKAGE__->mk_accessors(
19 qw/tree dispatch_types registered_dispatch_types
20 method_action_class action_container_class/
23 # Preload these action types
24 our @PRELOAD = qw/Path Regex/;
26 # Postload these action types
27 our @POSTLOAD = qw/Index Default/;
31 Catalyst::Dispatcher - The Catalyst Dispatcher
43 =item $self->detach( $c, $command [, \@arguments ] )
48 my ( $self, $c, $command, @args ) = @_;
49 $c->forward( $command, @args ) if $command;
50 die $Catalyst::DETACH;
53 =item $self->dispatch($c)
58 my ( $self, $c ) = @_;
61 $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
65 my $path = $c->req->path;
67 ? qq/Unknown resource "$path"/
68 : "No default action defined";
69 $c->log->error($error) if $c->debug;
74 =item $self->forward( $c, $command [, \@arguments ] )
84 $c->log->debug('Nothing to forward to') if $c->debug;
89 my $arguments = $c->req->args;
90 if ( ref( $_[-1] ) eq 'ARRAY' ) {
97 unless ( ref $command ) {
98 my $command_copy = $command;
100 unless ( $command_copy =~ s/^\/// ) {
101 my $namespace = $c->stack->[-1]->namespace;
102 $command_copy = "${namespace}/${command}";
105 unless ( $command_copy =~ /\// ) {
106 $result = $c->get_action( $command_copy, '/' );
110 DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
112 $result = $c->get_action( $tail, $1 );
116 unshift( @{$arguments}, @extra_args );
119 unshift( @extra_args, $tail );
126 my $class = ref($command) || ref( $c->component($command) );
127 my $method = shift || 'process';
131 qq/Couldn't forward to command "$command". Invalid action or component./;
133 $c->log->debug($error) if $c->debug;
137 if ( my $code = $class->can($method) ) {
138 my $action = $self->method_action_class->new(
142 reverse => "$class->$method",
144 namespace => Catalyst::Utils::class2prefix(
145 $class, $c->config->{case_sensitive}
154 qq/Couldn't forward to "$class". Does not implement "$method"/;
156 $c->log->debug($error)
164 local $c->request->{arguments} = [ @{$arguments} ];
165 $result->execute($c);
167 else { $result->execute($c) }
172 =item $self->prepare_action($c)
177 my ( $self, $c ) = @_;
178 my $path = $c->req->path;
179 my @path = split /\//, $c->req->path;
180 $c->req->args( \my @args );
182 push( @path, '/' ) unless @path; # Root action
184 DESCEND: while (@path) {
185 $path = join '/', @path;
187 $path = '' if $path eq '/'; # Root action
189 # Check out dispatch types to see if any will handle the path at
192 foreach my $type ( @{ $self->dispatch_types } ) {
193 last DESCEND if $type->match( $c, $path );
196 # If not, move the last part path to args
198 unshift @args, pop @path;
201 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
202 if ( $c->debug && @args );
205 =item $self->get_action( $action, $namespace )
210 my ( $self, $name, $namespace ) = @_;
213 $namespace = '' if $namespace eq '/';
215 my @match = $self->get_containers($namespace);
217 return unless @match;
219 if ( my $action = $match[-1]->get_action($name) ) {
220 return $action if $action->namespace eq $namespace;
224 =item $self->get_actions( $c, $action, $namespace )
229 my ( $self, $c, $action, $namespace ) = @_;
230 return [] unless $action;
232 $namespace = '' if $namespace eq '/';
234 my @match = $self->get_containers($namespace);
236 return map { $_->get_action($action) } @match;
239 =item $self->get_containers( $namespace )
244 my ( $self, $namespace ) = @_;
246 # If the namespace is / just return the root ActionContainer
248 return ( $self->tree->getNodeValue )
249 if ( !$namespace || ( $namespace eq '/' ) );
251 # Use a visitor to recurse down the tree finding the ActionContainers
252 # for each namespace in the chain.
254 my $visitor = Tree::Simple::Visitor::FindByPath->new;
255 my @path = split( '/', $namespace );
256 $visitor->setSearchPath(@path);
257 $self->tree->accept($visitor);
259 my @match = $visitor->getResults;
260 @match = ( $self->tree ) unless @match;
262 if ( !defined $visitor->getResult ) {
264 # If we don't manage to match, the visitor doesn't return the last
265 # node is matched, so foo/bar/baz would only find the 'foo' node,
266 # not the foo and foo/bar nodes as it should. This does another
267 # single-level search to see if that's the case, and the 'last unless'
268 # should catch any failures - or short-circuit this if this *is* a
269 # bug in the visitor and gets fixed.
271 if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
272 $visitor->setSearchPath($extra);
273 $match[-1]->accept($visitor);
274 push( @match, $visitor->getResult ) if defined $visitor->getResult;
278 return map { $_->getNodeValue } @match;
281 =item $self->register( $c, $action )
286 my ( $self, $c, $action ) = @_;
288 my $registered = $self->registered_dispatch_types;
291 foreach my $key ( keys %{ $action->attributes } ) {
292 $priv++ if $key eq 'Private';
293 my $class = "Catalyst::DispatchType::$key";
294 unless ( $registered->{$class} ) {
295 eval "require $class";
296 push( @{ $self->dispatch_types }, $class->new ) unless $@;
297 $registered->{$class} = 1;
301 # Pass the action to our dispatch types so they can register it if reqd.
303 foreach my $type ( @{ $self->dispatch_types } ) {
304 $reg++ if $type->register( $c, $action );
307 return unless $reg + $priv;
309 my $namespace = $action->namespace;
310 my $parent = $self->tree;
311 my $visitor = Tree::Simple::Visitor::FindByPath->new;
314 for my $part ( split '/', $namespace ) {
315 $visitor->setSearchPath($part);
316 $parent->accept($visitor);
317 my $child = $visitor->getResult;
321 # Create a new tree node and an ActionContainer to form
325 Catalyst::ActionContainer->new(
326 { part => $part, actions => {} } );
327 $child = $parent->addChild( Tree::Simple->new($container) );
328 $visitor->setSearchPath($part);
329 $parent->accept($visitor);
330 $child = $visitor->getResult;
337 # Set the method value
338 $parent->getNodeValue->actions->{ $action->name } = $action;
341 =item $self->setup_actions( $class, $component )
346 my ( $self, $c ) = @_;
348 $self->dispatch_types( [] );
349 $self->registered_dispatch_types( {} );
350 $self->method_action_class('Catalyst::Action');
351 $self->action_container_class('Catalyst::ActionContainer');
353 # Preload action types
354 for my $type (@PRELOAD) {
355 my $class = "Catalyst::DispatchType::$type";
356 eval "require $class";
357 Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
359 push @{ $self->dispatch_types }, $class->new;
360 $self->registered_dispatch_types->{$class} = 1;
365 Catalyst::ActionContainer->new( { part => '/', actions => {} } );
366 $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
368 foreach my $comp ( values %{ $c->components } ) {
369 $comp->register_actions($c) if $comp->can('register_actions');
372 # Postload action types
373 for my $type (@POSTLOAD) {
374 my $class = "Catalyst::DispatchType::$type";
375 eval "require $class";
376 Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
378 push @{ $self->dispatch_types }, $class->new;
381 return unless $c->debug;
383 my $privates = Text::SimpleTable->new(
391 my ( $walker, $parent, $prefix ) = @_;
392 $prefix .= $parent->getNodeValue || '';
393 $prefix .= '/' unless $prefix =~ /\/$/;
394 my $node = $parent->getNodeValue->actions;
396 for my $action ( keys %{$node} ) {
397 my $action_obj = $node->{$action};
399 if ( ( $action =~ /^_.*/ )
400 && ( !$c->config->{show_internal_actions} ) );
401 $privates->row( "$prefix$action", $action_obj->class, $action );
405 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
408 $walker->( $walker, $self->tree, '' );
409 $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
412 # List all public actions
413 $_->list($c) for @{ $self->dispatch_types };
420 Sebastian Riedel, C<sri@cpan.org>
421 Matt S Trout, C<mst@shadowcatsystems.co.uk>
425 This program is free software, you can redistribute it and/or modify it under
426 the same terms as Perl itself.