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; |
87b85407 |
11 | use Text::SimpleTable; |
1abd6db7 |
12 | use Tree::Simple; |
13 | use Tree::Simple::Visitor::FindByPath; |
e72f8f51 |
14 | use Scalar::Util (); |
1abd6db7 |
15 | |
fbcc39ad |
16 | # Stringify to class |
17 | use overload '""' => sub { return ref shift }, fallback => 1; |
18 | |
49070d25 |
19 | __PACKAGE__->mk_accessors( |
20 | qw/tree dispatch_types registered_dispatch_types |
e7bb8d33 |
21 | method_action_class action_container_class |
22 | preload_dispatch_types postload_dispatch_types |
a13e21ab |
23 | action_hash container_hash |
9e81ba44 |
24 | / |
49070d25 |
25 | ); |
6d030e6f |
26 | |
27 | # Preload these action types |
61a9002d |
28 | our @PRELOAD = qw/Index Path Regex/; |
1abd6db7 |
29 | |
2d1d8f91 |
30 | # Postload these action types |
61a9002d |
31 | our @POSTLOAD = qw/Default/; |
2d1d8f91 |
32 | |
1abd6db7 |
33 | =head1 NAME |
34 | |
9c053379 |
35 | Catalyst::Dispatcher - The Catalyst Dispatcher |
1abd6db7 |
36 | |
37 | =head1 SYNOPSIS |
38 | |
39 | See L<Catalyst>. |
40 | |
41 | =head1 DESCRIPTION |
42 | |
4ab87e27 |
43 | This is the class that maps public urls to actions in your Catalyst |
44 | application based on the attributes you set. |
45 | |
1abd6db7 |
46 | =head1 METHODS |
47 | |
76ddf86b |
48 | =head2 new |
4ab87e27 |
49 | |
50 | Construct a new dispatcher. |
51 | |
e7bb8d33 |
52 | =cut |
53 | |
54 | sub new { |
9e81ba44 |
55 | my $self = shift; |
e7bb8d33 |
56 | my $class = ref($self) || $self; |
9e81ba44 |
57 | |
58 | my $obj = $class->SUPER::new(@_); |
59 | |
e7bb8d33 |
60 | # set the default pre- and and postloads |
9e81ba44 |
61 | $obj->preload_dispatch_types( \@PRELOAD ); |
e7bb8d33 |
62 | $obj->postload_dispatch_types( \@POSTLOAD ); |
a13e21ab |
63 | $obj->action_hash( {} ); |
64 | $obj->container_hash( {} ); |
65 | |
66 | # Create the root node of the tree |
67 | my $container = |
68 | Catalyst::ActionContainer->new( { part => '/', actions => {} } ); |
69 | $obj->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); |
70 | |
9e81ba44 |
71 | return $obj; |
e7bb8d33 |
72 | } |
73 | |
74 | =head2 $self->preload_dispatch_types |
75 | |
76 | An arrayref of pre-loaded dispatchtype classes |
77 | |
78 | Entries are considered to be available as C<Catalyst::DispatchType::CLASS> |
79 | To use a custom class outside the regular C<Catalyst> namespace, prefix |
80 | it with a C<+>, like so: |
81 | |
82 | +My::Dispatch::Type |
83 | |
84 | =head2 $self->postload_dispatch_types |
85 | |
86 | An arrayref of post-loaded dispatchtype classes |
87 | |
88 | Entries are considered to be available as C<Catalyst::DispatchType::CLASS> |
89 | To use a custom class outside the regular C<Catalyst> namespace, prefix |
90 | it with a C<+>, like so: |
91 | |
92 | +My::Dispatch::Type |
93 | |
b5ecfcf0 |
94 | =head2 $self->detach( $c, $command [, \@arguments ] ) |
6ef62eb2 |
95 | |
4ab87e27 |
96 | Documented in L<Catalyst> |
97 | |
6ef62eb2 |
98 | =cut |
99 | |
100 | sub detach { |
fbcc39ad |
101 | my ( $self, $c, $command, @args ) = @_; |
bd7d2e94 |
102 | $c->forward( $command, @args ) if $command; |
fbcc39ad |
103 | die $Catalyst::DETACH; |
6ef62eb2 |
104 | } |
105 | |
b5ecfcf0 |
106 | =head2 $self->dispatch($c) |
1abd6db7 |
107 | |
4ab87e27 |
108 | Delegate the dispatch to the action that matched the url, or return a |
109 | message about unknown resource |
110 | |
111 | |
1abd6db7 |
112 | =cut |
113 | |
114 | sub dispatch { |
fbcc39ad |
115 | my ( $self, $c ) = @_; |
66e28e3f |
116 | if ( $c->action ) { |
28591cd7 |
117 | $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) ); |
fbcc39ad |
118 | } |
119 | |
120 | else { |
1abd6db7 |
121 | my $path = $c->req->path; |
122 | my $error = $path |
123 | ? qq/Unknown resource "$path"/ |
124 | : "No default action defined"; |
125 | $c->log->error($error) if $c->debug; |
126 | $c->error($error); |
127 | } |
128 | } |
129 | |
b5ecfcf0 |
130 | =head2 $self->forward( $c, $command [, \@arguments ] ) |
1abd6db7 |
131 | |
4ab87e27 |
132 | Documented in L<Catalyst> |
133 | |
1abd6db7 |
134 | =cut |
135 | |
136 | sub forward { |
e72f8f51 |
137 | my ( $self, $c, $command, @extra_params ) = @_; |
99fe1710 |
138 | |
1abd6db7 |
139 | unless ($command) { |
140 | $c->log->debug('Nothing to forward to') if $c->debug; |
141 | return 0; |
142 | } |
99fe1710 |
143 | |
e72f8f51 |
144 | my @args; |
145 | |
146 | if ( ref( $extra_params[-1] ) eq 'ARRAY' ) { |
147 | @args = @{ pop @extra_params } |
148 | } else { |
149 | # this is a copy, it may take some abuse from ->_invoke_as_path if the path had trailing parts |
150 | @args = @{ $c->request->arguments }; |
151 | } |
152 | |
153 | my $action; |
154 | |
155 | # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that |
156 | $action = $self->_invoke_as_path( $c, "$command", \@args ); |
99fe1710 |
157 | |
e72f8f51 |
158 | # forward to a component ( "MyApp::*::Foo" or $c->component("...") - a path or an object) |
159 | unless ($action) { |
160 | my $method = @extra_params ? $extra_params[0] : "process"; |
161 | $action = $self->_invoke_as_component( $c, $command, $method ); |
162 | } |
99fe1710 |
163 | |
99fe1710 |
164 | |
e540158b |
165 | unless ($action) { |
166 | my $error = |
167 | qq/Couldn't forward to command "$command": / |
168 | . qq/Invalid action or component./; |
169 | $c->error($error); |
170 | $c->log->debug($error) if $c->debug; |
171 | return 0; |
172 | } |
bd7d2e94 |
173 | |
e540158b |
174 | #push @$args, @_; |
adb53907 |
175 | |
e72f8f51 |
176 | local $c->request->{arguments} = \@args; |
b8f669f3 |
177 | $action->dispatch( $c ); |
99fe1710 |
178 | |
1abd6db7 |
179 | return $c->state; |
180 | } |
181 | |
adb53907 |
182 | sub _action_rel2abs { |
e540158b |
183 | my ( $self, $c, $path ) = @_; |
184 | |
185 | unless ( $path =~ m#^/# ) { |
186 | my $namespace = $c->stack->[-1]->namespace; |
187 | $path = "$namespace/$path"; |
188 | } |
189 | |
190 | $path =~ s#^/##; |
191 | return $path; |
adb53907 |
192 | } |
193 | |
194 | sub _invoke_as_path { |
e540158b |
195 | my ( $self, $c, $rel_path, $args ) = @_; |
196 | |
e540158b |
197 | my $path = $self->_action_rel2abs( $c, $rel_path ); |
198 | |
199 | my ( $tail, @extra_args ); |
200 | while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) ) |
201 | { # allow $path to be empty |
202 | if ( my $action = $c->get_action( $tail, $path ) ) { |
203 | push @$args, @extra_args; |
204 | return $action; |
205 | } |
206 | else { |
207 | return |
208 | unless $path |
209 | ; # if a match on the global namespace failed then the whole lookup failed |
210 | } |
211 | |
212 | unshift @extra_args, $tail; |
213 | } |
adb53907 |
214 | } |
215 | |
216 | sub _find_component_class { |
e540158b |
217 | my ( $self, $c, $component ) = @_; |
adb53907 |
218 | |
e540158b |
219 | return ref($component) |
220 | || ref( $c->component($component) ) |
221 | || $c->component($component); |
adb53907 |
222 | } |
223 | |
224 | sub _invoke_as_component { |
e540158b |
225 | my ( $self, $c, $component, $method ) = @_; |
226 | |
227 | my $class = $self->_find_component_class( $c, $component ) || return 0; |
e540158b |
228 | |
229 | if ( my $code = $class->can($method) ) { |
230 | return $self->method_action_class->new( |
231 | { |
232 | name => $method, |
233 | code => $code, |
234 | reverse => "$class->$method", |
235 | class => $class, |
236 | namespace => Catalyst::Utils::class2prefix( |
237 | $class, $c->config->{case_sensitive} |
238 | ), |
239 | } |
240 | ); |
241 | } |
242 | else { |
243 | my $error = |
244 | qq/Couldn't forward to "$class". Does not implement "$method"/; |
245 | $c->error($error); |
246 | $c->log->debug($error) |
247 | if $c->debug; |
248 | return 0; |
249 | } |
adb53907 |
250 | } |
251 | |
b5ecfcf0 |
252 | =head2 $self->prepare_action($c) |
fbcc39ad |
253 | |
4ab87e27 |
254 | Find an dispatch type that matches $c->req->path, and set args from it. |
255 | |
fbcc39ad |
256 | =cut |
257 | |
258 | sub prepare_action { |
259 | my ( $self, $c ) = @_; |
260 | my $path = $c->req->path; |
261 | my @path = split /\//, $c->req->path; |
262 | $c->req->args( \my @args ); |
263 | |
61a9002d |
264 | unshift( @path, '' ); # Root action |
78d760bb |
265 | |
b96f127f |
266 | DESCEND: while (@path) { |
fbcc39ad |
267 | $path = join '/', @path; |
61a9002d |
268 | $path =~ s#^/##; |
fbcc39ad |
269 | |
61a9002d |
270 | $path = '' if $path eq '/'; # Root action |
78d760bb |
271 | |
22f3a8dd |
272 | # Check out dispatch types to see if any will handle the path at |
273 | # this level |
274 | |
78d760bb |
275 | foreach my $type ( @{ $self->dispatch_types } ) { |
2633d7dc |
276 | last DESCEND if $type->match( $c, $path ); |
66e28e3f |
277 | } |
b96f127f |
278 | |
22f3a8dd |
279 | # If not, move the last part path to args |
4082e678 |
280 | my $arg = pop(@path); |
281 | $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; |
282 | unshift @args, $arg; |
fbcc39ad |
283 | } |
284 | |
e3a13771 |
285 | $c->log->debug( 'Path is "' . $c->req->match . '"' ) |
286 | if ( $c->debug && $c->req->match ); |
287 | |
fbcc39ad |
288 | $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) |
289 | if ( $c->debug && @args ); |
290 | } |
291 | |
b5ecfcf0 |
292 | =head2 $self->get_action( $action, $namespace ) |
1abd6db7 |
293 | |
4ab87e27 |
294 | returns a named action from a given namespace. |
295 | |
1abd6db7 |
296 | =cut |
297 | |
298 | sub get_action { |
bcd1002b |
299 | my ( $self, $name, $namespace ) = @_; |
79a3189a |
300 | return unless $name; |
3d0d6d21 |
301 | |
28928de9 |
302 | $namespace = join( "/", grep { length } split '/', $namespace || "" ); |
99fe1710 |
303 | |
a13e21ab |
304 | return $self->action_hash->{"$namespace/$name"}; |
1abd6db7 |
305 | } |
306 | |
34d28dfd |
307 | =head2 $self->get_action_by_path( $path ); |
308 | |
309 | Returns the named action by its full path. |
3d0d6d21 |
310 | |
34d28dfd |
311 | =cut |
3d0d6d21 |
312 | |
313 | sub get_action_by_path { |
314 | my ( $self, $path ) = @_; |
ea0e58d9 |
315 | $path =~ s/^\///; |
28928de9 |
316 | $path = "/$path" unless $path =~ /\//; |
3d0d6d21 |
317 | $self->action_hash->{$path}; |
318 | } |
319 | |
b5ecfcf0 |
320 | =head2 $self->get_actions( $c, $action, $namespace ) |
a9dc674c |
321 | |
322 | =cut |
323 | |
324 | sub get_actions { |
325 | my ( $self, $c, $action, $namespace ) = @_; |
326 | return [] unless $action; |
3d0d6d21 |
327 | |
28928de9 |
328 | $namespace = join( "/", grep { length } split '/', $namespace || "" ); |
a9dc674c |
329 | |
330 | my @match = $self->get_containers($namespace); |
331 | |
684d10ed |
332 | return map { $_->get_action($action) } @match; |
a9dc674c |
333 | } |
334 | |
b5ecfcf0 |
335 | =head2 $self->get_containers( $namespace ) |
cfd04b0c |
336 | |
4ab87e27 |
337 | Return all the action containers for a given namespace, inclusive |
338 | |
cfd04b0c |
339 | =cut |
340 | |
341 | sub get_containers { |
342 | my ( $self, $namespace ) = @_; |
a13e21ab |
343 | $namespace ||= ''; |
344 | $namespace = '' if $namespace eq '/'; |
cfd04b0c |
345 | |
a13e21ab |
346 | my @containers; |
cfd04b0c |
347 | |
7f23827b |
348 | if ( length $namespace ) { |
349 | do { |
350 | push @containers, $self->container_hash->{$namespace}; |
351 | } while ( $namespace =~ s#/[^/]+$## ); |
352 | } |
90ce41ba |
353 | |
a13e21ab |
354 | return reverse grep { defined } @containers, $self->container_hash->{''}; |
90ce41ba |
355 | |
a13e21ab |
356 | my @parts = split '/', $namespace; |
cfd04b0c |
357 | } |
358 | |
ea0e58d9 |
359 | =head2 $self->uri_for_action($action, \@captures) |
360 | |
361 | Takes a Catalyst::Action object and action parameters and returns a URI |
362 | part such that if $c->req->path were this URI part, this action would be |
363 | dispatched to with $c->req->captures set to the supplied arrayref. |
364 | |
365 | If the action object is not available for external dispatch or the dispatcher |
366 | cannot determine an appropriate URI, this method will return undef. |
367 | |
368 | =cut |
369 | |
370 | sub uri_for_action { |
371 | my ( $self, $action, $captures) = @_; |
372 | $captures ||= []; |
373 | foreach my $dispatch_type ( @{ $self->dispatch_types } ) { |
374 | my $uri = $dispatch_type->uri_for_action( $action, $captures ); |
81e75875 |
375 | return( $uri eq '' ? '/' : $uri ) |
376 | if defined($uri); |
ea0e58d9 |
377 | } |
378 | return undef; |
379 | } |
380 | |
b5ecfcf0 |
381 | =head2 $self->register( $c, $action ) |
aad72cc9 |
382 | |
4ab87e27 |
383 | Make sure all required dispatch types for this action are loaded, then |
384 | pass the action to our dispatch types so they can register it if required. |
385 | Also, set up the tree with the action containers. |
386 | |
aad72cc9 |
387 | =cut |
388 | |
79a3189a |
389 | sub register { |
390 | my ( $self, $c, $action ) = @_; |
391 | |
694d15f1 |
392 | my $registered = $self->registered_dispatch_types; |
393 | |
394 | my $priv = 0; |
395 | foreach my $key ( keys %{ $action->attributes } ) { |
9a6ecf4f |
396 | next if $key eq 'Private'; |
694d15f1 |
397 | my $class = "Catalyst::DispatchType::$key"; |
398 | unless ( $registered->{$class} ) { |
399 | eval "require $class"; |
400 | push( @{ $self->dispatch_types }, $class->new ) unless $@; |
401 | $registered->{$class} = 1; |
402 | } |
403 | } |
404 | |
405 | # Pass the action to our dispatch types so they can register it if reqd. |
01ce0928 |
406 | foreach my $type ( @{ $self->dispatch_types } ) { |
9a6ecf4f |
407 | $type->register( $c, $action ); |
694d15f1 |
408 | } |
409 | |
79a3189a |
410 | my $namespace = $action->namespace; |
a13e21ab |
411 | my $name = $action->name; |
c7116517 |
412 | |
ad5e4650 |
413 | my $container = $self->_find_or_create_action_container($namespace); |
15e9b5dd |
414 | |
415 | # Set the method value |
a13e21ab |
416 | $container->add_action($action); |
c7116517 |
417 | |
a13e21ab |
418 | $self->action_hash->{"$namespace/$name"} = $action; |
419 | $self->container_hash->{$namespace} = $container; |
15e9b5dd |
420 | } |
421 | |
ad5e4650 |
422 | sub _find_or_create_action_container { |
a13e21ab |
423 | my ( $self, $namespace ) = @_; |
424 | |
425 | my $tree ||= $self->tree; |
99fe1710 |
426 | |
a13e21ab |
427 | return $tree->getNodeValue unless $namespace; |
78d760bb |
428 | |
a13e21ab |
429 | my @namespace = split '/', $namespace; |
430 | return $self->_find_or_create_namespace_node( $tree, @namespace ) |
431 | ->getNodeValue; |
8505565b |
432 | } |
90ce41ba |
433 | |
8505565b |
434 | sub _find_or_create_namespace_node { |
a13e21ab |
435 | my ( $self, $parent, $part, @namespace ) = @_; |
78d760bb |
436 | |
a13e21ab |
437 | return $parent unless $part; |
8505565b |
438 | |
a13e21ab |
439 | my $child = |
440 | ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0]; |
8505565b |
441 | |
a13e21ab |
442 | unless ($child) { |
443 | my $container = Catalyst::ActionContainer->new($part); |
444 | $parent->addChild( $child = Tree::Simple->new($container) ); |
445 | } |
99fe1710 |
446 | |
a13e21ab |
447 | $self->_find_or_create_namespace_node( $child, @namespace ); |
1abd6db7 |
448 | } |
449 | |
4ab87e27 |
450 | =head2 $self->setup_actions( $class, $context ) |
451 | |
1abd6db7 |
452 | |
453 | =cut |
454 | |
455 | sub setup_actions { |
11bd4e3e |
456 | my ( $self, $c ) = @_; |
99fe1710 |
457 | |
6d030e6f |
458 | $self->dispatch_types( [] ); |
91d4abc5 |
459 | $self->registered_dispatch_types( {} ); |
49070d25 |
460 | $self->method_action_class('Catalyst::Action'); |
461 | $self->action_container_class('Catalyst::ActionContainer'); |
12e28165 |
462 | |
9e81ba44 |
463 | my @classes = |
ad5e4650 |
464 | $self->_load_dispatch_types( @{ $self->preload_dispatch_types } ); |
9e81ba44 |
465 | @{ $self->registered_dispatch_types }{@classes} = (1) x @classes; |
b96f127f |
466 | |
49070d25 |
467 | foreach my $comp ( values %{ $c->components } ) { |
468 | $comp->register_actions($c) if $comp->can('register_actions'); |
1abd6db7 |
469 | } |
e494bd6b |
470 | |
ad5e4650 |
471 | $self->_load_dispatch_types( @{ $self->postload_dispatch_types } ); |
6d030e6f |
472 | |
11bd4e3e |
473 | return unless $c->debug; |
99fe1710 |
474 | |
684d10ed |
475 | my $privates = Text::SimpleTable->new( |
dbf03873 |
476 | [ 20, 'Private' ], |
34d28dfd |
477 | [ 36, 'Class' ], |
dbf03873 |
478 | [ 12, 'Method' ] |
684d10ed |
479 | ); |
99fe1710 |
480 | |
87b85407 |
481 | my $has_private = 0; |
1abd6db7 |
482 | my $walker = sub { |
483 | my ( $walker, $parent, $prefix ) = @_; |
484 | $prefix .= $parent->getNodeValue || ''; |
485 | $prefix .= '/' unless $prefix =~ /\/$/; |
b7aebc12 |
486 | my $node = $parent->getNodeValue->actions; |
99fe1710 |
487 | |
78d760bb |
488 | for my $action ( keys %{$node} ) { |
b7aebc12 |
489 | my $action_obj = $node->{$action}; |
b0bb11ec |
490 | next |
491 | if ( ( $action =~ /^_.*/ ) |
492 | && ( !$c->config->{show_internal_actions} ) ); |
684d10ed |
493 | $privates->row( "$prefix$action", $action_obj->class, $action ); |
87b85407 |
494 | $has_private = 1; |
1abd6db7 |
495 | } |
99fe1710 |
496 | |
1abd6db7 |
497 | $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; |
498 | }; |
99fe1710 |
499 | |
1abd6db7 |
500 | $walker->( $walker, $self->tree, '' ); |
11bd4e3e |
501 | $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) |
49070d25 |
502 | if ($has_private); |
99fe1710 |
503 | |
a9cbd748 |
504 | # List all public actions |
11bd4e3e |
505 | $_->list($c) for @{ $self->dispatch_types }; |
1abd6db7 |
506 | } |
507 | |
ad5e4650 |
508 | sub _load_dispatch_types { |
9e81ba44 |
509 | my ( $self, @types ) = @_; |
510 | |
511 | my @loaded; |
512 | |
513 | # Preload action types |
514 | for my $type (@types) { |
515 | my $class = |
516 | ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}"; |
517 | eval "require $class"; |
518 | Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) |
519 | if $@; |
520 | push @{ $self->dispatch_types }, $class->new; |
521 | |
522 | push @loaded, $class; |
523 | } |
524 | |
a13e21ab |
525 | return @loaded; |
9e81ba44 |
526 | } |
527 | |
1abd6db7 |
528 | =head1 AUTHOR |
529 | |
530 | Sebastian Riedel, C<sri@cpan.org> |
158c88c0 |
531 | Matt S Trout, C<mst@shadowcatsystems.co.uk> |
1abd6db7 |
532 | |
533 | =head1 COPYRIGHT |
534 | |
535 | This program is free software, you can redistribute it and/or modify it under |
536 | the same terms as Perl itself. |
537 | |
538 | =cut |
539 | |
540 | 1; |