1 package Catalyst::Dispatcher;
4 use base 'Class::Data::Inheritable';
8 use Tree::Simple::Visitor::FindByPath;
10 __PACKAGE__->mk_classdata($_) for qw/actions tree/;
12 # These are the core structures
14 { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
18 __PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
22 Catalyst::Dispatcher - The Catalyst Dispatcher
36 Dispatch request to actions.
42 my $action = $c->req->action;
44 $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
45 if $action eq 'default';
48 if ( my $result = $c->get_action($action) ) {
50 Catalyst::Utils::class2prefix( $result->[0]->[0]->[0] );
54 my $default = $action eq 'default' ? $namespace : undef;
55 my $results = $c->get_action( $action, $default );
62 if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
63 $c->execute( @{ $begin->[0] } );
64 return if scalar @{ $c->error };
67 # Execute the auto chain
69 for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
70 $c->execute( @{ $auto->[0] } );
71 return if scalar @{ $c->error };
72 last unless $c->state;
76 # Execute the action or last default
77 my $mkay = $auto ? $c->state ? 1 : 0 : 1;
78 if ( ( my $action = $c->req->action ) && $mkay ) {
79 if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) {
80 $c->execute( @{ $result->[0] } );
85 if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
86 $c->execute( @{ $end->[0] } );
87 return if scalar @{ $c->error };
92 my $path = $c->req->path;
94 ? qq/Unknown resource "$path"/
95 : "No default action defined";
96 $c->log->error($error) if $c->debug;
101 =item $c->forward($command)
103 Forward processing to a private action or a method from a class.
104 If you define a class without method it will default to process().
107 $c->forward('index');
108 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
109 $c->forward('MyApp::View::TT');
118 $c->log->debug('Nothing to forward to') if $c->debug;
122 my $caller = caller(0);
125 if ( $command =~ /^\// ) {
126 $command =~ /^\/(.*)\/(\w+)$/;
127 $namespace = $1 || '/';
128 $command = $2 || $command;
132 else { $namespace = Catalyst::Utils::class2prefix($caller) || '/' }
134 my $results = $c->get_action( $command, $namespace );
136 unless ( @{$results} ) {
137 my $class = $command || '';
138 my $path = $class . '.pm';
141 unless ( $INC{ $path } ) {
142 my $error = qq/Couldn't forward to "$class". Invalid or not loaded./;
144 $c->log->debug($error) if $c->debug;
148 unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) {
149 my $error = qq/Can't forward to "$class". Class is not a Catalyst component./;
151 $c->log->debug($error) if $c->debug;
155 my $method = shift || 'process';
157 if ( my $code = $class->can($method) ) {
158 $c->actions->{reverse}->{"$code"} = "$class->$method";
159 $results = [ [ [ $class, $code ] ] ];
163 my $error = qq/Couldn't forward to "$class". Does not implement "$method"/;
165 $c->log->debug($error)
172 for my $result ( @{$results} ) {
173 $c->execute( @{ $result->[0] } );
174 return if scalar @{ $c->error };
175 last unless $c->state;
181 =item $c->get_action( $action, $namespace )
183 Get an action in a given namespace.
188 my ( $c, $action, $namespace ) = @_;
189 return [] unless $action;
193 $namespace = '' if $namespace eq '/';
194 my $parent = $c->tree;
196 my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
198 if ( $allowed{$action} ) {
199 my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
200 push @results, [$result] if $result;
201 my $visitor = Tree::Simple::Visitor::FindByPath->new;
203 for my $part ( split '/', $namespace ) {
204 $visitor->setSearchPath($part);
205 $parent->accept($visitor);
206 my $child = $visitor->getResult;
207 my $uid = $child->getUID if $child;
208 my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
209 push @results, [$match] if $match;
210 $parent = $child if $child;
218 my $visitor = Tree::Simple::Visitor::FindByPath->new;
219 $visitor->setSearchPath( split '/', $namespace );
220 $parent->accept($visitor);
221 my $child = $visitor->getResult;
222 my $uid = $child->getUID if $child;
223 my $match = $c->actions->{private}->{$uid}->{$action}
225 push @results, [$match] if $match;
230 $c->actions->{private}->{ $parent->getUID }->{$action};
231 push @results, [$result] if $result;
238 elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
239 elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
243 for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
244 my $name = $c->actions->{compiled}->[$i]->[0];
245 my $regex = $c->actions->{compiled}->[$i]->[1];
247 if ( my @snippets = ( $action =~ $regex ) ) {
248 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
256 =item $c->set_action( $action, $code, $namespace, $attrs )
258 Set an action in a given namespace.
263 my ( $c, $method, $code, $namespace, $attrs ) = @_;
265 my $prefix = Catalyst::Utils::class2prefix($namespace) || '';
268 for my $attr ( @{$attrs} ) {
269 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
270 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
271 elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
272 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
273 elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
276 if ( $flags{private} && ( keys %flags > 1 ) ) {
277 $c->log->debug( 'Bad action definition "'
278 . join( ' ', @{$attrs} )
279 . qq/" for "$namespace->$method"/ )
283 return unless keys %flags;
285 my $parent = $c->tree;
286 my $visitor = Tree::Simple::Visitor::FindByPath->new;
288 for my $part ( split '/', $prefix ) {
289 $visitor->setSearchPath($part);
290 $parent->accept($visitor);
291 my $child = $visitor->getResult;
294 $child = $parent->addChild( Tree::Simple->new($part) );
295 $visitor->setSearchPath($part);
296 $parent->accept($visitor);
297 $child = $visitor->getResult;
303 my $uid = $parent->getUID;
304 $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
305 my $forward = $prefix ? "$prefix/$method" : $method;
307 if ( $flags{path} ) {
308 $flags{path} =~ s/^\w+//;
309 $flags{path} =~ s/\w+$//;
310 if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
311 if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
314 if ( $flags{regex} ) {
315 $flags{regex} =~ s/^\w+//;
316 $flags{regex} =~ s/\w+$//;
317 if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
318 if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
321 my $reverse = $prefix ? "$prefix/$method" : $method;
323 if ( $flags{local} || $flags{global} || $flags{path} ) {
324 my $path = $flags{path} || $method;
327 if ( $path =~ /^\/(.+)/ ) {
332 $absolute = 1 if $flags{global};
333 my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
334 $c->actions->{plain}->{$name} = [ $namespace, $code ];
337 if ( my $regex = $flags{regex} ) {
338 push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
339 $c->actions->{regex}->{$regex} = [ $namespace, $code ];
342 $c->actions->{reverse}->{"$code"} = $reverse;
345 =item $class->setup_actions($component)
347 Setup actions for a component.
352 my ( $self, $comps ) = @_;
354 for my $comp (@$comps) {
355 $comp = ref $comp || $comp;
357 for my $action ( @{ $comp->_cache } ) {
358 my ( $code, $attrs ) = @{$action};
361 my @cache = ( $comp, @{"$comp\::ISA"} );
364 while ( my $namespace = shift @cache ) {
365 $namespaces{$namespace}++;
366 for my $isa ( @{"$comp\::ISA"} ) {
367 next if $namespaces{$isa};
373 for my $namespace ( keys %namespaces ) {
375 for my $sym ( values %{ $namespace . '::' } ) {
377 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
379 $name = *{$sym}{NAME};
380 $self->set_action( $name, $code, $comp, $attrs );
392 my $actions = $self->actions;
393 my $privates = Text::ASCIITable->new;
394 $privates->setCols( 'Private', 'Class' );
395 $privates->setColWidth( 'Private', 36, 1 );
396 $privates->setColWidth( 'Class', 37, 1 );
399 my ( $walker, $parent, $prefix ) = @_;
400 $prefix .= $parent->getNodeValue || '';
401 $prefix .= '/' unless $prefix =~ /\/$/;
402 my $uid = $parent->getUID;
404 for my $action ( keys %{ $actions->{private}->{$uid} } ) {
405 my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
406 $privates->addRow( "$prefix$action", $class );
409 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
412 $walker->( $walker, $self->tree, '' );
413 $self->log->debug( 'Loaded private actions', $privates->draw )
414 if ( @{ $privates->{tbl_rows} } && $self->debug );
416 my $publics = Text::ASCIITable->new;
417 $publics->setCols( 'Public', 'Private' );
418 $publics->setColWidth( 'Public', 36, 1 );
419 $publics->setColWidth( 'Private', 37, 1 );
421 for my $plain ( sort keys %{ $actions->{plain} } ) {
422 my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
423 my $reverse = $self->actions->{reverse}->{$code};
424 $reverse = $reverse ? "/$reverse" : $code;
425 $publics->addRow( "/$plain", $reverse );
428 $self->log->debug( 'Loaded public actions', $publics->draw )
429 if ( @{ $publics->{tbl_rows} } && $self->debug );
431 my $regexes = Text::ASCIITable->new;
432 $regexes->setCols( 'Regex', 'Private' );
433 $regexes->setColWidth( 'Regex', 36, 1 );
434 $regexes->setColWidth( 'Private', 37, 1 );
436 for my $regex ( sort keys %{ $actions->{regex} } ) {
437 my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
438 my $reverse = $self->actions->{reverse}->{$code};
439 $reverse = $reverse ? "/$reverse" : $code;
440 $regexes->addRow( $regex, $reverse );
443 $self->log->debug( 'Loaded regex actions', $regexes->draw )
444 if ( @{ $regexes->{tbl_rows} } && $self->debug );
451 Sebastian Riedel, C<sri@cpan.org>
455 This program is free software, you can redistribute it and/or modify it under
456 the same terms as Perl itself.