Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

(code) Win32 disk monitor, email notify, event log

by ybiC (Prior)
on Jul 16, 2002 at 00:38 UTC ( #181972=sourcecode: print w/ replies, xml ) Need Help??

Category: Win32 Stuff
Author/Contact Info ybiC
Description:

Check free disk space on a Win32 localhost.   Automatically detects and checks all fixed disk drives (hard disks or partitions with assigned drive letters).   Optional email notification on alarum and Event Log entry on program run.   Intended to run as a periodically scheduled task.   Clearly not a replacement for expensive commercial monitoring packages, but potentially beneficial for small business with a single Win32 file/print server.

If you spot any signs of PERL-ly code here and let me know, I'll make sure to mention your help here and in pod credits
    Props to thunders for join() tip,
    Kanji for spotting 0-bytes-free bug,
    and to fsn for mondo SMTP info/tips/help,

Email alarum looks something like this:

Envelope-to: pastor@church.org
To: pastor@church.org
From: wdf.pl@myserver
Subject: ALERT - MYSERVER DISK SPACE GETTING LOW
Date: Mon, 15 Jul 2002 20:01:04 -0500

This message was automatically generated by the wdf.pl program.
pastor@church.org
officemgr@church.org

    MYSERVER
  D:\ less than 30% free space

      C:\
    57 percent used
    43 percent free

    5,132,570,624 bytes total
    2,909,786,112 bytes used
    2,222,784,512 bytes free

      D:\
    80 percent used
    20 percent free

    20,412,596,224 bytes total
    16,364,945,408 bytes used
    4,047,650,816 bytes free

Update:
Squashed Bugs:   no-alarum-on-0-bytes-free, non-functional email option
New Features:   Event Logging, argument for nearby SMTP server

#!perl

# wdf.pl
# pod at tail


use warnings;            # avoid D'oh! bugs
use strict;              # avoid D'oh! bugs
use Win32::AdminMisc;    # host+drive stuff    (www.roth.net/perl/pack
+ages)
use Win32::EventLog;     # log program runs        (core ActivePerl mo
+dule)
use POSIX;               # round decimal places    (core ActivePerl mo
+dule)
use Net::SMTP;           # email notification      (core ActivePerl mo
+dule)
use File::Spec;          # strip path from $0      (core ActivePerl mo
+dule)
use Tie::IxHash;         # ordered hash            (core ActivePerl mo
+dule)
use Getopt::Long;        # options & arguments     (core ActivePerl mo
+dule)
use Pod::Usage;          # elim redundant Usage()  (core ActivePerl mo
+dule)
$|++;                    # make STDOUT hot
my $VERSION = '0.09.07';


 ## PRELIMINARIES ##
my $host = Win32::AdminMisc::GetComputerName();
my ($notUsed,$not_used,$program) = File::Spec->splitpath( $0 );


 ## OPTIONS+ARGUMENTS ##
my ($arg_lowFree, @arg_recipients, $arg_smtp);
my ($opt_eventLog, $opt_versions, $opt_help, $opt_man);
GetOptions(
  'lowfree=i'   => \$arg_lowFree,
  'recipient=s' => \@arg_recipients,
  'smtp=s'      => \$arg_smtp,
  'eventlog!'   => \$opt_eventLog,
  'versions!'   => \$opt_versions,
  'help!'       => \$opt_help,
  'man!'        => \$opt_man,
) or pod2usage(-verbose => 1) && exit;
push my @eventLogStrings, "  = $program run started =" if($opt_eventLo
+g);
pod2usage(-verbose => 1) && exit if $opt_help;
pod2usage(-verbose => 2) && exit if $opt_man;
pod2usage(-verbose => 1) && exit unless $arg_lowFree && $arg_lowFree >
+ 0;
$arg_smtp = $host unless $arg_smtp;




 ## QUERY DRIVES, GEN INDIVIDUAL DRIVE REPORTS ##
