1 package Catalyst::Plugin::ConfigLoader;
8 use Data::Visitor::Callback;
9 use Catalyst::Utils ();
11 our $VERSION = '0.24';
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' } );
29 In the file, assuming it's in YAML format:
33 Accessible through the context object, or the class itself
35 $c->config->{foo} # bar
36 MyApp->config->{foo} # bar
40 This module will attempt to load find and load a configuration
41 file of various types. Currently it supports YAML, JSON, XML,
42 INI and Perl formats. Special configuration for a particular driver format can
43 be stored in C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ driver }>.
44 For example, to pass arguments to L<Config::General>, use the following:
46 __PACKAGE__->config( 'Plugin::ConfigLoader' => {
48 'General' => { -LowerCaseNames => 1 }
52 See L<Config::Any>'s C<driver_args> parameter for more information.
54 To support the distinction between development and production environments,
55 this module will also attemp to load a local config (e.g. myapp_local.yaml)
56 which will override any duplicate settings. See
57 L<get_config_local_suffix|/get_config_local_suffix>
58 for details on how this is configured.
64 This method is automatically called by Catalyst's setup routine. It will
65 attempt to use each plugin and, once a file has been successfully
66 loaded, set the C<config()> section.
72 my @files = $c->find_files;
73 my $cfg = Config::Any->load_files(
75 filter => \&_fix_syntax,
77 driver_args => $c->config->{ 'Plugin::ConfigLoader' }->{ driver }
81 # map the array of hashrefs to a simple hash
82 my %configs = map { %$_ } @$cfg;
84 # split the responses into normal and local cfg
85 my $local_suffix = $c->get_config_local_suffix;
86 my ( @main, @locals );
87 for ( sort keys %configs ) {
88 if ( m{$local_suffix\.}ms ) {
96 # load all the normal cfgs, then the local cfgs last so they can override
98 $c->load_config( { $_ => $configs{ $_ } } ) for @main, @locals;
101 $c->next::method( @_ );
106 This method handles loading the configuration data into the Catalyst
107 context object. It does not return a value.
115 my ( $file, $config ) = %$ref;
117 $c->config( $config );
118 $c->log->debug( qq(Loaded Config "$file") )
126 This method determines the potential file paths to be used for config loading.
127 It returns an array of paths (up to the filename less the extension) to pass to
128 L<Config::Any|Config::Any> for loading.
134 my ( $path, $extension ) = $c->get_config_path;
135 my $suffix = $c->get_config_local_suffix;
136 my @extensions = @{ Config::Any->extensions };
140 die "Unable to handle files with the extension '${extension}'"
141 unless grep { $_ eq $extension } @extensions;
142 ( my $local = $path ) =~ s{\.$extension}{_$suffix.$extension};
143 push @files, $path, $local;
146 @files = map { ( "$path.$_", "${path}_${suffix}.$_" ) } @extensions;
151 =head2 get_config_path
153 This method determines the path, filename prefix and file extension to be used
154 for config loading. It returns the path (up to the filename less the
155 extension) to check and the specific extension to use (if it was specified).
157 The order of preference is specified as:
161 =item * C<$ENV{ MYAPP_CONFIG }>
163 =item * C<$ENV{ CATALYST_CONFIG }>
165 =item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ file }>
167 =item * C<$c-E<gt>path_to( $application_prefix )>
171 If either of the first two user-specified options are directories, the
172 application prefix will be added on to the end of the path.
176 sub get_config_path {
180 my $appname = ref $c || $c;
181 my $prefix = Catalyst::Utils::appprefix( $appname );
182 my $path = Catalyst::Utils::env_value( $c, 'CONFIG' )
183 || $c->config->{ 'Plugin::ConfigLoader' }->{ file }
184 || $c->path_to( $prefix );
186 my ( $extension ) = ( $path =~ m{\.(.{1,4})$} );
189 $path =~ s{[\/\\]$}{};
193 return ( $path, $extension );
196 =head2 get_config_local_suffix
198 Determines the suffix of files used to override the main config. By default
199 this value is C<local>, which will load C<myapp_local.conf>. The suffix can
200 be specified in the following order of preference:
204 =item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
206 =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
208 =item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ config_local_suffix }>
212 The first one of these values found replaces the default of C<local> in the
213 name of the local config file to be loaded.
215 For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>,
216 ConfigLoader will try and load C<myapp_testing.conf> instead of
221 sub get_config_local_suffix {
224 my $appname = ref $c || $c;
225 my $suffix = Catalyst::Utils::env_value( $c, 'CONFIG_LOCAL_SUFFIX' )
226 || $c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }
236 prefix => $_ eq 'Component' ? '' : $_ . '::',
237 values => delete $config->{ lc $_ } || delete $config->{ $_ }
239 grep { ref $config->{ lc $_ } || ref $config->{ $_ } }
240 qw( Component Model M View V Controller C Plugin )
243 foreach my $comp ( @components ) {
244 my $prefix = $comp->{ prefix };
245 foreach my $element ( keys %{ $comp->{ values } } ) {
246 $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
251 =head2 finalize_config
253 This method is called after the config file is loaded. It can be
254 used to implement tuning of config values that can only be done
255 at runtime. If you need to do this to properly configure any
256 plugins, it's important to load ConfigLoader before them.
257 ConfigLoader provides a default finalize_config method which
258 walks through the loaded config hash and calls the C<config_substitutions>
263 sub finalize_config {
265 my $v = Data::Visitor::Callback->new(
267 return unless defined $_;
268 $c->config_substitutions( $_ );
271 $v->visit( $c->config );
274 =head2 config_substitutions( $value )
276 This method substitutes macros found with calls to a function. There are three
281 =item * C<__HOME__> - replaced with C<$c-E<gt>path_to('')>
283 =item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}>
285 =item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_to('foo/bar')>
287 =item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use
288 C<__DATA__> as a config value, for example)
292 The parameter list is split on comma (C<,>). You can override this method to
293 do your own string munging, or you can define your own macros in
294 C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
297 MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
298 baz => sub { my $c = shift; qux( @_ ); }
301 The above will respond to C<__baz(x,y)__> in config strings.
305 sub config_substitutions {
307 my $subs = $c->config->{ 'Plugin::ConfigLoader' }->{ substitutions }
309 $subs->{ HOME } ||= sub { shift->path_to( '' ); };
313 if (! defined($ENV{$v})) {
314 Catalyst::Exception->throw( message =>
315 "Missing environment variable: $v" );
321 $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
322 $subs->{ literal } ||= sub { return $_[ 1 ]; };
323 my $subsre = join( '|', keys %$subs );
326 s{__($subsre)(?:\((.+?)\))?__}{ $subs->{ $1 }->( $c, $2 ? split( /,/, $2 ) : () ) }eg;
332 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
336 The following people have generously donated their time to the
337 development of this module:
341 =item * Joel Bernstein E<lt>rataxis@cpan.orgE<gt> - Rewrite to use L<Config::Any>
343 =item * David Kamholz E<lt>dkamholz@cpan.orgE<gt> - L<Data::Visitor> integration
345 =item * Stuart Watt - Addition of ENV macro.
349 Work to this module has been generously sponsored by:
353 =item * Portugal Telecom L<http://www.sapo.pt/> - Work done by Joel Bernstein
357 =head1 COPYRIGHT AND LICENSE
359 Copyright 2006-2009 by Brian Cassidy
361 This library is free software; you can redistribute it and/or modify
362 it under the same terms as Perl itself.
370 =item * L<Catalyst::Plugin::ConfigLoader::Manual>
372 =item * L<Config::Any>