WebSVN – zfs_utils – Diff – /trunk/ZFS_Utils.pm

 #   makeReplicateCommands: create zfs send commands for replication based on snapshot lists
 # Exported functions and variables
-our @EXPORT_OK = qw(loadConfig shredFile mountDriveByLabel mountGeli logMsg runCmd makeReplicateCommands $logFileName $displayLogsOnConsole);
+our @EXPORT_OK = qw(loadConfig shredFile mountDriveByLabel mountGeli logMsg runCmd makeReplicateCommands sendReport $logFileName $displayLogsOnConsole);
 our $VERSION = '0.2';
 our $logFileName = '/tmp/zfs_utils.log'; # this can be overridden by the caller, and turned off with empty string
 our $displayLogsOnConsole = 1; # if non-zero, log messages are also printed to console
        close $logfh;
+    }
     print "$timestamp\t$msg\n" if ($displayLogsOnConsole);
+}
-# find a drive by it's label by scanning /dev/gpt/ for $timeout seconds.
+# find a drive by it's label by scanning /dev/gpt/
+# driveInfo is a hashref with the following keys:
+# label - the GPT label of the drive (required)
+# filesystem - the filesystem type (default: ufs)
+# mountPath - where to mount the drive (default: /mnt/label)
+# timeout - how long to wait for the drive (default: 600 seconds)
+# check_interval - how often to check for the drive (default: 15 seconds)
 # If the drive is found, mount it on mountPath and return the mountPath.
 # If not found, return empty string.
 sub mountDriveByLabel {
-   my ($label, $mountPath, $timeout, $checkEvery, $filesystem ) = @_;
+   my ( $driveInfo ) = @_;
-   unless ($label) {
+   unless ($driveInfo->{label}) {
-      logMsg("mountDriveByLabel: No label provided");
+      logMsg("mountDriveByLabel: No drive label provided");
       return '';
+   }
-   unless ( $label =~ /^[a-zA-Z0-9_\-]+$/ ) {
+   unless ( $driveInfo->{label} =~ /^[a-zA-Z0-9_\-]+$/ ) {
-      logMsg("mountDriveByLabel: Invalid label '$label'");
+      logMsg("mountDriveByLabel: Invalid label '$driveInfo->{label}'");
       return '';
+   }
-   logMsg("mountDriveByLabel: Looking for drive with label '$label'");
+   logMsg("mountDriveByLabel: Looking for drive with label '$driveInfo->{label}'");
    # default to /mnt/label if not provided
-   $mountPath //= "/mnt/$label"; # this is where we'll mount it if we find it
+   $driveInfo->{mountPath} //= "/mnt/$driveInfo->{label}"; # this is where we'll mount it if we find it
-   $filesystem //= 'ufs'; # default to mounting ufs
+   $driveInfo->{filesystem} //= 'ufs'; # default to mounting ufs
    # The location for the label depends on filesystem. Only providing access to ufs and msdos here for safety.
    # gpt labeled drives for ufs are in /dev/gpt/, for msdosfs in /dev/msdosfs/
-   $label = $filesystem eq 'msdos' ? "/dev/msdosfs/$label" : "/dev/gpt/$label";
+   $driveInfo->{mountPath} = $driveInfo->{filesystem} eq 'msdos' ? "/dev/msdosfs/$driveInfo->{label}" : "/dev/gpt/$driveInfo->{label}";
    # drive already mounted, just return the path
-   return $mountPath if ( runCmd( "mount | grep '$mountPath'" ) );
+   return $driveInfo->{mountPath} if ( runCmd( "mount | grep '$driveInfo->{mountPath}'" ) );
    # default to 10 minutes (600 seconds) if not provided
-   $timeout //= 600;
+   $driveInfo->{timeout} //= 600;
    # default to checking every minute if not provided
-   $checkEvery //= 15;
+   $driveInfo->{check_interval} //= 15;
    # wait up to $timeout seconds for device to appear, checking every 10 seconds
-   while ( $timeout > 0 ) {
+   while ( $driveInfo->{timeout} > 0 ) {
-      if ( -e "$label" ) {
+      if ( -e "$driveInfo->{label}" ) {
          last;
       } else {
-         sleep $checkEvery;
+         sleep $driveInfo->{check_interval};
-         $timeout -= $checkEvery;
+         $driveInfo->{timeout} -= $driveInfo->{check_interval};
-         print "Waiting for drive labeled $label\n";
+         print "Waiting for drive labeled $driveInfo->{label}\n";
+      }
+    }
     # if we found it, mount and return mount path
-    if ( -e "$label" ) {
+    if ( -e "$driveInfo->{label}" ) {
        # ensure mount point
-       unless ( -d $mountPath || make_path($mountPath) ) {
+       unless ( -d $driveInfo->{mountPath} || make_path($driveInfo->{mountPath}) ) {
-         logMsg("Failed to create $mountPath: $!");
+         logMsg("Failed to create $driveInfo->{mountPath}: $!");
          return '';
+       }
        # mount device (let mount detect filesystem)
-       unless ( runCmd( "mount -t $filesystem $label $mountPath" ) ) {
+       unless ( runCmd( "mount -t $driveInfo->{filesystem} $driveInfo->{label} $driveInfo->{mountPath}" ) ) {
-         logMsg("Failed to mount $label on $mountPath: $!");
+         logMsg("Failed to mount $driveInfo->{label} on $driveInfo->{mountPath}: $!");
          return '';
+       }
-       return $mountPath;
+       return $driveInfo->{mountPath};
     } else {
        return '';
+    }
+}
    # return arrayref of commands (caller can iterate or join with pipes)
    return \%commands;
+}
+# Send report via email and/or copy to target drive.
+# $reportConfig is a hashref with optional keys:
+#   email - email address to send report to
+#   targetDrive - hashref with keys:
+#       label - GPT or msdosfs label of the target drive
+#       mount_point - optional mount point to use (if not provided, /mnt/label is used)
+# $subject is the email subject
+# $logFile is the path to the log file to send/copy
+sub sendReport {
+   my ( $reportConfig, $subject, $logFile ) = @_;
+   return unless defined $reportConfig;
+   if ( defined $reportConfig->{email} && $reportConfig->{email} ne '' ) {
+      sendEmailReport( $reportConfig->{email}, $subject, $logFile );
+   }
+   if ( defined $reportConfig->{targetDrive} ) {
+      my $mountPoint = mountDriveByLabel( $reportConfig->{targetDrive}->{label}, $reportConfig->{targetDrive}->{mount_point}, 300 );
+      if ( defined $mountPoint ) {
+         copyReportToDrive( $logFile, $mountPoint );
+         `umount $mountPoint`;
+         rmdir $mountPoint;
+      } else {
+         logMsg( "Warning: could not mount report target drive with label '$reportConfig->{targetDrive}->{label}'" );
+      }
+   }
+}
+# Copy the report log file to the specified mount point.
+# $logFile is the path to the log file to copy.
+# $mountPoint is the mount point of the target drive.
+# Does nothing if log file or mount point are invalid.
+sub copyReportToDrive {
+   my ( $logFile, $mountPoint ) = @_;
+   return unless defined $logFile && -e $logFile;
+   return unless defined $mountPoint && -d $mountPoint;
+   my $targetFile = "$mountPoint/" . ( split( /\//, $logFile ) )[-1];
+   logMsg( "Copying report log file $logFile to drive at $mountPoint" );
+   unless ( copy( $logFile, $targetFile ) ) {
+      logMsg( "Could not copy report log file to target drive: $!" );
+   }
+}
+# Send an email report with the contents of the log file.
+# $to is the recipient email address.
+# $subject is the email subject.
+# $logFile is the path to the log file to send.
+# Does nothing if any parameter is invalid.
+sub sendEmailReport {
+   my ( $to, $subject, $logFile ) = @_;
+   return unless defined $to && $to ne '';
+   return unless defined $subject && $subject ne '';
+   return unless defined $logFile && -e $logFile;
+   logMsg( "Sending email report to $to with subject '$subject'" );
+   open my $mailfh, '|-', '/usr/sbin/sendmail -t' or do {
+      logMsg( "Could not open sendmail: $!" );
+      return;
+   };
+   print $mailfh "To: $to\n";
+   print $mailfh "Subject: $subject\n";
+   print $mailfh "MIME-Version: 1.0\n";
+   print $mailfh "Content-Type: text/plain; charset=\"utf-8\"\n";
+   print $mailfh "\n"; # end of headers
+   open my $logfh, '<', $logFile or do {
+      logMsg( "Could not open log file $logFile for reading: $!" );
+      close $mailfh;
+      return;
+   };
+   while ( my $line = <$logfh> ) {
+      print $mailfh $line;
+   }
+   close $logfh;
+   close $mailfh;
+}
 ;

Subversion Repositories zfs_utils

(root)/trunk/ZFS_Utils.pm – Rev 34 → 35