lib/Catalyst/Controller.pm

   1 package Catalyst::Controller;
   2
   3 use Moose;
   4 use Moose::Util qw/find_meta/;
   5
   6 use namespace::clean -except => 'meta';
   7
   8 BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; }
   9
  10 use MooseX::MethodAttributes;
  11 use Catalyst::Exception;
  12 use Catalyst::Utils;
  13
  14 with 'Catalyst::Component::ApplicationAttribute';
  15
  16 has path_prefix =>
  17     (
  18      is => 'rw',
  19      isa => 'Str',
  20      init_arg => 'path',
  21      predicate => 'has_path_prefix',
  22     );
  23
  24 has action_namespace =>
  25     (
  26      is => 'rw',
  27      isa => 'Str',
  28      init_arg => 'namespace',
  29      predicate => 'has_action_namespace',
  30     );
  31
  32 has _controller_actions =>
  33     (
  34      is => 'rw',
  35      isa => 'HashRef',
  36      init_arg => undef,
  37     );
  38
  39 sub BUILD {
  40     my ($self, $args) = @_;
  41     my $action  = delete $args->{action}  || {};
  42     my $actions = delete $args->{actions} || {};
  43     my $attr_value = $self->merge_config_hashes($actions, $action);
  44     $self->_controller_actions($attr_value);
  45 }
  46
  47 =head1 NAME
  48
  49 Catalyst::Controller - Catalyst Controller base class
  50
  51 =head1 SYNOPSIS
  52
  53   package MyApp::Controller::Search
  54   use base qw/Catalyst::Controller/;
  55
  56   sub foo : Local {
  57     my ($self,$c,@args) = @_;
  58     ...
  59   } # Dispatches to /search/foo
  60
  61 =head1 DESCRIPTION
  62
  63 Controllers are where the actions in the Catalyst framework
  64 reside. Each action is represented by a function with an attribute to
  65 identify what kind of action it is. See the L<Catalyst::Dispatcher>
  66 for more info about how Catalyst dispatches to actions.
  67
  68 =cut
  69
  70 #I think both of these could be attributes. doesn't really seem like they need
  71 #to ble class data. i think that attributes +default would work just fine
  72 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
  73
  74 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
  75 __PACKAGE__->_action_class('Catalyst::Action');
  76
  77
  78 sub _DISPATCH : Private {
  79     my ( $self, $c ) = @_;
  80
  81     foreach my $disp ( @{ $self->_dispatch_steps } ) {
  82         last unless $c->forward($disp);
  83     }
  84
  85     $c->forward('_END');
  86 }
  87
  88 sub _BEGIN : Private {
  89     my ( $self, $c ) = @_;
  90     my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
  91     return 1 unless $begin;
  92     $begin->dispatch( $c );
  93     return !@{ $c->error };
  94 }
  95
  96 sub _AUTO : Private {
  97     my ( $self, $c ) = @_;
  98     my @auto = $c->get_actions( 'auto', $c->namespace );
  99     foreach my $auto (@auto) {
 100         $auto->dispatch( $c );
 101         return 0 unless $c->state;
 102     }
 103     return 1;
 104 }
 105
 106 sub _ACTION : Private {
 107     my ( $self, $c ) = @_;
 108     if (   ref $c->action
 109         && $c->action->can('execute')
 110         && defined $c->req->action )
 111     {
 112         $c->action->dispatch( $c );
 113     }
 114     return !@{ $c->error };
 115 }
 116
 117 sub _END : Private {
 118     my ( $self, $c ) = @_;
 119     my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
 120     return 1 unless $end;
 121     $end->dispatch( $c );
 122     return !@{ $c->error };
 123 }
 124
 125 sub action_for {
 126     my ( $self, $name ) = @_;
 127     my $app = ($self->isa('Catalyst') ? $self : $self->_application);
 128     return $app->dispatcher->get_action($name, $self->action_namespace);
 129 }
 130
 131 #my opinion is that this whole sub really should be a builder method, not
 132 #something that happens on every call. Anyone else disagree?? -- groditi
 133 ## -- apparently this is all just waiting for app/ctx split
 134 around action_namespace => sub {
 135     my $orig = shift;
 136     my ( $self, $c ) = @_;
 137
 138     if( ref($self) ){
 139         return $self->$orig if $self->has_action_namespace;
 140     } else {
 141         return $self->config->{namespace} if exists $self->config->{namespace};
 142     }
 143
 144     my $case_s;
 145     if( $c ){
 146         $case_s = $c->config->{case_sensitive};
 147     } else {
 148         if ($self->isa('Catalyst')) {
 149             $case_s = $self->config->{case_sensitive};
 150         } else {
 151             if (ref $self) {
 152                 $case_s = $self->_application->config->{case_sensitive};
 153             } else {
 154                 confess("Can't figure out case_sensitive setting");
 155             }
 156         }
 157     }
 158
 159     my $namespace = Catalyst::Utils::class2prefix(ref($self) || $self, $case_s) || '';
 160     $self->$orig($namespace) if ref($self);
 161     return $namespace;
 162 };
 163
 164 #Once again, this is probably better written as a builder method
 165 around path_prefix => sub {
 166     my $orig = shift;
 167     my $self = shift;
 168     if( ref($self) ){
 169       return $self->$orig if $self->has_path_prefix;
 170     } else {
 171       return $self->config->{path} if exists $self->config->{path};
 172     }
 173     my $namespace = $self->action_namespace(@_);
 174     $self->$orig($namespace) if ref($self);
 175     return $namespace;
 176 };
 177
 178 sub get_action_methods {
 179     my $self = shift;
 180     my $meta = find_meta($self);
 181     confess("Metaclass for "
 182           . ref($meta) . " for "
 183           . $meta->name
 184           . " cannot support register_actions." )
 185       unless $meta->can('get_nearest_methods_with_attributes');
 186     my @methods = $meta->get_nearest_methods_with_attributes;
 187
 188     # actions specified via config are also action_methods
 189     push(
 190         @methods,
 191         map {
 192             $meta->get_method($_)
 193               || confess( 'Action "'
 194                   . $_
 195                   . '" is not available from controller '
 196                   . ( ref $self ) )
 197           } keys %{ $self->_controller_actions }
 198     ) if ( ref $self );
 199     return @methods;
 200 }
 201
 202
 203 sub register_actions {
 204     my ( $self, $c ) = @_;
 205     $self->register_action_methods( $c, $self->get_action_methods );
 206 }
 207
 208 sub register_action_methods {
 209     my ( $self, $c, @methods ) = @_;
 210     my $class = ref $self || $self;
 211     #this is still not correct for some reason.
 212     my $namespace = $self->action_namespace($c);
 213
 214     foreach my $method (@methods) {
 215         my $name = $method->name;
 216         my $attributes = $method->attributes;
 217         my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
 218         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
 219             $c->log->debug( 'Bad action definition "'
 220                   . join( ' ', @{ $attributes } )
 221                   . qq/" for "$class->$name"/ )
 222               if $c->debug;
 223             next;
 224         }
 225         my $reverse = $namespace ? "${namespace}/${name}" : $name;
 226         my $action = $self->create_action(
 227             name       => $name,
 228             code       => $method->body,
 229             reverse    => $reverse,
 230             namespace  => $namespace,
 231             class      => $class,
 232             attributes => $attrs,
 233         );
 234
 235         $c->dispatcher->register( $c, $action );
 236     }
 237 }
 238
 239 sub create_action {
 240     my $self = shift;
 241     my %args = @_;
 242
 243     my $class = (exists $args{attributes}{ActionClass}
 244                     ? $args{attributes}{ActionClass}[0]
 245                     : $self->_action_class);
 246
 247     Class::MOP::load_class($class);
 248     return $class->new( \%args );
 249 }
 250
 251 sub _parse_attrs {
 252     my ( $self, $c, $name, @attrs ) = @_;
 253
 254     my %raw_attributes;
 255
 256     foreach my $attr (@attrs) {
 257
 258         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 259
 260         if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
 261         {
 262
 263             if ( defined $value ) {
 264                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
 265             }
 266             push( @{ $raw_attributes{$key} }, $value );
 267         }
 268     }
 269
 270     #I know that the original behavior was to ignore action if actions was set
 271     # but i actually think this may be a little more sane? we can always remove
 272     # the merge behavior quite easily and go back to having actions have
 273     # presedence over action by modifying the keys. i honestly think this is
 274     # superior while mantaining really high degree of compat
 275     my $actions;
 276     if( ref($self) ) {
 277         $actions = $self->_controller_actions;
 278     } else {
 279         my $cfg = $self->config;
 280         $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
 281     }
 282
 283     %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
 284                        %raw_attributes,
 285                        (exists $actions->{$name} ? %{$actions->{$name}} : ()));
 286
 287
 288     my %final_attributes;
 289
 290     foreach my $key (keys %raw_attributes) {
 291
 292         my $raw = $raw_attributes{$key};
 293
 294         foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
 295
 296             my $meth = "_parse_${key}_attr";
 297             if ( my $code = $self->can($meth) ) {
 298                 ( $key, $value ) = $self->$code( $c, $name, $value );
 299             }
 300             push( @{ $final_attributes{$key} }, $value );
 301         }
 302     }
 303
 304     return \%final_attributes;
 305 }
 306
 307 sub _parse_Global_attr {
 308     my ( $self, $c, $name, $value ) = @_;
 309     return $self->_parse_Path_attr( $c, $name, "/$name" );
 310 }
 311
 312 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
 313
 314 sub _parse_Local_attr {
 315     my ( $self, $c, $name, $value ) = @_;
 316     return $self->_parse_Path_attr( $c, $name, $name );
 317 }
 318
 319 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
 320
 321 sub _parse_Path_attr {
 322     my ( $self, $c, $name, $value ) = @_;
 323     $value = '' if !defined $value;
 324     if ( $value =~ m!^/! ) {
 325         return ( 'Path', $value );
 326     }
 327     elsif ( length $value ) {
 328         return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
 329     }
 330     else {
 331         return ( 'Path', $self->path_prefix($c) );
 332     }
 333 }
 334
 335 sub _parse_Regex_attr {
 336     my ( $self, $c, $name, $value ) = @_;
 337     return ( 'Regex', $value );
 338 }
 339
 340 sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
 341
 342 sub _parse_LocalRegex_attr {
 343     my ( $self, $c, $name, $value ) = @_;
 344     unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
 345
 346     my $prefix = $self->path_prefix( $c );
 347     $prefix .= '/' if length( $prefix );
 348
 349     return ( 'Regex', "^${prefix}${value}" );
 350 }
 351
 352 sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
 353
 354 sub _parse_Chained_attr {
 355     my ($self, $c, $name, $value) = @_;
 356
 357     if (defined($value) && length($value)) {
 358         if ($value eq '.') {
 359             $value = '/'.$self->action_namespace($c);
 360         } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
 361             my @parts = split '/', $self->action_namespace($c);
 362             my @levels = split '/', $rel;
 363
 364             $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
 365         } elsif ($value !~ m/^\//) {
 366             my $action_ns = $self->action_namespace($c);
 367
 368             if ($action_ns) {
 369                 $value = '/'.join('/', $action_ns, $value);
 370             } else {
 371                 $value = '/'.$value; # special case namespace '' (root)
 372             }
 373         }
 374     } else {
 375         $value = '/'
 376     }
 377
 378     return Chained => $value;
 379 }
 380
 381 sub _parse_ChainedParent_attr {
 382     my ($self, $c, $name, $value) = @_;
 383     return $self->_parse_Chained_attr($c, $name, '../'.$name);
 384 }
 385
 386 sub _parse_PathPrefix_attr {
 387     my $self = shift;
 388     return PathPart => $self->path_prefix;
 389 }
 390
 391 sub _parse_ActionClass_attr {
 392     my ( $self, $c, $name, $value ) = @_;
 393     $value = Catalyst::Utils::resolve_namespace($self->_action_class, $value);
 394     return ( 'ActionClass', $value );
 395 }
 396
 397 sub _parse_MyAction_attr {
 398     my ( $self, $c, $name, $value ) = @_;
 399
 400     my $appclass = Catalyst::Utils::class2appclass($self);
 401     $value = "${appclass}::Action::${value}";
 402
 403     return ( 'ActionClass', $value );
 404 }
 405
 406 __PACKAGE__->meta->make_immutable;
 407
 408 1;
 409
 410 __END__
 411
 412 =head1 CONFIGURATION
 413
 414 Like any other L<Catalyst::Component>, controllers have a config hash,
 415 accessible through $self->config from the controller actions.  Some
 416 settings are in use by the Catalyst framework:
 417
 418 =head2 namespace
 419
 420 This specifies the internal namespace the controller should be bound
 421 to. By default the controller is bound to the URI version of the
 422 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
 423 will be bound to 'foo/bar'. The default Root controller is an example
 424 of setting namespace to '' (the null string).
 425
 426 =head2 path
 427
 428 Sets 'path_prefix', as described below.
 429
 430 =head1 METHODS
 431
 432 =head2 BUILDARGS ($app, @args)
 433
 434 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
 435 instance as $self->_application.
 436
 437 =head2 $self->action_for('name')
 438
 439 Returns the Catalyst::Action object (if any) for a given method name
 440 in this component.
 441
 442 =head2 $self->action_namespace($c)
 443
 444 Returns the private namespace for actions in this component. Defaults
 445 to a value from the controller name (for
 446 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
 447 overridden from the "namespace" config key.
 448
 449
 450 =head2 $self->path_prefix($c)
 451
 452 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
 453 relative :Path actions in this component. Defaults to the action_namespace or
 454 can be overridden from the "path" config key.
 455
 456 =head2 $self->register_actions($c)
 457
 458 Finds all applicable actions for this component, creates
 459 Catalyst::Action objects (using $self->create_action) for them and
 460 registers them with $c->dispatcher.
 461
 462 =head2 $self->get_action_methods()
 463
 464 Returns a list of L<Moose::Meta::Method> objects, doing the
 465 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
 466 action methods for this package.
 467
 468 =head2 $self->register_action_methods($c, @methods)
 469
 470 Creates action objects for a set of action methods using C< create_action >,
 471 and registers them with the dispatcher.
 472
 473 =head2 $self->create_action(%args)
 474
 475 Called with a hash of data to be use for construction of a new
 476 Catalyst::Action (or appropriate sub/alternative class) object.
 477
 478 =head2 $self->_application
 479
 480 =head2 $self->_app
 481
 482 Returns the application instance stored by C<new()>
 483
 484 =head1 AUTHORS
 485
 486 Catalyst Contributors, see Catalyst.pm
 487
 488 =head1 COPYRIGHT
 489
 490 This program is free software, you can redistribute it and/or modify
 491 it under the same terms as Perl itself.
 492
 493 =cut