* Commit for 2.1.0.
[BackupPC.git] / lib / BackupPC / Xfer / Tar.pm
index 7092b89..bc4f787 100644 (file)
@@ -11,7 +11,7 @@
 #   Craig Barratt  <cbarratt@users.sourceforge.net>
 #
 # COPYRIGHT
-#   Copyright (C) 2001  Craig Barratt
+#   Copyright (C) 2001-2003  Craig Barratt
 #
 #   This program is free software; you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -29,7 +29,7 @@
 #
 #========================================================================
 #
-# Version 1.6.0_CVS, released 10 Dec 2002.
+# Version 2.1.0, released 20 Jun 2004.
 #
 # See http://backuppc.sourceforge.net.
 #
@@ -78,11 +78,11 @@ sub start
     my($t) = @_;
     my $bpc = $t->{bpc};
     my $conf = $t->{conf};
-    my(@fileList, @tarClientCmd, $logMsg, $incrDate);
+    my(@fileList, $tarClientCmd, $logMsg, $incrDate);
     local(*TAR);
 
     if ( $t->{type} eq "restore" ) {
-        push(@tarClientCmd, split(/ +/, $conf->{TarClientRestoreCmd}));
+       $tarClientCmd = $conf->{TarClientRestoreCmd};
         $logMsg = "restore started below directory $t->{shareName}";
        #
        # restores are considered to work unless we see they fail
@@ -92,24 +92,11 @@ sub start
     } else {
        #
        # Turn $conf->{BackupFilesOnly} and $conf->{BackupFilesExclude}
-       # into a hash of arrays of files
+       # into a hash of arrays of files, and $conf->{TarShareName}
+       # to an array
        #
-       $conf->{TarShareName} = [ $conf->{TarShareName} ]
-                       unless ref($conf->{TarShareName}) eq "ARRAY";
-       foreach my $param qw(BackupFilesOnly BackupFilesExclude) {
-           next if ( !defined($conf->{$param}) );
-           if ( ref($conf->{$param}) eq "ARRAY" ) {
-               $conf->{$param} = {
-                       $conf->{TarShareName}[0] => $conf->{$param}
-               };
-           } elsif ( ref($conf->{$param}) eq "HASH" ) {
-               # do nothing
-           } else {
-               $conf->{$param} = {
-                       $conf->{TarShareName}[0] => [ $conf->{$param} ]
-               };
-           }
-       }
+       $bpc->backupFileConfFix($conf, "TarShareName");
+
         if ( defined($conf->{BackupFilesExclude}{$t->{shareName}}) ) {
             foreach my $file ( @{$conf->{BackupFilesExclude}{$t->{shareName}}} )
             {
@@ -125,52 +112,37 @@ sub start
         } else {
            push(@fileList, ".");
         }
+       if ( ref($conf->{TarClientCmd}) eq "ARRAY" ) {
+           $tarClientCmd = $conf->{TarClientCmd};
+       } else {
+           $tarClientCmd = [split(/ +/, $conf->{TarClientCmd})];
+       }
+       my $args;
         if ( $t->{type} eq "full" ) {
-           push(@tarClientCmd,
-                   split(/ +/, $conf->{TarClientCmd}),
-                   split(/ +/, $conf->{TarFullArgs})
-           );
+           $args = $conf->{TarFullArgs};
             $logMsg = "full backup started for directory $t->{shareName}";
         } else {
-            $incrDate = $bpc->timeStampISO($t->{lastFull} - 3600, 1);
-           push(@tarClientCmd,
-                   split(/ +/, $conf->{TarClientCmd}),
-                   split(/ +/, $conf->{TarIncrArgs})
-           );
+            $incrDate = $bpc->timeStamp($t->{lastFull} - 3600, 1);
+           $args = $conf->{TarIncrArgs};
             $logMsg = "incr backup started back to $incrDate for directory"
                     . " $t->{shareName}";
         }
+       push(@$tarClientCmd, split(/ +/, $args));
     }
     #
     # Merge variables into @tarClientCmd
     #
-    my $vars = {
+    my $args = {
         host      => $t->{host},
         hostIP    => $t->{hostIP},
+        client    => $t->{client},
         incrDate  => $incrDate,
         shareName => $t->{shareName},
+       fileList  => \@fileList,
         tarPath   => $conf->{TarClientPath},
         sshPath   => $conf->{SshPath},
     };
-    my @cmd = @tarClientCmd;
-    @tarClientCmd = ();
-    foreach my $arg ( @cmd ) {
-       next if ( $arg =~ /^\s*$/ );
-       if ( $arg =~ /^\$fileList(\+?)/ ) {
-           my $esc = $1 eq "+";
-           foreach $arg ( @fileList ) {
-               $arg = $bpc->shellEscape($arg) if ( $esc );
-               push(@tarClientCmd, $arg);
-           }
-       } else {
-           $arg =~ s{\$(\w+)(\+?)}{
-               defined($vars->{$1})
-                   ? ($2 eq "+" ? $bpc->shellEscape($vars->{$1}) : $vars->{$1})
-                   : "\$$1"
-           }eg;
-           push(@tarClientCmd, $arg);
-       }
-    }
+    $tarClientCmd = $bpc->cmdVarSubstitute($tarClientCmd, $args);
     if ( !defined($t->{xferPid} = open(TAR, "-|")) ) {
         $t->{_errStr} = "Can't fork to run tar";
         return;
@@ -204,13 +176,15 @@ sub start
         #
         # Run the tar command
         #
-        exec(@tarClientCmd);
+       alarm(0);
+       $bpc->cmdExecOrEval($tarClientCmd, $args);
         # should not be reached, but just in case...
-        $t->{_errStr} = "Can't exec @tarClientCmd";
+        $t->{_errStr} = "Can't exec @$tarClientCmd";
         return;
     }
-    $t->{XferLOG}->write(\"Running: @tarClientCmd\n");
-    alarm($conf->{SmbClientTimeout});
+    my $str = "Running: " . $bpc->execCmd2ShellCmd(@$tarClientCmd) . "\n";
+    $t->{XferLOG}->write(\"Running: @$tarClientCmd\n");
+    alarm($conf->{ClientTimeout});
     $t->{_errStr} = undef;
     return $logMsg;
 }
@@ -235,17 +209,19 @@ sub readOutput
     while ( $t->{tarOut} =~ /(.*?)[\n\r]+(.*)/s ) {
         $_ = $1;
         $t->{tarOut} = $2;
-        $t->{XferLOG}->write(\"$_\n");
         #
         # refresh our inactivity alarm
         #
-        alarm($conf->{SmbClientTimeout});
+        alarm($conf->{ClientTimeout}) if ( !$t->{abort} );
         $t->{lastOutputLine} = $_ if ( !/^$/ );
         if ( /^Total bytes written: / ) {
+            $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 1 );
             $t->{xferOK} = 1;
         } elsif ( /^\./ ) {
+            $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 2 );
             $t->{fileCnt}++;
         } else {
+            $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 0 );
             $t->{xferErrCnt}++;
            #
            # If tar encounters a minor error, it will exit with a non-zero
@@ -254,11 +230,34 @@ sub readOutput
            #
            $t->{tarBadExitOk} = 1
                    if ( $t->{xferOK} && /Error exit delayed from previous / );
+            #
+            # Also remember files that had read errors
+            #
+            if ( /: \.\/(.*): Read error at byte / ) {
+                my $badFile = $1;
+                push(@{$t->{badFiles}}, {
+                        share => $t->{shareName},
+                        file  => $badFile
+                    });
+            }
+
        }
     }
     return 1;
 }
 
+sub abort
+{
+    my($t, $reason) = @_;
+    my @xferPid = $t->xferPid;
+
+    $t->{abort} = 1;
+    $t->{abortReason} = $reason;
+    if ( @xferPid ) {
+       kill($t->{bpc}->sigName2num("INT"), @xferPid);
+    }
+}
+
 sub setSelectMask
 {
     my($t, $FDreadRef) = @_;
@@ -277,7 +276,7 @@ sub xferPid
 {
     my($t) = @_;
 
-    return $t->{xferPid};
+    return ($t->{xferPid});
 }
 
 sub logMsg