Subversion Repositories camp_sysinfo_client_3

Rev

Rev 141 | Rev 144 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
16 rodolico 1
#!/usr/bin/env perl
20 rodolico 2
use warnings;
26 rodolico 3
use strict;  
2 rodolico 4
 
5
# sysinfo
6
# Author: R. W. Rodolico
7
# Primary client portion of sysinfo system. Will collect information about its current
8
# host and create a report containing the information. This report can then be processed
9
# by process_sysinfo.pl on the collection computer.
112 rodolico 10
# output file consists of a YAML file of the form:
2 rodolico 11
#  <sysinfo3.0.0>
12
#    <diskinfo name='/dev/xvda3'>
13
#      <fstype>ext3</fstype>
14
#      <mount>/home</mount>
15
#      <size>51606140</size>
16
#      <used>331472</used>
17
#    </diskinfo>
18
#    <network name='eth0'>
19
#      <address>192.168.1.3</address>
20
#      <ip6address>fe80::216:3eff:fefb:4e10</ip6address>
21
#      <ip6networkbits>64</ip6networkbits>
22
#      <mac>00:16:3e:fb:4e:10</mac>
23
#      <mtu>1500</mtu>
24
#      <netmask>255.255.255.0</netmask>
25
#    </network>
26
#    <operatingsystem>
27
#      <codename>squeeze</codename>
28
#      <description>Debian GNU/Linux 6.0.4 (squeeze)</description>
29
#      <distribution>Debian</distribution>
30
#      <kernel>2.6.32-5-xen-686</kernel>
31
#      <os_name>Linux</os_name>
32
#      <os_version>Linux version 2.6.32-5-xen-686 (Debian 2.6.32-41) (ben@decadent.org.uk) (gcc version 4.3.5 (Debian 4.3.5-4) ) #1 SMP Mon Jan 16 19:46:09 UTC 2012</os_version>
33
#      <release>6.0.4</release>
34
#    </operatingsystem>
35
#    <pci name='0000:00:00.0'>
36
#      <class>RAM memory</class>
37
#      <device>MCP55 Memory Controller</device>
38
#      <rev>a2</rev>
39
#      <sdevice>Device cb84</sdevice>
40
#      <slot>0000:00:00.0</slot>
41
#      <svendor>nVidia Corporation</svendor>
42
#      <vendor>nVidia Corporation</vendor>
43
#    </pci>
44
#    <report>
45
#      <client>Staffmasters</client>
46
#      <date>2012-05-01 03:00</date>
47
#      <version>2.0.0</version>
48
#    </report>
49
#    <software name='aptitude'>
50
#      <description>terminal-based package manager (terminal interface only)</description>
51
#      <version>0.6.3-3.2+squeeze1</version>
52
#    </software>
53
#    <system>
54
#      <cpu_speed>1800.103</cpu_speed>
55
#      <cpu_sub>i686</cpu_sub>
56
#      <cpu_type>GenuineIntel</cpu_type>
57
#      <hostname>backup.staffmasters.local</hostname>
58
#      <last_boot>1333259809</last_boot>
59
#      <memory>520852</memory>
60
#      <num_cpu>1</num_cpu>
61
#    </system>
62
#  </sysinfo3.0.0>
63
 
64
 
65
#
66
# Version 1.3 20071104
67
# added capability of e-mailing the results by itself and external configuration file
68
 
69
# Version 1.3.1 20071110
70
# added du -sk to explicitly do directory sizes in 'k'. Also, fixed some documentation
71
 
72
# Version 1.3.3 20081104
73
# modified hostname to hostname -f, and allowed user to place custom value in configuration file
74
# also, modified to go with Debian standards in preparation to creating a debian package.
75
 
76
# Version 2.0 20081208
77
# Modified to use different libraries for different OS's in preparation to porting to Windows
78
# Uses different packages based on which OS it is on.
79
 
