Subversion Repositories camp_sysinfo_client_3

Rev

Rev 254 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 254 Rev 256
Line 1... Line 1...
1 
#!/usr/bin/env perl
 1 
#!/usr/bin/env perl
2 
use warnings;
 2 
use warnings;
3 
use strict;
3 
use strict;
4 
 
 4 
 
5 
# Description: Basic template for modules. Do NOT enable
 5 
use version ; our $VERSION = 'v1.0.0';
6 
 
 6 
 
- 
 
 7 
# Template for modules to be used in sysinfo
7 
our $VERSION = '1.2';
 8 
# Author: R. W. Rodolico
- 
 
 9 
# Date:   2025-04-02
- 
 
 10 
#
- 
 
 11 
# Enter some information about system here
- 
 
 12 
#
- 
 
 13 
# Revision History
- 
 
 14 
#
- 
 
 15 
# 20250402 v4.0.0 Rodolico
- 
 
 16 
# Modified for v4 of sysinfo_client, using extended tests for modules, files used and operating systems
- 
 
 17 
# Underlying code remains unchanged
- 
 
 18 
#
8 
 
 19 
 
9 
exit 1; # remove this before using
 - 
 
10 
 
 - 
 
11 
# Put some comments here on who wrote it and what it does
 20 
# find our location and use it for searching for libraries. library.pm must be in the same directory as the calling script
12 
 
 - 
 
13 
# find our location and use it for searching for libraries
 21 
# or, if run interactively, in the parent of the modules
14 
BEGIN {
 22 
BEGIN {
15 
   use FindBin;
 23 
   use FindBin;
16 
   use File::Spec;
 24 
   use File::Spec;
- 
 
 25 
   # prepend the bin directory and its parent
17 
   use lib File::Spec->catdir($FindBin::Bin);
 26 
   use lib File::Spec->catdir($FindBin::Bin), File::Spec->catdir("$FindBin::Bin/..");
18 
   eval( 'use library;' );
 27 
   eval( 'use library;' );
19 
   die "Could not find library.pm in the module directory\n" if $@;
 28 
   die sprintf( "Could not find library.pm in %s, INC is %s\n", __FILE__, join( "\n", @INC ) ) if $@;
20 
   eval( 'use Data::Dumper;' );
 - 
 
21 
}
 29 
}
22 
 
 30 
 
- 
 
 31 
#####
- 
 
 32 
##### Change these to match your needs
- 
 
 33 
#####
- 
 
 34 
 
- 
 
 35 
# Make this a list of all the modules we are going to use. You can replace undef with the version you need, if you like
- 
 
 36 
my $modulesList = {
- 
 
 37 
        'Data::Dumper'     => undef,
- 
 
 38 
   };
- 
 
 39 
 
- 
 
 40 
# hash of commands that are needed for the system. key is the name of the command and, in some cases, the value will become
- 
 
 41 
# the full path (from which or where)
- 
 
 42 
my $commandsList = {
- 
 
 43 
        'dpkg' => undef,
- 
 
 44 
        'grep' => undef,
- 
 
 45 
   };
- 
 
 46 
 
23 
# check for valid OS. Remove any OS' this module is not valid for
 47 
# list of operating systems this module can be used on.
- 
 
 48 
my $osList = {
- 
 
 49 
#         'mswin32' => undef,
- 
 
 50 
         'freebsd' => undef,
- 
 
 51 
#         'linux'   => undef,
- 
 
 52 
   };
- 
 
 53 
 
24 
exit 1 unless &checkOS( { 'linux' => undef, 'freebsd' => undef, 'mswin32' => undef } );
 54 
# the category the return data should go into. See sysinfo for a list
- 
 
 55 
my $CATEGORY = 'software';
- 
 
 56 
 
- 
 
 57 
#####
- 
 
 58 
##### End of required
- 
 
 59 
#####
25 
 
 60 
 
- 
 
 61 
# some variables needed for our system
26 
# check for required commands, return 2 if they don't exist. Enter an full list of all commands required. If one doesn't exist
 62 
my $errorPrepend = 'error: in ' . __FILE__; # this is prepended to any error messages
27 
# script exits and returns an exit code of 2
 63 
my @out; # temporary location for each line of output
- 
 
 64 
 
- 
 
 65 
