use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use Class::C3::Adopt::NEXT;
+use List::Util qw/first/;
use List::MoreUtils qw/uniq/;
use attributes;
use utf8;
$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;
+# FIXME: should this be a Catalyst::Utils method?
+ if (!$name) {
+ my $class = $c->action->class;
+
+ my $prefix = length Catalyst::Utils::class2classprefix($class);
+
+ # MyApp::Controller::Foo becomes Foo
+ # the + 2 is because of the ::
+ $name = substr $class, $prefix + 2;
}
- 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};
-
- my( $comp, $rest ) = $container->get_service_list;
+ if $c->stash->{current_view_instance};
- 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
return $c->container->get_sub_container('view')->get_service_list;
}
+sub _find_component {
+ my ($c, $component, @args) = @_;
+ my @result;
+
+ my $query = ref $component
+ ? $component
+ : qr{^$component$}
+ ;
+
+ for my $subcontainer_name (qw/model view controller/) {
+ my $subcontainer = $c->container->get_sub_container($subcontainer_name);
+ my @components = $subcontainer->get_service_list;
+ @result = grep { m{$component} } @components;
+
+ return map { $subcontainer->get_component( $_, $c, @args ) } @result
+ if @result;
+ }
+
+ # it expects an empty list on failed searches
+ return @result;
+}
+
=head2 $c->comp($name)
=head2 $c->component($name)
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);
+ return sort keys %{ $c->components }
+ unless ( $component );
- if( $component ) {
- my $comps = $c->components;
+ return $c->_find_component( $component, @args )
+ if ref $component;
- if( !ref $component ) {
- return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } )
- if $container->has_service( $name );
- }
+ my ($type, $name) = _get_component_type_name($component);
- return
- if $c->config->{disable_component_resolution_regex_fallback};
+ return $c->container->get_component_from_sub_container(
+ $type, $name, $c, @args
+ ) if $type;
- # This is here so $c->comp( '::M::' ) works
- my $query = ref $component ? $component : qr{$component}i;
+ my @result = $c->_find_component( $component, @args );
+ return shift @result if @result;
- my @result = grep { m{$query} } keys %{ $c->components };
- return map { $c->_filter_component( $_, @args ) } @result if ref $component;
+ # FIXME: I probably shouldn't be doing this
+ # I'm keeping it temporarily for things like $c->comp('MyApp')
+ return $c->components->{$component}
+ if exists $c->components->{$component} and !@args;
- 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 );
- }
+ $c->log->warn("Looking for '$component', but nothing was found.");
- # I would expect to return an empty list here, but that breaks back-compat
- }
+ # 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 going to be deprecated");
+ $c->log->warn("in future releases.");
- # fallback
return sort keys %{ $c->components };
}
my ($type, $name) = _get_component_type_name($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) } ));
+ $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
}
return $class->$orig($components);
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
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 } ));
+ $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 )
) 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) } ));
+ $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;
+ if (scalar @parts == 1) {
+ return (undef, $component);
+ }
+
while (my $type = shift @parts) {
return ('controller', join '::', @parts)
if $type =~ /^(c|controller)$/i;
=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