80
# Version 3.0 20120923
81
# Major revision. Most internal intelligence pulled out and put into modules and data transfer format has been changed to YAML
82
#
83
# Base system only pulls client name, machine name and machine number, all of which can be set in the configuration file
84
# if the value is not set, it attempts various means to determine the values and, if it fails, aborts with an error message
85
#    client name -- REQUIRED, must come from configuration file
86
#    machine name --  REQUIRED, if not set via conf file, attempts hostname command (hostname -f) or module getHostName
87
#    machine number -- REQUIRED, if not set via conf file, attempts "echo `hostname -f`-clientname | md5sum" or module getSerial
88
# modules are stored in "configuration directory/modules" (/etc/sysinfo/modules on most Linux systems) and are processed in 
89
# standard sort order (case sensitive). 
90
# Module filenames may contain alpha-numeric, underscore and the period only (files containing other characters are ignored).
91
# Modules should set their exit code to 0 for success, and non-zero for failure
92
# Modules should return 0 or more tab delimited, newline terminated strings, processed as one record per line
93
# A module return string line is processed as follows:
94
#     category \t [category \t ...] \t key \t value
95
# example:
96
#    System \t num_cpu \t 1
97
#    System \t Users \t root \t /root/
98
# (note, if non-zero exit code returned, return value is assumed to be error message and is printed to STDERR) 
99
# sysinfo stores the result in a hash, using categories as the keys (case sensitive), thus, the above results in
100
# $store{'System'}{'num_cpu'} = '1';
101
# $store{'System'}{'Users'}{'root'} = '/root';
102
# upon completion, sysinfo converts the $store hash into an XML or YAML string for transfer
103
# It then sends it to the main server as defined in the conf file.
104
# NOTE: YAML is hand crafted to kill any requirements for external libraries
105
# see sub hashToYAML for details
106
 
9 rodolico 107
# Version 3.0.1 20160321
108
# Renamed to sysinfo-client to not conflict with Linux package sysinfo
109
# created installer in Perl to not rely on package managers
110
# default path for configuration file changed to /etc/camp/sysinfo-client.conf
111
# $VERSION changed to $DATA_VERSION to not conflict with $main::VERSION (script version vs data format version)
13 rodolico 112
#
113
# Version 3.1.0 20160401
114
# module and script dirs now arrays to be searched. Idea is that default
115
#    modules/scripts are in installdir/modules or installdir/scripts, and
116
#    user supplied are in /etc/scripts and /etc/modules
14 rodolico 117
# Tightened up the file systems checks, requiring all scripts and modules
118
#    be set 0700 at least, and owned by root
18 rodolico 119
# Transport layers now an array, and if one fails to send the report, the others
120
#    are tried in turn
14 rodolico 121
# Worked on logic for sendReport to give better error checking.
122
# Doing a search for the configuration file matching cwd, then /etc/camp, then /usr/local/etc/camp
21 rodolico 123
# Self documenting, ie a key for software\tsysinfo-client\version\current version is inserted
28 rodolico 124
#
125
# Version 3.1.1 20160915 RWR
126
# set use strict and use warnings, then fixed errors
37 rodolico 127
#
128
# Version 3.1.2 20160922 RWR
129
# $exitCode 1 (not applicable to this machine) does not throw warning
130
#
42 rodolico 131
# Version 3.1.3 20161010 RWR
132
# Removed extra use warnings
47 rodolico 133
#
134
# Version 3.1.4 20161023 RWR
135
# Would error out if moduledir does not exist, added a return
51 rodolico 136
#
137
# Version 3.1.5 20170327 RWR
138
# On freeBSD systems, was looking in wrong place for configuration file
59 rodolico 139
#
140
# Version 3.2.0 20180320 RWR
62 rodolico 141
# Major change in the configuration file format; All entries are loaded into 
142
# hash %configuration, so clientname is no longer $clientname, but is now
143
# $configuration{'clientname'}
144
# NOT backwards compatible
59 rodolico 145
# changed configuration to be loaded into hash (vs directly loaded into variables)
146
# added UUID to configuration file
62 rodolico 147
#
148
# Version 3.2.1 20180424 RWR
149
# Finally got a semi-stable version of this running. Fixed a bunch of bugs
150
# and appears to be working correctly.
112 rodolico 151
#
152
# Version 3.3.0 20190419 RWR
153
# Converted to use YAML config file
135 rodolico 154
#
155
# Version 3.4.0 20191111 RWR
156
# adding logging with priority. logging is a hash inside of %cvonfiguration which contains the following
157
# $configuration{ 'logging' } = {
158
#    'log type'  => 'string',
159
#    'log level' => #,
160
#    'other params' => something,
161
# };
138 rodolico 162
#
163
# The default log type is cache, which builds an array of all messages passed. When the log type is changed, the cache is
164
# checked for values and, if they exist, they are dumped to the log, then removed.
165
#
135 rodolico 166
# Currently, the only log type is 'file', which has one other additional parameter, 'log path' which
167
# points to the actual log to be created. The log is NOT limited in size, so use something else to
168
# do that.
169
# log level is an integer which is compared the a priority passed to the logging function. The
170
# higher log level is set, the more verbose the log.
171
# 0 - Normal, basically logs when the program starts and ends, and any warnings.
172
# 1 - a little more information about flow
173
# 2 - Gives ending information on structures
174
# 3 - Gives a lot of info about structures when they are initialized and at the end
175
# 4 - Crazy. Dumps just about every structure every time they are changed
176
#
177
# $TESTING has been set to a binary. If true, the report is not sent via the transports, but is dumped to /tmp/sysinfo.testing.yaml
178
 
