2 #============================================================= -*-perl-*-
4 # BackupPC_tarIncCreate: create a tar archive of an existing incremental dump
9 # Usage: BackupPC_tarIncCreate [options]
14 # -h host Host from which the tar archive is created.
15 # -n dumpNum Dump number from which the tar archive is created.
16 # A negative number means relative to the end (eg -1
17 # means the most recent dump, -2 2nd most recent etc).
18 # -s shareName Share name from which the tar archive is created.
21 # -t print summary totals
22 # -r pathRemove path prefix that will be replaced with pathAdd
23 # -p pathAdd new path prefix
24 # -b BLOCKS BLOCKS x 512 bytes per record (default 20; same as tar)
25 # -w writeBufSz write buffer size (default 1MB)
27 # The -h, -n and -s options specify which dump is used to generate
28 # the tar archive. The -r and -p options can be used to relocate
29 # the paths in the tar archive so extracted files can be placed
30 # in a location different from their original location.
33 # Craig Barratt <cbarratt@users.sourceforge.net>
34 # Ivan Klaric <iklaric@gmail.com>
35 # Dobrica Pavlinusic <dpavlin@rot13.org>
38 # Copyright (C) 2001-2003 Craig Barratt
40 # This program is free software; you can redistribute it and/or modify
41 # it under the terms of the GNU General Public License as published by
42 # the Free Software Foundation; either version 2 of the License, or
43 # (at your option) any later version.
45 # This program is distributed in the hope that it will be useful,
46 # but WITHOUT ANY WARRANTY; without even the implied warranty of
47 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
48 # GNU General Public License for more details.
50 # You should have received a copy of the GNU General Public License
51 # along with this program; if not, write to the Free Software
52 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
54 #========================================================================
56 # Version 2.1.0, released 20 Jun 2004.
58 # See http://backuppc.sourceforge.net.
60 #========================================================================
64 use lib "__INSTALLDIR__/lib";
69 use BackupPC::Attrib qw(:all);
70 use BackupPC::FileZIO;
72 use BackupPC::SearchLib;
73 use Time::HiRes qw/time/;
74 use POSIX qw/strftime/;
78 use Data::Dumper; ### FIXME
80 die("BackupPC::Lib->new failed\n") if ( !(my $bpc = BackupPC::Lib->new) );
81 my $TopDir = $bpc->TopDir();
82 my $BinDir = $bpc->BinDir();
83 my %Conf = $bpc->Conf();
84 %BackupPC::SearchLib::Conf = %Conf;
86 my $in_backup_increment;
89 if ( !getopts("th:n:p:r:s:b:w:vdf", \%opts) ) {
93 -h host host from which the tar archive is created
94 -n dumpNum dump number from which the tar archive is created
95 A negative number means relative to the end (eg -1
96 means the most recent dump, -2 2nd most recent etc).
97 -s shareName share name from which the tar archive is created
100 -t print summary totals
101 -r pathRemove path prefix that will be replaced with pathAdd
102 -p pathAdd new path prefix
103 -b BLOCKS BLOCKS x 512 bytes per record (default 20; same as tar)
104 -w writeBufSz write buffer size (default 1048576 = 1MB)
105 -f overwrite existing parts
112 if ( $opts{h} !~ /^([\w\.\s-]+)$/ ) {
113 die "$0: bad host name '$opts{h}'\n";
117 if ( $opts{n} !~ /^(-?\d+)$/ ) {
118 die "$0: bad dump number '$opts{n}'\n";
123 foreach my $c (qw/gzip md5sum tee/) {
124 $bin->{$c} = which($c) || die "$0 needs $c, install it\n";
127 my @Backups = $bpc->BackupInfoRead($Host);
133 my $current_tar_size = 0;
134 my $total_increment_size = 0;
137 $Num = $Backups[@Backups + $Num]{num} if ( -@Backups <= $Num && $Num < 0 );
138 for ( $i = 0 ; $i < @Backups ; $i++ ) {
139 last if ( $Backups[$i]{num} == $Num );
141 if ( $i >= @Backups ) {
142 die "$0: bad backup number $Num for host $Host\n";
145 my $PathRemove = $1 if ( $opts{r} =~ /(.+)/ );
146 my $PathAdd = $1 if ( $opts{p} =~ /(.+)/ );
147 if ( $opts{s} !~ /^([\w\s\.\/\$-]+)$/ && $opts{s} ne "*" ) {
148 die "$0: bad share name '$opts{s}'\n";
150 our $ShareName = $opts{s};
151 our $view = BackupPC::View->new($bpc, $Host, \@Backups);
155 my $dsn = $Conf{SearchDSN};
156 my $db_user = $Conf{SearchUser} || '';
158 my $dbh = DBI->connect($dsn, $db_user, "", { RaiseError => 1, AutoCommit => 0} );
160 my $sth_inc_size = $dbh->prepare(qq{
167 my $sth_backup_parts = $dbh->prepare(qq{
168 insert into backup_parts (
175 ) values (?,?,?,?,?,?)
179 # This constant and the line of code below that uses it are borrowed
180 # from Archive::Tar. Thanks to Calle Dybedahl and Stephen Zander.
183 # Archive::Tar is Copyright 1997 Calle Dybedahl. All rights reserved.
184 # Copyright 1998 Stephen Zander. All rights reserved.
187 = 'a100 a8 a8 a8 a12 a12 A8 a1 a100 a6 a2 a32 a32 a8 a8 a155 x12';
188 my $tar_header_length = 512;
190 my $BufSize = $opts{w} || 1048576; # 1MB or 2^20
192 my $WriteBufSz = ($opts{b} || 20) * $tar_header_length;
194 my(%UidCache, %GidCache);
195 my(%HardLinkExtraFiles, @HardLinks);
198 # Write out all the requested files/directories
201 my $max_file_size = $Conf{'MaxArchiveFileSize'} || die "problem with MaxArchiveFileSize parametar";
202 $max_file_size *= 1024;
204 my $tar_dir = $Conf{InstallDir}.'/'.$Conf{GzipTempDir};
205 die "problem with $tar_dir, check GzipTempDir in configuration\n" unless (-d $tar_dir && -w $tar_dir);
207 my $tar_file = BackupPC::SearchLib::getGzipName($Host, $ShareName, $Num) || die "can't getGzipName($Host, $ShareName, $Num)";
209 my $tar_path_final = $tar_dir . '/' . $tar_file;
210 my $tar_path = $tar_path_final . '.tmp';
212 $tar_path =~ s#//#/#g;
214 my $sth = $dbh->prepare(qq{
218 JOIN shares on shares.id = shareid
219 JOIN hosts on hosts.id = shares.hostid
220 WHERE hosts.name = ? and shares.name = ? and backups.num = ?
222 $sth->execute($Host, $ShareName, $Num);
223 my ($backup_id) = $sth->fetchrow_array;
226 print STDERR "backup_id: $backup_id working dir: $tar_dir, max uncompressed size $max_file_size bytes, tar $tar_file\n" if ($opts{d});
228 if (-e $tar_path_final) {
230 rmtree $tar_path_final || die "can't remove $tar_path_final: $!";
232 die "$tar_path_final allready exists\n";
239 my $items_in_part = 0;
245 return if ($current_tar_size == 0);
247 print STDERR " $part" if ($opts{v});
250 # Finish with two null 512 byte headers,
251 # and then round out a full block.
253 my $data = "\0" x ($tar_header_length * 2);
254 TarWrite($fh, \$data);
255 TarWrite($fh, undef);
257 close($fh) || die "can't close archive part $part: $!";
259 my $file = $tar_path . '/' . $part;
261 my $md5 = read_file( $file . '.md5' ) || die "can't read md5sum file ${file}.md5";
264 my $size = (stat( $file . '.tar.gz' ))[7] || die "can't stat ${file}.tar.gz";
266 $sth_backup_parts->execute(
275 $total_increment_size += int( ( $size + 1023 ) / 1024 ) * 1024;
281 print STDERR "# rename $from -> $to\n" if ($opts{d});
282 rename $from, $to || die "can't move $from -> $to: $!\n";
286 print STDERR " single";
287 move("${tar_path}/1.tar.gz", "${tar_path_final}.tar.gz");
288 move("${tar_path}/1.md5", "${tar_path_final}.md5");
289 rmtree $tar_path or die "can't remove temporary dir $tar_path: $!";
291 print STDERR " [last]";
292 move("${tar_path}", "${tar_path_final}");
295 $sth_inc_size->execute(
296 $total_increment_size,
301 print STDERR ", $total_increment_size bytes\n" if ($opts{v});
310 # if this is first part, create directory
314 print STDERR "# deleting existing $tar_path\n" if ($opts{d});
317 mkdir($tar_path) || die "can't create directory $tar_path: $!";
320 print STDERR "ABORTED: cleanup temp dir";
326 $SIG{'INT'} = \&abort_cleanup;
327 $SIG{'QUIT'} = \&abort_cleanup;
328 $SIG{'__DIE__'} = \&abort_cleanup;
332 my $file = $tar_path . '/' . $part;
335 # create comprex pipe which will pass output through gzip
336 # for compression, create file on disk using tee
337 # and pipe same output to md5sum to create checksum
340 my $cmd = '| ' . $bin->{'gzip'} . ' ' . $Conf{GzipLevel} . ' ' .
341 '| ' . $bin->{'tee'} . ' ' . $file . '.tar.gz' . ' ' .
342 '| ' . $bin->{'md5sum'} . ' - > ' . $file . '.md5';
344 print STDERR "## $cmd\n" if ($opts{d});
346 open($fh, $cmd) or die "can't open $cmd: $!";
349 $current_tar_size = 0;
355 if (seedCache($Host, $ShareName, $Num)) {
356 archiveWrite($fh, '/');
357 archiveWriteHardLinks($fh);
358 new_tar_part( close => 1 );
360 print STDERR "NOTE: no files found for $Host:$ShareName, increment $Num\n" if ($opts{v});
361 # remove temporary files if there are no files
366 # print out totals if requested
369 print STDERR "Done: $FileCnt files, $ByteCnt bytes, $DirCnt dirs,",
370 " $SpecialCnt specials, $ErrorCnt errors\n";
372 if ( $ErrorCnt && !$FileCnt && !$DirCnt ) {
374 # Got errors, with no files or directories; exit with non-zero
377 die "got errors or no files\n";
380 $sth_inc_size->finish;
381 $sth_backup_parts->finish;
383 $dbh->commit || die "can't commit changes to database";
388 ###########################################################################
390 ###########################################################################
394 my($fh, $dir, $tarPathOverride) = @_;
396 if ( $dir =~ m{(^|/)\.\.(/|$)} ) {
397 print(STDERR "$0: bad directory '$dir'\n");
401 $dir = "/" if ( $dir eq "." );
402 #print(STDERR "calling find with $Num, $ShareName, $dir\n");
404 if ( $view->find($Num, $ShareName, $dir, 0, \&TarWriteFile,
405 $fh, $tarPathOverride) < 0 ) {
406 print(STDERR "$0: bad share or directory '$ShareName/$dir'\n");
413 # Write out any hardlinks (if any)
415 sub archiveWriteHardLinks
418 foreach my $hdr ( @HardLinks ) {
420 if ( defined($PathRemove)
421 && substr($hdr->{linkname}, 0, length($PathRemove)+1)
422 eq ".$PathRemove" ) {
423 substr($hdr->{linkname}, 0, length($PathRemove)+1) = ".$PathAdd";
425 TarWriteFileInfo($fh, $hdr);
428 %HardLinkExtraFiles = ();
435 $UidCache{$uid} = (getpwuid($uid))[0] if ( !exists($UidCache{$uid}) );
436 return $UidCache{$uid};
443 $GidCache{$gid} = (getgrgid($gid))[0] if ( !exists($GidCache{$gid}) );
444 return $GidCache{$gid};
449 my($fh, $dataRef) = @_;
452 if ( !defined($dataRef) ) {
454 # do flush by padding to a full $WriteBufSz
456 my $data = "\0" x ($WriteBufSz - length($WriteBuf));
460 # poor man's tell :-)
461 $current_tar_size += length($$dataRef);
463 if ( length($WriteBuf) + length($$dataRef) < $WriteBufSz ) {
465 # just buffer and return
467 $WriteBuf .= $$dataRef;
470 my $done = $WriteBufSz - length($WriteBuf);
471 if ( syswrite($fh, $WriteBuf . substr($$dataRef, 0, $done))
473 die "Unable to write to output file ($!)\n";
475 while ( $done + $WriteBufSz <= length($$dataRef) ) {
476 if ( syswrite($fh, substr($$dataRef, $done, $WriteBufSz))
478 die "Unable to write to output file ($!)\n";
480 $done += $WriteBufSz;
482 $WriteBuf = substr($$dataRef, $done);
489 if ( $size % $tar_header_length ) {
490 my $data = "\0" x ($tar_header_length - ($size % $tar_header_length));
491 TarWrite($fh, \$data);
499 $hdr->{uname} = UidLookup($hdr->{uid}) if ( !defined($hdr->{uname}) );
500 $hdr->{gname} = GidLookup($hdr->{gid}) if ( !defined($hdr->{gname}) );
501 my $devmajor = defined($hdr->{devmajor}) ? sprintf("%07o", $hdr->{devmajor})
503 my $devminor = defined($hdr->{devminor}) ? sprintf("%07o", $hdr->{devminor})
506 if ( $hdr->{size} >= 2 * 65536 * 65536 ) {
508 # GNU extension for files >= 8GB: send size in big-endian binary
510 $sizeStr = pack("c4 N N", 0x80, 0, 0, 0,
511 $hdr->{size} / (65536 * 65536),
512 $hdr->{size} % (65536 * 65536));
513 } elsif ( $hdr->{size} >= 1 * 65536 * 65536 ) {
515 # sprintf octal only handles up to 2^32 - 1
517 $sizeStr = sprintf("%03o", $hdr->{size} / (1 << 24))
518 . sprintf("%08o", $hdr->{size} % (1 << 24));
520 $sizeStr = sprintf("%011o", $hdr->{size});
522 my $data = pack($tar_pack_header,
523 substr($hdr->{name}, 0, 99),
524 sprintf("%07o", $hdr->{mode}),
525 sprintf("%07o", $hdr->{uid}),
526 sprintf("%07o", $hdr->{gid}),
528 sprintf("%011o", $hdr->{mtime}),
529 "", #checksum field - space padded by pack("A8")
531 substr($hdr->{linkname}, 0, 99),
532 $hdr->{magic} || 'ustar ',
533 $hdr->{version} || ' ',
540 substr($data, 148, 7) = sprintf("%06o\0", unpack("%16C*",$data));
541 TarWrite($fh, \$data);
549 # Handle long link names (symbolic links)
551 if ( length($hdr->{linkname}) > 99 ) {
553 my $data = $hdr->{linkname} . "\0";
554 $h{name} = "././\@LongLink";
556 $h{size} = length($data);
557 TarWriteHeader($fh, \%h);
558 TarWrite($fh, \$data);
559 TarWritePad($fh, length($data));
562 # Handle long file names
564 if ( length($hdr->{name}) > 99 ) {
566 my $data = $hdr->{name} . "\0";
567 $h{name} = "././\@LongLink";
569 $h{size} = length($data);
570 TarWriteHeader($fh, \%h);
571 TarWrite($fh, \$data);
572 TarWritePad($fh, length($data));
574 TarWriteHeader($fh, $hdr);
578 # seed cache of files in this increment
581 my ($host, $share, $dumpNo) = @_;
583 print STDERR curr_time(), "$host:$share #$dumpNo" if ($opts{v});
587 JOIN shares on shares.id = shareid
588 JOIN hosts on hosts.id = shares.hostid
589 WHERE hosts.name = ? and shares.name = ? and backupnum = ?
592 my $sth = $dbh->prepare($sql);
593 $sth->execute($host, $share, $dumpNo);
594 my $count = $sth->rows;
595 print STDERR " $count items, parts:" if ($opts{v});
596 while (my $row = $sth->fetchrow_arrayref) {
597 #print STDERR "+ ", $row->[0],"\n";
598 $in_backup_increment->{ $row->[0] } = $row->[1];
607 # calculate overhad for one file in tar
609 sub tar_overhead($) {
610 my $name = shift || '';
612 # header, padding of file and two null blocks at end
613 my $len = 4 * $tar_header_length;
615 # if filename is longer than 99 chars subtract blocks for
617 if ( length($name) > 99 ) {
618 $len += int( ( length($name) + $tar_header_length ) / $tar_header_length ) * $tar_header_length;
629 my($hdr, $fh, $tarPathOverride) = @_;
631 my $tarPath = $hdr->{relPath};
632 $tarPath = $tarPathOverride if ( defined($tarPathOverride) );
634 $tarPath =~ s{//+}{/}g;
636 #print STDERR "? $tarPath\n" if ($opts{d});
637 my $size = $in_backup_increment->{$tarPath};
638 return unless (defined($size));
640 # is this file too large to fit into MaxArchiveFileSize?
642 if ( ($current_tar_size + tar_overhead($tarPath) + $size) > $max_file_size ) {
643 print STDERR "# tar file $current_tar_size + $tar_header_length + $size > $max_file_size, splitting\n" if ($opts{d});
647 #print STDERR "A $tarPath [$size] tell: $current_tar_size\n" if ($opts{d});
650 if ( defined($PathRemove)
651 && substr($tarPath, 0, length($PathRemove)) eq $PathRemove ) {
652 substr($tarPath, 0, length($PathRemove)) = $PathAdd;
654 $tarPath = "./" . $tarPath if ( $tarPath !~ /^\.\// );
655 $tarPath =~ s{//+}{/}g;
656 $hdr->{name} = $tarPath;
658 if ( $hdr->{type} == BPC_FTYPE_DIR ) {
660 # Directory: just write the header
662 $hdr->{name} .= "/" if ( $hdr->{name} !~ m{/$} );
663 TarWriteFileInfo($fh, $hdr);
665 } elsif ( $hdr->{type} == BPC_FTYPE_FILE ) {
667 # Regular file: write the header and file
669 my $f = BackupPC::FileZIO->open($hdr->{fullPath}, 0, $hdr->{compress});
670 if ( !defined($f) ) {
671 print(STDERR "Unable to open file $hdr->{fullPath}\n");
675 # do we need to split file?
676 if ($hdr->{size} < $max_file_size) {
677 TarWriteFileInfo($fh, $hdr);
679 while ( $f->read(\$data, $BufSize) > 0 ) {
680 TarWrite($fh, \$data);
681 $size += length($data);
684 TarWritePad($fh, $size);
688 my $full_size = $hdr->{size};
689 my $orig_name = $hdr->{name};
690 my $max_part_size = $max_file_size - tar_overhead($hdr->{name});
692 my $parts = int(($full_size + $max_part_size - 1) / $max_part_size);
693 print STDERR "# splitting $orig_name [$full_size bytes] into $parts parts\n" if ($opts{d});
694 foreach my $subpart ( 1 .. $parts ) {
696 if ($subpart < $parts) {
697 $hdr->{size} = $max_part_size;
699 $hdr->{size} = $full_size % $max_part_size;
701 $hdr->{name} = $orig_name . '/' . $subpart;
702 print STDERR "## creating part $subpart ",$hdr->{name}, " [", $hdr->{size}," bytes]\n";
704 TarWriteFileInfo($fh, $hdr);
707 for ( 1 .. int($hdr->{size} / $BufSize) ) {
708 my $r_size = $f->read(\$data, $BufSize);
709 die "expected $BufSize bytes read, got $r_size bytes!" if ($r_size != $BufSize);
710 TarWrite($fh, \$data);
711 $size += length($data);
714 my $size_left = $hdr->{size} % $BufSize;
715 my $r_size = $f->read(\$data, $size_left);
716 die "expected $size_left bytes last read, got $r_size bytes!" if ($r_size != $size_left);
718 TarWrite($fh, \$data);
719 $size += length($data);
720 TarWritePad($fh, $size);
726 $ByteCnt += $full_size;
729 } elsif ( $hdr->{type} == BPC_FTYPE_HARDLINK ) {
731 # Hardlink file: either write a hardlink or the complete file
732 # depending upon whether the linked-to file will be written
735 # Start by reading the contents of the link.
737 my $f = BackupPC::FileZIO->open($hdr->{fullPath}, 0, $hdr->{compress});
738 if ( !defined($f) ) {
739 print(STDERR "Unable to open file $hdr->{fullPath}\n");
744 while ( $f->read(\$data, $BufSize) > 0 ) {
745 $hdr->{linkname} .= $data;
749 my $name = $hdr->{linkname};
751 if ( $HardLinkExtraFiles{$name} ) {
753 # Target file will be or was written, so just remember
754 # the hardlink so we can dump it later.
756 push(@HardLinks, $hdr);
760 # Have to dump the original file. Just call the top-level
761 # routine, so that we save the hassle of dealing with
762 # mangling, merging and attributes.
764 $HardLinkExtraFiles{$hdr->{linkname}} = 1;
765 archiveWrite($fh, $hdr->{linkname}, $hdr->{name});
767 } elsif ( $hdr->{type} == BPC_FTYPE_SYMLINK ) {
769 # Symbolic link: read the symbolic link contents into the header
770 # and write the header.
772 my $f = BackupPC::FileZIO->open($hdr->{fullPath}, 0, $hdr->{compress});
773 if ( !defined($f) ) {
774 print(STDERR "Unable to open symlink file $hdr->{fullPath}\n");
779 while ( $f->read(\$data, $BufSize) > 0 ) {
780 $hdr->{linkname} .= $data;
784 TarWriteFileInfo($fh, $hdr);
786 } elsif ( $hdr->{type} == BPC_FTYPE_CHARDEV
787 || $hdr->{type} == BPC_FTYPE_BLOCKDEV
788 || $hdr->{type} == BPC_FTYPE_FIFO ) {
790 # Special files: for char and block special we read the
791 # major and minor numbers from a plain file.
793 if ( $hdr->{type} != BPC_FTYPE_FIFO ) {
794 my $f = BackupPC::FileZIO->open($hdr->{fullPath}, 0,
797 if ( !defined($f) || $f->read(\$data, $BufSize) < 0 ) {
798 print(STDERR "Unable to open/read char/block special file"
799 . " $hdr->{fullPath}\n");
800 $f->close if ( defined($f) );
805 if ( $data =~ /(\d+),(\d+)/ ) {
806 $hdr->{devmajor} = $1;
807 $hdr->{devminor} = $2;
811 TarWriteFileInfo($fh, $hdr);
814 print(STDERR "Got unknown type $hdr->{type} for $hdr->{name}\n");
819 my $t_fmt = '%Y-%m-%d %H:%M:%S';
821 return strftime($t_fmt,localtime());