summaryrefslogtreecommitdiffstats
path: root/lib/Nagios/Plugin/Config.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Nagios/Plugin/Config.pm')
-rw-r--r--lib/Nagios/Plugin/Config.pm174
1 files changed, 0 insertions, 174 deletions
diff --git a/lib/Nagios/Plugin/Config.pm b/lib/Nagios/Plugin/Config.pm
deleted file mode 100644
index dd270e9..0000000
--- a/lib/Nagios/Plugin/Config.pm
+++ /dev/null
@@ -1,174 +0,0 @@
1package Nagios::Plugin::Config;
2
3use strict;
4use Carp;
5use File::Spec;
6use base qw(Config::Tiny);
7
8my $FILENAME1 = 'plugins.ini';
9my $FILENAME2 = 'nagios-plugins.ini';
10my $CURRENT_FILE = undef;
11
12# Config paths ending in nagios (search for $FILENAME1)
13my @NAGIOS_CONFIG_PATH = qw(/etc/nagios /usr/local/nagios/etc /usr/local/etc/nagios /etc/opt/nagios);
14# Config paths not ending in nagios (search for $FILENAME2)
15my @CONFIG_PATH = qw(/etc /usr/local/etc /etc/opt);
16
17# Override Config::Tiny::read to default the filename, if not given
18sub read
19{
20 my $class = shift;
21
22 unless ($_[0]) {
23 SEARCH: {
24 if ($ENV{NAGIOS_CONFIG_PATH}) {
25 for (split /:/, $ENV{NAGIOS_CONFIG_PATH}) {
26 my $file = File::Spec->catfile($_, $FILENAME1);
27 unshift(@_, $file), last SEARCH if -f $file;
28 $file = File::Spec->catfile($_, $FILENAME2);
29 unshift(@_, $file), last SEARCH if -f $file;
30 }
31 }
32 for (@NAGIOS_CONFIG_PATH) {
33 my $file = File::Spec->catfile($_, $FILENAME1);
34 unshift(@_, $file), last SEARCH if -f $file;
35 }
36 for (@CONFIG_PATH) {
37 my $file = File::Spec->catfile($_, $FILENAME2);
38 unshift(@_, $file), last SEARCH if -f $file;
39 }
40 }
41
42 # Use die instead of croak, so we can pass a clean message downstream
43 die "Cannot find '$FILENAME1' or '$FILENAME2' in any standard location.\n" unless $_[0];
44 }
45
46 $CURRENT_FILE = $_[0];
47 $class->SUPER::read( @_ );
48}
49
50# Straight from Config::Tiny - only changes are repeated property key support
51# Would be nice if we could just override the per-line handling ...
52sub read_string
53{
54 my $class = ref $_[0] ? ref shift : shift;
55 my $self = bless {}, $class;
56 return undef unless defined $_[0];
57
58 # Parse the file
59 my $ns = '_';
60 my $counter = 0;
61 foreach ( split /(?:\015{1,2}\012|\015|\012)/, shift ) {
62 $counter++;
63
64 # Skip comments and empty lines
65 next if /^\s*(?:\#|\;|$)/;
66
67 # Handle section headers
68 if ( /^\s*\[\s*(.+?)\s*\]\s*$/ ) {
69 # Create the sub-hash if it doesn't exist.
70 # Without this sections without keys will not
71 # appear at all in the completed struct.
72 $self->{$ns = $1} ||= {};
73 next;
74 }
75
76 # Handle properties
77 if ( /^\s*([^=]+?)\s*=\s*(.*?)\s*$/ ) {
78 push @{$self->{$ns}->{$1}}, $2;
79 next;
80 }
81
82 return $self->_error( "Syntax error at line $counter: '$_'" );
83 }
84
85 $self;
86}
87
88sub write { croak "Write access not permitted" }
89
90# Return last file used by read();
91sub np_getfile { return $CURRENT_FILE; }
92
931;
94
95=head1 NAME
96
97Nagios::Plugin::Config - read nagios plugin .ini style config files
98
99=head1 SYNOPSIS
100
101 # Read given nagios plugin config file
102 $Config = Nagios::Plugin::Config->read( '/etc/nagios/plugins.ini' );
103
104 # Search for and read default nagios plugin config file
105 $Config = Nagios::Plugin::Config->read();
106
107 # Access sections and properties (returns scalars or arrayrefs)
108 $rootproperty = $Config->{_}->{rootproperty};
109 $one = $Config->{section}->{one};
110 $Foo = $Config->{section}->{Foo};
111
112=head1 DESCRIPTION
113
114Nagios::Plugin::Config is a subclass of the excellent Config::Tiny,
115with the following changes:
116
117=over 4
118
119=item
120
121Repeated keys are allowed within sections, returning lists instead of scalars
122
123=item
124
125Write functionality has been removed i.e. access is read only
126
127=item
128
129Nagios::Plugin::Config searches for a default nagios plugins file if no explicit
130filename is given to C<read()>. The current standard locations checked are:
131
132=over 4
133
134=item /etc/nagios/plugins.ini
135
136=item /usr/local/nagios/etc/plugins.ini
137
138=item /usr/local/etc/nagios /etc/opt/nagios/plugins.ini
139
140=item /etc/nagios-plugins.ini
141
142=item /usr/local/etc/nagios-plugins.ini
143
144=item /etc/opt/nagios-plugins.ini
145
146=back
147
148To use a custom location, set a C<NAGIOS_CONFIG_PATH> environment variable
149to the set of directories that should be checked. The first C<plugins.ini> or
150C<nagios-plugins.ini> file found will be used.
151
152=back
153
154
155=head1 SEE ALSO
156
157L<Config::Tiny>, L<Nagios::Plugin>
158
159
160=head1 AUTHORS
161
162This code is maintained by the Nagios Plugin Development Team:
163L<http://nagiosplug.sourceforge.net>.
164
165
166=head1 COPYRIGHT and LICENCE
167
168Copyright (C) 2006-2007 by Nagios Plugin Development Team
169
170This library is free software; you can redistribute it and/or modify
171it under the same terms as Perl itself.
172
173=cut
174