9 rodolico 179
 
112 rodolico 180
# find our location and use it for searching for libraries
181
BEGIN {
182
   use FindBin;
183
   use File::Spec;
184
   use lib File::Spec->catdir($FindBin::Bin);
185
}
62 rodolico 186
 
112 rodolico 187
use YAML::Tiny;
138 rodolico 188
use Data::Dumper;
112 rodolico 189
 
2 rodolico 190
# Following are global variables overridden if configuration file exists
191
 
135 rodolico 192
my $TESTING = 0; # if set to 1, will do everything, but will dump output to /tmp/sysinfo.testing.yaml
9 rodolico 193
 
135 rodolico 194
our $VERSION = '3.4.0';
195
 
2 rodolico 196
my $indentLevel = 2; # number of spaces to indent per level in XML or YAML
197
 
13 rodolico 198
# paths to search for configuration file
51 rodolico 199
my @confFileSearchPath = ( '.', '/etc/camp/sysinfo-client', '/etc/camp', '/usr/local/etc/camp/sysinfo-client' );
2 rodolico 200
 
112 rodolico 201
my $configurationFile = 'sysinfo-client.yaml'; # name of the configuration file
2 rodolico 202
 
135 rodolico 203
my $reportDate = &timeStamp(); # set report date
2 rodolico 204
 
59 rodolico 205
my %configuration = (
142 rodolico 206
   'logging' => { 'log type' => 'cache', 'log level' => 0 },    # if set, will point to logging
61 rodolico 207
   'moduleDirs' => [], # search paths for modules
208
   'scriptDirs' => [], # search paths for scripts
59 rodolico 209
   'clientName' => '',  # Required!! Must be set in conf file (no defaults)
210
   'serialNumber' => '', # serial number of machine
211
   'UUID'         => '', # UUID of machine
61 rodolico 212
   'transports'   => [], # hash with various transports
213
   'hostname' => &getHostName() # fully qualified host name of machine
59 rodolico 214
)
215
;
2 rodolico 216
 
9 rodolico 217
my $DATA_VERSION = '3.0.0'; # used in sending the data file. sets version of XML/YAML data file
2 rodolico 218
 
13 rodolico 219
 
136 rodolico 220
#######################################################
221
#
222
# timeStamp
223
#
224
# return current system date as YYYY-MM-DD HH:MM:SS
225
#
226
#######################################################
227
sub timeStamp {
228
   my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)=localtime(time);
142 rodolico 229
   return sprintf "%4d-%02d-%02d %02d:%02d:%02d",$year+1900,$mon+1,$mday,$hour,$min,$sec;
136 rodolico 230
}
231
 
