1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
package ConfigReader::Simple;
#
# Simple interface to a configuration file
#
# ObLegalStuff:
# Copyright (c) 1998 Bek Oberin. All rights reserved. This program is
# free software; you can redistribute it and/or modify it under the
# same terms as Perl itself.
#
# Last updated by gossamer on Thu Sep 3 22:01:47 EST 1998
#
use strict;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
require Exporter;
@ISA = qw(Exporter);
@EXPORT = qw();
@EXPORT_OK = qw();
$VERSION = "0.5";
my $DEBUG = 0;
=head1 NAME
ConfigReader::Simple - Simple configuration file parser
=head1 SYNOPSIS
use ConfigReader::Simple;
$config = ConfigReader::Simple->new("configrc", [qw(Foo Bar Baz Quux)]);
$config->parse();
=head1 DESCRIPTION
C<ConfigReader::Simple> reads and parses simple configuration files. It's
designed to be smaller and simpler than the C<ConfigReader> module
and is more suited to simple configuration files.
=cut
###################################################################
# Functions under here are member functions #
###################################################################
=head1 CONSTRUCTOR
=item new ( FILENAME, DIRECTIVES )
This is the constructor for a new ConfigReader::Simple object.
C<FILENAME> tells the instance where to look for the configuration
file.
C<DIRECTIVES> is a reference to an array. Each member of the array
should contain one valid directive.
=cut
sub new {
my $prototype = shift;
my $filename = shift;
my $keyref = shift;
my $class = ref($prototype) || $prototype;
my $self = {};
$self->{"filename"} = $filename;
$self->{"validkeys"} = $keyref;
bless($self, $class);
return $self;
}
#
# destructor
#
sub DESTROY {
my $self = shift;
return 1;
}
=pod
=item parse ()
This does the actual work. No parameters needed.
=cut
sub parse {
my $self = shift;
open(CONFIG, $self->{"filename"}) ||
die "Config: Can't open config file " . $self->{"filename"} . ": $!";
while (<CONFIG>) {
chomp;
next if /^\s*$/; # blank
next if /^\s*#/; # comment
my ($key, $value) = &parse_line($_);
print STDERR "Key: '$key' Value: '$value'\n" if $DEBUG;
if (&is_arraymember($key, $self->{"validkeys"})) {
$self->{"config_data"}{$key} = $value;
} else {
die "Config: Invalid key '$key'\n";
}
}
close(CONFIG);
return 1;
}
=pod
=item get ( DIRECTIVE )
Returns the parsed value for that directive.
=cut
sub get {
my $self = shift;
my $key = shift;
return $self->{"config_data"}{$key};
}
sub parse_line {
my $text = shift;
my ($key, $value);
if ($text =~ /^\s*(\w+)\s+(['"]?)(.*?)\2\s*$/) {
$key = $1;
$value = $3;
} else {
die "Config: Can't parse line: $text\n";
}
return ($key, $value);
}
sub is_arraymember {
my $value = shift;
my $arrayref = shift;
foreach (@$arrayref) {
return 1 if $_ eq $value;
}
return 0;
}
=pod
=head1 LIMITATIONS/BUGS
Directives are case-sensitive.
If a directive is repeated, the first instance will silently be
ignored.
Always die()s on errors instead of reporting them.
C<get()> doesn't warn if used before C<parse()>.
C<get()> doesn't warn if you try to acces the value of an
unknown directive not know (ie: one that wasn't passed via C<new()>).
All these will be addressed in future releases.
=head1 AUTHOR
Bek Oberin <gossamer@tertius.net.au>
=head1 COPYRIGHT
Copyright (c) 1998 Bek Oberin. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
#
# End code.
#
1;
|
