* Split BackupPC_Admin into a set of modules, one for each major action.
[BackupPC.git] / bin / BackupPC_dump
index 1bb28c1..79393bf 100755 (executable)
@@ -5,7 +5,7 @@
 #
 # DESCRIPTION
 #
-#   Usage: BackupPC_dump [-i] [-f] [-d] [-e] <client>
+#   Usage: BackupPC_dump [-i] [-f] [-d] [-e] [-v] <client>
 #
 #   Flags:
 #
@@ -24,6 +24,8 @@
 #          dhcp hosts that are no longer on the network will not expire
 #          old backups.
 #
+#     -v   verbose.  for manual usage: prints failure reasons in more detail.
+#
 #   BackupPC_dump is run periodically by BackupPC to backup $client.
 #   The file $TopDir/pc/$client/backups is read to decide whether a
 #   full or incremental backup needs to be run.  If no backup is
@@ -50,7 +52,7 @@
 #   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 2.0.0_CVS, released 3 Feb 2003.
+# Version 2.1.0_CVS, released 3 Jul 2003.
 #
 # See http://backuppc.sourceforge.net.
 #
 #========================================================================
 
 use strict;
+no  utf8;
 use lib "/usr/local/BackupPC/lib";
 use BackupPC::Lib;
 use BackupPC::FileZIO;
 use BackupPC::Xfer::Smb;
 use BackupPC::Xfer::Tar;
 use BackupPC::Xfer::Rsync;
+use Socket;
 use File::Path;
 use Getopt::Std;
 
@@ -93,13 +97,13 @@ my $TopDir = $bpc->TopDir();
 my $BinDir = $bpc->BinDir();
 my %Conf   = $bpc->Conf();
 my $NeedPostCmd;
+my $Hosts;
 
 $bpc->ChildInit();
 
 my %opts;
