Commit | Line | Data |
5ee249f2 |
1 | package Catalyst::Controller; |
2 | |
ae29b412 |
3 | use Moose; |
a58af53d |
4 | use Moose::Util qw/find_meta/; |
4f4ab5b4 |
5 | use List::MoreUtils qw/uniq/; |
ae29b412 |
6 | use namespace::clean -except => 'meta'; |
7 | |
ba545c13 |
8 | BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; } |
234763d4 |
9 | |
cf37d21a |
10 | use MooseX::MethodAttributes; |
234763d4 |
11 | use Catalyst::Exception; |
12 | use Catalyst::Utils; |
ae29b412 |
13 | |
14 | with 'Catalyst::Component::ApplicationAttribute'; |
15 | |
16 | has path_prefix => |
17 | ( |
18 | is => 'rw', |
19 | isa => 'Str', |
7f22a5aa |
20 | init_arg => 'path', |
ae29b412 |
21 | predicate => 'has_path_prefix', |
22 | ); |
23 | |
24 | has action_namespace => |
25 | ( |
26 | is => 'rw', |
27 | isa => 'Str', |
7f22a5aa |
28 | init_arg => 'namespace', |
ae29b412 |
29 | predicate => 'has_action_namespace', |
30 | ); |
31 | |
b138a0d0 |
32 | has actions => |
ae29b412 |
33 | ( |
b138a0d0 |
34 | accessor => '_controller_actions', |
ae29b412 |
35 | isa => 'HashRef', |
7f22a5aa |
36 | init_arg => undef, |
ae29b412 |
37 | ); |
38 | |
7f22a5aa |
39 | sub BUILD { |
40 | my ($self, $args) = @_; |
ae29b412 |
41 | my $action = delete $args->{action} || {}; |
42 | my $actions = delete $args->{actions} || {}; |
7f22a5aa |
43 | my $attr_value = $self->merge_config_hashes($actions, $action); |
44 | $self->_controller_actions($attr_value); |
45 | } |
5ee249f2 |
46 | |
d0e5dfb5 |
47 | |
48 | |
5ee249f2 |
49 | =head1 NAME |
50 | |
51 | Catalyst::Controller - Catalyst Controller base class |
52 | |
53 | =head1 SYNOPSIS |
54 | |
234763d4 |
55 | package MyApp::Controller::Search |
a269e0c2 |
56 | use base qw/Catalyst::Controller/; |
234763d4 |
57 | |
27ae4114 |
58 | sub foo : Local { |
85d9fce6 |
59 | my ($self,$c,@args) = @_; |
27ae4114 |
60 | ... |
234763d4 |
61 | } # Dispatches to /search/foo |
5ee249f2 |
62 | |
63 | =head1 DESCRIPTION |
64 | |
a269e0c2 |
65 | Controllers are where the actions in the Catalyst framework |
66 | reside. Each action is represented by a function with an attribute to |
67 | identify what kind of action it is. See the L<Catalyst::Dispatcher> |
68 | for more info about how Catalyst dispatches to actions. |
234763d4 |
69 | |
70 | =cut |
71 | |
ae29b412 |
72 | #I think both of these could be attributes. doesn't really seem like they need |
73 | #to ble class data. i think that attributes +default would work just fine |
234763d4 |
74 | __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/; |
75 | |
76 | __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] ); |
77 | __PACKAGE__->_action_class('Catalyst::Action'); |
78 | |
234763d4 |
79 | |
80 | sub _DISPATCH : Private { |
81 | my ( $self, $c ) = @_; |
82 | |
83 | foreach my $disp ( @{ $self->_dispatch_steps } ) { |
84 | last unless $c->forward($disp); |
85 | } |
86 | |
87 | $c->forward('_END'); |
88 | } |
89 | |
90 | sub _BEGIN : Private { |
91 | my ( $self, $c ) = @_; |
92 | my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1]; |
93 | return 1 unless $begin; |
94 | $begin->dispatch( $c ); |
95 | return !@{ $c->error }; |
96 | } |
97 | |
98 | sub _AUTO : Private { |
99 | my ( $self, $c ) = @_; |
100 | my @auto = $c->get_actions( 'auto', $c->namespace ); |
101 | foreach my $auto (@auto) { |
102 | $auto->dispatch( $c ); |
103 | return 0 unless $c->state; |
104 | } |
105 | return 1; |
106 | } |
107 | |
108 | sub _ACTION : Private { |
109 | my ( $self, $c ) = @_; |
110 | if ( ref $c->action |
111 | && $c->action->can('execute') |
53119b78 |
112 | && defined $c->req->action ) |
234763d4 |
113 | { |
114 | $c->action->dispatch( $c ); |
115 | } |
116 | return !@{ $c->error }; |
117 | } |
118 | |
119 | sub _END : Private { |
120 | my ( $self, $c ) = @_; |
121 | my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1]; |
122 | return 1 unless $end; |
123 | $end->dispatch( $c ); |
124 | return !@{ $c->error }; |
125 | } |
126 | |
234763d4 |
127 | sub action_for { |
128 | my ( $self, $name ) = @_; |
129 | my $app = ($self->isa('Catalyst') ? $self : $self->_application); |
130 | return $app->dispatcher->get_action($name, $self->action_namespace); |
131 | } |
132 | |
27ae4114 |
133 | #my opinion is that this whole sub really should be a builder method, not |
ae29b412 |
134 | #something that happens on every call. Anyone else disagree?? -- groditi |
135 | ## -- apparently this is all just waiting for app/ctx split |
136 | around action_namespace => sub { |
137 | my $orig = shift; |
234763d4 |
138 | my ( $self, $c ) = @_; |
ae29b412 |
139 | |
df960201 |
140 | my $class = ref($self) || $self; |
141 | my $appclass = ref($c) || $c; |
ae29b412 |
142 | if( ref($self) ){ |
143 | return $self->$orig if $self->has_action_namespace; |
144 | } else { |
df960201 |
145 | return $class->config->{namespace} if exists $class->config->{namespace}; |
234763d4 |
146 | } |
234763d4 |
147 | |
ae29b412 |
148 | my $case_s; |
149 | if( $c ){ |
df960201 |
150 | $case_s = $appclass->config->{case_sensitive}; |
ae29b412 |
151 | } else { |
152 | if ($self->isa('Catalyst')) { |
df960201 |
153 | $case_s = $class->config->{case_sensitive}; |
ae29b412 |
154 | } else { |
155 | if (ref $self) { |
df960201 |
156 | $case_s = ref($self->_application)->config->{case_sensitive}; |
ae29b412 |
157 | } else { |
158 | confess("Can't figure out case_sensitive setting"); |
159 | } |
160 | } |
234763d4 |
161 | } |
ae29b412 |
162 | |
8f6cebb2 |
163 | my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || ''; |
ae29b412 |
164 | $self->$orig($namespace) if ref($self); |
165 | return $namespace; |
166 | }; |
167 | |
168 | #Once again, this is probably better written as a builder method |
169 | around path_prefix => sub { |
170 | my $orig = shift; |
171 | my $self = shift; |
172 | if( ref($self) ){ |
173 | return $self->$orig if $self->has_path_prefix; |
174 | } else { |
175 | return $self->config->{path} if exists $self->config->{path}; |
176 | } |
177 | my $namespace = $self->action_namespace(@_); |
178 | $self->$orig($namespace) if ref($self); |
179 | return $namespace; |
180 | }; |
234763d4 |
181 | |
9ab7d83d |
182 | sub get_action_methods { |
183 | my $self = shift; |
2bf074ab |
184 | my $meta = find_meta($self) || confess("No metaclass setup for $self"); |
d0e5dfb5 |
185 | confess("Metaclass " |
fa649eb7 |
186 | . ref($meta) . " for " |
187 | . $meta->name |
188 | . " cannot support register_actions." ) |
189 | unless $meta->can('get_nearest_methods_with_attributes'); |
cf37d21a |
190 | my @methods = $meta->get_nearest_methods_with_attributes; |
fa649eb7 |
191 | |
192 | # actions specified via config are also action_methods |
193 | push( |
194 | @methods, |
195 | map { |
d0e78355 |
196 | $meta->find_method_by_name($_) |
1b79e199 |
197 | || confess( 'Action "' |
fa649eb7 |
198 | . $_ |
199 | . '" is not available from controller ' |
200 | . ( ref $self ) ) |
201 | } keys %{ $self->_controller_actions } |
202 | ) if ( ref $self ); |
4f4ab5b4 |
203 | return uniq @methods; |
9ab7d83d |
204 | } |
234763d4 |
205 | |
fa649eb7 |
206 | |
234763d4 |
207 | sub register_actions { |
208 | my ( $self, $c ) = @_; |
9ab7d83d |
209 | $self->register_action_methods( $c, $self->get_action_methods ); |
210 | } |
211 | |
212 | sub register_action_methods { |
213 | my ( $self, $c, @methods ) = @_; |
8f6cebb2 |
214 | my $class = $self->catalyst_component_name; |
ae29b412 |
215 | #this is still not correct for some reason. |
234763d4 |
216 | my $namespace = $self->action_namespace($c); |
234763d4 |
217 | |
f3c5b1c9 |
218 | # FIXME - fugly |
a202886b |
219 | if (!blessed($self) && $self eq $c && scalar(@methods)) { |
f3c5b1c9 |
220 | my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods; |
221 | if (scalar(@really_bad_methods)) { |
222 | $c->log->warn("Action methods (" . join(', ', @really_bad_methods) . ") found defined in your application class, $self. This is deprecated, please move them into a Root controller."); |
223 | } |
a202886b |
224 | } |
d2598ac8 |
225 | |
ba545c13 |
226 | foreach my $method (@methods) { |
227 | my $name = $method->name; |
228 | my $attributes = $method->attributes; |
ba545c13 |
229 | my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } ); |
234763d4 |
230 | if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) { |
231 | $c->log->debug( 'Bad action definition "' |
ba545c13 |
232 | . join( ' ', @{ $attributes } ) |
233 | . qq/" for "$class->$name"/ ) |
234763d4 |
234 | if $c->debug; |
235 | next; |
236 | } |
bc677969 |
237 | my $reverse = $namespace ? "${namespace}/${name}" : $name; |
234763d4 |
238 | my $action = $self->create_action( |
ba545c13 |
239 | name => $name, |
240 | code => $method->body, |
234763d4 |
241 | reverse => $reverse, |
242 | namespace => $namespace, |
243 | class => $class, |
244 | attributes => $attrs, |
245 | ); |
246 | |
247 | $c->dispatcher->register( $c, $action ); |
248 | } |
249 | } |
250 | |
251 | sub create_action { |
252 | my $self = shift; |
253 | my %args = @_; |
254 | |
255 | my $class = (exists $args{attributes}{ActionClass} |
256 | ? $args{attributes}{ActionClass}[0] |
257 | : $self->_action_class); |
ae29b412 |
258 | Class::MOP::load_class($class); |
a7e955ae |
259 | |
260 | my $action_args = $self->config->{action_args}; |
261 | my %extra_args = ( |
262 | %{ $action_args->{'*'} || {} }, |
263 | %{ $action_args->{ $args{name} } || {} }, |
264 | ); |
265 | |
266 | return $class->new({ %extra_args, %args }); |
234763d4 |
267 | } |
268 | |
269 | sub _parse_attrs { |
270 | my ( $self, $c, $name, @attrs ) = @_; |
271 | |
272 | my %raw_attributes; |
273 | |
274 | foreach my $attr (@attrs) { |
275 | |
276 | # Parse out :Foo(bar) into Foo => bar etc (and arrayify) |
277 | |
278 | if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) ) |
279 | { |
280 | |
281 | if ( defined $value ) { |
282 | ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); |
283 | } |
284 | push( @{ $raw_attributes{$key} }, $value ); |
285 | } |
286 | } |
287 | |
ae29b412 |
288 | #I know that the original behavior was to ignore action if actions was set |
289 | # but i actually think this may be a little more sane? we can always remove |
290 | # the merge behavior quite easily and go back to having actions have |
291 | # presedence over action by modifying the keys. i honestly think this is |
292 | # superior while mantaining really high degree of compat |
293 | my $actions; |
294 | if( ref($self) ) { |
637be086 |
295 | $actions = $self->_controller_actions; |
ae29b412 |
296 | } else { |
297 | my $cfg = $self->config; |
298 | $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action}); |
234763d4 |
299 | } |
300 | |
ae29b412 |
301 | %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()), |
302 | %raw_attributes, |
303 | (exists $actions->{$name} ? %{$actions->{$name}} : ())); |
304 | |
305 | |
234763d4 |
306 | my %final_attributes; |
307 | |
308 | foreach my $key (keys %raw_attributes) { |
309 | |
310 | my $raw = $raw_attributes{$key}; |
311 | |
312 | foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) { |
313 | |
314 | my $meth = "_parse_${key}_attr"; |
ae29b412 |
315 | if ( my $code = $self->can($meth) ) { |
316 | ( $key, $value ) = $self->$code( $c, $name, $value ); |
234763d4 |
317 | } |
318 | push( @{ $final_attributes{$key} }, $value ); |
319 | } |
320 | } |
321 | |
322 | return \%final_attributes; |
323 | } |
324 | |
325 | sub _parse_Global_attr { |
326 | my ( $self, $c, $name, $value ) = @_; |
327 | return $self->_parse_Path_attr( $c, $name, "/$name" ); |
328 | } |
329 | |
330 | sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); } |
331 | |
332 | sub _parse_Local_attr { |
333 | my ( $self, $c, $name, $value ) = @_; |
334 | return $self->_parse_Path_attr( $c, $name, $name ); |
335 | } |
336 | |
337 | sub _parse_Relative_attr { shift->_parse_Local_attr(@_); } |
338 | |
339 | sub _parse_Path_attr { |
340 | my ( $self, $c, $name, $value ) = @_; |
53119b78 |
341 | $value = '' if !defined $value; |
234763d4 |
342 | if ( $value =~ m!^/! ) { |
343 | return ( 'Path', $value ); |
344 | } |
345 | elsif ( length $value ) { |
346 | return ( 'Path', join( '/', $self->path_prefix($c), $value ) ); |
347 | } |
348 | else { |
349 | return ( 'Path', $self->path_prefix($c) ); |
350 | } |
351 | } |
352 | |
353 | sub _parse_Regex_attr { |
354 | my ( $self, $c, $name, $value ) = @_; |
355 | return ( 'Regex', $value ); |
356 | } |
357 | |
358 | sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); } |
359 | |
360 | sub _parse_LocalRegex_attr { |
361 | my ( $self, $c, $name, $value ) = @_; |
362 | unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; } |
19c01ee1 |
363 | |
364 | my $prefix = $self->path_prefix( $c ); |
365 | $prefix .= '/' if length( $prefix ); |
27ae4114 |
366 | |
19c01ee1 |
367 | return ( 'Regex', "^${prefix}${value}" ); |
234763d4 |
368 | } |
369 | |
370 | sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); } |
371 | |
f3107403 |
372 | sub _parse_Chained_attr { |
373 | my ($self, $c, $name, $value) = @_; |
374 | |
375 | if (defined($value) && length($value)) { |
376 | if ($value eq '.') { |
377 | $value = '/'.$self->action_namespace($c); |
fb56008f |
378 | } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) { |
eb270c30 |
379 | my @parts = split '/', $self->action_namespace($c); |
fb56008f |
380 | my @levels = split '/', $rel; |
381 | |
382 | $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest); |
f3107403 |
383 | } elsif ($value !~ m/^\//) { |
384 | my $action_ns = $self->action_namespace($c); |
385 | |
386 | if ($action_ns) { |
387 | $value = '/'.join('/', $action_ns, $value); |
388 | } else { |
389 | $value = '/'.$value; # special case namespace '' (root) |
390 | } |
391 | } |
392 | } else { |
393 | $value = '/' |
394 | } |
395 | |
396 | return Chained => $value; |
397 | } |
398 | |
9356b981 |
399 | sub _parse_ChainedParent_attr { |
400 | my ($self, $c, $name, $value) = @_; |
401 | return $self->_parse_Chained_attr($c, $name, '../'.$name); |
402 | } |
403 | |
e5d2cfdb |
404 | sub _parse_PathPrefix_attr { |
02825551 |
405 | my ( $self, $c ) = @_; |
406 | return PathPart => $self->path_prefix($c); |
e5d2cfdb |
407 | } |
408 | |
234763d4 |
409 | sub _parse_ActionClass_attr { |
410 | my ( $self, $c, $name, $value ) = @_; |
5d8129e9 |
411 | my $appname = $self->_application; |
412 | $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value); |
234763d4 |
413 | return ( 'ActionClass', $value ); |
414 | } |
415 | |
9287719b |
416 | sub _parse_MyAction_attr { |
417 | my ( $self, $c, $name, $value ) = @_; |
418 | |
419 | my $appclass = Catalyst::Utils::class2appclass($self); |
420 | $value = "${appclass}::Action::${value}"; |
234763d4 |
421 | |
9287719b |
422 | return ( 'ActionClass', $value ); |
423 | } |
234763d4 |
424 | |
ae29b412 |
425 | __PACKAGE__->meta->make_immutable; |
426 | |
234763d4 |
427 | 1; |
428 | |
429 | __END__ |
430 | |
431 | =head1 CONFIGURATION |
432 | |
a269e0c2 |
433 | Like any other L<Catalyst::Component>, controllers have a config hash, |
434 | accessible through $self->config from the controller actions. Some |
435 | settings are in use by the Catalyst framework: |
234763d4 |
436 | |
437 | =head2 namespace |
438 | |
a269e0c2 |
439 | This specifies the internal namespace the controller should be bound |
440 | to. By default the controller is bound to the URI version of the |
441 | controller name. For instance controller 'MyApp::Controller::Foo::Bar' |
442 | will be bound to 'foo/bar'. The default Root controller is an example |
443 | of setting namespace to '' (the null string). |
234763d4 |
444 | |
27ae4114 |
445 | =head2 path |
234763d4 |
446 | |
447 | Sets 'path_prefix', as described below. |
448 | |
c8136648 |
449 | =head2 action_args |
450 | |
451 | Allows you to set instantiation arguments on your custom Actions or ActionRoles. |
452 | You can set args globally (shared across all actions) and specifically (for a |
453 | single action). |
454 | |
455 | package MyApp::Web::Controller::MyController; |
456 | use parent 'Catalyst::Controller'; |
457 | |
458 | __PACKAGE__->config({ |
459 | action_args => { |
460 | '*' => {globalarg1=>'hello', globalarg2=>'goodbye'}, |
461 | 'specific_action' => {customarg=>'arg1'}, |
462 | }, |
463 | }); |
464 | |
465 | sub specific_action :Path('') ActionClass('CustomActionClass') {} |
466 | |
467 | 1; |
468 | |
469 | In the case above, your 'CustomActionClass' would get passed the following |
470 | arguments when it is instantiated: (globalarg1=>'hello', globalarg2=>'goodbye', |
471 | 'customarg=>'arg1'). Please note that the order the arguments are passed are not |
472 | certain to be in the order declared. |
473 | |
474 | As with all other configuration hashes, you can set values inline with your |
475 | controller (as above) or centrally via a configuration file (such as you might |
476 | use with the ConfigLoader plugin). |
477 | |
234763d4 |
478 | =head1 METHODS |
479 | |
c4d02967 |
480 | =head2 BUILDARGS ($app, @args) |
234763d4 |
481 | |
c4d02967 |
482 | From L<Catalyst::Component::ApplicationAttribute>, stashes the application |
483 | instance as $self->_application. |
234763d4 |
484 | |
485 | =head2 $self->action_for('name') |
486 | |
a269e0c2 |
487 | Returns the Catalyst::Action object (if any) for a given method name |
488 | in this component. |
234763d4 |
489 | |
234763d4 |
490 | =head2 $self->action_namespace($c) |
491 | |
a269e0c2 |
492 | Returns the private namespace for actions in this component. Defaults |
493 | to a value from the controller name (for |
494 | e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be |
495 | overridden from the "namespace" config key. |
234763d4 |
496 | |
497 | |
498 | =head2 $self->path_prefix($c) |
499 | |
e5d2cfdb |
500 | Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and |
501 | relative :Path actions in this component. Defaults to the action_namespace or |
a269e0c2 |
502 | can be overridden from the "path" config key. |
234763d4 |
503 | |
c4d02967 |
504 | =head2 $self->register_actions($c) |
505 | |
506 | Finds all applicable actions for this component, creates |
507 | Catalyst::Action objects (using $self->create_action) for them and |
508 | registers them with $c->dispatcher. |
509 | |
510 | =head2 $self->get_action_methods() |
511 | |
512 | Returns a list of L<Moose::Meta::Method> objects, doing the |
513 | L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of |
514 | action methods for this package. |
515 | |
516 | =head2 $self->register_action_methods($c, @methods) |
517 | |
518 | Creates action objects for a set of action methods using C< create_action >, |
519 | and registers them with the dispatcher. |
520 | |
234763d4 |
521 | =head2 $self->create_action(%args) |
522 | |
a269e0c2 |
523 | Called with a hash of data to be use for construction of a new |
524 | Catalyst::Action (or appropriate sub/alternative class) object. |
234763d4 |
525 | |
a269e0c2 |
526 | =head2 $self->_application |
234763d4 |
527 | |
528 | =head2 $self->_app |
529 | |
530 | Returns the application instance stored by C<new()> |
5ee249f2 |
531 | |
0bf7ab71 |
532 | =head1 AUTHORS |
5ee249f2 |
533 | |
0bf7ab71 |
534 | Catalyst Contributors, see Catalyst.pm |
5ee249f2 |
535 | |
536 | =head1 COPYRIGHT |
537 | |
536bee89 |
538 | This library is free software. You can redistribute it and/or modify |
a269e0c2 |
539 | it under the same terms as Perl itself. |
5ee249f2 |
540 | |
541 | =cut |