X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController.pm;h=47ec9f0c8db190b300590ded4f54b179979cc9e3;hb=e87273a4374fb0d8da5479a826f9c847a50546cf;hp=81be71d04d5496f1aabdf1600356517767f819da;hpb=c4d02967407405042bdf9ea08223b5582612d8d1;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Controller.pm b/lib/Catalyst/Controller.pm index 81be71d..47ec9f0 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 @@ -134,28 +137,30 @@ 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,27 @@ 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( 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 ) = @_; $self->register_action_methods( $c, $self->get_action_methods ); @@ -191,14 +209,23 @@ 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); + # 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; + # 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 "' @@ -221,16 +248,31 @@ sub register_action_methods { } } -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 = $self->config->{action_args}; + + my %extra_args = ( + %{ $action_args->{'*'} || {} }, + %{ $action_args->{ $args{name} } || {} }, + ); + + return $class->new({ %extra_args, %args }); } sub _parse_attrs { @@ -252,14 +294,9 @@ 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; if( ref($self) ) { - $actions = $self->actions; + $actions = $self->_controller_actions; } else { my $cfg = $self->config; $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action}); @@ -369,15 +406,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 ); } @@ -414,6 +450,46 @@ of setting namespace to '' (the null string). 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 defintions 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 BUILDARGS ($app, @args) @@ -457,6 +533,11 @@ action methods for this package. 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 @@ -474,7 +555,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