1 package Catalyst::Plugin::ConfigLoader;
\r
7 use Module::Pluggable::Object ();
\r
8 use Data::Visitor::Callback;
\r
10 our $VERSION = '0.12';
\r
14 Catalyst::Plugin::ConfigLoader - Load config files of various types
\r
20 # ConfigLoader should be first in your list so
\r
21 # other plugins can get the config information
\r
22 use Catalyst qw( ConfigLoader ... );
\r
24 # by default myapp.* will be loaded
\r
25 # you can specify a file if you'd like
\r
26 __PACKAGE__->config( file => 'config.yaml' );
\r
30 This module will attempt to load find and load a configuration
\r
31 file of various types. Currently it supports YAML, JSON, XML,
\r
32 INI and Perl formats.
\r
34 To support the distinction between development and production environments,
\r
35 this module will also attemp to load a local config (e.g. myapp_local.yaml)
\r
36 which will override any duplicate settings.
\r
42 This method is automatically called by Catalyst's setup routine. It will
\r
43 attempt to use each plugin and, once a file has been successfully
\r
44 loaded, set the C<config()> section.
\r
50 my( $path, $extension ) = $c->get_config_path;
\r
51 my $suffix = $c->get_config_local_suffix;
\r
53 my $finder = Module::Pluggable::Object->new(
\r
54 search_path => [ __PACKAGE__ ],
\r
58 for my $loader ( $finder->plugins ) {
\r
60 my @extensions = $loader->extensions;
\r
62 next unless grep { $_ eq $extension } @extensions;
\r
66 @files = map { ( "$path.$_", "${path}_${suffix}.$_" ) } @extensions;
\r
71 my $config = $loader->load( $_ );
\r
73 $c->log->debug( qq(Loaded Config "$_") ) if $c->debug;
\r
77 _fix_syntax( $config );
\r
79 $c->config( $config );
\r
83 $c->finalize_config;
\r
85 $c->NEXT::setup( @_ );
\r
88 =head2 finalize_config
\r
90 This method is called after the config file is loaded. It can be
\r
91 used to implement tuning of config values that can only be done
\r
92 at runtime. If you need to do this to properly configure any
\r
93 plugins, it's important to load ConfigLoader before them.
\r
94 ConfigLoader provides a default finalize_config method which
\r
95 walks through the loaded config hash and replaces any strings
\r
96 beginning containing C<__HOME__> with the full path to
\r
97 app's home directory (i.e. C<$c-E<gt>path_to('')> ).
\r
98 You can also use C<__path_to(foo/bar)__> which translates to
\r
99 C<$c-E<gt>path_to('foo', 'bar')>
\r
103 sub finalize_config {
\r
105 my $v = Data::Visitor::Callback->new(
\r
106 plain_value => sub {
\r
107 return unless defined $_;
\r
108 s{__HOME__}{ $c->path_to( '' ) }e;
\r
109 s{__path_to\((.+)\)__}{ $c->path_to( split( '/', $1 ) ) }e;
\r
112 $v->visit( $c->config );
\r
115 =head2 get_config_path
\r
117 This method determines the path, filename prefix and file extension to be used
\r
118 for config loading. It returns the path (up to the filename less the
\r
119 extension) to check and the specific extension to use (if it was specified).
\r
121 The order of preference is specified as:
\r
125 =item * C<$ENV{ MYAPP_CONFIG }>
\r
127 =item * C<$c-E<gt>config-E<gt>{ file }>
\r
129 =item * C<$c-E<gt>path_to( $application_prefix )>
\r
133 If either of the first two user-specified options are directories, the
\r
134 application prefix will be added on to the end of the path.
\r
138 sub get_config_path {
\r
140 my $appname = ref $c || $c;
\r
141 my $prefix = Catalyst::Utils::appprefix( $appname );
\r
142 my $path = $ENV{ Catalyst::Utils::class2env( $appname ) . '_CONFIG' }
\r
143 || $c->config->{ file }
\r
144 || $c->path_to( $prefix );
\r
146 my( $extension ) = ( $path =~ m{\.(.{1,4})$} );
\r
149 $path =~ s{[\/\\]$}{};
\r
150 $path .= "/$prefix";
\r
153 return( $path, $extension );
\r
156 =head2 get_config_local_suffix
\r
158 Determines the suffix of files used to override the main config. By default
\r
159 this value is C<local>, but it can be specified in the following order of preference:
\r
163 =item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
\r
165 =item * C<$ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }>
\r
167 =item * C<$c-E<gt>config-E<gt>{ config_local_suffix }>
\r
174 sub get_config_local_suffix {
\r
176 my $appname = ref $c || $c;
\r
177 my $suffix = $ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }
\r
178 || $ENV{ Catalyst::Utils::class2env( $appname ) . '_CONFIG_LOCAL_SUFFIX' }
\r
179 || $c->config->{ config_local_suffix }
\r
186 my $config = shift;
\r
189 prefix => $_ eq 'Component' ? '' : $_ . '::',
\r
190 values => delete $config->{ lc $_ } || delete $config->{ $_ }
\r
193 ref $config->{ lc $_ } || ref $config->{ $_ }
\r
195 qw( Component Model M View V Controller C )
\r
198 foreach my $comp ( @components ) {
\r
199 my $prefix = $comp->{ prefix };
\r
200 foreach my $element ( keys %{ $comp->{ values } } ) {
\r
201 $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
\r
210 =item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>
\r
214 =head1 CONTRIBUTORS
\r
216 The following people have generously donated their time to the
\r
217 development of this module:
\r
221 =item * David Kamholz E<lt>dkamholz@cpan.orgE<gt>
\r
225 =head1 COPYRIGHT AND LICENSE
\r
227 Copyright 2006 by Brian Cassidy
\r
229 This library is free software; you can redistribute it and/or modify
\r
230 it under the same terms as Perl itself.
\r
236 =item * L<Catalyst>
\r