1 package Catalyst::Dispatcher;
4 use base 'Class::Accessor::Fast';
5 use Catalyst::Exception;
10 use Tree::Simple::Visitor::FindByPath;
13 use overload '""' => sub { return ref shift }, fallback => 1;
15 __PACKAGE__->mk_accessors(qw/actions tree/);
19 Catalyst::Dispatcher - The Catalyst Dispatcher
31 =item $self->detach( $c, $command [, \@arguments ] )
36 my ( $self, $c, $command, @args ) = @_;
37 $c->forward( $command, @args ) if $command;
38 die $Catalyst::DETACH;
41 =item $self->dispatch($c)
46 my ( $self, $c ) = @_;
47 my $action = $c->req->action;
49 $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
50 if $action eq 'default';
53 if ( my $result = $c->get_action($action) ) {
55 Catalyst::Utils::class2prefix( $result->[0]->[0]->namespace,
56 $c->config->{case_sensitive} );
60 my $default = $action eq 'default' ? $namespace : undef;
61 my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
66 # Errors break the normal flow and the end action is instantly run
71 if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
72 $begin->[0]->execute($c);
73 $error++ if scalar @{ $c->error };
76 # Execute the auto chain
78 for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
81 $auto->[0]->execute($c);
82 $error++ if scalar @{ $c->error };
83 last unless $c->state;
86 # Execute the action or last default
87 my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
88 if ( ( my $action = $c->req->action ) && $mkay ) {
91 @{ $c->get_action( $action, $default, 1 ) }[-1] )
93 $result->[0]->execute($c);
94 $error++ if scalar @{ $c->error };
100 if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
101 $end->[0]->execute($c);
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",
183 $results = [ [$action] ];
188 qq/Couldn't forward to "$class". Does not implement "$method"/;
190 $c->log->debug($error)
197 local $c->request->{arguments} = [ @{$arguments} ];
199 for my $result ( @{$results} ) {
200 $result->[0]->execute($c);
201 return if scalar @{ $c->error };
202 last unless $c->state;
208 =item $self->prepare_action($c)
213 my ( $self, $c ) = @_;
214 my $path = $c->req->path;
215 my @path = split /\//, $c->req->path;
216 $c->req->args( \my @args );
219 $path = join '/', @path;
220 if ( my $result = ${ $c->get_action($path) }[0] ) {
224 my $match = $result->[1];
225 my @snippets = @{ $result->[2] };
227 qq/Requested action is "$path" and matched "$match"/)
230 'Snippets are "' . join( ' ', @snippets ) . '"' )
231 if ( $c->debug && @snippets );
232 $c->req->action($match);
233 $c->req->snippets( \@snippets );
237 $c->req->action($path);
238 $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
241 $c->req->match($path);
244 unshift @args, pop @path;
247 unless ( $c->req->action ) {
248 $c->req->action('default');
252 $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
253 if ( $c->debug && @args );
256 =item $self->get_action( $c, $action, $namespace, $inherit )
261 my ( $self, $c, $action, $namespace, $inherit ) = @_;
262 return [] unless $action;
267 $namespace = '' if $namespace eq '/';
268 my $parent = $self->tree;
273 $self->actions->{private}->{ $parent->getUID }->{$action};
274 push @results, [$result] if $result;
275 my $visitor = Tree::Simple::Visitor::FindByPath->new;
278 for my $part ( split '/', $namespace ) {
279 $visitor->setSearchPath($part);
280 $parent->accept($visitor);
281 my $child = $visitor->getResult;
282 my $uid = $child->getUID if $child;
283 my $match = $self->actions->{private}->{$uid}->{$action}
285 push @results, [$match] if $match;
299 my $visitor = Tree::Simple::Visitor::FindByPath->new;
300 $visitor->setSearchPath( split '/', $namespace );
301 $parent->accept($visitor);
302 my $child = $visitor->getResult;
303 my $uid = $child->getUID if $child;
304 my $match = $self->actions->{private}->{$uid}->{$action}
306 push @results, [$match] if $match;
311 $self->actions->{private}->{ $parent->getUID }->{$action};
312 push @results, [$result] if $result;
319 elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
320 elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
324 for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
325 my $name = $self->actions->{compiled}->[$i]->[0];
326 my $regex = $self->actions->{compiled}->[$i]->[1];
328 if ( my @snippets = ( $action =~ $regex ) ) {
330 [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
338 =item $self->set_action( $c, $action, $code, $namespace, $attrs )
343 my ( $self, $c, $method, $code, $namespace, $attrs ) = @_;
346 Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
350 for my $attr ( @{$attrs} ) {
351 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
352 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
353 elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) {
354 push @{ $flags{path} }, $1;
356 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
357 elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
358 push @{ $flags{regex} }, $2;
362 if ( $flags{private} && ( keys %flags > 1 ) ) {
363 $c->log->debug( 'Bad action definition "'
364 . join( ' ', @{$attrs} )
365 . qq/" for "$namespace->$method"/ )
369 return unless keys %flags;
371 my $parent = $self->tree;
372 my $visitor = Tree::Simple::Visitor::FindByPath->new;
374 for my $part ( split '/', $prefix ) {
375 $visitor->setSearchPath($part);
376 $parent->accept($visitor);
377 my $child = $visitor->getResult;
380 $child = $parent->addChild( Tree::Simple->new($part) );
381 $visitor->setSearchPath($part);
382 $parent->accept($visitor);
383 $child = $visitor->getResult;
389 my $reverse = $prefix ? "$prefix/$method" : $method;
391 my $action = Catalyst::Action->new(
395 namespace => $namespace,
399 my $uid = $parent->getUID;
400 $self->actions->{private}->{$uid}->{$method} = $action;
403 for my $path ( @{ $flags{path} } ) {
406 if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 }
407 if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 }
410 $flags{path} = \@path;
413 for my $regex ( @{ $flags{regex} } ) {
416 if ( $regex =~ /^\s*'(.*)'\s*$/ ) { $regex = $1 }
417 if ( $regex =~ /^\s*"(.*)"\s*$/ ) { $regex = $1 }
420 $flags{regex} = \@regex;
422 if ( $flags{local} || $flags{global} ) {
423 push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
426 push( @{ $flags{path} }, "/$method" ) if $flags{global};
429 for my $path ( @{ $flags{path} } ) {
430 if ( $path =~ /^\// ) { $path =~ s/^\/// }
431 else { $path = $prefix ? "$prefix/$path" : $path }
432 $self->actions->{plain}->{$path} = $action;
435 for my $regex ( @{ $flags{regex} } ) {
436 push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
437 $self->actions->{regex}->{$regex} = $action;
441 =item $self->setup_actions( $class, $component )
446 my ( $self, $class ) = @_;
448 # These are the core structures
459 $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
461 for my $comp ( keys %{ $class->components } ) {
463 # We only setup components that inherit from Catalyst::Base
464 next unless $comp->isa('Catalyst::Base');
466 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
467 my ( $code, $attrs ) = @{$action};
470 my @cache = ( $comp, @{"$comp\::ISA"} );
473 while ( my $namespace = shift @cache ) {
474 $namespaces{$namespace}++;
475 for my $isa ( @{"$comp\::ISA"} ) {
476 next if $namespaces{$isa};
482 for my $namespace ( keys %namespaces ) {
484 for my $sym ( values %{ $namespace . '::' } ) {
486 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
488 $name = *{$sym}{NAME};
489 $class->set_action( $name, $code, $comp, $attrs );
501 return unless $class->debug;
503 my $actions = $self->actions;
504 my $privates = Text::ASCIITable->new;
505 $privates->setCols( 'Private', 'Class' );
506 $privates->setColWidth( 'Private', 36, 1 );
507 $privates->setColWidth( 'Class', 37, 1 );
510 my ( $walker, $parent, $prefix ) = @_;
511 $prefix .= $parent->getNodeValue || '';
512 $prefix .= '/' unless $prefix =~ /\/$/;
513 my $uid = $parent->getUID;
515 for my $action ( keys %{ $actions->{private}->{$uid} } ) {
516 my $action_obj = $actions->{private}->{$uid}->{$action};
517 $privates->addRow( "$prefix$action", $action_obj->namespace );
520 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
523 $walker->( $walker, $self->tree, '' );
524 $class->log->debug( "Loaded private actions:\n" . $privates->draw )
525 if ( @{ $privates->{tbl_rows} } );
527 my $publics = Text::ASCIITable->new;
528 $publics->setCols( 'Public', 'Private' );
529 $publics->setColWidth( 'Public', 36, 1 );
530 $publics->setColWidth( 'Private', 37, 1 );
532 for my $plain ( sort keys %{ $actions->{plain} } ) {
533 my $action = $actions->{plain}->{$plain};
534 $publics->addRow( "/$plain", "/$action" );
537 $class->log->debug( "Loaded public actions:\n" . $publics->draw )
538 if ( @{ $publics->{tbl_rows} } );
540 my $regexes = Text::ASCIITable->new;
541 $regexes->setCols( 'Regex', 'Private' );
542 $regexes->setColWidth( 'Regex', 36, 1 );
543 $regexes->setColWidth( 'Private', 37, 1 );
545 for my $regex ( sort keys %{ $actions->{regex} } ) {
546 my $action = $actions->{regex}->{$regex};
547 $regexes->addRow( $regex, "/$action" );
550 $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
551 if ( @{ $regexes->{tbl_rows} } );
558 Sebastian Riedel, C<sri@cpan.org>
562 This program is free software, you can redistribute it and/or modify it under
563 the same terms as Perl itself.