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 foreach my $type (@{$self->dispatch_types}) {
225 last DESCEND if $type->prepare_action($c, $path);
228 unshift @args, pop @path;
231 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
232 if ( $c->debug && @args );
235 =item $self->get_action( $c, $action, $namespace, $inherit )
240 my ( $self, $c, $action, $namespace, $inherit ) = @_;
241 return [] unless $action;
247 my @match = $self->get_containers( $namespace );
251 foreach my $child ($inherit ? @match: $match[-1]) {
252 my $node = $child->actions;
253 push(@results, [ $node->{$action} ]) if defined $node->{$action};
261 =item $self->get_containers( $namespace )
266 my ( $self, $namespace ) = @_;
268 # If the namespace is / just return the root ActionContainer
270 return ($self->tree->getNodeValue) if $namespace eq '/';
272 # Use a visitor to recurse down the tree finding the ActionContainers
273 # for each namespace in the chain.
275 my $visitor = Tree::Simple::Visitor::FindByPath->new;
276 my @path = split('/', $namespace);
277 $visitor->setSearchPath( @path );
278 $self->tree->accept($visitor);
280 my @match = $visitor->getResults;
281 @match = ($self->tree) unless @match;
283 if (!defined $visitor->getResult) {
285 # If we don't manage to match, the visitor doesn't return the last
286 # node is matched, so foo/bar/baz would only find the 'foo' node,
287 # not the foo and foo/bar nodes as it should. This does another
288 # single-level search to see if that's the case, and the 'last unless'
289 # should catch any failures - or short-circuit this if this *is* a
290 # bug in the visitor and gets fixed.
292 my $extra = $path[(scalar @match) - 1];
294 $visitor->setSearchPath($extra);
295 $match[-1]->accept($visitor);
296 push(@match, $visitor->getResult) if defined $visitor->getResult;
299 return map { $_->getNodeValue } @match;
302 =item $self->set_action( $c, $action, $code, $namespace, $attrs )
307 my ( $self, $c, $method, $code, $namespace, $attrs ) = @_;
310 Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
314 for my $attr ( @{$attrs} ) {
315 if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) {
316 if ( defined $value ) {
317 ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/);
319 push(@{$attributes{$key}}, $value);
323 if ( $attributes{Private} && ( keys %attributes > 1 ) ) {
324 $c->log->debug( 'Bad action definition "'
325 . join( ' ', @{$attrs} )
326 . qq/" for "$namespace->$method"/ )
330 return unless keys %attributes;
332 my $parent = $self->tree;
333 my $visitor = Tree::Simple::Visitor::FindByPath->new;
336 for my $part ( split '/', $prefix ) {
337 $visitor->setSearchPath($part);
338 $parent->accept($visitor);
339 my $child = $visitor->getResult;
343 # Create a new tree node and an ActionContainer to form
346 my $container = Catalyst::ActionContainer->new(
347 { part => $part, actions => {} });
348 $child = $parent->addChild( Tree::Simple->new($container) );
349 $visitor->setSearchPath($part);
350 $parent->accept($visitor);
351 $child = $visitor->getResult;
358 my $reverse = $prefix ? "$prefix/$method" : $method;
360 my $action = Catalyst::Action->new(
365 namespace => $namespace,
367 attributes => \%attributes,
371 # Set the method value
372 $parent->getNodeValue->actions->{$method} = $action;
374 foreach my $type ( @{ $self->dispatch_types } ) {
375 $type->register_action($c, $action);
379 =item $self->setup_actions( $class, $component )
384 my ( $self, $class ) = @_;
386 # These are the core structures
396 $self->dispatch_types([
397 map { "Catalyst::DispatchType::$_"->new }
398 qw/Path Regex Default/ ]);
401 my $container = Catalyst::ActionContainer->new(
402 { part => '/', actions => {} } );
403 $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
405 for my $comp ( keys %{ $class->components } ) {
407 # We only setup components that inherit from Catalyst::Base
408 next unless $comp->isa('Catalyst::Base');
410 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
411 my ( $code, $attrs ) = @{$action};
414 my @cache = ( $comp, @{"$comp\::ISA"} );
417 while ( my $namespace = shift @cache ) {
418 $namespaces{$namespace}++;
419 for my $isa ( @{"$comp\::ISA"} ) {
420 next if $namespaces{$isa};
426 for my $namespace ( keys %namespaces ) {
428 for my $sym ( values %{ $namespace . '::' } ) {
430 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
432 $name = *{$sym}{NAME};
433 $class->set_action( $name, $code, $comp, $attrs );
445 return unless $class->debug;
447 my $actions = $self->actions;
448 my $privates = Text::ASCIITable->new;
449 $privates->setCols( 'Private', 'Class' );
450 $privates->setColWidth( 'Private', 36, 1 );
451 $privates->setColWidth( 'Class', 37, 1 );
454 my ( $walker, $parent, $prefix ) = @_;
455 $prefix .= $parent->getNodeValue || '';
456 $prefix .= '/' unless $prefix =~ /\/$/;
457 my $node = $parent->getNodeValue->actions;
459 for my $action ( keys %{ $node } ) {
460 my $action_obj = $node->{$action};
461 $privates->addRow( "$prefix$action", $action_obj->namespace );
464 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
467 $walker->( $walker, $self->tree, '' );
468 $class->log->debug( "Loaded private actions:\n" . $privates->draw )
469 if ( @{ $privates->{tbl_rows} } );
471 my $publics = Text::ASCIITable->new;
472 $publics->setCols( 'Public', 'Private' );
473 $publics->setColWidth( 'Public', 36, 1 );
474 $publics->setColWidth( 'Private', 37, 1 );
476 for my $plain ( sort keys %{ $actions->{plain} } ) {
477 my $action = $actions->{plain}->{$plain};
478 $publics->addRow( "/$plain", "/$action" );
481 $class->log->debug( "Loaded public actions:\n" . $publics->draw )
482 if ( @{ $publics->{tbl_rows} } );
484 my $regexes = Text::ASCIITable->new;
485 $regexes->setCols( 'Regex', 'Private' );
486 $regexes->setColWidth( 'Regex', 36, 1 );
487 $regexes->setColWidth( 'Private', 37, 1 );
489 for my $regex ( sort keys %{ $actions->{regex} } ) {
490 my $action = $actions->{regex}->{$regex};
491 $regexes->addRow( $regex, "/$action" );
494 $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
495 if ( @{ $regexes->{tbl_rows} } );
502 Sebastian Riedel, C<sri@cpan.org>
506 This program is free software, you can redistribute it and/or modify it under
507 the same terms as Perl itself.