1 package Catalyst::IOC::Container;
5 use Data::Visitor::Callback;
6 use Catalyst::Utils ();
7 use Devel::InnerPackage ();
8 use Hash::Util qw/lock_hash/;
9 use MooseX::Types::LoadableClass qw/ LoadableClass /;
11 use Catalyst::IOC::BlockInjection;
12 use Module::Pluggable::Object ();
13 use namespace::autoclean;
15 extends 'Bread::Board::Container';
17 has config_local_suffix => (
26 default => sub { +{} },
35 has substitutions => (
38 default => sub { +{} },
41 has application_name => (
47 has sub_container_class => (
51 default => 'Catalyst::IOC::SubContainer',
53 new_sub_container => 'new',
58 my ( $self, $params ) = @_;
61 $self->${\"build_${_}_service"}
81 $self->add_sub_container(
82 $self->build_controller_subcontainer
85 # FIXME - the config should be merged at this point
86 my $config = $self->resolve( service => 'config' );
87 my $default_view = $params->{default_view} || $config->{default_view};
88 my $default_model = $params->{default_model} || $config->{default_model};
90 $self->add_sub_container(
91 $self->build_view_subcontainer(
92 default_component => $default_view,
96 $self->add_sub_container(
97 $self->build_model_subcontainer(
98 default_component => $default_model,
103 sub build_model_subcontainer {
106 return $self->new_sub_container( @_,
111 sub build_view_subcontainer {
114 return $self->new_sub_container( @_,
119 sub build_controller_subcontainer {
122 return $self->new_sub_container(
123 name => 'controller',
127 sub build_application_name_service {
130 return Bread::Board::Literal->new( name => 'application_name', value => $self->application_name );
133 sub build_driver_service {
136 return Bread::Board::Literal->new( name => 'driver', value => $self->driver );
139 sub build_file_service {
142 return Bread::Board::Literal->new( name => 'file', value => $self->file );
145 sub build_substitutions_service {
148 return Bread::Board::Literal->new( name => 'substitutions', value => $self->substitutions );
151 sub build_extensions_service {
154 return Bread::Board::BlockInjection->new(
155 lifecycle => 'Singleton',
156 name => 'extensions',
158 return \@{Config::Any->extensions};
163 sub build_prefix_service {
166 return Bread::Board::BlockInjection->new(
167 lifecycle => 'Singleton',
170 return Catalyst::Utils::appprefix( shift->param('application_name') );
172 dependencies => [ depends_on('application_name') ],
176 sub build_path_service {
179 return Bread::Board::BlockInjection->new(
180 lifecycle => 'Singleton',
185 return Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG' )
187 || $s->param('application_name')->path_to( $s->param('prefix') );
189 dependencies => [ depends_on('file'), depends_on('application_name'), depends_on('prefix') ],
193 sub build_config_service {
196 return Bread::Board::BlockInjection->new(
197 lifecycle => 'Singleton',
202 my $v = Data::Visitor::Callback->new(
204 return unless defined $_;
205 return $self->_config_substitutions( $s->param('application_name'), $s->param('substitutions'), $_ );
209 $v->visit( $s->param('raw_config') );
211 dependencies => [ depends_on('application_name'), depends_on('raw_config'), depends_on('substitutions') ],
215 sub build_raw_config_service {
218 return Bread::Board::BlockInjection->new(
219 lifecycle => 'Singleton',
220 name => 'raw_config',
224 my @global = @{$s->param('global_config')};
225 my @locals = @{$s->param('local_config')};
228 for my $cfg (@global, @locals) {
230 $config = Catalyst::Utils::merge_hashes( $config, $cfg->{$_} );
235 dependencies => [ depends_on('global_config'), depends_on('local_config') ],
239 sub build_global_files_service {
242 return Bread::Board::BlockInjection->new(
243 lifecycle => 'Singleton',
244 name => 'global_files',
248 my ( $path, $extension ) = @{$s->param('config_path')};
250 my @extensions = @{$s->param('extensions')};
254 die "Unable to handle files with the extension '${extension}'" unless grep { $_ eq $extension } @extensions;
257 @files = map { "$path.$_" } @extensions;
261 dependencies => [ depends_on('extensions'), depends_on('config_path') ],
265 sub build_local_files_service {
268 return Bread::Board::BlockInjection->new(
269 lifecycle => 'Singleton',
270 name => 'local_files',
274 my ( $path, $extension ) = @{$s->param('config_path')};
275 my $suffix = $s->param('config_local_suffix');
277 my @extensions = @{$s->param('extensions')};
281 die "Unable to handle files with the extension '${extension}'" unless grep { $_ eq $extension } @extensions;
282 $path =~ s{\.$extension}{_$suffix.$extension};
285 @files = map { "${path}_${suffix}.$_" } @extensions;
289 dependencies => [ depends_on('extensions'), depends_on('config_path'), depends_on('config_local_suffix') ],
293 sub build_global_config_service {
296 return Bread::Board::BlockInjection->new(
297 lifecycle => 'Singleton',
298 name => 'global_config',
302 return Config::Any->load_files({
303 files => $s->param('global_files'),
304 filter => \&_fix_syntax,
306 driver_args => $s->param('driver'),
309 dependencies => [ depends_on('global_files') ],
313 sub build_local_config_service {
316 return Bread::Board::BlockInjection->new(
317 lifecycle => 'Singleton',
318 name => 'local_config',
322 return Config::Any->load_files({
323 files => $s->param('local_files'),
324 filter => \&_fix_syntax,
326 driver_args => $s->param('driver'),
329 dependencies => [ depends_on('local_files') ],
333 sub build_config_path_service {
336 return Bread::Board::BlockInjection->new(
337 lifecycle => 'Singleton',
338 name => 'config_path',
342 my $path = $s->param('path');
343 my $prefix = $s->param('prefix');
345 my ( $extension ) = ( $path =~ m{\.(.{1,4})$} );
348 $path =~ s{[\/\\]$}{};
352 return [ $path, $extension ];
354 dependencies => [ depends_on('prefix'), depends_on('path') ],
358 sub build_config_local_suffix_service {
361 return Bread::Board::BlockInjection->new(
362 lifecycle => 'Singleton',
363 name => 'config_local_suffix',
366 my $suffix = Catalyst::Utils::env_value( $s->param('application_name'), 'CONFIG_LOCAL_SUFFIX' ) || $self->config_local_suffix;
370 dependencies => [ depends_on('application_name') ],
374 sub build_locate_components_service {
377 return Bread::Board::BlockInjection->new(
378 lifecycle => 'Singleton',
379 name => 'locate_components',
382 my $class = $s->param('application_name');
383 my $config = $s->param('config')->{ setup_components };
385 Catalyst::Exception->throw(
386 qq{You are using search_extra config option. That option is\n} .
387 qq{deprecated, please refer to the documentation for\n} .
388 qq{other ways of achieving the same results.\n}
389 ) if delete $config->{ search_extra };
391 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
393 my $locator = Module::Pluggable::Object->new(
394 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
398 # XXX think about ditching this sort entirely
399 my @comps = sort { length $a <=> length $b } $locator->plugins;
403 dependencies => [ depends_on('application_name'), depends_on('config') ],
411 prefix => $_ eq 'Component' ? '' : $_ . '::',
412 values => delete $config->{ lc $_ } || delete $config->{ $_ }
414 grep { ref $config->{ lc $_ } || ref $config->{ $_ } }
415 qw( Component Model M View V Controller C Plugin )
418 foreach my $comp ( @components ) {
419 my $prefix = $comp->{ prefix };
420 foreach my $element ( keys %{ $comp->{ values } } ) {
421 $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
426 sub _config_substitutions {
427 my ( $self, $name, $subs, $arg ) = @_;
429 $subs->{ HOME } ||= sub { shift->path_to( '' ); };
433 if (! defined($ENV{$v})) {
434 Catalyst::Exception->throw( message =>
435 "Missing environment variable: $v" );
441 $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
442 $subs->{ literal } ||= sub { return $_[ 1 ]; };
443 my $subsre = join( '|', keys %$subs );
445 $arg =~ s{__($subsre)(?:\((.+?)\))?__}{ $subs->{ $1 }->( $name, $2 ? split( /,/, $2 ) : () ) }eg;
449 sub get_component_from_sub_container {
450 my ( $self, $sub_container_name, $name, $c, @args ) = @_;
452 my $sub_container = $self->get_sub_container( $sub_container_name );
455 my $default = $sub_container->default_component;
457 return $sub_container->get_component( $default, $c, @args )
458 if $default && $sub_container->has_service( $default );
460 # FIXME - should I be calling $c->log->warn here?
461 # this is never a controller, so this is safe
462 $c->log->warn( "Calling \$c->$sub_container_name() is not supported unless you specify one of:" );
463 $c->log->warn( "* \$c->config(default_$sub_container_name => 'the name of the default $sub_container_name to use')" );
464 $c->log->warn( "* \$c->stash->{current_$sub_container_name} # the name of the view to use for this request" );
465 $c->log->warn( "* \$c->stash->{current_${sub_container_name}_instance} # the instance of the $sub_container_name to use for this request" );
470 return $sub_container->get_component_regexp( $name, $c, @args )
473 return $sub_container->get_component( $name, $c, @args )
474 if $sub_container->has_service( $name );
477 "Attempted to use $sub_container_name '$name', " .
478 "but it does not exist"
485 my ( $self, $component, $c, @args ) = @_;
486 my ( $type, $name ) = _get_component_type_name($component);
489 return $self->get_component_from_sub_container(
490 $type, $name, $c, @args
493 my $query = ref $component
498 for my $subcontainer_name (qw/model view controller/) {
499 my $subcontainer = $self->get_sub_container( $subcontainer_name );
500 my @components = $subcontainer->get_service_list;
501 @result = grep { m{$component} } @components;
503 return map { $subcontainer->get_component( $_, $c, @args ) } @result
507 # FIXME - I guess I shouldn't be calling $c->components here
508 # one last search for things like $c->comp(qr/::M::/)
509 @result = $self->find_component_regexp(
510 $c->components, $component, $c, @args
511 ) if !@result and ref $component;
513 # it expects an empty list on failed searches
517 sub find_component_regexp {
518 my ( $self, $components, $component, @args ) = @_;
521 my @components = grep { m{$component} } keys %{ $components };
524 my ($type, $name) = _get_component_type_name($_);
526 push @result, $self->get_component_from_sub_container(
534 # FIXME sorry for the name again :)
535 sub get_components_types {
539 for my $sub_container_name (qw/model view controller/) {
540 my $sub_container = $self->get_sub_container($sub_container_name);
541 for my $service ( $sub_container->get_service_list ) {
542 my $comp = $self->resolve(service => $service);
543 my $compname = ref $comp || $comp;
544 my $type = ref $comp ? 'instance' : 'class';
545 push @comps_types, [ $compname, $type ];
552 sub get_all_components {
557 map { $_ => $self->get_sub_container($_) } qw(model view controller)
560 for my $container (keys %$containers) {
561 for my $component ($containers->{$container}->get_service_list) {
562 my $comp = $containers->{$container}->resolve(
563 service => $component
565 my $comp_name = ref $comp || $comp;
566 $components{$comp_name} = $comp;
570 return lock_hash %components;
574 my ( $self, $component, $class ) = @_;
575 my ( $type, $name ) = _get_component_type_name($component);
579 $self->get_sub_container($type)->add_service(
580 Catalyst::IOC::BlockInjection->new(
581 lifecycle => 'Singleton', # FIXME?
583 block => sub { $self->setup_component( $component, $class ) },
588 # FIXME: should this sub exist?
589 # should it be moved to Catalyst::Utils,
590 # or replaced by something already existing there?
591 sub _get_component_type_name {
592 my ( $component ) = @_;
594 my @parts = split /::/, $component;
596 while (my $type = shift @parts) {
597 return ('controller', join '::', @parts)
598 if $type =~ /^(c|controller)$/i;
600 return ('model', join '::', @parts)
601 if $type =~ /^(m|model)$/i;
603 return ('view', join '::', @parts)
604 if $type =~ /^(v|view)$/i;
607 return (undef, $component);
610 # FIXME ugly and temporary
611 # Just moved it here the way it was, so we can work on it here in the container
612 sub setup_component {
613 my ( $self, $component, $class ) = @_;
615 unless ( $component->can( 'COMPONENT' ) ) {
619 # FIXME I know this isn't the "Dependency Injection" way of doing things,
621 my $suffix = Catalyst::Utils::class2classsuffix( $component );
622 my $config = $self->resolve(service => 'config')->{ $suffix } || {};
624 # Stash catalyst_component_name in the config here, so that custom COMPONENT
625 # methods also pass it. local to avoid pointlessly shitting in config
626 # for the debug screen, as $component is already the key name.
627 local $config->{catalyst_component_name} = $component;
629 my $instance = eval { $component->COMPONENT( $class, $config ); };
631 if ( my $error = $@ ) {
633 Catalyst::Exception->throw(
634 message => qq/Couldn't instantiate component "$component", "$error"/
637 elsif (!blessed $instance) {
638 my $metaclass = Moose::Util::find_meta($component);
639 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
640 my $component_method_from = $method_meta->associated_metaclass->name;
641 my $value = defined($instance) ? $instance : 'undef';
642 Catalyst::Exception->throw(
644 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
651 sub expand_component_module {
652 my ( $class, $module ) = @_;
653 return Devel::InnerPackage::list_packages( $module );
656 sub setup_components {
657 my ( $self, $class ) = @_;
659 my @comps = @{ $self->resolve( service => 'locate_components' ) };
660 my %comps = map { $_ => 1 } @comps;
661 my $deprecatedcatalyst_component_names = 0;
663 for my $component ( @comps ) {
665 # We pass ignore_loaded here so that overlay files for (e.g.)
666 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
667 # we know M::P::O found a file on disk so this is safe
669 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
672 for my $component (@comps) {
673 $self->add_component( $component, $class );
674 # FIXME - $instance->expand_modules() is broken
675 my @expanded_components = $self->expand_component_module( $component );
678 !$deprecatedcatalyst_component_names &&
679 ($deprecatedcatalyst_component_names = $component =~ m/::[CMV]::/) ||
680 ($deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components)
682 # FIXME - should I be calling warn here?
683 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
684 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
688 for my $component (@expanded_components) {
689 $self->add_component( $component, $class )
690 unless $comps{$component};
694 $self->get_sub_container('model')->make_single_default;
695 $self->get_sub_container('view')->make_single_default;
706 Catalyst::Container - IOC for Catalyst components
716 =head2 build_model_subcontainer
718 Container that stores all models.
720 =head2 build_view_subcontainer
722 Container that stores all views.
724 =head2 build_controller_subcontainer
726 Container that stores all controllers.
730 =head2 build_application_name_service
732 Name of the application (such as MyApp).
734 =head2 build_driver_service
736 Config options passed directly to the driver being used.
738 =head2 build_file_service
742 =head2 build_substitutions_service
744 Executes all the substitutions in config. See L</_config_substitutions> method.
746 =head2 build_extensions_service
748 =head2 build_prefix_service
750 =head2 build_path_service
752 =head2 build_config_service
754 =head2 build_raw_config_service
756 =head2 build_global_files_service
758 =head2 build_local_files_service
760 =head2 build_global_config_service
762 =head2 build_local_config_service
764 =head2 build_config_path_service
766 =head2 build_config_local_suffix_service
768 Determines the suffix of files used to override the main config. By default
769 this value is C<local>, which will load C<myapp_local.conf>. The suffix can
770 be specified in the following order of preference:
774 =item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
776 =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
780 The first one of these values found replaces the default of C<local> in the
781 name of the local config file to be loaded.
783 For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>,
784 ConfigLoader will try and load C<myapp_testing.conf> instead of
787 =head2 get_component_from_sub_container($sub_container, $name, $c, @args)
789 Looks for components in a given subcontainer (such as controller, model or view), and returns the searched component. If $name is undef, it returns the default component (such as default_view, if $sub_container is 'view'). If $name is a regexp, it returns an array of matching components. Otherwise, it looks for the component with name $name.
791 =head2 get_components_types
793 =head2 get_all_components
795 Fetches all the components, in each of the sub_containers model, view and controller, and returns a readonly hash. The keys are the class names, and the values are the blessed objects. This is what is returned by $c->components.
799 Adds a component to the appropriate subcontainer. The subcontainer is guessed by the component name given.
801 =head2 find_component
803 Searches for components in all containers. If $component is the full class name, the subcontainer is guessed, and it gets the searched component in there. Otherwise, it looks for a component with that name in all subcontainers. If $component is a regexp, it calls the method below, find_component_regexp, and matches all components against that regexp.
805 =head2 find_component_regexp
807 Finds components that match a given regexp. Used internally, by find_component.
809 =head2 setup_component
813 =head2 _config_substitutions
815 This method substitutes macros found with calls to a function. There are a
816 number of default macros:
820 =item * C<__HOME__> - replaced with C<$c-E<gt>path_to('')>
822 =item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}>
824 =item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_to('foo/bar')>
826 =item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use
827 C<__DATA__> as a config value, for example)
831 The parameter list is split on comma (C<,>). You can override this method to
832 do your own string munging, or you can define your own macros in
833 C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
836 MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
837 baz => sub { my $c = shift; qux( @_ ); }
840 The above will respond to C<__baz(x,y)__> in config strings.
842 =head2 $c->expand_component_module( $component, $setup_component_config )
844 Components found by C<locate_components> will be passed to this method, which
845 is expected to return a list of component (package) names to be set up.
847 =head2 build_locate_components_service
849 This method is meant to provide a list of component modules that should be
850 setup for the application. By default, it will use L<Module::Pluggable>.
852 Specify a C<setup_components> config option to pass additional options directly
853 to L<Module::Pluggable>.
857 Catalyst Contributors, see Catalyst.pm
861 This library is free software. You can redistribute it and/or modify it under
862 the same terms as Perl itself.