X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FBase.pm;h=65f3120e4864da536822d3745875d771c9202287;hb=d666af81cece84d49c57bb91949641937ad57091;hp=f667feae78ff1036921744167e9424af625888ce;hpb=158c88c0db581dcee202cd854c77186590c2992c;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm index f667fea..65f3120 100644 --- a/lib/Catalyst/Base.pm +++ b/lib/Catalyst/Base.pm @@ -8,9 +8,10 @@ use Catalyst::Utils; use Class::Inspector; use NEXT; -__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps/; +__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/; __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] ); +__PACKAGE__->_action_class('Catalyst::Action'); sub _DISPATCH : Private { my ( $self, $c ) = @_; @@ -24,17 +25,17 @@ sub _DISPATCH : Private { sub _BEGIN : Private { my ( $self, $c ) = @_; - my $begin = ($c->get_actions( 'begin', $c->namespace))[-1]; + my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1]; return 1 unless $begin; - $begin->execute($c); + $begin->dispatch( $c ); return !@{ $c->error }; } sub _AUTO : Private { my ( $self, $c ) = @_; - my @auto = $c->get_actions('auto', $c->namespace); + my @auto = $c->get_actions( 'auto', $c->namespace ); foreach my $auto (@auto) { - $auto->execute($c); + $auto->dispatch( $c ); return 0 unless $c->state; } return 1; @@ -42,96 +43,265 @@ sub _AUTO : Private { sub _ACTION : Private { my ( $self, $c ) = @_; - $c->action->execute($c); + if ( ref $c->action + && $c->action->can('execute') + && $c->req->action ) + { + $c->action->dispatch( $c ); + } return !@{ $c->error }; } sub _END : Private { my ( $self, $c ) = @_; - my $end = ($c->get_actions( 'end', $c->namespace))[-1]; + my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1]; return 1 unless $end; - $end->execute($c); + $end->dispatch( $c ); return !@{ $c->error }; } +sub new { + my $self = shift; + my $app = $_[0]; + my $new = $self->NEXT::new(@_); + $new->{application} = $app; + return $new; +} + +=head1 NAME + +Catalyst::Base - Catalyst Base Class + +=head1 SYNOPSIS + +See L + +=head1 DESCRIPTION + +Catalyst Base Class + +This is the base class for all Catalyst components. It also handles +dispatch of actions for controllers. + +=head1 METHODS + +=head2 $self->action_for('name') + +Returns the Catalyst::Action object (if any) for a given method name in +this component. + +=cut + +sub action_for { + my ( $self, $name ) = @_; + my $app = ($self->isa('Catalyst') ? $self : $self->{application}); + return $app->dispatcher->get_action($name, $self->action_namespace); +} + +=head2 $self->action_namespace($c) + +Returns the private namespace for actions in this component. Defaults to a value +from the controller name (for e.g. MyApp::Controller::Foo::Bar becomes +"foo/bar") or can be overriden from the "namespace" config key. + +=cut + sub action_namespace { my ( $self, $c ) = @_; - return - Catalyst::Utils::class2prefix( - ref $self, $c->config->{case_sensitive} ) || ''; + unless ( $c ) { + $c = ($self->isa('Catalyst') ? $self : $self->{application}); + } + my $hash = (ref $self ? $self : $self->config); # hate app-is-class + return $hash->{namespace} if exists $hash->{namespace}; + return Catalyst::Utils::class2prefix( ref($self) || $self, + $c->config->{case_sensitive} ) + || ''; } +=head2 $self->path_prefix($c) + +Returns the default path prefix for :Local, :LocalRegex and relative :Path +actions in this component. Defaults to the action_namespace or can be +overriden from the "path" config key. + +=cut + +sub path_prefix { + my ( $self, $c ) = @_; + unless ( $c ) { + $c = ($self->isa('Catalyst') ? $self : $self->{application}); + } + my $hash = (ref $self ? $self : $self->config); # hate app-is-class + return $hash->{path} if exists $hash->{path}; + return shift->action_namespace(@_); +} + +=head2 $self->register_actions($c) + +register all actions for this component based on a given context. + +=cut + sub register_actions { my ( $self, $c ) = @_; my $class = ref $self || $self; - my $namespace = $self->action_namespace( $c ); + my $namespace = $self->action_namespace($c); my %methods; - $methods{$self->can($_)} = $_ for @{Class::Inspector->methods($class)||[]}; - foreach my $cache (@{$self->_action_cache}) { - my $code = $cache->[0]; - my $method = $methods{$code}; + $methods{ $self->can($_) } = $_ + for @{ Class::Inspector->methods($class) || [] }; + + # Advanced inheritance support for plugins and the like + my @action_cache; + { + no strict 'refs'; + for my $isa ( @{"$class\::ISA"}, $class ) { + push @action_cache, @{ $isa->_action_cache } + if $isa->can('_action_cache'); + } + } + + 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(@{$cache->[1]}); - if ($attrs->{Private} && ( keys %$attrs > 1 ) ) { + my $attrs = $self->_parse_attrs( $c, $method, @{ $cache->[1] } ); + if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) { $c->log->debug( 'Bad action definition "' - . join( ' ', @{$cache->[1]} ) + . join( ' ', @{ $cache->[1] } ) . qq/" for "$class->$method"/ ) if $c->debug; next; } my $reverse = $namespace ? "$namespace/$method" : $method; - my $action = Catalyst::Action->new( - { - name => $method, - code => $code, - reverse => $reverse, - namespace => $namespace, - class => $class, - attributes => $attrs, - } + my $action = $self->create_action( + name => $method, + code => $code, + reverse => $reverse, + namespace => $namespace, + class => $class, + attributes => $attrs, ); - $c->dispatcher->register($c, $action); + + $c->dispatcher->register( $c, $action ); + } +} + +sub create_action { + my $self = shift; + my %args = @_; + + my $class = (exists $args{attributes}{ActionClass} + ? $args{attributes}{ActionClass}[0] + : $self->_action_class); + + unless ( Class::Inspector->loaded($class) ) { + require Class::Inspector->filename($class); } + + return $class->new( \%args ); } sub _parse_attrs { - my ( $self, @attrs ) = @_; - my %attributes; + my ( $self, $c, $name, @attrs ) = @_; + + my %raw_attributes; + foreach my $attr (@attrs) { # Parse out :Foo(bar) into Foo => bar etc (and arrayify) - if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) { + if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) ) + { if ( defined $value ) { ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); } - push( @{ $attributes{$key} }, $value ); + push( @{ $raw_attributes{$key} }, $value ); + } + } + + my $hash = (ref $self ? $self : $self->config); # hate app-is-class + + if (exists $hash->{actions} || exists $hash->{action}) { + my $a = $hash->{actions} || $hash->{action}; + %raw_attributes = ((exists $a->{'*'} ? %{$a->{'*'}} : ()), + %raw_attributes, + (exists $a->{$name} ? %{$a->{$name}} : ())); + } + + my %final_attributes; + + foreach my $key (keys %raw_attributes) { + + my $raw = $raw_attributes{$key}; + + foreach my $value (ref($raw) ? @$raw : $raw) { + + my $meth = "_parse_${key}_attr"; + if ( $self->can($meth) ) { + ( $key, $value ) = $self->$meth( $c, $name, $value ); + } + push( @{ $final_attributes{$key} }, $value ); } } - return \%attributes; + + return \%final_attributes; } +sub _parse_Global_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, "/$name" ); +} -=head1 NAME +sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); } -Catalyst::Base - Catalyst Controller Base Class +sub _parse_Local_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, $name ); +} -=head1 SYNOPSIS +sub _parse_Relative_attr { shift->_parse_Local_attr(@_); } +sub _parse_Path_attr { + my ( $self, $c, $name, $value ) = @_; + $value ||= ''; + if ( $value =~ m!^/! ) { + return ( 'Path', $value ); + } + elsif ( length $value ) { + return ( 'Path', join( '/', $self->path_prefix($c), $value ) ); + } + else { + return ( 'Path', $self->path_prefix($c) ); + } +} -=head1 DESCRIPTION +sub _parse_Regex_attr { + my ( $self, $c, $name, $value ) = @_; + return ( 'Regex', $value ); +} +sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); } -=head1 METHODS +sub _parse_LocalRegex_attr { + my ( $self, $c, $name, $value ) = @_; + unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; } + return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" ); +} -=over 4 +sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); } -=back +sub _parse_ActionClass_attr { + my ( $self, $c, $name, $value ) = @_; + unless ( $value =~ s/^\+// ) { + $value = join('::', $self->_action_class, $value ); + } + return ( 'ActionClass', $value ); +} =head1 SEE ALSO -L. +L, L. =head1 AUTHOR