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 | |
91d4abc5 |
18 | __PACKAGE__->mk_accessors(qw/tree dispatch_types registered_dispatch_types/); |
6d030e6f |
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 ) { |
b0bb11ec |
58 | $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) ); |
fbcc39ad |
59 | } |
60 | |
61 | else { |
1abd6db7 |
62 | my $path = $c->req->path; |
63 | my $error = $path |
64 | ? qq/Unknown resource "$path"/ |
65 | : "No default action defined"; |
66 | $c->log->error($error) if $c->debug; |
67 | $c->error($error); |
68 | } |
69 | } |
70 | |
fbcc39ad |
71 | =item $self->forward( $c, $command [, \@arguments ] ) |
1abd6db7 |
72 | |
73 | =cut |
74 | |
75 | sub forward { |
fbcc39ad |
76 | my $self = shift; |
1abd6db7 |
77 | my $c = shift; |
78 | my $command = shift; |
99fe1710 |
79 | |
1abd6db7 |
80 | unless ($command) { |
81 | $c->log->debug('Nothing to forward to') if $c->debug; |
82 | return 0; |
83 | } |
99fe1710 |
84 | |
e0fc6749 |
85 | my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; |
99fe1710 |
86 | |
a9dc674c |
87 | my $result; |
fbcc39ad |
88 | |
8199eac3 |
89 | my $command_copy = $command; |
90 | |
91 | unless ( $command_copy =~ s/^\/// ) { |
91d4abc5 |
92 | my $namespace = $c->namespace; |
5d68b17b |
93 | $command_copy = "${namespace}/${command}"; |
1abd6db7 |
94 | } |
99fe1710 |
95 | |
8199eac3 |
96 | unless ( $command_copy =~ /\// ) { |
a9dc674c |
97 | $result = $c->get_action( $command_copy, '/' ); |
8199eac3 |
98 | } |
e494bd6b |
99 | else { |
8199eac3 |
100 | my @extra_args; |
101 | DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { |
102 | my $tail = $2; |
a9dc674c |
103 | $result = $c->get_action( $tail, $1 ); |
104 | if ( $result ) { |
8199eac3 |
105 | $command = $tail; |
106 | push( @{$arguments}, @extra_args ); |
107 | last DESCEND; |
108 | } |
109 | unshift( @extra_args, $tail ); |
110 | } |
e494bd6b |
111 | } |
99fe1710 |
112 | |
a9dc674c |
113 | unless ( $result ) { |
bd7d2e94 |
114 | |
d6e0d7e6 |
115 | my $comp; |
116 | |
117 | unless ( $comp = $c->component($command) ) { |
bd7d2e94 |
118 | my $error = |
119 | qq/Couldn't forward to command "$command". Invalid action or component./; |
3b2ed580 |
120 | $c->error($error); |
121 | $c->log->debug($error) if $c->debug; |
1abd6db7 |
122 | return 0; |
123 | } |
bd7d2e94 |
124 | |
d6e0d7e6 |
125 | my $class = ref $comp; |
1abd6db7 |
126 | my $method = shift || 'process'; |
99fe1710 |
127 | |
d6e0d7e6 |
128 | if ( my $code = $class->can($method) ) { |
fbcc39ad |
129 | my $action = Catalyst::Action->new( |
130 | { |
6b239949 |
131 | name => $method, |
fbcc39ad |
132 | code => $code, |
133 | reverse => "$class->$method", |
11bd4e3e |
134 | class => $class, |
fbcc39ad |
135 | namespace => $class, |
136 | } |
137 | ); |
a9dc674c |
138 | $result = $action; |
fbcc39ad |
139 | } |
140 | |
141 | else { |
bd7d2e94 |
142 | my $error = |
143 | qq/Couldn't forward to "$class". Does not implement "$method"/; |
3b2ed580 |
144 | $c->error($error); |
145 | $c->log->debug($error) |
1abd6db7 |
146 | if $c->debug; |
147 | return 0; |
148 | } |
99fe1710 |
149 | |
1abd6db7 |
150 | } |
bd7d2e94 |
151 | |
152 | local $c->request->{arguments} = [ @{$arguments} ]; |
91d4abc5 |
153 | local $c->{namespace} = $result->namespace; |
99fe1710 |
154 | |
a9dc674c |
155 | $result->execute($c); |
99fe1710 |
156 | |
1abd6db7 |
157 | return $c->state; |
158 | } |
159 | |
fbcc39ad |
160 | =item $self->prepare_action($c) |
161 | |
162 | =cut |
163 | |
164 | sub prepare_action { |
165 | my ( $self, $c ) = @_; |
166 | my $path = $c->req->path; |
167 | my @path = split /\//, $c->req->path; |
168 | $c->req->args( \my @args ); |
169 | |
78d760bb |
170 | push( @path, '/' ) unless @path; # Root action |
171 | |
b96f127f |
172 | DESCEND: while (@path) { |
fbcc39ad |
173 | $path = join '/', @path; |
fbcc39ad |
174 | |
78d760bb |
175 | $path = '' if $path eq '/'; # Root action |
176 | |
22f3a8dd |
177 | # Check out dispatch types to see if any will handle the path at |
178 | # this level |
179 | |
78d760bb |
180 | foreach my $type ( @{ $self->dispatch_types } ) { |
2633d7dc |
181 | last DESCEND if $type->match( $c, $path ); |
66e28e3f |
182 | } |
b96f127f |
183 | |
22f3a8dd |
184 | # If not, move the last part path to args |
185 | |
b96f127f |
186 | unshift @args, pop @path; |
fbcc39ad |
187 | } |
188 | |
189 | $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) |
190 | if ( $c->debug && @args ); |
191 | } |
192 | |
a9dc674c |
193 | =item $self->get_action( $c, $action, $namespace ) |
1abd6db7 |
194 | |
195 | =cut |
196 | |
197 | sub get_action { |
79a3189a |
198 | my ( $self, $c, $name, $namespace ) = @_; |
199 | return unless $name; |
bcccee4e |
200 | $namespace ||= ''; |
772ab8ae |
201 | $namespace = '' if $namespace eq '/'; |
99fe1710 |
202 | |
78d760bb |
203 | my @match = $self->get_containers($namespace); |
c8d9780f |
204 | |
79a3189a |
205 | return unless @match; |
772ab8ae |
206 | |
79a3189a |
207 | if ( my $action = $match[-1]->get_action( $c, $name ) ) |
a9dc674c |
208 | { |
79a3189a |
209 | return $action if $action->namespace eq $namespace; |
1abd6db7 |
210 | } |
1abd6db7 |
211 | } |
212 | |
a9dc674c |
213 | =item $self->get_actions( $c, $action, $namespace ) |
214 | |
215 | =cut |
216 | |
217 | sub get_actions { |
218 | my ( $self, $c, $action, $namespace ) = @_; |
219 | return [] unless $action; |
220 | $namespace ||= ''; |
221 | $namespace = '' if $namespace eq '/'; |
222 | |
223 | my @match = $self->get_containers($namespace); |
224 | |
79a3189a |
225 | return map { $_->get_action($c, $action) } @match; |
a9dc674c |
226 | } |
227 | |
cfd04b0c |
228 | =item $self->get_containers( $namespace ) |
229 | |
230 | =cut |
231 | |
232 | sub get_containers { |
233 | my ( $self, $namespace ) = @_; |
234 | |
90ce41ba |
235 | # If the namespace is / just return the root ActionContainer |
236 | |
78d760bb |
237 | return ( $self->tree->getNodeValue ) |
238 | if ( !$namespace || ( $namespace eq '/' ) ); |
cfd04b0c |
239 | |
90ce41ba |
240 | # Use a visitor to recurse down the tree finding the ActionContainers |
241 | # for each namespace in the chain. |
242 | |
cfd04b0c |
243 | my $visitor = Tree::Simple::Visitor::FindByPath->new; |
78d760bb |
244 | my @path = split( '/', $namespace ); |
245 | $visitor->setSearchPath(@path); |
cfd04b0c |
246 | $self->tree->accept($visitor); |
247 | |
248 | my @match = $visitor->getResults; |
78d760bb |
249 | @match = ( $self->tree ) unless @match; |
cfd04b0c |
250 | |
78d760bb |
251 | if ( !defined $visitor->getResult ) { |
90ce41ba |
252 | |
253 | # If we don't manage to match, the visitor doesn't return the last |
254 | # node is matched, so foo/bar/baz would only find the 'foo' node, |
255 | # not the foo and foo/bar nodes as it should. This does another |
256 | # single-level search to see if that's the case, and the 'last unless' |
257 | # should catch any failures - or short-circuit this if this *is* a |
258 | # bug in the visitor and gets fixed. |
259 | |
78d760bb |
260 | my $extra = $path[ ( scalar @match ) - 1 ]; |
cfd04b0c |
261 | last unless $extra; |
262 | $visitor->setSearchPath($extra); |
263 | $match[-1]->accept($visitor); |
78d760bb |
264 | push( @match, $visitor->getResult ) if defined $visitor->getResult; |
cfd04b0c |
265 | } |
266 | |
267 | return map { $_->getNodeValue } @match; |
268 | } |
269 | |
79a3189a |
270 | sub register { |
271 | my ( $self, $c, $action ) = @_; |
272 | |
273 | my $namespace = $action->namespace; |
274 | my $parent = $self->tree; |
275 | my $visitor = Tree::Simple::Visitor::FindByPath->new; |
99fe1710 |
276 | |
11bd4e3e |
277 | if ($namespace) { |
278 | for my $part ( split '/', $namespace ) { |
1abd6db7 |
279 | $visitor->setSearchPath($part); |
280 | $parent->accept($visitor); |
b7aebc12 |
281 | my $child = $visitor->getResult; |
78d760bb |
282 | |
b7aebc12 |
283 | unless ($child) { |
90ce41ba |
284 | |
285 | # Create a new tree node and an ActionContainer to form |
286 | # its value. |
287 | |
78d760bb |
288 | my $container = |
289 | Catalyst::ActionContainer->new( |
290 | { part => $part, actions => {} } ); |
b7aebc12 |
291 | $child = $parent->addChild( Tree::Simple->new($container) ); |
292 | $visitor->setSearchPath($part); |
293 | $parent->accept($visitor); |
294 | $child = $visitor->getResult; |
295 | } |
78d760bb |
296 | |
b7aebc12 |
297 | $parent = $child; |
1abd6db7 |
298 | } |
1abd6db7 |
299 | } |
99fe1710 |
300 | |
90ce41ba |
301 | # Set the method value |
79a3189a |
302 | $parent->getNodeValue->actions->{$action->name} = $action; |
fbcc39ad |
303 | |
91d4abc5 |
304 | my $registered = $self->registered_dispatch_types; |
305 | |
306 | foreach my $key (keys %{$action->attributes}) { |
307 | my $class = "Catalyst::DispatchType::$key"; |
308 | unless ( $registered->{$class} ) { |
309 | eval "require $class"; |
310 | push( @{ $self->dispatch_types }, $class->new ) unless $@; |
311 | $registered->{$class} = 1; |
312 | } |
313 | } |
314 | |
22f3a8dd |
315 | # Pass the action to our dispatch types so they can register it if reqd. |
b96f127f |
316 | foreach my $type ( @{ $self->dispatch_types } ) { |
2633d7dc |
317 | $type->register( $c, $action ); |
b96f127f |
318 | } |
1abd6db7 |
319 | } |
320 | |
fbcc39ad |
321 | =item $self->setup_actions( $class, $component ) |
1abd6db7 |
322 | |
323 | =cut |
324 | |
325 | sub setup_actions { |
11bd4e3e |
326 | my ( $self, $c ) = @_; |
99fe1710 |
327 | |
6d030e6f |
328 | $self->dispatch_types( [] ); |
91d4abc5 |
329 | $self->registered_dispatch_types( {} ); |
12e28165 |
330 | |
6d030e6f |
331 | # Preload action types |
332 | for my $type (@PRELOAD) { |
333 | my $class = "Catalyst::DispatchType::$type"; |
334 | eval "require $class"; |
335 | Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) |
336 | if $@; |
337 | push @{ $self->dispatch_types }, $class->new; |
91d4abc5 |
338 | $self->registered_dispatch_types->{$class} = 1; |
6d030e6f |
339 | } |
b96f127f |
340 | |
12e28165 |
341 | # We use a tree |
78d760bb |
342 | my $container = |
343 | Catalyst::ActionContainer->new( { part => '/', actions => {} } ); |
b7aebc12 |
344 | $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); |
e494bd6b |
345 | |
91d4abc5 |
346 | $c->register_actions( $c ); |
99fe1710 |
347 | |
91d4abc5 |
348 | foreach my $comp ( values %{$c->components} ) { |
349 | $comp->register_actions( $c ) if $comp->can('register_actions'); |
1abd6db7 |
350 | } |
e494bd6b |
351 | |
2d1d8f91 |
352 | # Postload action types |
353 | for my $type (@POSTLOAD) { |
354 | my $class = "Catalyst::DispatchType::$type"; |
355 | eval "require $class"; |
356 | Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) |
357 | if $@; |
358 | push @{ $self->dispatch_types }, $class->new; |
359 | } |
6d030e6f |
360 | |
11bd4e3e |
361 | return unless $c->debug; |
99fe1710 |
362 | |
1abd6db7 |
363 | my $privates = Text::ASCIITable->new; |
5fbed090 |
364 | $privates->setCols( 'Private', 'Class' ); |
365 | $privates->setColWidth( 'Private', 36, 1 ); |
366 | $privates->setColWidth( 'Class', 37, 1 ); |
99fe1710 |
367 | |
1abd6db7 |
368 | my $walker = sub { |
369 | my ( $walker, $parent, $prefix ) = @_; |
370 | $prefix .= $parent->getNodeValue || ''; |
371 | $prefix .= '/' unless $prefix =~ /\/$/; |
b7aebc12 |
372 | my $node = $parent->getNodeValue->actions; |
99fe1710 |
373 | |
78d760bb |
374 | for my $action ( keys %{$node} ) { |
b7aebc12 |
375 | my $action_obj = $node->{$action}; |
b0bb11ec |
376 | next |
377 | if ( ( $action =~ /^_.*/ ) |
378 | && ( !$c->config->{show_internal_actions} ) ); |
11bd4e3e |
379 | $privates->addRow( "$prefix$action", $action_obj->class ); |
1abd6db7 |
380 | } |
99fe1710 |
381 | |
1abd6db7 |
382 | $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; |
383 | }; |
99fe1710 |
384 | |
1abd6db7 |
385 | $walker->( $walker, $self->tree, '' ); |
11bd4e3e |
386 | $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) |
a268a011 |
387 | if ( @{ $privates->{tbl_rows} } ); |
99fe1710 |
388 | |
a9cbd748 |
389 | # List all public actions |
11bd4e3e |
390 | $_->list($c) for @{ $self->dispatch_types }; |
1abd6db7 |
391 | } |
392 | |
1abd6db7 |
393 | =back |
394 | |
395 | =head1 AUTHOR |
396 | |
397 | Sebastian Riedel, C<sri@cpan.org> |
158c88c0 |
398 | Matt S Trout, C<mst@shadowcatsystems.co.uk> |
1abd6db7 |
399 | |
400 | =head1 COPYRIGHT |
401 | |
402 | This program is free software, you can redistribute it and/or modify it under |
403 | the same terms as Perl itself. |
404 | |
405 | =cut |
406 | |
407 | 1; |