Subversion Repositories camp_sysinfo_client_3

#!/usr/bin/env perl

# v1.2.0 20161022 RWR

# moved makeConfig here so it is usable by install and configure

#

# v1.3.0 20190108 RWR

# added UUID and set defaults for config file

#

# v1.4.0 20190204 RWR

# added autoconvert from v1.2 configuration file to v1.3

# using dumper to set configuration file

#

# version 2.0 20190330 RWR

# changed it so all configs are YAML

package sysinfoconf;

our $VERSION = '2.0';

use warnings;

use strict;  

#use Data::Dumper;

use YAML::Tiny;

use File::Basename;

use Exporter;

our @ISA = qw( Exporter );

our @EXPORT = qw( $clientName $serialNumber $hostname @moduleDirs @scriptDirs 

                  $transports $sysinfo3 %sendTypes $binDir $moduleDir

                  $scriptDir $confDir $binName $confName

                  &showConf &transportsToConfig &getAnswer &yesno  

                  &writeConfig &processParameters $TESTING &checkDirectoryExists

                  &runCommand &setDryRun &enableModules &makeConfig &findConf &deepmerge

                );

our $TESTING = 0;

our $dryRun;

our $clientName = '';

our $serialNumber = '';

our $hostname = '';

my @installDirs = ( '/opt/camp/sysinfo-client', '/usr/local/opt/camp/sysinfo-client' );

my @confDirs =    ( '/etc/camp/sysinfo-client', '/usr/local/etc/camp/sysinfo-client' );

our @moduleDirs = ( '/opt/camp/sysinfo-client/modules', '/etc/camp/sysinfo-client/modules' );

our @scriptDirs = ( '/opt/camp/sysinfo-client/scripts', '/etc/camp/sysinfo-client/scripts' );

our $transports = {}; # holds transportation mechanisms

our $sysinfo3 = 'sysinfo-client.yaml';

our $binDir = '/opt/camp/sysinfo-client';

our $moduleDir = $binDir . '/modules';

our $scriptDir = $binDir . '/scripts';

our $confDir = '/etc/camp/sysinfo-client';

our $binName = 'sysinfo-client';

our $confName = 'sysinfo-client.yaml';

sub setDryRun {

   $dryRun = shift;

}

our %sendTypes = ( 

                  'SendEmail' =>    { 'sendScript' => 'sendEmailScript',

                                      'keys' => 

                                      [

                                        'mailTo',

                                        'mailSubject',

                                        'mailCC',

                                        'mailBCC',

                                        'mailServer',

                                        'mailFrom',

                                        'logFile',

                                        'otherCLParams',

                                        'tls',

                                        'smtpUser',

                                        'smtpPass',

                                        'sendEmailScriptLocation'

                                      ],

                                    },

                  'HTTP Upload' =>  { 'sendScript' => 'upload_http',

                                      'keys' => 

                                      [

                                        'URL',

                                        'key for report',

                                        'key for date',

                                        'key for hostname',

                                        'key for client',

                                        'key for serial number'

                                      ]

                                    },

                  'Save Local' =>   { 'sendScript' => 'save_local',

                                      'keys' =>

                                      [

                                         'output directory'

                                      ]

                                   }

                );

# recursively merge multiple hashes/arrays to an arbitrary depth

# stolen from

# https://stackoverflow.com/questions/2767477/how-can-i-merge-several-hashes-into-one-hash-in-perl