my (@report, @lowDrives);
my @drives=Win32::AdminMisc::GetDrives(DRIVE_FIXED);
for my $drive(@drives){
  my ($total, $free) = Win32::AdminMisc::GetDriveSpace($drive);
  next unless $total;
  my $used           = $total-$free;
  my $percentUsed    = Round(($used/$total)*100);
  my $percentFree    = Round(($free/$total)*100);
  my($cTotal, $cUsed, $cFree) = Commify(Round($total, $used, $free));

  my $report = "
    $drive
  $percentUsed percent used
  $percentFree percent free

  $cTotal bytes total
  $cUsed bytes used
  $cFree bytes free";
  push @report, $report;
  push @lowDrives, $drive if($percentFree < $arg_lowFree);
}


 ## COMBINE INDIVIDUAL REPORTS INTO MESSAGE ##
my $low    = @lowDrives > 0 ? join(' and ', @lowDrives) : 'No';
my $plural = @lowDrives == 1 ? '' : 's';
my $alarum = "  $host $low drive$plural less than ${arg_lowFree}% free
+ space";
unshift @report, $alarum;
my $message = join("\n", @report);
print "\n$message\n";
push @eventLogStrings, "  = $program report =\n$message" if($opt_event
+Log);


 ## OPTIONAL EMAIL NOTIFICATION ##