# Try to load the modules we need. If we can not, then make a list of missing modules for error message.
28 
foreach my $command ( 'sysctl', 'df' ) {
 66 
for my $module ( keys %$modulesList ) {
- 
 
 67 
   eval ( "use $module;" );
29 
   exit 2 unless &validCommandOnSystem( $command );
 68 
   push @out, "$errorPrepend Could not load $module" if $@;
30 
}
 69 
}
31 
 
 70 
 
32 
# category we will use for all values found
 - 
 
33 
# see sysinfo for a list of valid categories
 - 
 
34 
my $CATEGORY = 'system';
 - 
 
35 
 
 - 
 
36 
# run the commands necessary to do whatever you want to do
 - 
 
37 
# The library entered above has some helper routines
 - 
 
38 
# validCommandOnSystem -- passed a name, returns the fully qualified path or '' if it does not exist
 - 
 
39 
# cleanUp - passed a delimiter and a string, does the following (delimiter can be '')
 - 
 
40 
#           chomps the string (removes trailing newlines)
 - 
 
41 
#           removes all text BEFORE the delimiter, the delimiter, and any whitespace
 - 
 
42 
#           thus, the string 'xxI Am x  a weird string' with a newline will become
 71 
if ( ! @out && ! checkOS ( $osList ) ) { # check if we are on an acceptible operating system
43 
#           'a weird string' with no newline
 - 
 
44 
 
 - 
 
45 
# now, return the tab delimited output (to STDOUT). $CATEGORY is the first
 - 
 
46 
# item, name as recognized by sysinfo is the second and the value is
 - 
 
47 
# the last one. For multiple entries, place on separate lines (ie, newline separated)
 - 
 
48 
 
 - 
 
49 
# Example of getting last_boot and uptime on a Unix system
 - 
 
50 
# exit status of 3 or greater means we could not get data for some reason
 - 
 
51 
if ( -d '/proc/uptime' ) {
 - 
 
52 
   my $uptime = qx(cat /proc/uptime);
 - 
 
53 
   $uptime =~ m/(\d+)/;
 - 
 
54 
   $uptime = int($1); # uptime now has the up time in seconds
 - 
 
55 
   print "$CATEGORY\tlast_boot\t" . (time - $uptime) . "\n";
 - 
 
56 
   print "$CATEGORY\tuptime\t" . $uptime . "\n";
 72 
    push @out, "$errorPrepend Invalid Operating System";
57 
   exit 0;
 - 
 
58 
} else {
 - 
 
59 
   exit 3;
 - 
 
60 
}
 73 
}
- 
 
 74 
if ( !@out && ! validCommandOnSystem ( $commandsList ) ) {
- 
 
 75 
   push @out, "$errorPrepend Can not find some commands needed";
- 
 
 76 
}
- 
 
 77 
if ( !@out ) { # we made it, we have everything, so do the processing
- 
 
 78 
   #####
- 
 
 79 
   ##### Your code starts here. Remember to push all output onto @out
- 
 
 80 
   #####
- 
 
 81
- 
 
 82 
   # sample for dpkg on Debian based systems
- 
 
 83 
   my @packages  = split( "\n", qx(dpkg -l | grep ^i) );
- 
 
 84 
   chomp @packages;
- 
 
 85 
 
- 
 
 86 
   for ( my $i = 0; $i < @packages; $i++ ) {
- 
 
 87 
      utf8::encode( $packages[$i] );
- 
 
 88 
      my ($status,$package, $version, @description) = split ' ', $packages[$i];
- 
 
 89 
      push @out, "$CATEGORY\t$package\tversion\t$version";
- 
 
 90 
      push @out, "$CATEGORY\t$package\tdescription\t" . join(" ", @description);
- 
 
 91 
   }
- 
 
 92
- 
 
 93 
   #####
- 
 
 94 
   ##### Your code ends here.
- 
 
 95 
   #####
- 
 
 96 
}
- 
 
 97 
 
- 
 
 98 
# If we are testing from the command line (caller is undef), print the results for debugging
- 
 
 99 
print join( "\n", @out ) . "\n" unless caller;
- 
 
 100 
# called by do, which has a value of the last assignment made, so make the assignment. The equivilent of a return
- 
 
 101 
my $return = join( "\n", @out );
61 
 
 102 
 
62 
# if you have not done an exit state above (1 indicating wrong operating system, 2 meaning the commands do not exist), do one
 - 
 
63 
# here (exit 0 indicates success)
 - 
 
64 
exit 0;
 -