1 package Catalyst::Plugin::ConfigLoader;
\r
7 use Module::Pluggable::Fast
\r
8 name => '_config_loaders',
\r
9 search => [ __PACKAGE__ ],
\r
11 use Data::Visitor::Callback;
\r
13 our $VERSION = '0.1';
\r
17 Catalyst::Plugin::ConfigLoader - Load config files of various types
\r
23 # ConfigLoader should be first in your list so
\r
24 # other plugins can get the config information
\r
25 use Catalyst qw( ConfigLoader ... );
\r
27 # by default myapp.* will be loaded
\r
28 # you can specify a file if you'd like
\r
29 __PACKAGE__->config( file => 'config.yaml' );
\r
33 This module will attempt to load find and load a configuration
\r
34 file of various types. Currently it supports YAML, JSON, XML,
\r
35 INI and Perl formats.
\r
37 To support the distinction between development and production environments,
\r
38 this module will also attemp to load a local config (e.g. myapp_local.yaml)
\r
39 which will override any duplicate settings.
\r
45 This method is automatically called by Catalyst's setup routine. It will
\r
46 attempt to use each plugin and, once a file has been successfully
\r
47 loaded, set the C<config()> section.
\r
53 my( $path, $extension ) = $c->get_config_path;
\r
55 for my $loader ( $c->_config_loaders ) {
\r
57 my @extensions = $loader->extensions;
\r
59 next unless grep { $_ eq $extension } @extensions;
\r
63 @files = map { ( "$path.$_", "${path}_local.$_" ) } @extensions;
\r
68 my $config = $loader->load( $_ );
\r
70 $c->log->debug( "Loaded Config $_" ) if $c->debug;
\r
74 _fix_syntax( $config );
\r
76 $c->config( $config );
\r
80 $c->finalize_config;
\r
82 $c->NEXT::setup( @_ );
\r
85 =head2 finalize_config
\r
87 This method is called after the config file is loaded. It can be
\r
88 used to implement tuning of config values that can only be done
\r
89 at runtime. If you need to do this to properly configure any
\r
90 plugins, it's important to load ConfigLoader before them.
\r
91 ConfigLoader provides a default finalize_config method which
\r
92 walks through the loaded config hash and replaces any strings
\r
93 beginning containing C<__HOME__> with the full path to
\r
94 app's home directory (i.e. C<$c-E<gt>path_to('')> ).
\r
95 You can also use C<__path_to('foo/bar')__> which translates to
\r
96 C<$c-E<gt>path_to('foo', 'bar')>
\r
100 sub finalize_config {
\r
102 my $v = Data::Visitor::Callback->new(
\r
103 plain_value => sub {
\r
104 return unless defined $_;
\r
105 s[__HOME__][ $c->path_to( '' ) ]e;
\r
106 s[__path_to\((.+)\)__][ $c->path_to( split( '/', $1 ) ) ]e;
\r
109 $v->visit( $c->config );
\r
112 =head2 get_config_path
\r
114 This method determines the path, filename prefix and file extension to be used
\r
115 for config loading. It returns the path (up to the filename less the
\r
116 extension) to check and the specific extension to use (if it was specified).
\r
118 The order of preference is specified as:
\r
122 =item * C<$ENV{ MYAPP_CONFIG }>
\r
124 =item * C<$c->config->{ file }>
\r
126 =item * C<$c->path_to( $application_prefix )>
\r
130 If either of the first two user-specified options are directories, the
\r
131 application prefix will be added on to the end of the path.
\r
135 sub get_config_path {
\r
137 my $appname = ref $c || $c;
\r
138 my $prefix = Catalyst::Utils::appprefix( $appname );
\r
139 my $path = $ENV{ Catalyst::Utils::class2env( $appname ) . '_CONFIG' }
\r
140 || $c->config->{ file }
\r
141 || $c->path_to( $prefix );
\r
143 my( $extension ) = ( $path =~ /\.(.{1,4})$/ );
\r
146 $path =~ s/[\/\\]$//;
\r
147 $path .= "/$prefix";
\r
150 return( $path, $extension );
\r
154 my $config = shift;
\r
157 prefix => $_ eq 'Component' ? '' : $_ . '::',
\r
158 values => delete $config->{ lc $_ } || delete $config->{ $_ }
\r
161 ref $config->{ lc $_ } || ref $config->{ $_ }
\r
163 qw( Component Model M View V Controller C )
\r
166 foreach my $comp ( @components ) {
\r
167 my $prefix = $comp->{ prefix };
\r
168 foreach my $element ( keys %{ $comp->{ values } } ) {
\r
169 $config->{ "$prefix$element" } = $comp->{ values }->{ $element };
\r
178 =item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>
\r
182 =head1 CONTRIBUTORS
\r
184 The following people have generously donated their time to the
\r
185 development of this module:
\r
189 =item * David Kamholz E<lt>dkamholz@cpan.orgE<gt>
\r
193 =head1 COPYRIGHT AND LICENSE
\r
195 Copyright 2006 by Brian Cassidy
\r
197 This library is free software; you can redistribute it and/or modify
\r
198 it under the same terms as Perl itself.
\r
204 =item * L<Catalyst>
\r