1 package Catalyst::Controller;
4 use Moose::Util qw/find_meta/;
5 use List::MoreUtils qw/uniq/;
6 use namespace::clean -except => 'meta';
8 BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; }
10 use MooseX::MethodAttributes;
11 use Catalyst::Exception;
14 with 'Catalyst::Component::ApplicationAttribute';
21 predicate => 'has_path_prefix',
24 has action_namespace =>
28 init_arg => 'namespace',
29 predicate => 'has_action_namespace',
34 accessor => '_controller_actions',
40 my ($self, $args) = @_;
41 my $action = delete $args->{action} || {};
42 my $actions = delete $args->{actions} || {};
43 my $attr_value = $self->merge_config_hashes($actions, $action);
44 $self->_controller_actions($attr_value);
51 Catalyst::Controller - Catalyst Controller base class
55 package MyApp::Controller::Search
56 use base qw/Catalyst::Controller/;
59 my ($self,$c,@args) = @_;
61 } # Dispatches to /search/foo
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.
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
74 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
76 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
77 __PACKAGE__->_action_class('Catalyst::Action');
80 sub _DISPATCH : Private {
81 my ( $self, $c ) = @_;
83 foreach my $disp ( @{ $self->_dispatch_steps } ) {
84 last unless $c->forward($disp);
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 };
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;
108 sub _ACTION : Private {
109 my ( $self, $c ) = @_;
111 && $c->action->can('execute')
112 && defined $c->req->action )
114 $c->action->dispatch( $c );
116 return !@{ $c->error };
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 };
128 my ( $self, $name ) = @_;
129 my $app = ($self->isa('Catalyst') ? $self : $self->_application);
130 return $app->dispatcher->get_action($name, $self->action_namespace);
133 #my opinion is that this whole sub really should be a builder method, not
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 {
138 my ( $self, $c ) = @_;
140 my $class = ref($self) || $self;
141 my $appclass = ref($c) || $c;
143 return $self->$orig if $self->has_action_namespace;
145 return $class->config->{namespace} if exists $class->config->{namespace};
150 $case_s = $appclass->config->{case_sensitive};
152 if ($self->isa('Catalyst')) {
153 $case_s = $class->config->{case_sensitive};
156 $case_s = ref($self->_application)->config->{case_sensitive};
158 confess("Can't figure out case_sensitive setting");
163 my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || '';
164 $self->$orig($namespace) if ref($self);
168 #Once again, this is probably better written as a builder method
169 around path_prefix => sub {
173 return $self->$orig if $self->has_path_prefix;
175 return $self->config->{path} if exists $self->config->{path};
177 my $namespace = $self->action_namespace(@_);
178 $self->$orig($namespace) if ref($self);
182 sub get_action_methods {
184 my $meta = find_meta($self) || confess("No metaclass setup for $self");
186 . ref($meta) . " for "
188 . " cannot support register_actions." )
189 unless $meta->can('get_nearest_methods_with_attributes');
190 my @methods = $meta->get_nearest_methods_with_attributes;
192 # actions specified via config are also action_methods
196 $meta->find_method_by_name($_)
197 || confess( 'Action "'
199 . '" is not available from controller '
201 } keys %{ $self->_controller_actions }
203 return uniq @methods;
207 sub register_actions {
208 my ( $self, $c ) = @_;
209 $self->register_action_methods( $c, $self->get_action_methods );
212 sub register_action_methods {
213 my ( $self, $c, @methods ) = @_;
214 my $class = $self->catalyst_component_name;
215 #this is still not correct for some reason.
216 my $namespace = $self->action_namespace($c);
219 if (!blessed($self) && $self eq $c && scalar(@methods)) {
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.");
226 foreach my $method (@methods) {
227 my $name = $method->name;
228 my $attributes = $method->can('attributes') ? $method->attributes : [];
229 my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
230 if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
231 $c->log->debug( 'Bad action definition "'
232 . join( ' ', @{ $attributes } )
233 . qq/" for "$class->$name"/ )
237 my $reverse = $namespace ? "${namespace}/${name}" : $name;
238 my $action = $self->create_action(
240 code => $method->body,
242 namespace => $namespace,
244 attributes => $attrs,
247 $c->dispatcher->register( $c, $action );
255 my $class = (exists $args{attributes}{ActionClass}
256 ? $args{attributes}{ActionClass}[0]
257 : $self->_action_class);
259 Class::MOP::load_class($class);
267 my $class = $self->action_class(%args);
268 my $action_args = $self->config->{action_args};
271 %{ $action_args->{'*'} || {} },
272 %{ $action_args->{ $args{name} } || {} },
275 return $class->new({ %extra_args, %args });
279 my ( $self, $c, $name, @attrs ) = @_;
283 foreach my $attr (@attrs) {
285 # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
287 if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
290 if ( defined $value ) {
291 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
293 push( @{ $raw_attributes{$key} }, $value );
297 #I know that the original behavior was to ignore action if actions was set
298 # but i actually think this may be a little more sane? we can always remove
299 # the merge behavior quite easily and go back to having actions have
300 # presedence over action by modifying the keys. i honestly think this is
301 # superior while mantaining really high degree of compat
304 $actions = $self->_controller_actions;
306 my $cfg = $self->config;
307 $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
310 %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
312 (exists $actions->{$name} ? %{$actions->{$name}} : ()));
315 my %final_attributes;
317 foreach my $key (keys %raw_attributes) {
319 my $raw = $raw_attributes{$key};
321 foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
323 my $meth = "_parse_${key}_attr";
324 if ( my $code = $self->can($meth) ) {
325 ( $key, $value ) = $self->$code( $c, $name, $value );
327 push( @{ $final_attributes{$key} }, $value );
331 return \%final_attributes;
334 sub _parse_Global_attr {
335 my ( $self, $c, $name, $value ) = @_;
336 return $self->_parse_Path_attr( $c, $name, "/$name" );
339 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
341 sub _parse_Local_attr {
342 my ( $self, $c, $name, $value ) = @_;
343 return $self->_parse_Path_attr( $c, $name, $name );
346 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
348 sub _parse_Path_attr {
349 my ( $self, $c, $name, $value ) = @_;
350 $value = '' if !defined $value;
351 if ( $value =~ m!^/! ) {
352 return ( 'Path', $value );
354 elsif ( length $value ) {
355 return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
358 return ( 'Path', $self->path_prefix($c) );
362 sub _parse_Regex_attr {
363 my ( $self, $c, $name, $value ) = @_;
364 return ( 'Regex', $value );
367 sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
369 sub _parse_LocalRegex_attr {
370 my ( $self, $c, $name, $value ) = @_;
371 unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
373 my $prefix = $self->path_prefix( $c );
374 $prefix .= '/' if length( $prefix );
376 return ( 'Regex', "^${prefix}${value}" );
379 sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
381 sub _parse_Chained_attr {
382 my ($self, $c, $name, $value) = @_;
384 if (defined($value) && length($value)) {
386 $value = '/'.$self->action_namespace($c);
387 } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
388 my @parts = split '/', $self->action_namespace($c);
389 my @levels = split '/', $rel;
391 $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
392 } elsif ($value !~ m/^\//) {
393 my $action_ns = $self->action_namespace($c);
396 $value = '/'.join('/', $action_ns, $value);
398 $value = '/'.$value; # special case namespace '' (root)
405 return Chained => $value;
408 sub _parse_ChainedParent_attr {
409 my ($self, $c, $name, $value) = @_;
410 return $self->_parse_Chained_attr($c, $name, '../'.$name);
413 sub _parse_PathPrefix_attr {
414 my ( $self, $c ) = @_;
415 return PathPart => $self->path_prefix($c);
418 sub _parse_ActionClass_attr {
419 my ( $self, $c, $name, $value ) = @_;
420 my $appname = $self->_application;
421 $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
422 return ( 'ActionClass', $value );
425 sub _parse_MyAction_attr {
426 my ( $self, $c, $name, $value ) = @_;
428 my $appclass = Catalyst::Utils::class2appclass($self);
429 $value = "${appclass}::Action::${value}";
431 return ( 'ActionClass', $value );
434 __PACKAGE__->meta->make_immutable;
442 Like any other L<Catalyst::Component>, controllers have a config hash,
443 accessible through $self->config from the controller actions. Some
444 settings are in use by the Catalyst framework:
448 This specifies the internal namespace the controller should be bound
449 to. By default the controller is bound to the URI version of the
450 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
451 will be bound to 'foo/bar'. The default Root controller is an example
452 of setting namespace to '' (the null string).
456 Sets 'path_prefix', as described below.
460 Allows you to set the attributes that the dispatcher creates actions out of.
461 This allows you to do 'rails style routes', or override some of the
462 attribute defintions of actions composed from Roles.
463 You can set arguments globally (for all actions of the controller) and
464 specifically (for a single action).
468 '*' => { Chained => 'base', Args => 0 },
469 base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
473 In the case above every sub in the package would be made into a Chain
474 endpoint with a URI the same as the sub name for each sub, chained
475 to the sub named C<base>. Ergo dispatch to C</example> would call the
476 C<base> method, then the C<example> method.
480 Allows you to set constructor arguments on your actions. You can set arguments
481 globally and specifically (as above).
482 This is particularly useful when using C<ActionRole>s
483 (L<Catalyst::Controller::ActionRole>) and custom C<ActionClass>es.
487 '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
488 'specific_action' => { customarg => 'arg1' },
492 In the case above the action class associated with C<specific_action> would get
493 passed the following arguments, in addition to the normal action constructor
494 arguments, when it is instantiated:
496 (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
500 =head2 BUILDARGS ($app, @args)
502 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
503 instance as $self->_application.
505 =head2 $self->action_for('name')
507 Returns the Catalyst::Action object (if any) for a given method name
510 =head2 $self->action_namespace($c)
512 Returns the private namespace for actions in this component. Defaults
513 to a value from the controller name (for
514 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
515 overridden from the "namespace" config key.
518 =head2 $self->path_prefix($c)
520 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
521 relative :Path actions in this component. Defaults to the action_namespace or
522 can be overridden from the "path" config key.
524 =head2 $self->register_actions($c)
526 Finds all applicable actions for this component, creates
527 Catalyst::Action objects (using $self->create_action) for them and
528 registers them with $c->dispatcher.
530 =head2 $self->get_action_methods()
532 Returns a list of L<Moose::Meta::Method> objects, doing the
533 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
534 action methods for this package.
536 =head2 $self->register_action_methods($c, @methods)
538 Creates action objects for a set of action methods using C< create_action >,
539 and registers them with the dispatcher.
541 =head2 $self->action_class(%args)
543 Used when a controller is creating an action to determine the correct base
546 =head2 $self->create_action(%args)
548 Called with a hash of data to be use for construction of a new
549 Catalyst::Action (or appropriate sub/alternative class) object.
551 =head2 $self->_application
555 Returns the application instance stored by C<new()>
559 Catalyst Contributors, see Catalyst.pm
563 This library is free software. You can redistribute it and/or modify
564 it under the same terms as Perl itself.