138 rodolico 232
#######################################################
233
# function to simply log things
135 rodolico 234
# first parameter is the priority, if <= $logDef->{'log level'} will print
235
# all subsequent parameters assumed to be strings to sent to the log
236
# returns 0 on failure
237
#         1 on success
238
#         2 if priority > log level
239
#        -1 if $logDef is unset
240
# currently, only logs to a file
138 rodolico 241
#######################################################
135 rodolico 242
sub logIt {
243
   my $priority = shift;
13 rodolico 244
 
135 rodolico 245
   return -1 unless exists $configuration{'logging'};
246
   return 2 unless $priority <= $configuration{'logging'}{'log level'};
138 rodolico 247
   if ( $configuration{'logging'}{'log type'} eq 'cache' ) {
248
      push @{ $configuration{'logging'}{'cache'} }, @_;
249
      return;
250
   } elsif ( defined( $configuration{'logging'}{'cache'} ) ) {
251
      unshift @_, @{ $configuration{'logging'}{'cache'} };
252
      delete $configuration{'logging'}{'cache'};
253
   }
135 rodolico 254
   if ( $configuration{'logging'}{'log type'} eq 'file' ) {
255
      if ( open LOG, '>>' . $configuration{'logging'}{'log path'} ) {
256
         while ( my $t = shift ) {
257
            print LOG &timeStamp() . "\t$t\n";
258
         }
259
         close LOG;
260
      }
261
   } else {
262
      warn "Log type $configuration{'logging'} incorrectly configured\n";
263
      return 0;
264
   }
265
   return 1;
266
}
267
 
268
 
2 rodolico 269
#######################################################
270
#
13 rodolico 271
# findFile( $filename, @directories )
272
#
273
# Locates a file by searching sequentially in one or more
274
# directories, returning the first one found
275
# 
276
# Returns '' if not found
277
#
278
#######################################################
279
 
280
sub findFile {
59 rodolico 281
   my ( $filename, $directories ) = @_;
138 rodolico 282
   &logIt( 3, "Looking for $filename in findFile" );
59 rodolico 283
   for ( my $i = 0; $i < scalar( @{$directories} ); $i++ ) {
284
      my $confFile = $$directories[$i] . '/' . $filename;
138 rodolico 285
      &logIt( 4, "Looking for $filename in $confFile" );
13 rodolico 286
      return $confFile if ( -f $confFile );
287
   }
288
   return '';
289
}
290
 
291
 
292
#######################################################
293
#
2 rodolico 294
# loadConfigurationFile($confFile)
295
#
296
# Loads configuration file defined by $configurationFile, and dies if not available
112 rodolico 297
# This is a YAML file containing serialized contents of 
2 rodolico 298
# Parameters: configuration file fully path/file name
299
# NOTE: conf file must be a valid Perl file
300
#
301
#######################################################
302
 
135 rodolico 303
sub loadConfigurationFile {   
14 rodolico 304
   my ( $fileName, @searchPath ) = @_;
141 rodolico 305
   &logIt( 2, "Looking for config file $fileName in " . join( ', ', @searchPath ) );
13 rodolico 306
   my $confFile;
59 rodolico 307
   if ( $confFile = &findFile( $fileName, \@searchPath ) ) {
138 rodolico 308
      &logIt( 3, "Opening configuration from $confFile" );
112 rodolico 309
      my $yaml = YAML::Tiny->read( $confFile );
138 rodolico 310
      &logIt( 4, "Configuration file contents\n$yaml" );
112 rodolico 311
      return $yaml->[0];
13 rodolico 312
   }
14 rodolico 313
   die "Can not find $fileName in any of " . join( "\n\t", @searchPath ) . "\n";
2 rodolico 314
}
315
 
