1 package Catalyst::Dispatcher;
4 use base 'Class::Accessor::Fast';
5 use Catalyst::Exception;
8 use Catalyst::ActionContainer;
9 use Catalyst::DispatchType::Regex;
10 use Catalyst::DispatchType::Default;
13 use Tree::Simple::Visitor::FindByPath;
16 use overload '""' => sub { return ref shift }, fallback => 1;
18 __PACKAGE__->mk_accessors(qw/actions tree dispatch_types/);
22 Catalyst::Dispatcher - The Catalyst Dispatcher
34 =item $self->detach( $c, $command [, \@arguments ] )
39 my ( $self, $c, $command, @args ) = @_;
40 $c->forward( $command, @args ) if $command;
41 die $Catalyst::DETACH;
44 =item $self->dispatch($c)
49 my ( $self, $c ) = @_;
53 my @containers = $self->get_containers( $c->namespace );
55 foreach my $name (qw/begin auto end/) {
57 # Go down the container list representing each part of the
58 # current namespace inheritance tree, grabbing the actions hash
59 # of the ActionContainer object and looking for actions of the
60 # appropriate name registered to the namespace
64 grep { exists $_->{$name} }
70 # Errors break the normal flow and the end action is instantly run
75 if ( my $begin = @{ $actions{begin} }[-1] ) {
77 $error++ if scalar @{ $c->error };
80 # Execute the auto chain
82 for my $auto ( @{ $actions{auto} } ) {
86 $error++ if scalar @{ $c->error };
87 last unless $c->state;
90 # Execute the action or last default
91 my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
94 $c->action->execute($c);
95 $error++ if scalar @{ $c->error };
100 if ( my $end = @{ $actions{end} }[-1] ) {
106 my $path = $c->req->path;
108 ? qq/Unknown resource "$path"/
109 : "No default action defined";
110 $c->log->error($error) if $c->debug;
115 =item $self->forward( $c, $command [, \@arguments ] )
125 $c->log->debug('Nothing to forward to') if $c->debug;
129 # Relative forwards from detach
130 my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher')
131 && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1);
133 my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
137 my $command_copy = $command;
139 unless ( $command_copy =~ s/^\/// ) {
141 Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || '';
142 $command_copy = "${namespace}/${command}";
145 unless ( $command_copy =~ /\// ) {
146 $results = $c->get_action( $command_copy, '/' );
150 DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) {
152 $results = $c->get_action( $tail, $1 );
155 push( @{$arguments}, @extra_args );
158 unshift( @extra_args, $tail );
162 unless ( @{$results} ) {
164 unless ( $c->components->{$command} ) {
166 qq/Couldn't forward to command "$command". Invalid action or component./;
168 $c->log->debug($error) if $c->debug;
172 my $class = $command;
173 my $method = shift || 'process';
175 if ( my $code = $c->components->{$class}->can($method) ) {
176 my $action = Catalyst::Action->new(
179 reverse => "$class->$method",
184 $results = [ [$action] ];
189 qq/Couldn't forward to "$class". Does not implement "$method"/;
191 $c->log->debug($error)
198 local $c->request->{arguments} = [ @{$arguments} ];
200 for my $result ( @{$results} ) {
201 $result->[0]->execute($c);
202 return if scalar @{ $c->error };
203 last unless $c->state;
209 =item $self->prepare_action($c)
214 my ( $self, $c ) = @_;
215 my $path = $c->req->path;
216 my @path = split /\//, $c->req->path;
217 $c->req->args( \my @args );
219 DESCEND: while (@path) {
220 $path = join '/', @path;
221 if ( my $result = ${ $c->get_action($path) }[0] ) {
223 $c->req->action($path);
224 $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
226 $c->req->match($path);
227 $c->action($result->[0]);
228 $c->namespace($result->[0]->prefix);
232 unless ( $c->action ) {
233 foreach my $type (@{$self->dispatch_types}) {
234 last DESCEND if $type->prepare_action($c, $path);
235 #last DESCEND if $c->action;
239 unshift @args, pop @path;
242 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
243 if ( $c->debug && @args );
246 =item $self->get_action( $c, $action, $namespace, $inherit )
251 my ( $self, $c, $action, $namespace, $inherit ) = @_;
252 return [] unless $action;
258 my @match = $self->get_containers( $namespace );
262 foreach my $child ($inherit ? @match: $match[-1]) {
263 my $node = $child->actions;
264 push(@results, [ $node->{$action} ]) if defined $node->{$action};
269 elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
274 =item $self->get_containers( $namespace )
279 my ( $self, $namespace ) = @_;
281 # If the namespace is / just return the root ActionContainer
283 return ($self->tree->getNodeValue) if $namespace eq '/';
285 # Use a visitor to recurse down the tree finding the ActionContainers
286 # for each namespace in the chain.
288 my $visitor = Tree::Simple::Visitor::FindByPath->new;
289 my @path = split('/', $namespace);
290 $visitor->setSearchPath( @path );
291 $self->tree->accept($visitor);
293 my @match = $visitor->getResults;
294 @match = ($self->tree) unless @match;
296 if (!defined $visitor->getResult) {
298 # If we don't manage to match, the visitor doesn't return the last
299 # node is matched, so foo/bar/baz would only find the 'foo' node,
300 # not the foo and foo/bar nodes as it should. This does another
301 # single-level search to see if that's the case, and the 'last unless'
302 # should catch any failures - or short-circuit this if this *is* a
303 # bug in the visitor and gets fixed.
305 my $extra = $path[(scalar @match) - 1];
307 $visitor->setSearchPath($extra);
308 $match[-1]->accept($visitor);
309 push(@match, $visitor->getResult) if defined $visitor->getResult;
312 return map { $_->getNodeValue } @match;
315 =item $self->set_action( $c, $action, $code, $namespace, $attrs )
320 my ( $self, $c, $method, $code, $namespace, $attrs ) = @_;
323 Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
328 for my $attr ( @{$attrs} ) {
329 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
330 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
331 elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) {
332 push @{ $flags{path} }, $1;
334 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
335 elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
336 push @{ $flags{regex} }, $2;
338 if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) {
339 if ( defined $value ) {
340 ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/);
342 push(@{$attributes{$key}}, $value);
346 if ( $flags{private} && ( keys %flags > 1 ) ) {
347 $c->log->debug( 'Bad action definition "'
348 . join( ' ', @{$attrs} )
349 . qq/" for "$namespace->$method"/ )
353 return unless keys %flags;
355 my $parent = $self->tree;
356 my $visitor = Tree::Simple::Visitor::FindByPath->new;
359 for my $part ( split '/', $prefix ) {
360 $visitor->setSearchPath($part);
361 $parent->accept($visitor);
362 my $child = $visitor->getResult;
366 # Create a new tree node and an ActionContainer to form
369 my $container = Catalyst::ActionContainer->new(
370 { part => $part, actions => {} });
371 $child = $parent->addChild( Tree::Simple->new($container) );
372 $visitor->setSearchPath($part);
373 $parent->accept($visitor);
374 $child = $visitor->getResult;
381 my $reverse = $prefix ? "$prefix/$method" : $method;
383 my $action = Catalyst::Action->new(
387 namespace => $namespace,
389 attributes => \%attributes,
393 # Set the method value
394 $parent->getNodeValue->actions->{$method} = $action;
397 for my $path ( @{ $flags{path} } ) {
400 if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 }
401 if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 }
404 $flags{path} = \@path;
406 if ( $flags{local} || $flags{global} ) {
407 push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
410 push( @{ $flags{path} }, "/$method" ) if $flags{global};
413 for my $path ( @{ $flags{path} } ) {
414 if ( $path =~ /^\// ) { $path =~ s/^\/// }
415 else { $path = $prefix ? "$prefix/$path" : $path }
416 $self->actions->{plain}->{$path} = $action;
419 foreach my $type ( @{ $self->dispatch_types } ) {
420 $type->register_action($c, $action);
424 =item $self->setup_actions( $class, $component )
429 my ( $self, $class ) = @_;
431 # These are the core structures
441 $self->dispatch_types([
442 map { "Catalyst::DispatchType::$_"->new }
443 qw/Regex Default/ ]);
446 my $container = Catalyst::ActionContainer->new(
447 { part => '/', actions => {} } );
448 $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
450 for my $comp ( keys %{ $class->components } ) {
452 # We only setup components that inherit from Catalyst::Base
453 next unless $comp->isa('Catalyst::Base');
455 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
456 my ( $code, $attrs ) = @{$action};
459 my @cache = ( $comp, @{"$comp\::ISA"} );
462 while ( my $namespace = shift @cache ) {
463 $namespaces{$namespace}++;
464 for my $isa ( @{"$comp\::ISA"} ) {
465 next if $namespaces{$isa};
471 for my $namespace ( keys %namespaces ) {
473 for my $sym ( values %{ $namespace . '::' } ) {
475 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
477 $name = *{$sym}{NAME};
478 $class->set_action( $name, $code, $comp, $attrs );
490 return unless $class->debug;
492 my $actions = $self->actions;
493 my $privates = Text::ASCIITable->new;
494 $privates->setCols( 'Private', 'Class' );
495 $privates->setColWidth( 'Private', 36, 1 );
496 $privates->setColWidth( 'Class', 37, 1 );
499 my ( $walker, $parent, $prefix ) = @_;
500 $prefix .= $parent->getNodeValue || '';
501 $prefix .= '/' unless $prefix =~ /\/$/;
502 my $node = $parent->getNodeValue->actions;
504 for my $action ( keys %{ $node } ) {
505 my $action_obj = $node->{$action};
506 $privates->addRow( "$prefix$action", $action_obj->namespace );
509 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
512 $walker->( $walker, $self->tree, '' );
513 $class->log->debug( "Loaded private actions:\n" . $privates->draw )
514 if ( @{ $privates->{tbl_rows} } );
516 my $publics = Text::ASCIITable->new;
517 $publics->setCols( 'Public', 'Private' );
518 $publics->setColWidth( 'Public', 36, 1 );
519 $publics->setColWidth( 'Private', 37, 1 );
521 for my $plain ( sort keys %{ $actions->{plain} } ) {
522 my $action = $actions->{plain}->{$plain};
523 $publics->addRow( "/$plain", "/$action" );
526 $class->log->debug( "Loaded public actions:\n" . $publics->draw )
527 if ( @{ $publics->{tbl_rows} } );
529 my $regexes = Text::ASCIITable->new;
530 $regexes->setCols( 'Regex', 'Private' );
531 $regexes->setColWidth( 'Regex', 36, 1 );
532 $regexes->setColWidth( 'Private', 37, 1 );
534 for my $regex ( sort keys %{ $actions->{regex} } ) {
535 my $action = $actions->{regex}->{$regex};
536 $regexes->addRow( $regex, "/$action" );
539 $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
540 if ( @{ $regexes->{tbl_rows} } );
547 Sebastian Riedel, C<sri@cpan.org>
551 This program is free software, you can redistribute it and/or modify it under
552 the same terms as Perl itself.