1 package Catalyst::Controller;
5 use Class::Load ':all';
6 use String::RewritePrefix;
7 use Moose::Util qw/find_meta/;
8 use List::Util qw/first/;
9 use List::MoreUtils qw/uniq/;
10 use namespace::clean -except => 'meta';
12 BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; }
14 use MooseX::MethodAttributes;
15 use Catalyst::Exception;
18 with 'Catalyst::Component::ApplicationAttribute';
24 predicate => 'has_path_prefix',
27 has action_namespace => (
30 init_arg => 'namespace',
31 predicate => 'has_action_namespace',
35 accessor => '_controller_actions',
40 has _action_role_args => (
41 traits => [qw(Array)],
42 isa => 'ArrayRef[Str]',
43 init_arg => 'action_roles',
44 default => sub { [] },
46 _action_role_args => 'elements',
50 has _action_roles => (
51 traits => [qw(Array)],
52 isa => 'ArrayRef[RoleName]',
55 builder => '_build__action_roles',
57 _action_roles => 'elements',
61 has action_args => (is => 'ro');
63 # ->config(actions => { '*' => ...
64 has _all_actions_attributes => (
69 builder => '_build__all_actions_attributes',
73 my ($self, $args) = @_;
74 my $action = delete $args->{action} || {};
75 my $actions = delete $args->{actions} || {};
76 my $attr_value = $self->merge_config_hashes($actions, $action);
77 $self->_controller_actions($attr_value);
79 # trigger lazy builder
80 $self->_all_actions_attributes;
84 sub _build__action_roles {
86 my @roles = $self->_expand_role_shortname($self->_action_role_args);
87 load_class($_) for @roles;
91 sub _build__all_actions_attributes {
93 delete $self->_controller_actions->{'*'} || {};
98 Catalyst::Controller - Catalyst Controller base class
102 package MyApp::Controller::Search
103 use base qw/Catalyst::Controller/;
106 my ($self,$c,@args) = @_;
108 } # Dispatches to /search/foo
112 Controllers are where the actions in the Catalyst framework
113 reside. Each action is represented by a function with an attribute to
114 identify what kind of action it is. See the L<Catalyst::Dispatcher>
115 for more info about how Catalyst dispatches to actions.
119 #I think both of these could be attributes. doesn't really seem like they need
120 #to ble class data. i think that attributes +default would work just fine
121 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class _action_role_prefix/;
123 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
124 __PACKAGE__->_action_class('Catalyst::Action');
125 __PACKAGE__->_action_role_prefix([ 'Catalyst::ActionRole::' ]);
128 sub _DISPATCH : Private {
129 my ( $self, $c ) = @_;
131 foreach my $disp ( @{ $self->_dispatch_steps } ) {
132 last unless $c->forward($disp);
138 sub _BEGIN : Private {
139 my ( $self, $c ) = @_;
140 my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
141 return 1 unless $begin;
142 $begin->dispatch( $c );
143 return !@{ $c->error };
146 sub _AUTO : Private {
147 my ( $self, $c ) = @_;
148 my @auto = $c->get_actions( 'auto', $c->namespace );
149 foreach my $auto (@auto) {
150 $auto->dispatch( $c );
151 return 0 unless $c->state;
156 sub _ACTION : Private {
157 my ( $self, $c ) = @_;
159 && $c->action->can('execute')
160 && defined $c->req->action )
162 $c->action->dispatch( $c );
164 return !@{ $c->error };
168 my ( $self, $c ) = @_;
169 my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
170 return 1 unless $end;
171 $end->dispatch( $c );
172 return !@{ $c->error };
176 my ( $self, $name ) = @_;
177 my $app = ($self->isa('Catalyst') ? $self : $self->_application);
178 return $app->dispatcher->get_action($name, $self->action_namespace);
181 #my opinion is that this whole sub really should be a builder method, not
182 #something that happens on every call. Anyone else disagree?? -- groditi
183 ## -- apparently this is all just waiting for app/ctx split
184 around action_namespace => sub {
186 my ( $self, $c ) = @_;
188 my $class = ref($self) || $self;
189 my $appclass = ref($c) || $c;
191 return $self->$orig if $self->has_action_namespace;
193 return $class->config->{namespace} if exists $class->config->{namespace};
198 $case_s = $appclass->config->{case_sensitive};
200 if ($self->isa('Catalyst')) {
201 $case_s = $class->config->{case_sensitive};
204 $case_s = ref($self->_application)->config->{case_sensitive};
206 confess("Can't figure out case_sensitive setting");
211 my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || '';
212 $self->$orig($namespace) if ref($self);
216 #Once again, this is probably better written as a builder method
217 around path_prefix => sub {
221 return $self->$orig if $self->has_path_prefix;
223 return $self->config->{path} if exists $self->config->{path};
225 my $namespace = $self->action_namespace(@_);
226 $self->$orig($namespace) if ref($self);
230 sub get_action_methods {
232 my $meta = find_meta($self) || confess("No metaclass setup for $self");
234 sprintf "Metaclass %s for %s cannot support register_actions.",
235 ref $meta, $meta->name,
236 ) unless $meta->can('get_nearest_methods_with_attributes');
237 my @methods = $meta->get_nearest_methods_with_attributes;
239 # actions specified via config are also action_methods
243 $meta->find_method_by_name($_)
244 || confess( sprintf 'Action "%s" is not available from controller %s',
246 } keys %{ $self->_controller_actions }
248 return uniq @methods;
252 sub register_actions {
253 my ( $self, $c ) = @_;
254 $self->register_action_methods( $c, $self->get_action_methods );
257 sub register_action_methods {
258 my ( $self, $c, @methods ) = @_;
259 my $class = $self->catalyst_component_name;
260 #this is still not correct for some reason.
261 my $namespace = $self->action_namespace($c);
264 if (!blessed($self) && $self eq $c && scalar(@methods)) {
265 my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods;
266 if (scalar(@really_bad_methods)) {
267 $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.");
271 foreach my $method (@methods) {
272 my $name = $method->name;
273 # Horrible hack! All method metaclasses should have an attributes
274 # method, core Moose bug - see r13354.
275 my $attributes = $method->can('attributes') ? $method->attributes : [];
276 my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
277 if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
278 $c->log->warn( 'Bad action definition "'
279 . join( ' ', @{ $attributes } )
280 . qq/" for "$class->$name"/ )
284 my $reverse = $namespace ? "${namespace}/${name}" : $name;
285 my $action = $self->create_action(
287 code => $method->body,
289 namespace => $namespace,
291 attributes => $attrs,
294 $c->dispatcher->register( $c, $action );
298 sub _apply_action_class_roles {
299 my ($self, $class, @roles) = @_;
301 load_class($_) for @roles;
302 my $meta = Moose::Meta::Class->initialize($class)->create_anon_class(
303 superclasses => [$class],
307 $meta->add_method(meta => sub { $meta });
316 my $class = (exists $args{attributes}{ActionClass}
317 ? $args{attributes}{ActionClass}[0]
318 : $self->_action_class);
320 Class::MOP::load_class($class);
328 my $class = $self->action_class(%args);
331 Moose->init_meta(for_class => $class)
332 unless Class::MOP::does_metaclass_exist($class);
334 unless ($args{name} =~ /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/) {
335 my @roles = $self->gather_action_roles(%args);
336 push @roles, $self->gather_default_action_roles(%args);
338 $class = $self->_apply_action_class_roles($class, @roles) if @roles;
344 : $self->config->{action_args}
348 %{ $action_args->{'*'} || {} },
349 %{ $action_args->{ $args{name} } || {} },
352 return $class->new({ %extra_args, %args });
355 sub gather_action_roles {
356 my ($self, %args) = @_;
358 (blessed $self ? $self->_action_roles : ()),
359 @{ $args{attributes}->{Does} || [] },
363 sub gather_default_action_roles {
364 my ($self, %args) = @_;
366 push @roles, 'Catalyst::ActionRole::HTTPMethods'
367 if $args{attributes}->{Method};
372 my ( $self, $c, $name, @attrs ) = @_;
376 foreach my $attr (@attrs) {
378 # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
380 if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
383 if ( defined $value ) {
384 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
386 push( @{ $raw_attributes{$key} }, $value );
390 my ($actions_config, $all_actions_config);
392 $actions_config = $self->_controller_actions;
393 # No, you're not getting actions => { '*' => ... } with actions in MyApp.
394 $all_actions_config = $self->_all_actions_attributes;
396 my $cfg = $self->config;
397 $actions_config = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
398 $all_actions_config = {};
403 # Note we deep copy array refs here to stop crapping on config
404 # when attributes are parsed. RT#65463
405 exists $actions_config->{$name} ? map { ref($_) eq 'ARRAY' ? [ @$_ ] : $_ } %{ $actions_config->{$name } } : (),
408 # Private actions with additional attributes will raise a warning and then
409 # be ignored. Adding '*' arguments to the default _DISPATCH / etc. methods,
410 # which are Private, will prevent those from being registered. They should
411 # probably be turned into :Actions instead, or we might want to otherwise
412 # disambiguate between those built-in internal actions and user-level
414 %raw_attributes = (%{ $all_actions_config }, %raw_attributes)
415 unless $raw_attributes{Private};
417 my %final_attributes;
419 while (my ($key, $value) = each %raw_attributes){
420 my $new_attrs = $self->_parse_attr($c, $name, $key => $value );
421 push @{ $final_attributes{$_} }, @{ $new_attrs->{$_} } for keys %$new_attrs;
424 return \%final_attributes;
428 my ($self, $c, $name, $key, $values) = @_;
430 my %final_attributes;
431 foreach my $value (ref($values) eq 'ARRAY' ? @$values : $values) {
432 my $meth = "_parse_${key}_attr";
433 if ( my $code = $self->can($meth) ) {
434 my %new_attrs = $self->$code( $c, $name, $value );
435 while (my ($new_key, $value) = each %new_attrs){
436 my $new_attrs = $key eq $new_key ?
437 { $new_key => [$value] } :
438 $self->_parse_attr($c, $name, $new_key => $value );
439 push @{ $final_attributes{$_} }, @{ $new_attrs->{$_} } for keys %$new_attrs;
443 push( @{ $final_attributes{$key} }, $value );
447 return \%final_attributes;
450 sub _parse_Global_attr {
451 my ( $self, $c, $name, $value ) = @_;
452 # _parse_attr will call _parse_Path_attr for us
453 return Path => "/$name";
456 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
458 sub _parse_Local_attr {
459 my ( $self, $c, $name, $value ) = @_;
460 # _parse_attr will call _parse_Path_attr for us
463 'PathPart' => join( '/', $self->path_prefix($c), $name)
467 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
469 sub _parse_Path_attr {
470 my ( $self, $c, $name, $value ) = @_;
471 $value = '' if !defined $value;
472 if ( $value =~ s!^/!! ) {
478 elsif ( length $value ) {
481 'PathPart' => join( '/', $self->path_prefix($c), $value )
487 'PathPart' => $self->path_prefix($c)
492 sub _parse_Chained_attr {
493 my ($self, $c, $name, $value) = @_;
495 if (defined($value) && length($value)) {
497 $value = '/'.$self->action_namespace($c);
498 } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
499 my @parts = split '/', $self->action_namespace($c);
500 my @levels = split '/', $rel;
502 $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
503 } elsif ($value !~ m/^\//) {
504 my $action_ns = $self->action_namespace($c);
507 $value = '/'.join('/', $action_ns, $value);
509 $value = '/'.$value; # special case namespace '' (root)
516 return Chained => $value;
519 sub _parse_ChainedParent_attr {
520 my ($self, $c, $name, $value) = @_;
521 return $self->_parse_Chained_attr($c, $name, '../'.$name);
524 sub _parse_PathPrefix_attr {
525 my ( $self, $c ) = @_;
526 return PathPart => $self->path_prefix($c);
529 sub _parse_ActionClass_attr {
530 my ( $self, $c, $name, $value ) = @_;
531 my $appname = $self->_application;
532 $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
533 return ( 'ActionClass', $value );
536 sub _parse_MyAction_attr {
537 my ( $self, $c, $name, $value ) = @_;
539 my $appclass = Catalyst::Utils::class2appclass($self);
540 $value = "+${appclass}::Action::${value}";
542 return ( 'ActionClass', $value );
545 sub _parse_Does_attr {
546 my ($self, $app, $name, $value) = @_;
547 return Does => $self->_expand_role_shortname($value);
550 sub _parse_GET_attr { Method => 'GET' }
551 sub _parse_POST_attr { Method => 'POST' }
552 sub _parse_PUT_attr { Method => 'PUT' }
553 sub _parse_DELETE_attr { Method => 'DELETE' }
554 sub _parse_OPTION_attr { Method => 'OPTION' }
555 sub _parse_HEAD_attr { Method => 'HEAD' }
557 sub _expand_role_shortname {
558 my ($self, @shortnames) = @_;
559 my $app = $self->_application;
561 my $prefix = $self->can('_action_role_prefix') ? $self->_action_role_prefix : ['Catalyst::ActionRole::'];
562 my @prefixes = (qq{${app}::ActionRole::}, @$prefix);
564 return String::RewritePrefix->rewrite(
566 my $loaded = load_first_existing_class(
567 map { "$_$_[0]" } @prefixes
569 return first { $loaded =~ /^$_/ }
570 sort { length $b <=> length $a } @prefixes;
578 __PACKAGE__->meta->make_immutable;
586 Like any other L<Catalyst::Component>, controllers have a config hash,
587 accessible through $self->config from the controller actions. Some
588 settings are in use by the Catalyst framework:
592 This specifies the internal namespace the controller should be bound
593 to. By default the controller is bound to the URI version of the
594 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
595 will be bound to 'foo/bar'. The default Root controller is an example
596 of setting namespace to '' (the null string).
600 Sets 'path_prefix', as described below.
604 Allows you to set the attributes that the dispatcher creates actions out of.
605 This allows you to do 'rails style routes', or override some of the
606 attribute definitions of actions composed from Roles.
607 You can set arguments globally (for all actions of the controller) and
608 specifically (for a single action).
612 '*' => { Chained => 'base', Args => 0 },
613 base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
617 In the case above every sub in the package would be made into a Chain
618 endpoint with a URI the same as the sub name for each sub, chained
619 to the sub named C<base>. Ergo dispatch to C</example> would call the
620 C<base> method, then the C<example> method.
624 Allows you to set constructor arguments on your actions. You can set arguments
625 globally and specifically (as above).
626 This is particularly useful when using C<ActionRole>s
627 (L<Catalyst::Controller::ActionRole>) and custom C<ActionClass>es.
631 '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
632 'specific_action' => { customarg => 'arg1' },
636 In the case above the action class associated with C<specific_action> would get
637 passed the following arguments, in addition to the normal action constructor
638 arguments, when it is instantiated:
640 (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
644 =head2 BUILDARGS ($app, @args)
646 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
647 instance as $self->_application.
649 =head2 $self->action_for('name')
651 Returns the Catalyst::Action object (if any) for a given method name
654 =head2 $self->action_namespace($c)
656 Returns the private namespace for actions in this component. Defaults
657 to a value from the controller name (for
658 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
659 overridden from the "namespace" config key.
662 =head2 $self->path_prefix($c)
664 Returns the default path prefix for :PathPrefix, :Local and
665 relative :Path actions in this component. Defaults to the action_namespace or
666 can be overridden from the "path" config key.
668 =head2 $self->register_actions($c)
670 Finds all applicable actions for this component, creates
671 Catalyst::Action objects (using $self->create_action) for them and
672 registers them with $c->dispatcher.
674 =head2 $self->get_action_methods()
676 Returns a list of L<Moose::Meta::Method> objects, doing the
677 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
678 action methods for this package.
680 =head2 $self->register_action_methods($c, @methods)
682 Creates action objects for a set of action methods using C< create_action >,
683 and registers them with the dispatcher.
685 =head2 $self->action_class(%args)
687 Used when a controller is creating an action to determine the correct base
690 =head2 $self->create_action(%args)
692 Called with a hash of data to be use for construction of a new
693 Catalyst::Action (or appropriate sub/alternative class) object.
695 =head2 $self->gather_action_roles(\%action_args)
697 Gathers the list of roles to apply to an action with the given %action_args.
699 =head2 $self->gather_default_action_roles(\%action_args)
701 returns a list of action roles to be applied based on core, builtin rules.
702 Currently only the L<Catalyst::ActionRole::HTTPMethods> role is applied
705 =head2 $self->_application
709 Returns the application instance stored by C<new()>
711 =head1 ACTION SUBROUTINE ATTRIBUTES
713 Please see L<Catalyst::Manual::Intro> for more details
715 Think of action attributes as a sort of way to record metadata about an action,
716 similar to how annotations work in other languages you might have heard of.
717 Generally L<Catalyst> uses these to influence how the dispatcher sees your
718 action and when it will run it in response to an incoming request. They can
719 also be used for other things. Here's a summary, but you should refer to the
720 liked manual page for additional help.
724 sub homepage :Global { ... }
726 A global action defined in any controller always runs relative to your root.
727 So the above is the same as:
729 sub myaction :Path("/homepage") { ... }
733 Status: Deprecated alias to L</Global>.
737 Alias to "Path("$action_name"). The following two actions are the same:
739 sub myaction :Local { ... }
740 sub myaction :Path('myaction') { ... }
744 Status: Deprecated alias to L</Local>
748 Handle various types of paths:
750 package MyApp::Controller::Baz {
754 sub myaction1 :Path { ... } # -> /baz
755 sub myaction2 :Path('foo') { ... } # -> /baz/bar
756 sub myaction2 :Path('/bar') { ... } # -> /bar
759 This is a general toolbox for attaching your action to a give path.
766 B<Status: Deprecated.> Use Chained methods or other techniques.
767 If you really depend on this, install the standalone
768 L<Catalyst::DispatchType::Regex> distribution.
770 A global way to match a give regular expression in the incoming request path.
776 B<Status: Deprecated.> Use Chained methods or other techniques.
777 If you really depend on this, install the standalone
778 L<Catalyst::DispatchType::Regex> distribution.
780 Like L</Regex> but scoped under the namespace of the containing controller
792 Please see L<Catalyst::DispatchType::Chained>
796 Set the base class for the action, defaults to L</Catalyst::Action>. It is now
797 preferred to use L</Does>.
801 Set the ActionClass using a custom Action in your project namespace.
803 The following is exactly the same:
805 sub foo_action1 : Local ActionClass('+MyApp::Action::Bar') { ... }
806 sub foo_action2 : Local MyAction('Bar') { ... }
810 package MyApp::Controller::Zoo;
812 sub foo : Local Does('Moo') { ... } # Catalyst::ActionRole::
813 sub bar : Local Does('~Moo') { ... } # MyApp::ActionRole::Moo
814 sub baz : Local Does('+MyApp::ActionRole::Moo') { ... }
832 Sets the give action path to match the specified HTTP method, or via one of the
833 broadly accepted methods of overriding the 'true' method (see
834 L<Catalyst::ActionRole::HTTPMethods>).
838 When used with L</Path> indicates the number of arguments expected in
839 the path. However if no Args value is set, assumed to 'slurp' all
840 remaining path pars under this namespace.
842 =head1 OPTIONAL METHODS
844 =head2 _parse_[$name]_attr
846 Allows you to customize parsing of subroutine attributes.
848 sub myaction1 :Path TwoArgs { ... }
850 sub _parse_TwoArgs_attr {
851 my ( $self, $c, $name, $value ) = @_;
852 # $self -> controller instance
857 Please note that this feature does not let you actually assign new functions
858 to actions via subroutine attributes, but is really more for creating useful
859 aliases to existing core and extended attributes, and transforms based on
860 existing information (like from configuration). Code for actually doing
861 something meaningful with the subroutine attributes will be located in the
862 L<Catalyst::Action> classes (or your subclasses), L<Catalyst::Dispatcher> and
863 in subclasses of L<Catalyst::DispatchType>. Remember these methods only get
864 called basically once when the application is starting, not per request!
868 Catalyst Contributors, see Catalyst.pm
872 This library is free software. You can redistribute it and/or modify
873 it under the same terms as Perl itself.