X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FBase.pm;h=561fe9752a3539a5a8f645b7426649eaaebc6d1e;hb=264bac8c94a84d7dbac9912946d1a639fa37d1cd;hp=dd38bea61195066d04cdc42ddc58df76b047fb7e;hpb=a268a0112398ac10d8fabd86ed28a183cbe4398e;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm index dd38bea..561fe97 100644 --- a/lib/Catalyst/Base.pm +++ b/lib/Catalyst/Base.pm @@ -1,126 +1,329 @@ package Catalyst::Base; use strict; -use base qw/Class::Data::Inheritable 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/_attr_cache _action_cache _config/; -__PACKAGE__->_attr_cache( {} ); -__PACKAGE__->_action_cache( [] ); +__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/; -# note - see attributes(3pm) -sub MODIFY_CODE_ATTRIBUTES { - my ( $class, $code, @attrs ) = @_; - $class->_attr_cache->{$code} = [@attrs]; - push @{ $class->_action_cache }, [ $code, [@attrs] ]; - return (); -} +__PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] ); +__PACKAGE__->_action_class('Catalyst::Action'); -sub FETCH_CODE_ATTRIBUTES { $_[0]->_attr_cache->{ $_[1] } || () } +sub _DISPATCH : Private { + my ( $self, $c ) = @_; -=head1 NAME + foreach my $disp ( @{ $self->_dispatch_steps } ) { + last unless $c->forward($disp); + } -Catalyst::Base - Catalyst Universal Base Class + $c->forward('_END'); +} -=head1 SYNOPSIS +sub _BEGIN : Private { + my ( $self, $c ) = @_; + my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1]; + return 1 unless $begin; + $begin->dispatch( $c ); + return !@{ $c->error }; +} - # lib/MyApp/Model/Something.pm - package MyApp::Model::Something; +sub _AUTO : Private { + my ( $self, $c ) = @_; + my @auto = $c->get_actions( 'auto', $c->namespace ); + foreach my $auto (@auto) { + $auto->dispatch( $c ); + return 0 unless $c->state; + } + return 1; +} - use base 'Catalyst::Base'; +sub _ACTION : Private { + my ( $self, $c ) = @_; + if ( ref $c->action + && $c->action->can('execute') + && $c->req->action ) + { + $c->action->dispatch( $c ); + } + return !@{ $c->error }; +} - __PACKAGE__->config( foo => 'bar' ); +sub _END : Private { + my ( $self, $c ) = @_; + my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1]; + return 1 unless $end; + $end->dispatch( $c ); + return !@{ $c->error }; +} - sub test { - my $self = shift; - return $self->{foo}; - } +sub new { + my $self = shift; + my $app = $_[0]; + my $new = $self->NEXT::new(@_); + $new->{application} = $app; + return $new; +} - sub forward_to_me { - my ( $self, $c ) = @_; - $c->response->output( $self->{foo} ); - } - - 1; +=head1 NAME - # Methods can be a request step - $c->forward(qw/MyApp::Model::Something forward_to_me/); +Catalyst::Base - Catalyst Base Class - # Or just methods - print $c->comp('MyApp::Model::Something')->test; +=head1 SYNOPSIS - print $c->comp('MyApp::Model::Something')->{foo}; +See L =head1 DESCRIPTION -This is the universal base class for Catalyst components -(Model/View/Controller). +Catalyst Base Class -It provides you with a generic new() for instantiation through Catalyst's -component loader with config() support and a process() method placeholder. +This is the base class for all Catalyst components. It also handles +dispatch of actions for controllers. =head1 METHODS -=over 4 +=head2 $class->new($app, @args) + +Proxies through to NEXT::new and stashes the application instance as +$self->{application}. -=item new($c) +=head2 $self->action_for('name') + +Returns the Catalyst::Action object (if any) for a given method name in +this component. =cut -sub new { +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 ) = @_; - - # Temporary fix, some components does not pass context to constructor - my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; + 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 - return $self->NEXT::new( { %{ $self->config }, %{ $arguments } } ); +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(@_); } -# remember to leave blank lines between the consecutive =item's -# otherwise the pod tools don't recognize the subsequent =items +=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. + +=cut + +sub register_actions { + my ( $self, $c ) = @_; + my $class = ref $self || $self; + my $namespace = $self->action_namespace($c); + my %methods; + $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'); + } + } -=item $c->config + 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] } ); + if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) { + $c->log->debug( 'Bad action definition "' + . join( ' ', @{ $cache->[1] } ) + . qq/" for "$class->$method"/ ) + if $c->debug; + next; + } + my $reverse = $namespace ? "$namespace/$method" : $method; + my $action = $self->create_action( + name => $method, + code => $code, + reverse => $reverse, + namespace => $namespace, + class => $class, + attributes => $attrs, + ); + + $c->dispatcher->register( $c, $action ); + } +} + +=head2 $self->create_action(%args) -=item $c->config($hashref) +Called with a hash of data to be use for construction of a new Catalyst::Action +(or appropriate sub/alternative class) object. -=item $c->config($key, $value, ...) +Primarily designed for the use of register_actions. =cut -sub config { +sub create_action { my $self = shift; - $self->_config( {} ) unless $self->_config; - if (@_) { - my $config = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$config ) { - $self->_config->{$key} = $val; + 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, $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 ( defined $value ) { + ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); + } + 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) eq 'ARRAY' ? @$raw : $raw) { + + my $meth = "_parse_${key}_attr"; + if ( $self->can($meth) ) { + ( $key, $value ) = $self->$meth( $c, $name, $value ); + } + push( @{ $final_attributes{$key} }, $value ); } } - return $self->_config; + + return \%final_attributes; } -=item $c->process() +sub _parse_Global_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, "/$name" ); +} -=cut +sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); } + +sub _parse_Local_attr { + my ( $self, $c, $name, $value ) = @_; + return $self->_parse_Path_attr( $c, $name, $name ); +} + +sub _parse_Relative_attr { shift->_parse_Local_attr(@_); } -sub process { - die( ( ref $_[0] || $_[0] ) . " did not override Catalyst::Base::process" ); +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) ); + } } -=item FETCH_CODE_ATTRIBUTES +sub _parse_Regex_attr { + my ( $self, $c, $name, $value ) = @_; + return ( 'Regex', $value ); +} -=item MODIFY_CODE_ATTRIBUTES +sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); } -=back +sub _parse_LocalRegex_attr { + my ( $self, $c, $name, $value ) = @_; + unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; } + return ( 'Regex', '^' . $self->path_prefix($c) . "/${value}" ); +} + +sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); } + +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 Sebastian Riedel, C Marcus Ramberg, C +Matt S Trout, C =head1 COPYRIGHT