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->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);
260 return $class->new( \%args );
264 my ( $self, $c, $name, @attrs ) = @_;
268 foreach my $attr (@attrs) {
270 # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
272 if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
275 if ( defined $value ) {
276 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
278 push( @{ $raw_attributes{$key} }, $value );
282 #I know that the original behavior was to ignore action if actions was set
283 # but i actually think this may be a little more sane? we can always remove
284 # the merge behavior quite easily and go back to having actions have
285 # presedence over action by modifying the keys. i honestly think this is
286 # superior while mantaining really high degree of compat
289 $actions = $self->_controller_actions;
291 my $cfg = $self->config;
292 $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
295 %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
297 (exists $actions->{$name} ? %{$actions->{$name}} : ()));
300 my %final_attributes;
302 foreach my $key (keys %raw_attributes) {
304 my $raw = $raw_attributes{$key};
306 foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
308 my $meth = "_parse_${key}_attr";
309 if ( my $code = $self->can($meth) ) {
310 ( $key, $value ) = $self->$code( $c, $name, $value );
312 push( @{ $final_attributes{$key} }, $value );
316 return \%final_attributes;
319 sub _parse_Global_attr {
320 my ( $self, $c, $name, $value ) = @_;
321 return $self->_parse_Path_attr( $c, $name, "/$name" );
324 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
326 sub _parse_Local_attr {
327 my ( $self, $c, $name, $value ) = @_;
328 return $self->_parse_Path_attr( $c, $name, $name );
331 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
333 sub _parse_Path_attr {
334 my ( $self, $c, $name, $value ) = @_;
335 $value = '' if !defined $value;
336 if ( $value =~ m!^/! ) {
337 return ( 'Path', $value );
339 elsif ( length $value ) {
340 return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
343 return ( 'Path', $self->path_prefix($c) );
347 sub _parse_Regex_attr {
348 my ( $self, $c, $name, $value ) = @_;
349 return ( 'Regex', $value );
352 sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
354 sub _parse_LocalRegex_attr {
355 my ( $self, $c, $name, $value ) = @_;
356 unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
358 my $prefix = $self->path_prefix( $c );
359 $prefix .= '/' if length( $prefix );
361 return ( 'Regex', "^${prefix}${value}" );
364 sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
366 sub _parse_Chained_attr {
367 my ($self, $c, $name, $value) = @_;
369 if (defined($value) && length($value)) {
371 $value = '/'.$self->action_namespace($c);
372 } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
373 my @parts = split '/', $self->action_namespace($c);
374 my @levels = split '/', $rel;
376 $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
377 } elsif ($value !~ m/^\//) {
378 my $action_ns = $self->action_namespace($c);
381 $value = '/'.join('/', $action_ns, $value);
383 $value = '/'.$value; # special case namespace '' (root)
390 return Chained => $value;
393 sub _parse_ChainedParent_attr {
394 my ($self, $c, $name, $value) = @_;
395 return $self->_parse_Chained_attr($c, $name, '../'.$name);
398 sub _parse_PathPrefix_attr {
399 my ( $self, $c ) = @_;
400 return PathPart => $self->path_prefix($c);
403 sub _parse_ActionClass_attr {
404 my ( $self, $c, $name, $value ) = @_;
405 my $appname = $self->_application;
406 $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
407 return ( 'ActionClass', $value );
410 sub _parse_MyAction_attr {
411 my ( $self, $c, $name, $value ) = @_;
413 my $appclass = Catalyst::Utils::class2appclass($self);
414 $value = "${appclass}::Action::${value}";
416 return ( 'ActionClass', $value );
419 __PACKAGE__->meta->make_immutable;
427 Like any other L<Catalyst::Component>, controllers have a config hash,
428 accessible through $self->config from the controller actions. Some
429 settings are in use by the Catalyst framework:
433 This specifies the internal namespace the controller should be bound
434 to. By default the controller is bound to the URI version of the
435 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
436 will be bound to 'foo/bar'. The default Root controller is an example
437 of setting namespace to '' (the null string).
441 Sets 'path_prefix', as described below.
445 =head2 BUILDARGS ($app, @args)
447 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
448 instance as $self->_application.
450 =head2 $self->action_for('name')
452 Returns the Catalyst::Action object (if any) for a given method name
455 =head2 $self->action_namespace($c)
457 Returns the private namespace for actions in this component. Defaults
458 to a value from the controller name (for
459 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
460 overridden from the "namespace" config key.
463 =head2 $self->path_prefix($c)
465 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
466 relative :Path actions in this component. Defaults to the action_namespace or
467 can be overridden from the "path" config key.
469 =head2 $self->register_actions($c)
471 Finds all applicable actions for this component, creates
472 Catalyst::Action objects (using $self->create_action) for them and
473 registers them with $c->dispatcher.
475 =head2 $self->get_action_methods()
477 Returns a list of L<Moose::Meta::Method> objects, doing the
478 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
479 action methods for this package.
481 =head2 $self->register_action_methods($c, @methods)
483 Creates action objects for a set of action methods using C< create_action >,
484 and registers them with the dispatcher.
486 =head2 $self->create_action(%args)
488 Called with a hash of data to be use for construction of a new
489 Catalyst::Action (or appropriate sub/alternative class) object.
491 =head2 $self->_application
495 Returns the application instance stored by C<new()>
499 Catalyst Contributors, see Catalyst.pm
503 This library is free software. You can redistribute it and/or modify
504 it under the same terms as Perl itself.