1 package Catalyst::Controller;
4 use Moose::Util qw/find_meta/;
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',
32 has _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);
49 Catalyst::Controller - Catalyst Controller base class
53 package MyApp::Controller::Search
54 use base qw/Catalyst::Controller/;
57 my ($self,$c,@args) = @_;
59 } # Dispatches to /search/foo
63 Controllers are where the actions in the Catalyst framework
64 reside. Each action is represented by a function with an attribute to
65 identify what kind of action it is. See the L<Catalyst::Dispatcher>
66 for more info about how Catalyst dispatches to actions.
70 #I think both of these could be attributes. doesn't really seem like they need
71 #to ble class data. i think that attributes +default would work just fine
72 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
74 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
75 __PACKAGE__->_action_class('Catalyst::Action');
78 sub _DISPATCH : Private {
79 my ( $self, $c ) = @_;
81 foreach my $disp ( @{ $self->_dispatch_steps } ) {
82 last unless $c->forward($disp);
88 sub _BEGIN : Private {
89 my ( $self, $c ) = @_;
90 my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
91 return 1 unless $begin;
92 $begin->dispatch( $c );
93 return !@{ $c->error };
97 my ( $self, $c ) = @_;
98 my @auto = $c->get_actions( 'auto', $c->namespace );
99 foreach my $auto (@auto) {
100 $auto->dispatch( $c );
101 return 0 unless $c->state;
106 sub _ACTION : Private {
107 my ( $self, $c ) = @_;
109 && $c->action->can('execute')
110 && defined $c->req->action )
112 $c->action->dispatch( $c );
114 return !@{ $c->error };
118 my ( $self, $c ) = @_;
119 my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
120 return 1 unless $end;
121 $end->dispatch( $c );
122 return !@{ $c->error };
126 my ( $self, $name ) = @_;
127 my $app = ($self->isa('Catalyst') ? $self : $self->_application);
128 return $app->dispatcher->get_action($name, $self->action_namespace);
131 #my opinion is that this whole sub really should be a builder method, not
132 #something that happens on every call. Anyone else disagree?? -- groditi
133 ## -- apparently this is all just waiting for app/ctx split
134 around action_namespace => sub {
136 my ( $self, $c ) = @_;
139 return $self->$orig if $self->has_action_namespace;
141 return $self->config->{namespace} if exists $self->config->{namespace};
146 $case_s = $c->config->{case_sensitive};
148 if ($self->isa('Catalyst')) {
149 $case_s = $self->config->{case_sensitive};
152 $case_s = $self->_application->config->{case_sensitive};
154 confess("Can't figure out case_sensitive setting");
159 my $namespace = Catalyst::Utils::class2prefix(ref($self) || $self, $case_s) || '';
160 $self->$orig($namespace) if ref($self);
164 #Once again, this is probably better written as a builder method
165 around path_prefix => sub {
169 return $self->$orig if $self->has_path_prefix;
171 return $self->config->{path} if exists $self->config->{path};
173 my $namespace = $self->action_namespace(@_);
174 $self->$orig($namespace) if ref($self);
178 sub get_action_methods {
180 my $meta = find_meta($self);
181 confess("Metaclass for "
182 . ref($meta) . " for "
184 . " cannot support register_actions." )
185 unless $meta->can('get_nearest_methods_with_attributes');
186 my @methods = $meta->get_nearest_methods_with_attributes;
188 # actions specified via config are also action_methods
192 $meta->find_method_by_name($_)
193 || confess( 'Action "'
195 . '" is not available from controller '
197 } keys %{ $self->_controller_actions }
203 sub register_actions {
204 my ( $self, $c ) = @_;
205 $self->register_action_methods( $c, $self->get_action_methods );
208 sub register_action_methods {
209 my ( $self, $c, @methods ) = @_;
210 my $class = ref $self || $self;
211 #this is still not correct for some reason.
212 my $namespace = $self->action_namespace($c);
214 foreach my $method (@methods) {
215 my $name = $method->name;
216 my $attributes = $method->attributes;
217 my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
218 if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
219 $c->log->debug( 'Bad action definition "'
220 . join( ' ', @{ $attributes } )
221 . qq/" for "$class->$name"/ )
225 my $reverse = $namespace ? "${namespace}/${name}" : $name;
226 my $action = $self->create_action(
228 code => $method->body,
230 namespace => $namespace,
232 attributes => $attrs,
235 $c->dispatcher->register( $c, $action );
243 my $class = (exists $args{attributes}{ActionClass}
244 ? $args{attributes}{ActionClass}[0]
245 : $self->_action_class);
247 Class::MOP::load_class($class);
248 return $class->new( \%args );
252 my ( $self, $c, $name, @attrs ) = @_;
256 foreach my $attr (@attrs) {
258 # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
260 if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
263 if ( defined $value ) {
264 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
266 push( @{ $raw_attributes{$key} }, $value );
270 #I know that the original behavior was to ignore action if actions was set
271 # but i actually think this may be a little more sane? we can always remove
272 # the merge behavior quite easily and go back to having actions have
273 # presedence over action by modifying the keys. i honestly think this is
274 # superior while mantaining really high degree of compat
277 $actions = $self->_controller_actions;
279 my $cfg = $self->config;
280 $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
283 %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
285 (exists $actions->{$name} ? %{$actions->{$name}} : ()));
288 my %final_attributes;
290 foreach my $key (keys %raw_attributes) {
292 my $raw = $raw_attributes{$key};
294 foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
296 my $meth = "_parse_${key}_attr";
297 if ( my $code = $self->can($meth) ) {
298 ( $key, $value ) = $self->$code( $c, $name, $value );
300 push( @{ $final_attributes{$key} }, $value );
304 return \%final_attributes;
307 sub _parse_Global_attr {
308 my ( $self, $c, $name, $value ) = @_;
309 return $self->_parse_Path_attr( $c, $name, "/$name" );
312 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
314 sub _parse_Local_attr {
315 my ( $self, $c, $name, $value ) = @_;
316 return $self->_parse_Path_attr( $c, $name, $name );
319 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
321 sub _parse_Path_attr {
322 my ( $self, $c, $name, $value ) = @_;
323 $value = '' if !defined $value;
324 if ( $value =~ m!^/! ) {
325 return ( 'Path', $value );
327 elsif ( length $value ) {
328 return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
331 return ( 'Path', $self->path_prefix($c) );
335 sub _parse_Regex_attr {
336 my ( $self, $c, $name, $value ) = @_;
337 return ( 'Regex', $value );
340 sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
342 sub _parse_LocalRegex_attr {
343 my ( $self, $c, $name, $value ) = @_;
344 unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
346 my $prefix = $self->path_prefix( $c );
347 $prefix .= '/' if length( $prefix );
349 return ( 'Regex', "^${prefix}${value}" );
352 sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
354 sub _parse_Chained_attr {
355 my ($self, $c, $name, $value) = @_;
357 if (defined($value) && length($value)) {
359 $value = '/'.$self->action_namespace($c);
360 } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
361 my @parts = split '/', $self->action_namespace($c);
362 my @levels = split '/', $rel;
364 $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
365 } elsif ($value !~ m/^\//) {
366 my $action_ns = $self->action_namespace($c);
369 $value = '/'.join('/', $action_ns, $value);
371 $value = '/'.$value; # special case namespace '' (root)
378 return Chained => $value;
381 sub _parse_ChainedParent_attr {
382 my ($self, $c, $name, $value) = @_;
383 return $self->_parse_Chained_attr($c, $name, '../'.$name);
386 sub _parse_PathPrefix_attr {
387 my ( $self, $c ) = @_;
388 return PathPart => $self->path_prefix($c);
391 sub _parse_ActionClass_attr {
392 my ( $self, $c, $name, $value ) = @_;
393 my $appname = $self->_application;
394 $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
395 return ( 'ActionClass', $value );
398 sub _parse_MyAction_attr {
399 my ( $self, $c, $name, $value ) = @_;
401 my $appclass = Catalyst::Utils::class2appclass($self);
402 $value = "${appclass}::Action::${value}";
404 return ( 'ActionClass', $value );
407 __PACKAGE__->meta->make_immutable;
415 Like any other L<Catalyst::Component>, controllers have a config hash,
416 accessible through $self->config from the controller actions. Some
417 settings are in use by the Catalyst framework:
421 This specifies the internal namespace the controller should be bound
422 to. By default the controller is bound to the URI version of the
423 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
424 will be bound to 'foo/bar'. The default Root controller is an example
425 of setting namespace to '' (the null string).
429 Sets 'path_prefix', as described below.
433 =head2 BUILDARGS ($app, @args)
435 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
436 instance as $self->_application.
438 =head2 $self->action_for('name')
440 Returns the Catalyst::Action object (if any) for a given method name
443 =head2 $self->action_namespace($c)
445 Returns the private namespace for actions in this component. Defaults
446 to a value from the controller name (for
447 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
448 overridden from the "namespace" config key.
451 =head2 $self->path_prefix($c)
453 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
454 relative :Path actions in this component. Defaults to the action_namespace or
455 can be overridden from the "path" config key.
457 =head2 $self->register_actions($c)
459 Finds all applicable actions for this component, creates
460 Catalyst::Action objects (using $self->create_action) for them and
461 registers them with $c->dispatcher.
463 =head2 $self->get_action_methods()
465 Returns a list of L<Moose::Meta::Method> objects, doing the
466 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
467 action methods for this package.
469 =head2 $self->register_action_methods($c, @methods)
471 Creates action objects for a set of action methods using C< create_action >,
472 and registers them with the dispatcher.
474 =head2 $self->create_action(%args)
476 Called with a hash of data to be use for construction of a new
477 Catalyst::Action (or appropriate sub/alternative class) object.
479 =head2 $self->_application
483 Returns the application instance stored by C<new()>
487 Catalyst Contributors, see Catalyst.pm
491 This library is free software. You can redistribute it and/or modify
492 it under the same terms as Perl itself.