* Various changes for 3.0.0beta1
[BackupPC.git] / bin / BackupPC_dump
index 72f992c..f47b6e3 100755 (executable)
@@ -70,7 +70,7 @@
 #
 #========================================================================
 #
-# Version 3.0.0alpha, released 23 Jan 2006.
+# Version 3.0.0beta1, released 30 Jul 2006.
 #
 # See http://backuppc.sourceforge.net.
 #
@@ -86,6 +86,7 @@ use BackupPC::Xfer::Smb;
 use BackupPC::Xfer::Tar;
 use BackupPC::Xfer::Rsync;
 use BackupPC::Xfer::BackupPCd;
+use Encode;
 use Socket;
 use File::Path;
 use File::Find;
@@ -193,7 +194,30 @@ mkpath($Dir, 0, 0777) if ( !-d $Dir );
 if ( !-f "$Dir/LOCK" ) {
     open(LOCK, ">", "$Dir/LOCK") && close(LOCK);
 }
-open(LOG, ">>", "$Dir/LOG");
+
+my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
+my $logPath = sprintf("$Dir/LOG.%02d%04d", $mon + 1, $year + 1900);
+
+if ( !-f $logPath ) {
+    #
+    # Compress and prune old log files
+    #
+    my $lastLog = $Conf{MaxOldPerPCLogFiles} - 1;
+    foreach my $file ( $bpc->sortedPCLogFiles($client) ) {
+        if ( $lastLog <= 0 ) {
+            unlink($file);
+            next;
+        }
+        $lastLog--;
+        next if ( $file =~ /\.z$/ || !$Conf{CompressLevel} );
+        BackupPC::FileZIO->compressCopy($file,
+                                        "$file.z",
+                                        undef,
+                                        $Conf{CompressLevel}, 1);
+    }
+}
+
+open(LOG, ">>", $logPath);
 select(LOG); $| = 1; select(STDOUT);
 
 #
@@ -273,17 +297,26 @@ if ( $opts{d} ) {
     print("DHCP $hostIP $clientURI\n");
 }
 
-my($needLink, @Backups, $type, $lastBkupNum, $lastFullBkupNum);
-my $lastFull = 0;
-my $lastIncr = 0;
+my($needLink, @Backups, $type);
+my($incrBaseTime, $incrBaseBkupNum, $incrBaseLevel, $incrLevel);
+my $lastFullTime = 0;
+my $lastIncrTime = 0;
 my $partialIdx = -1;
 my $partialNum;
+my $lastBkupNum;
 my $lastPartial = 0;
 
