package Catalyst::Base;
use strict;
-use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
-use Catalyst::Utils;
+use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/;
+
use Catalyst::Exception;
+use Catalyst::Utils;
+use Class::Inspector;
use NEXT;
-# Some caches...
-__PACKAGE__->mk_classdata($_) for qw/_attr_cache _action_cache _config/;
-__PACKAGE__->_attr_cache( {} );
-__PACKAGE__->_action_cache( [] );
-
-# note - see attributes(3pm)
-sub MODIFY_CODE_ATTRIBUTES {
- my ( $class, $code, @attrs ) = @_;
- $class->_attr_cache->{$code} = [@attrs];
- push @{ $class->_action_cache }, [ $code, [@attrs] ];
- return ();
-}
-
-sub FETCH_CODE_ATTRIBUTES { $_[0]->_attr_cache->{ $_[1] } || () }
-
-=head1 NAME
-
-Catalyst::Base - Catalyst Universal Base Class
-
-=head1 SYNOPSIS
-
- # lib/MyApp/Model/Something.pm
- package MyApp::Model::Something;
+__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps/;
- use base 'Catalyst::Base';
+__PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
- __PACKAGE__->config( foo => 'bar' );
-
- sub test {
- my $self = shift;
- return $self->{foo};
- }
+sub _DISPATCH : Private {
+ my ( $self, $c ) = @_;
- sub forward_to_me {
- my ( $self, $c ) = @_;
- $c->response->output( $self->{foo} );
+ foreach my $disp ( @{ $self->_dispatch_steps } ) {
+ last unless $c->forward($disp);
}
-
- 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
+ $c->forward('_END');
+}
-sub new {
+sub _BEGIN : Private {
my ( $self, $c ) = @_;
+ my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
+ return 1 unless $begin;
+ $begin->execute($c);
+ return !@{ $c->error };
+}
- # You'll find yourself naked and strung from a tree if you ever
- # remove this again, k? :)
- my $class = ref $self || $self;
- my $appname = Catalyst::Utils::class2appclass($class);
- my $suffix = Catalyst::Utils::class2classsuffix($class);
- my $appconfig = {};
+sub _AUTO : Private {
+ my ( $self, $c ) = @_;
+ my @auto = $c->get_actions( 'auto', $c->namespace );
+ foreach my $auto (@auto) {
+ $auto->execute($c);
+ return 0 unless $c->state;
+ }
+ return 1;
+}
- # Not catched, for compatibility with non Catalyst apps
- eval '$appconfig = $appname->config->{$suffix} || {}';
- my $config = { %{ $self->config }, %{$appconfig} };
+sub _ACTION : Private {
+ my ( $self, $c ) = @_;
+ $c->action->execute($c);
+ return !@{ $c->error };
+}
- # Temporary fix, some components does not pass context to constructor
- my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
+sub _END : Private {
+ my ( $self, $c ) = @_;
+ my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
+ return 1 unless $end;
+ $end->execute($c);
+ return !@{ $c->error };
+}
- return $self->NEXT::new( { %{$config}, %{$arguments} } );
+sub action_namespace {
+ my ( $self, $c ) = @_;
+ return Catalyst::Utils::class2prefix( ref $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
+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 = $methods{$code};
+ next unless $method;
+ my $attrs = $self->_parse_attrs( @{ $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 = Catalyst::Action->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => $reverse,
+ namespace => $namespace,
+ class => $class,
+ attributes => $attrs,
+ }
+ );
+ $c->dispatcher->register( $c, $action );
+ }
+}
-=item $c->config($hashref)
+sub _parse_attrs {
+ my ( $self, @attrs ) = @_;
+ my %attributes;
+ foreach my $attr (@attrs) {
-=item $c->config($key, $value, ...)
+ # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
-=cut
+ if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) {
-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;
+ if ( defined $value ) {
+ ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
+ }
+ push( @{ $attributes{$key} }, $value );
}
}
- return $self->_config;
+ return \%attributes;
}
-=item $c->process()
+=head1 NAME
-=cut
+Catalyst::Base - Catalyst Controller Base Class
-sub process {
+=head1 SYNOPSIS
- Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] )
- . " did not override Catalyst::Base::process" );
-}
-=item FETCH_CODE_ATTRIBUTES
+=head1 DESCRIPTION
+
-=item MODIFY_CODE_ATTRIBUTES
+=head1 METHODS
+
+=over 4
=back
Sebastian Riedel, C<sri@cpan.org>
Marcus Ramberg, C<mramberg@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
=head1 COPYRIGHT