316
#######################################################
317
#
318
# sendResults( $parameters, $message, $scriptDirectory )
319
#
320
# Sends results of run to server using external script. If external
321
# script not defined, just print to STDOUT
322
#
323
# Parameters
324
#  $parameters - a hash containing the information necessary to make the transfer
325
#  $message - the message to be sent
326
#  $scriptDirectory - path (not filename) of script to be executed
327
# 
328
# $parameters contains different key/value pairs depending on the script used
329
#             for example, a stand-alone SMTP script may need a username/password,
330
#             smtp server name, port number, from and to address
331
#             while an http transfer may only need a script name
332
#             See the individual scripts to determine what parameters need to be
333
#             filled in.
334
#             The only required parameter is 'sendScript' which must contain the
335
#             name of the script to execute (and it must be located in $scriptDirectory)
336
# SCRIPT must contain one sub named doit, that accepts three parameters, the hash, 
337
#       the message, and, optionally, the script directory
338
#
339
# If script not defined, just dump to STDOUT. With a properly set up cron job, the output
340
# would then be sent via e-mail to an administrative account, possibly root
341
#
342
#######################################################
343
sub sendResults {
62 rodolico 344
   my ( $globals, $transports, $message, $scriptDirectory ) = @_;
135 rodolico 345
   &logIt( 3, "Entering sendResults" );
113 rodolico 346
   foreach my $key ( sort { $a <=> $b } %$transports ) {
347
      if ( $transports->{$key}->{'sendScript'} ) {
135 rodolico 348
         &logIt( 3, "Trying to find file " . $transports->{$key}->{'sendScript'} . " in " . join( "\n\t", @{$scriptDirectory} ) );
113 rodolico 349
         my $sendScript = &findFile( $transports->{$key}->{'sendScript'}, $scriptDirectory );
19 rodolico 350
         if ( $sendScript ) {
18 rodolico 351
            # load the chosen script into memory
352
            require $sendScript;
19 rodolico 353
            # merge the globals in
354
            while ( my ( $gkey, $value ) = each %$globals ) { 
113 rodolico 355
               $transports->{$key}->{$gkey} = $value; 
19 rodolico 356
            }
20 rodolico 357
            # do variable substitution for any values which need it
113 rodolico 358
            foreach my $thisOne ( keys %{$transports->{$key}} ) {
135 rodolico 359
               &logIt( 4, "$thisOne" );
113 rodolico 360
               if ( $transports->{$key}->{$thisOne} =~ m/(\$configuration\{'hostname'\})|(\$reportDate)|(\$configuration\{'clientName'\})|(\$configuration\{'serialNumber'\})/ ) {
361
                  $transports->{$key}->{$thisOne} = eval "\"$transports->{$key}->{$thisOne}\"";
20 rodolico 362
               }
363
            }
364
 
62 rodolico 365
            #%$transports{$key}{keys %$globals} = values %$globals;
366
            #print Dumper( $$transports[$key] );
20 rodolico 367
            #next;
18 rodolico 368
            # execute the "doit" sub from that script
135 rodolico 369
            &logIt( 3, $message );
370
            my $return = &doit( $transports->{$key}, $message );
371
            return $return if ( $return == 1 );
18 rodolico 372
         } else {
135 rodolico 373
            &logIt( 0,"Could not find " . $$transports[$key]{'sendScript'} . ", trying next transport" );
18 rodolico 374
         } # if..else
375
      } # if
376
   } # foreach
377
   # if we made it here, we have not sent the report, so just return it to the user
85 rodolico 378
   # if called from a cron job, it will (hopefully) be sent to root
135 rodolico 379
   &logIt( 0, 'Error, reached ' . __LINE__ . " which should not happen, message was\n$message" );
85 rodolico 380
   print $message;
16 rodolico 381
   return 1;
2 rodolico 382
}
383
 
384
#######################################################
385
#
386
# getHostName
387
#
388
# return hostname from hostname -f
389
#
390
#######################################################
391
sub getHostName {
135 rodolico 392
   &logIt( 3, "Entering getHostName" );
28 rodolico 393
   my $hostname = `hostname -f`;
2 rodolico 394
   chomp $hostname;
395
   return $hostname;
396
}
397
 
398
#######################################################
399
#
18 rodolico 400
# escapeForYAML
2 rodolico 401
#
18 rodolico 402
# Escapes values put into YAML report
2 rodolico 403
#
112 rodolico 404
# DEPRECATED AS OF VERSION 3.3.0
405
# uses YAML::Tiny
406
#
2 rodolico 407
#######################################################
112 rodolico 408
#sub escapeForYAML {
409
#   my $value = shift;
410
#   $value =~ s/'/\\'/gi; # escape single quotes
411
#   $value =~ s/"/\\"/gi; # escape double quotes
412
#   # pound sign indicates start of a comment and thus loses part
413
#   # of strings. Surrounding it by double quotes in next statement
414
#   # allows 
415
#   $value = '"' . $value . '"' if ( $value =~ m/[#:]/ );
416
#   return $value;
417
#}
2 rodolico 418
 
