02177a0a8a29c407c51e91b53f8baa5dafb6a7cb
[BackupPC.git] / lib / BackupPC / Lib.pm
1 #============================================================= -*-perl-*-
2 #
3 # BackupPC::Lib package
4 #
5 # DESCRIPTION
6 #
7 #   This library defines a BackupPC::Lib class and a variety of utility
8 #   functions used by BackupPC.
9 #
10 # AUTHOR
11 #   Craig Barratt  <cbarratt@users.sourceforge.net>
12 #
13 # COPYRIGHT
14 #   Copyright (C) 2001  Craig Barratt
15 #
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.
20 #
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.
25 #
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
29 #
30 #========================================================================
31 #
32 # Version 1.5.0, released 2 Aug 2002.
33 #
34 # See http://backuppc.sourceforge.net.
35 #
36 #========================================================================
37
38 package BackupPC::Lib;
39
40 use strict;
41
42 use vars qw(%Conf %Lang);
43 use Fcntl qw/:flock/;
44 use Carp;
45 use DirHandle ();
46 use File::Path;
47 use File::Compare;
48 use Socket;
49 use Cwd;
50 use Digest::MD5;
51
52 sub new
53 {
54     my $class = shift;
55     my($topDir) = @_;
56     my $self = bless {
57         TopDir  => $topDir || '/data/BackupPC',
58         BinDir  => '/usr/local/BackupPC/bin',
59         LibDir  => '/usr/local/BackupPC/lib',
60         Version => '1.5.0',
61         BackupFields => [qw(
62                     num type startTime endTime
63                     nFiles size nFilesExist sizeExist nFilesNew sizeNew
64                     xferErrs xferBadFile xferBadShare tarErrs
65                     compress sizeExistComp sizeNewComp
66                     noFill fillFromNum mangle
67                 )],
68         RestoreFields => [qw(
69                     num startTime endTime result errorMsg nFiles size
70                     tarCreateErrs xferErrs
71                 )],
72     }, $class;
73     #
74     # Clean up %ENV and setup other variables.
75     #
76     delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
77     $self->{PoolDir}  = "$self->{TopDir}/pool";
78     $self->{CPoolDir} = "$self->{TopDir}/cpool";
79     if ( defined(my $error = $self->ConfigRead()) ) {
80         print(STDERR $error, "\n");
81         return;
82     }
83     return $self;
84 }
85
86 sub TopDir
87 {
88     my($self) = @_;
89     return $self->{TopDir};
90 }
91
92 sub BinDir
93 {
94     my($self) = @_;
95     return $self->{BinDir};
96 }
97
98 sub Version
99 {
100     my($self) = @_;
101     return $self->{Version};
102 }
103
104 sub Conf
105 {
106     my($self) = @_;
107     return %{$self->{Conf}};
108 }
109
110 sub Lang
111 {
112     my($self) = @_;
113     return $self->{Lang};
114 }
115
116 sub adminJob
117 {
118     return " admin ";
119 }
120
121 sub trashJob
122 {
123     return " trashClean ";
124 }
125
126 sub timeStamp
127 {
128     my($self, $t, $noPad) = @_;
129     my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
130               = localtime($t || time);
131     $year += 1900;
132     $mon++;
133     return "$year/$mon/$mday " . sprintf("%02d:%02d:%02d", $hour, $min, $sec)
134             . ($noPad ? "" : " ");
135 }
136
137 #
138 # An ISO 8601-compliant version of timeStamp.  Needed by the
139 # --newer-mtime argument to GNU tar in BackupPC::Xfer::Tar.
140 # Also see http://www.w3.org/TR/NOTE-datetime.
141 #
142 sub timeStampISO
143 {
144     my($self, $t, $noPad) = @_;
145     my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
146               = localtime($t || time);
147     $year += 1900;
148     $mon++;
149     return sprintf("%04d-%02d-%02d ", $year, $mon, $mday)
150          . sprintf("%02d:%02d:%02d", $hour, $min, $sec)
151          . ($noPad ? "" : " ");
152 }
153
154 sub BackupInfoRead
155 {
156     my($self, $host) = @_;
157     local(*BK_INFO, *LOCK);
158     my(@Backups);
159
160     flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
161     if ( open(BK_INFO, "$self->{TopDir}/pc/$host/backups") ) {
162         while ( <BK_INFO> ) {
163             s/[\n\r]+//;
164             next if ( !/^(\d+\t(incr|full)[\d\t]*$)/ );
165             $_ = $1;
166             @{$Backups[@Backups]}{@{$self->{BackupFields}}} = split(/\t/);
167         }
168         close(BK_INFO);
169     }
170     close(LOCK);
171     return @Backups;
172 }
173
174 sub BackupInfoWrite
175 {
176     my($self, $host, @Backups) = @_;
177     local(*BK_INFO, *LOCK);
178     my($i);
179
180     flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
181     unlink("$self->{TopDir}/pc/$host/backups.old")
182                 if ( -f "$self->{TopDir}/pc/$host/backups.old" );
183     rename("$self->{TopDir}/pc/$host/backups",
184            "$self->{TopDir}/pc/$host/backups.old")
185                 if ( -f "$self->{TopDir}/pc/$host/backups" );
186     if ( open(BK_INFO, ">$self->{TopDir}/pc/$host/backups") ) {
187         for ( $i = 0 ; $i < @Backups ; $i++ ) {
188             my %b = %{$Backups[$i]};
189             printf(BK_INFO "%s\n", join("\t", @b{@{$self->{BackupFields}}}));
190         }
191         close(BK_INFO);
192     }
193     close(LOCK);
194 }
195
196 sub RestoreInfoRead
197 {
198     my($self, $host) = @_;
199     local(*RESTORE_INFO, *LOCK);
200     my(@Restores);
201
202     flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
203     if ( open(RESTORE_INFO, "$self->{TopDir}/pc/$host/restores") ) {
204         while ( <RESTORE_INFO> ) {
205             s/[\n\r]+//;
206             next if ( !/^(\d+.*)/ );
207             $_ = $1;
208             @{$Restores[@Restores]}{@{$self->{RestoreFields}}} = split(/\t/);
209         }
210         close(RESTORE_INFO);
211     }
212     close(LOCK);
213     return @Restores;
214 }
215
216 sub RestoreInfoWrite
217 {
218     my($self, $host, @Restores) = @_;
219     local(*RESTORE_INFO, *LOCK);
220     my($i);
221
222     flock(LOCK, LOCK_EX) if open(LOCK, "$self->{TopDir}/pc/$host/LOCK");
223     unlink("$self->{TopDir}/pc/$host/restores.old")
224                 if ( -f "$self->{TopDir}/pc/$host/restores.old" );
225     rename("$self->{TopDir}/pc/$host/restores",
226            "$self->{TopDir}/pc/$host/restores.old")
227                 if ( -f "$self->{TopDir}/pc/$host/restores" );
228     if ( open(RESTORE_INFO, ">$self->{TopDir}/pc/$host/restores") ) {
229         for ( $i = 0 ; $i < @Restores ; $i++ ) {
230             my %b = %{$Restores[$i]};
231             printf(RESTORE_INFO "%s\n",
232                         join("\t", @b{@{$self->{RestoreFields}}}));
233         }
234         close(RESTORE_INFO);
235     }
236     close(LOCK);
237 }
238
239 sub ConfigRead
240 {
241     my($self, $host) = @_;
242     my($ret, $mesg, $config, @configs);
243
244     $self->{Conf} = ();
245     push(@configs, "$self->{TopDir}/conf/config.pl");
246     push(@configs, "$self->{TopDir}/pc/$host/config.pl")
247             if ( defined($host) && -f "$self->{TopDir}/pc/$host/config.pl" );
248     foreach $config ( @configs ) {
249         %Conf = ();
250         if ( !defined($ret = do $config) && ($! || $@) ) {
251             $mesg = "Couldn't open $config: $!" if ( $! );
252             $mesg = "Couldn't execute $config: $@" if ( $@ );
253             $mesg =~ s/[\n\r]+//;
254             return $mesg;
255         }
256         %{$self->{Conf}} = ( %{$self->{Conf} || {}}, %Conf );
257     }
258     my $langFile = "$self->{LibDir}/BackupPC/Lang/$self->{Conf}{Language}.pm";
259     if ( !defined($ret = do $langFile) && ($! || $@) ) {
260         $mesg = "Couldn't open language file $langFile: $!" if ( $! );
261         $mesg = "Couldn't execute language file $langFile: $@" if ( $@ );
262         $mesg =~ s/[\n\r]+//;
263         return $mesg;
264     }
265     $self->{Lang} = \%Lang;
266     return;
267 }
268
269 #
270 # Return the mtime of the config file
271 #
272 sub ConfigMTime
273 {
274     my($self) = @_;
275     return (stat("$self->{TopDir}/conf/config.pl"))[9];
276 }
277
278 #
279 # Returns information from the host file in $self->{TopDir}/conf/hosts.
280 # With no argument a ref to a hash of hosts is returned.  Each
281 # hash contains fields as specified in the hosts file.  With an
282 # argument a ref to a single hash is returned with information
283 # for just that host.
284 #
285 sub HostInfoRead
286 {
287     my($self, $host) = @_;
288     my(%hosts, @hdr, @fld);
289     local(*HOST_INFO);
290
291     if ( !open(HOST_INFO, "$self->{TopDir}/conf/hosts") ) {
292         print(STDERR $self->timeStamp,
293                      "Can't open $self->{TopDir}/conf/hosts\n");
294         return {};
295     }
296     while ( <HOST_INFO> ) {
297         s/[\n\r]+//;
298         s/#.*//;
299         s/\s+$//;
300         next if ( /^\s*$/ || !/^([\w\.-]+\s+.*)/ );
301         @fld = split(/\s+/, $1);
302         if ( @hdr ) {
303             if ( defined($host) ) {
304                 next if ( lc($fld[0]) ne $host );
305                 @{$hosts{lc($fld[0])}}{@hdr} = @fld;
306                 close(HOST_INFO);
307                 return \%hosts;
308             } else {
309                 @{$hosts{lc($fld[0])}}{@hdr} = @fld;
310             }
311         } else {
312             @hdr = @fld;
313         }
314     }
315     close(HOST_INFO);
316     return \%hosts;
317 }
318
319 #
320 # Return the mtime of the hosts file
321 #
322 sub HostsMTime
323 {
324     my($self) = @_;
325     return (stat("$self->{TopDir}/conf/hosts"))[9];
326 }
327
328 #
329 # Stripped down from File::Path.  In particular we don't print
330 # many warnings and we try three times to delete each directory
331 # and file -- for some reason the original File::Path rmtree
332 # didn't always completely remove a directory tree on the NetApp.
333 #
334 # Warning: this routine changes the cwd.
335 #
336 sub RmTreeQuiet
337 {
338     my($self, $pwd, $roots) = @_;
339     my(@files, $root);
340
341     if ( defined($roots) && length($roots) ) {
342       $roots = [$roots] unless ref $roots;
343     } else {
344       print "RmTreeQuiet: No root path(s) specified\n";
345     }
346     chdir($pwd);
347     foreach $root (@{$roots}) {
348         $root = $1 if ( $root =~ m{(.*?)/*$} );
349         #
350         # Try first to simply unlink the file: this avoids an
351         # extra stat for every file.  If it fails (which it
352         # will for directories), check if it is a directory and
353         # then recurse.
354         #
355         if ( !unlink($root) ) {
356             if ( -d $root ) {
357                 my $d = DirHandle->new($root)
358                   or print "Can't read $pwd/$root: $!";
359                 @files = $d->read;
360                 $d->close;
361                 @files = grep $_!~/^\.{1,2}$/, @files;
362                 $self->RmTreeQuiet("$pwd/$root", \@files);
363                 chdir($pwd);
364                 rmdir($root) || rmdir($root);
365             } else {
366                 unlink($root) || unlink($root);
367             }
368         }
369     }
370 }
371
372 #
373 # Move a directory or file away for later deletion
374 #
375 sub RmTreeDefer
376 {
377     my($self, $trashDir, $file) = @_;
378     my($i, $f);
379
380     return if ( !-e $file );
381     mkpath($trashDir, 0, 0777) if ( !-d $trashDir );
382     for ( $i = 0 ; $i < 1000 ; $i++ ) {
383         $f = sprintf("%s/%d_%d_%d", $trashDir, time, $$, $i);
384         next if ( -e $f );
385         return if ( rename($file, $f) );
386     }
387     # shouldn't get here, but might if you tried to call this
388     # across file systems.... just remove the tree right now.
389     if ( $file =~ /(.*)\/([^\/]*)/ ) {
390         my($d) = $1;
391         my($f) = $2;
392         my($cwd) = Cwd::fastcwd();
393         $self->RmTreeQuiet($d, $f);
394         chdir($cwd) if ( $cwd );
395     }
396 }
397
398 #
399 # Empty the trash directory.  Returns 0 if it did nothing.
400 #
401 sub RmTreeTrashEmpty
402 {
403     my($self, $trashDir) = @_;
404     my(@files);
405     my($cwd) = Cwd::fastcwd();
406
407     return if ( !-d $trashDir );
408     my $d = DirHandle->new($trashDir)
409       or carp "Can't read $trashDir: $!";
410     @files = $d->read;
411     $d->close;
412     @files = grep $_!~/^\.{1,2}$/, @files;
413     return 0 if ( !@files );
414     $self->RmTreeQuiet($trashDir, \@files);
415     chdir($cwd) if ( $cwd );
416     return 1;
417 }
418
419 #
420 # Open a connection to the server.  Returns an error string on failure.
421 # Returns undef on success.
422 #
423 sub ServerConnect
424 {
425     my($self, $host, $port, $justConnect) = @_;
426     local(*FH);
427
428     return if ( defined($self->{ServerFD}) );
429     #
430     # First try the unix-domain socket
431     #
432     my $sockFile = "$self->{TopDir}/log/BackupPC.sock";
433     socket(*FH, PF_UNIX, SOCK_STREAM, 0)     || return "unix socket: $!";
434     if ( !connect(*FH, sockaddr_un($sockFile)) ) {
435         my $err = "unix connect: $!";
436         close(*FH);
437         if ( $port > 0 ) {
438             my $proto = getprotobyname('tcp');
439             my $iaddr = inet_aton($host)     || return "unknown host $host";
440             my $paddr = sockaddr_in($port, $iaddr);
441
442             socket(*FH, PF_INET, SOCK_STREAM, $proto)
443                                              || return "inet socket: $!";
444             connect(*FH, $paddr)             || return "inet connect: $!";
445         } else {
446             return $err;
447         }
448     }
449     my($oldFH) = select(*FH); $| = 1; select($oldFH);
450     $self->{ServerFD} = *FH;
451     return if ( $justConnect );
452     #
453     # Read the seed that we need for our MD5 message digest.  See
454     # ServerMesg below.
455     #
456     sysread($self->{ServerFD}, $self->{ServerSeed}, 1024);
457     $self->{ServerMesgCnt} = 0;
458     return;
459 }
460
461 #
462 # Check that the server connection is still ok
463 #
464 sub ServerOK
465 {
466     my($self) = @_;
467
468     return 0 if ( !defined($self->{ServerFD}) );
469     vec(my $FDread, fileno($self->{ServerFD}), 1) = 1;
470     my $ein = $FDread;
471     return 0 if ( select(my $rout = $FDread, undef, $ein, 0.0) < 0 );
472     return 1 if ( !vec($rout, fileno($self->{ServerFD}), 1) );
473 }
474
475 #
476 # Disconnect from the server
477 #
478 sub ServerDisconnect
479 {
480     my($self) = @_;
481     return if ( !defined($self->{ServerFD}) );
482     close($self->{ServerFD});
483     delete($self->{ServerFD});
484 }
485
486 #
487 # Sends a message to the server and returns with the reply.
488 #
489 # To avoid possible attacks via the TCP socket interface, every client
490 # message is protected by an MD5 digest. The MD5 digest includes four
491 # items:
492 #   - a seed that is sent to us when we first connect
493 #   - a sequence number that increments for each message
494 #   - a shared secret that is stored in $Conf{ServerMesgSecret}
495 #   - the message itself.
496 # The message is sent in plain text preceded by the MD5 digest. A
497 # snooper can see the plain-text seed sent by BackupPC and plain-text
498 # message, but cannot construct a valid MD5 digest since the secret in
499 # $Conf{ServerMesgSecret} is unknown. A replay attack is not possible
500 # since the seed changes on a per-connection and per-message basis.
501 #
502 sub ServerMesg
503 {
504     my($self, $mesg) = @_;
505     return if ( !defined(my $fh = $self->{ServerFD}) );
506     my $md5 = Digest::MD5->new;
507     $md5->add($self->{ServerSeed} . $self->{ServerMesgCnt}
508             . $self->{Conf}{ServerMesgSecret} . $mesg);
509     print($fh $md5->b64digest . " $mesg\n");
510     $self->{ServerMesgCnt}++;
511     return <$fh>;
512 }
513
514 #
515 # Do initialization for child processes
516 #
517 sub ChildInit
518 {
519     my($self) = @_;
520     close(STDERR);
521     open(STDERR, ">&STDOUT");
522     select(STDERR); $| = 1;
523     select(STDOUT); $| = 1;
524     $ENV{PATH} = $self->{Conf}{MyPath};
525 }
526
527 #
528 # Compute the MD5 digest of a file.  For efficiency we don't
529 # use the whole file for big files:
530 #   - for files <= 256K we use the file size and the whole file.
531 #   - for files <= 1M we use the file size, the first 128K and
532 #     the last 128K.
533 #   - for files > 1M, we use the file size, the first 128K and
534 #     the 8th 128K (ie: the 128K up to 1MB).
535 # See the documentation for a discussion of the tradeoffs in
536 # how much data we use and how many collisions we get.
537 #
538 # Returns the MD5 digest (a hex string) and the file size.
539 #
540 sub File2MD5
541 {
542     my($self, $md5, $name) = @_;
543     my($data, $fileSize);
544     local(*N);
545
546     $fileSize = (stat($name))[7];
547     return ("", -1) if ( !-f _ );
548     $name = $1 if ( $name =~ /(.*)/ );
549     return ("", 0) if ( $fileSize == 0 );
550     return ("", -1) if ( !open(N, $name) );
551     $md5->reset();
552     $md5->add($fileSize);
553     if ( $fileSize > 262144 ) {
554         #
555         # read the first and last 131072 bytes of the file,
556         # up to 1MB.
557         #
558         my $seekPosn = ($fileSize > 1048576 ? 1048576 : $fileSize) - 131072;
559         $md5->add($data) if ( sysread(N, $data, 131072) );
560         $md5->add($data) if ( sysseek(N, $seekPosn, 0)
561                                 && sysread(N, $data, 131072) );
562     } else {
563         #
564         # read the whole file
565         #
566         $md5->add($data) if ( sysread(N, $data, $fileSize) );
567     }
568     close(N);
569     return ($md5->hexdigest, $fileSize);
570 }
571
572 #
573 # Compute the MD5 digest of a buffer (string).  For efficiency we don't
574 # use the whole string for big strings:
575 #   - for files <= 256K we use the file size and the whole file.
576 #   - for files <= 1M we use the file size, the first 128K and
577 #     the last 128K.
578 #   - for files > 1M, we use the file size, the first 128K and
579 #     the 8th 128K (ie: the 128K up to 1MB).
580 # See the documentation for a discussion of the tradeoffs in
581 # how much data we use and how many collisions we get.
582 #
583 # Returns the MD5 digest (a hex string).
584 #
585 sub Buffer2MD5
586 {
587     my($self, $md5, $fileSize, $dataRef) = @_;
588
589     $md5->reset();
590     $md5->add($fileSize);
591     if ( $fileSize > 262144 ) {
592         #
593         # add the first and last 131072 bytes of the string,
594         # up to 1MB.
595         #
596         my $seekPosn = ($fileSize > 1048576 ? 1048576 : $fileSize) - 131072;
597         $md5->add(substr($$dataRef, 0, 131072));
598         $md5->add(substr($$dataRef, $seekPosn, 131072));
599     } else {
600         #
601         # add the whole string
602         #
603         $md5->add($$dataRef);
604     }
605     return $md5->hexdigest;
606 }
607
608 #
609 # Given an MD5 digest $d and a compress flag, return the full
610 # path in the pool.
611 #
612 sub MD52Path
613 {
614     my($self, $d, $compress, $poolDir) = @_;
615
616     return if ( $d !~ m{(.)(.)(.)(.*)} );
617     $poolDir = ($compress ? $self->{CPoolDir} : $self->{PoolDir})
618                     if ( !defined($poolDir) );
619     return "$poolDir/$1/$2/$3/$1$2$3$4";
620 }
621
622 #
623 # For each file, check if the file exists in $self->{TopDir}/pool.
624 # If so, remove the file and make a hardlink to the file in
625 # the pool.  Otherwise, if the newFile flag is set, make a
626 # hardlink in the pool to the new file.
627 #
628 # Returns 0 if a link should be made to a new file (ie: when the file
629 #    is a new file but the newFile flag is 0).
630 # Returns 1 if a link to an existing file is made,
631 # Returns 2 if a link to a new file is made (only if $newFile is set)
632 # Returns negative on error.
633 #
634 sub MakeFileLink
635 {
636     my($self, $name, $d, $newFile, $compress) = @_;
637     my($i, $rawFile);
638
639     return -1 if ( !-f $name );
640     for ( $i = -1 ; ; $i++ ) {
641         return -2 if ( !defined($rawFile = $self->MD52Path($d, $compress)) );
642         $rawFile .= "_$i" if ( $i >= 0 );
643         if ( -f $rawFile ) {
644             if ( !compare($name, $rawFile) ) {
645                 unlink($name);
646                 return -3 if ( !link($rawFile, $name) );
647                 return 1;
648             }
649         } elsif ( $newFile && -f $name && (stat($name))[3] == 1 ) {
650             my($newDir);
651             ($newDir = $rawFile) =~ s{(.*)/.*}{$1};
652             mkpath($newDir, 0, 0777) if ( !-d $newDir );
653             return -4 if ( !link($name, $rawFile) );
654             return 2;
655         } else {
656             return 0;
657         }
658     }
659 }
660
661 sub CheckHostAlive
662 {
663     my($self, $host) = @_;
664     my($s, $pingArgs);
665
666     $pingArgs = $self->{Conf}{PingArgs};
667     #
668     # Merge variables into $pingArgs
669     #
670     my $vars = {
671         host    => $host,
672     };
673     $pingArgs =~ s/\$(\w+)/defined($vars->{$1})
674                                  ? $self->shellEscape($vars->{$1})
675                                  : \$$1/eg;
676     #
677     # Do a first ping in case the PC needs to wakeup
678     #
679     $s = `$self->{Conf}{PingPath} $pingArgs 2>&1`;
680     return -1 if ( $? );
681     #
682     # Do a second ping and get the round-trip time in msec
683     #
684     $s = `$self->{Conf}{PingPath} $pingArgs 2>&1`;
685     return -1 if ( $? );
686     return $1 if ( $s !~ /time=([\d\.]+)\s*ms/ );
687     return $1/1000 if ( $s !~ /time=([\d\.]+)\s*usec/ );
688     return 0;
689 }
690
691 sub CheckFileSystemUsage
692 {
693     my($self) = @_;
694     my($topDir) = $self->{TopDir};
695     my($s);
696
697     if ( $^O eq "solaris" ) {
698         $s = `$self->{Conf}{DfPath} -k $topDir 2>&1`;
699         return 0 if ( $? || $s !~ /(\d+)%/s );
700         return $1;
701     } elsif ( $^O eq "sunos" ) {
702         $s = `$self->{Conf}{DfPath} $topDir 2>&1`;
703         return 0 if ( $? || $s !~ /(\d+)%/s );
704         return $1;
705     } elsif ( $^O eq "linux" ) {
706         $s = `$self->{Conf}{DfPath} $topDir 2>&1`;
707         return 0 if ( $? || $s !~ /(\d+)%/s );
708         return $1;
709     } else {
710         return 0;
711     }
712 }
713
714 sub NetBiosInfoGet
715 {
716     my($self, $host) = @_;
717     my($netBiosHostName, $netBiosUserName);
718
719     foreach ( split(/[\n\r]+/, `$self->{Conf}{NmbLookupPath} -A $host 2>&1`) ) {
720         next if ( !/([\w-]+)\s*<(\w{2})\> - .*<ACTIVE>/i );
721         $netBiosHostName ||= $1 if ( $2 eq "00" );  # host is first 00
722         $netBiosUserName   = $1 if ( $2 eq "03" );  # user is last 03
723     }
724     return if ( !defined($netBiosHostName) );
725     return (lc($netBiosHostName), lc($netBiosUserName));
726 }
727
728 sub fileNameEltMangle
729 {
730     my($self, $name) = @_;
731
732     $name =~ s{([%/\n\r])}{sprintf("%%%02x", ord($1))}eg;
733     return "f$name";
734 }
735
736 #
737 # We store files with every name preceded by "f".  This
738 # avoids possible name conflicts with other information
739 # we store in the same directories (eg: attribute info).
740 # The process of turning a normal path into one with each
741 # node prefixed with "f" is called mangling.
742 #
743 sub fileNameMangle
744 {
745     my($self, $name) = @_;
746
747     $name =~ s{/([^/]+)}{"/" . $self->fileNameEltMangle($1)}eg;
748     $name =~ s{^([^/]+)}{$self->fileNameEltMangle($1)}eg;
749     return $name;
750 }
751
752 #
753 # This undoes FileNameMangle
754 #
755 sub fileNameUnmangle
756 {
757     my($self, $name) = @_;
758
759     $name =~ s{/f}{/}g;
760     $name =~ s{^f}{};
761     $name =~ s{%(..)}{chr(hex($1))}eg;
762     return $name;
763 }
764
765 #
766 # Escape shell meta-characters with backslashes.
767 # This should be applied to each argument seperately, not an
768 # entire shell command.
769 #
770 sub shellEscape
771 {
772     my($self, $cmd) = @_;
773
774     $cmd =~ s/([][;&()<>{}|^\n\r\t *\$\\'"`?])/\\$1/g;
775     return $cmd;
776 }
777
778 1;