1 package Catalyst::Plugin::ConfigLoader;
8 use Data::Visitor::Callback;
9 use Catalyst::Utils ();
11 our $VERSION = '0.19';
15 Catalyst::Plugin::ConfigLoader - Load config files of various types
21 # ConfigLoader should be first in your list so
22 # other plugins can get the config information
23 use Catalyst qw( ConfigLoader ... );
25 # by default myapp.* will be loaded
26 # you can specify a file if you'd like
27 __PACKAGE__->config( 'Plugin::ConfigLoader' => { file => 'config.yaml' } );
31 This module will attempt to load find and load a configuration
32 file of various types. Currently it supports YAML, JSON, XML,
33 INI and Perl formats. Special configuration for a particular driver format can
34 be stored in C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ driver }>.
36 To support the distinction between development and production environments,
37 this module will also attemp to load a local config (e.g. myapp_local.yaml)
38 which will override any duplicate settings.
44 This method is automatically called by Catalyst's setup routine. It will
45 attempt to use each plugin and, once a file has been successfully
46 loaded, set the C<config()> section.
52 my @files = $c->find_files;
53 my $cfg = Config::Any->load_files(
55 filter => \&_fix_syntax,
57 driver_args => $c->config->{ 'Plugin::ConfigLoader' }->{ driver }
62 # split the responses into normal and local cfg
63 my $local_suffix = $c->get_config_local_suffix;
64 my ( @cfg, @localcfg );
66 if ( ( keys %$_ )[ 0 ] =~ m{ $local_suffix \. }xms ) {
74 # load all the normal cfgs, then the local cfgs last so they can override
76 $c->load_config( $_ ) for @cfg, @localcfg;
79 $c->NEXT::setup( @_ );
84 This method handles loading the configuration data into the Catalyst
85 context object. It does not return a value.
93 my ( $file, $config ) = %$ref;
95 $c->config( $config );
96 $c->log->debug( qq(Loaded Config "$file") )
104 This method determines the potential file paths to be used for config loading.
105 It returns an array of paths (up to the filename less the extension) to pass to
106 L<Config::Any|Config::Any> for loading.
112 my ( $path, $extension ) = $c->get_config_path;
113 my $suffix = $c->get_config_local_suffix;
114 my @extensions = @{ Config::Any->extensions };
118 next unless grep { $_ eq $extension } @extensions;
119 ( my $local = $path ) =~ s{\.$extension}{_$suffix.$extension};
120 push @files, $path, $local;
123 @files = map { ( "$path.$_", "${path}_${suffix}.$_" ) } @extensions;
129 =head2 get_config_path
131 This method determines the path, filename prefix and file extension to be used
132 for config loading. It returns the path (up to the filename less the
133 extension) to check and the specific extension to use (if it was specified).
135 The order of preference is specified as:
139 =item * C<$ENV{ MYAPP_CONFIG }>
141 =item * C<$ENV{ CATALYST_CONFIG }>
143 =item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ file }>
145 =item * C<$c-E<gt>path_to( $application_prefix )>
149 If either of the first two user-specified options are directories, the
150 application prefix will be added on to the end of the path.
152 DEPRECATION NOTICE: C<$c-E<gt>config-E<gt>{ file }> is deprecated
153 and will be removed in the next release.
157 sub get_config_path {
161 if ( exists $c->config->{ file } ) {
163 q(*** "file" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ file }")
168 my $appname = ref $c || $c;
169 my $prefix = Catalyst::Utils::appprefix( $appname );
170 my $path = Catalyst::Utils::env_value( $c, 'CONFIG' )
171 || $c->config->{ 'Plugin::ConfigLoader' }->{ file }
172 || $c->config->{ file } # to be removed next release
173 || $c->path_to( $prefix );
175 my ( $extension ) = ( $path =~ m{\.(.{1,4})$} );
178 $path =~ s{[\/\\]$}{};
182 return ( $path, $extension );
185 =head2 get_config_local_suffix
187 Determines the suffix of files used to override the main config. By default
188 this value is C<local>, but it can be specified in the following order of preference:
192 =item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
194 =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
196 =item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ config_local_suffix }>
200 DEPRECATION NOTICE: C<$c-E<gt>config-E<gt>{ config_local_suffix }> is deprecated
201 and will be removed in the next release.
205 sub get_config_local_suffix {
209 if ( exists $c->config->{ config_local_suffix } ) {
211 q(*** "config_local_suffix" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }")
216 my $appname = ref $c || $c;
217 my $suffix = Catalyst::Utils::env_value( $c, 'CONFIG_LOCAL_SUFFIX' )
218 || $c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }
220 ->{ config_local_suffix } # to be remove in the next release
230 prefix => $_ eq 'Component' ? '' : $_ . '::',
231 values => delete $config->{ lc $_ } || delete $config->{ $_ }
233 grep { ref $config->{ lc $_ } || ref $config->{ $_ } }
234 qw( Component Model M View V Controller C )
237 foreach my $comp ( @components ) {
238 my $prefix = $comp->{ prefix };
239 foreach my $element ( keys %{ $comp->{ values } } ) {
240 $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
245 =head2 finalize_config
247 This method is called after the config file is loaded. It can be
248 used to implement tuning of config values that can only be done
249 at runtime. If you need to do this to properly configure any
250 plugins, it's important to load ConfigLoader before them.
251 ConfigLoader provides a default finalize_config method which
252 walks through the loaded config hash and calls the C<config_substitutions>
257 sub finalize_config {
259 my $v = Data::Visitor::Callback->new(
261 return unless defined $_;
262 $c->config_substitutions( $_ );
265 $v->visit( $c->config );
268 =head2 config_substitutions( $value )
270 This method substitutes macros found with calls to a function. There are three
275 =item * C<__HOME__> - replaced with C<$c-E<gt>path_to('')>
277 =item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_to('foo/bar')>
279 =item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use
280 C<__DATA__> as a config value, for example)
284 The parameter list is split on comma (C<,>). You can override this method to
285 do your own string munging, or you can define your own macros in
286 C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
289 MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
290 baz => sub { my $c = shift; qux( @_ ); }
293 The above will respond to C<__baz(x,y)__> in config strings.
297 sub config_substitutions {
299 my $subs = $c->config->{ 'Plugin::ConfigLoader' }->{ substitutions }
301 $subs->{ HOME } ||= sub { shift->path_to( '' ); };
302 $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
303 $subs->{ literal } ||= sub { return $_[ 1 ]; };
304 my $subsre = join( '|', keys %$subs );
307 s{__($subsre)(?:\((.+?)\))?__}{ $subs->{ $1 }->( $c, $2 ? split( /,/, $2 ) : () ) }eg;
313 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
317 The following people have generously donated their time to the
318 development of this module:
322 =item * Joel Bernstein E<lt>rataxis@cpan.orgE<gt> - Rewrite to use L<Config::Any>
324 =item * David Kamholz E<lt>dkamholz@cpan.orgE<gt> - L<Data::Visitor> integration
328 Work to this module has been generously sponsored by:
332 =item * Portugal Telecom L<http://www.sapo.pt/> - Work done by Joel Bernstein
336 =head1 COPYRIGHT AND LICENSE
338 Copyright 2007 by Brian Cassidy
340 This library is free software; you can redistribute it and/or modify
341 it under the same terms as Perl itself.
349 =item * L<Catalyst::Plugin::ConfigLoader::Manual>
351 =item * L<Config::Any>