lib/Catalyst/Base.pm

   1 package Catalyst::Base;
   2
   3 use strict;
   4 use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/;
   5
   6 use Catalyst::Exception;
   7 use Catalyst::Utils;
   8 use Class::Inspector;
   9 use NEXT;
  10
  11 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
  12
  13 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
  14 __PACKAGE__->_action_class('Catalyst::Action');
  15
  16 sub _DISPATCH : Private {
  17     my ( $self, $c ) = @_;
  18
  19     foreach my $disp ( @{ $self->_dispatch_steps } ) {
  20         last unless $c->forward($disp);
  21     }
  22
  23     $c->forward('_END');
  24 }
  25
  26 sub _BEGIN : Private {
  27     my ( $self, $c ) = @_;
  28     my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
  29     return 1 unless $begin;
  30     $begin->execute($c);
  31     return !@{ $c->error };
  32 }
  33
  34 sub _AUTO : Private {
  35     my ( $self, $c ) = @_;
  36     my @auto = $c->get_actions( 'auto', $c->namespace );
  37     foreach my $auto (@auto) {
  38         $auto->execute($c);
  39         return 0 unless $c->state;
  40     }
  41     return 1;
  42 }
  43
  44 sub _ACTION : Private {
  45     my ( $self, $c ) = @_;
  46     $c->action->execute($c);
  47     return !@{ $c->error };
  48 }
  49
  50 sub _END : Private {
  51     my ( $self, $c ) = @_;
  52     my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
  53     return 1 unless $end;
  54     $end->execute($c);
  55     return !@{ $c->error };
  56 }
  57
  58 sub action_namespace {
  59     my ( $self, $c ) = @_;
  60     return Catalyst::Utils::class2prefix( ref $self,
  61         $c->config->{case_sensitive} )
  62       || '';
  63 }
  64
  65 sub register_actions {
  66     my ( $self, $c ) = @_;
  67     my $class = ref $self || $self;
  68     my $namespace = $self->action_namespace($c);
  69     my %methods;
  70     $methods{ $self->can($_) } = $_
  71       for @{ Class::Inspector->methods($class) || [] };
  72
  73     # Advanced inheritance support for plugins and the like
  74     my @action_cache;
  75     {
  76         no strict 'refs';
  77         for my $isa ( @{"$class\::ISA"}, $class ) {
  78             push @action_cache, @{ $isa->_action_cache }
  79               if $isa->can('_action_cache');
  80         }
  81     }
  82
  83     foreach my $cache (@action_cache) {
  84         my $code   = $cache->[0];
  85         my $method = $methods{$code};
  86         next unless $method;
  87         my $attrs = $self->_parse_attrs( @{ $cache->[1] } );
  88         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
  89             $c->log->debug( 'Bad action definition "'
  90                   . join( ' ', @{ $cache->[1] } )
  91                   . qq/" for "$class->$method"/ )
  92               if $c->debug;
  93             next;
  94         }
  95         my $reverse = $namespace ? "$namespace/$method" : $method;
  96         my $action = $self->_action_class->new(
  97             {
  98                 name       => $method,
  99                 code       => $code,
 100                 reverse    => $reverse,
 101                 namespace  => $namespace,
 102                 class      => $class,
 103                 attributes => $attrs,
 104             }
 105         );
 106         $c->dispatcher->register( $c, $action );
 107     }
 108 }
 109
 110 sub _parse_attrs {
 111     my ( $self, @attrs ) = @_;
 112     my %attributes;
 113     foreach my $attr (@attrs) {
 114
 115         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 116
 117         if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) ) {
 118
 119             if ( defined $value ) {
 120                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
 121             }
 122             push( @{ $attributes{$key} }, $value );
 123         }
 124     }
 125     return \%attributes;
 126 }
 127
 128 =head1 NAME
 129
 130 Catalyst::Base - Catalyst Controller Base Class
 131
 132 =head1 SYNOPSIS
 133
 134
 135 =head1 DESCRIPTION
 136
 137
 138 =head1 METHODS
 139
 140 =over 4
 141
 142 =back
 143
 144 =head1 SEE ALSO
 145
 146 L<Catalyst>.
 147
 148 =head1 AUTHOR
 149
 150 Sebastian Riedel, C<sri@cpan.org>
 151 Marcus Ramberg, C<mramberg@cpan.org>
 152 Matt S Trout, C<mst@shadowcatsystems.co.uk>
 153
 154 =head1 COPYRIGHT
 155
 156 This program is free software, you can redistribute it and/or modify it under
 157 the same terms as Perl itself.
 158
 159 =cut
 160
 161 1;