7 use Module::Pluggable::Object ();
13 Config::Any - Load configuration from different file formats, transparently
19 my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
21 my $cfg = Config::Any->load_files({files => \@filepaths, ... });
24 my ($filename, $config) = %$_;
25 $class->config($config);
26 warn "loaded config from file: $filename";
31 L<Config::Any|Config::Any> provides a facility for Perl applications and libraries
32 to load configuration data from multiple different file formats. It supports XML, YAML,
33 JSON, Apache-style configuration, Windows INI files, and even Perl code.
35 The rationale for this module is as follows: Perl programs are deployed on many different
36 platforms and integrated with many different systems. Systems administrators and end
37 users may prefer different configuration formats than the developers. The flexibility
38 inherent in a multiple format configuration loader allows different users to make
39 different choices, without generating extra work for the developers. As a developer
40 you only need to learn a single interface to be able to use the power of different
41 configuration formats.
47 =head2 load_files( \%args )
49 Config::Any->load_files( { files => \@files } );
50 Config::Any->load_files( { files => \@files, filter => \&filter } );
51 Config::Any->load_files( { files => \@files, use_ext => 1 } );
52 Config::Any->load_files( { files => \@files, flatten_to_hash => 1 } );
54 C<load_files()> attempts to load configuration from the list of files passed in
55 the C<files> parameter, if the file exists.
57 If the C<filter> parameter is set, it is used as a callback to modify the configuration
58 data before it is returned. It will be passed a single hash-reference parameter which
59 it should modify in-place.
61 If the C<use_ext> parameter is defined, the loader will attempt to parse the file
62 extension from each filename and will skip the file unless it matches a standard
63 extension for the loading plugins. Only plugins whose standard extensions match the
64 file extension will be used. For efficiency reasons, its use is encouraged, but
65 be aware that you will lose flexibility -- for example, a file called C<myapp.cfg>
66 containing YAML data will not be offered to the YAML plugin, whereas C<myapp.yml>
67 or C<myapp.yaml> would be.
69 When the C<flatten_to_hash> parameter is defined, the loader will return a hash
70 keyed on the file names, as opposed to the usual list of single-key hashes.
72 C<load_files()> also supports a 'force_plugins' parameter, whose value should be an
73 arrayref of plugin names like C<Config::Any::INI>. Its intended use is to allow the use
74 of a non-standard file extension while forcing it to be offered to a particular parser.
75 It is not compatible with 'use_ext'.
77 You can supply a C<driver_args> hashref to pass special options to a particular
78 parser object. Example:
80 Config::Any->load_files( { files => \@files, driver_args => {
81 General => { -LowerCaseNames => 1 }
87 my ( $class, $args ) = @_;
89 unless ( $args && exists $args->{ files } ) {
90 warn "No files specified!";
94 return $class->_load( $args );
97 =head2 load_stems( \%args )
99 Config::Any->load_stems( { stems => \@stems } );
100 Config::Any->load_stems( { stems => \@stems, filter => \&filter } );
101 Config::Any->load_stems( { stems => \@stems, use_ext => 1 } );
102 Config::Any->load_stems( { stems => \@stems, flatten_to_hash => 1 } );
104 C<load_stems()> attempts to load configuration from a list of files which it generates
105 by combining the filename stems list passed in the C<stems> parameter with the
106 potential filename extensions from each loader, which you can check with the
107 C<extensions()> classmethod described below. Once this list of possible filenames is
108 built it is treated exactly as in C<load_files()> above, as which it takes the same
109 parameters. Please read the C<load_files()> documentation before using this method.
114 my ( $class, $args ) = @_;
116 unless ( $args && exists $args->{ stems } ) {
117 warn "No stems specified!";
121 my $stems = delete $args->{ stems };
123 for my $s ( @$stems ) {
124 for my $ext ( $class->extensions ) {
125 push @files, "$s.$ext";
129 $args->{ files } = \@files;
130 return $class->_load( $args );
134 my ( $class, $args ) = @_;
135 croak "_load requires a arrayref of file paths" unless $args->{ files };
137 my $force = defined $args->{ force_plugins };
138 if ( !$force and !defined $args->{ use_ext } ) {
140 "use_ext argument was not explicitly set, as of 0.09, this is true by default";
141 $args->{ use_ext } = 1;
144 # figure out what plugins we're using
146 ? map { eval "require $_;"; $_; } @{ $args->{ force_plugins } }
149 # map extensions if we have to
150 my ( %extension_lut, $extension_re );
151 my $use_ext_lut = !$force && $args->{ use_ext };
152 if ( $use_ext_lut ) {
153 for my $plugin ( @plugins ) {
154 for ( $plugin->extensions ) {
155 $extension_lut{ $_ } ||= [];
156 push @{ $extension_lut{ $_ } }, $plugin;
160 $extension_re = join( '|', keys %extension_lut );
163 # map args to plugins
164 my $base_class = __PACKAGE__;
166 for my $plugin ( @plugins ) {
167 $plugin =~ m{^$base_class\::(.+)};
168 $loader_args{ $plugin } = $args->{ driver_args }->{ $1 } || {};
173 for my $filename ( @{ $args->{ files } } ) {
175 # don't even bother if it's not there
176 next unless -f $filename;
178 my @try_plugins = @plugins;
180 if ( $use_ext_lut ) {
181 $filename =~ m{\.($extension_re)\z};
184 $filename =~ m{\.([^.]+)\z};
185 croak "There are no loaders available for .${1} files";
188 @try_plugins = @{ $extension_lut{ $1 } };
191 # not using use_ext means we try all plugins anyway, so we'll
192 # ignore it for the "unsupported" error
193 my $supported = $use_ext_lut ? 0 : 1;
194 for my $loader ( @try_plugins ) {
195 next unless $loader->is_supported;
198 = eval { $loader->load( $filename, $loader_args{ $loader } ); };
200 # fatal error if we used extension matching
201 croak "Error parsing $filename: $@" if $@ and $use_ext_lut;
202 next if $@ or !@configs;
204 # post-process config with a filter callback
205 if ( $args->{ filter } ) {
206 $args->{ filter }->( $_ ) for @configs;
210 { $filename => @configs == 1 ? $configs[ 0 ] : \@configs };
216 "Cannot load $filename: required support modules are not available.\nPlease install "
217 . join( " OR ", map { _support_error( $_ ) } @try_plugins );
221 if ( defined $args->{ flatten_to_hash } ) {
222 my %flattened = map { %$_ } @results;
231 if ( $module->can( 'requires_all_of' ) ) {
232 return join( ' and ',
233 map { ref $_ ? join( ' ', @$_ ) : $_ } $module->requires_all_of );
235 if ( $module->can( 'requires_any_of' ) ) {
238 map { ref $_ ? join( ' ', @$_ ) : $_ } $module->requires_any_of );
244 The C<finder()> classmethod returns the
245 L<Module::Pluggable::Object|Module::Pluggable::Object>
246 object which is used to load the plugins. See the documentation for that module for
253 my $finder = Module::Pluggable::Object->new(
254 search_path => [ __PACKAGE__ ],
255 except => [ __PACKAGE__ . '::Base' ],
263 The C<plugins()> classmethod returns the names of configuration loading plugins as
264 found by L<Module::Pluggable::Object|Module::Pluggable::Object>.
271 # filter out things that don't look like our plugins
272 return grep { $_->isa( 'Config::Any::Base' ) } $class->finder->plugins;
277 The C<extensions()> classmethod returns the possible file extensions which can be loaded
278 by C<load_stems()> and C<load_files()>. This may be useful if you set the C<use_ext>
279 parameter to those methods.
286 = map { $_->extensions } $class->plugins;
287 return wantarray ? @ext : \@ext;
294 =item C<No files specified!> or C<No stems specified!>
296 The C<load_files()> and C<load_stems()> methods will issue this warning if
297 called with an empty list of files/stems to load.
299 =item C<_load requires a arrayref of file paths>
301 This fatal error will be thrown by the internal C<_load> method. It should not occur
302 but is specified here for completeness. If your code dies with this error, please
303 email a failing test case to the authors below.
307 =head1 CONFIGURATION AND ENVIRONMENT
309 Config::Any requires no configuration files or environment variables.
313 L<Module::Pluggable|Module::Pluggable>
315 And at least one of the following:
316 L<Config::General|Config::General>
317 L<Config::Tiny|Config::Tiny>
320 L<JSON::Syck|JSON::Syck>
321 L<YAML::Syck|YAML::Syck>
322 L<XML::Simple|XML::Simple>
324 =head1 INCOMPATIBILITIES
328 =head1 BUGS AND LIMITATIONS
330 No bugs have been reported.
332 Please report any bugs or feature requests to
333 C<bug-config-any@rt.cpan.org>, or through the web interface at
334 L<http://rt.cpan.org>.
338 Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
342 This module was based on the original
343 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
344 module by Brian Cassidy C<< <bricas@cpan.org> >>.
346 With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
348 Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
350 =head1 LICENCE AND COPYRIGHT
352 Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
353 Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
355 This module is free software; you can redistribute it and/or
356 modify it under the same terms as Perl itself. See L<perlartistic>.
358 =head1 DISCLAIMER OF WARRANTY
360 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
361 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
362 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
363 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
364 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
365 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
366 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
367 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
368 NECESSARY SERVICING, REPAIR, OR CORRECTION.
370 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
371 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
372 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
373 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
374 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
375 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
376 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
377 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
378 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
383 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
384 -- now a wrapper around this module.