#!/usr/bin/perl
#
# A simple configuration file builder based on questions listed in
# it's own configuration file. It would certainly be easy to use this
# for other (non-snmp) programs as well.
#
use Getopt::Std;
use Term::ReadLine;
use IO::File;
use Data::Dumper;
# globals
%tokenitems=qw(line 1 info 1 comment 1);
%arrayitems=qw(question 1 validanswer 1);
#defaults
$opts{'c'} = "/usr/share/snmp/snmpconf";
# read the argument string
getopts("qadhfc:piI:r:R:g:G", \%opts);
# display help
if ($opts{'h'}) {
print "$0 [options] [FILETOCREATE...]\n";
print "options:\n";
print " -f overwrite existing files without prompting\n";
print " -i install created files into /usr/share/snmp.\n";
print " -p install created files into $ENV{HOME}/.snmp.\n";
print " -I DIR install created files into DIR.\n";
print " -a Don't ask any questions, just read in current\n";
print " current .conf files and comment them\n";
print " -r all|none Read in all or none of the .conf files found.\n";
print " -R file,... Read in a particular list of .conf files.\n";
print " -g GROUP Ask a series of GROUPed questions.\n";
print " -G List known GROUPs.\n";
print " -c conf_dir use alternate configuration directory.\n";
print " -q run more quietly with less advice.\n";
print " -d turn on debugging output.\n";
print " -D turn on debugging dumper output.\n";
exit;
}
# setup terminal interface.
$term = new Term::ReadLine 'snmpconf';
# read in configuration file set
read_config_files($opts{'c'}, \%filetypes);
debug(my_Dumper(\%filetypes));
if ($opts{'G'}) {
Print("\nKnown GROUPs of tokens:\n\n");
foreach my $group (keys(%groups)) {
print " $group\n";
}
Print("\n");
exit;
}
#
# Find existing files to possibly read in.
#
my @searchpath = (qw(/usr/share/snmp /etc/snmp .), "$ENV{HOME}/.snmp");
push @searchpath, $opts{I} if ($opts{I});
foreach my $i (@searchpath) {
debug("searching $i\n");
foreach my $ft (keys(%filetypes)) {
debug("searching for $i/$ft\n");
$knownfiles{"$i/$ft"} = $ft if (-f "$i/$ft");
my $localft = $ft;
$localft =~ s/.conf/.local.conf/;
$knownfiles{"$i/$localft"} = $ft if (-f "$i/$localft");
}
}
#
# Ask the user if they want them to be read in and read them
#
if (keys(%knownfiles)) {
my @files;
if (defined($opts{'r'})) {
if ($opts{'r'} eq "all" || $opts{'r'} eq "a") {
@files = keys(%knownfiles);
} elsif ($opts{'r'} ne "none" && $opts{'r'} ne "n") {
print "unknown argument to -r: $opts{'r'}\n";
exit(1);
}
} elsif(defined($opts{'R'})) {
@files = split(/\s*,\s*/,$opts{'R'});
foreach my $i (@files) {
my $x = $i;
$x =~ s/.*\/([^\/]+)$/$1/;
$knownfiles{$i} = $x;
}
Print("reading: ", join(",",@files),"\n");
} else {
@files = display_menu(-head => "The following configuration files were found:\n",
-tail => "Would you like me to read them in? Their content will be merged with the\noutput files created by this session.\nValid answer examples: \"all\", \"none\",\"1,2,5\"\n",
-multiple => 1,
-question => 'Read in which',
-defaultvalue => 'all',
sort keys(%knownfiles));
}
foreach my $i (@files) {
debug("reading $i\n");
read_config($i, $knownfiles{$i});
}
}
if ($opts{'g'}) {
my @groups = split(/,:\s/,$opts{'g'});
foreach my $group (@groups) {
do_group($group);
}
} elsif ($#ARGV >= 0) {
#
# loop through requested files.
#
foreach my $i (@ARGV) {
if (!defined($filetypes{$i})) {
warn "invalid file: $i\n";
} else {
if ($opts{'a'}) {
$didfile{$i} = 1;
} else {
build_file($term, $i, $filetypes{$i});
}
}
}
} else {
#
# ask user to select file type to operate on.
#
while(1) {
my $line = display_menu(-head => "Select file to create:\n",
-question => 'Select File',
-otheranswers => ['quit', 'q'],
keys(%filetypes));
last if ($line eq "q" or $line eq "quit");
debug("file selected: $line\n");
build_file($term, $line, $filetypes{$line});
}
}
#
# Write out the results to the output files.
#
output_files(\%filetypes, $term);
#
# Display the files that have been created for the user.
#
Print("\nThe following files were created:\n\n");
@didfiles = keys(%didfile);
foreach my $i (@didfiles) {
if ($didfile{$i} ne "1") {
if ($opts{'i'} || $opts{'I'}) {
$opts{'I'} = "/usr/share/snmp" if (!$opts{'I'});
system("mv $opts{'I'}/$i $opts{'I'}/$i.bak") if (-f "$opts{'I'}/$i");
system("mv $didfile{$i} $opts{'I'}");
Print(" $didfile{$i} installed in $opts{'I'}\n");
} elsif ($opts{'p'}) {
system("mv $ENV{HOME}/.snmp/$i $ENV{HOME}/.snmp/$i.bak");
system("mv $i $ENV{HOME}/.snmp");
Print(" $didfile{$i} installed in $ENV{HOME}/.snmp\n");
} else {
Print(" $didfile{$i} ",
($i ne $didfile{$i})?"[ from $i specifications]":" ","\n");
if ($opts{'d'}) {
open(I,$didfile{$i});
debug(" " . join(" ",<I>) . "\n");
close(I);
}
}
}
}
$didfilesc = join(",",@didfiles);
$didfiless = join(" ",@didfiles);
if (!$opts{'p'} && !$opts{'i'} && !$opts{'I'}) {
Print("\nThese files should be moved to /usr/share/snmp/ if you
want them used by everyone on the system. To do this automatically
right now, you can run one of the following commands:
mv $didfiless /usr/share/snmp/
$0 -R $didfilesc -f -i -a $didfiless
Or, if you want them for your personal use, copy them to
$ENV{HOME}/.snmp To do this automatically
right now, you can run the following command:
mv $didfiless $ENV{HOME}/.snmp/
$0 -R $didfilesc -f -p -a $didfiless
FYI, if you specify -i or -p on the command line for future runs of
$0, this will be done immediately after snmpconf finishes creating the
files for you.
");
}
###########################################################################
# Functions
###########################################################################
sub Print {
print @_ if (!$opts{'q'});
}
#
# handle a group of questions
#
sub get_yn_maybe {
my $question = shift;
my $ans = "y";
if ($question ne "") {
$ans = get_answer($term, $question,
valid_answers(qw(yes y no n)), 'y');
}
return ($ans =~ /^y/)?1:0;
}
sub do_group {
my $group = shift;
die "no such group $group\n" if (!$groups{$group});
foreach my $token (@{$groups{$group}}) {
if ($token->[0] eq "message") {
Print ("$token->[1] $token->[2]\n");
} elsif ($token->[0] eq "subgroup") {
do_group($token->[1]) if (get_yn_maybe($token->[2]));
} elsif (defined($tokenmap{$token->[1]})) {
if (get_yn_maybe($token->[2])) {
do {
do_line($token->[1], $tokenmap{$token->[1]});
} until ($token->[0] ne "multiple" ||
get_answer($term, "Do another $token->[1] line?",
valid_answers(qw(yes y no n)), 'y')
=~ /n/);
}
} elsif (defined($filetypes{$token->[1]})) {
$didfile{$token->[1]} = 1;
} else {
die "invalid member $token->[1] of group $group\n";
}
}
}
#
# build a particular type of file by operating on sections
#
sub build_file {
my ($term, $filename, $fileconf) = @_;
$didfile{$filename} = 1;
my (@lines);
while(1) {
my $line = display_menu(-head => "Select configuration section for $filename to operate on:\n",
-otheranswers => ['finished','f'],
-question => "Select section",
-numeric => 1,
map { $_->{'title'}[0] } @$fileconf);
return @lines if ($line eq "finished" || $line eq "f");
do_section($fileconf->[$line-1]);
}
}
#
# configure a particular section by operating on token types
#
sub do_section {
my $confsect = shift;
my @lines;
while(1) {
Print ("\nSection: $confsect->{'title'}[0]\n");
Print ("Description:\n");
Print (" ", join("\n ",@{$confsect->{'description'}}),"\n");
my $line =
display_menu(-head => "Select from:\n",
-otheranswers => ['finished','f','list','l'],
-question => 'Select section',
-descriptions => [map { $confsect->{$_}{info}[0] }
keys(%{$confsect->{'thetokens'}})],
keys(%{$confsect->{'thetokens'}}));
return @lines if ($line eq "finished" || $line eq "f");
if ($line eq "list" || $line eq "l") {
print "Lines defined for section \"$confsect->{title}[0]\" so far:\n";
foreach my $i (keys(%{$confsect->{'thetokens'}})) {
if ($#{$confsect->{$i}{'results'}} >= 0) {
print " ",join("\n ",@{$confsect->{$i}{'results'}}),"\n";
}
}
next;
}
do_line($line, $confsect->{$line});
}
return;
}
#
# Ask all the questions related to a particular line type
#
sub do_line {
my $token = shift;
my $confline = shift;
my (@answers, $counter, $i);
# debug(my_Dumper($confline));
Print ("\nConfiguring: $token\n");
Print ("Description:\n ",join("\n ",@{$confline->{'info'}}),"\n\n");
for($i=0; $i <= $#{$confline->{'question'}}; $i++) {
if (defined($confline->{'question'}[$i]) &&
$confline->{'question'}[$i] ne "") {
my $q = $confline->{'question'}[$i];
$q =~ s/\$(\d+)/$answers[$1]/g;
debug("after: $term, $q, ",$confline->{'validanswer'}[$i],"\n");
$answers[$i] = get_answer($term, $q,
$confline->{'validanswer'}[$i]);
$answers[$i] =~ s/\"/\\\"/g;
$answers[$i] = '"' . $answers[$i] . '"' if ($answers[$i] =~ /\s/);
}
}
if ($#{$confline->{'line'}} == -1) {
my ($i,$line);
for($i=0; $i <= $#{$confline->{'question'}}; $i++) {
next if (!defined($confline->{'question'}[$i]) ||
$confline->{'question'}[$i] eq "");
$line .= " \$" . $i;
}
push @{$confline->{'line'}}, $line;
}
foreach my $line (@{$confline->{'line'}}) {
my $finished = $line;
debug("preline: $finished\n");
debug("answers: ",my_Dumper(\@answers));
$finished =~ s/\$(\d+)/$answers[$1]/g;
if ($line =~ s/^eval\s+//) {
debug("eval: $finished\n");
$finished = eval $finished;
debug("eval results: $finished\n");
}
$finished = $token . " " . $finished;
Print ("\nFinished Output: $finished\n");
push @{$confline->{'results'}},$finished;
}
}
#
# read all sets of config files in the various subdirectories.
#
sub read_config_files {
my $readdir = shift;
my $filetypes = shift;
opendir(DH, $readdir) || die "no such directory $readdir, did you run make install?\n";
my $dir;
while(defined($dir = readdir(DH))) {
next if ($dir =~ /^\./);
next if ($dir =~ /CVS/);
debug("dir entry: $dir\n");
if (-d "$readdir/$dir") {
$filetypes->{$dir} = read_config_items("$readdir/$dir", $dir);
}
}
closedir DH;
}
#
# read each configuration file in a directory
#
sub read_config_items {
my $itemdir = shift;
my $type = shift;
opendir(ITEMS, $itemdir);
my $file;
my @results;
while(defined($file = readdir(ITEMS))) {
next if ($file =~ /~$/);
if (-f "$itemdir/$file") {
my $res = read_config_item("$itemdir/$file", $type);
if (scalar(keys(%$res)) > 0) {
push @results, $res;
}
}
}
closedir(ITEMS);
return \@results;
}
#
# mark a list of tokens as a special "group"
#
sub read_config_group {
my ($fh, $group, $type) = @_;
my $line;
debug("handling group $group\n");
push (@{$groups{$group}},['filetype', $type]);
while($line = <$fh>) {
chomp($line);
next if ($line =~ /^\s*$/);
next if ($line =~ /^\#/);
return $line if ($line !~ /^(single|multiple|message|filetype|subgroup)/);
my ($type, $token, $rest) = ($line =~ /^(\w+)\s+([^\s]+)\s*(.*)/);
debug ("reading group $group : $type -> $token -> $rest\n");
push (@{$groups{$group}}, [$type, $token, $rest]);
}
return;
}
#
# Parse one file
#
sub read_config_item {
my $itemfile = shift;
my $type = shift;
my $fh = new IO::File($itemfile);
return if (!defined($fh));
my (%results, $curtoken);
debug("tokenitems: ", my_Dumper(\%tokenitems));
topwhile:
while($line = <$fh>) {
next if ($line =~ /^\s*\#/);
my ($token, $rest) = ($line =~ /^(\w+)\s+(.*)/);
next if (!defined($token) || !defined($rest));
while ($token eq 'group') {
# handle special group list
my $next = read_config_group($fh, $rest,$type);
if ($next) {
($token, $rest) = ($next =~ /^(\w+)\s+(.*)/);
} else {
next topwhile;
}
}
debug("token: $token => $rest\n");
if ($token eq 'steal') {
foreach my $stealfrom (keys(%{$results{$rest}})) {
if (!defined($results{$curtoken}{$stealfrom})) {
@{$results{$curtoken}{$stealfrom}} =
@{$results{$rest}{$stealfrom}};
}
}
} elsif (defined($tokenitems{$token})) {
if (!defined($curtoken)) {
die "error in configuration file $itemfile, no token set\n";
}
$rest =~ s/^\#//;
push @{$results{$curtoken}{$token}},$rest;
} elsif (defined($arrayitems{$token})) {
if (!defined($curtoken)) {
die "error in configuration file $itemfile, no token set\n";
}
my ($num, $newrest) = ($rest =~ /^(\d+)\s+(.*)/);
if (!defined($num) || !defined($newrest)) {
warn "invalid config line: $line\n";
} else {
$results{$curtoken}{$token}[$num] = $newrest;
}
} elsif ($token =~ /^token\s*$/) {
$rest = lc($rest);
$curtoken = $rest;
$results{'thetokens'}{$curtoken} = 1;
$results{$curtoken}{'defined'} = 1;
$tokenmap{$curtoken} = $results{$curtoken};
debug("current token set to $token\n");
} else {
push @{$results{$token}},$rest;
}
}
return \%results;
}
sub debug {
print @_ if ($opts{'d'});
}
sub output_files {
my $filetypes = shift;
my $term = shift;
foreach my $ft (keys(%$filetypes)) {
next if (!$didfile{$ft});
my $outputf = $ft;
if (-f $outputf && !$opts{'f'}) {
print "Error: $outputf already exists. \n";
my $ans = get_answer($term,"'overwrite', 'skip', 'rename' or 'append'? ",valid_answers(qw(o overwrite r rename s skip a append)));
next if ($ans =~ /^(s|skip)$/i);
if ($ans =~ /^(a|append)/) {
$outputf = ">$outputf";
} elsif ($ans =~ /^(r|rename)$/i) {
# default to rename for error conditions
$outputf = $term->readline("Save to what file name then (or 'skip')? ");
}
}
$didfile{$ft} = $outputf;
open(O,">$outputf") || warn "couldn't write to $outputf\n";
print O "#" x 75,"\n";
print O "#\n# $ft\n";
print O "#\n# - created by the snmpconf configuration program\n#\n";
foreach my $sect (@{$filetypes->{$ft}}) {
my $secthelp = 0;
foreach my $token (keys(%{$sect->{'thetokens'}})) {
if ($#{$sect->{$token}{'results'}} >= 0) {
if ($secthelp++ == 0) {
print O "#" x 75,"\n# SECTION: ",
join("\n# ", @{$sect->{title}}), "\n#\n";
print O "# ", join("\n# ",@{$sect->{description}}),
"\n";
}
print O "\n# $token: ",
join("\n# ",@{$sect->{$token}{info}}), "\n\n";
foreach my $result (@{$sect->{$token}{'results'}}) {
print O "$result\n";
}
}
}
print O "\n\n\n";
}
if ($#{$unknown{$ft}} > -1) {
print O "#\n# Unknown directives read in from other files by snmpconf\n#\n";
foreach my $unknown (@{$unknown{$ft}}) {
print O $unknown,"\n";
}
}
close(O);
}
}
sub get_answer {
my ($term, $question, $regexp, $defaultval) = @_;
$question .= " (default = $defaultval)" if (defined($defaultval) && $defaultval ne "");
$question .= ": ";
my $ans = $term->readline($question);
return $defaultval if ($ans eq "" && defined($defaultval) &&
$defaultval ne "");
while (!(!defined($regexp) ||
$regexp eq "" ||
$ans =~ /$regexp/)) {
print "invalid answer! It must match this regular expression: $regexp\n";
$ans = $term->readline($question);
}
return $defaultval if ($ans eq "" && defined($defaultval) &&
$defaultval ne "");
return $ans;
}
sub valid_answers {
my @list;
foreach $i (@_) {
push @list, $i if ($i);
}
return "^(" . join("|",@list) . ")\$";
}
sub read_config {
my $file = shift;
my $filetype = shift;
return if (!defined($filetypes{$filetype}));
if (! -f $file) {
warn "$file does not exist\n";
return;
}
open(I,$file);
while(<I>) {
next if (/^\s*\#/);
next if (/^\s*$/);
chomp;
my ($token, $rest) = /^\s*(\w+)\s+(.*)/;
$token = lc($token);
next if (defined($alllines{$_})); # drop duplicate lines
if (defined($tokenmap{$token})) {
push @{$tokenmap{$token}{'results'}},$_;
} else {
push @{$unknown{$filetype}},$_;
}
$alllines{$_}++;
}
}
sub display_menu {
my %config;
while ($#_ > -1 && $_[0] =~ /^-/) {
my $key = shift;
$config{$key} = shift;
}
my $count=1;
print "\n" if (!defined($config{'-dense'}));
if ($config{'-head'}) {
print $config{'-head'};
print "\n" if (!defined($config{'-dense'}));
}
my @answers = @_;
my @list;
if (defined($config{'-descriptions'}) &&
ref($config{'-descriptions'}) eq "ARRAY") {
@list = @{$config{'-descriptions'}}
} else {
@list = @_;
}
foreach my $i (@list) {
printf " %2d: $i\n", $count++ if ($i);
}
print "\n" if (!defined($config{'-dense'}));
if (defined($config{'-otheranswers'})) {
if (ref($config{'-otheranswers'}) eq 'ARRAY') {
print "Other options: ", join(",",@{$config{'-otheranswers'}}),"\n";
push @answers, @{$config{'-otheranswers'}};
} else {
my $maxlen = 0;
push @answers,keys(%{$config{'-otheranswers'}});
foreach my $i (keys(%{$config{'-otheranswers'}})) {
$maxlen = length($i) if (length($i) > $maxlen);
}
foreach my $i (keys(%{$config{'-otheranswers'}})) {
printf(" %-" . $maxlen . "s: %s\n", $i,
$config{'-otheranswers'}{$i});
}
}
print "\n" if (!defined($config{'-dense'}));
}
if ($config{'-tail'}) {
print $config{'-tail'};
print "\n" if (!defined($config{'-dense'}));
}
if (defined($config{'-question'})) {
while(1) {
my $numexpr;
if ($config{'-multiple'}) {
$numexpr = '[\d\s,]+|all|a|none|n';
} else {
$numexpr = '\d+';
}
push @answers,"" if ($config{'-defaultvalue'});
$ans = get_answer($term, $config{'-question'},
valid_answers($numexpr,@answers),
$config{'-defaultvalue'});
if ($ans =~ /^$numexpr$/) {
if ($config{'-multiple'}) {
my @list = split(/\s*,\s*/,$ans);
my @ret;
$count = 0;
foreach my $i (@_) {
$count++;
if ($ans eq "all" || $ans eq "a"
|| grep(/^$count$/,@list)) {
push @ret, $i;
}
}
return @ret;
} else {
if ($ans <= 0 || $ans > $#_+1) {
warn "invalid selection: $ans [must be 1-" .
($#_+1) . "]\n";
} else {
return $ans if ($config{'-numeric'});
$count = 0;
foreach my $i (@_) {
$count++;
if ($ans eq $count) {
return $i;
}
}
}
}
} else {
return $ans;
}
}
}
}
sub my_Dumper {
if ($opts{'D'}) {
return Dumper(@_);
} else {
return "\n";
}
}
