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 sendReport $logFileName $displayLogsOnConsole $lastRunError);
+our @EXPORT_OK = qw(loadConfig shredFile mountDriveByLabel unmountDriveByLabel mountGeli logMsg runCmd makeReplicateCommands sendReport fatalError getDirectoryList cleanDirectory $logFileName $displayLogsOnConsole $lastRunError);
 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
     } else {
        return '';
+    }
+}
+# finds and unmounts a drive defined by $driveInfo.
+# on success, removes the mount point if empty.
+sub unmountDriveByLabel {
+   my ( $driveInfo ) = @_;
+   unless ($driveInfo->{label}) {
+      logMsg("unmountDriveByLabel: No drive label provided");
+      return '';
+   }
+   unless ( $driveInfo->{label} =~ /^[a-zA-Z0-9_\-]+$/ ) {
+      logMsg("unmountDriveByLabel: Invalid label '$driveInfo->{label}'");
+      return '';
+   }
+   logMsg("unmountDriveByLabel: Looking for drive with label '$driveInfo->{label}'");
+   # default to /mnt/label if not provided
+   $driveInfo->{mountPath} //= "/mnt/$driveInfo->{label}"; # this is where we'll mount it if we find it
+   runCmd( "mount | grep '$driveInfo->{mountPath}'" );
+   if ( $lastRunError ) {
+     logMsg("Drive with label '$driveInfo->{label}' is not mounted");
+     return '';
+   }
+   # unmount device
+   runCmd( "umount $driveInfo->{mountPath}" );
+   if ( $lastRunError ) {
+     logMsg("Failed to unmount $driveInfo->{mountPath}: $!");
+     return '';
+   }
+   # and remove the directory if empty (find command will return empty string or one filename)
+   rmdir $driveInfo->{mountPath} unless runCmd( "find $driveInfo->{mountPath} -mindepth 1 -print -quit");
+   return $driveInfo->{mountPath};
+}
 ## Load a YAML configuration file into a hashref.
 ## If the file does not exist, and a default hashref is provided,
 ## create the file by dumping the default to YAML, then return the default.
 sub loadConfig {
     my ($filename, $default) = @_;
 ;
                } or do {
                   logMsg("No YAML writer available (YAML::XS or YAML::Tiny). Could not create $filename");
                };
          };
          die "Failed to write default config to $filename:$!\n" unless $wrote;
-        }
+      } # if default
-        # No default provided; nothing to create
+      # No default provided; nothing to create
-        return {};
+      return {};
-    }
+   } # unless -e $filename
-    my $yaml;
+   my $yaml;
-    # Try YAML::XS first, fall back to YAML::Tiny
+   # Try YAML::XS first, fall back to YAML::Tiny
-    eval {
+   eval {
-        require YAML::XS;
+      require YAML::XS;
-        YAML::XS->import();
+      YAML::XS->import();
-        $yaml = YAML::XS::LoadFile($filename);
+      $yaml = YAML::XS::LoadFile($filename);
-        logMsg("using YAML::XS to load $filename");
+      logMsg("using YAML::XS to load $filename");
 ;
-    } or do {
+   } or do {
-        eval {
+      eval {
-            require YAML::Tiny;
+         require YAML::Tiny;
-            YAML::Tiny->import();
+         YAML::Tiny->import();
-            $yaml = YAML::Tiny->read($filename);
+         $yaml = YAML::Tiny->read($filename);
-            $yaml = $yaml->[0] if $yaml;  # YAML::Tiny returns an arrayref of documents
+         $yaml = $yaml->[0] if $yaml;  # YAML::Tiny returns an arrayref of documents
-            logMsg("using YAML::Tiny to load $filename");
+         logMsg("using YAML::Tiny to load $filename");
 ;
-        } or do {
+      } or do {
-            logMsg("No YAML parser installed (YAML::XS or YAML::Tiny). Skipping config load from $filename");
+         logMsg("No YAML parser installed (YAML::XS or YAML::Tiny). Skipping config load from $filename");
-            return ($default && ref $default eq 'HASH') ? $default : {};
+         return ($default && ref $default eq 'HASH') ? $default : {};
-        };
+      };
-    };
+   };
-    # Ensure we have a hashref
+   # Ensure we have a hashref
-    die "Config file $filename did not produce a HASH.\n" unless (defined $yaml && ref $yaml eq 'HASH');
+   die "Config file $filename did not produce a HASH.\n" unless (defined $yaml && ref $yaml eq 'HASH');
-    return $yaml;
+   return $yaml;
+}
 # Mount a GELI-encrypted ZFS pool.
 # $geliConfig - hashref containing configuration for geli
    chmod 0600, $target;
    return 1;
