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, $default ? 1 : 0 );
62 if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
63 $c->execute( @{ $begin->[0] } );
64 return if scalar @{ $c->error };
67 # Execute the auto chain
69 for $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
70 $c->execute( @{ $auto->[0] } );
71 return if scalar @{ $c->error };
72 last unless $c->state;
75 # Execute the action or last default
76 my $mkay = defined $auto ? $c->state ? 1 : 0 : 1;
77 if ( ( my $action = $c->req->action ) && $mkay ) {
78 if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
80 $c->execute( @{ $result->[0] } );
85 if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-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} ) {
143 qq/Couldn't forward to "$class". Invalid or not loaded./;
145 $c->log->debug($error) if $c->debug;
149 unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) {
151 qq/Can't forward to "$class". Class is not a Catalyst component./;
153 $c->log->debug($error) if $c->debug;
157 my $method = shift || 'process';
159 if ( my $code = $class->can($method) ) {
160 $c->actions->{reverse}->{"$code"} = "$class->$method";
161 $results = [ [ [ $class, $code ] ] ];
166 qq/Couldn't forward to "$class". Does not implement "$method"/;
168 $c->log->debug($error)
175 for my $result ( @{$results} ) {
176 $c->execute( @{ $result->[0] } );
177 return if scalar @{ $c->error };
178 last unless $c->state;
184 =item $c->get_action( $action, $namespace, $inherit )
186 Get an action in a given namespace.
191 my ( $c, $action, $namespace, $inherit ) = @_;
192 return [] unless $action;
197 $namespace = '' if $namespace eq '/';
198 my $parent = $c->tree;
202 my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
203 push @results, [$result] if $result;
204 my $visitor = Tree::Simple::Visitor::FindByPath->new;
206 for my $part ( split '/', $namespace ) {
207 $visitor->setSearchPath($part);
208 $parent->accept($visitor);
209 my $child = $visitor->getResult;
210 my $uid = $child->getUID if $child;
211 my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
212 push @results, [$match] if $match;
213 $parent = $child if $child;
221 my $visitor = Tree::Simple::Visitor::FindByPath->new;
222 $visitor->setSearchPath( split '/', $namespace );
223 $parent->accept($visitor);
224 my $child = $visitor->getResult;
225 my $uid = $child->getUID if $child;
226 my $match = $c->actions->{private}->{$uid}->{$action}
228 push @results, [$match] if $match;
233 $c->actions->{private}->{ $parent->getUID }->{$action};
234 push @results, [$result] if $result;
241 elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
242 elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
246 for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
247 my $name = $c->actions->{compiled}->[$i]->[0];
248 my $regex = $c->actions->{compiled}->[$i]->[1];
250 if ( my @snippets = ( $action =~ $regex ) ) {
251 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
259 =item $c->set_action( $action, $code, $namespace, $attrs )
261 Set an action in a given namespace.
266 my ( $c, $method, $code, $namespace, $attrs ) = @_;
268 my $prefix = Catalyst::Utils::class2prefix($namespace) || '';
271 for my $attr ( @{$attrs} ) {
272 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
273 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
274 elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
275 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
276 elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
279 if ( $flags{private} && ( keys %flags > 1 ) ) {
280 $c->log->debug( 'Bad action definition "'
281 . join( ' ', @{$attrs} )
282 . qq/" for "$namespace->$method"/ )
286 return unless keys %flags;
288 my $parent = $c->tree;
289 my $visitor = Tree::Simple::Visitor::FindByPath->new;
291 for my $part ( split '/', $prefix ) {
292 $visitor->setSearchPath($part);
293 $parent->accept($visitor);
294 my $child = $visitor->getResult;
297 $child = $parent->addChild( Tree::Simple->new($part) );
298 $visitor->setSearchPath($part);
299 $parent->accept($visitor);
300 $child = $visitor->getResult;
306 my $uid = $parent->getUID;
307 $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
308 my $forward = $prefix ? "$prefix/$method" : $method;
310 if ( $flags{path} ) {
311 $flags{path} =~ s/^\w+//;
312 $flags{path} =~ s/\w+$//;
313 if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
314 if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
317 if ( $flags{regex} ) {
318 $flags{regex} =~ s/^\w+//;
319 $flags{regex} =~ s/\w+$//;
320 if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
321 if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
324 my $reverse = $prefix ? "$prefix/$method" : $method;
326 if ( $flags{local} || $flags{global} || $flags{path} ) {
327 my $path = $flags{path} || $method;
330 if ( $path =~ /^\/(.+)/ ) {
335 $absolute = 1 if $flags{global};
336 my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
337 $c->actions->{plain}->{$name} = [ $namespace, $code ];
340 if ( my $regex = $flags{regex} ) {
341 push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
342 $c->actions->{regex}->{$regex} = [ $namespace, $code ];
345 $c->actions->{reverse}->{"$code"} = $reverse;
348 =item $class->setup_actions($component)
350 Setup actions for a component.
355 my ( $self, $comps ) = @_;
357 for my $comp (@$comps) {
358 $comp = ref $comp || $comp;
360 for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) {
361 my ( $code, $attrs ) = @{$action};
364 my @cache = ( $comp, @{"$comp\::ISA"} );
367 while ( my $namespace = shift @cache ) {
368 $namespaces{$namespace}++;
369 for my $isa ( @{"$comp\::ISA"} ) {
370 next if $namespaces{$isa};
376 for my $namespace ( keys %namespaces ) {
378 for my $sym ( values %{ $namespace . '::' } ) {
380 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
382 $name = *{$sym}{NAME};
383 $self->set_action( $name, $code, $comp, $attrs );
395 my $actions = $self->actions;
396 my $privates = Text::ASCIITable->new;
397 $privates->setCols( 'Private', 'Class' );
398 $privates->setColWidth( 'Private', 36, 1 );
399 $privates->setColWidth( 'Class', 37, 1 );
402 my ( $walker, $parent, $prefix ) = @_;
403 $prefix .= $parent->getNodeValue || '';
404 $prefix .= '/' unless $prefix =~ /\/$/;
405 my $uid = $parent->getUID;
407 for my $action ( keys %{ $actions->{private}->{$uid} } ) {
408 my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
409 $privates->addRow( "$prefix$action", $class );
412 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
415 $walker->( $walker, $self->tree, '' );
416 $self->log->debug( 'Loaded private actions', $privates->draw )
417 if ( @{ $privates->{tbl_rows} } && $self->debug );
419 my $publics = Text::ASCIITable->new;
420 $publics->setCols( 'Public', 'Private' );
421 $publics->setColWidth( 'Public', 36, 1 );
422 $publics->setColWidth( 'Private', 37, 1 );
424 for my $plain ( sort keys %{ $actions->{plain} } ) {
425 my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
426 my $reverse = $self->actions->{reverse}->{$code};
427 $reverse = $reverse ? "/$reverse" : $code;
428 $publics->addRow( "/$plain", $reverse );
431 $self->log->debug( 'Loaded public actions', $publics->draw )
432 if ( @{ $publics->{tbl_rows} } && $self->debug );
434 my $regexes = Text::ASCIITable->new;
435 $regexes->setCols( 'Regex', 'Private' );
436 $regexes->setColWidth( 'Regex', 36, 1 );
437 $regexes->setColWidth( 'Private', 37, 1 );
439 for my $regex ( sort keys %{ $actions->{regex} } ) {
440 my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
441 my $reverse = $self->actions->{reverse}->{$code};
442 $reverse = $reverse ? "/$reverse" : $code;
443 $regexes->addRow( $regex, $reverse );
446 $self->log->debug( 'Loaded regex actions', $regexes->draw )
447 if ( @{ $regexes->{tbl_rows} } && $self->debug );
454 Sebastian Riedel, C<sri@cpan.org>
458 This program is free software, you can redistribute it and/or modify it under
459 the same terms as Perl itself.