sub deepmerge {

    my (@structs) = @_;

    my $new;

    # filter out non-existant structs

    @structs = grep {defined($_)} @structs;

    my $ref = ref($structs[0]);

    if (not all(map {ref($_) eq $ref} @structs)) { 

        warn("deepmerge: all structs are not $ref\n");

    } 

    my @tomerge = grep {ref($_) eq $ref} @structs;

    return qr/$tomerge[0]/ if scalar(@tomerge) == 1 and $ref eq 'Regexp';

    return $tomerge[0] if scalar(@tomerge) == 1;

    if ($ref eq '') { 

        $new = pop(@tomerge); # prefer farthest right

    } elsif ($ref eq 'Regexp') { 

        $new = qr/$tomerge[$#tomerge]/;

    } elsif ($ref eq 'ARRAY') { 

        $new = [];

        for my $i (0 .. max(map {scalar(@$_) - 1} @tomerge)) { 

            $new->[$i] = deepmerge(map {$_->[$i]} @tomerge);

        }

    } elsif ($ref eq 'HASH') { 

        $new = {};

        for my $key (uniq(map {keys %$_} @tomerge)) { 

            $new->{$key} = deepmerge(map {$_->{$key}} @tomerge);

        }

    } else {

        # ignore all other structures...

        $new = '';

    }

    return $new;

}

sub enableModules {

   my $moduleDir = shift;

   my %modules;

   if ( opendir( my $dh, "$moduleDir" ) ) {

      %modules = map{ $_ => { 'enabled' => -x "$moduleDir/$_" } } 

                 grep { ! /^\./ } 

                 readdir $dh;

      closedir( $dh );

      foreach my $filename ( keys %modules ) {

         if ( open FILE,"<$moduleDir/$_" ) {

            my @descript = grep{ /^# Description: (.*)/ } <FILE>;

            close FILE;

            chomp @descript;

            $modules{$filename}{'description'} = $descript[0];

         } # if

      } # foreach

   } # if

} # enableModules

sub showConf {

   my $configuration = shift;

   $configuration = Dump($configuration);

   return $configuration;

   #return $conf;

   #my $conf;

   #$conf .= "\$clientName = '" .   ( defined( $$configuration{'clientName'}   ) ? $$configuration{'clientName'}   : '' ) . "';\n";

   #$conf .= "\$serialNumber = '" . ( defined( $$configuration{'serialNumber'} ) ? $$configuration{'serialNumber'} : '' ) . "';\n";

   #$conf .= "\$hostname = '" .     ( defined( $$configuration{'hostname'}     ) ? $$configuration{'hostname'}     : '' ) . "';\n";

   #$conf .= "\$UUID = '" .      ( defined( $$configuration{'UUID'}     ) ? $$configuration{'UUID'}     : '' ) . "';\n";

   #$conf .= "\@moduleDirs = ('" . join( "','", @{ $$configuration{ 'moduleDirs' } } ) . "');\n";

   #$conf .= "\@scriptDirs = ('" . join( "','", @{ $$configuration{ 'scriptDirs' } } ) . "');\n";

   #$conf .= &transportsToConfig( $$configuration{ 'transports' } ) if defined( $$configuration{ 'transports' } );

   #return $conf;

}

sub transportsToConfig {

   my $transports = shift;

   my $config;

   foreach my $priority ( sort { $a <=> $b } keys %$transports ) {

      my $name = $$transports{ $priority }{'-name-'};

      $config .= "# Tranport $name at priority $priority\n";

      my $thisOne = $$transports{ $priority };

      foreach my $key ( sort keys %$thisOne ) {

         $config .= "\$\$transports{$priority}{'$key'} = '$$thisOne{$key}';\n";

      } # foreach

   } # foreach

   return $config;

} # transportsToConfig

# read the configuration file passed in and return a reference to it

# to the calling routine

sub readConfig {

   my $filename = shift;

   my $config;

   return $config unless -e $filename;

   if ( open CONF,"<$filename" ) {

      my $contents = join( '', <CONF> );

      close CONF;

      # now, look to see what kind of file this is.

      if ( $contents =~ m/^---(\s*#.*)?$/m ) {

         print "Reading $filename as YAML\n";

         #print "Contents are:\n\n=====================$contents\n=====================\n";

         # this is a yaml file

         #$contents = YAML::Tiny->read( $config );

         $config = Load( $contents );

      } elsif ( $contents =~ m/\$clientName/ ) {

         # this is old style

         print "Reading $filename as old school file\n";

         my $clientName = '';

         my $serialNumber = '';

         my $hostname = '';

         my @moduleDirs;

         my @scriptDirs;

         my $UUID = '';

         my $transports;

         # now, eval the information we just read.

         # NOTE: we must turn off strict while doing this, and we die if something breaks.

         no strict "vars";

         eval( $contents );

         use strict "vars";

         die "Error during eval: $@\n" if $@;

         $config->{'clientName'} = $clientName if $clientName;

         $config->{'serialNumber'} = $serialNumber if $serialNumber;

         $config->{'UUID'} = $UUID unless $config->{'UUID'};

         $config->{'hostname'} = $hostname if $hostname;

         $config->{'moduleDirs'} = [ @moduleDirs ] if @moduleDirs;

         $config->{'scriptDirs'} = [ @scriptDirs ] if @scriptDirs;

         $config->{'transports'} = $transports if $transports;

      }

   } else {

         warn "Could not read config file $filename, skipped: $!\n";

   }

   return $config;

}

sub makeConfig {

   my @configFileNames = @_;

   my %config;

   foreach my $config ( @configFileNames ) {

      my $thisConfig = &readConfig( $config );

      # add the new config to %config, overwriting any existing keys which are duplicated

      @config{keys %$thisConfig} = values %$thisConfig;

   }

   # now, ensure the correct values are loaded in some areas

   unless ( $config{'hostname'} ) {

      $hostname = `hostname -f`;

      chomp $hostname;

      $config{'hostname'} = $hostname;

   }

   unless ( $config{'serialNumber'} ) {

      $serialNumber = `dmidecode -t 1 | grep 'Serial Number' | cut -d':' -f2` if `which dmidecode`;

      chomp $serialNumber;

      $serialNumber =~ s/\s//gi;

      $config{'serialNumber'} = $serialNumber;

   }

   unless ( $config{'UUID'} ) {

      my $UUID = `dmidecode -t 1 | grep -i uuid | cut -d':' -f2` if `which dmidecode`;

      $UUID =~ s/\s//gi;

      $config{'UUID'} = $UUID;

   }

   # ensure we have the default SaveLocal transport defined

   unless ( defined $config{'transports'}{'99'} ) {

      $config{'transports'}{'99'} = {

                         'name'=> 'SaveLocal',

                         'output directory' => '/tmp',

                         'sendScript' => 'save_local'

                        };

   }

   return \%config;

}

# prompt the user for a response, then allow them to enter it

# the first response is considered the default and is printed

# in all caps if more than one exists

# first answer is used if they simply press the Enter

# key. The response is returned all lower case if more than one

# exists.

# it is assumed 

sub getAnswer {

   my ( $prompt, @answers ) = @_;

   $answers[0] = '' unless defined( $answers[0] );

   my $default = $answers[0];

   my $onlyOneAnswer = scalar( @answers ) == 1;

   print $prompt . '[ ';

   $answers[0] = uc $answers[0] unless $onlyOneAnswer;

   print join( ' | ', @answers ) . ' ]: ';

   my $thisAnswer = <>;

   chomp $thisAnswer;

   $thisAnswer = $default unless $thisAnswer;

   return $thisAnswer;

}

sub yesno {

   my ( $prompt, $default ) = @_;

   $default = 'yes' unless $default;

   my $answer = &getAnswer( $prompt, $default eq 'yes' ? ('yes','no' ) : ('no', 'yes') );

   return lc( substr( $answer, 0, 1 ) ) eq 'y';

}

# runs a system command. Also, if in testing mode, simply shows what

# would have been done.

sub runCommand {

   while ( my $command = shift ) {

      if ( $dryRun ) {

         print "$command\n";

      } else {

         `$command`;

      }

   }

   return 1;

} # runCommand

# checks if a directory exists and, if not, creates it

my %directories; # holds list of directories already created so no need to do an I/O

sub checkDirectoryExists {

   my ( $filename,$mod,$owner ) = @_;

   $mod = "0700" unless $mod;

   $owner = "root:root" unless $owner;

   print "Checking Directory for $filename with $mod and $owner\n" if $TESTING > 2;

   my ($fn, $dirname) = fileparse( $filename );

   print "\tParsing out $dirname and $filename\n" if $TESTING > 2;

   return '' if exists $directories{$dirname};

   if ( -d $dirname ) {

      $directories{$dirname} = 1;

      return '';

   }

   if ( &runCommand( "mkdir -p $dirname", "chmod $mod $dirname", "chown $owner $dirname" ) ) {

      $directories{$dirname} = 1;

   }

   return '';   

}

sub writeConfig {

   my ( $filename,$content ) = @_;

   my $path;

   ($filename, $path ) = fileparse( $filename );

   my $return;

   `mkdir -p $path` unless -d $path;

   $filename = $path . '/' . $filename;

   if ( -e $filename ) {

      `cp $filename $filename.bak` if ( -e $filename );

      $return .= "Old config copied to $filename.bak\n";

   }

   if ( $dryRun ) {

      $return .= "Not writing to configuration file\n";

   } else {

      open CONF,">$filename" or die "Could not write to $filename: $!\n";

      print CONF $content;

      close CONF;

      `chmod 600 $filename`;

      $return .= "Configuration successfully written to $filename\n";

   }

   return $return;

}

sub processParameters {

   while ( my $parameter = shift ) {

      if ( $parameter eq '-v' ) {

         print "$VERSION\n";

         exit;

      }

   } # while

}

sub findConf {

   my $confName = shift;

   my @confDirs =    ( '/etc/camp/sysinfo-client', '/usr/local/etc/camp/sysinfo-client' );

   for ( my $i = 0; $i < @confDirs; $i++ ) {

      if ( -d $confDirs[ $i ] ) {

         return ( $confDirs[$i],  $confName );

      }

   }

   return ( '', $confName );

}

1;