1 package Collectd::Graph::Config;
5 Collectd::Graph::Config - Parse the collection3 config file.
9 # Copyright (C) 2008 Florian octo Forster <octo at verplant.org>
11 # This program is free software; you can redistribute it and/or modify it under
12 # the terms of the GNU General Public License as published by the Free Software
13 # Foundation; only version 2 of the License is applicable.
15 # This program is distributed in the hope that it will be useful, but WITHOUT
16 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 # You should have received a copy of the GNU General Public License along with
21 # this program; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 use Carp (qw(cluck confess));
29 use Config::General ('ParseConfig');
30 use Collectd::Graph::Type ();
32 @Collectd::Graph::Config::ISA = ('Exporter');
33 @Collectd::Graph::Config::EXPORT_OK = (qw(gc_read_config gc_get_config
36 our $Configuration = undef;
40 =head1 EXPORTED FUNCTIONS
44 =item B<gc_read_config> (I<$file>)
46 Reads the configuration from the file located at I<$file>. Returns B<true> when
47 successfull and B<false> otherwise.
61 $file ||= "etc/collection.conf";
63 %conf = ParseConfig (-ConfigFile => $file,
65 -UseApacheInclude => 1,
66 -IncludeDirectories => 1,
67 ($Config::General::VERSION >= 2.38) ? (-IncludeAgain => 0) : (),
68 -MergeDuplicateBlocks => 1,
75 $Configuration = \%conf;
79 =item B<gc_get_config> ()
81 Returns the hash as provided by L<Config::General>. The hash is returned as a
82 hash reference. Don't change it!
88 return ($Configuration);
91 =item B<gc_get_config> (I<$key>, [I<$default>])
93 Returns the scalar value I<$key> from the config file. If the key does not
94 exist, I<$default> will be returned. If no default is given, B<undef> will be
102 my $default = (@_ != 0) ? shift : undef;
110 $value = $Configuration->{lc ($key)};
111 if (!defined ($value))
116 if (ref ($value) ne '')
118 cluck ("Value for `$key' should be scalar, but actually is "
134 L<Collectd::Graph::Type>
136 =head1 AUTHOR AND LICENSE
138 Copyright (c) 2008 by Florian Forster
139 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>. Licensed under the terms of the GNU
140 General Public License, VersionE<nbsp>2 (GPLv2).
144 # vim: set shiftwidth=2 softtabstop=2 tabstop=8 et fdm=marker :