lib/Catalyst/Controller.pm

   1 package Catalyst::Controller;
   2
   3 use Moose;
   4 use Moose::Util qw/find_meta/;
   5 use List::MoreUtils qw/uniq/;
   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 actions =>
  33     (
  34      accessor => '_controller_actions',
  35      isa => 'HashRef',
  36      init_arg => undef,
  37     );
  38
  39 # ->config(actions => { '*' => ...
  40 has _all_actions_attributes => (
  41     is       => 'ro',
  42     isa      => 'HashRef',
  43     init_arg => undef,
  44     lazy     => 1,
  45     builder  => '_build__all_actions_attributes',
  46 );
  47
  48 sub BUILD {
  49     my ($self, $args) = @_;
  50     my $action  = delete $args->{action}  || {};
  51     my $actions = delete $args->{actions} || {};
  52     my $attr_value = $self->merge_config_hashes($actions, $action);
  53     $self->_controller_actions($attr_value);
  54
  55     # trigger lazy builder
  56     $self->_all_actions_attributes;
  57 }
  58
  59 sub _build__all_actions_attributes {
  60     my ($self) = @_;
  61     delete $self->_controller_actions->{'*'} || {};
  62 }
  63
  64 =head1 NAME
  65
  66 Catalyst::Controller - Catalyst Controller base class
  67
  68 =head1 SYNOPSIS
  69
  70   package MyApp::Controller::Search
  71   use base qw/Catalyst::Controller/;
  72
  73   sub foo : Local {
  74     my ($self,$c,@args) = @_;
  75     ...
  76   } # Dispatches to /search/foo
  77
  78 =head1 DESCRIPTION
  79
  80 Controllers are where the actions in the Catalyst framework
  81 reside. Each action is represented by a function with an attribute to
  82 identify what kind of action it is. See the L<Catalyst::Dispatcher>
  83 for more info about how Catalyst dispatches to actions.
  84
  85 =cut
  86
  87 #I think both of these could be attributes. doesn't really seem like they need
  88 #to ble class data. i think that attributes +default would work just fine
  89 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
  90
  91 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
  92 __PACKAGE__->_action_class('Catalyst::Action');
  93
  94
  95 sub _DISPATCH : Private {
  96     my ( $self, $c ) = @_;
  97
  98     foreach my $disp ( @{ $self->_dispatch_steps } ) {
  99         last unless $c->forward($disp);
 100     }
 101
 102     $c->forward('_END');
 103 }
 104
 105 sub _BEGIN : Private {
 106     my ( $self, $c ) = @_;
 107     my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
 108     return 1 unless $begin;
 109     $begin->dispatch( $c );
 110     return !@{ $c->error };
 111 }
 112
 113 sub _AUTO : Private {
 114     my ( $self, $c ) = @_;
 115     my @auto = $c->get_actions( 'auto', $c->namespace );
 116     foreach my $auto (@auto) {
 117         $auto->dispatch( $c );
 118         return 0 unless $c->state;
 119     }
 120     return 1;
 121 }
 122
 123 sub _ACTION : Private {
 124     my ( $self, $c ) = @_;
 125     if (   ref $c->action
 126         && $c->action->can('execute')
 127         && defined $c->req->action )
 128     {
 129         $c->action->dispatch( $c );
 130     }
 131     return !@{ $c->error };
 132 }
 133
 134 sub _END : Private {
 135     my ( $self, $c ) = @_;
 136     my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
 137     return 1 unless $end;
 138     $end->dispatch( $c );
 139     return !@{ $c->error };
 140 }
 141
 142 sub action_for {
 143     my ( $self, $name ) = @_;
 144     my $app = ($self->isa('Catalyst') ? $self : $self->_application);
 145     return $app->dispatcher->get_action($name, $self->action_namespace);
 146 }
 147
 148 #my opinion is that this whole sub really should be a builder method, not
 149 #something that happens on every call. Anyone else disagree?? -- groditi
 150 ## -- apparently this is all just waiting for app/ctx split
 151 around action_namespace => sub {
 152     my $orig = shift;
 153     my ( $self, $c ) = @_;
 154
 155     my $class = ref($self) || $self;
 156     my $appclass = ref($c) || $c;
 157
 158     # FIXME - catalyst_component_name is no longer a class accessor, because
 159     # 'MyApp as a controller' behavior is removed. But is this call to
 160     # catalyst_component_name necessary, or is it always the same as $class?
 161     my $component_name = ref($self) ? $self->catalyst_component_name : $self;
 162
 163     if( ref($self) ){
 164         return $self->$orig if $self->has_action_namespace;
 165     } else {
 166         return $class->config->{namespace} if exists $class->config->{namespace};
 167     }
 168
 169     my $case_s;
 170     if( $c ){
 171         $case_s = $appclass->config->{case_sensitive};
 172     } else {
 173         if ($self->isa('Catalyst')) {
 174             $case_s = $class->config->{case_sensitive};
 175         } else {
 176             if (ref $self) {
 177                 $case_s = ref($self->_application)->config->{case_sensitive};
 178             } else {
 179                 confess("Can't figure out case_sensitive setting");
 180             }
 181         }
 182     }
 183
 184     my $namespace = Catalyst::Utils::class2prefix($component_name, $case_s) || '';
 185     $self->$orig($namespace) if ref($self);
 186     return $namespace;
 187 };
 188
 189 #Once again, this is probably better written as a builder method
 190 around path_prefix => sub {
 191     my $orig = shift;
 192     my $self = shift;
 193     if( ref($self) ){
 194       return $self->$orig if $self->has_path_prefix;
 195     } else {
 196       return $self->config->{path} if exists $self->config->{path};
 197     }
 198     my $namespace = $self->action_namespace(@_);
 199     $self->$orig($namespace) if ref($self);
 200     return $namespace;
 201 };
 202
 203 sub get_action_methods {
 204     my $self = shift;
 205     my $meta = find_meta($self) || confess("No metaclass setup for $self");
 206     confess(
 207         sprintf "Metaclass %s for %s cannot support register_actions.",
 208             ref $meta, $meta->name,
 209     ) unless $meta->can('get_nearest_methods_with_attributes');
 210     my @methods = $meta->get_nearest_methods_with_attributes;
 211
 212     # actions specified via config are also action_methods
 213     push(
 214         @methods,
 215         map {
 216             $meta->find_method_by_name($_)
 217                 || confess( sprintf 'Action "%s" is not available from controller %s',
 218                             $_, ref $self )
 219         } keys %{ $self->_controller_actions }
 220     ) if ( ref $self );
 221     return uniq @methods;
 222 }
 223
 224
 225 sub register_actions {
 226     my ( $self, $c ) = @_;
 227     $self->register_action_methods( $c, $self->get_action_methods );
 228 }
 229
 230 sub register_action_methods {
 231     my ( $self, $c, @methods ) = @_;
 232     my $class = $self->catalyst_component_name;
 233     #this is still not correct for some reason.
 234     my $namespace = $self->action_namespace($c);
 235
 236     # FIXME - fugly
 237     if (!blessed($self) && $self eq $c && scalar(@methods)) {
 238         my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods;
 239         if (scalar(@really_bad_methods)) {
 240             $c->log->warn("Action methods (" . join(', ', @really_bad_methods) . ") found defined in your application class, $self. This is deprecated, please move them into a Root controller.");
 241         }
 242     }
 243
 244     foreach my $method (@methods) {
 245         my $name = $method->name;
 246         # Horrible hack! All method metaclasses should have an attributes
 247         # method, core Moose bug - see r13354.
 248         my $attributes = $method->can('attributes') ? $method->attributes : [];
 249         my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
 250         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
 251             $c->log->debug( 'Bad action definition "'
 252                   . join( ' ', @{ $attributes } )
 253                   . qq/" for "$class->$name"/ )
 254               if $c->debug;
 255             next;
 256         }
 257         my $reverse = $namespace ? "${namespace}/${name}" : $name;
 258         my $action = $self->create_action(
 259             name       => $name,
 260             code       => $method->body,
 261             reverse    => $reverse,
 262             namespace  => $namespace,
 263             class      => $class,
 264             attributes => $attrs,
 265         );
 266
 267         $c->dispatcher->register( $c, $action );
 268     }
 269 }
 270
 271 sub action_class {
 272     my $self = shift;
 273     my %args = @_;
 274
 275     my $class = (exists $args{attributes}{ActionClass}
 276         ? $args{attributes}{ActionClass}[0]
 277         : $self->_action_class);
 278
 279     Class::MOP::load_class($class);
 280     return $class;
 281 }
 282
 283 sub create_action {
 284     my $self = shift;
 285     my %args = @_;
 286
 287     my $class = $self->action_class(%args);
 288     my $action_args = $self->config->{action_args};
 289
 290     my %extra_args = (
 291         %{ $action_args->{'*'}           || {} },
 292         %{ $action_args->{ $args{name} } || {} },
 293     );
 294
 295     return $class->new({ %extra_args, %args });
 296 }
 297
 298 sub _parse_attrs {
 299     my ( $self, $c, $name, @attrs ) = @_;
 300
 301     my %raw_attributes;
 302
 303     foreach my $attr (@attrs) {
 304
 305         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 306
 307         if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
 308         {
 309
 310             if ( defined $value ) {
 311                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
 312             }
 313             push( @{ $raw_attributes{$key} }, $value );
 314         }
 315     }
 316
 317     my ($actions_config, $all_actions_config);
 318     if( ref($self) ) {
 319         $actions_config = $self->_controller_actions;
 320         # No, you're not getting actions => { '*' => ... } with actions in MyApp.
 321         $all_actions_config = $self->_all_actions_attributes;
 322     } else {
 323         my $cfg = $self->config;
 324         $actions_config = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
 325         $all_actions_config = {};
 326     }
 327
 328     %raw_attributes = (
 329         %raw_attributes,
 330         # Note we deep copy array refs here to stop crapping on config
 331         # when attributes are parsed. RT#65463
 332         exists $actions_config->{$name} ? map { ref($_) eq 'ARRAY' ? [ @$_ ] : $_ } %{ $actions_config->{$name } } : (),
 333     );
 334
 335     # Private actions with additional attributes will raise a warning and then
 336     # be ignored. Adding '*' arguments to the default _DISPATCH / etc. methods,
 337     # which are Private, will prevent those from being registered. They should
 338     # probably be turned into :Actions instead, or we might want to otherwise
 339     # disambiguate between those built-in internal actions and user-level
 340     # Private ones.
 341     %raw_attributes = (%{ $all_actions_config }, %raw_attributes)
 342         unless $raw_attributes{Private};
 343
 344     my %final_attributes;
 345
 346     foreach my $key (keys %raw_attributes) {
 347
 348         my $raw = $raw_attributes{$key};
 349
 350         foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
 351
 352             my $meth = "_parse_${key}_attr";
 353             if ( my $code = $self->can($meth) ) {
 354                 ( $key, $value ) = $self->$code( $c, $name, $value );
 355             }
 356             push( @{ $final_attributes{$key} }, $value );
 357         }
 358     }
 359
 360     return \%final_attributes;
 361 }
 362
 363 sub _parse_Global_attr {
 364     my ( $self, $c, $name, $value ) = @_;
 365     return $self->_parse_Path_attr( $c, $name, "/$name" );
 366 }
 367
 368 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
 369
 370 sub _parse_Local_attr {
 371     my ( $self, $c, $name, $value ) = @_;
 372     return $self->_parse_Path_attr( $c, $name, $name );
 373 }
 374
 375 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
 376
 377 sub _parse_Path_attr {
 378     my ( $self, $c, $name, $value ) = @_;
 379     $value = '' if !defined $value;
 380     if ( $value =~ m!^/! ) {
 381         return ( 'Path', $value );
 382     }
 383     elsif ( length $value ) {
 384         return ( 'Path', join( '/', $self->path_prefix($c), $value ) );
 385     }
 386     else {
 387         return ( 'Path', $self->path_prefix($c) );
 388     }
 389 }
 390
 391 sub _parse_Regex_attr {
 392     my ( $self, $c, $name, $value ) = @_;
 393     return ( 'Regex', $value );
 394 }
 395
 396 sub _parse_Regexp_attr { shift->_parse_Regex_attr(@_); }
 397
 398 sub _parse_LocalRegex_attr {
 399     my ( $self, $c, $name, $value ) = @_;
 400     unless ( $value =~ s/^\^// ) { $value = "(?:.*?)$value"; }
 401
 402     my $prefix = $self->path_prefix( $c );
 403     $prefix .= '/' if length( $prefix );
 404
 405     return ( 'Regex', "^${prefix}${value}" );
 406 }
 407
 408 sub _parse_LocalRegexp_attr { shift->_parse_LocalRegex_attr(@_); }
 409
 410 sub _parse_Chained_attr {
 411     my ($self, $c, $name, $value) = @_;
 412
 413     if (defined($value) && length($value)) {
 414         if ($value eq '.') {
 415             $value = '/'.$self->action_namespace($c);
 416         } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
 417             my @parts = split '/', $self->action_namespace($c);
 418             my @levels = split '/', $rel;
 419
 420             $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
 421         } elsif ($value !~ m/^\//) {
 422             my $action_ns = $self->action_namespace($c);
 423
 424             if ($action_ns) {
 425                 $value = '/'.join('/', $action_ns, $value);
 426             } else {
 427                 $value = '/'.$value; # special case namespace '' (root)
 428             }
 429         }
 430     } else {
 431         $value = '/'
 432     }
 433
 434     return Chained => $value;
 435 }
 436
 437 sub _parse_ChainedParent_attr {
 438     my ($self, $c, $name, $value) = @_;
 439     return $self->_parse_Chained_attr($c, $name, '../'.$name);
 440 }
 441
 442 sub _parse_PathPrefix_attr {
 443     my ( $self, $c ) = @_;
 444     return PathPart => $self->path_prefix($c);
 445 }
 446
 447 sub _parse_ActionClass_attr {
 448     my ( $self, $c, $name, $value ) = @_;
 449     my $appname = $self->_application;
 450     $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
 451     return ( 'ActionClass', $value );
 452 }
 453
 454 sub _parse_MyAction_attr {
 455     my ( $self, $c, $name, $value ) = @_;
 456
 457     my $appclass = Catalyst::Utils::class2appclass($self);
 458     $value = "${appclass}::Action::${value}";
 459
 460     return ( 'ActionClass', $value );
 461 }
 462
 463 __PACKAGE__->meta->make_immutable;
 464
 465 1;
 466
 467 __END__
 468
 469 =head1 CONFIGURATION
 470
 471 Like any other L<Catalyst::Component>, controllers have a config hash,
 472 accessible through $self->config from the controller actions.  Some
 473 settings are in use by the Catalyst framework:
 474
 475 =head2 namespace
 476
 477 This specifies the internal namespace the controller should be bound
 478 to. By default the controller is bound to the URI version of the
 479 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
 480 will be bound to 'foo/bar'. The default Root controller is an example
 481 of setting namespace to '' (the null string).
 482
 483 =head2 path
 484
 485 Sets 'path_prefix', as described below.
 486
 487 =head2 action
 488
 489 Allows you to set the attributes that the dispatcher creates actions out of.
 490 This allows you to do 'rails style routes', or override some of the
 491 attribute definitions of actions composed from Roles.
 492 You can set arguments globally (for all actions of the controller) and
 493 specifically (for a single action).
 494
 495     __PACKAGE__->config(
 496         action => {
 497             '*' => { Chained => 'base', Args => 0  },
 498             base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
 499         },
 500      );
 501
 502 In the case above every sub in the package would be made into a Chain
 503 endpoint with a URI the same as the sub name for each sub, chained
 504 to the sub named C<base>. Ergo dispatch to C</example> would call the
 505 C<base> method, then the C<example> method.
 506
 507 =head2 action_args
 508
 509 Allows you to set constructor arguments on your actions. You can set arguments
 510 globally and specifically (as above).
 511 This is particularly useful when using C<ActionRole>s
 512 (L<Catalyst::Controller::ActionRole>) and custom C<ActionClass>es.
 513
 514     __PACKAGE__->config(
 515         action_args => {
 516             '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
 517             'specific_action' => { customarg => 'arg1' },
 518         },
 519      );
 520
 521 In the case above the action class associated with C<specific_action> would get
 522 passed the following arguments, in addition to the normal action constructor
 523 arguments, when it is instantiated:
 524
 525   (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
 526
 527 =head1 METHODS
 528
 529 =head2 BUILDARGS ($app, @args)
 530
 531 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
 532 instance as $self->_application.
 533
 534 =head2 $self->action_for('name')
 535
 536 Returns the Catalyst::Action object (if any) for a given method name
 537 in this component.
 538
 539 =head2 $self->action_namespace($c)
 540
 541 Returns the private namespace for actions in this component. Defaults
 542 to a value from the controller name (for
 543 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
 544 overridden from the "namespace" config key.
 545
 546
 547 =head2 $self->path_prefix($c)
 548
 549 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
 550 relative :Path actions in this component. Defaults to the action_namespace or
 551 can be overridden from the "path" config key.
 552
 553 =head2 $self->register_actions($c)
 554
 555 Finds all applicable actions for this component, creates
 556 Catalyst::Action objects (using $self->create_action) for them and
 557 registers them with $c->dispatcher.
 558
 559 =head2 $self->get_action_methods()
 560
 561 Returns a list of L<Moose::Meta::Method> objects, doing the
 562 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
 563 action methods for this package.
 564
 565 =head2 $self->register_action_methods($c, @methods)
 566
 567 Creates action objects for a set of action methods using C< create_action >,
 568 and registers them with the dispatcher.
 569
 570 =head2 $self->action_class(%args)
 571
 572 Used when a controller is creating an action to determine the correct base
 573 action class to use.
 574
 575 =head2 $self->create_action(%args)
 576
 577 Called with a hash of data to be use for construction of a new
 578 Catalyst::Action (or appropriate sub/alternative class) object.
 579
 580 =head2 $self->_application
 581
 582 =head2 $self->_app
 583
 584 Returns the application instance stored by C<new()>
 585
 586 =head1 AUTHORS
 587
 588 Catalyst Contributors, see Catalyst.pm
 589
 590 =head1 COPYRIGHT
 591
 592 This library is free software. You can redistribute it and/or modify
 593 it under the same terms as Perl itself.
 594
 595 =cut