# 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
#
#========================================================================
#
-# Version 1.5.0, released 2 Aug 2002.
+# Version 2.1.0_CVS, released 8 Feb 2004.
#
# See http://backuppc.sourceforge.net.
#
sub new
{
my $class = shift;
- my($topDir) = @_;
- my $self = bless {
+ my($topDir, $installDir, $noUserCheck) = @_;
+
+ my $bpc = bless {
TopDir => $topDir || '/data/BackupPC',
- BinDir => '/usr/local/BackupPC/bin',
- LibDir => '/usr/local/BackupPC/lib',
- Version => '1.5.0',
+ BinDir => $installDir || '/usr/local/BackupPC',
+ LibDir => $installDir || '/usr/local/BackupPC',
+ Version => '2.1.0_CVS',
BackupFields => [qw(
num type startTime endTime
nFiles size nFilesExist sizeExist nFilesNew sizeNew
xferErrs xferBadFile xferBadShare tarErrs
compress sizeExistComp sizeNewComp
- noFill fillFromNum mangle
+ noFill fillFromNum mangle xferMethod level
)],
RestoreFields => [qw(
num startTime endTime result errorMsg nFiles size
tarCreateErrs xferErrs
)],
+ ArchiveFields => [qw(
+ num startTime endTime result errorMsg
+ )],
}, $class;
+ $bpc->{BinDir} .= "/bin";
+ $bpc->{LibDir} .= "/lib";
#
# Clean up %ENV and setup other variables.
#
delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
- $self->{PoolDir} = "$self->{TopDir}/pool";
- $self->{CPoolDir} = "$self->{TopDir}/cpool";
- if ( defined(my $error = $self->ConfigRead()) ) {
+ $bpc->{PoolDir} = "$bpc->{TopDir}/pool";
+ $bpc->{CPoolDir} = "$bpc->{TopDir}/cpool";
+ if ( defined(my $error = $bpc->ConfigRead()) ) {
print(STDERR $error, "\n");
return;
}
- return $self;
+ #
+ # Verify we are running as the correct user
+ #
+ if ( !$noUserCheck
+ && $bpc->{Conf}{BackupPCUserVerify}
+ && $> != (my $uid = (getpwnam($bpc->{Conf}{BackupPCUser}))[2]) ) {
+ print("Wrong user: my userid is $>, instead of $uid"
+ . " ($bpc->{Conf}{BackupPCUser})\n");
+ return;
+ }
+ return $bpc;
}
sub TopDir
{
- my($self) = @_;
- return $self->{TopDir};
+ my($bpc) = @_;
+ return $bpc->{TopDir};
}
sub BinDir
{
- my($self) = @_;
- return $self->{BinDir};
+ my($bpc) = @_;
+ return $bpc->{BinDir};
}
sub Version
{
- my($self) = @_;
- return $self->{Version};
+ my($bpc) = @_;
+ return $bpc->{Version};
}
sub Conf
{
- my($self) = @_;
- return %{$self->{Conf}};
+ my($bpc) = @_;
+ return %{$bpc->{Conf}};
}
sub Lang
{
- my($self) = @_;
- return $self->{Lang};
+ my($bpc) = @_;
+ return $bpc->{Lang};
}
sub adminJob
return " trashClean ";
}
-sub timeStamp
+sub ConfValue
{
- my($self, $t, $noPad) = @_;
- my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
- = localtime($t || time);
- $year += 1900;
- $mon++;
- return "$year/$mon/$mday " . sprintf("%02d:%02d:%02d", $hour, $min, $sec)
- . ($noPad ? "" : " ");
+ my($bpc, $param) = @_;
+
+ return $bpc->{Conf}{$param};
+}
+
+sub verbose
+{
+ my($bpc, $param) = @_;
+
+ $bpc->{verbose} = $param if ( defined($param) );
+ return $bpc->{verbose};
}
#
-# An ISO 8601-compliant version of timeStamp. Needed by the
-# --newer-mtime argument to GNU tar in BackupPC::Xfer::Tar.
-# Also see http://www.w3.org/TR/NOTE-datetime.
+# Generate an ISO 8601 format timeStamp (but without the "T").
+# See http://www.w3.org/TR/NOTE-datetime and
+# http://www.cl.cam.ac.uk/~mgk25/iso-time.html
#
-sub timeStampISO
+sub timeStamp
{
- my($self, $t, $noPad) = @_;
+ my($bpc, $t, $noPad) = @_;
my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
= localtime($t || time);
- $year += 1900;
- $mon++;
- return sprintf("%04d-%02d-%02d ", $year, $mon, $mday)
- . sprintf("%02d:%02d:%02d", $hour, $min, $sec)
- . ($noPad ? "" : " ");
+ return sprintf("%04d-%02d-%02d %02d:%02d:%02d",
+ $year + 1900, $mon + 1, $mday, $hour, $min, $sec)
+ . ($noPad ? "" : " ");
}
sub BackupInfoRead
{
- my($self, $host) = @_;
+ my($bpc, $host) = @_;
local(*BK_INFO, *LOCK);
my(@Backups);
- flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
- if ( open(BK_INFO, "$self->{TopDir}/pc/$host/backups") ) {
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ if ( open(BK_INFO, "$bpc->{TopDir}/pc/$host/backups") ) {
+ binmode(BK_INFO);
while ( <BK_INFO> ) {
s/[\n\r]+//;
- next if ( !/^(\d+\t(incr|full)[\d\t]*$)/ );
+ next if ( !/^(\d+\t(incr|full|partial)[\d\t]*$)/ );
$_ = $1;
- @{$Backups[@Backups]}{@{$self->{BackupFields}}} = split(/\t/);
+ @{$Backups[@Backups]}{@{$bpc->{BackupFields}}} = split(/\t/);
}
close(BK_INFO);
}
sub BackupInfoWrite
{
- my($self, $host, @Backups) = @_;
+ my($bpc, $host, @Backups) = @_;
local(*BK_INFO, *LOCK);
my($i);
- flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
- unlink("$self->{TopDir}/pc/$host/backups.old")
- if ( -f "$self->{TopDir}/pc/$host/backups.old" );
- rename("$self->{TopDir}/pc/$host/backups",
- "$self->{TopDir}/pc/$host/backups.old")
- if ( -f "$self->{TopDir}/pc/$host/backups" );
- if ( open(BK_INFO, ">$self->{TopDir}/pc/$host/backups") ) {
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ unlink("$bpc->{TopDir}/pc/$host/backups.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/backups.old" );
+ rename("$bpc->{TopDir}/pc/$host/backups",
+ "$bpc->{TopDir}/pc/$host/backups.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/backups" );
+ if ( open(BK_INFO, ">$bpc->{TopDir}/pc/$host/backups") ) {
+ binmode(BK_INFO);
for ( $i = 0 ; $i < @Backups ; $i++ ) {
my %b = %{$Backups[$i]};
- printf(BK_INFO "%s\n", join("\t", @b{@{$self->{BackupFields}}}));
+ printf(BK_INFO "%s\n", join("\t", @b{@{$bpc->{BackupFields}}}));
}
close(BK_INFO);
}
sub RestoreInfoRead
{
- my($self, $host) = @_;
+ my($bpc, $host) = @_;
local(*RESTORE_INFO, *LOCK);
my(@Restores);
- flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
- if ( open(RESTORE_INFO, "$self->{TopDir}/pc/$host/restores") ) {
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ if ( open(RESTORE_INFO, "$bpc->{TopDir}/pc/$host/restores") ) {
+ binmode(RESTORE_INFO);
while ( <RESTORE_INFO> ) {
s/[\n\r]+//;
next if ( !/^(\d+.*)/ );
$_ = $1;
- @{$Restores[@Restores]}{@{$self->{RestoreFields}}} = split(/\t/);
+ @{$Restores[@Restores]}{@{$bpc->{RestoreFields}}} = split(/\t/);
}
close(RESTORE_INFO);
}
sub RestoreInfoWrite
{
- my($self, $host, @Restores) = @_;
+ my($bpc, $host, @Restores) = @_;
local(*RESTORE_INFO, *LOCK);
my($i);
- flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
- unlink("$self->{TopDir}/pc/$host/restores.old")
- if ( -f "$self->{TopDir}/pc/$host/restores.old" );
- rename("$self->{TopDir}/pc/$host/restores",
- "$self->{TopDir}/pc/$host/restores.old")
- if ( -f "$self->{TopDir}/pc/$host/restores" );
- if ( open(RESTORE_INFO, ">$self->{TopDir}/pc/$host/restores") ) {
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ unlink("$bpc->{TopDir}/pc/$host/restores.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/restores.old" );
+ rename("$bpc->{TopDir}/pc/$host/restores",
+ "$bpc->{TopDir}/pc/$host/restores.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/restores" );
+ if ( open(RESTORE_INFO, ">$bpc->{TopDir}/pc/$host/restores") ) {
+ binmode(RESTORE_INFO);
for ( $i = 0 ; $i < @Restores ; $i++ ) {
my %b = %{$Restores[$i]};
printf(RESTORE_INFO "%s\n",
- join("\t", @b{@{$self->{RestoreFields}}}));
+ join("\t", @b{@{$bpc->{RestoreFields}}}));
}
close(RESTORE_INFO);
}
close(LOCK);
}
+sub ArchiveInfoRead
+{
+ my($bpc, $host) = @_;
+ local(*ARCHIVE_INFO, *LOCK);
+ my(@Archives);
+
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ if ( open(ARCHIVE_INFO, "$bpc->{TopDir}/pc/$host/archives") ) {
+ binmode(ARCHIVE_INFO);
+ while ( <ARCHIVE_INFO> ) {
+ s/[\n\r]+//;
+ next if ( !/^(\d+.*)/ );
+ $_ = $1;
+ @{$Archives[@Archives]}{@{$bpc->{ArchiveFields}}} = split(/\t/);
+ }
+ close(ARCHIVE_INFO);
+ }
+ close(LOCK);
+ return @Archives;
+}
+
+sub ArchiveInfoWrite
+{
+ my($bpc, $host, @Archives) = @_;
+ local(*ARCHIVE_INFO, *LOCK);
+ my($i);
+
+ flock(LOCK, LOCK_EX) if open(LOCK, "$bpc->{TopDir}/pc/$host/LOCK");
+ unlink("$bpc->{TopDir}/pc/$host/archives.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/archives.old" );
+ rename("$bpc->{TopDir}/pc/$host/archives",
+ "$bpc->{TopDir}/pc/$host/archives.old")
+ if ( -f "$bpc->{TopDir}/pc/$host/archives" );
+ if ( open(ARCHIVE_INFO, ">$bpc->{TopDir}/pc/$host/archives") ) {
+ binmode(ARCHIVE_INFO);
+ for ( $i = 0 ; $i < @Archives ; $i++ ) {
+ my %b = %{$Archives[$i]};
+ printf(ARCHIVE_INFO "%s\n",
+ join("\t", @b{@{$bpc->{ArchiveFields}}}));
+ }
+ close(ARCHIVE_INFO);
+ }
+ close(LOCK);
+}
+
sub ConfigRead
{
- my($self, $host) = @_;
+ my($bpc, $host) = @_;
my($ret, $mesg, $config, @configs);
- $self->{Conf} = ();
- push(@configs, "$self->{TopDir}/conf/config.pl");
- push(@configs, "$self->{TopDir}/pc/$host/config.pl")
- if ( defined($host) && -f "$self->{TopDir}/pc/$host/config.pl" );
+ $bpc->{Conf} = ();
+ push(@configs, "$bpc->{TopDir}/conf/config.pl");
+ push(@configs, "$bpc->{TopDir}/conf/$host.pl")
+ if ( $host ne "config" && -f "$bpc->{TopDir}/conf/$host.pl" );
+ push(@configs, "$bpc->{TopDir}/pc/$host/config.pl")
+ if ( defined($host) && -f "$bpc->{TopDir}/pc/$host/config.pl" );
foreach $config ( @configs ) {
%Conf = ();
if ( !defined($ret = do $config) && ($! || $@) ) {
$mesg =~ s/[\n\r]+//;
return $mesg;
}
- %{$self->{Conf}} = ( %{$self->{Conf} || {}}, %Conf );
+ %{$bpc->{Conf}} = ( %{$bpc->{Conf} || {}}, %Conf );
+ }
+ return if ( !defined($bpc->{Conf}{Language}) );
+ if ( defined($bpc->{Conf}{PerlModuleLoad}) ) {
+ #
+ # Load any user-specified perl modules. This is for
+ # optional user-defined extensions.
+ #
+ $bpc->{Conf}{PerlModuleLoad} = [$bpc->{Conf}{PerlModuleLoad}]
+ if ( ref($bpc->{Conf}{PerlModuleLoad}) ne "ARRAY" );
+ foreach my $module ( @{$bpc->{Conf}{PerlModuleLoad}} ) {
+ eval("use $module;");
+ }
}
- my $langFile = "$self->{LibDir}/BackupPC/Lang/$self->{Conf}{Language}.pm";
+ my $langFile = "$bpc->{LibDir}/BackupPC/Lang/$bpc->{Conf}{Language}.pm";
if ( !defined($ret = do $langFile) && ($! || $@) ) {
$mesg = "Couldn't open language file $langFile: $!" if ( $! );
$mesg = "Couldn't execute language file $langFile: $@" if ( $@ );
$mesg =~ s/[\n\r]+//;
return $mesg;
}
- $self->{Lang} = \%Lang;
+ $bpc->{Lang} = \%Lang;
return;
}
#
sub ConfigMTime
{
- my($self) = @_;
- return (stat("$self->{TopDir}/conf/config.pl"))[9];
+ my($bpc) = @_;
+ return (stat("$bpc->{TopDir}/conf/config.pl"))[9];
}
#
-# Returns information from the host file in $self->{TopDir}/conf/hosts.
+# Returns information from the host file in $bpc->{TopDir}/conf/hosts.
# With no argument a ref to a hash of hosts is returned. Each
# hash contains fields as specified in the hosts file. With an
# argument a ref to a single hash is returned with information
#
sub HostInfoRead
{
- my($self, $host) = @_;
+ my($bpc, $host) = @_;
my(%hosts, @hdr, @fld);
local(*HOST_INFO);
- if ( !open(HOST_INFO, "$self->{TopDir}/conf/hosts") ) {
- print(STDERR $self->timeStamp,
- "Can't open $self->{TopDir}/conf/hosts\n");
+ if ( !open(HOST_INFO, "$bpc->{TopDir}/conf/hosts") ) {
+ print(STDERR $bpc->timeStamp,
+ "Can't open $bpc->{TopDir}/conf/hosts\n");
return {};
}
+ binmode(HOST_INFO);
while ( <HOST_INFO> ) {
s/[\n\r]+//;
s/#.*//;
s/\s+$//;
- next if ( /^\s*$/ || !/^([\w\.-]+\s+.*)/ );
- @fld = split(/\s+/, $1);
+ next if ( /^\s*$/ || !/^([\w\.\\-]+\s+.*)/ );
+ #
+ # Split on white space, except if preceded by \
+ # using zero-width negative look-behind assertion
+ # (always wanted to use one of those).
+ #
+ @fld = split(/(?<!\\)\s+/, $1);
+ #
+ # Remove any \
+ #
+ foreach ( @fld ) {
+ s{\\(\s)}{$1}g;
+ }
if ( @hdr ) {
if ( defined($host) ) {
next if ( lc($fld[0]) ne $host );
#
sub HostsMTime
{
- my($self) = @_;
- return (stat("$self->{TopDir}/conf/hosts"))[9];
+ my($bpc) = @_;
+ return (stat("$bpc->{TopDir}/conf/hosts"))[9];
}
#
#
sub RmTreeQuiet
{
- my($self, $pwd, $roots) = @_;
+ my($bpc, $pwd, $roots) = @_;
my(@files, $root);
if ( defined($roots) && length($roots) ) {
@files = $d->read;
$d->close;
@files = grep $_!~/^\.{1,2}$/, @files;
- $self->RmTreeQuiet("$pwd/$root", \@files);
+ $bpc->RmTreeQuiet("$pwd/$root", \@files);
chdir($pwd);
rmdir($root) || rmdir($root);
} else {
#
sub RmTreeDefer
{
- my($self, $trashDir, $file) = @_;
+ my($bpc, $trashDir, $file) = @_;
my($i, $f);
return if ( !-e $file );
my($d) = $1;
my($f) = $2;
my($cwd) = Cwd::fastcwd();
- $self->RmTreeQuiet($d, $f);
+ $cwd = $1 if ( $cwd =~ /(.*)/ );
+ $bpc->RmTreeQuiet($d, $f);
chdir($cwd) if ( $cwd );
}
}
#
-# Empty the trash directory. Returns 0 if it did nothing.
+# Empty the trash directory. Returns 0 if it did nothing, 1 if it
+# did something, -1 if it failed to remove all the files.
#
sub RmTreeTrashEmpty
{
- my($self, $trashDir) = @_;
+ my($bpc, $trashDir) = @_;
my(@files);
my($cwd) = Cwd::fastcwd();
+ $cwd = $1 if ( $cwd =~ /(.*)/ );
return if ( !-d $trashDir );
- my $d = DirHandle->new($trashDir)
- or carp "Can't read $trashDir: $!";
+ my $d = DirHandle->new($trashDir) or carp "Can't read $trashDir: $!";
@files = $d->read;
$d->close;
@files = grep $_!~/^\.{1,2}$/, @files;
return 0 if ( !@files );
- $self->RmTreeQuiet($trashDir, \@files);
+ $bpc->RmTreeQuiet($trashDir, \@files);
+ foreach my $f ( @files ) {
+ return -1 if ( -e $f );
+ }
chdir($cwd) if ( $cwd );
return 1;
}
#
sub ServerConnect
{
- my($self, $host, $port, $justConnect) = @_;
+ my($bpc, $host, $port, $justConnect) = @_;
local(*FH);
- return if ( defined($self->{ServerFD}) );
+ return if ( defined($bpc->{ServerFD}) );
#
# First try the unix-domain socket
#
- my $sockFile = "$self->{TopDir}/log/BackupPC.sock";
+ my $sockFile = "$bpc->{TopDir}/log/BackupPC.sock";
socket(*FH, PF_UNIX, SOCK_STREAM, 0) || return "unix socket: $!";
if ( !connect(*FH, sockaddr_un($sockFile)) ) {
my $err = "unix connect: $!";
}
}
my($oldFH) = select(*FH); $| = 1; select($oldFH);
- $self->{ServerFD} = *FH;
+ $bpc->{ServerFD} = *FH;
return if ( $justConnect );
#
# Read the seed that we need for our MD5 message digest. See
# ServerMesg below.
#
- sysread($self->{ServerFD}, $self->{ServerSeed}, 1024);
- $self->{ServerMesgCnt} = 0;
+ sysread($bpc->{ServerFD}, $bpc->{ServerSeed}, 1024);
+ $bpc->{ServerMesgCnt} = 0;
return;
}
#
sub ServerOK
{
- my($self) = @_;
+ my($bpc) = @_;
- return 0 if ( !defined($self->{ServerFD}) );
- vec(my $FDread, fileno($self->{ServerFD}), 1) = 1;
+ return 0 if ( !defined($bpc->{ServerFD}) );
+ vec(my $FDread, fileno($bpc->{ServerFD}), 1) = 1;
my $ein = $FDread;
return 0 if ( select(my $rout = $FDread, undef, $ein, 0.0) < 0 );
- return 1 if ( !vec($rout, fileno($self->{ServerFD}), 1) );
+ return 1 if ( !vec($rout, fileno($bpc->{ServerFD}), 1) );
}
#
#
sub ServerDisconnect
{
- my($self) = @_;
- return if ( !defined($self->{ServerFD}) );
- close($self->{ServerFD});
- delete($self->{ServerFD});
+ my($bpc) = @_;
+ return if ( !defined($bpc->{ServerFD}) );
+ close($bpc->{ServerFD});
+ delete($bpc->{ServerFD});
}
#
#
sub ServerMesg
{
- my($self, $mesg) = @_;
- return if ( !defined(my $fh = $self->{ServerFD}) );
+ my($bpc, $mesg) = @_;
+ return if ( !defined(my $fh = $bpc->{ServerFD}) );
my $md5 = Digest::MD5->new;
- $md5->add($self->{ServerSeed} . $self->{ServerMesgCnt}
- . $self->{Conf}{ServerMesgSecret} . $mesg);
+ $md5->add($bpc->{ServerSeed} . $bpc->{ServerMesgCnt}
+ . $bpc->{Conf}{ServerMesgSecret} . $mesg);
print($fh $md5->b64digest . " $mesg\n");
- $self->{ServerMesgCnt}++;
+ $bpc->{ServerMesgCnt}++;
return <$fh>;
}
#
sub ChildInit
{
- my($self) = @_;
+ my($bpc) = @_;
close(STDERR);
open(STDERR, ">&STDOUT");
select(STDERR); $| = 1;
select(STDOUT); $| = 1;
- $ENV{PATH} = $self->{Conf}{MyPath};
+ $ENV{PATH} = $bpc->{Conf}{MyPath};
}
#
#
sub File2MD5
{
- my($self, $md5, $name) = @_;
+ my($bpc, $md5, $name) = @_;
my($data, $fileSize);
local(*N);
$name = $1 if ( $name =~ /(.*)/ );
return ("", 0) if ( $fileSize == 0 );
return ("", -1) if ( !open(N, $name) );
+ binmode(N);
$md5->reset();
$md5->add($fileSize);
if ( $fileSize > 262144 ) {
#
sub Buffer2MD5
{
- my($self, $md5, $fileSize, $dataRef) = @_;
+ my($bpc, $md5, $fileSize, $dataRef) = @_;
$md5->reset();
$md5->add($fileSize);
#
sub MD52Path
{
- my($self, $d, $compress, $poolDir) = @_;
+ my($bpc, $d, $compress, $poolDir) = @_;
return if ( $d !~ m{(.)(.)(.)(.*)} );
- $poolDir = ($compress ? $self->{CPoolDir} : $self->{PoolDir})
+ $poolDir = ($compress ? $bpc->{CPoolDir} : $bpc->{PoolDir})
if ( !defined($poolDir) );
return "$poolDir/$1/$2/$3/$1$2$3$4";
}
#
-# For each file, check if the file exists in $self->{TopDir}/pool.
+# For each file, check if the file exists in $bpc->{TopDir}/pool.
# If so, remove the file and make a hardlink to the file in
# the pool. Otherwise, if the newFile flag is set, make a
# hardlink in the pool to the new file.
#
sub MakeFileLink
{
- my($self, $name, $d, $newFile, $compress) = @_;
+ my($bpc, $name, $d, $newFile, $compress) = @_;
my($i, $rawFile);
return -1 if ( !-f $name );
for ( $i = -1 ; ; $i++ ) {
- return -2 if ( !defined($rawFile = $self->MD52Path($d, $compress)) );
+ return -2 if ( !defined($rawFile = $bpc->MD52Path($d, $compress)) );
$rawFile .= "_$i" if ( $i >= 0 );
if ( -f $rawFile ) {
- if ( !compare($name, $rawFile) ) {
+ if ( (stat(_))[3] < $bpc->{Conf}{HardLinkMax}
+ && !compare($name, $rawFile) ) {
unlink($name);
return -3 if ( !link($rawFile, $name) );
return 1;
sub CheckHostAlive
{
- my($self, $host) = @_;
- my($s, $pingArgs);
+ my($bpc, $host) = @_;
+ my($s, $pingCmd, $ret);
- $pingArgs = $self->{Conf}{PingArgs};
#
- # Merge variables into $pingArgs
+ # Return success if the ping cmd is undefined or empty.
#
- my $vars = {
- host => $host,
+ if ( $bpc->{Conf}{PingCmd} eq "" ) {
+ print(STDERR "CheckHostAlive: return ok because \$Conf{PingCmd}"
+ . " is empty\n") if ( $bpc->{verbose} );
+ return 0;
+ }
+
+ my $args = {
+ pingPath => $bpc->{Conf}{PingPath},
+ host => $host,
};
- $pingArgs =~ s/\$(\w+)/defined($vars->{$1})
- ? $self->shellEscape($vars->{$1})
- : \$$1/eg;
+ $pingCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{PingCmd}, $args);
+
#
# Do a first ping in case the PC needs to wakeup
#
- $s = `$self->{Conf}{PingPath} $pingArgs 2>&1`;
- return -1 if ( $? );
+ $s = $bpc->cmdSystemOrEval($pingCmd, undef, $args);
+ if ( $? ) {
+ print(STDERR "CheckHostAlive: first ping failed ($?, $!)\n")
+ if ( $bpc->{verbose} );
+ return -1;
+ }
+
#
# Do a second ping and get the round-trip time in msec
#
- $s = `$self->{Conf}{PingPath} $pingArgs 2>&1`;
- return -1 if ( $? );
- return $1 if ( $s !~ /time=([\d\.]+)\s*ms/ );
- return $1/1000 if ( $s !~ /time=([\d\.]+)\s*usec/ );
- return 0;
+ $s = $bpc->cmdSystemOrEval($pingCmd, undef, $args);
+ if ( $? ) {
+ print(STDERR "CheckHostAlive: second ping failed ($?, $!)\n")
+ if ( $bpc->{verbose} );
+ return -1;
+ }
+ if ( $s =~ /time=([\d\.]+)\s*ms/i ) {
+ $ret = $1;
+ } elsif ( $s =~ /time=([\d\.]+)\s*usec/i ) {
+ $ret = $1/1000;
+ } else {
+ print(STDERR "CheckHostAlive: can't extract round-trip time"
+ . " (not fatal)\n") if ( $bpc->{verbose} );
+ $ret = 0;
+ }
+ print(STDERR "CheckHostAlive: returning $ret\n") if ( $bpc->{verbose} );
+ return $ret;
}
sub CheckFileSystemUsage
{
- my($self) = @_;
- my($topDir) = $self->{TopDir};
- my($s);
-
- if ( $^O eq "solaris" ) {
- $s = `$self->{Conf}{DfPath} -k $topDir 2>&1`;
- return 0 if ( $? || $s !~ /(\d+)%/s );
- return $1;
- } elsif ( $^O eq "sunos" ) {
- $s = `$self->{Conf}{DfPath} $topDir 2>&1`;
- return 0 if ( $? || $s !~ /(\d+)%/s );
- return $1;
- } elsif ( $^O eq "linux" ) {
- $s = `$self->{Conf}{DfPath} $topDir 2>&1`;
- return 0 if ( $? || $s !~ /(\d+)%/s );
- return $1;
- } else {
- return 0;
- }
+ my($bpc) = @_;
+ my($topDir) = $bpc->{TopDir};
+ my($s, $dfCmd);
+
+ return 0 if ( $bpc->{Conf}{DfCmd} eq "" );
+ my $args = {
+ dfPath => $bpc->{Conf}{DfPath},
+ topDir => $bpc->{TopDir},
+ };
+ $dfCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{DfCmd}, $args);
+ $s = $bpc->cmdSystemOrEval($dfCmd, undef, $args);
+ return 0 if ( $? || $s !~ /(\d+)%/s );
+ return $1;
}
+#
+# Given an IP address, return the host name and user name via
+# NetBios.
+#
sub NetBiosInfoGet
{
- my($self, $host) = @_;
+ my($bpc, $host) = @_;
my($netBiosHostName, $netBiosUserName);
+ my($s, $nmbCmd);
- foreach ( split(/[\n\r]+/, `$self->{Conf}{NmbLookupPath} -A $host 2>&1`) ) {
- next if ( !/([\w-]+)\s*<(\w{2})\> - .*<ACTIVE>/i );
+ #
+ # Skip NetBios check if NmbLookupCmd is emtpy
+ #
+ if ( $bpc->{Conf}{NmbLookupCmd} eq "" ) {
+ print(STDERR "NetBiosInfoGet: return $host because \$Conf{NmbLookupCmd}"
+ . " is empty\n") if ( $bpc->{verbose} );
+ return ($host, undef);
+ }
+
+ my $args = {
+ nmbLookupPath => $bpc->{Conf}{NmbLookupPath},
+ host => $host,
+ };
+ $nmbCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{NmbLookupCmd}, $args);
+ foreach ( split(/[\n\r]+/, $bpc->cmdSystemOrEval($nmbCmd, undef, $args)) ) {
+ next if ( !/^\s*([\w\s-]+?)\s*<(\w{2})\> - .*<ACTIVE>/i );
$netBiosHostName ||= $1 if ( $2 eq "00" ); # host is first 00
$netBiosUserName = $1 if ( $2 eq "03" ); # user is last 03
}
- return if ( !defined($netBiosHostName) );
- return (lc($netBiosHostName), lc($netBiosUserName));
+ if ( !defined($netBiosHostName) ) {
+ print(STDERR "NetBiosInfoGet: failed: can't parse return string\n")
+ if ( $bpc->{verbose} );
+ return;
+ }
+ $netBiosHostName = lc($netBiosHostName);
+ $netBiosUserName = lc($netBiosUserName);
+ print(STDERR "NetBiosInfoGet: success, returning host $netBiosHostName,"
+ . " user $netBiosUserName\n") if ( $bpc->{verbose} );
+ return ($netBiosHostName, $netBiosUserName);
+}
+
+#
+# Given a NetBios name lookup the IP address via NetBios.
+# In the case of a host returning multiple interfaces we
+# return the first IP address that matches the subnet mask.
+# If none match the subnet mask (or nmblookup doesn't print
+# the subnet mask) then just the first IP address is returned.
+#
+sub NetBiosHostIPFind
+{
+ my($bpc, $host) = @_;
+ my($netBiosHostName, $netBiosUserName);
+ my($s, $nmbCmd, $subnet, $ipAddr, $firstIpAddr);
+
+ #
+ # Skip NetBios lookup if NmbLookupFindHostCmd is emtpy
+ #
+ if ( $bpc->{Conf}{NmbLookupFindHostCmd} eq "" ) {
+ print(STDERR "NetBiosHostIPFind: return $host because"
+ . " \$Conf{NmbLookupFindHostCmd} is empty\n")
+ if ( $bpc->{verbose} );
+ return $host;
+ }
+
+ my $args = {
+ nmbLookupPath => $bpc->{Conf}{NmbLookupPath},
+ host => $host,
+ };
+ $nmbCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{NmbLookupFindHostCmd}, $args);
+ foreach my $resp ( split(/[\n\r]+/, $bpc->cmdSystemOrEval($nmbCmd, undef,
+ $args) ) ) {
+ if ( $resp =~ /querying\s+\Q$host\E\s+on\s+(\d+\.\d+\.\d+\.\d+)/i ) {
+ $subnet = $1;
+ $subnet = $1 if ( $subnet =~ /^(.*?)(\.255)+$/ );
+ } elsif ( $resp =~ /^\s*(\d+\.\d+\.\d+\.\d+)\s+\Q$host/ ) {
+ my $ip = $1;
+ $firstIpAddr = $ip if ( !defined($firstIpAddr) );
+ $ipAddr = $ip if ( !defined($ipAddr) && $ip =~ /^\Q$subnet/ );
+ }
+ }
+ $ipAddr = $firstIpAddr if ( !defined($ipAddr) );
+ if ( defined($ipAddr) ) {
+ print(STDERR "NetBiosHostIPFind: found IP address $ipAddr for"
+ . " host $host\n") if ( $bpc->{verbose} );
+ return $ipAddr;
+ } else {
+ print(STDERR "NetBiosHostIPFind: couldn't find IP address for"
+ . " host $host\n") if ( $bpc->{verbose} );
+ return;
+ }
}
sub fileNameEltMangle
{
- my($self, $name) = @_;
+ my($bpc, $name) = @_;
+ return "" if ( $name eq "" );
$name =~ s{([%/\n\r])}{sprintf("%%%02x", ord($1))}eg;
return "f$name";
}
#
sub fileNameMangle
{
- my($self, $name) = @_;
+ my($bpc, $name) = @_;
- $name =~ s{/([^/]+)}{"/" . $self->fileNameEltMangle($1)}eg;
- $name =~ s{^([^/]+)}{$self->fileNameEltMangle($1)}eg;
+ $name =~ s{/([^/]+)}{"/" . $bpc->fileNameEltMangle($1)}eg;
+ $name =~ s{^([^/]+)}{$bpc->fileNameEltMangle($1)}eg;
return $name;
}
#
sub fileNameUnmangle
{
- my($self, $name) = @_;
+ my($bpc, $name) = @_;
$name =~ s{/f}{/}g;
$name =~ s{^f}{};
#
sub shellEscape
{
- my($self, $cmd) = @_;
+ my($bpc, $cmd) = @_;
$cmd =~ s/([][;&()<>{}|^\n\r\t *\$\\'"`?])/\\$1/g;
return $cmd;
}
+#
+# For printing exec commands (which don't use a shell) so they look like
+# a valid shell command this function should be called with the exec
+# args. The shell command string is returned.
+#
+sub execCmd2ShellCmd
+{
+ my($bpc, @args) = @_;
+ my $str;
+
+ foreach my $a ( @args ) {
+ $str .= " " if ( $str ne "" );
+ $str .= $bpc->shellEscape($a);
+ }
+ return $str;
+}
+
+#
+# Do a URI-style escape to protect/encode special characters
+#
+sub uriEsc
+{
+ my($bpc, $s) = @_;
+ $s =~ s{([^\w.\/-])}{sprintf("%%%02X", ord($1));}eg;
+ return $s;
+}
+
+#
+# Do a URI-style unescape to restore special characters
+#
+sub uriUnesc
+{
+ my($bpc, $s) = @_;
+ $s =~ s{%(..)}{chr(hex($1))}eg;
+ return $s;
+}
+
+#
+# Do variable substitution prior to execution of a command.
+#
+sub cmdVarSubstitute
+{
+ my($bpc, $template, $vars) = @_;
+ my(@cmd);
+
+ #
+ # Return without any substitution if the first entry starts with "&",
+ # indicating this is perl code.
+ #
+ if ( (ref($template) eq "ARRAY" ? $template->[0] : $template) =~ /^\&/ ) {
+ return $template;
+ }
+ if ( ref($template) ne "ARRAY" ) {
+ #
+ # Split at white space, except if escaped by \
+ #
+ $template = [split(/(?<!\\)\s+/, $template)];
+ #
+ # Remove the \ that escaped white space.
+ #
+ foreach ( @$template ) {
+ s{\\(\s)}{$1}g;
+ }
+ }
+ #
+ # Merge variables into @tarClientCmd
+ #
+ foreach my $arg ( @$template ) {
+ #
+ # Replace scalar variables first
+ #
+ $arg =~ s{\$(\w+)(\+?)}{
+ exists($vars->{$1}) && ref($vars->{$1}) ne "ARRAY"
+ ? ($2 eq "+" ? $bpc->shellEscape($vars->{$1}) : $vars->{$1})
+ : "\$$1$2"
+ }eg;
+ #
+ # Now replicate any array arguments; this just works for just one
+ # array var in each argument.
+ #
+ if ( $arg =~ m{(.*)\$(\w+)(\+?)(.*)} && ref($vars->{$2}) eq "ARRAY" ) {
+ my $pre = $1;
+ my $var = $2;
+ my $esc = $3;
+ my $post = $4;
+ foreach my $v ( @{$vars->{$var}} ) {
+ $v = $bpc->shellEscape($v) if ( $esc eq "+" );
+ push(@cmd, "$pre$v$post");
+ }
+ } else {
+ push(@cmd, $arg);
+ }
+ }
+ return \@cmd;
+}
+
+#
+# Exec or eval a command. $cmd is either a string on an array ref.
+#
+# @args are optional arguments for the eval() case; they are not used
+# for exec().
+#
+sub cmdExecOrEval
+{
+ my($bpc, $cmd, @args) = @_;
+
+ if ( (ref($cmd) eq "ARRAY" ? $cmd->[0] : $cmd) =~ /^\&/ ) {
+ $cmd = join(" ", $cmd) if ( ref($cmd) eq "ARRAY" );
+ print(STDERR "cmdExecOrEval: about to eval perl code $cmd\n")
+ if ( $bpc->{verbose} );
+ eval($cmd);
+ print(STDERR "Perl code fragment for exec shouldn't return!!\n");
+ exit(1);
+ } else {
+ $cmd = [split(/\s+/, $cmd)] if ( ref($cmd) ne "ARRAY" );
+ print(STDERR "cmdExecOrEval: about to exec ",
+ $bpc->execCmd2ShellCmd(@$cmd), "\n")
+ if ( $bpc->{verbose} );
+ alarm(0);
+ $cmd = [map { m/(.*)/ } @$cmd]; # untaint
+ #
+ # force list-form of exec(), ie: no shell even for 1 arg
+ #
+ exec { $cmd->[0] } @$cmd;
+ print(STDERR "Exec failed for @$cmd\n");
+ exit(1);
+ }
+}
+
+#
+# System or eval a command. $cmd is either a string on an array ref.
+# $stdoutCB is a callback for output generated by the command. If it
+# is undef then output is returned. If it is a code ref then the function
+# is called with each piece of output as an argument. If it is a scalar
+# ref the output is appended to this variable.
+#
+# @args are optional arguments for the eval() case; they are not used
+# for system().
+#
+# Also, $? should be set when the CHILD pipe is closed.
+#
+sub cmdSystemOrEval
+{
+ my($bpc, $cmd, $stdoutCB, @args) = @_;
+ my($pid, $out, $allOut);
+ local(*CHILD);
+
+ if ( (ref($cmd) eq "ARRAY" ? $cmd->[0] : $cmd) =~ /^\&/ ) {
+ $cmd = join(" ", $cmd) if ( ref($cmd) eq "ARRAY" );
+ print(STDERR "cmdSystemOrEval: about to eval perl code $cmd\n")
+ if ( $bpc->{verbose} );
+ $out = eval($cmd);
+ $$stdoutCB .= $out if ( ref($stdoutCB) eq 'SCALAR' );
+ &$stdoutCB($out) if ( ref($stdoutCB) eq 'CODE' );
+ print(STDERR "cmdSystemOrEval: finished: got output $out\n")
+ if ( $bpc->{verbose} );
+ return $out if ( !defined($stdoutCB) );
+ return;
+ } else {
+ $cmd = [split(/\s+/, $cmd)] if ( ref($cmd) ne "ARRAY" );
+ print(STDERR "cmdSystemOrEval: about to system ",
+ $bpc->execCmd2ShellCmd(@$cmd), "\n")
+ if ( $bpc->{verbose} );
+ if ( !defined($pid = open(CHILD, "-|")) ) {
+ my $err = "Can't fork to run @$cmd\n";
+ $? = 1;
+ $$stdoutCB .= $err if ( ref($stdoutCB) eq 'SCALAR' );
+ &$stdoutCB($err) if ( ref($stdoutCB) eq 'CODE' );
+ return $err if ( !defined($stdoutCB) );
+ return;
+ }
+ binmode(CHILD);
+ if ( !$pid ) {
+ #
+ # This is the child
+ #
+ close(STDERR);
+ open(STDERR, ">&STDOUT");
+ alarm(0);
+ $cmd = [map { m/(.*)/ } @$cmd]; # untaint
+ #
+ # force list-form of exec(), ie: no shell even for 1 arg
+ #
+ exec { $cmd->[0] } @$cmd;
+ print("Exec of @$cmd failed\n");
+ exit(1);
+ }
+ #
+ # The parent gathers the output from the child
+ #
+ while ( <CHILD> ) {
+ $$stdoutCB .= $_ if ( ref($stdoutCB) eq 'SCALAR' );
+ &$stdoutCB($_) if ( ref($stdoutCB) eq 'CODE' );
+ $out .= $_ if ( !defined($stdoutCB) );
+ $allOut .= $_ if ( $bpc->{verbose} );
+ }
+ $? = 0;
+ close(CHILD);
+ }
+ print(STDERR "cmdSystemOrEval: finished: got output $allOut\n")
+ if ( $bpc->{verbose} );
+ return $out;
+}
+
1;
projects / BackupPC.git / blobdiff