2 #============================================================= -*-perl-*-
4 # BackupPC_zipCreate: create a zip archive of an existing dump
5 # for restore on a client.
9 # Usage: BackupPC_zipCreate [-t] [-h host] [-n dumpNum] [-s shareName]
10 # [-r pathRemove] [-p pathAdd] [-c compressionLevel]
11 # files/directories...
16 # -h host host from which the zip archive is created
17 # -n dumpNum dump number from which the zip archive is created
18 # -s shareName share name from which the zip 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 # -c level compression level (default is 0, no compression)
26 # The -h, -n and -s options specify which dump is used to generate
27 # the zip archive. The -r and -p options can be used to relocate
28 # the paths in the zip archive so extracted files can be placed
29 # in a location different from their original location.
32 # Guillaume Filion <gfk@users.sourceforge.net>
33 # Based on Backup_tarCreate by Craig Barratt <cbarratt@users.sourceforge.net>
36 # Copyright (C) 2002-2003 Craig Barratt and Guillaume Filion
38 # This program is free software; you can redistribute it and/or modify
39 # it under the terms of the GNU General Public License as published by
40 # the Free Software Foundation; either version 2 of the License, or
41 # (at your option) any later version.
43 # This program is distributed in the hope that it will be useful,
44 # but WITHOUT ANY WARRANTY; without even the implied warranty of
45 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46 # GNU General Public License for more details.
48 # You should have received a copy of the GNU General Public License
49 # along with this program; if not, write to the Free Software
50 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
52 #========================================================================
54 # Version 2.1.0, released 20 Jun 2004.
56 # See http://backuppc.sourceforge.net.
58 #========================================================================
62 use lib "__INSTALLDIR__/lib";
63 use Archive::Zip qw(:ERROR_CODES);
68 use BackupPC::Attrib qw(:all);
69 use BackupPC::FileZIO;
70 use BackupPC::Zip::FileMember;
73 die("BackupPC::Lib->new failed\n") if ( !(my $bpc = BackupPC::Lib->new) );
74 my $TopDir = $bpc->TopDir();
75 my $BinDir = $bpc->BinDir();
76 my %Conf = $bpc->Conf();
80 if ( !getopts("th:n:p:r:s:c:", \%opts) || @ARGV < 1 ) {
81 print(STDERR "usage: $0 [-t] [-h host] [-n dumpNum] [-s shareName]"
82 . " [-r pathRemove] [-p pathAdd] [-c compressionLevel]"
83 . " files/directories...\n");
87 if ( $opts{h} !~ /^([\w\.\s-]+)$/ ) {
88 print(STDERR "$0: bad host name '$opts{h}'\n");
93 if ( $opts{n} !~ /^(\d+)$/ ) {
94 print(STDERR "$0: bad dump number '$opts{n}'\n");
98 $opts{c} = 0 if ( $opts{c} eq "" );
99 if ( $opts{c} !~ /^(\d+)$/ ) {
100 print(STDERR "$0: invalid compression level '$opts{c}'. 0=none, 9=max\n");
103 my $compLevel = $opts{c};
105 my @Backups = $bpc->BackupInfoRead($Host);
113 for ( $i = 0 ; $i < @Backups ; $i++ ) {
114 last if ( $Backups[$i]{num} == $Num );
116 if ( $i >= @Backups ) {
117 print(STDERR "$0: bad backup number $Num for host $Host\n");
121 my $PathRemove = $1 if ( $opts{r} =~ /(.+)/ );
122 my $PathAdd = $1 if ( $opts{p} =~ /(.+)/ );
123 if ( $opts{s} !~ /^([\w\s\.\/\$-]+)$/ ) {
124 print(STDERR "$0: bad share name '$opts{s}'\n");
127 my $ShareName = $opts{s};
129 my $BufSize = 1048576; # 1MB or 2^20
130 my(%UidCache, %GidCache);
132 my $fh = new IO::Handle;
133 $fh->fdopen(fileno(STDOUT),"w");
134 my $zipfh = Archive::Zip->new();
137 foreach my $dir ( @ARGV ) {
138 archiveWrite($zipfh, $dir);
143 my($zipfh, $dir, $zipPathOverride) = @_;
145 my $view = BackupPC::View->new($bpc, $Host, \@Backups);
147 if ( $dir =~ m{(^|/)\.\.(/|$)} || $dir !~ /^(.*)$/ ) {
148 print(STDERR "$0: bad directory '$dir'\n");
152 $view->find($Num, $ShareName, $dir, 0, \&ZipWriteFile,
153 $zipfh, $zipPathOverride);
157 print STDERR "Can't write Zip file\n"
158 unless $zipfh->writeToFileHandle($fh, 0) == Archive::Zip::AZ_OK;
161 # print out totals if requested
164 print STDERR "Done: $FileCnt files, $ByteCnt bytes, $DirCnt dirs,",
165 " $SpecialCnt specials ignored, $ErrorCnt errors\n";
169 ###########################################################################
171 ###########################################################################
177 $UidCache{$uid} = (getpwuid($uid))[0] if ( !exists($UidCache{$uid}) );
178 return $UidCache{$uid};
185 $GidCache{$gid} = (getgrgid($gid))[0] if ( !exists($GidCache{$gid}) );
186 return $GidCache{$gid};
194 my($hdr, $zipfh, $zipPathOverride) = @_;
196 my $tarPath = $hdr->{relPath};
197 $tarPath = $zipPathOverride if ( defined($zipPathOverride) );
199 if ( defined($PathRemove)
200 && substr($tarPath, 0, length($PathRemove)) eq $PathRemove ) {
201 substr($tarPath, 0, length($PathRemove)) = $PathAdd;
203 $tarPath = "./" . $tarPath if ( $tarPath !~ /^\.\// );
204 $tarPath =~ s{//+}{/}g;
205 $hdr->{name} = $tarPath;
207 my $zipmember; # Container to hold the file/directory to zip.
209 if ( $hdr->{type} == BPC_FTYPE_DIR ) {
211 # Directory: just write the header
213 $hdr->{name} .= "/" if ( $hdr->{name} !~ m{/$} );
214 $zipmember = Archive::Zip::Member->newDirectoryNamed($hdr->{name});
216 } elsif ( $hdr->{type} == BPC_FTYPE_FILE ) {
218 # Regular file: write the header and file
220 $zipmember = BackupPC::Zip::FileMember->newFromFileNamed(
227 $ByteCnt += $hdr->{size};
228 } elsif ( $hdr->{type} == BPC_FTYPE_HARDLINK ) {
230 # Hardlink file: not supported by Zip, so just make a copy
231 # of the pointed-to file.
233 # Start by reading the contents of the link.
235 my $f = BackupPC::FileZIO->open($hdr->{fullPath}, 0, $hdr->{compress});
236 if ( !defined($f) ) {
237 print(STDERR "Unable to open file $hdr->{fullPath}\n");
242 while ( $f->read(\$data, $BufSize) > 0 ) {
243 $hdr->{linkname} .= $data;
247 # Dump the original file. Just call the top-level
248 # routine, so that we save the hassle of dealing with
249 # mangling, merging and attributes.
251 archiveWrite($zipfh, $hdr->{linkname}, $hdr->{name});
252 } elsif ( $hdr->{type} == BPC_FTYPE_SYMLINK ) {
254 # Symlinks can't be Zipped. 8(
255 # We could zip the pointed-to dir/file (just like hardlink), but we
256 # have to avoid the infinite-loop case of a symlink pointed to a
257 # directory above us. Ignore for now. Could be a comand-line
261 } elsif ( $hdr->{type} == BPC_FTYPE_CHARDEV
262 || $hdr->{type} == BPC_FTYPE_BLOCKDEV
263 || $hdr->{type} == BPC_FTYPE_FIFO ) {
265 # Special files can't be Zipped. 8(
269 print(STDERR "Got unknown type $hdr->{type} for $hdr->{name}\n");
272 return if ( !$zipmember );
275 # Set the attributes and permissions. The standard zip file
276 # header cannot handle dates prior to 1/1/1980, or 315561600
277 # unix seconds, so we round up the mtime.
279 my $mtime = $hdr->{mtime};
280 $mtime = 315561600 if ( $mtime < 315561600 );
281 $zipmember->setLastModFileDateTimeFromUnix($mtime);
282 $zipmember->unixFileAttributes($hdr->{mode});
283 # Zip files don't accept uid and gid, so we put them in the comment field.
284 $zipmember->fileComment("uid=".$hdr->{uid}." gid=".$hdr->{gid})
285 if ( $hdr->{uid} || $hdr->{gid} );
287 # Specify the compression level for this member
288 $zipmember->desiredCompressionLevel($compLevel) if ($compLevel =~ /[0-9]/);
290 # Finally Zip the member
291 $zipfh->addMember($zipmember);