X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController.pm;h=ee39c7b86b2db48a909dd13007b584ac8f8f8f5a;hb=c813664857bab8bd99687041937b078b9590bf0c;hp=f98a8d55cc674384ac5b7ec86ffb3b255732ed9d;hpb=9ab7d83d1c7106860b01e3c17c334a2794d9bd0a;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Controller.pm b/lib/Catalyst/Controller.pm index f98a8d5..ee39c7b 100644 --- a/lib/Catalyst/Controller.pm +++ b/lib/Catalyst/Controller.pm @@ -2,11 +2,12 @@ package Catalyst::Controller; use Moose; use Moose::Util qw/find_meta/; - +use List::MoreUtils qw/uniq/; use namespace::clean -except => 'meta'; BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; } +use MooseX::MethodAttributes; use Catalyst::Exception; use Catalyst::Utils; @@ -30,7 +31,7 @@ has action_namespace => has actions => ( - is => 'rw', + accessor => '_controller_actions', isa => 'HashRef', init_arg => undef, ); @@ -40,9 +41,11 @@ sub BUILD { my $action = delete $args->{action} || {}; my $actions = delete $args->{actions} || {}; my $attr_value = $self->merge_config_hashes($actions, $action); - $self->actions($attr_value); + $self->_controller_actions($attr_value); } + + =head1 NAME Catalyst::Controller - Catalyst Controller base class @@ -52,9 +55,9 @@ Catalyst::Controller - Catalyst Controller base class package MyApp::Controller::Search use base qw/Catalyst::Controller/; - sub foo : Local { + sub foo : Local { my ($self,$c,@args) = @_; - ... + ... } # Dispatches to /search/foo =head1 DESCRIPTION @@ -127,35 +130,37 @@ sub action_for { return $app->dispatcher->get_action($name, $self->action_namespace); } -#my opinion is that this whole sub really should be a builder method, not +#my opinion is that this whole sub really should be a builder method, not #something that happens on every call. Anyone else disagree?? -- groditi ## -- apparently this is all just waiting for app/ctx split around action_namespace => sub { my $orig = shift; my ( $self, $c ) = @_; + my $class = ref($self) || $self; + my $appclass = ref($c) || $c; if( ref($self) ){ return $self->$orig if $self->has_action_namespace; } else { - return $self->config->{namespace} if exists $self->config->{namespace}; + return $class->config->{namespace} if exists $class->config->{namespace}; } my $case_s; if( $c ){ - $case_s = $c->config->{case_sensitive}; + $case_s = $appclass->config->{case_sensitive}; } else { if ($self->isa('Catalyst')) { - $case_s = $self->config->{case_sensitive}; + $case_s = $class->config->{case_sensitive}; } else { if (ref $self) { - $case_s = $self->_application->config->{case_sensitive}; + $case_s = ref($self->_application)->config->{case_sensitive}; } else { confess("Can't figure out case_sensitive setting"); } } } - my $namespace = Catalyst::Utils::class2prefix(ref($self) || $self, $case_s) || ''; + my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || ''; $self->$orig($namespace) if ref($self); return $namespace; }; @@ -176,14 +181,29 @@ around path_prefix => sub { sub get_action_methods { my $self = shift; - my $meta = find_meta($self); - confess("Metaclass for " . ref($meta) ." for " . $meta->name - . " cannot support register_actions.") - unless $meta->can('get_all_methods_with_attributes'); - my @methods = $meta->get_all_methods_with_attributes; - return @methods; + my $meta = find_meta($self) || confess("No metaclass setup for $self"); + confess("Metaclass " + . ref($meta) . " for " + . $meta->name + . " cannot support register_actions." ) + unless $meta->can('get_nearest_methods_with_attributes'); + my @methods = $meta->get_nearest_methods_with_attributes; + + # actions specified via config are also action_methods + push( + @methods, + map { + $meta->find_method_by_name($_) + || confess( 'Action "' + . $_ + . '" is not available from controller ' + . ( ref $self ) ) + } keys %{ $self->_controller_actions } + ) if ( ref $self ); + return uniq @methods; } + sub register_actions { my ( $self, $c ) = @_; $self->register_action_methods( $c, $self->get_action_methods ); @@ -191,15 +211,21 @@ sub register_actions { sub register_action_methods { my ( $self, $c, @methods ) = @_; - my $class = ref $self || $self; + my $class = $self->catalyst_component_name; #this is still not correct for some reason. my $namespace = $self->action_namespace($c); - my @methods = $meta->get_all_methods_with_attributes; + + # FIXME - fugly + if (!blessed($self) && $self eq $c && scalar(@methods)) { + my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods; + if (scalar(@really_bad_methods)) { + $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."); + } + } foreach my $method (@methods) { my $name = $method->name; my $attributes = $method->attributes; - next unless $attributes; my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } ); if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) { $c->log->debug( 'Bad action definition "' @@ -229,9 +255,15 @@ sub create_action { my $class = (exists $args{attributes}{ActionClass} ? $args{attributes}{ActionClass}[0] : $self->_action_class); - Class::MOP::load_class($class); - return $class->new( \%args ); + + my $action_args = $self->config->{action_args}; + my %extra_args = ( + %{ $action_args->{'*'} || {} }, + %{ $action_args->{ $args{name} } || {} }, + ); + + return $class->new({ %extra_args, %args }); } sub _parse_attrs { @@ -260,7 +292,7 @@ sub _parse_attrs { # superior while mantaining really high degree of compat my $actions; if( ref($self) ) { - $actions = $self->actions; + $actions = $self->_controller_actions; } else { my $cfg = $self->config; $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action}); @@ -331,7 +363,7 @@ sub _parse_LocalRegex_attr { my $prefix = $self->path_prefix( $c ); $prefix .= '/' if length( $prefix ); - + return ( 'Regex', "^${prefix}${value}" ); } @@ -370,15 +402,14 @@ sub _parse_ChainedParent_attr { } sub _parse_PathPrefix_attr { - my $self = shift; - return PathPart => $self->path_prefix; + my ( $self, $c ) = @_; + return PathPart => $self->path_prefix($c); } sub _parse_ActionClass_attr { my ( $self, $c, $name, $value ) = @_; - unless ( $value =~ s/^\+// ) { - $value = join('::', $self->_action_class, $value ); - } + my $appname = $self->_application; + $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value); return ( 'ActionClass', $value ); } @@ -411,28 +442,51 @@ controller name. For instance controller 'MyApp::Controller::Foo::Bar' will be bound to 'foo/bar'. The default Root controller is an example of setting namespace to '' (the null string). -=head2 path +=head2 path Sets 'path_prefix', as described below. +=head2 action_args + +Allows you to set instantiation arguments on your custom Actions or ActionRoles. +You can set args globally (shared across all actions) and specifically (for a +single action). + + package MyApp::Web::Controller::MyController; + use parent 'Catalyst::Controller'; + + __PACKAGE__->config({ + action_args => { + '*' => {globalarg1=>'hello', globalarg2=>'goodbye'}, + 'specific_action' => {customarg=>'arg1'}, + }, + }); + + sub specific_action :Path('') ActionClass('CustomActionClass') {} + + 1; + +In the case above, your 'CustomActionClass' would get passed the following +arguments when it is instantiated: (globalarg1=>'hello', globalarg2=>'goodbye', +'customarg=>'arg1'). Please note that the order the arguments are passed are not +certain to be in the order declared. + +As with all other configuration hashes, you can set values inline with your +controller (as above) or centrally via a configuration file (such as you might +use with the ConfigLoader plugin). + =head1 METHODS -=head2 $class->new($app, @args) +=head2 BUILDARGS ($app, @args) -Proxies through to NEXT::new and stashes the application instance as -$self->_application. +From L, stashes the application +instance as $self->_application. =head2 $self->action_for('name') Returns the Catalyst::Action object (if any) for a given method name in this component. -=head2 $self->register_actions($c) - -Finds all applicable actions for this component, creates -Catalyst::Action objects (using $self->create_action) for them and -registers them with $c->dispatcher. - =head2 $self->action_namespace($c) Returns the private namespace for actions in this component. Defaults @@ -447,13 +501,28 @@ Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and relative :Path actions in this component. Defaults to the action_namespace or can be overridden from the "path" config key. +=head2 $self->register_actions($c) + +Finds all applicable actions for this component, creates +Catalyst::Action objects (using $self->create_action) for them and +registers them with $c->dispatcher. + +=head2 $self->get_action_methods() + +Returns a list of L objects, doing the +L role, which are the set of +action methods for this package. + +=head2 $self->register_action_methods($c, @methods) + +Creates action objects for a set of action methods using C< create_action >, +and registers them with the dispatcher. + =head2 $self->create_action(%args) Called with a hash of data to be use for construction of a new Catalyst::Action (or appropriate sub/alternative class) object. -Primarily designed for the use of register_actions. - =head2 $self->_application =head2 $self->_app @@ -466,7 +535,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut