bin/BackupPC_dump

   1 #!/usr/bin/perl
   2 #============================================================= -*-perl-*-
   3 #
   4 # BackupPC_dump: Dump a single client.
   5 #
   6 # DESCRIPTION
   7 #
   8 #   Usage: BackupPC_dump [-i] [-f] [-F] [-I] [-d] [-e] [-v] <client>
   9 #
  10 #   Flags:
  11 #
  12 #     -i   Do an incremental dump, overriding any scheduling (but a full
  13 #          dump will be done if no dumps have yet succeeded)
  14 #
  15 #     -f   Do a full dump, overriding any scheduling.
  16 #
  17 #     -I   Do an increment dump if the regular schedule requires a
  18 #          full or incremental, otherwise do nothing (a full is done
  19 #          if no dumps have yet succeeded)
  20 #
  21 #     -F   Do a full dump if the regular schedule requires a
  22 #          full or incremental, otherwise do nothing
  23 #
  24 #     -d   Host is a DHCP pool address, and the client argument
  25 #          just an IP address.  We lookup the NetBios name from
  26 #          the IP address.
  27 #
  28 #     -e   Just do an dump expiry check for the client.  Don't do anything
  29 #          else.  This is used periodically by BackupPC to make sure that
  30 #          dhcp hosts have correctly expired old backups.  Without this,
  31 #          dhcp hosts that are no longer on the network will not expire
  32 #          old backups.
  33 #
  34 #     -v   verbose.  for manual usage: prints failure reasons in more detail.
  35 #
  36 #   BackupPC_dump is run periodically by BackupPC to backup $client.
  37 #   The file $TopDir/pc/$client/backups is read to decide whether a
  38 #   full or incremental backup needs to be run.  If no backup is
  39 #   scheduled, or a ping to $client fails, then BackupPC_dump quits.
  40 #
  41 #   The backup is done using the selected XferMethod (smb, tar, rsync,
  42 #   backuppcd etc), extracting the dump into $TopDir/pc/$client/new.
  43 #   The xfer output is put into $TopDir/pc/$client/XferLOG.
  44 #
  45 #   If the dump succeeds (based on parsing the output of the XferMethod):
  46 #     - $TopDir/pc/$client/new is renamed to $TopDir/pc/$client/nnn, where
  47 #           nnn is the next sequential dump number.
  48 #     - $TopDir/pc/$client/XferLOG is renamed to $TopDir/pc/$client/XferLOG.nnn.
  49 #     - $TopDir/pc/$client/backups is updated.
  50 #
  51 #   If the dump fails:
  52 #     - $TopDir/pc/$client/new is moved to $TopDir/trash for later removal.
  53 #     - $TopDir/pc/$client/XferLOG is renamed to $TopDir/pc/$client/XferLOG.bad
  54 #           for later viewing.
  55 #
  56 #   BackupPC_dump communicates to BackupPC via printing to STDOUT.
  57 #
  58 # AUTHOR
  59 #   Craig Barratt  <cbarratt@users.sourceforge.net>
  60 #
  61 # COPYRIGHT
  62 #   Copyright (C) 2001-2009  Craig Barratt
  63 #
  64 #   This program is free software; you can redistribute it and/or modify
  65 #   it under the terms of the GNU General Public License as published by
  66 #   the Free Software Foundation; either version 2 of the License, or
  67 #   (at your option) any later version.
  68 #
  69 #   This program is distributed in the hope that it will be useful,
  70 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  71 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  72 #   GNU General Public License for more details.
  73 #
  74 #   You should have received a copy of the GNU General Public License
  75 #   along with this program; if not, write to the Free Software
  76 #   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  77 #
  78 #========================================================================
  79 #
  80 # Version 3.2.0, released 31 Jul 2010.
  81 #
  82 # See http://backuppc.sourceforge.net.
  83 #
  84 #========================================================================
  85
  86 use strict;
  87 no  utf8;
  88 use lib "/usr/local/BackupPC/lib";
  89 use BackupPC::Lib;
  90 use BackupPC::FileZIO;
  91 use BackupPC::Storage;
  92 use BackupPC::Xfer;
  93 use Encode;
  94 use Socket;
  95 use File::Path;
  96 use File::Find;
  97 use Getopt::Std;
  98
  99 ###########################################################################
 100 # Initialize
 101 ###########################################################################
 102
 103 die("BackupPC::Lib->new failed\n") if ( !(my $bpc = BackupPC::Lib->new) );
 104 my $TopDir = $bpc->TopDir();
 105 my $BinDir = $bpc->BinDir();
 106 my %Conf   = $bpc->Conf();
 107 my $NeedPostCmd;
 108 my $Hosts;
 109 my $SigName;
 110 my $Abort;
 111
 112 $bpc->ChildInit();
 113
 114 my %opts;
 115 if ( !getopts("defivFI", \%opts) || @ARGV != 1 ) {
 116     print("usage: $0 [-d] [-e] [-f] [-i] [-F] [-I] [-v] <client>\n");
 117     exit(1);
 118 }
 119 if ( $ARGV[0] !~ /^([\w\.\s-]+)$/ ) {
 120     print("$0: bad client name '$ARGV[0]'\n");
 121     exit(1);
 122 }
 123 if ( (defined($opts{f}) + defined($opts{i}) + defined($opts{F}) + defined($opts{I})) > 1 ) {
 124     print("$0: exiting because you can only use one of -f, -i, -F, and -I\n");
 125     exit(1);
 126 }
 127
 128 my $client = $1;   # BackupPC's client name (might not be real host name)
 129 my $hostIP;        # this is the IP address
 130 my $host;          # this is the real host name
 131
 132 my($clientURI, $user);
 133
 134 $bpc->verbose(1) if ( $opts{v} );
 135
 136 if ( $opts{d} ) {
 137     #
 138     # The client name $client is simply a DHCP address.  We need to check
 139     # if there is any machine at this address, and if so, get the actual
 140     # host name via NetBios using nmblookup.
 141     #
 142     $hostIP = $client;
 143     if ( $bpc->CheckHostAlive($hostIP) < 0 ) {
 144         print(STDERR "Exiting because CheckHostAlive($hostIP) failed\n")
 145                             if ( $opts{v} );
 146         exit(1);
 147     }
 148     if ( $Conf{NmbLookupCmd} eq "" ) {
 149         print(STDERR "Exiting because \$Conf{NmbLookupCmd} is empty\n")
 150                             if ( $opts{v} );
 151         exit(1);
 152     }
 153     ($client, $user) = $bpc->NetBiosInfoGet($hostIP);
 154     if ( $client !~ /^([\w\.\s-]+)$/ ) {
 155         print(STDERR "Exiting because NetBiosInfoGet($hostIP) returned"
 156                    . " '$client', an invalid host name\n") if ( $opts{v} );
 157         exit(1)
 158     }
 159     $Hosts = $bpc->HostInfoRead($client);
 160     $host = $client;
 161 } else {
 162     $Hosts = $bpc->HostInfoRead($client);
 163 }
 164 if ( !defined($Hosts->{$client}) ) {
 165     print(STDERR "Exiting because host $client does not exist in the"
 166                . " hosts file\n") if ( $opts{v} );
 167     exit(1)
 168 }
 169
 170 my $Dir     = "$TopDir/pc/$client";
 171 my @xferPid = ();
 172 my $tarPid  = -1;
 173 my $completionPercent;
 174
 175 #
 176 # Re-read config file, so we can include the PC-specific config
 177 #
 178 $clientURI = $bpc->uriEsc($client);
 179 if ( defined(my $error = $bpc->ConfigRead($client)) ) {
 180     print("dump failed: Can't read PC's config file: $error\n");
 181     exit(1);
 182 }
 183 %Conf = $bpc->Conf();
 184
 185 #
 186 # Catch various signals
 187 #
 188 $SIG{INT}  = \&catch_signal;
 189 $SIG{ALRM} = \&catch_signal;
 190 $SIG{TERM} = \&catch_signal;
 191 $SIG{PIPE} = \&catch_signal;
 192 $SIG{STOP} = \&catch_signal;
 193 $SIG{TSTP} = \&catch_signal;
 194 $SIG{TTIN} = \&catch_signal;
 195 my $Pid = $$;
 196
 197 #
 198 # Make sure we eventually timeout if there is no activity from
 199 # the data transport program.
 200 #
 201 alarm($Conf{ClientTimeout});
 202
 203 mkpath($Dir, 0, 0777) if ( !-d $Dir );
 204 if ( !-f "$Dir/LOCK" ) {
 205     open(LOCK, ">", "$Dir/LOCK") && close(LOCK);
 206 }
 207
 208 my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
 209 my $logPath = sprintf("$Dir/LOG.%02d%04d", $mon + 1, $year + 1900);
 210
 211 if ( !-f $logPath ) {
 212     #
 213     # Compress and prune old log files
 214     #
 215     my $lastLog = $Conf{MaxOldPerPCLogFiles} - 1;
 216     foreach my $file ( $bpc->sortedPCLogFiles($client) ) {
 217         if ( $lastLog <= 0 ) {
 218             unlink($file);
 219             next;
 220         }
 221         $lastLog--;
 222         next if ( $file =~ /\.z$/ || !$Conf{CompressLevel} );
 223         BackupPC::FileZIO->compressCopy($file,
 224                                         "$file.z",
 225                                         undef,
 226                                         $Conf{CompressLevel}, 1);
 227     }
 228 }
 229
 230 open(LOG, ">>", $logPath);
 231 select(LOG); $| = 1; select(STDOUT);
 232
 233 #
 234 # For the -e option we just expire backups and quit
 235 #
 236 if ( $opts{e} ) {
 237     BackupExpire($client);
 238     exit(0);
 239 }
 240
 241 #
 242 # For archive hosts we don't bother any further
 243 #
 244 if ($Conf{XferMethod} eq "archive" ) {
 245     print(STDERR "Exiting because the XferMethod is set to archive\n")
 246                 if ( $opts{v} );
 247     exit(0);
 248 }
 249
 250 ###########################################################################
 251 # Figure out what to do and do it
 252 ###########################################################################
 253
 254 #
 255 # See if we should skip this host during a certain range
 256 # of times.
 257 #
 258 my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort});
 259 if ( $err ne "" ) {
 260     print("Can't connect to server ($err)\n");
 261     print(LOG $bpc->timeStamp, "Can't connect to server ($err)\n");
 262     exit(1);
 263 }
 264 my $reply = $bpc->ServerMesg("status host($clientURI)");
 265 $reply = $1 if ( $reply =~ /(.*)/s );
 266 my(%StatusHost);
 267 eval($reply);
 268 $bpc->ServerDisconnect();
 269
 270 #
 271 # For DHCP tell BackupPC which host this is
 272 #
 273 if ( $opts{d} ) {
 274     if ( $StatusHost{activeJob} ) {
 275         # oops, something is already running for this host
 276         print(STDERR "Exiting because backup is already running for $client\n")
 277                         if ( $opts{v} );
 278         exit(0);
 279     }
 280     print("DHCP $hostIP $clientURI\n");
 281 }
 282
 283 my($needLink, @Backups, $type);
 284 my($incrBaseTime, $incrBaseBkupNum, $incrBaseLevel, $incrLevel);
 285 my $lastFullTime = 0;
 286 my $lastIncrTime = 0;
 287 my $partialIdx = -1;
 288 my $partialNum;
 289 my $partialFileCnt;
 290 my $lastBkupNum;
 291 my $lastPartial = 0;
 292
 293 #
 294 # Maintain backward compatibility with $Conf{FullPeriod} == -1 or -2
 295 # meaning disable backups
 296 #
 297 $Conf{BackupsDisable} = -$Conf{FullPeriod}
 298             if ( !$Conf{BackupsDisable} && $Conf{FullPeriod} < 0 );
 299
 300 if ( $Conf{BackupsDisable} == 1 && !$opts{f} && !$opts{i}
 301         || $Conf{BackupsDisable} == 2 ) {
 302     print(STDERR "Exiting because backups are disabled with"
 303        . " \$Conf{BackupsDisable} = $Conf{BackupsDisable}\n") if ( $opts{v} );
 304     #
 305     # Tell BackupPC to ignore old failed backups on hosts that
 306     # have backups disabled.
 307     #
 308     print("backups disabled\n")
 309                 if ( defined($StatusHost{errorTime})
 310                      && $StatusHost{reason} ne "Reason_backup_done"
 311                      && time - $StatusHost{errorTime} > 4 * 24 * 3600 );
 312     NothingToDo($needLink);
 313 }
 314
 315 if ( !$opts{i} && !$opts{f} && $Conf{BlackoutGoodCnt} >= 0
 316              && $StatusHost{aliveCnt} >= $Conf{BlackoutGoodCnt} ) {
 317     my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
 318     my($currHours) = $hour + $min / 60 + $sec / 3600;
 319     my $blackout;
 320
 321     foreach my $p ( @{$Conf{BlackoutPeriods}} ) {
 322         #
 323         # Allow blackout to span midnight (specified by hourBegin
 324         # being greater than hourEnd)
 325         #
 326         next if ( ref($p->{weekDays}) ne "ARRAY"
 327                     || !defined($p->{hourBegin})
 328                     || !defined($p->{hourEnd})
 329                 );
 330         my $matchWday = $wday;
 331         if ( $p->{hourBegin} > $p->{hourEnd} ) {
 332             $blackout = $p->{hourBegin} <= $currHours
 333                           || $currHours <= $p->{hourEnd};
 334             if ( $currHours <= $p->{hourEnd} ) {
 335                 #
 336                 # This is after midnight, so decrement the weekday for the
 337                 # weekday check (eg: Monday 11pm-1am means Monday 2300 to
 338                 # Tuesday 0100, not Monday 2300-2400 plus Monday 0000-0100).
 339                 #
 340                 $matchWday--;
 341                 $matchWday += 7 if ( $matchWday < 0 );
 342             }
 343         } else {
 344             $blackout = $p->{hourBegin} <= $currHours
 345                           && $currHours <= $p->{hourEnd};
 346         }
 347         if ( $blackout && grep($_ == $matchWday, @{$p->{weekDays}}) ) {
 348 #           print(LOG $bpc->timeStamp, "skipping because of blackout"
 349 #                      . " (alive $StatusHost{aliveCnt} times)\n");
 350             print(STDERR "Skipping $client because of blackout\n")
 351                             if ( $opts{v} );
 352             NothingToDo($needLink);
 353         }
 354     }
 355 }
 356
 357 if ( !$opts{i} && !$opts{f} && $StatusHost{backoffTime} > time ) {
 358     printf(LOG "%sskipping because of user requested delay (%.1f hours left)\n",
 359                 $bpc->timeStamp, ($StatusHost{backoffTime} - time) / 3600);
 360     NothingToDo($needLink);
 361 }
 362
 363 #
 364 # Now see if there are any old backups we should delete
 365 #
 366 BackupExpire($client);
 367
 368 my(@lastIdxByLevel, $incrCntSinceFull);
 369
 370 #
 371 # Read Backup information, and find times of the most recent full and
 372 # incremental backups.  Also figure out which backup we will use
 373 # as a starting point for an incremental.
 374 #
 375 @Backups = $bpc->BackupInfoRead($client);
 376 for ( my $i = 0 ; $i < @Backups ; $i++ ) {
 377     $needLink = 1 if ( $Backups[$i]{nFilesNew} eq ""
 378                         || -f "$Dir/NewFileList.$Backups[$i]{num}" );
 379     if ( $Backups[$i]{type} eq "full" ) {
 380         $incrCntSinceFull = 0;
 381         $lastBkupNum = $Backups[$i]{num};
 382         $lastIdxByLevel[0] = $i;
 383         if ( $lastFullTime < $Backups[$i]{startTime} ) {
 384             $lastFullTime = $Backups[$i]{startTime};
 385         }
 386     } elsif ( $Backups[$i]{type} eq "incr" ) {
 387         $incrCntSinceFull++;
 388         $lastBkupNum = $Backups[$i]{num};
 389         $lastIdxByLevel[$Backups[$i]{level}] = $i;
 390         $lastIncrTime = $Backups[$i]{startTime}
 391                 if ( $lastIncrTime < $Backups[$i]{startTime} );
 392     } elsif ( $Backups[$i]{type} eq "partial" ) {
 393         $partialIdx     = $i;
 394         $lastPartial    = $Backups[$i]{startTime};
 395         $partialNum     = $Backups[$i]{num};
 396         $partialFileCnt = $Backups[$i]{nFiles};
 397     }
 398 }
 399
 400 #
 401 # Decide whether we do nothing, or a full or incremental backup.
 402 #
 403 my $needs_full = (time - $lastFullTime > $Conf{FullPeriod} * 24 * 3600
 404                && time - $lastIncrTime > $Conf{IncrPeriod} * 24 * 3600);
 405 my $needs_incr = (time - $lastIncrTime > $Conf{IncrPeriod} * 24 * 3600
 406                && time - $lastFullTime > $Conf{IncrPeriod} * 24 * 3600);
 407
 408 if ( $lastFullTime == 0
 409         || $opts{f}
 410         || (!$opts{i} && !$opts{I} && $needs_full)
 411         || ( $opts{F} && $needs_incr) ) {
 412     $type = "full";
 413     $incrLevel = 0;
 414     $incrBaseBkupNum = $lastBkupNum;
 415 } elsif ( $opts{i}
 416         || $needs_incr
 417         || ($opts{I} && $needs_full) ) {
 418     $type = "incr";
 419     #
 420     # For an incremental backup, figure out which level we should
 421     # do and the index of the reference backup, which is the most
 422     # recent backup at any lower level.
 423     #
 424     @{$Conf{IncrLevels}} = [$Conf{IncrLevels}]
 425                             unless ref($Conf{IncrLevels}) eq "ARRAY";
 426     @{$Conf{IncrLevels}} = [1] if ( !@{$Conf{IncrLevels}} );
 427     $incrCntSinceFull = $incrCntSinceFull % @{$Conf{IncrLevels}};
 428     $incrLevel = $Conf{IncrLevels}[$incrCntSinceFull];
 429     for ( my $i = 0 ; $i < $incrLevel ; $i++ ) {
 430         my $idx = $lastIdxByLevel[$i];
 431         next if ( !defined($idx) );
 432         if ( !defined($incrBaseTime)
 433                 || $Backups[$idx]{startTime} > $incrBaseTime ) {
 434             $incrBaseBkupNum = $Backups[$idx]{num};
 435             $incrBaseLevel   = $Backups[$idx]{level};
 436             $incrBaseTime    = $Backups[$idx]{startTime};
 437         }
 438     }
 439     #
 440     # Can't find any earlier lower-level backup!  Shouldn't
 441     # happen - just do full instead
 442     #
 443     if ( !defined($incrBaseBkupNum) || $incrLevel < 1 ) {
 444         $type = "full";
 445         $incrBaseBkupNum = $lastBkupNum;
 446     }
 447 } else {
 448     NothingToDo($needLink);
 449 }
 450
 451 #
 452 # Create top-level directories if they don't exist
 453 #
 454 foreach my $dir ( (
 455             "$Conf{TopDir}",
 456             "$Conf{TopDir}/pool",
 457             "$Conf{TopDir}/cpool",
 458             "$Conf{TopDir}/pc",
 459             "$Conf{TopDir}/trash",
 460         ) ) {
 461     next if ( -d $dir );
 462     mkpath($dir, 0, 0750);
 463     if ( !-d $dir ) {
 464         print("Failed to create $dir\n");
 465         printf(LOG "%sFailed to create directory %s\n", $bpc->timeStamp, $dir);
 466         print("link $clientURI\n") if ( $needLink );
 467         exit(1);
 468     } else {
 469         printf(LOG "%sCreated directory %s\n", $bpc->timeStamp, $dir);
 470     }
 471 }
 472
 473 if ( !$bpc->HardlinkTest($Dir, "$TopDir/cpool") ) {
 474     print(LOG $bpc->timeStamp, "Can't create a test hardlink between a file"
 475                . " in $Dir and $TopDir/cpool.  Either these are different"
 476                . " file systems, or this file system doesn't support hardlinks,"
 477                . " or these directories don't exist, or there is a permissions"
 478                . " problem, or the file system is out of inodes or full.  Use"
 479                . " df, df -i, and ls -ld to check each of these possibilities."
 480                . " Quitting...\n");
 481     print("test hardlink between $Dir and $TopDir/cpool failed\n");
 482     print("link $clientURI\n") if ( $needLink );
 483     exit(1);
 484 }
 485
 486 if ( !$opts{d} ) {
 487     #
 488     # In the non-DHCP case, make sure the host can be looked up
 489     # via NS, or otherwise find the IP address via NetBios.
 490     #
 491     if ( $Conf{ClientNameAlias} ne "" ) {
 492         $host = $Conf{ClientNameAlias};
 493     } else {
 494         $host = $client;
 495     }
 496     if ( !defined(gethostbyname($host)) ) {
 497         #
 498         # Ok, NS doesn't know about it.  Maybe it is a NetBios name
 499         # instead.
 500         #
 501         print(STDERR "Name server doesn't know about $host; trying NetBios\n")
 502                         if ( $opts{v} );
 503         if ( !defined($hostIP = $bpc->NetBiosHostIPFind($host)) ) {
 504             print(LOG $bpc->timeStamp, "Can't find host $host via netbios\n");
 505             print("host not found\n");
 506             exit(1);
 507         }
 508     } else {
 509         $hostIP = $host;
 510     }
 511 }
 512
 513 #
 514 # Check if $host is alive
 515 #
 516 my $delay = $bpc->CheckHostAlive($hostIP);
 517 if ( $delay < 0 ) {
 518     print(LOG $bpc->timeStamp, "no ping response\n");
 519     print("no ping response\n");
 520     print("link $clientURI\n") if ( $needLink );
 521     exit(1);
 522 } elsif ( $delay > $Conf{PingMaxMsec} ) {
 523     printf(LOG "%sping too slow: %.4gmsec\n", $bpc->timeStamp, $delay);
 524     printf("ping too slow: %.4gmsec (threshold is %gmsec)\n",
 525                     $delay, $Conf{PingMaxMsec});
 526     print("link $clientURI\n") if ( $needLink );
 527     exit(1);
 528 }
 529
 530 #
 531 # Make sure it is really the machine we expect (only for fixed addresses,
 532 # since we got the DHCP address above).
 533 #
 534 if ( !$opts{d} && (my $errMsg = CorrectHostCheck($hostIP, $host)) ) {
 535     print(LOG $bpc->timeStamp, "dump failed: $errMsg\n");
 536     print("dump failed: $errMsg\n");
 537     exit(1);
 538 } elsif ( $opts{d} ) {
 539     print(LOG $bpc->timeStamp, "$host is dhcp $hostIP, user is $user\n");
 540 }
 541
 542 #
 543 # Get a clean directory $Dir/new
 544 #
 545 $bpc->RmTreeDefer("$TopDir/trash", "$Dir/new") if ( -d "$Dir/new" );
 546
 547 #
 548 # Setup file extension for compression and open XferLOG output file
 549 #
 550 if ( $Conf{CompressLevel} && !BackupPC::FileZIO->compOk ) {
 551     print(LOG $bpc->timeStamp, "dump failed: can't find Compress::Zlib\n");
 552     print("dump failed: can't find Compress::Zlib\n");
 553     exit(1);
 554 }
 555 my $fileExt = $Conf{CompressLevel} > 0 ? ".z" : "";
 556 my $XferLOG = BackupPC::FileZIO->open("$Dir/XferLOG$fileExt", 1,
 557                                      $Conf{CompressLevel});
 558 if ( !defined($XferLOG) ) {
 559     print(LOG $bpc->timeStamp, "dump failed: unable to open/create"
 560                              . " $Dir/XferLOG$fileExt\n");
 561     print("dump failed: unable to open/create $Dir/XferLOG$fileExt\n");
 562     exit(1);
 563 }
 564
 565 #
 566 # Ignore the partial dump in the case of an incremental
 567 # or when the partial is too old.  A partial is a partial full.
 568 #
 569 if ( $type ne "full" || time - $lastPartial > $Conf{PartialAgeMax} * 24*3600 ) {
 570     $partialNum = undef;
 571     $partialIdx = -1;
 572 }
 573
 574 #
 575 # If this is a partial, copy the old XferLOG file
 576 #
 577 if ( $partialNum ) {
 578     my($compress, $fileName);
 579     if ( -f "$Dir/XferLOG.$partialNum.z" ) {
 580         $fileName = "$Dir/XferLOG.$partialNum.z";
 581         $compress = 1;
 582     } elsif ( -f "$Dir/XferLOG.$partialNum" ) {
 583         $fileName = "$Dir/XferLOG.$partialNum";
 584         $compress = 0;
 585     }
 586     if ( my $oldLOG = BackupPC::FileZIO->open($fileName, 0, $compress) ) {
 587         my $data;
 588         while ( $oldLOG->read(\$data, 65536) > 0 ) {
 589             $XferLOG->write(\$data);
 590         }
 591         $oldLOG->close;
 592     }
 593 }
 594
 595 $XferLOG->writeTeeStderr(1) if ( $opts{v} );
 596 unlink("$Dir/NewFileList") if ( -f "$Dir/NewFileList" );
 597
 598 my $startTime     = time();
 599 my $tarErrs       = 0;
 600 my $nFilesExist   = 0;
 601 my $sizeExist     = 0;
 602 my $sizeExistComp = 0;
 603 my $nFilesTotal   = 0;
 604 my $sizeTotal     = 0;
 605 my($logMsg, %stat, $xfer, $ShareNames, $noFilesErr);
 606 my $newFilesFH;
 607
 608 $ShareNames = BackupPC::Xfer::getShareNames(\%Conf);
 609
 610 #
 611 # Run an optional pre-dump command
 612 #
 613 UserCommandRun("DumpPreUserCmd");
 614 if ( $? && $Conf{UserCmdCheckStatus} ) {
 615     print(LOG $bpc->timeStamp,
 616             "DumpPreUserCmd returned error status $?... exiting\n");
 617     $XferLOG->write(\"DumpPreUserCmd returned error status $?... exiting\n");
 618     $stat{hostError} = "DumpPreUserCmd returned error status $?";
 619     BackupFailCleanup();
 620 }
 621 $NeedPostCmd = 1;
 622
 623 #
 624 # Now backup each of the shares
 625 #
 626 my $shareDuplicate = {};
 627 for my $shareName ( @$ShareNames ) {
 628     local(*RH, *WH);
 629
 630     #
 631     # Convert $shareName to utf8 octets
 632     #
 633     $shareName = encode("utf8", $shareName);
 634     $stat{xferOK} = $stat{hostAbort} = undef;
 635     $stat{hostError} = $stat{lastOutputLine} = undef;
 636     if ( $shareName eq "" ) {
 637         print(LOG $bpc->timeStamp,
 638                   "unexpected empty share name skipped\n");
 639         next;
 640     }
 641     if ( $shareDuplicate->{$shareName} ) {
 642         print(LOG $bpc->timeStamp,
 643                   "unexpected repeated share name $shareName skipped\n");
 644         next;
 645     }
 646     $shareDuplicate->{$shareName} = 1;
 647
 648     UserCommandRun("DumpPreShareCmd", $shareName);
 649     if ( $? && $Conf{UserCmdCheckStatus} ) {
 650         print(LOG $bpc->timeStamp,
 651                 "DumpPreShareCmd returned error status $?... exiting\n");
 652         UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
 653         $XferLOG->write(\"DumpPreShareCmd returned error status $?... exiting\n");
 654         $stat{hostError} = "DumpPreShareCmd returned error status $?";
 655         BackupFailCleanup();
 656     }
 657
 658     $xfer = BackupPC::Xfer::create($Conf{XferMethod}, $bpc);
 659     if ( !defined($xfer) ) {
 660         my $errStr = BackupPC::Xfer::errStr();
 661         print(LOG $bpc->timeStamp, "dump failed: $errStr\n");
 662         UserCommandRun("DumpPostShareCmd", $shareName) if ( $NeedPostCmd );
 663         UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
 664         $XferLOG->write(\"BackupPC::Xfer::create failed: $errStr\n");
 665         $stat{hostError} = $errStr;
 666         BackupFailCleanup();
 667     }
 668
 669     my $useTar = $xfer->useTar;
 670
 671     if ( $useTar ) {
 672         #
 673         # This xfer method outputs a tar format file, so we start a
 674         # BackupPC_tarExtract to extract the data.
 675         #
 676         # Create a socketpair to connect the Xfer method to BackupPC_tarExtract
 677         # WH is the write handle for writing, provided to the transport
 678         # program, and RH is the other end of the socket for reading,
 679         # provided to BackupPC_tarExtract.
 680         #
 681         if ( socketpair(RH, WH, AF_UNIX, SOCK_STREAM, PF_UNSPEC) ) {
 682             shutdown(RH, 1);    # no writing to this socket
 683             shutdown(WH, 0);    # no reading from this socket
 684             setsockopt(RH, SOL_SOCKET, SO_RCVBUF, 8 * 65536);
 685             setsockopt(WH, SOL_SOCKET, SO_SNDBUF, 8 * 65536);
 686         } else {
 687             #
 688             # Default to pipe() if socketpair() doesn't work.
 689             #
 690             pipe(RH, WH);
 691         }
 692
 693         #
 694         # fork a child for BackupPC_tarExtract.  TAR is a file handle
 695         # on which we (the parent) read the stdout & stderr from
 696         # BackupPC_tarExtract.
 697         #
 698         if ( !defined($tarPid = open(TAR, "-|")) ) {
 699             print(LOG $bpc->timeStamp, "can't fork to run tar\n");
 700             print("can't fork to run tar\n");
 701             close(RH);
 702             close(WH);
 703             last;
 704         }
 705         binmode(TAR);
 706         if ( !$tarPid ) {
 707             #
 708             # This is the tar child.  Close the write end of the pipe,
 709             # clone STDERR to STDOUT, clone STDIN from RH, and then
 710             # exec BackupPC_tarExtract.
 711             #
 712             setpgrp 0,0;
 713             close(WH);
 714             close(STDERR);
 715             open(STDERR, ">&STDOUT");
 716             close(STDIN);
 717             open(STDIN, "<&RH");
 718             alarm(0);
 719             exec("$BinDir/BackupPC_tarExtract", $client, $shareName,
 720                          $Conf{CompressLevel});
 721             print(LOG $bpc->timeStamp,
 722                         "can't exec $BinDir/BackupPC_tarExtract\n");
 723             exit(0);
 724         }
 725     } elsif ( !defined($newFilesFH) ) {
 726         #
 727         # We need to create the NewFileList output file
 728         #
 729         local(*NEW_FILES);
 730         open(NEW_FILES, ">", "$TopDir/pc/$client/NewFileList")
 731                      || die("can't open $TopDir/pc/$client/NewFileList");
 732         $newFilesFH = *NEW_FILES;
 733         binmode(NEW_FILES);
 734     }
 735
 736     #
 737     # Run the transport program
 738     #
 739     $xfer->args({
 740         host         => $host,
 741         client       => $client,
 742         hostIP       => $hostIP,
 743         shareName    => $shareName,
 744         pipeRH       => *RH,
 745         pipeWH       => *WH,
 746         XferLOG      => $XferLOG,
 747         newFilesFH   => $newFilesFH,
 748         outDir       => $Dir,
 749         type         => $type,
 750         incrBaseTime => $incrBaseTime,
 751         incrBaseBkupNum => $incrBaseBkupNum,
 752         backups      => \@Backups,
 753         compress     => $Conf{CompressLevel},
 754         XferMethod   => $Conf{XferMethod},
 755         logLevel     => $Conf{XferLogLevel},
 756         partialNum   => $partialNum,
 757         pidHandler   => \&pidHandler,
 758         completionPercent => \&completionPercent,
 759     });
 760
 761     if ( !defined($logMsg = $xfer->start()) ) {
 762         my $errStr = "xfer start failed: " . $xfer->errStr . "\n";
 763         print(LOG $bpc->timeStamp, $errStr);
 764         #
 765         # kill off the tar process, first nicely then forcefully
 766         #
 767         if ( $tarPid > 0 ) {
 768             kill($bpc->sigName2num("INT"), $tarPid);
 769             sleep(1);
 770             kill($bpc->sigName2num("KILL"), $tarPid);
 771         }
 772         if ( @xferPid ) {
 773             kill($bpc->sigName2num("INT"), @xferPid);
 774             sleep(1);
 775             kill($bpc->sigName2num("KILL"), @xferPid);
 776         }
 777         UserCommandRun("DumpPostShareCmd", $shareName) if ( $NeedPostCmd );
 778         UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
 779         $XferLOG->write(\"xfer start failed: $errStr\n");
 780         $stat{hostError} = $errStr;
 781         BackupFailCleanup();
 782     }
 783
 784     @xferPid = $xfer->xferPid;
 785
 786     if ( $useTar ) {
 787         #
 788         # The parent must close both handles on the pipe since the children
 789         # are using these handles now.
 790         #
 791         close(RH);
 792         close(WH);
 793     }
 794     print(LOG $bpc->timeStamp, $logMsg, "\n");
 795     $XferLOG->write(\"$logMsg\n");
 796     print("started $type dump, share=$shareName\n");
 797
 798     pidHandler(@xferPid);
 799
 800     if ( $useTar ) {
 801         #
 802         # Parse the output of the transfer program and BackupPC_tarExtract
 803         # while they run.  Since we might be reading from two or more children
 804         # we use a select.
 805         #
 806         my($FDread, $tarOut, $mesg);
 807         vec($FDread, fileno(TAR), 1) = 1;
 808         $xfer->setSelectMask(\$FDread);
 809
 810         SCAN: while ( 1 ) {
 811             my $ein = $FDread;
 812             last if ( $FDread =~ /^\0*$/ );
 813             select(my $rout = $FDread, undef, $ein, undef);
 814             if ( vec($rout, fileno(TAR), 1) ) {
 815                 if ( sysread(TAR, $mesg, 8192) <= 0 ) {
 816                     vec($FDread, fileno(TAR), 1) = 0;
 817                     close(TAR);
 818                 } else {
 819                     $tarOut .= $mesg;
 820                 }
 821             }
 822             while ( $tarOut =~ /(.*?)[\n\r]+(.*)/s ) {
 823                 $_ = $1;
 824                 $tarOut = $2;
 825                 if ( /^  / ) {
 826                     $XferLOG->write(\"$_\n");
 827                 } else {
 828                     $XferLOG->write(\"tarExtract: $_\n");
 829                 }
 830                 if ( /^BackupPC_tarExtact aborting \((.*)\)/ ) {
 831                     $stat{hostError} = $1;
 832                 }
 833                 if ( /^Done: (\d+) errors, (\d+) filesExist, (\d+) sizeExist, (\d+) sizeExistComp, (\d+) filesTotal, (\d+) sizeTotal/ ) {
 834                     $tarErrs       += $1;
 835                     $nFilesExist   += $2;
 836                     $sizeExist     += $3;
 837                     $sizeExistComp += $4;
 838                     $nFilesTotal   += $5;
 839                     $sizeTotal     += $6;
 840                 }
 841             }
 842             last if ( !$xfer->readOutput(\$FDread, $rout) );
 843             while ( my $str = $xfer->logMsgGet ) {
 844                 print(LOG $bpc->timeStamp, "xfer: $str\n");
 845             }
 846             if ( $xfer->getStats->{fileCnt} == 1 ) {
 847                 #
 848                 # Make sure it is still the machine we expect.  We do this while
 849                 # the transfer is running to avoid a potential race condition if
 850                 # the ip address was reassigned by dhcp just before we started
 851                 # the transfer.
 852                 #
 853                 if ( my $errMsg = CorrectHostCheck($hostIP, $host) ) {
 854                     $stat{hostError} = $errMsg if ( $stat{hostError} eq "" );
 855                     last SCAN;
 856                 }
 857             }
 858         }
 859     } else {
 860         #
 861         # otherwise the xfer module does everything for us
 862         #
 863         my @results = $xfer->run();
 864         $tarErrs       += $results[0];
 865         $nFilesExist   += $results[1];
 866         $sizeExist     += $results[2];
 867         $sizeExistComp += $results[3];
 868         $nFilesTotal   += $results[4];
 869         $sizeTotal     += $results[5];
 870     }
 871
 872     #
 873     # Merge the xfer status (need to accumulate counts)
 874     #
 875     my $newStat = $xfer->getStats;
 876     if ( $newStat->{fileCnt} == 0 ) {
 877        $noFilesErr ||= "No files dumped for share $shareName";
 878     }
 879     foreach my $k ( (keys(%stat), keys(%$newStat)) ) {
 880         next if ( !defined($newStat->{$k}) );
 881         if ( $k =~ /Cnt$/ ) {
 882             $stat{$k} += $newStat->{$k};
 883             delete($newStat->{$k});
 884             next;
 885         }
 886         if ( !defined($stat{$k}) ) {
 887             $stat{$k} = $newStat->{$k};
 888             delete($newStat->{$k});
 889             next;
 890         }
 891     }
 892
 893     if ( $NeedPostCmd ) {
 894         UserCommandRun("DumpPostShareCmd", $shareName);
 895         if ( $? && $Conf{UserCmdCheckStatus} ) {
 896             print(LOG $bpc->timeStamp,
 897                     "DumpPostShareCmd returned error status $?... exiting\n");
 898             $stat{hostError} = "DumpPostShareCmd returned error status $?";
 899         }
 900     }
 901
 902     $stat{xferOK} = 0 if ( $stat{hostError} || $stat{hostAbort} );
 903     if ( !$stat{xferOK} ) {
 904         #
 905         # kill off the transfer program, first nicely then forcefully
 906         #
 907         if ( @xferPid ) {
 908             kill($bpc->sigName2num("INT"), @xferPid);
 909             sleep(1);
 910             kill($bpc->sigName2num("KILL"), @xferPid);
 911         }
 912         #
 913         # kill off the tar process, first nicely then forcefully
 914         #
 915         if ( $tarPid > 0 ) {
 916             kill($bpc->sigName2num("INT"), $tarPid);
 917             sleep(1);
 918             kill($bpc->sigName2num("KILL"), $tarPid);
 919         }
 920         #
 921         # don't do any more shares on this host
 922         #
 923         last;
 924     }
 925     #
 926     # Wait for any child processes to exit
 927     #
 928     # 1 while ( wait() >= 0 );
 929 }
 930
 931 #
 932 # If this is a full, and any share had zero files then consider the dump bad
 933 #
 934 if ( $type eq "full" && $stat{hostError} eq ""
 935             && length($noFilesErr) && $Conf{BackupZeroFilesIsFatal} ) {
 936     $stat{hostError} = $noFilesErr;
 937     $stat{xferOK} = 0;
 938 }
 939
 940 $stat{xferOK} = 0 if ( $Abort );
 941
 942 #
 943 # If there is no "new" directory then the backup is bad
 944 #
 945 if ( $stat{xferOK} && !-d "$Dir/new" ) {
 946     $stat{hostError} = "No backup directory $Dir/new"
 947                             if ( $stat{hostError} eq "" );
 948     $stat{xferOK} = 0;
 949 }
 950
 951 #
 952 # Do one last check to make sure it is still the machine we expect.
 953 #
 954 if ( $stat{xferOK} && (my $errMsg = CorrectHostCheck($hostIP, $host)) ) {
 955     $stat{hostError} = $errMsg;
 956     $stat{xferOK} = 0;
 957 }
 958
 959 UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
 960 if ( $? && $Conf{UserCmdCheckStatus} ) {
 961     print(LOG $bpc->timeStamp,
 962             "DumpPostUserCmd returned error status $?... exiting\n");
 963     $stat{hostError} = "DumpPostUserCmd returned error status $?";
 964     $stat{xferOK} = 0;
 965 }
 966 close($newFilesFH) if ( defined($newFilesFH) );
 967
 968 my $endTime = time();
 969
 970 #
 971 # If the dump failed, clean up
 972 #
 973 if ( !$stat{xferOK} ) {
 974     $stat{hostError} = $stat{lastOutputLine} if ( $stat{hostError} eq "" );
 975     if ( $stat{hostError} ) {
 976         print(LOG $bpc->timeStamp,
 977                   "Got fatal error during xfer ($stat{hostError})\n");
 978         $XferLOG->write(\"Got fatal error during xfer ($stat{hostError})\n");
 979     }
 980     if ( !$Abort ) {
 981         #
 982         # wait a short while and see if the system is still alive
 983         #
 984         sleep(5);
 985         if ( $bpc->CheckHostAlive($hostIP) < 0 ) {
 986             $stat{hostAbort} = 1;
 987         }
 988         if ( $stat{hostAbort} ) {
 989             $stat{hostError} = "lost network connection during backup";
 990         }
 991         print(LOG $bpc->timeStamp, "Backup aborted ($stat{hostError})\n");
 992         $XferLOG->write(\"Backup aborted ($stat{hostError})\n");
 993     } else {
 994         $XferLOG->write(\"Backup aborted by user signal\n");
 995     }
 996
 997     #
 998     # Close the log file and call BackupFailCleanup, which exits.
 999     #
1000     BackupFailCleanup();
1001 }
1002
1003 my $newNum = BackupSave();
1004
1005 my $otherCount = $stat{xferErrCnt} - $stat{xferBadFileCnt}
1006                                    - $stat{xferBadShareCnt};
1007 $stat{fileCnt}         ||= 0;
1008 $stat{byteCnt}         ||= 0;
1009 $stat{xferErrCnt}      ||= 0;
1010 $stat{xferBadFileCnt}  ||= 0;
1011 $stat{xferBadShareCnt} ||= 0;
1012 print(LOG $bpc->timeStamp,
1013           "$type backup $newNum complete, $stat{fileCnt} files,"
1014         . " $stat{byteCnt} bytes,"
1015         . " $stat{xferErrCnt} xferErrs ($stat{xferBadFileCnt} bad files,"
1016         . " $stat{xferBadShareCnt} bad shares, $otherCount other)\n");
1017
1018 BackupExpire($client);
1019
1020 print("$type backup complete\n");
1021
1022 ###########################################################################
1023 # Subroutines
1024 ###########################################################################
1025
1026 sub NothingToDo
1027 {
1028     my($needLink) = @_;
1029
1030     print("nothing to do\n");
1031     print("link $clientURI\n") if ( $needLink );
1032     exit(0);
1033 }
1034
1035 sub catch_signal
1036 {
1037     my $sigName = shift;
1038
1039     #
1040     # The first time we receive a signal we try to gracefully
1041     # abort the backup.  This allows us to keep a partial dump
1042     # with the in-progress file deleted and attribute caches
1043     # flushed to disk etc.
1044     #
1045     if ( !length($SigName) ) {
1046         my $reason;
1047         if ( $sigName eq "INT" ) {
1048             $reason = "aborted by user (signal=$sigName)";
1049         } else {
1050             $reason = "aborted by signal=$sigName";
1051         }
1052         if ( $Pid == $$ ) {
1053             #
1054             # Parent logs a message
1055             #
1056             print(LOG $bpc->timeStamp,
1057                     "Aborting backup up after signal $sigName\n");
1058
1059             #
1060             # Tell xfer to abort, but only if we actually started one
1061             #
1062             $xfer->abort($reason) if ( defined($xfer) );
1063
1064             #
1065             # Send ALRMs to BackupPC_tarExtract if we are using it
1066             #
1067             if ( $tarPid > 0 ) {
1068                 kill($bpc->sigName2num("ARLM"), $tarPid);
1069             }
1070
1071             #
1072             # Schedule a 20 second timer in case the clean
1073             # abort doesn't complete
1074             #
1075             alarm(20);
1076         } else {
1077             #
1078             # Children ignore anything other than ALRM and INT
1079             #
1080             if ( $sigName ne "ALRM" && $sigName ne "INT" ) {
1081                 return;
1082             }
1083
1084             #
1085             # The child also tells xfer to abort
1086             #
1087             $xfer->abort($reason);
1088
1089             #
1090             # Schedule a 15 second timer in case the clean
1091             # abort doesn't complete
1092             #
1093             alarm(15);
1094         }
1095         $SigName = $sigName;
1096         $Abort = 1;
1097         return;
1098     }
1099
1100     #
1101     # This is a second signal: time to clean up.
1102     #
1103     if ( $Pid != $$ && ($sigName eq "ALRM" || $sigName eq "INT") ) {
1104         #
1105         # Children quit quietly on ALRM or INT
1106         #
1107         exit(1)
1108     }
1109
1110     #
1111     # Ignore other signals in children
1112     #
1113     return if ( $Pid != $$ );
1114
1115     $SIG{$sigName} = 'IGNORE';
1116     UserCommandRun("DumpPostUserCmd") if ( $NeedPostCmd );
1117     $XferLOG->write(\"exiting after signal $sigName\n");
1118     if ( @xferPid ) {
1119         kill($bpc->sigName2num("INT"), @xferPid);
1120         sleep(1);
1121         kill($bpc->sigName2num("KILL"), @xferPid);
1122     }
1123     if ( $tarPid > 0 ) {
1124         kill($bpc->sigName2num("INT"), $tarPid);
1125         sleep(1);
1126         kill($bpc->sigName2num("KILL"), $tarPid);
1127     }
1128     if ( $sigName eq "INT" ) {
1129         $stat{hostError} = "aborted by user (signal=$sigName)";
1130     } else {
1131         $stat{hostError} = "received signal=$sigName";
1132     }
1133     BackupFailCleanup();
1134 }
1135
1136 sub CheckForNewFiles
1137 {
1138     if ( -f _ && $File::Find::name !~ /\/fattrib$/ ) {
1139         $nFilesTotal++;
1140     } elsif ( -d _ ) {
1141         #
1142         # No need to check entire tree
1143         #
1144         $File::Find::prune = 1 if ( $nFilesTotal );
1145     }
1146 }
1147
1148 sub BackupFailCleanup
1149 {
1150     my $fileExt = $Conf{CompressLevel} > 0 ? ".z" : "";
1151     my $keepPartial = 0;
1152
1153     #
1154     # We keep this backup if it is a full and we actually backed
1155     # up some files.  If the prior backup was a partial too, we
1156     # only keep this backup if it has more files than the previous
1157     # partial.
1158     #
1159     if ( $type eq "full" ) {
1160         if ( $nFilesTotal == 0 && $xfer->getStats->{fileCnt} == 0 ) {
1161             #
1162             # Xfer didn't report any files, but check in the new
1163             # directory just in case.
1164             #
1165             find(\&CheckForNewFiles, "$Dir/new");
1166         }
1167         my $str;
1168         if ( $nFilesTotal > $partialFileCnt
1169                 || $xfer->getStats->{fileCnt} > $partialFileCnt ) {
1170             #
1171             # If the last backup wasn't a partial then
1172             # $partialFileCnt is undefined, so the above
1173             # test is simply $nFilesTotal > 0
1174             #
1175             $keepPartial = 1;
1176             if ( $partialFileCnt ) {
1177                 $str = "Saving this as a partial backup\n";
1178             } else {
1179                 $str = sprintf("Saving this as a partial backup, replacing the"
1180                          . " prior one (got %d and %d files versus %d)\n",
1181                          $nFilesTotal, $xfer->getStats->{fileCnt}, $partialFileCnt);
1182             }
1183         } else {
1184             $str = sprintf("Not saving this as a partial backup since it has fewer"
1185                      . " files than the prior one (got %d and %d files versus %d)\n",
1186                      $nFilesTotal, $xfer->getStats->{fileCnt}, $partialFileCnt);
1187         }
1188         $XferLOG->write(\$str);
1189     }
1190
1191     #
1192     # Don't keep partials if they are disabled
1193     #
1194     $keepPartial = 0 if ( $Conf{PartialAgeMax} < 0 );
1195
1196     if ( !$keepPartial ) {
1197         #
1198         # No point in saving this dump; get rid of eveything.
1199         #
1200         $XferLOG->close();
1201         unlink("$Dir/timeStamp.level0")    if ( -f "$Dir/timeStamp.level0" );
1202         unlink("$Dir/SmbLOG.bad")          if ( -f "$Dir/SmbLOG.bad" );
1203         unlink("$Dir/SmbLOG.bad$fileExt")  if ( -f "$Dir/SmbLOG.bad$fileExt" );
1204         unlink("$Dir/XferLOG.bad")         if ( -f "$Dir/XferLOG.bad" );
1205         unlink("$Dir/XferLOG.bad$fileExt") if ( -f "$Dir/XferLOG.bad$fileExt" );
1206         unlink("$Dir/NewFileList")         if ( -f "$Dir/NewFileList" );
1207         rename("$Dir/XferLOG$fileExt", "$Dir/XferLOG.bad$fileExt");
1208         $bpc->RmTreeDefer("$TopDir/trash", "$Dir/new") if ( -d "$Dir/new" );
1209         print("dump failed: $stat{hostError}\n");
1210         $XferLOG->close();
1211         print("link $clientURI\n") if ( $needLink );
1212         exit(1);
1213     }
1214     #
1215     # Ok, now we should save this as a partial dump
1216     #
1217     $type = "partial";
1218     my $newNum = BackupSave();
1219     print("dump failed: $stat{hostError}\n");
1220     print("link $clientURI\n") if ( $needLink );
1221     print(LOG $bpc->timeStamp, "Saved partial dump $newNum\n");
1222     exit(2);
1223 }
1224
1225 #
1226 # Decide which old backups should be expired by moving them
1227 # to $TopDir/trash.
1228 #
1229 sub BackupExpire
1230 {
1231     my($client) = @_;
1232     my($Dir) = "$TopDir/pc/$client";
1233     my(@Backups) = $bpc->BackupInfoRead($client);
1234     my($cntFull, $cntIncr, $firstFull, $firstIncr, $oldestIncr,
1235        $oldestFull, $changes);
1236
1237     if ( $Conf{FullKeepCnt} <= 0 ) {
1238         print(LOG $bpc->timeStamp,
1239                   "Invalid value for \$Conf{FullKeepCnt}=$Conf{FullKeepCnt}\n");
1240         print(STDERR
1241             "Invalid value for \$Conf{FullKeepCnt}=$Conf{FullKeepCnt}\n")
1242                             if ( $opts{v} );
1243         return;
1244     }
1245     while ( 1 ) {
1246         $cntFull = $cntIncr = 0;
1247         $oldestIncr = $oldestFull = 0;
1248         for ( my $i = 0 ; $i < @Backups ; $i++ ) {
1249             if ( $Backups[$i]{type} eq "full" ) {
1250                 $firstFull = $i if ( $cntFull == 0 );
1251                 $cntFull++;
1252             } elsif ( $Backups[$i]{type} eq "incr" ) {
1253                 $firstIncr = $i if ( $cntIncr == 0 );
1254                 $cntIncr++;
1255             }
1256         }
1257         $oldestIncr = (time - $Backups[$firstIncr]{startTime}) / (24 * 3600)
1258                         if ( $cntIncr > 0 );
1259         $oldestFull = (time - $Backups[$firstFull]{startTime}) / (24 * 3600)
1260                         if ( $cntFull > 0 );
1261
1262         #
1263         # With multi-level incrementals, several of the following
1264         # incrementals might depend upon this one, so we have to
1265         # delete all of the them.  Figure out if that is possible
1266         # by counting the number of consecutive incrementals that
1267         # are unfilled and have a level higher than this one.
1268         #
1269         my $cntIncrDel = 1;
1270         my $earliestIncr = $oldestIncr;
1271
1272         for ( my $i = $firstIncr + 1 ; $i < @Backups ; $i++ ) {
1273             last if ( $Backups[$i]{level} <= $Backups[$firstIncr]{level}
1274                    || !$Backups[$i]{noFill} );
1275             $cntIncrDel++;
1276             $earliestIncr = (time - $Backups[$i]{startTime}) / (24 * 3600);
1277         }
1278
1279         if ( $cntIncr >= $Conf{IncrKeepCnt} + $cntIncrDel
1280                 || ($cntIncr >= $Conf{IncrKeepCntMin} + $cntIncrDel
1281                     && $earliestIncr > $Conf{IncrAgeMax}) ) {
1282             #
1283             # Only delete an incr backup if the Conf settings are satisfied
1284             # for all $cntIncrDel incrementals.  Since BackupRemove() does
1285             # a splice() we need to do the deletes in the reverse order.
1286             #
1287             for ( my $i = $firstIncr + $cntIncrDel - 1 ;
1288                     $i >= $firstIncr ; $i-- ) {
1289                 print(LOG $bpc->timeStamp,
1290                           "removing incr backup $Backups[$i]{num}\n");
1291                 BackupRemove($client, \@Backups, $i);
1292                 $changes++;
1293             }
1294             next;
1295         }
1296
1297         #
1298         # Delete any old full backups, according to $Conf{FullKeepCntMin}
1299         # and $Conf{FullAgeMax}.
1300         #
1301         # First make sure that $Conf{FullAgeMax} is at least bigger
1302         # than $Conf{FullPeriod} * $Conf{FullKeepCnt}, including
1303         # the exponential array case.
1304         #
1305         my $fullKeepCnt = $Conf{FullKeepCnt};
1306         $fullKeepCnt = [$fullKeepCnt] if ( ref($fullKeepCnt) ne "ARRAY" );
1307         my $fullAgeMax;
1308         my $fullPeriod = int(0.5 + $Conf{FullPeriod});
1309         $fullPeriod = 7 if ( $fullPeriod <= 0 );
1310         for ( my $i = 0 ; $i < @$fullKeepCnt ; $i++ ) {
1311             $fullAgeMax += $fullKeepCnt->[$i] * $fullPeriod;
1312             $fullPeriod *= 2;
1313         }
1314         $fullAgeMax += $fullPeriod;     # add some buffer
1315
1316         if ( $cntFull > $Conf{FullKeepCntMin}
1317                && $oldestFull > $Conf{FullAgeMax}
1318                && $oldestFull > $fullAgeMax
1319                && $Conf{FullKeepCntMin} > 0
1320                && $Conf{FullAgeMax} > 0
1321                && (@Backups <= $firstFull + 1
1322                         || !$Backups[$firstFull + 1]{noFill}) ) {
1323             #
1324             # Only delete a full backup if the Conf settings are satisfied.
1325             # We also must make sure that either this backup is the most
1326             # recent one, or the next backup is filled.
1327             # (We can't deleted a full backup if the next backup is not
1328             # filled.)
1329             #
1330             print(LOG $bpc->timeStamp,
1331                    "removing old full backup $Backups[$firstFull]{num}\n");
1332             BackupRemove($client, \@Backups, $firstFull);
1333             $changes++;
1334             next;
1335         }
1336
1337         #
1338         # Do new-style full backup expiry, which includes the the case
1339         # where $Conf{FullKeepCnt} is an array.
1340         #
1341         last if ( !BackupFullExpire($client, \@Backups) );
1342         $changes++;
1343     }
1344     $bpc->BackupInfoWrite($client, @Backups) if ( $changes );
1345 }
1346
1347 #
1348 # Handle full backup expiry, using exponential periods.
1349 #
1350 sub BackupFullExpire
1351 {
1352     my($client, $Backups) = @_;
1353     my $fullCnt = 0;
1354     my $fullPeriod = $Conf{FullPeriod};
1355     my $origFullPeriod = $fullPeriod;
1356     my $fullKeepCnt = $Conf{FullKeepCnt};
1357     my $fullKeepIdx = 0;
1358     my(@delete, @fullList);
1359
1360     #
1361     # Don't delete anything if $Conf{FullPeriod} or $Conf{FullKeepCnt} are
1362     # not defined - possibly a corrupted config.pl file.
1363     #
1364     return if ( !defined($Conf{FullPeriod}) || !defined($Conf{FullKeepCnt}) );
1365
1366     #
1367     # If regular backups are still disabled with $Conf{FullPeriod} < 0,
1368     # we still expire backups based on a typical FullPeriod value - weekly.
1369     #
1370     $fullPeriod = 7 if ( $fullPeriod <= 0 );
1371
1372     $fullKeepCnt = [$fullKeepCnt] if ( ref($fullKeepCnt) ne "ARRAY" );
1373
1374     for ( my $i = 0 ; $i < @$Backups ; $i++ ) {
1375         next if ( $Backups->[$i]{type} ne "full" );
1376         push(@fullList, $i);
1377     }
1378     for ( my $k = @fullList - 1 ; $k >= 0 ; $k-- ) {
1379         my $i = $fullList[$k];
1380         my $prevFull = $fullList[$k-1] if ( $k > 0 );
1381         #
1382         # Don't delete any full that is followed by an unfilled backup,
1383         # since it is needed for restore.
1384         #
1385         my $noDelete = $i + 1 < @$Backups ? $Backups->[$i+1]{noFill} : 0;
1386
1387         if ( !$noDelete &&
1388               ($fullKeepIdx >= @$fullKeepCnt
1389               || $k > 0
1390                  && $fullKeepIdx > 0
1391                  && $Backups->[$i]{startTime} - $Backups->[$prevFull]{startTime}
1392                              < ($fullPeriod - $origFullPeriod / 2) * 24 * 3600
1393                )
1394             ) {
1395             #
1396             # Delete the full backup
1397             #
1398             #print("Deleting backup $i ($prevFull)\n");
1399             unshift(@delete, $i);
1400         } else {
1401             $fullCnt++;
1402             while ( $fullKeepIdx < @$fullKeepCnt
1403                      && $fullCnt >= $fullKeepCnt->[$fullKeepIdx] ) {
1404                 $fullKeepIdx++;
1405                 $fullCnt = 0;
1406                 $fullPeriod = 2 * $fullPeriod;
1407             }
1408         }
1409     }
1410     #
1411     # Now actually delete the backups
1412     #
1413     for ( my $i = @delete - 1 ; $i >= 0 ; $i-- ) {
1414         print(LOG $bpc->timeStamp,
1415                "removing full backup $Backups->[$delete[$i]]{num}\n");
1416         BackupRemove($client, $Backups, $delete[$i]);
1417     }
1418     return @delete;
1419 }
1420
1421 #
1422 # Removes any partial backups
1423 #
1424 sub BackupPartialRemove
1425 {
1426     my($client, $Backups) = @_;
1427
1428     for ( my $i = @$Backups - 1 ; $i >= 0 ; $i-- ) {
1429         next if ( $Backups->[$i]{type} ne "partial" );
1430         BackupRemove($client, $Backups, $i);
1431     }
1432 }
1433
1434 sub BackupSave
1435 {
1436     my @Backups = $bpc->BackupInfoRead($client);
1437     my $num  = -1;
1438     my $newFilesFH;
1439
1440     #
1441     # Since we got a good backup we should remove any partial dumps
1442     # (the new backup might also be a partial, but that's ok).
1443     #
1444     BackupPartialRemove($client, \@Backups);
1445     $needLink = 1 if ( -f "$Dir/NewFileList" );
1446
1447     #
1448     # Number the new backup
1449     #
1450     for ( my $i = 0 ; $i < @Backups ; $i++ ) {
1451         $num = $Backups[$i]{num} if ( $num < $Backups[$i]{num} );
1452     }
1453     $num++;
1454     $bpc->RmTreeDefer("$TopDir/trash", "$Dir/$num") if ( -d "$Dir/$num" );
1455     if ( !rename("$Dir/new", "$Dir/$num") ) {
1456         print(LOG $bpc->timeStamp, "Rename $Dir/new -> $Dir/$num failed\n");
1457         $stat{xferOK} = 0;
1458         return;
1459     }
1460
1461     #
1462     # Add the new backup information to the backup file
1463     #
1464     my $i = @Backups;
1465     $Backups[$i]{num}           = $num;
1466     $Backups[$i]{type}          = $type;
1467     $Backups[$i]{startTime}     = $startTime;
1468     $Backups[$i]{endTime}       = $endTime;
1469     $Backups[$i]{size}          = $sizeTotal;
1470     $Backups[$i]{nFiles}        = $nFilesTotal;
1471     $Backups[$i]{xferErrs}      = $stat{xferErrCnt} || 0;
1472     $Backups[$i]{xferBadFile}   = $stat{xferBadFileCnt} || 0;
1473     $Backups[$i]{xferBadShare}  = $stat{xferBadShareCnt} || 0;
1474     $Backups[$i]{nFilesExist}   = $nFilesExist;
1475     $Backups[$i]{sizeExist}     = $sizeExist;
1476     $Backups[$i]{sizeExistComp} = $sizeExistComp;
1477     $Backups[$i]{tarErrs}       = $tarErrs;
1478     $Backups[$i]{compress}      = $Conf{CompressLevel};
1479     $Backups[$i]{noFill}        = $type eq "incr" ? 1 : 0;
1480     $Backups[$i]{level}         = $incrLevel;
1481     $Backups[$i]{mangle}        = 1;     # name mangling always on for v1.04+
1482     $Backups[$i]{xferMethod}    = $Conf{XferMethod};
1483     $Backups[$i]{charset}       = $Conf{ClientCharset};
1484     $Backups[$i]{version}       = $bpc->Version();
1485     #
1486     # Save the main backups file
1487     #
1488     $bpc->BackupInfoWrite($client, @Backups);
1489     #
1490     # Save just this backup's info in case the main backups file
1491     # gets corrupted
1492     #
1493     BackupPC::Storage->backupInfoWrite($Dir, $Backups[$i]{num},
1494                                              $Backups[$i]);
1495
1496     unlink("$Dir/timeStamp.level0") if ( -f "$Dir/timeStamp.level0" );
1497     foreach my $ext ( qw(bad bad.z) ) {
1498         next if ( !-f "$Dir/XferLOG.$ext" );
1499         unlink("$Dir/XferLOG.$ext.old") if ( -f "$Dir/XferLOG.$ext" );
1500         rename("$Dir/XferLOG.$ext", "$Dir/XferLOG.$ext.old");
1501     }
1502
1503     #
1504     # Now remove the bad files, replacing them if possible with links to
1505     # earlier backups.
1506     #
1507     foreach my $f ( $xfer->getBadFiles ) {
1508         my $j;
1509         my $shareM = $bpc->fileNameEltMangle($f->{share});
1510         my $fileM  = $bpc->fileNameMangle($f->{file});
1511         unlink("$Dir/$num/$shareM/$fileM");
1512         for ( $j = $i - 1 ; $j >= 0 ; $j-- ) {
1513             my $file;
1514             if ( $Backups[$j]{mangle} ) {
1515                 $file = "$shareM/$fileM";
1516             } else {
1517                 $file = "$f->{share}/$f->{file}";
1518             }
1519             next if ( !-f "$Dir/$Backups[$j]{num}/$file" );
1520
1521             my($exists, $digest, $origSize, $outSize, $errs)
1522                                 = BackupPC::PoolWrite::LinkOrCopy(
1523                                       $bpc,
1524                                       "$Dir/$Backups[$j]{num}/$file",
1525                                       $Backups[$j]{compress},
1526                                       "$Dir/$num/$shareM/$fileM",
1527                                       $Conf{CompressLevel});
1528             if ( !$exists ) {
1529                 #
1530                 # the hard link failed, most likely because the target
1531                 # file has too many links.  We have copied the file
1532                 # instead, so add this to the new file list.
1533                 #
1534                 if ( !defined($newFilesFH) ) {
1535                     my $str = "Appending to NewFileList for $shareM/$fileM\n";
1536                     $XferLOG->write(\$str);
1537                     open($newFilesFH, ">>", "$TopDir/pc/$client/NewFileList")
1538                          || die("can't open $TopDir/pc/$client/NewFileList");
1539                     binmode($newFilesFH);
1540                 }
1541                 if ( -f "$Dir/$num/$shareM/$fileM" ) {
1542                     print($newFilesFH "$digest $origSize $shareM/$fileM\n");
1543                 } else {
1544                     my $str = "Unable to link/copy $num/$f->{share}/$f->{file}"
1545                             . " to $Backups[$j]{num}/$f->{share}/$f->{file}\n";
1546                     $XferLOG->write(\$str);
1547                 }
1548             } else {
1549                 my $str = "Bad file $num/$f->{share}/$f->{file} replaced"
1550                         . " by link to"
1551                         . " $Backups[$j]{num}/$f->{share}/$f->{file}\n";
1552                 $XferLOG->write(\$str);
1553             }
1554             last;
1555         }
1556         if ( $j < 0 ) {
1557             my $str = "Removed bad file $num/$f->{share}/$f->{file}"
1558                     . " (no older copy to link to)\n";
1559             $XferLOG->write(\$str);
1560         }
1561     }
1562     close($newFilesFH) if ( defined($newFilesFH) );
1563     $XferLOG->close();
1564     rename("$Dir/XferLOG$fileExt", "$Dir/XferLOG.$num$fileExt");
1565     rename("$Dir/NewFileList", "$Dir/NewFileList.$num");
1566
1567     return $num;
1568 }
1569
1570 #
1571 # Removes a specific backup
1572 #
1573 sub BackupRemove
1574 {
1575     my($client, $Backups, $idx) = @_;
1576     my($Dir) = "$TopDir/pc/$client";
1577
1578     if ( $Backups->[$idx]{num} eq "" ) {
1579         print("BackupRemove: ignoring empty backup number for idx $idx\n");
1580         return;
1581     }
1582
1583     $bpc->RmTreeDefer("$TopDir/trash",
1584                       "$Dir/$Backups->[$idx]{num}");
1585     unlink("$Dir/SmbLOG.$Backups->[$idx]{num}")
1586                 if ( -f "$Dir/SmbLOG.$Backups->[$idx]{num}" );
1587     unlink("$Dir/SmbLOG.$Backups->[$idx]{num}.z")
1588                 if ( -f "$Dir/SmbLOG.$Backups->[$idx]{num}.z" );
1589     unlink("$Dir/XferLOG.$Backups->[$idx]{num}")
1590                 if ( -f "$Dir/XferLOG.$Backups->[$idx]{num}" );
1591     unlink("$Dir/XferLOG.$Backups->[$idx]{num}.z")
1592                 if ( -f "$Dir/XferLOG.$Backups->[$idx]{num}.z" );
1593     splice(@{$Backups}, $idx, 1);
1594 }
1595
1596 sub CorrectHostCheck
1597 {
1598     my($hostIP, $host) = @_;
1599     return if ( $hostIP eq $host && !$Conf{FixedIPNetBiosNameCheck}
1600                 || $Conf{NmbLookupCmd} eq "" );
1601     my($netBiosHost, $netBiosUser) = $bpc->NetBiosInfoGet($hostIP);
1602     return "host $host has mismatching netbios name $netBiosHost"
1603                 if ( lc($netBiosHost) ne lc(substr($host, 0, 15)) );
1604     return;
1605 }
1606
1607 #
1608 # The Xfer method might tell us from time to time about processes
1609 # it forks.  We tell BackupPC about this (for status displays) and
1610 # keep track of the pids in case we cancel the backup
1611 #
1612 sub pidHandler
1613 {
1614     @xferPid = @_;
1615     @xferPid = grep(/./, @xferPid);
1616     return if ( !@xferPid && $tarPid < 0 );
1617     my @pids = @xferPid;
1618     push(@pids, $tarPid) if ( $tarPid > 0 );
1619     my $str = join(",", @pids);
1620     $XferLOG->write(\"Xfer PIDs are now $str\n") if ( defined($XferLOG) );
1621     print("xferPids $str\n");
1622 }
1623
1624 #
1625 # The Xfer method might tell us from time to time about progress
1626 # in the backup or restore
1627 #
1628 sub completionPercent
1629 {
1630     my($percent) = @_;
1631
1632     $percent = 100 if ( $percent > 100 );
1633     $percent =   0 if ( $percent <   0 );
1634     if ( !defined($completionPercent)
1635         || int($completionPercent + 0.5) != int($percent) ) {
1636             printf("completionPercent %.0f\n", $percent);
1637     }
1638     $completionPercent = $percent;
1639 }
1640
1641 #
1642 # Run an optional pre- or post-dump command
1643 #
1644 sub UserCommandRun
1645 {
1646     my($cmdType, $sharename) = @_;
1647
1648     return if ( !defined($Conf{$cmdType}) );
1649     my $vars = {
1650         xfer       => $xfer,
1651         client     => $client,
1652         host       => $host,
1653         hostIP     => $hostIP,
1654         user       => $Hosts->{$client}{user},
1655         moreUsers  => $Hosts->{$client}{moreUsers},
1656         share      => $ShareNames->[0],
1657         shares     => $ShareNames,
1658         XferMethod => $Conf{XferMethod},
1659         sshPath    => $Conf{SshPath},
1660         LOG        => *LOG,
1661         XferLOG    => $XferLOG,
1662         stat       => \%stat,
1663         xferOK     => $stat{xferOK} || 0,
1664         hostError  => $stat{hostError},
1665         type       => $type,
1666         cmdType    => $cmdType,
1667     };
1668
1669     if ($cmdType eq 'DumpPreShareCmd' || $cmdType eq 'DumpPostShareCmd') {
1670         $vars->{share} = $sharename;
1671     }
1672
1673     my $cmd = $bpc->cmdVarSubstitute($Conf{$cmdType}, $vars);
1674     $XferLOG->write(\"Executing $cmdType: @$cmd\n");
1675     #
1676     # Run the user's command, dumping the stdout/stderr into the
1677     # Xfer log file.  Also supply the optional $vars and %Conf in
1678     # case the command is really perl code instead of a shell
1679     # command.
1680     #
1681     $bpc->cmdSystemOrEval($cmd,
1682             sub {
1683                 $XferLOG->write(\$_[0]);
1684                 print(LOG $bpc->timeStamp, "Output from $cmdType: ", $_[0]);
1685             },
1686             $vars, \%Conf);
1687 }