419
#######################################################
420
#
421
# hashToYAML( $hashRef, $indent )
422
#
423
# Converts a hash to a YAML string
424
#
425
# NOTE: This routine recursively calls itself for every level
426
#       in the hash
427
#
428
# Parameters
429
#     $hashref - reference (address) of a hash
430
#     $indent  - current indent level, defaults to 0
431
#
432
# Even though there are some very good libraries that do this
433
# I chose to hand-code it so sysinfo can be run with no libraries
434
# loaded. I chose to NOT do a full implementation, so special chars
435
# that would normally be escaped are not in here. 
436
# However, I followed all the RFC for the values that were given, so
437
# assume any YAML reader can parse this
438
# NOTE: YAML appears to give a resulting file 1/3 smaller than the above
439
#       XML, and compresses down in like manner
440
#
112 rodolico 441
# DEPRECATED AS OF VERSION 3.3.0
442
# uses YAML::Tiny
443
#
2 rodolico 444
#######################################################
112 rodolico 445
#sub hashToYAML {
446
#   my ($hashRef, $indent) = @_;
447
#   $indent = 0 unless $indent; # default to 0 if not defined
448
#   
449
#   my $output; # where the output is stored
450
#   foreach my $key ( keys %$hashRef ) { # for each key in the current reference
451
#      print "Looking at $key\n" if $TESTING > 3;
452
#      # see http://www.perlmonks.org/?node_id=175651 for isa function
453
#      if ( UNIVERSAL::isa( $$hashRef{$key}, 'HASH' ) ) { # is the value another hash?
454
#            # NOTE: unlike xml, indentation is NOT optional in YAML, so the following line verifies $indentlevel is non-zero
455
#            #       and, if it is, uses a default 3 character indentation
456
#            $output .= (' ' x $indent ) . &escapeForYAML($key) . ":\n" . # key, plus colon, plus newline
457
#                    &hashToYAML( $$hashRef{$key}, $indent+($indentLevel ? $indentLevel : 3) ) . # add results of recursive call
458
#                    "\n";
459
#      } elsif ( UNIVERSAL::isa( $$hashRef{$key}, 'ARRAY' ) ) { # is it an array? ignore it
460
#      } else { # it is a scalar, so just do <key>value</key>
461
#         $output .= (' ' x $indent ) . &escapeForYAML($key) . ': ' . &escapeForYAML($$hashRef{$key}) . "\n";
462
#      }
463
#   }
464
#   return $output;
465
#}
2 rodolico 466
 
467
 
468
#######################################################
469
#
470
# tabDelimitedToHash ($hashRef, $tabdelim)
471
#
472
# Takes a tab delimited multi line string and adds it
473
# to a hash. The final field in each line is considered to
474
# be the value, and all prior fields are considered to be
475
# hierachial keys.
476
#
477
# Parameters
478
#     $hashref - reference (address) of a hash
479
#     $tabdelim - A tab delimited, newline terminated set of records
480
#
481
#
482
#######################################################
483
sub tabDelimitedToHash {
484
   my ($hashRef, $tabdelim) = @_;
135 rodolico 485
   &logIt( 3, "Entering tabDelimitedToHash" );
2 rodolico 486
   foreach my $line ( split( "\n", $tabdelim ) ) { # split on newlines, then process each line in turn
487
      $line =~ s/'/\\'/gi; # escape single quotes
28 rodolico 488
      my @fields = split( / *\t */, $line ); # get all the field values into array
2 rodolico 489
      my $theValue = pop @fields; # the last one is the value, so save it
490
      # now, we build a Perl statement that would create the assignment. The goal is
491
      # to have a string that says something like $$hashRef{'key'}{'key'} = $value;
492
      # then, eval that.
493
      my $command = '$$hashRef'; # start with the name of the dereferenced hash (parameter 1)
494
      while (my $key = shift @fields) { # while we have a key, from left to right
495
         $command .= '{' . "'$key'" . '}'; # build it as {'key'} concated to string
496
      }
497
      $command .= "='$theValue';"; # add the assignment
498
      #print STDERR "$command\n"; 
499
      eval $command; # eval the string to make the actual assignment
500
   }
501
}
502
 
