1 #============================================================= -*-perl-*-
3 # BackupPC::Lib package
7 # This library defines a BackupPC::Lib class and a variety of utility
8 # functions used by BackupPC.
11 # Craig Barratt <cbarratt@users.sourceforge.net>
14 # Copyright (C) 2001-2009 Craig Barratt
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
26 # You should have received a copy of the GNU General Public License
27 # along with this program; if not, write to the Free Software
28 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #========================================================================
32 # Version 3.2.0, released 31 Jul 2010.
34 # See http://backuppc.sourceforge.net.
36 #========================================================================
38 package BackupPC::Lib;
42 use vars qw(%Conf %Lang);
43 use BackupPC::Storage;
52 use Encode qw/from_to encode_utf8/;
54 use vars qw( $IODirentOk $IODirentLoaded );
55 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
60 @ISA = qw(Exporter DynaLoader);
61 @EXPORT_OK = qw( BPC_DT_UNKNOWN
71 %EXPORT_TAGS = ('BPC_DT_ALL' => [@EXPORT, @EXPORT_OK]);
74 eval "use IO::Dirent qw( readdirent DT_DIR );";
75 $IODirentLoaded = 1 if ( !$@ );
79 # The need to match the constants in IO::Dirent
81 use constant BPC_DT_UNKNOWN => 0;
82 use constant BPC_DT_FIFO => 1; ## named pipe (fifo)
83 use constant BPC_DT_CHR => 2; ## character special
84 use constant BPC_DT_DIR => 4; ## directory
85 use constant BPC_DT_BLK => 6; ## block special
86 use constant BPC_DT_REG => 8; ## regular
87 use constant BPC_DT_LNK => 10; ## symbolic link
88 use constant BPC_DT_SOCK => 12; ## socket
93 my($topDir, $installDir, $confDir, $noUserCheck) = @_;
96 # Whether to use filesystem hierarchy standard for file layout.
97 # If set, text config files are below /etc/BackupPC.
103 # Set defaults for $topDir and $installDir.
105 $topDir = '/data/BackupPC' if ( $topDir eq "" );
106 $installDir = '/usr/local/BackupPC' if ( $installDir eq "" );
108 $confDir = '/etc/BackupPC'; # FIXME remove this! XXX
111 # Pick some initial defaults. For FHS the only critical
112 # path is the ConfDir, since we get everything else out
113 # of the main config file.
119 InstallDir => $installDir,
120 ConfDir => $confDir eq "" ? '/data/BackupPC/conf' : $confDir,
121 LogDir => '/var/log/BackupPC',
127 InstallDir => $installDir,
128 ConfDir => $confDir eq "" ? "$topDir/conf" : $confDir,
129 LogDir => "$topDir/log",
138 $bpc->{storage} = BackupPC::Storage->new($paths);
141 # Clean up %ENV and setup other variables.
143 delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
144 if ( defined(my $error = $bpc->ConfigRead()) ) {
145 print(STDERR $error, "\n");
150 # Update the paths based on the config file
152 foreach my $dir ( qw(TopDir ConfDir InstallDir LogDir) ) {
153 next if ( $bpc->{Conf}{$dir} eq "" );
154 $paths->{$dir} = $bpc->{$dir} = $bpc->{Conf}{$dir};
156 $bpc->{storage}->setPaths($paths);
157 $bpc->{PoolDir} = "$bpc->{TopDir}/pool";
158 $bpc->{CPoolDir} = "$bpc->{TopDir}/cpool";
161 # Verify we are running as the correct user
164 && $bpc->{Conf}{BackupPCUserVerify}
165 && $> != (my $uid = (getpwnam($bpc->{Conf}{BackupPCUser}))[2]) ) {
166 print(STDERR "$0: Wrong user: my userid is $>, instead of $uid"
167 . " ($bpc->{Conf}{BackupPCUser})\n");
168 print(STDERR "Please su $bpc->{Conf}{BackupPCUser} first\n");
177 return $bpc->{TopDir};
183 return "$bpc->{InstallDir}/bin";
189 return $bpc->{LogDir};
195 return $bpc->{ConfDir};
201 return "$bpc->{InstallDir}/lib";
207 return $bpc->{InstallDir};
213 return $bpc->{useFHS};
219 return $bpc->{Version};
225 return %{$bpc->{Conf}};
237 return " admin " if ( !$num );
238 return " admin$num ";
244 return $str =~ /^ admin/;
249 return " trashClean ";
254 my($bpc, $param) = @_;
256 return $bpc->{Conf}{$param};
261 my($bpc, $param) = @_;
263 $bpc->{verbose} = $param if ( defined($param) );
264 return $bpc->{verbose};
271 if ( !defined($bpc->{SigName2Num}) ) {
273 foreach my $name ( split(' ', $Config{sig_name}) ) {
274 $bpc->{SigName2Num}{$name} = $i;
278 return $bpc->{SigName2Num}{$sig};
282 # Generate an ISO 8601 format timeStamp (but without the "T").
283 # See http://www.w3.org/TR/NOTE-datetime and
284 # http://www.cl.cam.ac.uk/~mgk25/iso-time.html
288 my($bpc, $t, $noPad) = @_;
289 my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
290 = localtime($t || time);
291 return sprintf("%04d-%02d-%02d %02d:%02d:%02d",
292 $year + 1900, $mon + 1, $mday, $hour, $min, $sec)
293 . ($noPad ? "" : " ");
298 my($bpc, $host) = @_;
300 return $bpc->{storage}->BackupInfoRead($host);
305 my($bpc, $host, @Backups) = @_;
307 return $bpc->{storage}->BackupInfoWrite($host, @Backups);
312 my($bpc, $host) = @_;
314 return $bpc->{storage}->RestoreInfoRead($host);
319 my($bpc, $host, @Restores) = @_;
321 return $bpc->{storage}->RestoreInfoWrite($host, @Restores);
326 my($bpc, $host) = @_;
328 return $bpc->{storage}->ArchiveInfoRead($host);
333 my($bpc, $host, @Archives) = @_;
335 return $bpc->{storage}->ArchiveInfoWrite($host, @Archives);
340 my($bpc, $host) = @_;
342 return $bpc->{storage}->ConfigDataRead($host);
347 my($bpc, $host, $conf) = @_;
349 return $bpc->{storage}->ConfigDataWrite($host, $conf);
354 my($bpc, $host) = @_;
358 # Read main config file
360 my($mesg, $config) = $bpc->{storage}->ConfigDataRead();
361 return $mesg if ( defined($mesg) );
363 $bpc->{Conf} = $config;
366 # Read host config file
369 ($mesg, $config) = $bpc->{storage}->ConfigDataRead($host, $config);
370 return $mesg if ( defined($mesg) );
371 $bpc->{Conf} = $config;
375 # Load optional perl modules
377 if ( defined($bpc->{Conf}{PerlModuleLoad}) ) {
379 # Load any user-specified perl modules. This is for
380 # optional user-defined extensions.
382 $bpc->{Conf}{PerlModuleLoad} = [$bpc->{Conf}{PerlModuleLoad}]
383 if ( ref($bpc->{Conf}{PerlModuleLoad}) ne "ARRAY" );
384 foreach my $module ( @{$bpc->{Conf}{PerlModuleLoad}} ) {
385 eval("use $module;");
392 return "No language setting" if ( !defined($bpc->{Conf}{Language}) );
393 my $langFile = "$bpc->{InstallDir}/lib/BackupPC/Lang/$bpc->{Conf}{Language}.pm";
394 if ( !defined($ret = do $langFile) && ($! || $@) ) {
395 $mesg = "Couldn't open language file $langFile: $!" if ( $! );
396 $mesg = "Couldn't execute language file $langFile: $@" if ( $@ );
397 $mesg =~ s/[\n\r]+//;
400 $bpc->{Lang} = \%Lang;
403 # Make sure IncrLevels is defined
405 $bpc->{Conf}{IncrLevels} = [1] if ( !defined($bpc->{Conf}{IncrLevels}) );
411 # Return the mtime of the config file
417 return $bpc->{storage}->ConfigMTime();
421 # Returns information from the host file in $bpc->{TopDir}/conf/hosts.
422 # With no argument a ref to a hash of hosts is returned. Each
423 # hash contains fields as specified in the hosts file. With an
424 # argument a ref to a single hash is returned with information
425 # for just that host.
429 my($bpc, $host) = @_;
431 return $bpc->{storage}->HostInfoRead($host);
436 my($bpc, $host) = @_;
438 return $bpc->{storage}->HostInfoWrite($host);
442 # Return the mtime of the hosts file
448 return $bpc->{storage}->HostsMTime();
452 # Read a directory and return the entries in sorted inode order.
453 # This relies on the IO::Dirent module being installed. If not,
454 # the inode data is empty and the default directory order is
457 # The returned data is a list of hashes with entries {name, type, inode, nlink}.
458 # The returned data includes "." and "..".
460 # $need is a hash of file attributes we need: type, inode, or nlink.
461 # If set, these parameters are added to the returned hash.
463 # To support browsing pre-3.0.0 backups where the charset encoding
464 # is typically iso-8859-1, the charsetLegacy option can be set in
465 # $need to convert the path from utf8 and convert the names to utf8.
467 # If IO::Dirent is successful if will get type and inode for free.
468 # Otherwise, a stat is done on each file, which is more expensive.
472 my($bpc, $path, $need) = @_;
473 my(@entries, $addInode);
475 from_to($path, "utf8", $need->{charsetLegacy})
476 if ( $need->{charsetLegacy} ne "" );
477 return if ( !opendir(my $fh, $path) );
478 if ( $IODirentLoaded && !$IODirentOk ) {
480 # Make sure the IO::Dirent really works - some installs
481 # on certain file systems (eg: XFS) don't return a valid type.
483 if ( opendir(my $fh, $bpc->{TopDir}) ) {
484 my $dt_dir = eval("DT_DIR");
485 foreach my $e ( readdirent($fh) ) {
486 if ( $e->{name} eq "." && $e->{type} == $dt_dir ) {
494 # if it isn't ok then don't check again.
496 $IODirentLoaded = 0 if ( !$IODirentOk );
499 @entries = sort({ $a->{inode} <=> $b->{inode} } readdirent($fh));
500 map { $_->{type} = 0 + $_->{type} } @entries; # make type numeric
502 @entries = map { { name => $_} } readdir($fh);
505 if ( defined($need) ) {
506 for ( my $i = 0 ; $i < @entries ; $i++ ) {
507 next if ( (!$need->{inode} || defined($entries[$i]{inode}))
508 && (!$need->{type} || defined($entries[$i]{type}))
509 && (!$need->{nlink} || defined($entries[$i]{nlink})) );
510 my @s = stat("$path/$entries[$i]{name}");
511 $entries[$i]{nlink} = $s[3] if ( $need->{nlink} );
512 if ( $need->{inode} && !defined($entries[$i]{inode}) ) {
514 $entries[$i]{inode} = $s[1];
516 if ( $need->{type} && !defined($entries[$i]{type}) ) {
517 my $mode = S_IFMT($s[2]);
518 $entries[$i]{type} = BPC_DT_FIFO if ( S_ISFIFO($mode) );
519 $entries[$i]{type} = BPC_DT_CHR if ( S_ISCHR($mode) );
520 $entries[$i]{type} = BPC_DT_DIR if ( S_ISDIR($mode) );
521 $entries[$i]{type} = BPC_DT_BLK if ( S_ISBLK($mode) );
522 $entries[$i]{type} = BPC_DT_REG if ( S_ISREG($mode) );
523 $entries[$i]{type} = BPC_DT_LNK if ( S_ISLNK($mode) );
524 $entries[$i]{type} = BPC_DT_SOCK if ( S_ISSOCK($mode) );
529 # Sort the entries if inodes were added (the IO::Dirent case already
532 @entries = sort({ $a->{inode} <=> $b->{inode} } @entries) if ( $addInode );
534 # for browing pre-3.0.0 backups, map iso-8859-1 to utf8 if requested
536 if ( $need->{charsetLegacy} ne "" ) {
537 for ( my $i = 0 ; $i < @entries ; $i++ ) {
538 from_to($entries[$i]{name}, $need->{charsetLegacy}, "utf8");
545 # Same as dirRead, but only returns the names (which will be sorted in
546 # inode order if IO::Dirent is installed)
550 my($bpc, $path, $need) = @_;
552 my $entries = $bpc->dirRead($path, $need);
553 return if ( !defined($entries) );
554 my @names = map { $_->{name} } @$entries;
560 my($bpc, $param, $dir, $dontDoCwd) = @_;
562 return if ( !chdir($dir) );
563 my $entries = $bpc->dirRead(".", {inode => 1, type => 1});
564 #print Dumper($entries);
565 foreach my $f ( @$entries ) {
566 next if ( $f->{name} eq ".." || $f->{name} eq "." && $dontDoCwd );
567 $param->{wanted}($f->{name}, "$dir/$f->{name}");
568 next if ( $f->{type} != BPC_DT_DIR || $f->{name} eq "." );
570 $bpc->find($param, "$dir/$f->{name}", 1);
571 return if ( !chdir("..") );
576 # Stripped down from File::Path. In particular we don't print
577 # many warnings and we try three times to delete each directory
578 # and file -- for some reason the original File::Path rmtree
579 # didn't always completely remove a directory tree on a NetApp.
581 # Warning: this routine changes the cwd.
585 my($bpc, $pwd, $roots) = @_;
588 if ( defined($roots) && length($roots) ) {
589 $roots = [$roots] unless ref $roots;
591 print(STDERR "RmTreeQuiet: No root path(s) specified\n");
594 foreach $root (@{$roots}) {
595 $root = $1 if ( $root =~ m{(.*?)/*$} );
597 # Try first to simply unlink the file: this avoids an
598 # extra stat for every file. If it fails (which it
599 # will for directories), check if it is a directory and
602 if ( !unlink($root) ) {
604 my $d = $bpc->dirReadNames($root);
605 if ( !defined($d) ) {
606 print(STDERR "Can't read $pwd/$root: $!\n");
608 @files = grep $_ !~ /^\.{1,2}$/, @$d;
609 $bpc->RmTreeQuiet("$pwd/$root", \@files);
611 rmdir($root) || rmdir($root);
614 unlink($root) || unlink($root);
621 # Move a directory or file away for later deletion
625 my($bpc, $trashDir, $file) = @_;
628 return if ( !-e $file );
629 if ( !-d $trashDir ) {
630 eval { mkpath($trashDir, 0, 0777) };
633 # There's no good place to send this error - use stderr
635 print(STDERR "RmTreeDefer: can't create directory $trashDir");
638 for ( $i = 0 ; $i < 1000 ; $i++ ) {
639 $f = sprintf("%s/%d_%d_%d", $trashDir, time, $$, $i);
641 return if ( rename($file, $f) );
643 # shouldn't get here, but might if you tried to call this
644 # across file systems.... just remove the tree right now.
645 if ( $file =~ /(.*)\/([^\/]*)/ ) {
648 my($cwd) = Cwd::fastcwd();
649 $cwd = $1 if ( $cwd =~ /(.*)/ );
650 $bpc->RmTreeQuiet($d, $f);
651 chdir($cwd) if ( $cwd );
656 # Empty the trash directory. Returns 0 if it did nothing, 1 if it
657 # did something, -1 if it failed to remove all the files.
661 my($bpc, $trashDir) = @_;
663 my($cwd) = Cwd::fastcwd();
665 $cwd = $1 if ( $cwd =~ /(.*)/ );
666 return if ( !-d $trashDir );
667 my $d = $bpc->dirReadNames($trashDir) or carp "Can't read $trashDir: $!";
668 @files = grep $_ !~ /^\.{1,2}$/, @$d;
669 return 0 if ( !@files );
670 $bpc->RmTreeQuiet($trashDir, \@files);
671 foreach my $f ( @files ) {
672 return -1 if ( -e $f );
674 chdir($cwd) if ( $cwd );
679 # Open a connection to the server. Returns an error string on failure.
680 # Returns undef on success.
684 my($bpc, $host, $port, $justConnect) = @_;
687 return if ( defined($bpc->{ServerFD}) );
689 # First try the unix-domain socket
691 my $sockFile = "$bpc->{LogDir}/BackupPC.sock";
692 socket(*FH, PF_UNIX, SOCK_STREAM, 0) || return "unix socket: $!";
693 if ( !connect(*FH, sockaddr_un($sockFile)) ) {
694 my $err = "unix connect: $!";
697 my $proto = getprotobyname('tcp');
698 my $iaddr = inet_aton($host) || return "unknown host $host";
699 my $paddr = sockaddr_in($port, $iaddr);
701 socket(*FH, PF_INET, SOCK_STREAM, $proto)
702 || return "inet socket: $!";
703 connect(*FH, $paddr) || return "inet connect: $!";
708 my($oldFH) = select(*FH); $| = 1; select($oldFH);
709 $bpc->{ServerFD} = *FH;
710 return if ( $justConnect );
712 # Read the seed that we need for our MD5 message digest. See
715 sysread($bpc->{ServerFD}, $bpc->{ServerSeed}, 1024);
716 $bpc->{ServerMesgCnt} = 0;
721 # Check that the server connection is still ok
727 return 0 if ( !defined($bpc->{ServerFD}) );
728 vec(my $FDread, fileno($bpc->{ServerFD}), 1) = 1;
730 return 0 if ( select(my $rout = $FDread, undef, $ein, 0.0) < 0 );
731 return 1 if ( !vec($rout, fileno($bpc->{ServerFD}), 1) );
735 # Disconnect from the server
740 return if ( !defined($bpc->{ServerFD}) );
741 close($bpc->{ServerFD});
742 delete($bpc->{ServerFD});
746 # Sends a message to the server and returns with the reply.
748 # To avoid possible attacks via the TCP socket interface, every client
749 # message is protected by an MD5 digest. The MD5 digest includes four
751 # - a seed that is sent to us when we first connect
752 # - a sequence number that increments for each message
753 # - a shared secret that is stored in $Conf{ServerMesgSecret}
754 # - the message itself.
755 # The message is sent in plain text preceded by the MD5 digest. A
756 # snooper can see the plain-text seed sent by BackupPC and plain-text
757 # message, but cannot construct a valid MD5 digest since the secret in
758 # $Conf{ServerMesgSecret} is unknown. A replay attack is not possible
759 # since the seed changes on a per-connection and per-message basis.
763 my($bpc, $mesg) = @_;
764 return if ( !defined(my $fh = $bpc->{ServerFD}) );
767 my $md5 = Digest::MD5->new;
768 $mesg = encode_utf8($mesg);
769 $md5->add($bpc->{ServerSeed} . $bpc->{ServerMesgCnt}
770 . $bpc->{Conf}{ServerMesgSecret} . $mesg);
771 print($fh $md5->b64digest . " $mesg\n");
772 $bpc->{ServerMesgCnt}++;
777 # Do initialization for child processes
783 open(STDERR, ">&STDOUT");
784 select(STDERR); $| = 1;
785 select(STDOUT); $| = 1;
786 $ENV{PATH} = $bpc->{Conf}{MyPath};
790 # Compute the MD5 digest of a file. For efficiency we don't
791 # use the whole file for big files:
792 # - for files <= 256K we use the file size and the whole file.
793 # - for files <= 1M we use the file size, the first 128K and
795 # - for files > 1M, we use the file size, the first 128K and
796 # the 8th 128K (ie: the 128K up to 1MB).
797 # See the documentation for a discussion of the tradeoffs in
798 # how much data we use and how many collisions we get.
800 # Returns the MD5 digest (a hex string) and the file size.
804 my($bpc, $md5, $name) = @_;
805 my($data, $fileSize);
808 $fileSize = (stat($name))[7];
809 return ("", -1) if ( !-f _ );
810 $name = $1 if ( $name =~ /(.*)/ );
811 return ("", 0) if ( $fileSize == 0 );
812 return ("", -1) if ( !open(N, $name) );
815 $md5->add($fileSize);
816 if ( $fileSize > 262144 ) {
818 # read the first and last 131072 bytes of the file,
821 my $seekPosn = ($fileSize > 1048576 ? 1048576 : $fileSize) - 131072;
822 $md5->add($data) if ( sysread(N, $data, 131072) );
823 $md5->add($data) if ( sysseek(N, $seekPosn, 0)
824 && sysread(N, $data, 131072) );
827 # read the whole file
829 $md5->add($data) if ( sysread(N, $data, $fileSize) );
832 return ($md5->hexdigest, $fileSize);
836 # Compute the MD5 digest of a buffer (string). For efficiency we don't
837 # use the whole string for big strings:
838 # - for files <= 256K we use the file size and the whole file.
839 # - for files <= 1M we use the file size, the first 128K and
841 # - for files > 1M, we use the file size, the first 128K and
842 # the 8th 128K (ie: the 128K up to 1MB).
843 # See the documentation for a discussion of the tradeoffs in
844 # how much data we use and how many collisions we get.
846 # Returns the MD5 digest (a hex string).
850 my($bpc, $md5, $fileSize, $dataRef) = @_;
853 $md5->add($fileSize);
854 if ( $fileSize > 262144 ) {
856 # add the first and last 131072 bytes of the string,
859 my $seekPosn = ($fileSize > 1048576 ? 1048576 : $fileSize) - 131072;
860 $md5->add(substr($$dataRef, 0, 131072));
861 $md5->add(substr($$dataRef, $seekPosn, 131072));
864 # add the whole string
866 $md5->add($$dataRef);
868 return $md5->hexdigest;
872 # Given an MD5 digest $d and a compress flag, return the full
877 my($bpc, $d, $compress, $poolDir) = @_;
879 return if ( $d !~ m{(.)(.)(.)(.*)} );
880 $poolDir = ($compress ? $bpc->{CPoolDir} : $bpc->{PoolDir})
881 if ( !defined($poolDir) );
882 return "$poolDir/$1/$2/$3/$1$2$3$4";
886 # For each file, check if the file exists in $bpc->{TopDir}/pool.
887 # If so, remove the file and make a hardlink to the file in
888 # the pool. Otherwise, if the newFile flag is set, make a
889 # hardlink in the pool to the new file.
891 # Returns 0 if a link should be made to a new file (ie: when the file
892 # is a new file but the newFile flag is 0).
893 # Returns 1 if a link to an existing file is made,
894 # Returns 2 if a link to a new file is made (only if $newFile is set)
895 # Returns negative on error.
899 my($bpc, $name, $d, $newFile, $compress) = @_;
902 return -1 if ( !-f $name );
903 for ( $i = -1 ; ; $i++ ) {
904 return -2 if ( !defined($rawFile = $bpc->MD52Path($d, $compress)) );
905 $rawFile .= "_$i" if ( $i >= 0 );
907 if ( (stat(_))[3] < $bpc->{Conf}{HardLinkMax}
908 && !compare($name, $rawFile) ) {
910 return -3 if ( !link($rawFile, $name) );
913 } elsif ( $newFile && -f $name && (stat($name))[3] == 1 ) {
915 ($newDir = $rawFile) =~ s{(.*)/.*}{$1};
917 eval { mkpath($newDir, 0, 0777) };
920 return -4 if ( !link($name, $rawFile) );
929 # Tests if we can create a hardlink from a file in directory
930 # $newDir to a file in directory $targetDir. A temporary
931 # file in $targetDir is created and an attempt to create a
932 # hardlink of the same name in $newDir is made. The temporary
935 # Like link(), returns true on success and false on failure.
939 my($bpc, $targetDir, $newDir) = @_;
941 my($targetFile, $newFile, $fd);
942 for ( my $i = 0 ; ; $i++ ) {
943 $targetFile = "$targetDir/.TestFileLink.$$.$i";
944 $newFile = "$newDir/.TestFileLink.$$.$i";
945 last if ( !-e $targetFile && !-e $newFile );
947 return 0 if ( !open($fd, ">", $targetFile) );
949 my $ret = link($targetFile, $newFile);
957 my($bpc, $host) = @_;
958 my($s, $pingCmd, $ret);
961 # Return success if the ping cmd is undefined or empty.
963 if ( $bpc->{Conf}{PingCmd} eq "" ) {
964 print(STDERR "CheckHostAlive: return ok because \$Conf{PingCmd}"
965 . " is empty\n") if ( $bpc->{verbose} );
970 pingPath => $bpc->{Conf}{PingPath},
973 $pingCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{PingCmd}, $args);
976 # Do a first ping in case the PC needs to wakeup
978 $s = $bpc->cmdSystemOrEval($pingCmd, undef, $args);
980 print(STDERR "CheckHostAlive: first ping failed ($?, $!)\n")
981 if ( $bpc->{verbose} );
986 # Do a second ping and get the round-trip time in msec
988 $s = $bpc->cmdSystemOrEval($pingCmd, undef, $args);
990 print(STDERR "CheckHostAlive: second ping failed ($?, $!)\n")
991 if ( $bpc->{verbose} );
994 if ( $s =~ /rtt\s*min\/avg\/max\/mdev\s*=\s*[\d.]+\/([\d.]+)\/[\d.]+\/[\d.]+\s*(ms|usec)/i ) {
996 $ret /= 1000 if ( lc($2) eq "usec" );
997 } elsif ( $s =~ /time=([\d.]+)\s*(ms|usec)/i ) {
999 $ret /= 1000 if ( lc($2) eq "usec" );
1001 print(STDERR "CheckHostAlive: can't extract round-trip time"
1002 . " (not fatal)\n") if ( $bpc->{verbose} );
1005 print(STDERR "CheckHostAlive: returning $ret\n") if ( $bpc->{verbose} );
1009 sub CheckFileSystemUsage
1012 my($topDir) = $bpc->{TopDir};
1015 return 0 if ( $bpc->{Conf}{DfCmd} eq "" );
1017 dfPath => $bpc->{Conf}{DfPath},
1018 topDir => $bpc->{TopDir},
1020 $dfCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{DfCmd}, $args);
1021 $s = $bpc->cmdSystemOrEval($dfCmd, undef, $args);
1022 return 0 if ( $? || $s !~ /(\d+)%/s );
1027 # Given an IP address, return the host name and user name via
1032 my($bpc, $host) = @_;
1033 my($netBiosHostName, $netBiosUserName);
1037 # Skip NetBios check if NmbLookupCmd is emtpy
1039 if ( $bpc->{Conf}{NmbLookupCmd} eq "" ) {
1040 print(STDERR "NetBiosInfoGet: return $host because \$Conf{NmbLookupCmd}"
1041 . " is empty\n") if ( $bpc->{verbose} );
1042 return ($host, undef);
1046 nmbLookupPath => $bpc->{Conf}{NmbLookupPath},
1049 $nmbCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{NmbLookupCmd}, $args);
1050 foreach ( split(/[\n\r]+/, $bpc->cmdSystemOrEval($nmbCmd, undef, $args)) ) {
1052 # skip <GROUP> and other non <ACTIVE> entries
1054 next if ( /<\w{2}> - <GROUP>/i );
1055 next if ( !/^\s*([\w\s-]+?)\s*<(\w{2})\> - .*<ACTIVE>/i );
1056 $netBiosHostName ||= $1 if ( $2 eq "00" ); # host is first 00
1057 $netBiosUserName = $1 if ( $2 eq "03" ); # user is last 03
1059 if ( !defined($netBiosHostName) ) {
1060 print(STDERR "NetBiosInfoGet: failed: can't parse return string\n")
1061 if ( $bpc->{verbose} );
1064 $netBiosHostName = lc($netBiosHostName);
1065 $netBiosUserName = lc($netBiosUserName);
1066 print(STDERR "NetBiosInfoGet: success, returning host $netBiosHostName,"
1067 . " user $netBiosUserName\n") if ( $bpc->{verbose} );
1068 return ($netBiosHostName, $netBiosUserName);
1072 # Given a NetBios name lookup the IP address via NetBios.
1073 # In the case of a host returning multiple interfaces we
1074 # return the first IP address that matches the subnet mask.
1075 # If none match the subnet mask (or nmblookup doesn't print
1076 # the subnet mask) then just the first IP address is returned.
1078 sub NetBiosHostIPFind
1080 my($bpc, $host) = @_;
1081 my($netBiosHostName, $netBiosUserName);
1082 my($s, $nmbCmd, $subnet, $ipAddr, $firstIpAddr);
1085 # Skip NetBios lookup if NmbLookupFindHostCmd is emtpy
1087 if ( $bpc->{Conf}{NmbLookupFindHostCmd} eq "" ) {
1088 print(STDERR "NetBiosHostIPFind: return $host because"
1089 . " \$Conf{NmbLookupFindHostCmd} is empty\n")
1090 if ( $bpc->{verbose} );
1095 nmbLookupPath => $bpc->{Conf}{NmbLookupPath},
1098 $nmbCmd = $bpc->cmdVarSubstitute($bpc->{Conf}{NmbLookupFindHostCmd}, $args);
1099 foreach my $resp ( split(/[\n\r]+/, $bpc->cmdSystemOrEval($nmbCmd, undef,
1101 if ( $resp =~ /querying\s+\Q$host\E\s+on\s+(\d+\.\d+\.\d+\.\d+)/i ) {
1103 $subnet = $1 if ( $subnet =~ /^(.*?)(\.255)+$/ );
1104 } elsif ( $resp =~ /^\s*(\d+\.\d+\.\d+\.\d+)\s+\Q$host/ ) {
1106 $firstIpAddr = $ip if ( !defined($firstIpAddr) );
1107 $ipAddr = $ip if ( !defined($ipAddr) && $ip =~ /^\Q$subnet/ );
1110 $ipAddr = $firstIpAddr if ( !defined($ipAddr) );
1111 if ( defined($ipAddr) ) {
1112 print(STDERR "NetBiosHostIPFind: found IP address $ipAddr for"
1113 . " host $host\n") if ( $bpc->{verbose} );
1116 print(STDERR "NetBiosHostIPFind: couldn't find IP address for"
1117 . " host $host\n") if ( $bpc->{verbose} );
1122 sub fileNameEltMangle
1124 my($bpc, $name) = @_;
1126 return "" if ( $name eq "" );
1127 $name =~ s{([%/\n\r])}{sprintf("%%%02x", ord($1))}eg;
1132 # We store files with every name preceded by "f". This
1133 # avoids possible name conflicts with other information
1134 # we store in the same directories (eg: attribute info).
1135 # The process of turning a normal path into one with each
1136 # node prefixed with "f" is called mangling.
1140 my($bpc, $name) = @_;
1142 $name =~ s{/([^/]+)}{"/" . $bpc->fileNameEltMangle($1)}eg;
1143 $name =~ s{^([^/]+)}{$bpc->fileNameEltMangle($1)}eg;
1148 # This undoes FileNameMangle
1150 sub fileNameUnmangle
1152 my($bpc, $name) = @_;
1156 $name =~ s{%(..)}{chr(hex($1))}eg;
1161 # Escape shell meta-characters with backslashes.
1162 # This should be applied to each argument seperately, not an
1163 # entire shell command.
1167 my($bpc, $cmd) = @_;
1169 $cmd =~ s/([][;&()<>{}|^\n\r\t *\$\\'"`?])/\\$1/g;
1174 # For printing exec commands (which don't use a shell) so they look like
1175 # a valid shell command this function should be called with the exec
1176 # args. The shell command string is returned.
1178 sub execCmd2ShellCmd
1180 my($bpc, @args) = @_;
1183 foreach my $a ( @args ) {
1184 $str .= " " if ( $str ne "" );
1185 $str .= $bpc->shellEscape($a);
1191 # Do a URI-style escape to protect/encode special characters
1196 $s =~ s{([^\w.\/-])}{sprintf("%%%02X", ord($1));}eg;
1201 # Do a URI-style unescape to restore special characters
1206 $s =~ s{%(..)}{chr(hex($1))}eg;
1211 # Do variable substitution prior to execution of a command.
1213 sub cmdVarSubstitute
1215 my($bpc, $template, $vars) = @_;
1219 # Return without any substitution if the first entry starts with "&",
1220 # indicating this is perl code.
1222 if ( (ref($template) eq "ARRAY" ? $template->[0] : $template) =~ /^\&/ ) {
1225 if ( ref($template) ne "ARRAY" ) {
1227 # Split at white space, except if escaped by \
1229 $template = [split(/(?<!\\)\s+/, $template)];
1231 # Remove the \ that escaped white space.
1233 foreach ( @$template ) {
1238 # Merge variables into @cmd
1240 foreach my $arg ( @$template ) {
1242 # Replace $VAR with ${VAR} so that both types of variable
1243 # substitution are supported
1245 $arg =~ s[\$(\w+)]{\${$1}}g;
1247 # Replace scalar variables first
1249 $arg =~ s[\${(\w+)}(\+?)]{
1250 exists($vars->{$1}) && ref($vars->{$1}) ne "ARRAY"
1251 ? ($2 eq "+" ? $bpc->shellEscape($vars->{$1}) : $vars->{$1})
1255 # Now replicate any array arguments; this just works for just one
1256 # array var in each argument.
1258 if ( $arg =~ m[(.*)\${(\w+)}(\+?)(.*)] && ref($vars->{$2}) eq "ARRAY" ) {
1263 foreach my $v ( @{$vars->{$var}} ) {
1264 $v = $bpc->shellEscape($v) if ( $esc eq "+" );
1265 push(@cmd, "$pre$v$post");
1275 # Exec or eval a command. $cmd is either a string on an array ref.
1277 # @args are optional arguments for the eval() case; they are not used
1282 my($bpc, $cmd, @args) = @_;
1284 if ( (ref($cmd) eq "ARRAY" ? $cmd->[0] : $cmd) =~ /^\&/ ) {
1285 $cmd = join(" ", $cmd) if ( ref($cmd) eq "ARRAY" );
1286 print(STDERR "cmdExecOrEval: about to eval perl code $cmd\n")
1287 if ( $bpc->{verbose} );
1289 print(STDERR "Perl code fragment for exec shouldn't return!!\n");
1292 $cmd = [split(/\s+/, $cmd)] if ( ref($cmd) ne "ARRAY" );
1293 print(STDERR "cmdExecOrEval: about to exec ",
1294 $bpc->execCmd2ShellCmd(@$cmd), "\n")
1295 if ( $bpc->{verbose} );
1297 $cmd = [map { m/(.*)/ } @$cmd]; # untaint
1299 # force list-form of exec(), ie: no shell even for 1 arg
1301 exec { $cmd->[0] } @$cmd;
1302 print(STDERR "Exec failed for @$cmd\n");
1308 # System or eval a command. $cmd is either a string on an array ref.
1309 # $stdoutCB is a callback for output generated by the command. If it
1310 # is undef then output is returned. If it is a code ref then the function
1311 # is called with each piece of output as an argument. If it is a scalar
1312 # ref the output is appended to this variable.
1314 # @args are optional arguments for the eval() case; they are not used
1317 # Also, $? should be set when the CHILD pipe is closed.
1319 sub cmdSystemOrEvalLong
1321 my($bpc, $cmd, $stdoutCB, $ignoreStderr, $pidHandlerCB, @args) = @_;
1322 my($pid, $out, $allOut);
1326 if ( (ref($cmd) eq "ARRAY" ? $cmd->[0] : $cmd) =~ /^\&/ ) {
1327 $cmd = join(" ", $cmd) if ( ref($cmd) eq "ARRAY" );
1328 print(STDERR "cmdSystemOrEval: about to eval perl code $cmd\n")
1329 if ( $bpc->{verbose} );
1331 $$stdoutCB .= $out if ( ref($stdoutCB) eq 'SCALAR' );
1332 &$stdoutCB($out) if ( ref($stdoutCB) eq 'CODE' );
1333 print(STDERR "cmdSystemOrEval: finished: got output $out\n")
1334 if ( $bpc->{verbose} );
1335 return $out if ( !defined($stdoutCB) );
1338 $cmd = [split(/\s+/, $cmd)] if ( ref($cmd) ne "ARRAY" );
1339 print(STDERR "cmdSystemOrEval: about to system ",
1340 $bpc->execCmd2ShellCmd(@$cmd), "\n")
1341 if ( $bpc->{verbose} );
1342 if ( !defined($pid = open(CHILD, "-|")) ) {
1343 my $err = "Can't fork to run @$cmd\n";
1345 $$stdoutCB .= $err if ( ref($stdoutCB) eq 'SCALAR' );
1346 &$stdoutCB($err) if ( ref($stdoutCB) eq 'CODE' );
1347 return $err if ( !defined($stdoutCB) );
1356 if ( $ignoreStderr ) {
1357 open(STDERR, ">", "/dev/null");
1359 open(STDERR, ">&STDOUT");
1362 $cmd = [map { m/(.*)/ } @$cmd]; # untaint
1364 # force list-form of exec(), ie: no shell even for 1 arg
1366 exec { $cmd->[0] } @$cmd;
1367 print(STDERR "Exec of @$cmd failed\n");
1372 # Notify caller of child's pid
1374 &$pidHandlerCB($pid) if ( ref($pidHandlerCB) eq "CODE" );
1377 # The parent gathers the output from the child
1380 $$stdoutCB .= $_ if ( ref($stdoutCB) eq 'SCALAR' );
1381 &$stdoutCB($_) if ( ref($stdoutCB) eq 'CODE' );
1382 $out .= $_ if ( !defined($stdoutCB) );
1383 $allOut .= $_ if ( $bpc->{verbose} );
1388 print(STDERR "cmdSystemOrEval: finished: got output $allOut\n")
1389 if ( $bpc->{verbose} );
1394 # The shorter version that sets $ignoreStderr = 0, ie: merges stdout
1395 # and stderr together.
1399 my($bpc, $cmd, $stdoutCB, @args) = @_;
1401 return $bpc->cmdSystemOrEvalLong($cmd, $stdoutCB, 0, undef, @args);
1405 # Promotes $conf->{BackupFilesOnly}, $conf->{BackupFilesExclude}
1406 # to hashes and $conf->{$shareName} to an array.
1408 sub backupFileConfFix
1410 my($bpc, $conf, $shareName) = @_;
1412 $conf->{$shareName} = [ $conf->{$shareName} ]
1413 if ( ref($conf->{$shareName}) ne "ARRAY" );
1414 foreach my $param qw(BackupFilesOnly BackupFilesExclude) {
1415 next if ( !defined($conf->{$param}) );
1416 if ( ref($conf->{$param}) eq "HASH" ) {
1418 # A "*" entry means wildcard - it is the default for
1419 # all shares. Replicate the "*" entry for all shares,
1420 # but still allow override of specific entries.
1422 next if ( !defined($conf->{$param}{"*"}) );
1424 map({ $_ => $conf->{$param}{"*"} }
1425 @{$conf->{$shareName}}),
1429 $conf->{$param} = [ $conf->{$param} ]
1430 if ( ref($conf->{$param}) ne "ARRAY" );
1431 $conf->{$param} = { map { $_ => $conf->{$param} }
1432 @{$conf->{$shareName}} };
1438 # This is sort() compare function, used below.
1440 # New client LOG names are LOG.MMYYYY. Old style names are
1441 # LOG, LOG.0, LOG.1 etc. Sort them so new names are
1442 # first, and newest to oldest.
1446 my $na = $1 if ( $a =~ /LOG\.(\d+)(\.z)?$/ );
1447 my $nb = $1 if ( $b =~ /LOG\.(\d+)(\.z)?$/ );
1449 $na = -1 if ( !defined($na) );
1450 $nb = -1 if ( !defined($nb) );
1452 if ( length($na) >= 5 && length($nb) >= 5 ) {
1454 # Both new style: format is MMYYYY. Bigger dates are
1457 my $ma = $2 * 12 + $1 if ( $na =~ /(\d+)(\d{4})/ );
1458 my $mb = $2 * 12 + $1 if ( $nb =~ /(\d+)(\d{4})/ );
1460 } elsif ( length($na) >= 5 && length($nb) < 5 ) {
1462 } elsif ( length($na) < 5 && length($nb) >= 5 ) {
1466 # Both old style. Smaller numbers are more recent.
1473 # Returns list of paths to a clients's (or main) LOG files,
1474 # most recent first.
1476 sub sortedPCLogFiles
1478 my($bpc, $host) = @_;
1482 if ( $host ne "" ) {
1483 $dir = "$bpc->{TopDir}/pc/$host";
1485 $dir = "$bpc->{LogDir}";
1487 if ( opendir(DIR, $dir) ) {
1488 foreach my $file ( readdir(DIR) ) {
1489 next if ( !-f "$dir/$file" );
1490 next if ( $file ne "LOG" && $file !~ /^LOG\.\d/ );
1491 push(@files, "$dir/$file");
1495 return sort compareLOGName @files;
1499 # converts a glob-style pattern into a perl regular expression.
1503 my ( $bpc, $glob ) = @_;
1504 my ( $char, $subst );
1506 # $escapeChars escapes characters with no special glob meaning but
1507 # have meaning in regexps.
1508 my $escapeChars = [ '.', '/', ];
1510 # $charMap is where we implement the special meaning of glob
1511 # patterns and translate them to regexps.
1516 # multiple forward slashes are equivalent to one slash. We should
1517 # never have to use this.
1520 foreach $char (@$escapeChars) {
1521 $glob =~ s/\Q$char\E/\\$char/g;
1524 while ( ( $char, $subst ) = each(%$charMap) ) {
1525 $glob =~ s/(?<!\\)\Q$char\E/$subst/g;