Commit | Line | Data |
68a748b9 |
1 | package Catalyst::Dispatcher; |
1abd6db7 |
2 | |
3 | use strict; |
fbcc39ad |
4 | use base 'Class::Accessor::Fast'; |
a2f2cde9 |
5 | use Catalyst::Exception; |
f05af9ba |
6 | use Catalyst::Utils; |
fbcc39ad |
7 | use Catalyst::Action; |
b7aebc12 |
8 | use Catalyst::ActionContainer; |
b96f127f |
9 | use Catalyst::DispatchType::Default; |
bcccee4e |
10 | use Catalyst::DispatchType::Index; |
1abd6db7 |
11 | use Text::ASCIITable; |
1abd6db7 |
12 | use Tree::Simple; |
13 | use Tree::Simple::Visitor::FindByPath; |
14 | |
fbcc39ad |
15 | # Stringify to class |
16 | use overload '""' => sub { return ref shift }, fallback => 1; |
17 | |
6d030e6f |
18 | __PACKAGE__->mk_accessors(qw/tree dispatch_types/); |
19 | |
20 | # Preload these action types |
21 | our @PRELOAD = qw/Path Regex/; |
1abd6db7 |
22 | |
2d1d8f91 |
23 | # Postload these action types |
24 | our @POSTLOAD = qw/Index Default/; |
25 | |
1abd6db7 |
26 | =head1 NAME |
27 | |
9c053379 |
28 | Catalyst::Dispatcher - The Catalyst Dispatcher |
1abd6db7 |
29 | |
30 | =head1 SYNOPSIS |
31 | |
32 | See L<Catalyst>. |
33 | |
34 | =head1 DESCRIPTION |
35 | |
36 | =head1 METHODS |
37 | |
38 | =over 4 |
39 | |
fbcc39ad |
40 | =item $self->detach( $c, $command [, \@arguments ] ) |
6ef62eb2 |
41 | |
42 | =cut |
43 | |
44 | sub detach { |
fbcc39ad |
45 | my ( $self, $c, $command, @args ) = @_; |
bd7d2e94 |
46 | $c->forward( $command, @args ) if $command; |
fbcc39ad |
47 | die $Catalyst::DETACH; |
6ef62eb2 |
48 | } |
49 | |
fbcc39ad |
50 | =item $self->dispatch($c) |
1abd6db7 |
51 | |
52 | =cut |
53 | |
54 | sub dispatch { |
fbcc39ad |
55 | my ( $self, $c ) = @_; |
cfd04b0c |
56 | |
66e28e3f |
57 | if ( $c->action ) { |
58 | |
59 | my @containers = $self->get_containers( $c->namespace ); |
60 | my %actions; |
61 | foreach my $name (qw/begin auto end/) { |
90ce41ba |
62 | |
63 | # Go down the container list representing each part of the |
64 | # current namespace inheritance tree, grabbing the actions hash |
65 | # of the ActionContainer object and looking for actions of the |
66 | # appropriate name registered to the namespace |
67 | |
66e28e3f |
68 | $actions{$name} = [ |
78d760bb |
69 | map { $_->{$name} } |
70 | grep { exists $_->{$name} } |
71 | map { $_->actions } @containers |
66e28e3f |
72 | ]; |
73 | } |
1abd6db7 |
74 | |
fbcc39ad |
75 | # Errors break the normal flow and the end action is instantly run |
76 | my $error = 0; |
77 | |
1abd6db7 |
78 | # Execute last begin |
79 | $c->state(1); |
66e28e3f |
80 | if ( my $begin = @{ $actions{begin} }[-1] ) { |
cfd04b0c |
81 | $begin->execute($c); |
fbcc39ad |
82 | $error++ if scalar @{ $c->error }; |
1abd6db7 |
83 | } |
84 | |
85 | # Execute the auto chain |
1196a46d |
86 | my $autorun = 0; |
cfd04b0c |
87 | for my $auto ( @{ $actions{auto} } ) { |
fbcc39ad |
88 | last if $error; |
9ddd9d05 |
89 | $autorun++; |
cfd04b0c |
90 | $auto->execute($c); |
fbcc39ad |
91 | $error++ if scalar @{ $c->error }; |
1abd6db7 |
92 | last unless $c->state; |
93 | } |
94 | |
95 | # Execute the action or last default |
e5f21aa2 |
96 | my $mkay = $autorun ? $c->state ? 1 : 0 : 1; |
78d760bb |
97 | if ($mkay) { |
fbcc39ad |
98 | unless ($error) { |
66e28e3f |
99 | $c->action->execute($c); |
100 | $error++ if scalar @{ $c->error }; |
1abd6db7 |
101 | } |
102 | } |
103 | |
104 | # Execute last end |
cfd04b0c |
105 | if ( my $end = @{ $actions{end} }[-1] ) { |
106 | $end->execute($c); |
1abd6db7 |
107 | } |
fbcc39ad |
108 | } |
109 | |
110 | else { |
1abd6db7 |
111 | my $path = $c->req->path; |
112 | my $error = $path |
113 | ? qq/Unknown resource "$path"/ |
114 | : "No default action defined"; |
115 | $c->log->error($error) if $c->debug; |
116 | $c->error($error); |
117 | } |
118 | } |
119 | |
fbcc39ad |
120 | =item $self->forward( $c, $command [, \@arguments ] ) |
1abd6db7 |
121 | |
122 | =cut |
123 | |
124 | sub forward { |
fbcc39ad |
125 | my $self = shift; |
1abd6db7 |
126 | my $c = shift; |
127 | my $command = shift; |
99fe1710 |
128 | |
1abd6db7 |
129 | unless ($command) { |
130 | $c->log->debug('Nothing to forward to') if $c->debug; |
131 | return 0; |
132 | } |
99fe1710 |
133 | |
71c3bcc3 |
134 | # Relative forwards from detach |
fbcc39ad |
135 | my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher') |
136 | && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1); |
71c3bcc3 |
137 | |
e0fc6749 |
138 | my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; |
99fe1710 |
139 | |
fbcc39ad |
140 | my $results = []; |
141 | |
8199eac3 |
142 | my $command_copy = $command; |
143 | |
144 | unless ( $command_copy =~ s/^\/// ) { |
5d68b17b |
145 | my $namespace = |
78d760bb |
146 | Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) |
147 | || ''; |
5d68b17b |
148 | $command_copy = "${namespace}/${command}"; |
1abd6db7 |
149 | } |
99fe1710 |
150 | |
8199eac3 |
151 | unless ( $command_copy =~ /\// ) { |
152 | $results = $c->get_action( $command_copy, '/' ); |
153 | } |
e494bd6b |
154 | else { |
8199eac3 |
155 | my @extra_args; |
156 | DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { |
157 | my $tail = $2; |
158 | $results = $c->get_action( $tail, $1 ); |
159 | if ( @{$results} ) { |
160 | $command = $tail; |
161 | push( @{$arguments}, @extra_args ); |
162 | last DESCEND; |
163 | } |
164 | unshift( @extra_args, $tail ); |
165 | } |
e494bd6b |
166 | } |
99fe1710 |
167 | |
1abd6db7 |
168 | unless ( @{$results} ) { |
bd7d2e94 |
169 | |
fbcc39ad |
170 | unless ( $c->components->{$command} ) { |
bd7d2e94 |
171 | my $error = |
172 | qq/Couldn't forward to command "$command". Invalid action or component./; |
3b2ed580 |
173 | $c->error($error); |
174 | $c->log->debug($error) if $c->debug; |
1abd6db7 |
175 | return 0; |
176 | } |
bd7d2e94 |
177 | |
1f6bb799 |
178 | my $class = $command; |
1abd6db7 |
179 | my $method = shift || 'process'; |
99fe1710 |
180 | |
1f6bb799 |
181 | if ( my $code = $c->components->{$class}->can($method) ) { |
fbcc39ad |
182 | my $action = Catalyst::Action->new( |
183 | { |
6b239949 |
184 | name => $method, |
fbcc39ad |
185 | code => $code, |
186 | reverse => "$class->$method", |
187 | namespace => $class, |
cfd04b0c |
188 | prefix => $class, |
fbcc39ad |
189 | } |
190 | ); |
191 | $results = [ [$action] ]; |
192 | } |
193 | |
194 | else { |
bd7d2e94 |
195 | my $error = |
196 | qq/Couldn't forward to "$class". Does not implement "$method"/; |
3b2ed580 |
197 | $c->error($error); |
198 | $c->log->debug($error) |
1abd6db7 |
199 | if $c->debug; |
200 | return 0; |
201 | } |
99fe1710 |
202 | |
1abd6db7 |
203 | } |
bd7d2e94 |
204 | |
205 | local $c->request->{arguments} = [ @{$arguments} ]; |
99fe1710 |
206 | |
1abd6db7 |
207 | for my $result ( @{$results} ) { |
fbcc39ad |
208 | $result->[0]->execute($c); |
e0fc6749 |
209 | return if scalar @{ $c->error }; |
1abd6db7 |
210 | last unless $c->state; |
211 | } |
99fe1710 |
212 | |
1abd6db7 |
213 | return $c->state; |
214 | } |
215 | |
fbcc39ad |
216 | =item $self->prepare_action($c) |
217 | |
218 | =cut |
219 | |
220 | sub prepare_action { |
221 | my ( $self, $c ) = @_; |
222 | my $path = $c->req->path; |
223 | my @path = split /\//, $c->req->path; |
224 | $c->req->args( \my @args ); |
225 | |
78d760bb |
226 | push( @path, '/' ) unless @path; # Root action |
227 | |
b96f127f |
228 | DESCEND: while (@path) { |
fbcc39ad |
229 | $path = join '/', @path; |
fbcc39ad |
230 | |
78d760bb |
231 | $path = '' if $path eq '/'; # Root action |
232 | |
22f3a8dd |
233 | # Check out dispatch types to see if any will handle the path at |
234 | # this level |
235 | |
78d760bb |
236 | foreach my $type ( @{ $self->dispatch_types } ) { |
2633d7dc |
237 | last DESCEND if $type->match( $c, $path ); |
66e28e3f |
238 | } |
b96f127f |
239 | |
22f3a8dd |
240 | # If not, move the last part path to args |
241 | |
b96f127f |
242 | unshift @args, pop @path; |
fbcc39ad |
243 | } |
244 | |
245 | $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) |
246 | if ( $c->debug && @args ); |
247 | } |
248 | |
249 | =item $self->get_action( $c, $action, $namespace, $inherit ) |
1abd6db7 |
250 | |
251 | =cut |
252 | |
253 | sub get_action { |
fbcc39ad |
254 | my ( $self, $c, $action, $namespace, $inherit ) = @_; |
1abd6db7 |
255 | return [] unless $action; |
bcccee4e |
256 | $namespace ||= ''; |
772ab8ae |
257 | $namespace = '' if $namespace eq '/'; |
258 | $inherit ||= 0; |
99fe1710 |
259 | |
78d760bb |
260 | my @match = $self->get_containers($namespace); |
c8d9780f |
261 | |
772ab8ae |
262 | if ($inherit) { # Return [ [ $act_obj ], ... ] for valid containers |
263 | return [ |
264 | map { [ $_->{$action} ] } # Make [ $action_obj ] |
265 | grep { defined $_->{$action} } # If it exists in the container |
266 | map { $_->actions } # Get action hash for container |
267 | @match |
268 | ]; |
269 | } |
270 | else { |
271 | my $node = $match[-1]->actions; # Only bother looking at the last one |
272 | |
273 | if ( defined $node->{$action} |
274 | && ( $node->{$action}->prefix eq $namespace ) ) |
275 | { |
276 | return [ [ $node->{$action} ] ]; |
277 | } |
278 | else { |
279 | return []; |
bcccee4e |
280 | } |
1abd6db7 |
281 | } |
1abd6db7 |
282 | } |
283 | |
cfd04b0c |
284 | =item $self->get_containers( $namespace ) |
285 | |
286 | =cut |
287 | |
288 | sub get_containers { |
289 | my ( $self, $namespace ) = @_; |
290 | |
90ce41ba |
291 | # If the namespace is / just return the root ActionContainer |
292 | |
78d760bb |
293 | return ( $self->tree->getNodeValue ) |
294 | if ( !$namespace || ( $namespace eq '/' ) ); |
cfd04b0c |
295 | |
90ce41ba |
296 | # Use a visitor to recurse down the tree finding the ActionContainers |
297 | # for each namespace in the chain. |
298 | |
cfd04b0c |
299 | my $visitor = Tree::Simple::Visitor::FindByPath->new; |
78d760bb |
300 | my @path = split( '/', $namespace ); |
301 | $visitor->setSearchPath(@path); |
cfd04b0c |
302 | $self->tree->accept($visitor); |
303 | |
304 | my @match = $visitor->getResults; |
78d760bb |
305 | @match = ( $self->tree ) unless @match; |
cfd04b0c |
306 | |
78d760bb |
307 | if ( !defined $visitor->getResult ) { |
90ce41ba |
308 | |
309 | # If we don't manage to match, the visitor doesn't return the last |
310 | # node is matched, so foo/bar/baz would only find the 'foo' node, |
311 | # not the foo and foo/bar nodes as it should. This does another |
312 | # single-level search to see if that's the case, and the 'last unless' |
313 | # should catch any failures - or short-circuit this if this *is* a |
314 | # bug in the visitor and gets fixed. |
315 | |
78d760bb |
316 | my $extra = $path[ ( scalar @match ) - 1 ]; |
cfd04b0c |
317 | last unless $extra; |
318 | $visitor->setSearchPath($extra); |
319 | $match[-1]->accept($visitor); |
78d760bb |
320 | push( @match, $visitor->getResult ) if defined $visitor->getResult; |
cfd04b0c |
321 | } |
322 | |
323 | return map { $_->getNodeValue } @match; |
324 | } |
325 | |
fbcc39ad |
326 | =item $self->set_action( $c, $action, $code, $namespace, $attrs ) |
1abd6db7 |
327 | |
328 | =cut |
329 | |
330 | sub set_action { |
fbcc39ad |
331 | my ( $self, $c, $method, $code, $namespace, $attrs ) = @_; |
1abd6db7 |
332 | |
e494bd6b |
333 | my $prefix = |
334 | Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} ) |
335 | || ''; |
b96f127f |
336 | my %attributes; |
1abd6db7 |
337 | |
338 | for my $attr ( @{$attrs} ) { |
22f3a8dd |
339 | |
340 | # Parse out :Foo(bar) into Foo => bar etc (and arrayify) |
341 | |
6d030e6f |
342 | my %initialized; |
343 | $initialized{ ref $_ }++ for @{ $self->dispatch_types }; |
344 | |
78d760bb |
345 | if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) { |
6d030e6f |
346 | |
347 | # Initialize types |
348 | my $class = "Catalyst::DispatchType::$key"; |
349 | unless ( $initialized{$class} ) { |
350 | eval "require $class"; |
351 | push( @{ $self->dispatch_types }, $class->new ) unless $@; |
352 | $initialized{$class}++; |
353 | } |
354 | |
b96f127f |
355 | if ( defined $value ) { |
78d760bb |
356 | ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); |
b96f127f |
357 | } |
78d760bb |
358 | push( @{ $attributes{$key} }, $value ); |
b96f127f |
359 | } |
1abd6db7 |
360 | } |
361 | |
6b239949 |
362 | if ( $attributes{Private} && ( keys %attributes > 1 ) ) { |
8d4e224b |
363 | $c->log->debug( 'Bad action definition "' |
d0e524d2 |
364 | . join( ' ', @{$attrs} ) |
8d4e224b |
365 | . qq/" for "$namespace->$method"/ ) |
366 | if $c->debug; |
d0e524d2 |
367 | return; |
368 | } |
6b239949 |
369 | return unless keys %attributes; |
1abd6db7 |
370 | |
fbcc39ad |
371 | my $parent = $self->tree; |
1abd6db7 |
372 | my $visitor = Tree::Simple::Visitor::FindByPath->new; |
99fe1710 |
373 | |
b7aebc12 |
374 | if ($prefix) { |
375 | for my $part ( split '/', $prefix ) { |
1abd6db7 |
376 | $visitor->setSearchPath($part); |
377 | $parent->accept($visitor); |
b7aebc12 |
378 | my $child = $visitor->getResult; |
78d760bb |
379 | |
b7aebc12 |
380 | unless ($child) { |
90ce41ba |
381 | |
382 | # Create a new tree node and an ActionContainer to form |
383 | # its value. |
384 | |
78d760bb |
385 | my $container = |
386 | Catalyst::ActionContainer->new( |
387 | { part => $part, actions => {} } ); |
b7aebc12 |
388 | $child = $parent->addChild( Tree::Simple->new($container) ); |
389 | $visitor->setSearchPath($part); |
390 | $parent->accept($visitor); |
391 | $child = $visitor->getResult; |
392 | } |
78d760bb |
393 | |
b7aebc12 |
394 | $parent = $child; |
1abd6db7 |
395 | } |
1abd6db7 |
396 | } |
99fe1710 |
397 | |
fbcc39ad |
398 | my $reverse = $prefix ? "$prefix/$method" : $method; |
399 | |
400 | my $action = Catalyst::Action->new( |
401 | { |
6b239949 |
402 | name => $method, |
b96f127f |
403 | code => $code, |
404 | reverse => $reverse, |
405 | namespace => $namespace, |
406 | prefix => $prefix, |
407 | attributes => \%attributes, |
fbcc39ad |
408 | } |
409 | ); |
410 | |
90ce41ba |
411 | # Set the method value |
b7aebc12 |
412 | $parent->getNodeValue->actions->{$method} = $action; |
fbcc39ad |
413 | |
22f3a8dd |
414 | # Pass the action to our dispatch types so they can register it if reqd. |
b96f127f |
415 | foreach my $type ( @{ $self->dispatch_types } ) { |
2633d7dc |
416 | $type->register( $c, $action ); |
b96f127f |
417 | } |
1abd6db7 |
418 | } |
419 | |
fbcc39ad |
420 | =item $self->setup_actions( $class, $component ) |
1abd6db7 |
421 | |
422 | =cut |
423 | |
424 | sub setup_actions { |
fbcc39ad |
425 | my ( $self, $class ) = @_; |
99fe1710 |
426 | |
6d030e6f |
427 | $self->dispatch_types( [] ); |
12e28165 |
428 | |
6d030e6f |
429 | # Preload action types |
430 | for my $type (@PRELOAD) { |
431 | my $class = "Catalyst::DispatchType::$type"; |
432 | eval "require $class"; |
433 | Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) |
434 | if $@; |
435 | push @{ $self->dispatch_types }, $class->new; |
436 | } |
b96f127f |
437 | |
12e28165 |
438 | # We use a tree |
78d760bb |
439 | my $container = |
440 | Catalyst::ActionContainer->new( { part => '/', actions => {} } ); |
b7aebc12 |
441 | $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); |
e494bd6b |
442 | |
fbcc39ad |
443 | for my $comp ( keys %{ $class->components } ) { |
e494bd6b |
444 | |
445 | # We only setup components that inherit from Catalyst::Base |
a268a011 |
446 | next unless $comp->isa('Catalyst::Base'); |
99fe1710 |
447 | |
812a28c9 |
448 | for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) { |
1abd6db7 |
449 | my ( $code, $attrs ) = @{$action}; |
450 | my $name = ''; |
451 | no strict 'refs'; |
452 | my @cache = ( $comp, @{"$comp\::ISA"} ); |
453 | my %namespaces; |
99fe1710 |
454 | |
1abd6db7 |
455 | while ( my $namespace = shift @cache ) { |
456 | $namespaces{$namespace}++; |
457 | for my $isa ( @{"$comp\::ISA"} ) { |
458 | next if $namespaces{$isa}; |
459 | push @cache, $isa; |
460 | $namespaces{$isa}++; |
461 | } |
462 | } |
99fe1710 |
463 | |
1abd6db7 |
464 | for my $namespace ( keys %namespaces ) { |
465 | for my $sym ( values %{ $namespace . '::' } ) { |
466 | if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { |
467 | $name = *{$sym}{NAME}; |
fbcc39ad |
468 | $class->set_action( $name, $code, $comp, $attrs ); |
1abd6db7 |
469 | last; |
470 | } |
471 | } |
472 | } |
473 | } |
474 | } |
e494bd6b |
475 | |
2d1d8f91 |
476 | # Postload action types |
477 | for my $type (@POSTLOAD) { |
478 | my $class = "Catalyst::DispatchType::$type"; |
479 | eval "require $class"; |
480 | Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) |
481 | if $@; |
482 | push @{ $self->dispatch_types }, $class->new; |
483 | } |
6d030e6f |
484 | |
fbcc39ad |
485 | return unless $class->debug; |
99fe1710 |
486 | |
1abd6db7 |
487 | my $privates = Text::ASCIITable->new; |
5fbed090 |
488 | $privates->setCols( 'Private', 'Class' ); |
489 | $privates->setColWidth( 'Private', 36, 1 ); |
490 | $privates->setColWidth( 'Class', 37, 1 ); |
99fe1710 |
491 | |
1abd6db7 |
492 | my $walker = sub { |
493 | my ( $walker, $parent, $prefix ) = @_; |
494 | $prefix .= $parent->getNodeValue || ''; |
495 | $prefix .= '/' unless $prefix =~ /\/$/; |
b7aebc12 |
496 | my $node = $parent->getNodeValue->actions; |
99fe1710 |
497 | |
78d760bb |
498 | for my $action ( keys %{$node} ) { |
b7aebc12 |
499 | my $action_obj = $node->{$action}; |
fbcc39ad |
500 | $privates->addRow( "$prefix$action", $action_obj->namespace ); |
1abd6db7 |
501 | } |
99fe1710 |
502 | |
1abd6db7 |
503 | $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; |
504 | }; |
99fe1710 |
505 | |
1abd6db7 |
506 | $walker->( $walker, $self->tree, '' ); |
a9cbd748 |
507 | $class->log->debug( "Loaded Private actions:\n" . $privates->draw ) |
a268a011 |
508 | if ( @{ $privates->{tbl_rows} } ); |
99fe1710 |
509 | |
a9cbd748 |
510 | # List all public actions |
511 | $_->list($class) for @{ $self->dispatch_types }; |
1abd6db7 |
512 | } |
513 | |
1abd6db7 |
514 | =back |
515 | |
516 | =head1 AUTHOR |
517 | |
518 | Sebastian Riedel, C<sri@cpan.org> |
519 | |
520 | =head1 COPYRIGHT |
521 | |
522 | This program is free software, you can redistribute it and/or modify it under |
523 | the same terms as Perl itself. |
524 | |
525 | =cut |
526 | |
527 | 1; |