1 package Catalyst::Dispatcher;
4 use base 'Class::Data::Inheritable';
5 use Catalyst::Exception;
9 use Tree::Simple::Visitor::FindByPath;
11 __PACKAGE__->mk_classdata($_) for qw/actions tree/;
15 Catalyst::Dispatcher - The Catalyst Dispatcher
27 =item $c->detach( $command [, \@arguments ] )
29 Like C<forward> but doesn't return.
34 my ( $c, $command, @args ) = @_;
35 $c->forward( $command, @args ) if $command;
36 # die with DETACH signal, which will be caught in dispatching.
37 die $Catalyst::Engine::DETACH;
42 Dispatch request to actions.
48 my $action = $c->req->action;
50 $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
51 if $action eq 'default';
54 if ( my $result = $c->get_action($action) ) {
55 $namespace = Catalyst::Utils::class2prefix( $result->[0]->[0]->[0],
56 $c->config->{case_sensitive} );
60 my $default = $action eq 'default' ? $namespace : undef;
61 my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
68 if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
69 $c->execute( @{ $begin->[0] } );
70 return if scalar @{ $c->error };
73 # Execute the auto chain
75 for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
77 $c->execute( @{ $auto->[0] } );
78 return if scalar @{ $c->error };
79 last unless $c->state;
82 # Execute the action or last default
83 my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
84 if ( ( my $action = $c->req->action ) && $mkay ) {
85 if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
87 $c->execute( @{ $result->[0] } );
92 if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
93 $c->execute( @{ $end->[0] } );
94 return if scalar @{ $c->error };
97 my $path = $c->req->path;
99 ? qq/Unknown resource "$path"/
100 : "No default action defined";
101 $c->log->error($error) if $c->debug;
106 =item $c->forward( $command [, \@arguments ] )
108 Forward processing to a private action or a method from a class.
109 If you define a class without method it will default to process().
110 also takes an optional arrayref containing arguments to be passed
111 to the new function. $c->req->args will be reset upon returning
115 $c->forward('index');
116 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
117 $c->forward('MyApp::View::TT');
126 $c->log->debug('Nothing to forward to') if $c->debug;
130 # Relative forwards from detach
131 my $caller = ( caller(0) )[0]->isa('Catalyst::Dispatcher')
132 && ( ( caller(1) )[3] =~ /::detach$/ ) ? caller(1) : caller(0);
135 my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
137 if ( $command =~ /^\// ) {
138 $command =~ /^\/(.*)\/(\w+)$/;
139 $namespace = $1 || '/';
140 $command = $2 || $command;
146 Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} )
150 my $results = $c->get_action( $command, $namespace );
152 unless ( @{$results} ) {
154 unless ( defined( $c->components->{$command} ) ) {
156 qq/Couldn't forward to command "$command". Invalid action or component./;
158 $c->log->debug($error) if $c->debug;
162 my $class = $command;
163 my $method = shift || 'process';
165 if ( my $code = $c->components->{$class}->can($method) ) {
166 $c->actions->{reverse}->{"$code"} = "$class->$method";
167 $results = [ [ [ $class, $code ] ] ];
170 qq/Couldn't forward to "$class". Does not implement "$method"/;
172 $c->log->debug($error)
179 local $c->request->{arguments} = [ @{$arguments} ];
181 for my $result ( @{$results} ) {
182 $c->execute( @{ $result->[0] } );
183 return if scalar @{ $c->error };
184 last unless $c->state;
190 =item $c->get_action( $action, $namespace, $inherit )
192 Get an action in a given namespace.
197 my ( $c, $action, $namespace, $inherit ) = @_;
198 return [] unless $action;
203 $namespace = '' if $namespace eq '/';
204 my $parent = $c->tree;
208 my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
209 push @results, [$result] if $result;
210 my $visitor = Tree::Simple::Visitor::FindByPath->new;
213 for my $part ( split '/', $namespace ) {
214 $visitor->setSearchPath($part);
215 $parent->accept($visitor);
216 my $child = $visitor->getResult;
217 my $uid = $child->getUID if $child;
218 my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
219 push @results, [$match] if $match;
233 my $visitor = Tree::Simple::Visitor::FindByPath->new;
234 $visitor->setSearchPath( split '/', $namespace );
235 $parent->accept($visitor);
236 my $child = $visitor->getResult;
237 my $uid = $child->getUID if $child;
238 my $match = $c->actions->{private}->{$uid}->{$action}
240 push @results, [$match] if $match;
245 $c->actions->{private}->{ $parent->getUID }->{$action};
246 push @results, [$result] if $result;
253 elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
254 elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
258 for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
259 my $name = $c->actions->{compiled}->[$i]->[0];
260 my $regex = $c->actions->{compiled}->[$i]->[1];
262 if ( my @snippets = ( $action =~ $regex ) ) {
263 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
271 =item $c->set_action( $action, $code, $namespace, $attrs )
273 Set an action in a given namespace.
278 my ( $c, $method, $code, $namespace, $attrs ) = @_;
281 Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} )
285 for my $attr ( @{$attrs} ) {
286 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
287 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
288 elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 }
289 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
290 elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
295 if ( $flags{private} && ( keys %flags > 1 ) ) {
296 $c->log->debug( 'Bad action definition "'
297 . join( ' ', @{$attrs} )
298 . qq/" for "$namespace->$method"/ )
302 return unless keys %flags;
304 my $parent = $c->tree;
305 my $visitor = Tree::Simple::Visitor::FindByPath->new;
307 for my $part ( split '/', $prefix ) {
308 $visitor->setSearchPath($part);
309 $parent->accept($visitor);
310 my $child = $visitor->getResult;
313 $child = $parent->addChild( Tree::Simple->new($part) );
314 $visitor->setSearchPath($part);
315 $parent->accept($visitor);
316 $child = $visitor->getResult;
322 my $uid = $parent->getUID;
323 $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
324 my $forward = $prefix ? "$prefix/$method" : $method;
326 if ( $flags{path} ) {
327 $flags{path} =~ s/^\w+//;
328 $flags{path} =~ s/\w+$//;
329 if ( $flags{path} =~ /^\s*'(.*)'\s*$/ ) { $flags{path} = $1 }
330 if ( $flags{path} =~ /^\s*"(.*)"\s*$/ ) { $flags{path} = $1 }
333 if ( $flags{regex} ) {
334 $flags{regex} =~ s/^\w+//;
335 $flags{regex} =~ s/\w+$//;
336 if ( $flags{regex} =~ /^\s*'(.*)'\s*$/ ) { $flags{regex} = $1 }
337 if ( $flags{regex} =~ /^\s*"(.*)"\s*$/ ) { $flags{regex} = $1 }
340 my $reverse = $prefix ? "$prefix/$method" : $method;
342 if ( $flags{local} || $flags{global} || $flags{path} ) {
343 my $path = $flags{path} || $method;
346 if ( $path =~ /^\/(.+)/ ) {
351 $absolute = 1 if $flags{global};
352 my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
353 $c->actions->{plain}->{$name} = [ $namespace, $code ];
356 if ( my $regex = $flags{regex} ) {
357 push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
358 $c->actions->{regex}->{$regex} = [ $namespace, $code ];
361 $c->actions->{reverse}->{"$code"} = $reverse;
364 =item $class->setup_actions($component)
366 Setup actions for a component.
373 # These are the core structures
385 $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
387 for my $comp ( keys %{ $self->components } ) {
389 # We only setup components that inherit from Catalyst::Base
390 next unless $comp->isa('Catalyst::Base');
392 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
393 my ( $code, $attrs ) = @{$action};
396 my @cache = ( $comp, @{"$comp\::ISA"} );
399 while ( my $namespace = shift @cache ) {
400 $namespaces{$namespace}++;
401 for my $isa ( @{"$comp\::ISA"} ) {
402 next if $namespaces{$isa};
408 for my $namespace ( keys %namespaces ) {
410 for my $sym ( values %{ $namespace . '::' } ) {
412 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
414 $name = *{$sym}{NAME};
415 $self->set_action( $name, $code, $comp, $attrs );
427 return unless $self->debug;
429 my $actions = $self->actions;
430 my $privates = Text::ASCIITable->new;
431 $privates->setCols( 'Private', 'Class' );
432 $privates->setColWidth( 'Private', 36, 1 );
433 $privates->setColWidth( 'Class', 37, 1 );
436 my ( $walker, $parent, $prefix ) = @_;
437 $prefix .= $parent->getNodeValue || '';
438 $prefix .= '/' unless $prefix =~ /\/$/;
439 my $uid = $parent->getUID;
441 for my $action ( keys %{ $actions->{private}->{$uid} } ) {
442 my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
443 $privates->addRow( "$prefix$action", $class );
446 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
449 $walker->( $walker, $self->tree, '' );
450 $self->log->debug( "Loaded private actions:\n" . $privates->draw )
451 if ( @{ $privates->{tbl_rows} } );
453 my $publics = Text::ASCIITable->new;
454 $publics->setCols( 'Public', 'Private' );
455 $publics->setColWidth( 'Public', 36, 1 );
456 $publics->setColWidth( 'Private', 37, 1 );
458 for my $plain ( sort keys %{ $actions->{plain} } ) {
459 my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
460 my $reverse = $self->actions->{reverse}->{$code};
461 $reverse = $reverse ? "/$reverse" : $code;
462 $publics->addRow( "/$plain", $reverse );
465 $self->log->debug( "Loaded public actions:\n" . $publics->draw )
466 if ( @{ $publics->{tbl_rows} } );
468 my $regexes = Text::ASCIITable->new;
469 $regexes->setCols( 'Regex', 'Private' );
470 $regexes->setColWidth( 'Regex', 36, 1 );
471 $regexes->setColWidth( 'Private', 37, 1 );
473 for my $regex ( sort keys %{ $actions->{regex} } ) {
474 my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
475 my $reverse = $self->actions->{reverse}->{$code};
476 $reverse = $reverse ? "/$reverse" : $code;
477 $regexes->addRow( $regex, $reverse );
480 $self->log->debug( "Loaded regex actions:\n" . $regexes->draw )
481 if ( @{ $regexes->{tbl_rows} } );
488 Sebastian Riedel, C<sri@cpan.org>
492 This program is free software, you can redistribute it and/or modify it under
493 the same terms as Perl itself.