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/_attrcache _cache _config/;
-__PACKAGE__->_attrcache( {} );
-__PACKAGE__->_cache( [] );
-
-# note - see attributes(3pm)
-sub MODIFY_CODE_ATTRIBUTES {
- my ( $class, $code, @attrs ) = @_;
- $class->_attrcache->{$code} = [@attrs];
- push @{ $class->_cache }, [ $code, [@attrs] ];
- return ();
-}
-
-sub FETCH_CODE_ATTRIBUTES { $_[0]->_attrcache->{ $_[1] } || () }
+__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
-=head1 NAME
-
-Catalyst::Base - Catalyst Universal Base Class
+__PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
+__PACKAGE__->_action_class('Catalyst::Action');
-=head1 SYNOPSIS
+sub _DISPATCH : Private {
+ my ( $self, $c ) = @_;
- # lib/MyApp/Model/Something.pm
- package MyApp::Model::Something;
+ foreach my $disp ( @{ $self->_dispatch_steps } ) {
+ last unless $c->forward($disp);
+ }
- use base 'Catalyst::Base';
+ $c->forward('_END');
+}
- __PACKAGE__->config( foo => 'bar' );
+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 };
+}
- sub test {
- my $self = shift;
- return $self->{foo};
+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;
+}
- sub forward_to_me {
- my ( $self, $c ) = @_;
- $c->response->output( $self->{foo} );
+sub _ACTION : Private {
+ my ( $self, $c ) = @_;
+ if ( ref $c->action
+ && $c->action->can('execute')
+ && $c->req->action )
+ {
+ $c->action->dispatch( $c );
}
-
- 1;
+ return !@{ $c->error };
+}
+
+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 };
+}
+
+=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<Catalyst>
=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 $self->action_namespace($c)
-=item new($c)
+Determine the namespace for actions in this component.
=cut
-sub new {
+sub action_namespace {
my ( $self, $c ) = @_;
- my $class = ref $self || $self;
- my $appname = Catalyst::Utils::class2appclass($class);
- my $suffix = Catalyst::Utils::class2classsuffix($class);
- my $appconfig = $appname->config->{$suffix} || {};
- my $config = { %{ $self->config }, %{$appconfig} };
- return $self->NEXT::new($config);
+ return $self->config->{namespace} if exists $self->config->{namespace};
+ return Catalyst::Utils::class2prefix( ref($self) || $self,
+ $c->config->{case_sensitive} )
+ || '';
}
-# remember to leave blank lines between the consecutive =item's
-# otherwise the pod tools don't recognize the subsequent =items
+=head2 $self->path_prefix($c)
-=item $c->config
+alias for action_namespace
-=item $c->config($hashref)
+=cut
+
+sub path_prefix { shift->action_namespace(@_); }
-=item $c->config($key, $value, ...)
+=head2 $self->register_actions($c)
+
+register all actions for this component based on a given context.
=cut
-sub config {
+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');
+ }
+ }
+
+ foreach my $cache (@action_cache) {
+ my $code = $cache->[0];
+ my $method = $methods{$code};
+ 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 );
+ }
+}
+
+sub create_action {
my $self = shift;
- $self->_config( {} ) unless $self->_config;
- if ( $_[0] ) {
- 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 %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/ );
+ }
+ my $meth = "_parse_${key}_attr";
+ if ( $self->can($meth) ) {
+ ( $key, $value ) = $self->$meth( $c, $name, $value );
+ }
+ push( @{ $attributes{$key} }, $value );
}
}
- return $self->_config;
+ return \%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 process {
- die( ( ref $_[0] || $_[0] ) . " did not override Catalyst::Base::process" );
+sub _parse_Local_attr {
+ my ( $self, $c, $name, $value ) = @_;
+ return $self->_parse_Path_attr( $c, $name, $name );
}
-=back
+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) );
+ }
+}
+
+sub _parse_Regex_attr {
+ my ( $self, $c, $name, $value ) = @_;
+ return ( 'Regex', $value );
+}
+
+sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
+
+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<Catalyst>.
+L<Catalyst>, L<Catalyst::Controller>.
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>
Marcus Ramberg, C<mramberg@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
=head1 COPYRIGHT
projects / catagits/Catalyst-Runtime.git / blobdiff