1 package Catalyst::Dispatcher;
4 use base 'Class::Accessor::Fast';
5 use Catalyst::Exception;
8 use Catalyst::ActionContainer;
9 use Catalyst::DispatchType::Path;
10 use Catalyst::DispatchType::Regex;
11 use Catalyst::DispatchType::Default;
14 use Tree::Simple::Visitor::FindByPath;
17 use overload '""' => sub { return ref shift }, fallback => 1;
19 __PACKAGE__->mk_accessors(qw/actions tree dispatch_types/);
23 Catalyst::Dispatcher - The Catalyst Dispatcher
35 =item $self->detach( $c, $command [, \@arguments ] )
40 my ( $self, $c, $command, @args ) = @_;
41 $c->forward( $command, @args ) if $command;
42 die $Catalyst::DETACH;
45 =item $self->dispatch($c)
50 my ( $self, $c ) = @_;
54 my @containers = $self->get_containers( $c->namespace );
56 foreach my $name (qw/begin auto end/) {
58 # Go down the container list representing each part of the
59 # current namespace inheritance tree, grabbing the actions hash
60 # of the ActionContainer object and looking for actions of the
61 # appropriate name registered to the namespace
65 grep { exists $_->{$name} }
71 # Errors break the normal flow and the end action is instantly run
76 if ( my $begin = @{ $actions{begin} }[-1] ) {
78 $error++ if scalar @{ $c->error };
81 # Execute the auto chain
83 for my $auto ( @{ $actions{auto} } ) {
87 $error++ if scalar @{ $c->error };
88 last unless $c->state;
91 # Execute the action or last default
92 my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
95 $c->action->execute($c);
96 $error++ if scalar @{ $c->error };
101 if ( my $end = @{ $actions{end} }[-1] ) {
107 my $path = $c->req->path;
109 ? qq/Unknown resource "$path"/
110 : "No default action defined";
111 $c->log->error($error) if $c->debug;
116 =item $self->forward( $c, $command [, \@arguments ] )
126 $c->log->debug('Nothing to forward to') if $c->debug;
130 # Relative forwards from detach
131 my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher')
132 && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1);
134 my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
138 my $command_copy = $command;
140 unless ( $command_copy =~ s/^\/// ) {
142 Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || '';
143 $command_copy = "${namespace}/${command}";
146 unless ( $command_copy =~ /\// ) {
147 $results = $c->get_action( $command_copy, '/' );
151 DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
153 $results = $c->get_action( $tail, $1 );
156 push( @{$arguments}, @extra_args );
159 unshift( @extra_args, $tail );
163 unless ( @{$results} ) {
165 unless ( $c->components->{$command} ) {
167 qq/Couldn't forward to command "$command". Invalid action or component./;
169 $c->log->debug($error) if $c->debug;
173 my $class = $command;
174 my $method = shift || 'process';
176 if ( my $code = $c->components->{$class}->can($method) ) {
177 my $action = Catalyst::Action->new(
181 reverse => "$class->$method",
186 $results = [ [$action] ];
191 qq/Couldn't forward to "$class". Does not implement "$method"/;
193 $c->log->debug($error)
200 local $c->request->{arguments} = [ @{$arguments} ];
202 for my $result ( @{$results} ) {
203 $result->[0]->execute($c);
204 return if scalar @{ $c->error };
205 last unless $c->state;
211 =item $self->prepare_action($c)
216 my ( $self, $c ) = @_;
217 my $path = $c->req->path;
218 my @path = split /\//, $c->req->path;
219 $c->req->args( \my @args );
221 DESCEND: while (@path) {
222 $path = join '/', @path;
224 # Check out dispatch types to see if any will handle the path at
227 foreach my $type (@{$self->dispatch_types}) {
228 last DESCEND if $type->prepare_action($c, $path);
231 # If not, move the last part path to args
233 unshift @args, pop @path;
236 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
237 if ( $c->debug && @args );
240 =item $self->get_action( $c, $action, $namespace, $inherit )
245 my ( $self, $c, $action, $namespace, $inherit ) = @_;
246 return [] unless $action;
252 my @match = $self->get_containers( $namespace );
256 foreach my $child ($inherit ? @match: $match[-1]) {
257 my $node = $child->actions;
258 push(@results, [ $node->{$action} ]) if defined $node->{$action};
266 =item $self->get_containers( $namespace )
271 my ( $self, $namespace ) = @_;
273 # If the namespace is / just return the root ActionContainer
275 return ($self->tree->getNodeValue) if $namespace eq '/';
277 # Use a visitor to recurse down the tree finding the ActionContainers
278 # for each namespace in the chain.
280 my $visitor = Tree::Simple::Visitor::FindByPath->new;
281 my @path = split('/', $namespace);
282 $visitor->setSearchPath( @path );
283 $self->tree->accept($visitor);
285 my @match = $visitor->getResults;
286 @match = ($self->tree) unless @match;
288 if (!defined $visitor->getResult) {
290 # If we don't manage to match, the visitor doesn't return the last
291 # node is matched, so foo/bar/baz would only find the 'foo' node,
292 # not the foo and foo/bar nodes as it should. This does another
293 # single-level search to see if that's the case, and the 'last unless'
294 # should catch any failures - or short-circuit this if this *is* a
295 # bug in the visitor and gets fixed.
297 my $extra = $path[(scalar @match) - 1];
299 $visitor->setSearchPath($extra);
300 $match[-1]->accept($visitor);
301 push(@match, $visitor->getResult) if defined $visitor->getResult;
304 return map { $_->getNodeValue } @match;
307 =item $self->set_action( $c, $action, $code, $namespace, $attrs )
312 my ( $self, $c, $method, $code, $namespace, $attrs ) = @_;
315 Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
319 for my $attr ( @{$attrs} ) {
321 # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
323 if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) {
324 if ( defined $value ) {
325 ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/);
327 push(@{$attributes{$key}}, $value);
331 if ( $attributes{Private} && ( keys %attributes > 1 ) ) {
332 $c->log->debug( 'Bad action definition "'
333 . join( ' ', @{$attrs} )
334 . qq/" for "$namespace->$method"/ )
338 return unless keys %attributes;
340 my $parent = $self->tree;
341 my $visitor = Tree::Simple::Visitor::FindByPath->new;
344 for my $part ( split '/', $prefix ) {
345 $visitor->setSearchPath($part);
346 $parent->accept($visitor);
347 my $child = $visitor->getResult;
351 # Create a new tree node and an ActionContainer to form
354 my $container = Catalyst::ActionContainer->new(
355 { part => $part, actions => {} });
356 $child = $parent->addChild( Tree::Simple->new($container) );
357 $visitor->setSearchPath($part);
358 $parent->accept($visitor);
359 $child = $visitor->getResult;
366 my $reverse = $prefix ? "$prefix/$method" : $method;
368 my $action = Catalyst::Action->new(
373 namespace => $namespace,
375 attributes => \%attributes,
379 # Set the method value
380 $parent->getNodeValue->actions->{$method} = $action;
382 # Pass the action to our dispatch types so they can register it if reqd.
383 foreach my $type ( @{ $self->dispatch_types } ) {
384 $type->register_action($c, $action);
388 =item $self->setup_actions( $class, $component )
393 my ( $self, $class ) = @_;
395 # These are the core structures
405 $self->dispatch_types([
406 map { "Catalyst::DispatchType::$_"->new }
407 qw/Path Regex Default/ ]);
410 my $container = Catalyst::ActionContainer->new(
411 { part => '/', actions => {} } );
412 $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
414 for my $comp ( keys %{ $class->components } ) {
416 # We only setup components that inherit from Catalyst::Base
417 next unless $comp->isa('Catalyst::Base');
419 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
420 my ( $code, $attrs ) = @{$action};
423 my @cache = ( $comp, @{"$comp\::ISA"} );
426 while ( my $namespace = shift @cache ) {
427 $namespaces{$namespace}++;
428 for my $isa ( @{"$comp\::ISA"} ) {
429 next if $namespaces{$isa};
435 for my $namespace ( keys %namespaces ) {
437 for my $sym ( values %{ $namespace . '::' } ) {
439 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
441 $name = *{$sym}{NAME};
442 $class->set_action( $name, $code, $comp, $attrs );
454 return unless $class->debug;
456 my $actions = $self->actions;
457 my $privates = Text::ASCIITable->new;
458 $privates->setCols( 'Private', 'Class' );
459 $privates->setColWidth( 'Private', 36, 1 );
460 $privates->setColWidth( 'Class', 37, 1 );
463 my ( $walker, $parent, $prefix ) = @_;
464 $prefix .= $parent->getNodeValue || '';
465 $prefix .= '/' unless $prefix =~ /\/$/;
466 my $node = $parent->getNodeValue->actions;
468 for my $action ( keys %{ $node } ) {
469 my $action_obj = $node->{$action};
470 $privates->addRow( "$prefix$action", $action_obj->namespace );
473 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
476 $walker->( $walker, $self->tree, '' );
477 $class->log->debug( "Loaded private actions:\n" . $privates->draw )
478 if ( @{ $privates->{tbl_rows} } );
480 my $publics = Text::ASCIITable->new;
481 $publics->setCols( 'Public', 'Private' );
482 $publics->setColWidth( 'Public', 36, 1 );
483 $publics->setColWidth( 'Private', 37, 1 );
485 for my $plain ( sort keys %{ $actions->{plain} } ) {
486 my $action = $actions->{plain}->{$plain};
487 $publics->addRow( "/$plain", "/$action" );
490 $class->log->debug( "Loaded public actions:\n" . $publics->draw )
491 if ( @{ $publics->{tbl_rows} } );
493 my $regexes = Text::ASCIITable->new;
494 $regexes->setCols( 'Regex', 'Private' );
495 $regexes->setColWidth( 'Regex', 36, 1 );
496 $regexes->setColWidth( 'Private', 37, 1 );
498 for my $regex ( sort keys %{ $actions->{regex} } ) {
499 my $action = $actions->{regex}->{$regex};
500 $regexes->addRow( $regex, "/$action" );
503 $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
504 if ( @{ $regexes->{tbl_rows} } );
511 Sebastian Riedel, C<sri@cpan.org>
515 This program is free software, you can redistribute it and/or modify it under
516 the same terms as Perl itself.