-if ( $Conf{FullPeriod} == -1 && !$opts{f} && !$opts{i}
-        || $Conf{FullPeriod} == -2 ) {
+#
+# Maintain backward compatibility with $Conf{FullPeriod} == -1 or -2
+# meaning disable backups
+#
+$Conf{BackupsDisable} = -$Conf{FullPeriod}
+            if ( !$Conf{BackupsDisable} && $Conf{FullPeriod} < 0 );
+
+if ( $Conf{BackupsDisable} == 1 && !$opts{f} && !$opts{i}
+        || $Conf{BackupsDisable} == 2 ) {
     print(STDERR "Exiting because backups are disabled with"
-               . " \$Conf{FullPeriod} = $Conf{FullPeriod}\n") if ( $opts{v} );
+       . " \$Conf{BackupsDisable} = $Conf{BackupsDisable}\n") if ( $opts{v} );
     #
     # Tell BackupPC to ignore old failed backups on hosts that
     # have backups disabled.
@@ -301,23 +334,10 @@ if ( !$opts{i} && !$opts{f} && $Conf{BlackoutGoodCnt} >= 0
     my($currHours) = $hour + $min / 60 + $sec / 3600;
     my $blackout;
 
-    #
-    # Handle backward compatibility with original separate scalar
-    # parameters.
-    #
-    if ( defined($Conf{BlackoutHourBegin}) ) {
-        push(@{$Conf{BlackoutPeriods}},
-             {
-                 hourBegin => $Conf{BlackoutHourBegin},
-                 hourEnd   => $Conf{BlackoutHourEnd},
-                 weekDays  => $Conf{BlackoutWeekDays},
-             }
-        );
-    }
     foreach my $p ( @{$Conf{BlackoutPeriods}} ) {
         #
-        # Allow blackout to span midnight (specified by BlackoutHourBegin
-        # being greater than BlackoutHourEnd)
+        # Allow blackout to span midnight (specified by hourBegin
+        # being greater than hourEnd)
         #
         next if ( ref($p->{weekDays}) ne "ARRAY" 
                     || !defined($p->{hourBegin})
@@ -360,23 +380,31 @@ if ( !$opts{i} && !$opts{f} && $StatusHost{backoffTime} > time ) {
 #
 BackupExpire($client);
 
+my(@lastIdxByLevel, $incrCntSinceFull);
+
 #
 # Read Backup information, and find times of the most recent full and
-# incremental backups
+# incremental backups.  Also figure out which backup we will use
+# as a starting point for an incremental.
 #
 @Backups = $bpc->BackupInfoRead($client);
+## @Backups = sort( { $a->{startTime} <=> $b->{startTime} }, @Backups);
 for ( my $i = 0 ; $i < @Backups ; $i++ ) {
     $needLink = 1 if ( $Backups[$i]{nFilesNew} eq ""
                         || -f "$Dir/NewFileList.$Backups[$i]{num}" );
-    $lastBkupNum = $Backups[$i]{num};
     if ( $Backups[$i]{type} eq "full" ) {
-       if ( $lastFull < $Backups[$i]{startTime} ) {
-           $lastFull = $Backups[$i]{startTime};
-           $lastFullBkupNum = $Backups[$i]{num};
+        $incrCntSinceFull = 0;
+        $lastBkupNum = $Backups[$i]{num};
+        $lastIdxByLevel[0] = $i;
+       if ( $lastFullTime < $Backups[$i]{startTime} ) {
+           $lastFullTime = $Backups[$i]{startTime};
        }
     } elsif ( $Backups[$i]{type} eq "incr" ) {
-        $lastIncr = $Backups[$i]{startTime}
-                if ( $lastIncr < $Backups[$i]{startTime} );
+        $incrCntSinceFull++;
+        $lastBkupNum = $Backups[$i]{num};
+        $lastIdxByLevel[$Backups[$i]{level}] = $i;
+        $lastIncrTime = $Backups[$i]{startTime}
+                if ( $lastIncrTime < $Backups[$i]{startTime} );
     } elsif ( $Backups[$i]{type} eq "partial" ) {
         $partialIdx  = $i;
         $lastPartial = $Backups[$i]{startTime};
@@ -389,12 +417,42 @@ for ( my $i = 0 ; $i < @Backups ; $i++ ) {
 #
 if ( @Backups == 0
         || $opts{f}
-        || (!$opts{i} && (time - $lastFull > $Conf{FullPeriod} * 24*3600
-            && time - $lastIncr > $Conf{IncrPeriod} * 24*3600)) ) {
+        || (!$opts{i} && (time - $lastFullTime > $Conf{FullPeriod} * 24*3600
+            && time - $lastIncrTime > $Conf{IncrPeriod} * 24*3600)) ) {
     $type = "full";
-} elsif ( $opts{i} || (time - $lastIncr > $Conf{IncrPeriod} * 24*3600
-        && time - $lastFull > $Conf{IncrPeriod} * 24*3600) ) {
+    $incrLevel = 0;
+    $incrBaseBkupNum = $lastBkupNum;
+} elsif ( $opts{i} || (time - $lastIncrTime > $Conf{IncrPeriod} * 24*3600
+        && time - $lastFullTime > $Conf{IncrPeriod} * 24*3600) ) {
     $type = "incr";
+    #
+    # For an incremental backup, figure out which level we should
+    # do and the index of the reference backup, which is the most
+    # recent backup at any lower level.
+    #
+    @{$Conf{IncrLevels}} = [$Conf{IncrLevels}]
+                            unless ref($Conf{IncrLevels}) eq "ARRAY";
+    @{$Conf{IncrLevels}} = [1] if ( !@{$Conf{IncrLevels}} );
+    $incrCntSinceFull = $incrCntSinceFull % @{$Conf{IncrLevels}};
+    $incrLevel = $Conf{IncrLevels}[$incrCntSinceFull];
+    for ( my $i = 0 ; $i < $incrLevel ; $i++ ) {
+        my $idx = $lastIdxByLevel[$i];
+        next if ( !defined($idx) );
+        if ( !defined($incrBaseTime)
+                || $Backups[$idx]{startTime} > $incrBaseTime ) {
+            $incrBaseBkupNum = $Backups[$idx]{num};
+            $incrBaseLevel   = $Backups[$idx]{level};
+            $incrBaseTime    = $Backups[$idx]{startTime};
+        }
+    }
+    #
+    # Can't find any earlier lower-level backup!  Shouldn't
+    # happen - just do full instead
+    #
+    if ( !defined($incrBaseBkupNum) || $incrLevel < 1 ) {
+        $type = "full";
+        $incrBaseBkupNum = $lastBkupNum;
+    }
 } else {
     NothingToDo($needLink);
 }
@@ -510,6 +568,12 @@ $ShareNames = [ $ShareNames ] unless ref($ShareNames) eq "ARRAY";
 # Run an optional pre-dump command
 #
 UserCommandRun("DumpPreUserCmd");
+if ( $? && $Conf{UserCmdCheckStatus} ) {
+    print(LOG $bpc->timeStamp,
+            "DumpPreUserCmd returned error status $?... exiting\n");
+    print("dump failed: DumpPreUserCmd returned error status $?\n");
+    exit(1);
+}
 $NeedPostCmd = 1;
 
 #
@@ -518,6 +582,10 @@ $NeedPostCmd = 1;
 for my $shareName ( @$ShareNames ) {
     local(*RH, *WH);
 
+    #
+    # Convert $shareName to utf8 octets
+    #
+    $shareName = encode("utf8", $shareName);
     $stat{xferOK} = $stat{hostAbort} = undef;
     $stat{hostError} = $stat{lastOutputLine} = undef;
     if ( -d "$Dir/new/$shareName" ) {
@@ -527,6 +595,13 @@ for my $shareName ( @$ShareNames ) {
     }
 
     UserCommandRun("DumpPreShareCmd", $shareName);
+    if ( $? && $Conf{UserCmdCheckStatus} ) {
+        print(LOG $bpc->timeStamp,
+                "DumpPreShareCmd returned error status $?... exiting\n");
+        print("dump failed: DumpPreShareCmd returned error status $?\n");
+        UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
+        exit(1);
+    }
 
     if ( $Conf{XferMethod} eq "tar" ) {
         #
@@ -635,25 +710,24 @@ for my $shareName ( @$ShareNames ) {
     # Run the transport program
     #
     $xfer->args({
-        host        => $host,
-        client      => $client,
-        hostIP      => $hostIP,
-        shareName   => $shareName,
-        pipeRH      => *RH,
-        pipeWH      => *WH,
-        XferLOG     => $XferLOG,
-       newFilesFH  => $newFilesFH,
-        outDir      => $Dir,
-        type        => $type,
-        lastFull    => $lastFull,
-       lastBkupNum => $lastBkupNum,
-       lastFullBkupNum => $lastFullBkupNum,
-       backups     => \@Backups,
-       compress    => $Conf{CompressLevel},
-       XferMethod  => $Conf{XferMethod},
-       logLevel    => $Conf{XferLogLevel},
-       pidHandler  => \&pidHandler,
-        partialNum  => $partialNum,
+        host         => $host,
+        client       => $client,
+        hostIP       => $hostIP,
+        shareName    => $shareName,
+        pipeRH       => *RH,
+        pipeWH       => *WH,
+        XferLOG      => $XferLOG,
+       newFilesFH   => $newFilesFH,
+        outDir       => $Dir,
+        type         => $type,
+        incrBaseTime => $incrBaseTime,
+        incrBaseBkupNum => $incrBaseBkupNum,
+       backups      => \@Backups,
+       compress     => $Conf{CompressLevel},
+       XferMethod   => $Conf{XferMethod},
+       logLevel     => $Conf{XferLogLevel},
+       pidHandler   => \&pidHandler,
+        partialNum   => $partialNum,
     });
 
     if ( !defined($logMsg = $xfer->start()) ) {
@@ -689,6 +763,7 @@ for my $shareName ( @$ShareNames ) {
        close(WH);
     }
     print(LOG $bpc->timeStamp, $logMsg, "\n");
+    $XferLOG->write(\"$logMsg\n");
     print("started $type dump, share=$shareName\n");
 
     pidHandler(@xferPid);
@@ -788,7 +863,14 @@ for my $shareName ( @$ShareNames ) {
         }
     }
 
-    UserCommandRun("DumpPostShareCmd", $shareName) if ( $NeedPostCmd );
+    if ( $NeedPostCmd ) {
+        UserCommandRun("DumpPostShareCmd", $shareName);
+        if ( $? && $Conf{UserCmdCheckStatus} ) {
+            print(LOG $bpc->timeStamp,
+                    "DumpPostShareCmd returned error status $?... exiting\n");
+            $stat{hostError} = "DumpPostShareCmd returned error status $?";
+        }
+    }
 
     $stat{xferOK} = 0 if ( $stat{hostError} || $stat{hostAbort} );
     if ( !$stat{xferOK} ) {
@@ -835,6 +917,12 @@ if ( $stat{xferOK} && (my $errMsg = CorrectHostCheck($hostIP, $host)) ) {
 }
 
 UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
+if ( $? && $Conf{UserCmdCheckStatus} ) {
+    print(LOG $bpc->timeStamp,
+            "DumpPostUserCmd returned error status $?... exiting\n");
+    $stat{hostError} = "DumpPostUserCmd returned error status $?";
+    $stat{xferOK} = 0;
+}
 close($newFilesFH) if ( defined($newFilesFH) );
 
 my $endTime = time();
@@ -1098,7 +1186,7 @@ sub BackupExpire
            if ( $Backups[$i]{type} eq "full" ) {
                $firstFull = $i if ( $cntFull == 0 );
                $cntFull++;
-           } else {
+           } elsif ( $Backups[$i]{type} eq "incr" ) {
                $firstIncr = $i if ( $cntIncr == 0 );
                $cntIncr++;
            }
@@ -1107,23 +1195,39 @@ sub BackupExpire
                         if ( $cntIncr > 0 );
        $oldestFull = (time - $Backups[$firstFull]{startTime}) / (24 * 3600)
                         if ( $cntFull > 0 );
-       if ( $cntIncr > $Conf{IncrKeepCnt}
-               || ($cntIncr > $Conf{IncrKeepCntMin}
-                   && $oldestIncr > $Conf{IncrAgeMax})
-               && (@Backups <= $firstIncr + 1
-                        || $Backups[$firstIncr]{noFill}
-                        || !$Backups[$firstIncr + 1]{noFill}) ) {
+
+        #
+        # With multi-level incrementals, several of the following
+        # incrementals might depend upon this one, so we have to
+        # delete all of the them.  Figure out if that is possible
+        # by counting the number of consecutive incrementals that
+        # are unfilled and have a level higher than this one.
+        #
+        my $cntIncrDel = 1;
+        my $earliestIncr = $oldestIncr;
+
+       for ( my $i = $firstIncr + 1 ; $i < @Backups ; $i++ ) {
+            last if ( $Backups[$i]{level} <= $Backups[$firstIncr]{level}
+                   || !$Backups[$i]{noFill} );
+            $cntIncrDel++;
+            $earliestIncr = (time - $Backups[$i]{startTime}) / (24 * 3600);
+        }
+
+       if ( $cntIncr >= $Conf{IncrKeepCnt} + $cntIncrDel
+               || ($cntIncr >= $Conf{IncrKeepCntMin} + $cntIncrDel
+                   && $earliestIncr > $Conf{IncrAgeMax}) ) {
             #
-            # Only delete an incr backup if the Conf settings are satisfied.
-            # We also must make sure that either this backup is the most
-            # recent one, or it is not filled, or the next backup is filled.
-            # (We can't deleted a filled incr if the next backup is not
-            # filled.)
+            # Only delete an incr backup if the Conf settings are satisfied
+            # for all $cntIncrDel incrementals.  Since BackupRemove() does
+            # a splice() we need to do the deletes in the reverse order.
             # 
-           print(LOG $bpc->timeStamp,
-                      "removing incr backup $Backups[$firstIncr]{num}\n");
-            BackupRemove($client, \@Backups, $firstIncr);
-            $changes++;
+            for ( my $i = $firstIncr + $cntIncrDel - 1 ;
+                    $i >= $firstIncr ; $i-- ) {
+                print(LOG $bpc->timeStamp,
+                          "removing incr backup $Backups[$i]{num}\n");
+                BackupRemove($client, \@Backups, $i);
+                $changes++;
+            }
             next;
         }
 
@@ -1172,6 +1276,7 @@ sub BackupExpire
        # where $Conf{FullKeepCnt} is an array.
         #
         last if ( !BackupFullExpire($client, \@Backups) );
+        $changes++;
     }
     $bpc->BackupInfoWrite($client, @Backups) if ( $changes );
 }
@@ -1308,8 +1413,8 @@ sub BackupSave
     $Backups[$i]{tarErrs}       = $tarErrs;
     $Backups[$i]{compress}      = $Conf{CompressLevel};
     $Backups[$i]{noFill}        = $type eq "incr" ? 1 : 0;
-    $Backups[$i]{level}         = $type eq "incr" ? 1 : 0;
-    $Backups[$i]{mangle}        = 1;        # name mangling always on for v1.04+
+    $Backups[$i]{level}         = $incrLevel;
+    $Backups[$i]{mangle}        = 1;     # name mangling always on for v1.04+
     $Backups[$i]{xferMethod}    = $Conf{XferMethod};
     $Backups[$i]{charset}       = $Conf{ClientCharset};
     #