X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FBase.pm;h=b1990e9b692eaa599db906f5085fb2563d7028e3;hb=fabf3a100d2255ee3d0d4f7af57b57cd658feceb;hp=c7d21f6c875624cc67cf09a07c49e3064573e37c;hpb=91d4abc5cc6b75fb46cef7aac04f3cb58f6b3551;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm index c7d21f6..b1990e9 100644 --- a/lib/Catalyst/Base.pm +++ b/lib/Catalyst/Base.pm @@ -1,16 +1,17 @@ package Catalyst::Base; use strict; -use base qw/Catalyst::AttrContainer Class::Accessor::Fast/; +use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/; use Catalyst::Exception; use Catalyst::Utils; use Class::Inspector; use NEXT; -__PACKAGE__->mk_classdata($_) for qw/_config _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,7 +25,7 @@ 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); return !@{ $c->error }; @@ -32,7 +33,7 @@ sub _BEGIN : Private { 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); return 0 unless $c->state; @@ -42,173 +43,186 @@ 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->execute($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); return !@{ $c->error }; } +=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_namespace($c) + +Determine the namespace for actions in this component. + +=cut + sub action_namespace { my ( $self, $c ) = @_; - return - Catalyst::Utils::class2prefix( - ref $self, $c->config->{case_sensitive} ) || ''; + return $self->config->{namespace} if exists $self->config->{namespace}; + return Catalyst::Utils::class2prefix( ref($self) || $self, + $c->config->{case_sensitive} ) + || ''; } +=head2 $self->path_prefix($c) + +alias for action_namespace + +=cut + +sub path_prefix { 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]; + $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 = $methods{$code}; 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; + $self->_action_class->new( { @_ } ); +} + sub _parse_attrs { - my ( $self, @attrs ) = @_; + my ( $self, $c, $name, @attrs ) = @_; my %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/ ); } + my $meth = "_parse_${key}_attr"; + if ( $self->can($meth) ) { + ( $key, $value ) = $self->$meth( $c, $name, $value ); + } push( @{ $attributes{$key} }, $value ); } } return \%attributes; } +sub _parse_Global_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, "/$name" ); +} -=head1 NAME - -Catalyst::Base - Catalyst Universal Base Class - -=head1 SYNOPSIS - - # lib/MyApp/Model/Something.pm - package MyApp::Model::Something; +sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); } - use base 'Catalyst::Base'; +sub _parse_Local_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, $name ); +} - __PACKAGE__->config( foo => 'bar' ); +sub _parse_Relative_attr { shift->_parse_Local_attr(@_); } - sub test { - my $self = shift; - return $self->{foo}; +sub _parse_Path_attr { + my ( $self, $c, $name, $value ) = @_; + $value ||= ''; + if ( $value =~ m!^/! ) { + return ( 'Path', $value ); } - - sub forward_to_me { - my ( $self, $c ) = @_; - $c->response->output( $self->{foo} ); + elsif ( length $value ) { + return ( 'Path', join( '/', $self->path_prefix($c), $value ) ); } - - 1; - - # Methods can be a request step - $c->forward(qw/MyApp::Model::Something forward_to_me/); - - # Or just methods - print $c->comp('MyApp::Model::Something')->test; - - print $c->comp('MyApp::Model::Something')->{foo}; - -=head1 DESCRIPTION - -This is the universal base class for Catalyst components -(Model/View/Controller). - -It provides you with a generic new() for instantiation through Catalyst's -component loader with config() support and a process() method placeholder. - -=head1 METHODS - -=over 4 - -=item new($c) - -=cut - -sub new { - my ( $self, $c ) = @_; - - # Temporary fix, some components does not pass context to constructor - my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; - - return $self->NEXT::new( { %{ $self->config }, %{$arguments} } ); -} - -# remember to leave blank lines between the consecutive =item's -# otherwise the pod tools don't recognize the subsequent =items - -=item $c->config - -=item $c->config($hashref) - -=item $c->config($key, $value, ...) - -=cut - -sub config { - my $self = shift; - $self->_config( {} ) unless $self->_config; - if (@_) { - my $config = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$config ) { - $self->_config->{$key} = $val; - } + else { + return ( 'Path', $self->path_prefix($c) ); } - return $self->_config; } -=item $c->process() - -=cut +sub _parse_Regex_attr { + my ( $self, $c, $name, $value ) = @_; + return ( 'Regex', $value ); +} -sub process { +sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); } - Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] ) - . " did not override Catalyst::Base::process" ); +sub _parse_LocalRegex_attr { + my ( $self, $c, $name, $value ) = @_; + unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; } + return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" ); } -=back +sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); } =head1 SEE ALSO -L. +L, L. =head1 AUTHOR