1 #============================================================= -*-perl-*-
3 # BackupPC::View package
7 # This library defines a BackupPC::View class for merging of
8 # incremental backups and file attributes. This provides the
9 # caller with a single view of a merged backup, without worrying
10 # about which backup contributes which files.
13 # Craig Barratt <cbarratt@users.sourceforge.net>
16 # Copyright (C) 2002-2003 Craig Barratt
18 # This program is free software; you can redistribute it and/or modify
19 # it under the terms of the GNU General Public License as published by
20 # the Free Software Foundation; either version 2 of the License, or
21 # (at your option) any later version.
23 # This program is distributed in the hope that it will be useful,
24 # but WITHOUT ANY WARRANTY; without even the implied warranty of
25 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 # GNU General Public License for more details.
28 # You should have received a copy of the GNU General Public License
29 # along with this program; if not, write to the Free Software
30 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #========================================================================
34 # Version 3.0.0alpha, released 23 Jan 2006.
36 # See http://backuppc.sourceforge.net.
38 #========================================================================
40 package BackupPC::View;
46 use BackupPC::Attrib qw(:all);
47 use BackupPC::FileZIO;
52 my($class, $bpc, $host, $backups) = @_;
54 bpc => $bpc, # BackupPC::Lib object
55 host => $host, # host name
56 backups => $backups, # all backups for this host
57 num => -1, # backup number
58 idx => -1, # index into backups for backup
60 dirPath => undef, # path to current directory
61 dirAttr => undef, # attributes of current directory
63 for ( my $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
64 next if ( defined($m->{backups}[$i]{level}) );
65 $m->{backups}[$i]{level} = $m->{backups}[$i]{type} eq "incr" ? 1 : 0;
67 $m->{topDir} = $m->{bpc}->TopDir();
73 my($m, $backupNum, $share, $dir) = @_;
76 #print STDERR "dirCache($backupNum, $share, $dir)\n";
77 $dir = "/$dir" if ( $dir !~ m{^/} );
79 return if ( $m->{num} == $backupNum
80 && $m->{share} eq $share
82 && $m->{dir} eq $dir );
83 $m->backupNumCache($backupNum) if ( $m->{num} != $backupNum );
84 return if ( $m->{idx} < 0 );
87 $level = $m->{backups}[$m->{idx}]{level} + 1;
90 # Remember the requested share and dir
96 # merge backups, starting at the requested one, and working
97 # backwards until we get to level 0.
100 for ( $i = $m->{idx} ; $level > 0 && $i >= 0 ; $i-- ) {
101 #print(STDERR "Do $i ($m->{backups}[$i]{noFill},$m->{backups}[$i]{level})\n");
103 # skip backups with the same or higher level
105 next if ( $m->{backups}[$i]{level} >= $level );
107 $level = $m->{backups}[$i]{level};
108 $backupNum = $m->{backups}[$i]{num};
109 push(@{$m->{mergeNums}}, $backupNum);
110 my $mangle = $m->{backups}[$i]{mangle};
111 my $compress = $m->{backups}[$i]{compress};
112 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
115 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
116 . $m->{bpc}->fileNameMangle($dir);
118 $sharePathM = $share . $dir;
120 $path .= $sharePathM;
121 #print(STDERR "Opening $path (share=$share)\n");
122 if ( !opendir(DIR, $path) ) {
123 if ( $i == $m->{idx} ) {
125 # Oops, directory doesn't exist.
132 my @dir = readdir(DIR);
136 $attr = BackupPC::Attrib->new({ compress => $compress });
137 if ( -f $attr->fileName($path) && !$attr->read($path) ) {
138 $m->{error} = "Can't read attribute file in $path";
142 foreach my $file ( @dir ) {
143 $file = $1 if ( $file =~ /(.*)/ );
145 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
146 #print(STDERR "Doing $fileUM\n");
150 next if ( defined($m->{files}{$fileUM})
153 || $file eq "backupInfo"
154 || $mangle && $file eq "attrib" );
156 # skip directories in earlier backups (each backup always
157 # has the complete directory tree).
159 my @s = stat("$path/$file");
160 next if ( $i < $m->{idx} && -d _ );
161 if ( defined($attr) && defined(my $a = $attr->get($fileUM)) ) {
162 $m->{files}{$fileUM} = $a;
163 $attr->set($fileUM, undef);
166 # Very expensive in the non-attribute case when compresseion
167 # is on. We have to stat the file and read compressed files
168 # to determine their size.
170 $m->{files}{$fileUM} = {
171 type => -d _ ? BPC_FTYPE_DIR : BPC_FTYPE_FILE,
175 size => -f _ ? $s[7] : 0,
178 if ( $compress && -f _ ) {
180 # Compute the correct size by reading the whole file
182 my $f = BackupPC::FileZIO->open("$path/$file",
184 if ( !defined($f) ) {
185 $m->{error} = "Can't open $path/$file";
188 while ( $f->read(\$data, 65636 * 8) > 0 ) {
189 $size += length($data);
192 $m->{files}{$fileUM}{size} = $size;
196 ($m->{files}{$fileUM}{relPath} = "$dir/$fileUM") =~ s{//+}{/}g;
197 ($m->{files}{$fileUM}{sharePathM} = "$sharePathM/$file")
199 ($m->{files}{$fileUM}{fullPath} = "$path/$file") =~ s{//+}{/}g;
200 $m->{files}{$fileUM}{backupNum} = $backupNum;
201 $m->{files}{$fileUM}{compress} = $compress;
202 $m->{files}{$fileUM}{nlink} = $s[3];
203 $m->{files}{$fileUM}{inode} = $s[1];
206 # Also include deleted files
208 if ( defined($attr) ) {
210 foreach my $fileUM ( keys(%$a) ) {
211 next if ( $a->{$fileUM}{type} != BPC_FTYPE_DELETED );
213 $file = $m->{bpc}->fileNameMangle($fileUM) if ( $mangle );
214 $m->{files}{$fileUM} = $a->{$fileUM};
215 $m->{files}{$fileUM}{relPath} = "$dir/$fileUM";
216 $m->{files}{$fileUM}{sharePathM} = "$sharePathM/$file";
217 $m->{files}{$fileUM}{fullPath} = "$path/$file";
218 $m->{files}{$fileUM}{backupNum} = $backupNum;
219 $m->{files}{$fileUM}{compress} = $compress;
220 $m->{files}{$fileUM}{nlink} = 0;
221 $m->{files}{$fileUM}{inode} = 0;
226 # Prune deleted files
228 foreach my $file ( keys(%{$m->{files}}) ) {
229 next if ( $m->{files}{$file}{type} != BPC_FTYPE_DELETED );
230 delete($m->{files}{$file});
232 #print STDERR "Returning:\n", Dumper($m->{files});
236 # Return list of shares for this backup
240 my($m, $backupNum) = @_;
243 $m->backupNumCache($backupNum) if ( $m->{num} != $backupNum );
244 return if ( $m->{idx} < 0 );
246 my $mangle = $m->{backups}[$m->{idx}]{mangle};
247 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
248 return if ( !opendir(DIR, $path) );
249 my @dir = readdir(DIR);
251 foreach my $file ( @dir ) {
252 $file = $1 if ( $file =~ /(.*)/ );
253 next if ( $file eq "attrib" && $mangle
257 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
258 push(@shareList, $fileUM);
266 my($m, $backupNum) = @_;
268 if ( $m->{num} != $backupNum ) {
270 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
271 last if ( $m->{backups}[$i]{num} == $backupNum );
273 if ( $i >= @{$m->{backups}} ) {
277 $m->{num} = $backupNum;
283 # Return the attributes of a specific file
287 my($m, $backupNum, $share, $path) = @_;
289 #print(STDERR "fileAttrib($backupNum, $share, $path)\n");
290 if ( $path =~ s{(.*)/+(.+)}{$1} ) {
292 $m->dirCache($backupNum, $share, $path);
293 return $m->{files}{$file};
295 #print STDERR "Got empty $path\n";
296 $m->dirCache($backupNum, "", "");
297 my $attr = $m->{files}{$share};
298 return if ( !defined($attr) );
299 $attr->{relPath} = "/";
305 # Return the contents of a directory
309 my($m, $backupNum, $share, $dir) = @_;
311 $m->dirCache($backupNum, $share, $dir);
316 # Return a listref of backup numbers that are merged to create this view
322 return $m->{mergeNums};
326 # Return a list of backup indexes for which the directory exists
330 my($m, $share, $dir) = @_;
333 $dir = "/$dir" if ( $dir !~ m{^/} );
336 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
337 my $backupNum = $m->{backups}[$i]{num};
338 my $mangle = $m->{backups}[$i]{mangle};
339 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
342 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
343 . $m->{bpc}->fileNameMangle($dir);
345 $sharePathM = $share . $dir;
347 $path .= $sharePathM;
348 next if ( !-d $path );
349 push(@backupList, $i);
355 # Return the history of all backups for a particular directory
359 my($m, $share, $dir) = @_;
363 $dir = "/$dir" if ( $dir !~ m{^/} );
367 # merge backups, starting at the first one, and working
370 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
371 $level = $m->{backups}[$i]{level};
372 my $backupNum = $m->{backups}[$i]{num};
373 my $mangle = $m->{backups}[$i]{mangle};
374 my $compress = $m->{backups}[$i]{compress};
375 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
378 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
379 . $m->{bpc}->fileNameMangle($dir);
381 $sharePathM = $share . $dir;
383 $path .= $sharePathM;
384 #print(STDERR "Opening $path (share=$share)\n");
385 if ( !opendir(DIR, $path) ) {
387 # Oops, directory doesn't exist.
391 my @dir = readdir(DIR);
395 $attr = BackupPC::Attrib->new({ compress => $compress });
396 if ( -f $attr->fileName($path) && !$attr->read($path) ) {
397 $m->{error} = "Can't read attribute file in $path";
401 foreach my $file ( @dir ) {
402 $file = $1 if ( $file =~ /(.*)/ );
404 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
405 #print(STDERR "Doing $fileUM\n");
409 next if ( $file eq ".."
411 || $mangle && $file eq "attrib"
412 || defined($files->{$fileUM}[$i]) );
413 my @s = stat("$path/$file");
414 if ( defined($attr) && defined(my $a = $attr->get($fileUM)) ) {
415 $files->{$fileUM}[$i] = $a;
416 $attr->set($fileUM, undef);
419 # Very expensive in the non-attribute case when compresseion
420 # is on. We have to stat the file and read compressed files
421 # to determine their size.
423 $files->{$fileUM}[$i] = {
424 type => -d _ ? BPC_FTYPE_DIR : BPC_FTYPE_FILE,
428 size => -f _ ? $s[7] : 0,
431 if ( $compress && -f _ ) {
433 # Compute the correct size by reading the whole file
435 my $f = BackupPC::FileZIO->open("$path/$file",
437 if ( !defined($f) ) {
438 $m->{error} = "Can't open $path/$file";
441 while ( $f->read(\$data, 65636 * 8) > 0 ) {
442 $size += length($data);
445 $files->{$fileUM}[$i]{size} = $size;
449 ($files->{$fileUM}[$i]{relPath} = "$dir/$fileUM") =~ s{//+}{/}g;
450 ($files->{$fileUM}[$i]{sharePathM} = "$sharePathM/$file")
452 ($files->{$fileUM}[$i]{fullPath} = "$path/$file") =~ s{//+}{/}g;
453 $files->{$fileUM}[$i]{backupNum} = $backupNum;
454 $files->{$fileUM}[$i]{compress} = $compress;
455 $files->{$fileUM}[$i]{nlink} = $s[3];
456 $files->{$fileUM}[$i]{inode} = $s[1];
460 # Merge old backups. Don't merge directories from old
461 # backups because every backup has an accurate directory
464 for ( my $k = $i - 1 ; $level > 0 && $k >= 0 ; $k-- ) {
465 next if ( $m->{backups}[$k]{level} >= $level );
466 $level = $m->{backups}[$k]{level};
467 foreach my $fileUM ( keys(%$files) ) {
468 next if ( !defined($files->{$fileUM}[$k])
469 || defined($files->{$fileUM}[$i])
470 || $files->{$fileUM}[$k]{type} == BPC_FTYPE_DIR );
471 $files->{$fileUM}[$i] = $files->{$fileUM}[$k];
476 # Finally, remove deleted files
478 if ( defined($attr) ) {
480 foreach my $fileUM ( keys(%$a) ) {
481 next if ( $a->{$fileUM}{type} != BPC_FTYPE_DELETED );
482 $files->{$fileUM}[$i] = undef if ( defined($files->{$fileUM}) );
486 #print STDERR "Returning:\n", Dumper($files);
492 # Do a recursive find starting at the given path (either a file
493 # or directory). The callback function $callback is called on each
494 # file and directory. The function arguments are the attrs hashref,
495 # and additional callback arguments. The search is depth-first if
496 # depth is set. Returns -1 if $path does not exist.
500 my($m, $backupNum, $share, $path, $depth, $callback, @callbackArgs) = @_;
502 #print(STDERR "find: got $backupNum, $share, $path\n");
504 # First call the callback on the given $path
506 my $attr = $m->fileAttrib($backupNum, $share, $path);
507 return -1 if ( !defined($attr) );
508 &$callback($attr, @callbackArgs);
509 return if ( $attr->{type} != BPC_FTYPE_DIR );
512 # Now recurse into subdirectories
514 $m->findRecurse($backupNum, $share, $path, $depth,
515 $callback, @callbackArgs);
519 # Same as find(), except the callback is not called on the current
520 # $path, only on the contents of $path. So if $path is a file then
521 # no callback or recursion occurs.
525 my($m, $backupNum, $share, $path, $depth, $callback, @callbackArgs) = @_;
527 my $attr = $m->dirAttrib($backupNum, $share, $path);
528 return if ( !defined($attr) );
529 foreach my $file ( sort(keys(%$attr)) ) {
530 &$callback($attr->{$file}, @callbackArgs);
531 next if ( !$depth || $attr->{$file}{type} != BPC_FTYPE_DIR );
533 # For depth-first, recurse as we hit each directory
535 $m->findRecurse($backupNum, $share, "$path/$file", $depth,
536 $callback, @callbackArgs);
540 # For non-depth, recurse directories after we finish current dir
542 foreach my $file ( keys(%{$attr}) ) {
543 next if ( $attr->{$file}{type} != BPC_FTYPE_DIR );
544 $m->findRecurse($backupNum, $share, "$path/$file", $depth,
545 $callback, @callbackArgs);