+}
+# make a bunch of replicate commands and return them to the caller as a list
+# $rootDataSet - string, the root of the snapshots exclusive of the dataset itself
+# $sourceSnapsRef
+# $statusRef
+# $newStatusRef
+# returns
 sub makeReplicateCommands {
-   my ($sourceSnapsRef, $statusRef, $newStatusRef) = @_;
+   my ( $sourceSnapsRef, $statusRef, $newStatusRef) = @_;
    $sourceSnapsRef ||= [];
    $statusRef     ||= [];
    $newStatusRef  ||= [];
+   $rootDataSet .= '/';
    # parse snapshots: each line is expected to have snapshot fullname as first token: pool/fs@snap ...
    my %snaps_by_fs;
    foreach my $line (@$sourceSnapsRef) {
       next unless defined $line && $line =~ /\S/;
 #   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
+# $message is the message to include in the email body
-# $logFile is the path to the log file to send/copy
+# $logFile is the path to the log file to include in the report
 sub sendReport {
-   my ( $reportConfig, $subject, $logFile ) = @_;
+   my ( $reportConfig, $message, $logFile ) = @_;
    return unless defined $reportConfig;
+   $logFile //= $reportConfig->{logFile};
    logMsg( "Beginning sendReport" );
-   # if they have set an e-mail address, try to e-mail the report
-   if ( defined $reportConfig->{email} && $reportConfig->{email} ne '' ) {
-      logMsg( "Sending report via e-mail to $reportConfig->{email}");
-      sendEmailReport( $reportConfig->{email}, $subject, $logFile );
-   }
    # if targetDrive defined and there is a valid label for it, try to mount it and write the report there
    if ( defined $reportConfig->{targetDrive} && defined $reportConfig->{targetDrive}->{label} && $reportConfig->{targetDrive}->{label} ) {
       logMsg( "Saving report to disk with label $reportConfig->{targetDrive}->{label}" );
       my $mountPoint = mountDriveByLabel( $reportConfig->{targetDrive}->{label}, $reportConfig->{targetDrive}->{mount_point}, 300 );
       if ( defined $mountPoint && $mountPoint ) {
          rmdir $mountPoint;
       } else {
          logMsg( "Warning: could not mount report target drive with label '$reportConfig->{targetDrive}->{label}'" );
+      }
+   }
+   # if they have set an e-mail address, try to e-mail the report
+   if ( defined $reportConfig->{email} && $reportConfig->{email} ne '' ) {
+      logMsg( "Sending report via e-mail to $reportConfig->{email}" );
+      $reportConfig->{subject} //= 'Replication Report from ' . `hostname`;
+      sendEmailReport( $reportConfig->{email}, $reportConfig->{subject}, $message, $logFile );
+   }
+}
 # 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.
 # $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 ) = @_;
+   my ( $to, $subject, $message, $logFile ) = @_;
    return unless defined $to && $to ne '';
    $subject //= 'Sneakernet Replication Report from ' . `hostname`;
+   $message //= '';
    $logFile //= '';
    logMsg( "Sending email report to $to with subject '$subject'" );
    open my $mailfh, '|-', '/usr/sbin/sendmail -t' or do {
       logMsg( "Could not open sendmail: $!" );
    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
+   print $mailfh "$message\n";
-   print $mailfh "Following is the report for replication\n\n";
+   print $mailfh "\nLog contents:\n\n";
    if ( -e $logFile && open my $logfh, '<', $logFile ) {
       while ( my $line = <$logfh> ) {
          print $mailfh $line;
+      }
       close $logfh;
    };
    close $mailfh;
+}
+# Get all file names (not directories) from a directory
+# $dirname is directory to scan
+# returns arrayref
+sub getDirectoryList {
+   my $dirname = shift;
+   opendir( my $dh, $dirname ) || return 0;
+   # get all file names, but leave directories alone
+   my @files = map{ $dirname . "/$_" } grep { -f "$dirname/$_" } readdir($dh);
+   closedir $dh;
+   return \@files;
+}
+# clean all files from a directory, but not any subdirectories
+sub cleanDirectory {
+   my $dirname = shift;
+   logMsg( "Cleaning up $dirname of all files" );
+   my $files = getDirectoryList( $dirname );
+   # clean up a directory
+   foreach my $file (@$files) {
+      unlink $file or warn "Could not unlink $file: #!\n";
+   }
+   return 1;
+}
+# handle fatal error by logging message and dying
+# message - message to log, and also sent via email if applicable
+# config - configuration hashref (optional)
+# cleanupRoutine - code reference to cleanup routine (optional)
+# if cleanupRoutine is provided, it will be called before dying passing it the config hashref
+sub fatalError {
+   my ( $message, $config, $cleanupRoutine ) = @_;
+   logMsg( "FATAL ERROR: $message" );
+   if ( defined $cleanupRoutine && ref $cleanupRoutine eq 'CODE' ) {
+      logMsg( "Running cleanup routine before fatal error" );
+      eval {
+         $cleanupRoutine->( $config, $message );
+;
+      } or do {
+         logMsg( "Cleanup routine failed: $@" );
+      };
+   }
+   die;
+}
 ;

Subversion Repositories zfs_utils

(root)/trunk/ZFS_Utils.pm – Rev 41 → 42