X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FController.pm;h=fb6df0dfd170c3b1e51729dee95a4f186231c2cf;hp=18c825968deb622fdadddf5e6f947652658e80ca;hb=aea897b2495d079f3849eb30cd3dc7c89b31f742;hpb=ae29b412955743885e80350085167b54b69672da diff --git a/lib/Catalyst/Controller.pm b/lib/Catalyst/Controller.pm index 18c8259..fb6df0d 100644 --- a/lib/Catalyst/Controller.pm +++ b/lib/Catalyst/Controller.pm @@ -2,46 +2,62 @@ package Catalyst::Controller; use Moose; use Moose::Util qw/find_meta/; - +use List::MoreUtils qw/uniq/; use namespace::clean -except => 'meta'; -# Note - Must be done at compile time due to attributes (::AttrContainer) -BEGIN { extends qw/Catalyst::Component Catalyst::AttrContainer/; } +BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; } +use MooseX::MethodAttributes; use Catalyst::Exception; use Catalyst::Utils; with 'Catalyst::Component::ApplicationAttribute'; -has path_prefix => - ( - is => 'rw', - isa => 'Str', - init_arg => 'path', - predicate => 'has_path_prefix', - ); - -has action_namespace => - ( - is => 'rw', - isa => 'Str', - init_arg => 'namespace', - predicate => 'has_action_namespace', - ); - -has actions => - ( - is => 'rw', - isa => 'HashRef', - init_arg => undef, - ); +has path_prefix => ( + is => 'rw', + isa => 'Str', + init_arg => 'path', + predicate => 'has_path_prefix', +); + +has action_namespace => ( + is => 'rw', + isa => 'Str', + init_arg => 'namespace', + predicate => 'has_action_namespace', +); + +has actions => ( + accessor => '_controller_actions', + isa => 'HashRef', + init_arg => undef, +); + +has action_args => (is => 'ro'); + +# ->config(actions => { '*' => ... +has _all_actions_attributes => ( + is => 'ro', + isa => 'HashRef', + init_arg => undef, + lazy => 1, + builder => '_build__all_actions_attributes', +); sub BUILD { my ($self, $args) = @_; 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); + + # trigger lazy builder + $self->_all_actions_attributes; +} + +sub _build__all_actions_attributes { + my ($self) = @_; + delete $self->_controller_actions->{'*'} || {}; } =head1 NAME @@ -53,9 +69,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 @@ -128,35 +144,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; }; @@ -175,41 +193,64 @@ around path_prefix => sub { return $namespace; }; +sub get_action_methods { + my $self = shift; + my $meta = find_meta($self) || confess("No metaclass setup for $self"); + confess( + sprintf "Metaclass %s for %s cannot support register_actions.", + ref $meta, $meta->name, + ) 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( sprintf 'Action "%s" is not available from controller %s', + $_, ref $self ) + } keys %{ $self->_controller_actions } + ) if ( ref $self ); + return uniq @methods; +} + sub register_actions { my ( $self, $c ) = @_; - my $class = ref $self || $self; + $self->register_action_methods( $c, $self->get_action_methods ); +} + +sub register_action_methods { + my ( $self, $c, @methods ) = @_; + my $class = $self->catalyst_component_name; #this is still not correct for some reason. my $namespace = $self->action_namespace($c); - my $meta = find_meta($self); - my %methods = map { $_->body => $_->name } - $meta->get_all_methods; - - # Advanced inheritance support for plugins and the like - #moose todo: migrate to eliminate CDI compat - my @action_cache; - for my $isa ( $meta->superclasses, $class ) { - if(my $coderef = $isa->can('_action_cache')){ - push(@action_cache, @{ $isa->$coderef }); + + # 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 $cache (@action_cache) { - my $code = $cache->[0]; - my $method = delete $methods{$code}; # avoid dupe registers - next unless $method; - my $attrs = $self->_parse_attrs( $c, $method, @{ $cache->[1] } ); + foreach my $method (@methods) { + my $name = $method->name; + # Horrible hack! All method metaclasses should have an attributes + # method, core Moose bug - see r13354. + my $attributes = $method->can('attributes') ? $method->attributes : []; + my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } ); if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) { $c->log->debug( 'Bad action definition "' - . join( ' ', @{ $cache->[1] } ) - . qq/" for "$class->$method"/ ) + . join( ' ', @{ $attributes } ) + . qq/" for "$class->$name"/ ) if $c->debug; next; } - my $reverse = $namespace ? "${namespace}/${method}" : $method; + my $reverse = $namespace ? "${namespace}/${name}" : $name; my $action = $self->create_action( - name => $method, - code => $code, + name => $name, + code => $method->body, reverse => $reverse, namespace => $namespace, class => $class, @@ -220,16 +261,35 @@ sub register_actions { } } -sub create_action { +sub action_class { my $self = shift; my %args = @_; my $class = (exists $args{attributes}{ActionClass} - ? $args{attributes}{ActionClass}[0] - : $self->_action_class); + ? $args{attributes}{ActionClass}[0] + : $self->_action_class); Class::MOP::load_class($class); - return $class->new( \%args ); + return $class; +} + +sub create_action { + my $self = shift; + my %args = @_; + + my $class = $self->action_class(%args); + my $action_args = ( + ref($self) + ? $self->action_args + : $self->config->{action_args} + ); + + my %extra_args = ( + %{ $action_args->{'*'} || {} }, + %{ $action_args->{ $args{name} } || {} }, + ); + + return $class->new({ %extra_args, %args }); } sub _parse_attrs { @@ -251,23 +311,32 @@ sub _parse_attrs { } } - #I know that the original behavior was to ignore action if actions was set - # but i actually think this may be a little more sane? we can always remove - # the merge behavior quite easily and go back to having actions have - # presedence over action by modifying the keys. i honestly think this is - # superior while mantaining really high degree of compat - my $actions; + my ($actions_config, $all_actions_config); if( ref($self) ) { - $actions = $self->actions; + $actions_config = $self->_controller_actions; + # No, you're not getting actions => { '*' => ... } with actions in MyApp. + $all_actions_config = $self->_all_actions_attributes; } else { my $cfg = $self->config; - $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action}); + $actions_config = $self->merge_config_hashes($cfg->{actions}, $cfg->{action}); + $all_actions_config = {}; } - %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()), - %raw_attributes, - (exists $actions->{$name} ? %{$actions->{$name}} : ())); + %raw_attributes = ( + %raw_attributes, + # Note we deep copy array refs here to stop crapping on config + # when attributes are parsed. RT#65463 + exists $actions_config->{$name} ? map { ref($_) eq 'ARRAY' ? [ @$_ ] : $_ } %{ $actions_config->{$name } } : (), + ); + # Private actions with additional attributes will raise a warning and then + # be ignored. Adding '*' arguments to the default _DISPATCH / etc. methods, + # which are Private, will prevent those from being registered. They should + # probably be turned into :Actions instead, or we might want to otherwise + # disambiguate between those built-in internal actions and user-level + # Private ones. + %raw_attributes = (%{ $all_actions_config }, %raw_attributes) + unless $raw_attributes{Private}; my %final_attributes; @@ -329,7 +398,7 @@ sub _parse_LocalRegex_attr { my $prefix = $self->path_prefix( $c ); $prefix .= '/' if length( $prefix ); - + return ( 'Regex', "^${prefix}${value}" ); } @@ -368,15 +437,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 ); } @@ -409,28 +477,62 @@ 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 + +Allows you to set the attributes that the dispatcher creates actions out of. +This allows you to do 'rails style routes', or override some of the +attribute definitions of actions composed from Roles. +You can set arguments globally (for all actions of the controller) and +specifically (for a single action). + + __PACKAGE__->config( + action => { + '*' => { Chained => 'base', Args => 0 }, + base => { Chained => '/', PathPart => '', CaptureArgs => 0 }, + }, + ); + +In the case above every sub in the package would be made into a Chain +endpoint with a URI the same as the sub name for each sub, chained +to the sub named C. Ergo dispatch to C would call the +C method, then the C method. + +=head2 action_args + +Allows you to set constructor arguments on your actions. You can set arguments +globally and specifically (as above). +This is particularly useful when using Cs +(L) and custom Ces. + + __PACKAGE__->config( + action_args => { + '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' }, + 'specific_action' => { customarg => 'arg1' }, + }, + ); + +In the case above the action class associated with C would get +passed the following arguments, in addition to the normal action constructor +arguments, when it is instantiated: + + (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1') + =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 @@ -445,13 +547,33 @@ 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->action_class(%args) + +Used when a controller is creating an action to determine the correct base +action class to use. + =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 @@ -464,7 +586,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