503
#######################################################
504
#
13 rodolico 505
# validatePermission ( $file )
506
#
507
# Checks that file is owned by root, and has permission
508
# 0700 or less
509
# 
510
# Returns empty string on success, error message
511
# on failure
512
#
513
#######################################################
514
 
515
sub validatePermission {
516
   my $file = shift;
135 rodolico 517
   &logIt( 3, "Entering validatePermission with $file" );
14 rodolico 518
   my $return;
13 rodolico 519
   # must be owned by root
28 rodolico 520
   my $owner = (stat($file))[4];
13 rodolico 521
   $return .= " - Bad Owner [$owner]" if $owner;
522
   # must not have any permissions for group or world
523
   # ie, 0700 or less
28 rodolico 524
   my $mode = (stat($file))[2];
13 rodolico 525
   $mode = sprintf( '%04o', $mode & 07777 );
526
   $return .= " - Bad Permission [$mode]" unless $mode =~ m/0.00/;
527
   return $return ? $file . $return : '';
528
}
529
 
530
#######################################################
531
#
2 rodolico 532
# ProcessModules ( $system, $moduleDir )
533
#
534
# Processes all modules in $moduleDir, adding result to $system hash
535
# 
536
# Parameters
537
#     $system - reference (address) of a hash
538
#     $moduleDir - full path to a directory containing executable scripts
539
#  
540
# Each file in the $moduleDir directory that matches the regex in the grep
541
# and is executable is run. It is assumed the script will return 0 on success
542
# or a non-zero on failure
543
# The output of the script is assumed to be a tab delimited, newline separated
544
# list of records that should be added to the hash $system. This is done by calling 
545
# &parseModule above.
546
# on failure, the returned output of the script is assumed to be an error message
547
# and is displayed on STDERR
548
#######################################################
549
sub ProcessModules {
550
   my ( $system, $moduleDir ) = @_;
135 rodolico 551
   &logIt( 3, "Entering processModules" );
2 rodolico 552
   # open the module directory
47 rodolico 553
   return unless -d $moduleDir;
2 rodolico 554
   opendir( my $dh, $moduleDir ) || die "Module Directory $moduleDir can not be opened: $!\n";
555
   # and get all files which are executable and contain nothing but alpha-numerics and underscores (must begin with alpha-numeric)
556
   my @modules = grep { /^[a-zA-Z0-9][a-zA-Z0-9_]+$/ && -x "$moduleDir/$_" } readdir( $dh );
557
   closedir $dh;
28 rodolico 558
   foreach my $modFile ( sort @modules ) { # for each valid script
14 rodolico 559
      if ( my $error = &validatePermission( "$moduleDir$modFile" ) ) {
13 rodolico 560
         print STDERR "Not Processed: $error\n";
561
         next;
562
      }
135 rodolico 563
      &logIt( 3, "Processing module $moduleDir$modFile");
2 rodolico 564
      my $output = qx/$moduleDir$modFile $moduleDir/; # execute it and grab the output
565
      my $exitCode = $? >> 8; # process the exitCode
37 rodolico 566
      # exitCode 0 - processed normally
567
      # exitCode 1 - not applicable to this machine
568
      if ( $exitCode && $exitCode > 1) { # if non-zero, error, so show an error message
2 rodolico 569
         warn "Error in $moduleDir$modFile, [$output]\n";
135 rodolico 570
         &logIt( 0, "Error in $moduleDir$modFile, [$output]" );
2 rodolico 571
      } else { # otherwise, call tabDelimitedToHash to save the data
572
         &tabDelimitedToHash( $system, $output );
21 rodolico 573
      } # if
574
   } # foreach
575
   # add sysinfo-client (me) to the software list, since we're obviously installed
576
   &tabDelimitedToHash( $system, "software\tsysinfo-client\tversion\t$main::VERSION\n" );
2 rodolico 577
}
578
 
20 rodolico 579
sub processParameters {
580
   while ( my $parameter = shift ) {
581
      if ( $parameter eq '-v' ) {
582
         print "$main::VERSION\n";
583
         exit;
584
      }
585
   } # while
586
}
587
 
