/[BackupPC]/trunk/lib/BackupPC/View.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /trunk/lib/BackupPC/View.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 316 - (show annotations)
Mon Jan 30 13:37:17 2006 UTC (18 years, 3 months ago) by dpavlin
File size: 17328 byte(s)
 r9152@llin:  dpavlin | 2006-01-30 14:11:45 +0100
 update to upstream 2.1.2

1 #============================================================= -*-perl-*-
2 #
3 # BackupPC::View package
4 #
5 # DESCRIPTION
6 #
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.
11 #
12 # AUTHOR
13 # Craig Barratt <cbarratt@users.sourceforge.net>
14 #
15 # COPYRIGHT
16 # Copyright (C) 2002-2003 Craig Barratt
17 #
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.
22 #
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.
27 #
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
31 #
32 #========================================================================
33 #
34 # Version 2.1.2, released 5 Sep 2005.
35 #
36 # See http://backuppc.sourceforge.net.
37 #
38 #========================================================================
39
40 package BackupPC::View;
41
42 use strict;
43
44 use File::Path;
45 use BackupPC::Lib;
46 use BackupPC::Attrib qw(:all);
47 use BackupPC::FileZIO;
48 use Data::Dumper;
49
50 sub new
51 {
52 my($class, $bpc, $host, $backups, $only_one) = @_;
53 my $m = bless {
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
59 # we are viewing
60 dirPath => undef, # path to current directory
61 dirAttr => undef, # attributes of current directory
62 }, $class;
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;
66 }
67 $m->{topDir} = $m->{bpc}->TopDir();
68 $m->{only_one} = $only_one;
69 return $m;
70 }
71
72 sub dirCache
73 {
74 my($m, $backupNum, $share, $dir) = @_;
75 my($i, $level);
76
77 #print STDERR "dirCache($backupNum, $share, $dir)\n";
78 $dir = "/$dir" if ( $dir !~ m{^/} );
79 $dir =~ s{/+$}{};
80 return if ( $m->{num} == $backupNum
81 && $m->{share} eq $share
82 && defined($m->{dir})
83 && $m->{dir} eq $dir );
84 $m->backupNumCache($backupNum) if ( $m->{num} != $backupNum );
85 return if ( $m->{idx} < 0 );
86
87 $m->{files} = {};
88 $level = $m->{backups}[$m->{idx}]{level} + 1;
89
90 #
91 # Remember the requested share and dir
92 #
93 $m->{share} = $share;
94 $m->{dir} = $dir;
95
96 #
97 # merge backups, starting at the requested one, and working
98 # backwards until we get to level 0.
99 #
100 $m->{mergeNums} = [];
101 for ( $i = $m->{idx} ; $level > 0 && $i >= 0 ; $i-- ) {
102 #print(STDERR "Do $i ($m->{backups}[$i]{noFill},$m->{backups}[$i]{level})\n");
103 #
104 # skip backups with the same or higher level
105 #
106 next if ( $m->{backups}[$i]{level} >= $level );
107
108 last if ( $m->{only_one} && $i != $m->{idx} );
109
110 $level = $m->{backups}[$i]{level};
111 $backupNum = $m->{backups}[$i]{num};
112 push(@{$m->{mergeNums}}, $backupNum);
113 my $mangle = $m->{backups}[$i]{mangle};
114 my $compress = $m->{backups}[$i]{compress};
115 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
116 my $sharePathM;
117 if ( $mangle ) {
118 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
119 . $m->{bpc}->fileNameMangle($dir);
120 } else {
121 $sharePathM = $share . $dir;
122 }
123 $path .= $sharePathM;
124 #print(STDERR "Opening $path (share=$share)\n");
125 if ( !opendir(DIR, $path) ) {
126 if ( $i == $m->{idx} ) {
127 #
128 # Oops, directory doesn't exist.
129 #
130 $m->{files} = undef;
131 return;
132 }
133 next;
134 }
135 my @dir = readdir(DIR);
136 closedir(DIR);
137 my $attr;
138 if ( $mangle ) {
139 $attr = BackupPC::Attrib->new({ compress => $compress });
140 if ( -f $attr->fileName($path) && !$attr->read($path) ) {
141 $m->{error} = "Can't read attribute file in $path";
142 $attr = undef;
143 }
144 }
145 foreach my $file ( @dir ) {
146 $file = $1 if ( $file =~ /(.*)/ );
147 my $fileUM = $file;
148 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
149 #print(STDERR "Doing $fileUM\n");
150 #
151 # skip special files
152 #
153 next if ( defined($m->{files}{$fileUM})
154 || $file eq ".."
155 || $file eq "."
156 || $mangle && $file eq "attrib" );
157 #
158 # skip directories in earlier backups (each backup always
159 # has the complete directory tree).
160 #
161 my @s = stat("$path/$file");
162 next if ( $i < $m->{idx} && -d _ );
163 if ( defined($attr) && defined(my $a = $attr->get($fileUM)) ) {
164 $m->{files}{$fileUM} = $a;
165 $attr->set($fileUM, undef);
166 } else {
167 #
168 # Very expensive in the non-attribute case when compresseion
169 # is on. We have to stat the file and read compressed files
170 # to determine their size.
171 #
172 $m->{files}{$fileUM} = {
173 type => -d _ ? BPC_FTYPE_DIR : BPC_FTYPE_FILE,
174 mode => $s[2],
175 uid => $s[4],
176 gid => $s[5],
177 size => -f _ ? $s[7] : 0,
178 mtime => $s[9],
179 };
180 if ( $compress && -f _ ) {
181 #
182 # Compute the correct size by reading the whole file
183 #
184 my $f = BackupPC::FileZIO->open("$path/$file",
185 0, $compress);
186 if ( !defined($f) ) {
187 $m->{error} = "Can't open $path/$file";
188 } else {
189 my($data, $size);
190 while ( $f->read(\$data, 65636 * 8) > 0 ) {
191 $size += length($data);
192 }
193 $f->close;
194 $m->{files}{$fileUM}{size} = $size;
195 }
196 }
197 }
198 ($m->{files}{$fileUM}{relPath} = "$dir/$fileUM") =~ s{//+}{/}g;
199 ($m->{files}{$fileUM}{sharePathM} = "$sharePathM/$file")
200 =~ s{//+}{/}g;
201 ($m->{files}{$fileUM}{fullPath} = "$path/$file") =~ s{//+}{/}g;
202 $m->{files}{$fileUM}{backupNum} = $backupNum;
203 $m->{files}{$fileUM}{compress} = $compress;
204 $m->{files}{$fileUM}{nlink} = $s[3];
205 $m->{files}{$fileUM}{inode} = $s[1];
206 }
207 #
208 # Also include deleted files
209 #
210 if ( defined($attr) ) {
211 my $a = $attr->get;
212 foreach my $fileUM ( keys(%$a) ) {
213 next if ( $a->{$fileUM}{type} != BPC_FTYPE_DELETED );
214 my $file = $fileUM;
215 $file = $m->{bpc}->fileNameMangle($fileUM) if ( $mangle );
216 $m->{files}{$fileUM} = $a->{$fileUM};
217 $m->{files}{$fileUM}{relPath} = "$dir/$fileUM";
218 $m->{files}{$fileUM}{sharePathM} = "$sharePathM/$file";
219 $m->{files}{$fileUM}{fullPath} = "$path/$file";
220 $m->{files}{$fileUM}{backupNum} = $backupNum;
221 $m->{files}{$fileUM}{compress} = $compress;
222 $m->{files}{$fileUM}{nlink} = 0;
223 $m->{files}{$fileUM}{inode} = 0;
224 }
225 }
226 }
227 #
228 # Prune deleted files
229 #
230 foreach my $file ( keys(%{$m->{files}}) ) {
231 next if ( $m->{files}{$file}{type} != BPC_FTYPE_DELETED );
232 delete($m->{files}{$file});
233 }
234 #print STDERR "Returning:\n", Dumper($m->{files});
235 }
236
237 #
238 # Return list of shares for this backup
239 #
240 sub shareList
241 {
242 my($m, $backupNum) = @_;
243 my @shareList;
244
245 $m->backupNumCache($backupNum) if ( $m->{num} != $backupNum );
246 return if ( $m->{idx} < 0 );
247
248 my $mangle = $m->{backups}[$m->{idx}]{mangle};
249 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
250 return if ( !opendir(DIR, $path) );
251 my @dir = readdir(DIR);
252 closedir(DIR);
253 foreach my $file ( @dir ) {
254 $file = $1 if ( $file =~ /(.*)/ );
255 next if ( $file eq "attrib" && $mangle
256 || $file eq "."
257 || $file eq ".." );
258 my $fileUM = $file;
259 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
260 push(@shareList, $fileUM);
261 }
262 $m->{dir} = undef;
263 return @shareList;
264 }
265
266 sub backupNumCache
267 {
268 my($m, $backupNum) = @_;
269
270 if ( $m->{num} != $backupNum ) {
271 my $i;
272 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
273 last if ( $m->{backups}[$i]{num} == $backupNum );
274 }
275 if ( $i >= @{$m->{backups}} ) {
276 $m->{idx} = -1;
277 return;
278 }
279 $m->{num} = $backupNum;
280 $m->{idx} = $i;
281 }
282 }
283
284 #
285 # Return the attributes of a specific file
286 #
287 sub fileAttrib
288 {
289 my($m, $backupNum, $share, $path) = @_;
290
291 #print(STDERR "fileAttrib($backupNum, $share, $path)\n");
292 if ( $path =~ s{(.*)/+(.+)}{$1} ) {
293 my $file = $2;
294 $m->dirCache($backupNum, $share, $path);
295 return $m->{files}{$file};
296 } else {
297 #print STDERR "Got empty $path\n";
298 $m->dirCache($backupNum, "", "");
299 my $attr = $m->{files}{$share};
300 return if ( !defined($attr) );
301 $attr->{relPath} = "/";
302 return $attr;
303 }
304 }
305
306 #
307 # Return the contents of a directory
308 #
309 sub dirAttrib
310 {
311 my($m, $backupNum, $share, $dir) = @_;
312
313 $m->dirCache($backupNum, $share, $dir);
314 return $m->{files};
315 }
316
317 #
318 # Return a listref of backup numbers that are merged to create this view
319 #
320 sub mergeNums
321 {
322 my($m) = @_;
323
324 return $m->{mergeNums};
325 }
326
327 #
328 # Return a list of backup indexes for which the directory exists
329 #
330 sub backupList
331 {
332 my($m, $share, $dir) = @_;
333 my($i, @backupList);
334
335 $dir = "/$dir" if ( $dir !~ m{^/} );
336 $dir =~ s{/+$}{};
337
338 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
339 my $backupNum = $m->{backups}[$i]{num};
340 my $mangle = $m->{backups}[$i]{mangle};
341 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
342 my $sharePathM;
343 if ( $mangle ) {
344 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
345 . $m->{bpc}->fileNameMangle($dir);
346 } else {
347 $sharePathM = $share . $dir;
348 }
349 $path .= $sharePathM;
350 next if ( !-d $path );
351 push(@backupList, $i);
352 }
353 return @backupList;
354 }
355
356 #
357 # Return the history of all backups for a particular directory
358 #
359 sub dirHistory
360 {
361 my($m, $share, $dir) = @_;
362 my($i, $level);
363 my $files = {};
364
365 $dir = "/$dir" if ( $dir !~ m{^/} );
366 $dir =~ s{/+$}{};
367
368 #
369 # merge backups, starting at the first one, and working
370 # forward.
371 #
372 for ( $i = 0 ; $i < @{$m->{backups}} ; $i++ ) {
373 $level = $m->{backups}[$i]{level};
374 my $backupNum = $m->{backups}[$i]{num};
375 my $mangle = $m->{backups}[$i]{mangle};
376 my $compress = $m->{backups}[$i]{compress};
377 my $path = "$m->{topDir}/pc/$m->{host}/$backupNum/";
378 my $sharePathM;
379 if ( $mangle ) {
380 $sharePathM = $m->{bpc}->fileNameEltMangle($share)
381 . $m->{bpc}->fileNameMangle($dir);
382 } else {
383 $sharePathM = $share . $dir;
384 }
385 $path .= $sharePathM;
386 #print(STDERR "Opening $path (share=$share)\n");
387 if ( !opendir(DIR, $path) ) {
388 #
389 # Oops, directory doesn't exist.
390 #
391 next;
392 }
393 my @dir = readdir(DIR);
394 closedir(DIR);
395 my $attr;
396 if ( $mangle ) {
397 $attr = BackupPC::Attrib->new({ compress => $compress });
398 if ( -f $attr->fileName($path) && !$attr->read($path) ) {
399 $m->{error} = "Can't read attribute file in $path";
400 $attr = undef;
401 }
402 }
403 foreach my $file ( @dir ) {
404 $file = $1 if ( $file =~ /(.*)/ );
405 my $fileUM = $file;
406 $fileUM = $m->{bpc}->fileNameUnmangle($fileUM) if ( $mangle );
407 #print(STDERR "Doing $fileUM\n");
408 #
409 # skip special files
410 #
411 next if ( $file eq ".."
412 || $file eq "."
413 || $mangle && $file eq "attrib"
414 || defined($files->{$fileUM}[$i]) );
415 my @s = stat("$path/$file");
416 if ( defined($attr) && defined(my $a = $attr->get($fileUM)) ) {
417 $files->{$fileUM}[$i] = $a;
418 $attr->set($fileUM, undef);
419 } else {
420 #
421 # Very expensive in the non-attribute case when compresseion
422 # is on. We have to stat the file and read compressed files
423 # to determine their size.
424 #
425 $files->{$fileUM}[$i] = {
426 type => -d _ ? BPC_FTYPE_DIR : BPC_FTYPE_FILE,
427 mode => $s[2],
428 uid => $s[4],
429 gid => $s[5],
430 size => -f _ ? $s[7] : 0,
431 mtime => $s[9],
432 };
433 if ( $compress && -f _ ) {
434 #
435 # Compute the correct size by reading the whole file
436 #
437 my $f = BackupPC::FileZIO->open("$path/$file",
438 0, $compress);
439 if ( !defined($f) ) {
440 $m->{error} = "Can't open $path/$file";
441 } else {
442 my($data, $size);
443 while ( $f->read(\$data, 65636 * 8) > 0 ) {
444 $size += length($data);
445 }
446 $f->close;
447 $files->{$fileUM}[$i]{size} = $size;
448 }
449 }
450 }
451 ($files->{$fileUM}[$i]{relPath} = "$dir/$fileUM") =~ s{//+}{/}g;
452 ($files->{$fileUM}[$i]{sharePathM} = "$sharePathM/$file")
453 =~ s{//+}{/}g;
454 ($files->{$fileUM}[$i]{fullPath} = "$path/$file") =~ s{//+}{/}g;
455 $files->{$fileUM}[$i]{backupNum} = $backupNum;
456 $files->{$fileUM}[$i]{compress} = $compress;
457 $files->{$fileUM}[$i]{nlink} = $s[3];
458 $files->{$fileUM}[$i]{inode} = $s[1];
459 }
460
461 #
462 # Merge old backups. Don't merge directories from old
463 # backups because every backup has an accurate directory
464 # tree.
465 #
466 for ( my $k = $i - 1 ; $level > 0 && $k >= 0 ; $k-- ) {
467 next if ( $m->{backups}[$k]{level} >= $level );
468 $level = $m->{backups}[$k]{level};
469 foreach my $fileUM ( keys(%$files) ) {
470 next if ( !defined($files->{$fileUM}[$k])
471 || defined($files->{$fileUM}[$i])
472 || $files->{$fileUM}[$k]{type} == BPC_FTYPE_DIR );
473 $files->{$fileUM}[$i] = $files->{$fileUM}[$k];
474 }
475 }
476
477 #
478 # Finally, remove deleted files
479 #
480 if ( defined($attr) ) {
481 my $a = $attr->get;
482 foreach my $fileUM ( keys(%$a) ) {
483 next if ( $a->{$fileUM}{type} != BPC_FTYPE_DELETED );
484 $files->{$fileUM}[$i] = undef if ( defined($files->{$fileUM}) );
485 }
486 }
487 }
488 #print STDERR "Returning:\n", Dumper($files);
489 return $files;
490 }
491
492
493 #
494 # Do a recursive find starting at the given path (either a file
495 # or directory). The callback function $callback is called on each
496 # file and directory. The function arguments are the attrs hashref,
497 # and additional callback arguments. The search is depth-first if
498 # depth is set. Returns -1 if $path does not exist.
499 #
500 sub find
501 {
502 my($m, $backupNum, $share, $path, $depth, $callback, @callbackArgs) = @_;
503
504 #print(STDERR "find: got $backupNum, $share, $path\n");
505 #
506 # First call the callback on the given $path
507 #
508 my $attr = $m->fileAttrib($backupNum, $share, $path);
509 return -1 if ( !defined($attr) );
510 &$callback($attr, @callbackArgs);
511 return if ( $attr->{type} != BPC_FTYPE_DIR );
512
513 #
514 # Now recurse into subdirectories
515 #
516 $m->findRecurse($backupNum, $share, $path, $depth,
517 $callback, @callbackArgs);
518 }
519
520 #
521 # Same as find(), except the callback is not called on the current
522 # $path, only on the contents of $path. So if $path is a file then
523 # no callback or recursion occurs.
524 #
525 sub findRecurse
526 {
527 my($m, $backupNum, $share, $path, $depth, $callback, @callbackArgs) = @_;
528
529 my $attr = $m->dirAttrib($backupNum, $share, $path);
530 return if ( !defined($attr) );
531 foreach my $file ( sort(keys(%$attr)) ) {
532 &$callback($attr->{$file}, @callbackArgs);
533 next if ( !$depth || $attr->{$file}{type} != BPC_FTYPE_DIR );
534 #
535 # For depth-first, recurse as we hit each directory
536 #
537 $m->findRecurse($backupNum, $share, "$path/$file", $depth,
538 $callback, @callbackArgs);
539 }
540 if ( !$depth ) {
541 #
542 # For non-depth, recurse directories after we finish current dir
543 #
544 foreach my $file ( keys(%{$attr}) ) {
545 next if ( $attr->{$file}{type} != BPC_FTYPE_DIR );
546 $m->findRecurse($backupNum, $share, "$path/$file", $depth,
547 $callback, @callbackArgs);
548 }
549 }
550 }
551
552 1;

  ViewVC Help
Powered by ViewVC 1.1.26