-getopts("defi", \%opts);
-if ( @ARGV != 1 ) {
-    print("usage: $0 [-d] [-e] [-f] [-i] <client>\n");
+if ( !getopts("defiv", \%opts) || @ARGV != 1 ) {
+    print("usage: $0 [-d] [-e] [-f] [-i] [-v] <client>\n");
     exit(1);
 }
 if ( $ARGV[0] !~ /^([\w\.\s-]+)$/ ) {
@@ -112,6 +116,8 @@ my $host;          # this is the real host name
 
 my($clientURI, $user);
 
+$bpc->verbose(1) if ( $opts{v} );
+
 if ( $opts{d} ) {
     #
     # The client name $client is simply a DHCP address.  We need to check
@@ -119,17 +125,36 @@ if ( $opts{d} ) {
     # host name via NetBios using nmblookup.
     #
     $hostIP = $client;
-    exit(1) if ( $bpc->CheckHostAlive($hostIP) < 0
-                   || $Conf{NmbLookupCmd} eq "" );
+    if ( $bpc->CheckHostAlive($hostIP) < 0 ) {
+       print("Exiting because CheckHostAlive($hostIP) failed\n")
+                           if ( $opts{v} );
+       exit(1);
+    }
+    if ( $Conf{NmbLookupCmd} eq "" ) {
+       print("Exiting because \$Conf{NmbLookupCmd} is empty\n")
+                           if ( $opts{v} );
+       exit(1);
+    }
     ($client, $user) = $bpc->NetBiosInfoGet($hostIP);
-    exit(1) if ( $host !~ /^([\w\.\s-]+)$/ );
-    my $hosts = $bpc->HostInfoRead($client);
-    exit(1) if ( !defined($hosts->{$client}) );
+    if ( $client !~ /^([\w\.\s-]+)$/ ) {
+       print("Exiting because NetBiosInfoGet($hostIP) returned '$client',"
+           . " an invalid host name\n")
+                           if ( $opts{v} );
+       exit(1)
+    }
+    $Hosts = $bpc->HostInfoRead($client);
     $host = $client;
+} else {
+    $Hosts = $bpc->HostInfoRead($client);
+}
+if ( !defined($Hosts->{$client}) ) {
+    print("Exiting because host $client does not exist in the hosts file\n")
+                           if ( $opts{v} );
+    exit(1)
 }
 
 my $Dir     = "$TopDir/pc/$client";
-my $xferPid = -1;
+my @xferPid = ();
 my $tarPid  = -1;
 
 #
@@ -149,6 +174,9 @@ $SIG{INT}  = \&catch_signal;
 $SIG{ALRM} = \&catch_signal;
 $SIG{TERM} = \&catch_signal;
 $SIG{PIPE} = \&catch_signal;
+$SIG{STOP} = \&catch_signal;
+$SIG{TSTP} = \&catch_signal;
+$SIG{TTIN} = \&catch_signal;
 my $Pid = $$;
 
 #
@@ -164,6 +192,14 @@ if ( !-f "$Dir/LOCK" ) {
 open(LOG, ">>", "$Dir/LOG");
 select(LOG); $| = 1; select(STDOUT);
 
+#
+# For the -e option we just expire backups and quit
+#
+if ( $opts{e} ) {
+    BackupExpire($client);
+    exit(0);
+}
+
 if ( !$opts{d} ) {
     #
     # In the non-DHCP case, make sure the host can be looked up
@@ -179,10 +215,11 @@ if ( !$opts{d} ) {
         # Ok, NS doesn't know about it.  Maybe it is a NetBios name
         # instead.
         #
+       print("Name server doesn't know about $host; trying NetBios\n")
+                       if ( $opts{v} );
         if ( !defined($hostIP = $bpc->NetBiosHostIPFind($host)) ) {
-           print(LOG $bpc->timeStamp,
-                           "dump failed: Can't find host $host\n");
-            print("dump failed: Can't find host $host\n");
+           print(LOG $bpc->timeStamp, "Can't find host $host via netbios\n");
+            print("host not found\n");
             exit(1);
         }
     } else {
@@ -194,14 +231,6 @@ if ( !$opts{d} ) {
 # Figure out what to do and do it
 ###########################################################################
 
-#
-# For the -e option we just expire backups and quit
-#
-if ( $opts{e} ) {
-    BackupExpire($client);
-    exit(0);
-}
-
 #
 # See if we should skip this host during a certain range
 # of times.
@@ -224,6 +253,8 @@ $bpc->ServerDisconnect();
 if ( $opts{d} ) {
     if ( $StatusHost{activeJob} ) {
         # oops, something is already running for this host
+       print("Exiting because backup is already running for $client\n")
+                       if ( $opts{v} );
         exit(0);
     }
     print("DHCP $hostIP $clientURI\n");
@@ -344,6 +375,7 @@ if ( !defined($XferLOG) ) {
     print("dump failed: unable to open/create $Dir/XferLOG$fileExt\n");
     exit(1);
 }
+$XferLOG->writeTeeStdout(1) if ( $opts{v} );
 unlink("$Dir/NewFileList");
 my $startTime = time();
 
@@ -416,12 +448,22 @@ for my $shareName ( @$ShareNames ) {
        # This xfer method outputs a tar format file, so we start a
        # BackupPC_tarExtract to extract the data.
        #
-       # Create a pipe to connect the Xfer method to BackupPC_tarExtract
+       # Create a socketpair to connect the Xfer method to BackupPC_tarExtract
        # WH is the write handle for writing, provided to the transport
-       # program, and RH is the other end of the pipe for reading,
+       # program, and RH is the other end of the socket for reading,
        # provided to BackupPC_tarExtract.
        #
-       pipe(RH, WH);
+        if ( socketpair(RH, WH, AF_UNIX, SOCK_STREAM, PF_UNSPEC) ) {
+           shutdown(RH, 1);    # no writing to this socket
+           shutdown(WH, 0);    # no reading from this socket
+           setsockopt(RH, SOL_SOCKET, SO_RCVBUF, 8 * 65536);
+           setsockopt(WH, SOL_SOCKET, SO_SNDBUF, 8 * 65536);
+       } else {
+           #
+           # Default to pipe() if socketpair() doesn't work.
+           #
+           pipe(RH, WH);
+       }
 
        #
        # fork a child for BackupPC_tarExtract.  TAR is a file handle
@@ -435,6 +477,7 @@ for my $shareName ( @$ShareNames ) {
            close(WH);
            last;
        }
+       binmode(TAR);
        if ( !$tarPid ) {
            #
            # This is the tar child.  Close the write end of the pipe,
@@ -461,6 +504,7 @@ for my $shareName ( @$ShareNames ) {
        open(NEW_FILES, ">", "$TopDir/pc/$client/NewFileList")
                     || die("can't open $TopDir/pc/$client/NewFileList");
        $newFilesFH = *NEW_FILES;
+       binmode(NEW_FILES);
     }
 
     #
@@ -483,6 +527,7 @@ for my $shareName ( @$ShareNames ) {
        backups     => \@Backups,
        compress    => $Conf{CompressLevel},
        XferMethod  => $Conf{XferMethod},
+       pidHandler  => \&pidHandler,
     });
 
     if ( !defined($logMsg = $xfer->start()) ) {
@@ -497,11 +542,17 @@ for my $shareName ( @$ShareNames ) {
            sleep(1);
            kill(9, $tarPid);
        }
+       if ( @xferPid ) {
+           kill(2, @xferPid);
+           sleep(1);
+           kill(9, @xferPid);
+       }
        UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
         exit(1);
     }
 
-    $xferPid = $xfer->xferPid;
+    @xferPid = $xfer->xferPid;
+
     if ( $useTar ) {
        #
        # The parent must close both handles on the pipe since the children
@@ -509,17 +560,13 @@ for my $shareName ( @$ShareNames ) {
        #
        close(RH);
        close(WH);
-       print(LOG $bpc->timeStamp, $logMsg,
-                                  " (xferPid=$xferPid, tarPid=$tarPid)\n");
-    } elsif ( $xferPid > 0 ) {
-       print(LOG $bpc->timeStamp, $logMsg, " (xferPid=$xferPid)\n");
-    } else {
-       print(LOG $bpc->timeStamp, $logMsg, "\n");
     }
-    print("started $type dump, pid=$xferPid, tarPid=$tarPid,"
-            . " share=$shareName\n");
+    print(LOG $bpc->timeStamp, $logMsg, "\n");
+    print("started $type dump, share=$shareName\n");
+
+    pidHandler(@xferPid);
 
-    if ( $useTar || $xferPid > 0 ) {
+    if ( $useTar ) {
        #
        # Parse the output of the transfer program and BackupPC_tarExtract
        # while they run.  Since we might be reading from two or more children
@@ -568,7 +615,7 @@ for my $shareName ( @$ShareNames ) {
                # the transfer.
                #
                if ( my $errMsg = CorrectHostCheck($hostIP, $host) ) {
-                   $stat{hostError} = $errMsg;
+                   $stat{hostError} = $errMsg if ( $stat{hostError} eq "" );
                    last SCAN;
                }
            }
@@ -608,10 +655,10 @@ for my $shareName ( @$ShareNames ) {
         #
         # kill off the tranfer program, first nicely then forcefully
         #
-       if ( $xferPid > 0 ) {
-           kill(2, $xferPid);
+       if ( @xferPid ) {
+           kill(2, @xferPid);
            sleep(1);
-           kill(9, $xferPid);
+           kill(9, @xferPid);
        }
         #
         # kill off the tar process, first nicely then forcefully
@@ -775,7 +822,12 @@ sub catch_signal
     my $fileExt = $Conf{CompressLevel} > 0 ? ".z" : "";
 
     #
-    # Ignore signals in children
+    # Children quit quietly on ALRM
+    #
+    exit(1) if ( $Pid != $$ && $signame eq "ALRM" );
+
+    #
+    # Ignore other signals in children
     #
     return if ( $Pid != $$ );
 
@@ -784,17 +836,15 @@ sub catch_signal
     UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
     $XferLOG->write(\"exiting after signal $signame\n");
     $XferLOG->close();
-    if ( $xferPid > 0 ) {
-        if ( kill(2, $xferPid) <= 0 ) {
-            sleep(1);
-            kill(9, $xferPid);
-        }
+    if ( @xferPid ) {
+        kill(2, @xferPid);
+       sleep(1);
+       kill(9, @xferPid);
     }
     if ( $tarPid > 0 ) {
-        if ( kill(2, $tarPid) <= 0 ) {
-            sleep(1);
-            kill(9, $tarPid);
-        }
+        kill(2, $tarPid);
+       sleep(1);
+       kill(9, $tarPid);
     }
     unlink("$Dir/timeStamp.level0");
     unlink("$Dir/NewFileList");
@@ -907,6 +957,23 @@ sub CorrectHostCheck
     return;
 }
 
+#
+# The Xfer method might tell us from time to time about processes
+# it forks.  We tell BackupPC about this (for status displays) and
+# keep track of the pids in case we cancel the backup
+#
+sub pidHandler
+{
+    @xferPid = @_;
+    @xferPid = grep(/./, @xferPid);
+    return if ( !@xferPid && $tarPid < 0 );
+    my @pids = @xferPid;
+    push(@pids, $tarPid) if ( $tarPid > 0 );
+    my $str = join(",", @pids);
+    $XferLOG->write(\"Xfer PIDs are now $str\n") if ( defined($XferLOG) );
+    print("xferPids $str\n");
+}
+
 #
 # Run an optional pre- or post-dump command
 #
@@ -916,19 +983,21 @@ sub UserCommandRun
 
     return if ( !defined($Conf{$type}) );
     my $vars = {
-        xfer    => $xfer,
-        client  => $client,
-        host    => $host,
-        hostIP  => $hostIP,
-        share   => $ShareNames->[0],
-        shares  => $ShareNames,
+        xfer       => $xfer,
+        client     => $client,
+        host       => $host,
+        hostIP     => $hostIP,
+       user       => $Hosts->{$client}{user},
+       moreUsers  => $Hosts->{$client}{moreUsers},
+        share      => $ShareNames->[0],
+        shares     => $ShareNames,
         XferMethod => $Conf{XferMethod},
-        sshPath => $Conf{SshPath},
-        LOG     => *LOG,
-        XferLOG => $XferLOG,
-        stat    => \%stat,
-        xferOK  => $stat{xferOK},
-       type    => $type,
+        sshPath    => $Conf{SshPath},
+        LOG        => *LOG,
+        XferLOG    => $XferLOG,
+        stat       => \%stat,
+        xferOK     => $stat{xferOK} || 0,
+       type       => $type,
     };
     my $cmd = $bpc->cmdVarSubstitute($Conf{$type}, $vars);
     $XferLOG->write(\"Executing $type: @$cmd\n");