use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use Class::C3::Adopt::NEXT;
+use Hash::Util qw/lock_hash/;
use List::MoreUtils qw/uniq/;
use attributes;
use utf8;
#I imagine that very few of these really need to be class variables. if any.
#maybe we should just make them attributes with a default?
__PACKAGE__->mk_classdata($_)
- for qw/container components arguments dispatcher engine log dispatcher_class
+ for qw/container arguments dispatcher engine log dispatcher_class
engine_class context_class request_class response_class stats_class
setup_finished/;
return if $caller eq 'main';
my $meta = Moose::Meta::Class->initialize($caller);
- unless ( $caller->isa('Catalyst') ) {
- my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
- $meta->superclasses(@superclasses);
- }
+
+ unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
+ my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
+ $meta->superclasses(@superclasses); # XXX - Remove!
+ } # XXX - Remove!
+
# Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
$meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
$caller->setup_home;
}
+sub MODIFY_CODE_ATTRIBUTES {
+ Catalyst::Exception->throw(
+ "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
+ "That has been deprecated and removed. You should create a " .
+ "controller class called Root.pm, and move relevant code to that class."
+ );
+}
+
+
sub _application { $_[0] }
=head1 NAME
$c->error(0);
}
-sub _comp_search_prefixes {
- my $c = shift;
- return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
-}
-
-# search components given a name and some prefixes
-sub _comp_names_search_prefixes {
- my ( $c, $name, @prefixes ) = @_;
- my $appclass = ref $c || $c;
- my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
- $filter = qr/$filter/; # Compile regex now rather than once per loop
-
- my @components = map { $c->container->get_sub_container($_)->get_service_list } qw(controller view model);
-
- # map the original component name to the sub part that we will search against
- my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
- grep { /$filter/ } @components;
-
- # undef for a name will return all
- return keys %eligible if !defined $name;
-
- my $query = ref $name ? $name : qr/^$name$/i;
- my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
-
- return @result if @result;
-
- # if we were given a regexp to search against, we're done.
- return if ref $name;
-
- # skip regexp fallback if configured
- return
- if $appclass->config->{disable_component_resolution_regex_fallback};
-
- # regexp fallback
- $query = qr/$name/i;
- @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
-
- # no results? try against full names
- if( !@result ) {
- @result = grep { m{$query} } keys %eligible;
- }
-
- # don't warn if we didn't find any results, it just might not exist
- if( @result ) {
- # Disgusting hack to work out correct method name
- my $warn_for = lc $prefixes[0];
- my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
- (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
- "component resolution is unreliable and unsafe.";
- my $short = $result[0];
- # remove the component namespace prefix
- $short =~ s/.*?(Model|Controller|View):://;
- my $shortmess = Carp::shortmess('');
- if ($shortmess =~ m#Catalyst/Plugin#) {
- $msg .= " You probably need to set '$short' instead of '${name}' in this " .
- "plugin's config";
- } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
- $msg .= " You probably need to set '$short' instead of '${name}' in this " .
- "component's config";
- } else {
- $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
- "but if you really wanted to search, pass in a regexp as the argument " .
- "like so: \$c->${warn_for}(qr/${name}/)";
- }
- $c->log->warn( "${msg}$shortmess" );
- }
-
- return @result;
-}
-
-# Find possible names for a prefix
-sub _comp_names {
- my ( $c, @prefixes ) = @_;
- my $appclass = ref $c || $c;
-
- my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
-
- my @names = map { s{$filter}{}; $_; }
- $c->_comp_names_search_prefixes( undef, @prefixes );
-
- return @names;
-}
-
-# Filter a component before returning by calling ACCEPT_CONTEXT if available
-sub _filter_component {
- my ( $c, $comp, @args ) = @_;
-
- if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
- return $comp->ACCEPT_CONTEXT( $c, @args );
- }
-
- return $comp;
-}
-
=head2 COMPONENT ACCESSORS
=head2 $c->controller($name)
sub controller {
my ( $c, $name, @args ) = @_;
- my $container = $c->container->get_sub_container('controller');
- my $appclass = ref $c || $c;
- if( $name ) {
- if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps
- return $container->resolve(service => $name, parameters => { context => [ $c, @args ] } )
- if $container->has_service($name);
- }
- elsif ( ref $name eq 'Regexp' ) {
- my @comps = $container->get_service_list;
- my @result;
- for (@comps) {
- push @result, $container->resolve( service => $_, parameters => { context => [ $c, @args ] } )
- if m/$name/;
- }
- return @result;
- }
- else {
- my $short_name = ref $name;
- $short_name =~ s/^${appclass}::(C|Controller)//;
- return $container->resolve( service => $short_name, parameters => { context => [ $c, @args ] } )
- if $container->has_service($short_name);
- }
- return;
- }
+ $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
- return $c->component( $c->action->class );
+ return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
}
=head2 $c->model($name)
sub model {
my ( $c, $name, @args ) = @_;
- my $appclass = ref($c) || $c;
- my $container = $c->container->get_sub_container('model');
- if( $name ) {
- if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps
- return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } )
- if $container->has_service($name);
- }
- elsif ( ref $name eq 'Regexp' ) {
- my @comps = $container->get_service_list;
- my @result;
- for (@comps) {
- push @result, $container->resolve( service => $_, parameters => { context => [ $c, @args ] } )
- if m/$name/;
- }
- return @result;
- }
- else {
- my $short_name = ref $name;
- $short_name =~ s/^${appclass}::(M|Model)//;
- return $container->resolve( service => $short_name, parameters => { context => [ $c, @args ] } )
- if $container->has_service($short_name);
- }
- return;
- }
-
- if (ref $c) {
+ if (ref $c && !$name) {
return $c->stash->{current_model_instance}
- if $c->stash->{current_model_instance};
- return $c->model( $c->stash->{current_model} )
- if $c->stash->{current_model};
- }
- return $c->model( $appclass->config->{default_model} )
- if $appclass->config->{default_model};
-
-# FIXME: will this still be mantained?
- my( $comp, $rest ) = $container->get_service_list;
+ if $c->stash->{current_model_instance};
- if( $rest ) {
- $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
- $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
- $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
- $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
+ $name = $c->stash->{current_model}
+ if $c->stash->{current_model};
}
- return $container->resolve( service => $comp, parameters => { context => [ $c, @args ] } );
+ return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
}
sub view {
my ( $c, $name, @args ) = @_;
- my $appclass = ref($c) || $c;
- my $container = $c->container->get_sub_container('view');
- if( $name ) {
- if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps
- if ( $container->has_service($name) ) {
- return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } );
- }
- else {
- $c->log->warn( "Attempted to use view '$name', but does not exist" );
- }
- }
- elsif ( ref $name eq 'Regexp' ) {
- my @comps = $container->get_service_list;
- my @result;
- for (@comps) {
- push @result, $container->resolve( service => $_, parameters => { context => [ $c, @args ] } )
- if m/$name/;
- }
- return @result;
- }
- else {
- my $short_name = ref $name;
- $short_name =~ s/^${appclass}::(V|View)//;
- return $container->resolve( service => $short_name, parameters => { context => [ $c, @args ] } )
- if $container->has_service($short_name);
- }
-
- return;
- }
-
- if (ref $c) {
+ if (ref $c && !$name) {
return $c->stash->{current_view_instance}
- if $c->stash->{current_view_instance};
- return $c->view( $c->stash->{current_view} )
- if $c->stash->{current_view};
- }
- return $c->view( $appclass->config->{default_view} )
- if $appclass->config->{default_view};
+ if $c->stash->{current_view_instance};
- my( $comp, $rest ) = $container->get_service_list;
-
- if( $rest ) {
- $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
- $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
- $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
- $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
- $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
+ $name = $c->stash->{current_view}
+ if $c->stash->{current_view};
}
- return $container->resolve( service => $comp, parameters => { context => [ $c, @args ] } );
+ return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
}
=head2 $c->controllers
If C<$name> is a regexp, a list of components matched against the full
component name will be returned.
-If Catalyst can't find a component by name, it will fallback to regex
-matching by default. To disable this behaviour set
-disable_component_resolution_regex_fallback to a true value.
-
- __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
-
=cut
sub component {
my ( $c, $component, @args ) = @_;
- my ($type, $name) = _get_component_type_name($component);
- my $container = $c->container->get_sub_container($type);
+ unless ($component) {
+ $c->log->warn('Calling $c->component with no args is deprecated and ');
+ $c->log->warn('will be removed in a future release.');
+ $c->log->warn('Use $c->component_list instead.');
+ return $c->component_list;
+ }
- if( $component ) {
- my $comps = $c->components;
+ my ($type, $name) = _get_component_type_name($component);
- if( !ref $component ) {
- return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } )
- if $container->has_service( $name );
- }
+ return $c->container->get_component_from_sub_container(
+ $type, $name, $c, @args
+ ) if $type;
- return
- if $c->config->{disable_component_resolution_regex_fallback};
+ my @result = $c->container->find_component( $component, $c, @args );
- # This is here so $c->comp( '::M::' ) works
- my $query = ref $component ? $component : qr{$component}i;
+ # one last search for things like $c->comp(qr/::M::/)
+ @result = $c->container->find_component_regexp(
+ $c->components, $component, $c, @args
+ ) if !@result and ref $component;
- my @result = grep { m{$query} } keys %{ $c->components };
- return map { $c->_filter_component( $_, @args ) } @result if ref $component;
+ # list context for regexp searches
+ return @result if ref $component;
- if( $result[ 0 ] ) {
- $c->log->warn( Carp::shortmess(qq(Found results for "${component}" using regexp fallback)) );
- $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
- $c->log->warn( 'is unreliable and unsafe. You have been warned' );
- return $c->_filter_component( $result[ 0 ], @args );
- }
+ # only one component (if it's found) for string searches
+ return shift @result if @result;
- # I would expect to return an empty list here, but that breaks back-compat
+ if (ref $c eq $component) {
+ $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
+ $c->log->warn('deprecated, and will be removed in a future release.');
+ return $c;
}
- # fallback
- return sort keys %{ $c->components };
+ $c->log->warn("Looking for '$component', but nothing was found.");
+
+ # I would expect to return an empty list here, but that breaks back-compat
+ $c->log->warn('Component not found, returning the list of existing');
+ $c->log->warn('components. This behavior is deprecated and will be');
+ $c->log->warn('removed in a future release. Use $c->component_list');
+ $c->log->warn('instead.');
+
+ return $c->component_list;
}
+=head2 $c->component_list
+
+Returns the sorted list of the component names of the application.
+
+=cut
+
+sub component_list { sort keys %{ shift->components } }
+
=head2 CLASS DATA AND HELPER CLASSES
=head2 $c->config
sub plugin {
my ( $class, $name, $plugin, @args ) = @_;
- # See block comment in t/unit_core_plugin.t
+ # See block comment in t/aggregate/unit_core_plugin.t
$class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
$class->_register_plugin( $plugin, 1 );
$class->setup unless $Catalyst::__AM_RESTARTING;
}
- # Initialize our data structure
- $class->components( {} );
-
$class->setup_components;
- if ( $class->debug ) {
+ if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!!
my $column_width = Catalyst::Utils::term_width() - 8 - 9;
my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
for my $comp ( sort keys %{ $class->components } ) {
if ( keys %{ $class->components } );
}
- # Add our self to components, since we are also a component
- if( $class->isa('Catalyst::Controller') ){
- $class->components->{$class} = $class;
- }
-
$class->setup_actions;
if ( $class->debug ) {
=cut
-around components => sub {
- my $orig = shift;
- my $class = shift;
- my $comps = shift;
-
- return $class->$orig if ( !$comps );
+sub components {
+ my ( $class, $comps ) = @_;
-# FIXME: should this ugly kludge exist?
+ # FIXME: should this ugly kludge exist?
$class->setup_config unless defined $class->container;
-# FIXME: should there be a warning here, not to use this accessor to create the components?
- my $components = {};
-
my $containers;
- $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
-
- for my $component ( keys %$comps ) {
- $components->{ $component } = $comps->{$component};
-
- my ($type, $name) = _get_component_type_name($component);
+ $containers->{$_} = $class->container->get_sub_container($_)
+ for qw(model view controller);
+
+ if ( $comps ) {
+ for my $component ( keys %$comps ) {
+ my ($type, $name) = _get_component_type_name($component);
+
+ $containers->{$type}->add_service(
+ Catalyst::IOC::BlockInjection->new(
+ name => $name,
+ block => sub { $class->setup_component($component) },
+ )
+ );
+ }
+ }
-# FIXME: shouldn't the service name be $name?
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+ my %components;
+ for my $container (keys %$containers) {
+ my @service_list = $containers->{$container}->get_service_list;
+ for my $component (@service_list) {
+ my $comp = $containers->{$container}->resolve(
+ service => $component
+ );
+ my $comp_name = ref $comp || $comp;
+ $components{$comp_name} = $comp;
+ }
}
- return $class->$orig($components);
-};
+ return lock_hash %components;
+}
=head2 $c->context_class
my %args = %{ $class->config || {} };
- my @container_classes = ( "${class}::Container", 'Catalyst::Container');
+ my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
unshift @container_classes, delete $args{container_class} if exists $args{container_class};
my $container_class = Class::MOP::load_first_existing_class(@container_classes);
$class->finalize_config; # back-compat
}
-=head $c->finalize_config
+=head2 $c->finalize_config
=cut
my $class = shift;
my $config = $class->config->{ setup_components };
+ my $search_extra = $config->{ search_extra };
my @comps = $class->locate_components($config);
my %comps = map { $_ => 1 } @comps;
$containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
for my $component (@comps) {
- my $instance = $class->components->{ $component } = $class->setup_component($component);
- if ( my ($type, $name) = _get_component_type_name($component) ) {
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $instance } ));
+ my $instance = $class->setup_component($component);
+ if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) {
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
}
my @expanded_components = $instance->can('expand_modules')
? $instance->expand_modules( $component, $config )
qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
) if $deprecatedcatalyst_component_names;
- if (my ($type, $name) = _get_component_type_name($component)) {
- $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
+ if (my ($type, $name) = _get_component_type_name($component, $search_extra)) {
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
}
-
- $class->components->{ $component } = $class->setup_component($component);
}
}
+
+ $containers->{model}->make_single_default;
+ $containers->{view}->make_single_default;
}
+# FIXME: should this sub exist?
+# should it be moved to Catalyst::Utils,
+# or replaced by something already existing there?
sub _get_component_type_name {
- my $component = shift;
- my @parts = split /::/, $component;
+ my ( $component, $search_extra) = @_;
+ $search_extra ||= [];
+ my @search_extra = map { s/^:://; lc $_ } @$search_extra;
+
+ my @parts = split /::/, $component;
+
+ if (scalar @parts == 1) {
+ return (undef, $component);
+ }
while (my $type = shift @parts) {
return ('controller', join '::', @parts)
return ('view', join '::', @parts)
if $type =~ /^(v|view)$/i;
+
+ return (_get_component_type($component), join '::', @parts)
+ if @search_extra and ( grep { lc $type eq $_ } @search_extra );
}
}
+sub _get_component_type {
+ my ( $instance ) = @_;
+
+ return 'controller' if $instance->isa('Catalyst::Controller');
+ return 'model' if $instance->isa('Catalyst::Model');
+ return 'view' if $instance->isa('Catalyst::View');
+}
+
=head2 $c->locate_components( $setup_component_config )
This method is meant to provide a list of component modules that should be
=cut
+## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
sub setup_component {
my( $class, $component ) = @_;
=item *
-C<disable_component_resolution_regex_fallback> - Turns
-off the deprecated component resolution functionality so
-that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
-are called then regex search will not be attempted on string values and
-instead C<undef> will be returned.
-
-=item *
-
C<home> - The application home directory. In an uninstalled application,
this is the top level application directory. In an installed application,
this will be the directory containing C<< MyApp.pm >>.
Andrew Ruthven
+André Walker
+
andyg: Andy Grundman <andy@hybridized.org>
audreyt: Audrey Tang
projects / catagits/Catalyst-Runtime.git / blobdiff