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/Unknown class "$class"/;
144 $c->log->debug($error) if $c->debug;
148 my $method = shift || 'process';
150 if ( my $code = $class->can($method) ) {
151 $c->actions->{reverse}->{"$code"} = "$class->$method";
152 $results = [ [ [ $class, $code ] ] ];
156 my $error = qq/Couldn't forward to "$class". Does not implement "$method"/;
158 $c->log->debug($error)
165 for my $result ( @{$results} ) {
166 $c->execute( @{ $result->[0] } );
167 return if scalar @{ $c->error };
168 last unless $c->state;
174 =item $c->get_action( $action, $namespace )
176 Get an action in a given namespace.
181 my ( $c, $action, $namespace ) = @_;
182 return [] unless $action;
186 $namespace = '' if $namespace eq '/';
187 my $parent = $c->tree;
189 my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
191 if ( $allowed{$action} ) {
192 my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
193 push @results, [$result] if $result;
194 my $visitor = Tree::Simple::Visitor::FindByPath->new;
196 for my $part ( split '/', $namespace ) {
197 $visitor->setSearchPath($part);
198 $parent->accept($visitor);
199 my $child = $visitor->getResult;
200 my $uid = $child->getUID if $child;
201 my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
202 push @results, [$match] if $match;
203 $parent = $child if $child;
211 my $visitor = Tree::Simple::Visitor::FindByPath->new;
212 $visitor->setSearchPath( split '/', $namespace );
213 $parent->accept($visitor);
214 my $child = $visitor->getResult;
215 my $uid = $child->getUID if $child;
216 my $match = $c->actions->{private}->{$uid}->{$action}
218 push @results, [$match] if $match;
223 $c->actions->{private}->{ $parent->getUID }->{$action};
224 push @results, [$result] if $result;
231 elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
232 elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
236 for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
237 my $name = $c->actions->{compiled}->[$i]->[0];
238 my $regex = $c->actions->{compiled}->[$i]->[1];
240 if ( my @snippets = ( $action =~ $regex ) ) {
241 return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
249 =item $c->set_action( $action, $code, $namespace, $attrs )
251 Set an action in a given namespace.
256 my ( $c, $method, $code, $namespace, $attrs ) = @_;
258 my $prefix = Catalyst::Utils::class2prefix($namespace) || '';
261 for my $attr ( @{$attrs} ) {
262 if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
263 elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
264 elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
265 elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
266 elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
269 if ( $flags{private} && ( keys %flags > 1 ) ) {
270 $c->log->debug( 'Bad action definition "'
271 . join( ' ', @{$attrs} )
272 . qq/" for "$namespace->$method"/ )
276 return unless keys %flags;
278 my $parent = $c->tree;
279 my $visitor = Tree::Simple::Visitor::FindByPath->new;
281 for my $part ( split '/', $prefix ) {
282 $visitor->setSearchPath($part);
283 $parent->accept($visitor);
284 my $child = $visitor->getResult;
287 $child = $parent->addChild( Tree::Simple->new($part) );
288 $visitor->setSearchPath($part);
289 $parent->accept($visitor);
290 $child = $visitor->getResult;
296 my $uid = $parent->getUID;
297 $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
298 my $forward = $prefix ? "$prefix/$method" : $method;
300 if ( $flags{path} ) {
301 $flags{path} =~ s/^\w+//;
302 $flags{path} =~ s/\w+$//;
303 if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
304 if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
307 if ( $flags{regex} ) {
308 $flags{regex} =~ s/^\w+//;
309 $flags{regex} =~ s/\w+$//;
310 if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
311 if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
314 my $reverse = $prefix ? "$prefix/$method" : $method;
316 if ( $flags{local} || $flags{global} || $flags{path} ) {
317 my $path = $flags{path} || $method;
320 if ( $path =~ /^\/(.+)/ ) {
325 $absolute = 1 if $flags{global};
326 my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
327 $c->actions->{plain}->{$name} = [ $namespace, $code ];
330 if ( my $regex = $flags{regex} ) {
331 push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
332 $c->actions->{regex}->{$regex} = [ $namespace, $code ];
335 $c->actions->{reverse}->{"$code"} = $reverse;
338 =item $class->setup_actions($component)
340 Setup actions for a component.
345 my ( $self, $comps ) = @_;
347 for my $comp (@$comps) {
348 $comp = ref $comp || $comp;
350 for my $action ( @{ $comp->_cache } ) {
351 my ( $code, $attrs ) = @{$action};
354 my @cache = ( $comp, @{"$comp\::ISA"} );
357 while ( my $namespace = shift @cache ) {
358 $namespaces{$namespace}++;
359 for my $isa ( @{"$comp\::ISA"} ) {
360 next if $namespaces{$isa};
366 for my $namespace ( keys %namespaces ) {
368 for my $sym ( values %{ $namespace . '::' } ) {
370 if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
372 $name = *{$sym}{NAME};
373 $self->set_action( $name, $code, $comp, $attrs );
385 my $actions = $self->actions;
386 my $privates = Text::ASCIITable->new;
387 $privates->setCols( 'Private', 'Class' );
388 $privates->setColWidth( 'Private', 36, 1 );
389 $privates->setColWidth( 'Class', 37, 1 );
392 my ( $walker, $parent, $prefix ) = @_;
393 $prefix .= $parent->getNodeValue || '';
394 $prefix .= '/' unless $prefix =~ /\/$/;
395 my $uid = $parent->getUID;
397 for my $action ( keys %{ $actions->{private}->{$uid} } ) {
398 my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
399 $privates->addRow( "$prefix$action", $class );
402 $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
405 $walker->( $walker, $self->tree, '' );
406 $self->log->debug( 'Loaded private actions', $privates->draw )
407 if ( @{ $privates->{tbl_rows} } && $self->debug );
409 my $publics = Text::ASCIITable->new;
410 $publics->setCols( 'Public', 'Private' );
411 $publics->setColWidth( 'Public', 36, 1 );
412 $publics->setColWidth( 'Private', 37, 1 );
414 for my $plain ( sort keys %{ $actions->{plain} } ) {
415 my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
416 my $reverse = $self->actions->{reverse}->{$code};
417 $reverse = $reverse ? "/$reverse" : $code;
418 $publics->addRow( "/$plain", $reverse );
421 $self->log->debug( 'Loaded public actions', $publics->draw )
422 if ( @{ $publics->{tbl_rows} } && $self->debug );
424 my $regexes = Text::ASCIITable->new;
425 $regexes->setCols( 'Regex', 'Private' );
426 $regexes->setColWidth( 'Regex', 36, 1 );
427 $regexes->setColWidth( 'Private', 37, 1 );
429 for my $regex ( sort keys %{ $actions->{regex} } ) {
430 my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
431 my $reverse = $self->actions->{reverse}->{$code};
432 $reverse = $reverse ? "/$reverse" : $code;
433 $regexes->addRow( $regex, $reverse );
436 $self->log->debug( 'Loaded regex actions', $regexes->draw )
437 if ( @{ $regexes->{tbl_rows} } && $self->debug );
444 Sebastian Riedel, C<sri@cpan.org>
448 This program is free software, you can redistribute it and/or modify it under
449 the same terms as Perl itself.