if(@arg_recipients && @lowDrives > 0){
  my $autoMsg = 
    "Message automatically generated by $program program and sent to:"
+;
  my $recipListMsg = join("\n  ", @arg_recipients);
  for my $recipient(@arg_recipients){    
    print "Sending message to $recipient... ";
    if(my $smtp = new Net::SMTP($arg_smtp)){
      $smtp->mail("$program\@$host");
      $smtp->to($recipient);
      $smtp->data();
      $smtp->datasend("To: $recipient\n");
      $smtp->datasend("Subject: ALERT - $host DISK SPACE GETTING LOW\n
+");
      $smtp->datasend("\n");
      $smtp->datasend("\n$autoMsg\n  $recipListMsg\n\n$message");
      $smtp->dataend();
      $smtp->quit();
      print "successful";
      push @eventLogStrings, "  = $program sent email to $recipient"
        if($opt_eventLog);
    } else {
      print "failed";
      push @eventLogStrings, "ERROR  = $program failed to email $recip
+ient ="
        if($opt_eventLog);
    }
    print "\n";
  }
}


 ## WRAP IT UP ##
END{
  my @verMsg = (
    "\nVersions info:",
    "  Win32::AdminMisc         $Win32::AdminMisc::VERSION",
    "  Win32::EventLog          $Win32::EventLog::VERSION",
    "  POSIX                    $POSIX::VERSION",
    "  Net::SMTP                $Net::SMTP::VERSION",
    "  File::Spec               $File::Spec::VERSION",
    "  Getopt::Long             $Getopt::Long::VERSION",
    "  Pod::Usage               $Pod::Usage::VERSION",
    "  Perl                     $]",
    "  wdf.pl                   $VERSION",
    "  $^O",
  );
  tie my %winVer, "Tie::IxHash";
  %winVer = Win32::AdminMisc::GetWinVersion;
  for my $key (keys %winVer) {
    push @verMsg, "    $key - $winVer{$key}";
    }
  my $verMsg = join("\n", @verMsg);
  print $verMsg if($opt_versions);


   ## OPTIONAL EVENT LOGGING ##
  if($opt_eventLog){
    push @eventLogStrings, "  = $program run complete =";
    my $strings = join("\n", @eventLogStrings);
    my $eventType =
      @lowDrives > 0 ?'EVENTLOG_WARNING_TYPE':'EVENTLOG_INFORMATION_TY
+PE';
    Win32::EventLog::Open( my $event )
      or warn 'fail on Win32::EventLog::Open()';
    $event->Report({
      Computer  => $host,
      Source    => $program,
      EventType => $eventType,                                 ## FIXM
+E ##
      Strings   => "\n\n$strings\n$verMsg",
    }) or warn 'fail on Win32::EventLog::Report()';
    ## $event->Close or warn 'fail on Win32::EventLog::Close'; ## FIXM
+E ##
  }
}

######################################################################
+####
# Round long-decimal numbers for legibility:
# (from Math::Round source)
sub Round {
  my $halfhex = unpack('H*', pack('d', 0.5));
  my $half    = unpack('d',pack('H*', $halfhex));
  my $x;
  my @res = ();
  for $x (@_) {
    if ($x >= 0) { push @res, POSIX::floor($x + $half);
    } else {       push @res, POSIX::ceil ($x - $half);
    }
  }
  return (wantarray) ? @res : $res[0];
}
######################################################################
+####
# Insert commas in long numbers for legibility:
sub Commify {
  my @output;
  for(@_){
    my $input = $_;
    $input = reverse $input;
    $input =~ s<(\d\d\d)(?=\d)(?!\d*\.)><$1,>g;
    $input = reverse $input;
    push @output, $input;
  }
  return @output;
}
######################################################################
+####


=head1 TITLE

wdf.pl - Check free disk space of all hard disks on a Win32 localhost

=head1 SYNOPSIS

 wdf <arguments> <options>

 eg; wdf.pl --versions --lowFree 15 --recipient pastor@church.org

 Arguments and options may be called by short or long form, or even mi
+xed
 eg;
   wdf --lowFree 5 --recipient admin@church.org --smtp mail.church.org
   wdf -l 5 -r admin@church.org -s mail.church.org
   wdf -l 5 --recipient admin@church.org -s mail.church.org

 Arguments accept an optional '='
 eg;
   wdf -lowFree=30
   wdf -lowFree 30

=head1 DESCRIPTION

Check free disk space of all hard disks on Win32 locallhost.
Optional email notification on low free space.
Optional Event Log entry on program run.
Intended to run periodically as a scheduled task.

=head1 ARGUMENTS

 --lowFree <positive_integer>
 --recipient <valid_email_address>
 --smtp <nearby_SMTP_server>

 "lowFree" is the minimum percentage of free disk space to check for.
 If there is less free space than this, print to console
 and optionally send email alert.

 "recipient" is the email address to send alert message to.
 Accepts only one argument, but can be specified multiple times:
 eg;  wdf -r pastor@church.org -r officemgr@church.org

 "smtp" is an IP address or name of a nearby SMTP server.
 Default value of localhost.

=head1 OPTIONS

 --eventlog   report results to Win32 Event Log
 --versions   print Modules, Perl, OS, Program info
 --help       print contents of pod USAGE, ARGUMENTS, OPTIONS
 --man        print pod in it's entiretya

=head1 WIN32 NOTES

 assoc .pl=Perl
 ftype Perl=c:\perl\bin\perl.exe "%1" %*
 pathext=.pl;
 path=c:\perl\bin\;

 ppm set repository ROTH http://www.roth.net/perl/packages
 ppm set save
 ppm install Win32-AdminMisc

 Login as administrator
 control panel, scheduler, runas specific_user

 at 06:00 /every:Th c:\perl\bin\perl.exe c:\perls\wdf.pl -e -l 25 -r u
+ser@host.dom

 pl2bat wdf.pl

=head1 SMTP NOTES

 telnet mailserver.dom.tld 25
 220 mailserver.dom.tld ESMTP
 helo client.dom.tld
 250 OK
 mail from: user1@dom.tld
 250 Sender OK
 rcpt to: user2@dom.tld
 250 Recipient OK
 testing, testing, 1... 2... 3
 .
 250 Message accepted for deliver
 quit
 221 mailserver.dom.tld closing connection

=head1 TESTED

 OS               Win2kPro sp2
                  NT4.0 sp6
 Perl             ActivePerl 5.6.1
 Win32::AdminMisc 20000708
 POSIX            1.03
 Net::SMTP        2.19
 File::Spec       0.82
 Pod::Usage       1.14
 Getopt::Long     2.25

=head1 AUTHOR

ybiC

=head1 CREDITS

 Thanks to:
  thunders for join() tip,
  Kanji for pointing out 0-bytes-free bug of 'if($total && $free){...}
+',
  fsn for mondo SMTP info/tips/help,
  Dave Roth for writing Win32 Perl (Scripting|Programming) books.
  And to some guy named vroom

=head1 TODO

   Confirm NT 'at' entries remain after reboot
   Debug specified-EventType-ignored, 'none' shown by EventViewer
   Debug NT4-eventlog-no-line-endings
   Debug 'fail on Win32::EventLog::Close'
   Provide Message.dll for message table (Win32::EventLog::Message)
     use Win32::EventLog::Message;
     RegisterSource( 'System', 'My Perl Source' );
       $Event->Report( {
          EventID     => EVENT_ID,
          Strings     => "Everything is okay.\nReally, it's okay.",
          EventType   => EVENTLOG_SUCCESS_TYPE,
       });
     UnRegisterSource( 'System', 'My Perl Source' );
   More informative Net::SMTP errors

=head1 UPDATES

 2002-07-13   21:50 CDT
   Initial working code

 2002-07-19   10:05 CDT
   Rework email notify for standard Net::SMTP instead of Mail::Sender
   Programatically include server name in message
   Debug email notification (bad sender format)
   Debug email subject naming smtp host as having low drive space
   Strip dir path from $0 (down to just wdf.pl)
   Unshift $alarum into @message before join-ing @message into $messag
+e
   Borrow code from Math::Round for Round()
   Borrow code from Sys::Hostname for hostName()
   Getopt::Long and Pod::Usage
   Debug program continues to run even if required args not provided
   Eliminate $opt_useMail.  Instead, check for @recipient
   Protect against divide-by-zero from potential drive problem
     if($total && $free){...}
   Win32::AdminMisc::GetDrives(DRIVE_FIXED) instead of @arg_drives
   Win32::AdminMisc::GetComputerName() instead of hostName()
   Check for $arg_lowFree to be *positive* number
   Post to PerlMonks Code Catacombs, requesting PERL-ectomy
   Squash 0-bytes-free bug
     replace 'if($total && $free){...}'
     with 'next unless $total;'
   Intelligent singular/plural on 'less than n% free' message
   Event Log of program start, message, notify and completion
   Test from Win2k 'at' and Task Scheduler (success)
   Unsubify eventLog(), combine all into one message
   Eliminate 'uninit value' from 'pod2usage(...) unless $arg_lowFree >
+ 0'
   Event Log of per-user email success/fail
   Test on church NT4+Exchange server
   Test from WinNT4 'at' (success)
   Getopt argument for nearest SMTP server, default of localhost

=cut

Comment on (code) Win32 disk monitor, email notify, event log
Download Code
Re: Win32 low disk-space-free, with email notification
by Kanji (Parson) on Jul 16, 2002 at 02:08 UTC
    my @drives=Win32::AdminMisc::GetDrives(DRIVE_FIXED);

    If you have any SUBSTed 'drives', GetDrives() will list those as if they were additional drives, which may or may not be what you want (I imagine it'd matter more if you had seperate alarms for each drive).

    I'm not familiar with Win32::AdminMisc, but I got around this using Win32::DriveInfo's VolumeInfo...

    foreach my $drive ( Win32::DriveInfo::DrivesInUse ) { next unless Win32::DriveInfo::DriveType($drive) == FIXED_DISK; my $serial = (Win32::DriveInfo::VolumeInfo($drive))[1]; next if $seen{$serial}++; }

    Also, what happens if you have 0 bytes free? Won't the below cause your script to skip over it? (Forgive my ignorance if GetDriveSpace() returns some sort of '0 but true' string instead...)

      if($total && $free){

        --k.


Back to Code Catacombs

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: sourcecode [id://181972]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others musing on the Monastery: (8)
As of 2014-08-22 23:09 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (168 votes), past polls