588
&processParameters( @ARGV );
589
 
14 rodolico 590
# load the configuration file
112 rodolico 591
%configuration = %{ &loadConfigurationFile( $configurationFile, @confFileSearchPath) };
135 rodolico 592
 
2 rodolico 593
# user did not define a serial number, so make something up
59 rodolico 594
$configuration{'serialNumber'} = '' unless $configuration{'serialNumber'};
2 rodolico 595
# oops, no client name (required) so tell them and exit
61 rodolico 596
die "No client name defined in $configurationFile" unless $configuration{'clientName'};
2 rodolico 597
 
135 rodolico 598
&logIt( 0, 'Starting sysinfo Run' );
599
&logIt( 3, "Configuration is\n" . Data::Dumper->Dump( [\%configuration], [ qw($configuration) ] ) );
600
 
61 rodolico 601
$TESTING = $configuration{'TESTING'} if defined $configuration{'TESTING'};
602
 
135 rodolico 603
&logIt( 0, "Testing => $TESTING" ) if $TESTING;
76 rodolico 604
 
605
 
2 rodolico 606
my $System; # hash reference that will store all info we are going to send to the server
607
# some defaults.
135 rodolico 608
$System->{'report'}->{'version'} = $DATA_VERSION;
609
$System->{'report'}->{'date'} = $reportDate;
610
$System->{'report'}->{'client'} = $configuration{'clientName'};
611
$System->{'system'}->{'hostname'} = $configuration{'hostname'};
612
$System->{'system'}->{'serial'} = $configuration{'serialNumber'};
613
$System->{'system'}->{'UUID'} = $configuration{'UUID'};
2 rodolico 614
 
135 rodolico 615
&logIt( 3, "Initial System\n" . Data::Dumper->Dump( [$System], [qw( $System )] ) );
616
 
2 rodolico 617
# process any modules in the system
59 rodolico 618
foreach my $moduleDir ( @{$configuration{'moduleDirs'}} ) {
135 rodolico 619
   &logIt( 3, "Processing modules from $moduleDir" );
13 rodolico 620
   &ProcessModules( $System, "$moduleDir/" );
621
}
2 rodolico 622
 
135 rodolico 623
&logIt( 4, "After processing modules\n" . Data::Dumper->Dump( [$System], [qw( $System )] ) );
624
 
2 rodolico 625
# now, everything ins in $System, so convert it to the proper output format
112 rodolico 626
#my $out = "#sysinfo: $VERSION YAML\n---\n" . &hashToYAML( $System ) . "...\n";
2 rodolico 627
 
112 rodolico 628
my $out =  "#sysinfo: $VERSION YAML\n" . Dump( $System );
629
 
135 rodolico 630
&logIt( 4, 'At line number ' . __LINE__ . "\n" . Data::Dumper->Dump([$System],[qw($System)]) );
2 rodolico 631
 
19 rodolico 632
# load some global values for use in the script, if required
633
my $globals = { 
634
      'data version' => $DATA_VERSION,
635
      'report date'  => $reportDate,
59 rodolico 636
      'client name'  => $configuration{'clientName'},
637
      'host name'    => $configuration{'hostname'},
61 rodolico 638
      'serial number'=> $configuration{'serialNumber'},
639
      'UUID'         => $configuration{'UUID'}
19 rodolico 640
      };
62 rodolico 641
 
135 rodolico 642
&logIt( 4, "Globals initialized\n" . Data::Dumper->Dump([$globals],[qw($globals)]) );
643
 
644
if ( $TESTING ) {
645
   open DATA, ">/tmp/sysinfo.testing.yaml" or die "Could not write to /tmp/sysinfo.testing.yaml: $!\n";
646
   print DATA $out;
647
   close DATA;
648
} else {
649
   # and send the results to the server
650
   if ( my $success = &sendResults( $globals, $configuration{'transports'}, $out, $configuration{'scriptDirs'} ) != 1 ) {
651
      &logIt( 0, "Error $success while sending report from $configuration{'hostname'}" );
652
   }
16 rodolico 653
}
2 rodolico 654
 
135 rodolico 655
&logIt( 0, 'Ending sysinfo Run' );
656
 
9 rodolico 657
1;