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__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
+__PACKAGE__->_action_class('Catalyst::Action');
-sub _DISPATCH :Private {
+sub _DISPATCH : Private {
my ( $self, $c ) = @_;
- foreach my $disp (@{$self->_dispatch_steps}) {
+ foreach my $disp ( @{ $self->_dispatch_steps } ) {
last unless $c->forward($disp);
}
$c->forward('_END');
}
-sub _BEGIN :Private {
+sub _BEGIN : Private {
my ( $self, $c ) = @_;
- my $begin = @{ $c->get_action('begin', $c->namespace, 1) }[-1];
+ my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
return 1 unless $begin;
- $begin->[0]->execute($c);
- return !@{$c->error};
+ $begin->execute($c);
+ return !@{ $c->error };
}
-sub _AUTO :Private {
+sub _AUTO : Private {
my ( $self, $c ) = @_;
- my @auto = @{ $c->get_action('auto', $c->namespace, 1) };
+ my @auto = $c->get_actions( 'auto', $c->namespace );
foreach my $auto (@auto) {
- $auto->[0]->execute($c);
+ $auto->execute($c);
return 0 unless $c->state;
}
return 1;
}
-sub _ACTION :Private {
+sub _ACTION : Private {
my ( $self, $c ) = @_;
- $c->action->execute($c);
- return !@{$c->error};
+ if ( ref $c->action
+ && $c->action->can('execute')
+ && $c->req->action )
+ {
+ $c->action->execute($c);
+ }
+ return !@{ $c->error };
}
-sub _END :Private {
+sub _END : Private {
my ( $self, $c ) = @_;
- my $end = @{ $c->get_action('end', $c->namespace, 1) }[-1];
+ my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
return 1 unless $end;
- $end->[0]->execute($c);
- return !@{$c->error};
+ $end->execute($c);
+ return !@{ $c->error };
}
=head1 NAME
-Catalyst::Base - Catalyst Universal Base Class
+Catalyst::Base - Catalyst Base Class
=head1 SYNOPSIS
- # lib/MyApp/Model/Something.pm
- package MyApp::Model::Something;
+See L<Catalyst>
- use base 'Catalyst::Base';
+=head1 DESCRIPTION
- __PACKAGE__->config( foo => 'bar' );
+Catalyst Base Class
- sub test {
- my $self = shift;
- return $self->{foo};
- }
+This is the base class for all Catalyst components. It also handles
+dispatch of actions for controllers.
- sub forward_to_me {
- my ( $self, $c ) = @_;
- $c->response->output( $self->{foo} );
- }
-
- 1;
+=head1 METHODS
- # Methods can be a request step
- $c->forward(qw/MyApp::Model::Something forward_to_me/);
+=head2 $self->action_namespace($c)
- # Or just methods
- print $c->comp('MyApp::Model::Something')->test;
+Determine the namespace for actions in this component.
- print $c->comp('MyApp::Model::Something')->{foo};
+=cut
-=head1 DESCRIPTION
+sub action_namespace {
+ my ( $self, $c ) = @_;
+ return $self->config->{namespace} if exists $self->config->{namespace};
+ return Catalyst::Utils::class2prefix( ref($self) || $self,
+ $c->config->{case_sensitive} )
+ || '';
+}
-This is the universal base class for Catalyst components
-(Model/View/Controller).
+=head2 $self->path_prefix($c)
-It provides you with a generic new() for instantiation through Catalyst's
-component loader with config() support and a process() method placeholder.
+alias for action_namespace
-=head1 METHODS
+=cut
+
+sub path_prefix { shift->action_namespace(@_); }
-=over 4
+=head2 $self->register_actions($c)
-=item new($c)
+register all actions for this component based on a given context.
=cut
-sub new {
+sub register_actions {
my ( $self, $c ) = @_;
-
- # Temporary fix, some components does not pass context to constructor
- my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
+ 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');
+ }
+ }
- return $self->NEXT::new( { %{ $self->config }, %{ $arguments } } );
+ 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->_action_class->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => $reverse,
+ namespace => $namespace,
+ class => $class,
+ attributes => $attrs,
+ }
+ );
+ $c->dispatcher->register( $c, $action );
+ }
}
-# remember to leave blank lines between the consecutive =item's
-# otherwise the pod tools don't recognize the subsequent =items
-
-=item $c->config
+sub _parse_attrs {
+ my ( $self, $c, $name, @attrs ) = @_;
+ my %attributes;
+ foreach my $attr (@attrs) {
-=item $c->config($hashref)
+ # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
-=item $c->config($key, $value, ...)
-
-=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/ );
+ }
+ 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 _parse_Local_attr {
+ my ( $self, $c, $name, $value ) = @_;
+ return $self->_parse_Path_attr( $c, $name, $name );
+}
-sub process {
+sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
- Catalyst::Exception->throw(
- message => ( 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 );
+}
+
+sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
-=item MODIFY_CODE_ATTRIBUTES
+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<Catalyst>.
+L<Catalyst>, L<Catalyst::Controller>.
=head1 AUTHOR