# full or incremental backup needs to be run. If no backup is
# scheduled, or a ping to $client fails, then BackupPC_dump quits.
#
-# The backup is done using the selected XferMethod (smb, tar, rsync etc),
-# extracting the dump into $TopDir/pc/$client/new. The xfer output is
-# put into $TopDir/pc/$client/XferLOG.
+# The backup is done using the selected XferMethod (smb, tar, rsync,
+# backuppcd etc), extracting the dump into $TopDir/pc/$client/new.
+# The xfer output is put into $TopDir/pc/$client/XferLOG.
#
# If the dump succeeds (based on parsing the output of the XferMethod):
# - $TopDir/pc/$client/new is renamed to $TopDir/pc/$client/nnn, where
# Craig Barratt <cbarratt@users.sourceforge.net>
#
# COPYRIGHT
-# Copyright (C) 2001-2003 Craig Barratt
+# Copyright (C) 2001-2007 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
#
#========================================================================
#
-# Version 2.1.0, released 20 Jun 2004.
+# Version 3.1.0, released 25 Nov 2007.
#
# See http://backuppc.sourceforge.net.
#
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;
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);
#
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 $partialFileCnt;
+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.
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})
#
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);
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};
- $partialNum = $Backups[$i]{num};
+ $partialIdx = $i;
+ $lastPartial = $Backups[$i]{startTime};
+ $partialNum = $Backups[$i]{num};
+ $partialFileCnt = $Backups[$i]{nFiles};
}
}
#
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);
}
+if ( !$bpc->HardlinkTest($Dir, "$TopDir/cpool") ) {
+ print(LOG $bpc->timeStamp, "Can't create a test hardlink between a file"
+ . " in $Dir and $TopDir/cpool. Either these are different"
+ . " file systems, or this file system doesn't support hardlinks,"
+ . " or these directories don't exist, or there is a permissions"
+ . " problem, or the file system is out of inodes or full. Use"
+ . " df, df -i, and ls -ld to check each of these possibilities."
+ . " Quitting...\n");
+ print("test hardlink between $Dir and $TopDir/cpool failed\n");
+ print("link $clientURI\n") if ( $needLink );
+ exit(1);
+}
+
#
# Check if $host is alive
#
$ShareNames = $Conf{TarShareName};
} elsif ( $Conf{XferMethod} eq "rsync" || $Conf{XferMethod} eq "rsyncd" ) {
$ShareNames = $Conf{RsyncShareName};
+} elsif ( $Conf{XferMethod} eq "backuppcd" ) {
+ $ShareNames = $Conf{BackupPCdShareName};
} else {
$ShareNames = $Conf{SmbShareName};
}
# 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;
#
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" ) {
}
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" ) {
#
UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
exit(1);
}
+ } elsif ( $Conf{XferMethod} eq "backuppcd" ) {
+ #
+ # Use backuppcd as the transport program.
+ #
+ if ( !defined($xfer = BackupPC::Xfer::BackupPCd->new($bpc)) ) {
+ my $errStr = BackupPC::Xfer::BackupPCd::errStr;
+ print(LOG $bpc->timeStamp, "dump failed: $errStr\n");
+ print("dump failed: $errStr\n");
+ UserCommandRun("DumpPostShareCmd", $shareName) if ( $NeedPostCmd );
+ UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
+ exit(1);
+ }
} else {
#
# Default is to use smbclient (smb) as the transport program.
# 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()) ) {
close(WH);
}
print(LOG $bpc->timeStamp, $logMsg, "\n");
+ $XferLOG->write(\"$logMsg\n");
print("started $type dump, share=$shareName\n");
pidHandler(@xferPid);
}
}
- 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} ) {
#
- # kill off the tranfer program, first nicely then forcefully
+ # kill off the transfer program, first nicely then forcefully
#
if ( @xferPid ) {
kill($bpc->sigName2num("INT"), @xferPid);
$stat{xferOK} = 0 if ( $Abort );
+#
+# If there is no "new" directory then the backup is bad
+#
+if ( $stat{xferOK} && !-d "$Dir/new" ) {
+ $stat{hostError} = "No backup directory $Dir/new"
+ if ( $stat{hostError} eq "" );
+ $stat{xferOK} = 0;
+}
+
#
# Do one last check to make sure it is still the machine we expect.
#
}
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();
my $otherCount = $stat{xferErrCnt} - $stat{xferBadFileCnt}
- $stat{xferBadShareCnt};
+$stat{fileCnt} ||= 0;
+$stat{byteCnt} ||= 0;
+$stat{xferErrCnt} ||= 0;
+$stat{xferBadFileCnt} ||= 0;
+$stat{xferBadShareCnt} ||= 0;
print(LOG $bpc->timeStamp,
"$type backup $newNum complete, $stat{fileCnt} files,"
. " $stat{byteCnt} bytes,"
"Aborting backup up after signal $sigName\n");
#
- # Tell xfer to abort
+ # Tell xfer to abort, but only if we actually started one
#
- $xfer->abort($reason);
+ $xfer->abort($reason) if ( defined($xfer) );
#
# Send ALRMs to BackupPC_tarExtract if we are using it
#
# We keep this backup if it is a full and we actually backed
- # up some files.
+ # up some files. If the prior backup was a partial too, we
+ # only keep this backup if it has more files than the previous
+ # partial.
#
if ( $type eq "full" ) {
if ( $nFilesTotal == 0 && $xfer->getStats->{fileCnt} == 0 ) {
# directory just in case.
#
find(\&CheckForNewFiles, "$Dir/new");
- $keepPartial = 1 if ( $nFilesTotal );
- } else {
- #
- # Xfer reported some files
- #
+ }
+ my $str;
+ if ( $nFilesTotal > $partialFileCnt
+ || $xfer->getStats->{fileCnt} > $partialFileCnt ) {
+ #
+ # If the last backup wasn't a partial then
+ # $partialFileCnt is undefined, so the above
+ # test is simply $nFilesTotal > 0
+ #
$keepPartial = 1;
- }
+ if ( $partialFileCnt ) {
+ $str = "Saving this as a partial backup\n";
+ } else {
+ $str = sprintf("Saving this as a partial backup, replacing the"
+ . " prior one (got %d and %d files versus %d)\n",
+ $nFilesTotal, $xfer->getStats->{fileCnt}, $partialFileCnt);
+ }
+ } else {
+ $str = sprintf("Not saving this as a partial backup since it has fewer"
+ . " files than the prior one (got %d and %d files versus %d)\n",
+ $nFilesTotal, $xfer->getStats->{fileCnt}, $partialFileCnt);
+ }
+ $XferLOG->write(\$str);
}
#
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++;
}
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;
}
# where $Conf{FullKeepCnt} is an array.
#
last if ( !BackupFullExpire($client, \@Backups) );
+ $changes++;
}
$bpc->BackupInfoWrite($client, @Backups) if ( $changes );
}
# (the new backup might also be a partial, but that's ok).
#
BackupPartialRemove($client, \@Backups);
+ $needLink = 1 if ( -f "$Dir/NewFileList" );
#
# Number the new backup
if ( !rename("$Dir/new", "$Dir/$num") ) {
print(LOG $bpc->timeStamp, "Rename $Dir/new -> $Dir/$num failed\n");
$stat{xferOK} = 0;
+ return;
}
- $needLink = 1 if ( -f "$Dir/NewFileList" );
#
# Add the new backup information to the backup file
$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};
+ $Backups[$i]{version} = $bpc->Version();
#
# Save the main backups file
#