X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=12520e0225949d3c0637be4d3a843fc66b85a3e4;hb=56089c3b1874315737efea071b798453dbb6c8eb;hp=dfd7863ec0fa7d6b729593442eb8e63fa6cfb5a6;hpb=ad0f7a3b8ff866496d275bb9588fa3bab9e7c98b;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index dfd7863..12520e0 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -536,96 +536,32 @@ sub clear_errors { $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 - - # 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/ } keys %{ $c->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; +sub _find_component_regexp { + my ( $c, $container, $name, $args ) = @_; - # 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; -} + if $c->config->{disable_component_resolution_regex_fallback} && !ref $name; -# Find possible names for a prefix -sub _comp_names { - my ( $c, @prefixes ) = @_; my $appclass = ref $c || $c; + my $prefix = ucfirst $container->name; + my $p = substr $prefix, 0, 1; - my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; - - my @names = map { s{$filter}{}; $_; } - $c->_comp_names_search_prefixes( undef, @prefixes ); - - return @names; -} + my $query = ref $name ? $name : qr{$name}i; + $query =~ s/^${appclass}::($p|$prefix):://i; -# Filter a component before returning by calling ACCEPT_CONTEXT if available -sub _filter_component { - my ( $c, $comp, @args ) = @_; + my @comps = $container->get_service_list; + my @result = map { + $container->resolve( service => $_, parameters => { context => $args } ) + } grep { m/$query/ } @comps; - if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) { - return $comp->ACCEPT_CONTEXT( $c, @args ); + if (!ref $name && $result[0]) { + $c->log->warn( Carp::shortmess(qq(Found results for "${name}" 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 $result[0]; } - return $comp; + return @result; } =head2 COMPONENT ACCESSORS @@ -649,17 +585,15 @@ If you want to search for controllers, pass in a regexp as the argument. sub controller { my ( $c, $name, @args ) = @_; + my $container = $c->container->get_sub_container('controller'); + unshift @args, $c; - my $appclass = ref($c) || $c; if( $name ) { - unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps - my $comps = $c->components; - my $check = $appclass."::Controller::".$name; - return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check}; - } - my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ ); - return map { $c->_filter_component( $_, @args ) } @result if ref $name; - return $c->_filter_component( $result[ 0 ], @args ); + # Direct component hash lookup to avoid costly regexps + return $c->container->get_component('controller', $name, \@args) + if $container->has_service($name) && !ref $name; + + return $c->_find_component_regexp( $container, $name, \@args ); } return $c->component( $c->action->class ); @@ -689,15 +623,15 @@ If you want to search for models, pass in a regexp as the argument. sub model { my ( $c, $name, @args ) = @_; my $appclass = ref($c) || $c; + my $container = $c->container->get_sub_container('model'); + unshift @args, $c; + if( $name ) { - unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps - my $comps = $c->components; - my $check = $appclass."::Model::".$name; - return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check}; - } - my @result = $c->_comp_search_prefixes( $name, qw/Model M/ ); - return map { $c->_filter_component( $_, @args ) } @result if ref $name; - return $c->_filter_component( $result[ 0 ], @args ); + # Direct component hash lookup to avoid costly regexps + return $c->container->get_component('model', $name, \@args) + if $container->has_service($name) && !ref $name; + + return $c->_find_component_regexp( $container, $name, \@args ); } if (ref $c) { @@ -709,7 +643,8 @@ sub model { return $c->model( $appclass->config->{default_model} ) if $appclass->config->{default_model}; - my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/); +# FIXME: will this still be mantained? + my( $comp, $rest ) = $container->get_service_list; if( $rest ) { $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') ); @@ -719,7 +654,7 @@ sub model { $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' ); } - return $c->_filter_component( $comp ); + return $container->resolve( service => $comp, parameters => { context => \@args } ); } @@ -746,22 +681,21 @@ If you want to search for views, pass in a regexp as the argument. sub view { my ( $c, $name, @args ) = @_; - my $appclass = ref($c) || $c; + my $container = $c->container->get_sub_container('view'); + unshift @args, $c; + if( $name ) { - unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps - my $comps = $c->components; - my $check = $appclass."::View::".$name; - if( exists $comps->{$check} ) { - return $c->_filter_component( $comps->{$check}, @args ); + if ( !ref $name ) { # Direct component hash lookup to avoid costly regexps + if ( $container->has_service($name) ) { + return $c->container->get_component('view', $name, \@args); } else { - $c->log->warn( "Attempted to use view '$check', but does not exist" ); + $c->log->warn( "Attempted to use view '$name', but does not exist" ); } } - my @result = $c->_comp_search_prefixes( $name, qw/View V/ ); - return map { $c->_filter_component( $_, @args ) } @result if ref $name; - return $c->_filter_component( $result[ 0 ], @args ); + + return $c->_find_component_regexp( $container, $name, \@args ); } if (ref $c) { @@ -773,7 +707,7 @@ sub view { return $c->view( $appclass->config->{default_view} ) if $appclass->config->{default_view}; - my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/); + 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:' ); @@ -783,7 +717,7 @@ sub view { $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' ); } - return $c->_filter_component( $comp ); + return $container->resolve( service => $comp, parameters => { context => \@args } ); } =head2 $c->controllers @@ -794,7 +728,7 @@ Returns the available names which can be passed to $c->controller sub controllers { my ( $c ) = @_; - return $c->_comp_names(qw/Controller C/); + return $c->container->get_sub_container('controller')->get_service_list; } =head2 $c->models @@ -805,7 +739,7 @@ Returns the available names which can be passed to $c->model sub models { my ( $c ) = @_; - return $c->_comp_names(qw/Model M/); + return $c->container->get_sub_container('model')->get_service_list; } @@ -817,7 +751,7 @@ Returns the available names which can be passed to $c->view sub views { my ( $c ) = @_; - return $c->_comp_names(qw/View V/); + return $c->container->get_sub_container('view')->get_service_list; } =head2 $c->comp($name) @@ -841,37 +775,55 @@ disable_component_resolution_regex_fallback to a true value. =cut sub component { - my ( $c, $name, @args ) = @_; + my ( $c, $component, @args ) = @_; - if( $name ) { - my $comps = $c->components; + if ( $component ) { + my ($type, $name) = _get_component_type_name($component); + + if ($type && $c->container->has_sub_container($type)) { + my $container = $c->container->get_sub_container($type); + + if( !ref $component && $container->has_service($name) ) { + return $container->resolve( service => $name, parameters => { context => [ $c, @args ] } ); + } + + return + if $c->config->{disable_component_resolution_regex_fallback}; - if( !ref $name ) { - # is it the exact name? - return $c->_filter_component( $comps->{ $name }, @args ) - if exists $comps->{ $name }; + my $query = qr{$name}i; + my @components = $container->get_service_list; + my @result = grep { m{$query} } @components; - # perhaps we just omitted "MyApp"? - my $composed = ( ref $c || $c ) . "::${name}"; - return $c->_filter_component( $comps->{ $composed }, @args ) - if exists $comps->{ $composed }; + if (@result) { + $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' ); - # search all of the models, views and controllers - my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ ); - return $c->_filter_component( $comp, @args ) if $comp; + return $container->resolve( service => $result[0], parameters => { context => [$c, @args] } ); + } } + return + if $c->config->{disable_component_resolution_regex_fallback} && !ref $component; + # This is here so $c->comp( '::M::' ) works - my $query = ref $name ? $name : qr{$name}i; + my $query = ref $component ? $component : qr{$component}i; + + for my $subcontainer_name (qw/model view controller/) { + my $subcontainer = $c->container->get_sub_container($subcontainer_name); + my @components = $subcontainer->get_service_list; + my @result = grep { m{$query} } @components; + + if (@result) { + return map { $subcontainer->resolve( service => $_, parameters => { context => [$c, @args] } ) } @result + if ref $component; - my @result = grep { m{$query} } keys %{ $c->components }; - return map { $c->_filter_component( $_, @args ) } @result if ref $name; + $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' ); - if( $result[ 0 ] ) { - $c->log->warn( Carp::shortmess(qq(Found results for "${name}" 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 ); + return $subcontainer->resolve( service => $result[0], parameters => { context => [$c, @args] } ); + } } # I would expect to return an empty list here, but that breaks back-compat @@ -1590,6 +1542,36 @@ These methods are not meant to be used by end users. Returns a hash of components. +=cut + +around components => sub { + my $orig = shift; + my $class = shift; + my $comps = shift; + + return $class->$orig if ( !$comps ); + +# 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); + +# FIXME: shouldn't the service name be $name? + $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } )); + } + + return $class->$orig($components); +}; + =head2 $c->context_class Returns or sets the context class. @@ -2419,18 +2401,17 @@ sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } sub setup_config { my $class = shift; - my %args = %{$class->config || {} }; - my @container_classes = qw/MyApp::Container Catalyst::Container/; + my %args = %{ $class->config || {} }; + + my @container_classes = ( "${class}::Container", 'Catalyst::Container'); unshift @container_classes, delete $args{container_class} if exists $args{container_class}; my $container_class = Class::MOP::load_first_existing_class(@container_classes); my $container = $container_class->new( %args, name => "$class" ); - - $container->add_sub_container(Bread::Board::Container->new( name => $_ )) for qw(model controller view); $class->container($container); - my $config = $container->fetch('config')->get; + my $config = $container->resolve(service => 'config'); $class->config($config); $class->finalize_config; # back-compat } @@ -2483,13 +2464,9 @@ sub setup_components { for my $component (@comps) { my $instance = $class->components->{ $component } = $class->setup_component($component); - my $type = lc((split /::/, $component)[1]); - if ($deprecatedcatalyst_component_names) { - $type = 'controller' if $type eq 'c'; - $type = 'model' if $type eq 'm'; - $type = 'view' if $type eq 'v'; + 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(Bread::Board::BlockInjection->new( name => $component, block => sub { return $instance } )); my @expanded_components = $instance->can('expand_modules') ? $instance->expand_modules( $component, $config ) : $class->expand_component_module( $component, $config ); @@ -2501,18 +2478,31 @@ sub setup_components { qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n} ) if $deprecatedcatalyst_component_names; - if ($deprecatedcatalyst_component_names) { - $type = lc((split /::/, $component)[1]); - $type = 'controller' if $type eq 'c'; - $type = 'model' if $type eq 'm'; - $type = 'view' if $type eq 'v'; + 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(Bread::Board::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } )); + $class->components->{ $component } = $class->setup_component($component); } } } +sub _get_component_type_name { + my $component = shift; + my @parts = split /::/, $component; + + while (my $type = shift @parts) { + return ('controller', join '::', @parts) + if $type =~ /^(c|controller)$/i; + + return ('model', join '::', @parts) + if $type =~ /^(m|model)$/i; + + return ('view', join '::', @parts) + if $type =~ /^(v|view)$/i; + } +} + =head2 $c->locate_components( $setup_component_config ) This method is meant to provide a list of component modules that should be @@ -2583,8 +2573,7 @@ sub setup_component { message => qq/Couldn't instantiate component "$component", "$error"/ ); } - - unless (blessed $instance) { + elsif (!blessed $instance) { my $metaclass = Moose::Util::find_meta($component); my $method_meta = $metaclass->find_method_by_name('COMPONENT'); my $component_method_from = $method_meta->associated_metaclass->name; @@ -2594,6 +2583,7 @@ sub setup_component { qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./ ); } + return $instance; } @@ -2857,7 +2847,7 @@ the plugin name does not begin with C. my $class = ref $proto || $proto; Class::MOP::load_class( $plugin ); - $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" ) + $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" ) if $plugin->isa( 'Catalyst::Component' ); $proto->_plugins->{$plugin} = 1; unless ($instant) {