1 #============================================================= -*-perl-*-
3 # BackupPC::Xfer::Rsync package
7 # This library defines a BackupPC::Xfer::Rsync class for managing
8 # the rsync-based transport of backup data from the client.
11 # Craig Barratt <cbarratt@users.sourceforge.net>
14 # Copyright (C) 2002-2003 Craig Barratt
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
26 # You should have received a copy of the GNU General Public License
27 # along with this program; if not, write to the Free Software
28 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #========================================================================
32 # Version 2.1.0_CVS, released 8 Feb 2004.
34 # See http://backuppc.sourceforge.net.
36 #========================================================================
38 package BackupPC::Xfer::Rsync;
42 use BackupPC::Xfer::RsyncFileIO;
44 use vars qw( $RsyncLibOK $RsyncLibErr );
47 eval "use File::RsyncP;";
50 # Rsync module doesn't exist.
53 $RsyncLibErr = "File::RsyncP module doesn't exist";
55 if ( $File::RsyncP::VERSION < 0.50 ) {
57 $RsyncLibErr = "File::RsyncP module version too old: need 0.50";
66 my($class, $bpc, $args) = @_;
68 return if ( !$RsyncLibOK );
72 conf => { $bpc->Conf },
101 foreach my $arg ( keys(%$args) ) {
102 $t->{$arg} = $args->{$arg};
115 my $conf = $t->{conf};
116 my(@fileList, $rsyncClientCmd, $rsyncArgs, $logMsg,
117 $incrDate, $argList, $fioArgs);
120 # We add a slash to the share name we pass to rsync
122 ($t->{shareNameSlash} = "$t->{shareName}/") =~ s{//+$}{/};
124 if ( $t->{type} eq "restore" ) {
125 $rsyncClientCmd = $conf->{RsyncClientRestoreCmd};
126 $rsyncArgs = $conf->{RsyncRestoreArgs};
127 my $remoteDir = "$t->{shareName}/$t->{pathHdrDest}";
128 $remoteDir =~ s{//+}{/}g;
129 $argList = ['--server', @$rsyncArgs, '.', $remoteDir];
131 client => $t->{bkupSrcHost},
132 share => $t->{bkupSrcShare},
133 viewNum => $t->{bkupSrcNum},
134 fileList => $t->{fileList},
136 $logMsg = "restore started below directory $t->{shareName}"
137 . " to host $t->{host}";
140 # Turn $conf->{BackupFilesOnly} and $conf->{BackupFilesExclude}
141 # into a hash of arrays of files.
143 $conf->{RsyncShareName} = [ $conf->{RsyncShareName} ]
144 unless ref($conf->{RsyncShareName}) eq "ARRAY";
145 foreach my $param qw(BackupFilesOnly BackupFilesExclude) {
146 next if ( !defined($conf->{$param}) );
147 if ( ref($conf->{$param}) eq "ARRAY" ) {
149 $conf->{RsyncShareName}[0] => $conf->{$param}
151 } elsif ( ref($conf->{$param}) eq "HASH" ) {
155 $conf->{RsyncShareName}[0] => [ $conf->{$param} ]
159 if ( defined($conf->{BackupFilesOnly}{$t->{shareName}}) ) {
160 my(@inc, @exc, %incDone, %excDone);
161 foreach my $file ( @{$conf->{BackupFilesOnly}{$t->{shareName}}} ) {
163 # If the user wants to just include /home/craig, then
164 # we need to do create include/exclude pairs at
166 # --include /home --exclude /*
167 # --include /home/craig --exclude /home/*
169 # It's more complex if the user wants to include multiple
170 # deep paths. For example, if they want /home/craig and
171 # /var/log, then we need this mouthfull:
172 # --include /home --include /var --exclude /*
173 # --include /home/craig --exclude /home/*
174 # --include /var/log --exclude /var/*
176 # To make this easier we do all the includes first and all
177 # of the excludes at the end (hopefully they commute).
182 if ( $file eq "/" ) {
184 # This is a special case: if the user specifies
185 # "/" then just include it and don't exclude "/*".
187 push(@inc, $file) if ( !$incDone{$file} );
191 while ( $file =~ m{^/([^/]*)(.*)} ) {
194 if ( $file eq "/" ) {
196 # preserve a tailing slash
201 push(@exc, "$f/*") if ( !$excDone{"$f/*"} );
202 $excDone{"$f/*"} = 1;
204 push(@inc, $f) if ( !$incDone{$f} );
208 foreach my $file ( @inc ) {
209 push(@fileList, "--include=$file");
211 foreach my $file ( @exc ) {
212 push(@fileList, "--exclude=$file");
215 if ( defined($conf->{BackupFilesExclude}{$t->{shareName}}) ) {
216 foreach my $file ( @{$conf->{BackupFilesExclude}{$t->{shareName}}} )
219 # just append additional exclude lists onto the end
221 push(@fileList, "--exclude=$file");
224 if ( $t->{type} eq "full" ) {
225 if ( $t->{partialNum} ) {
226 $logMsg = "full backup started for directory $t->{shareName};"
227 . " updating partial $t->{partialNum}";
229 $logMsg = "full backup started for directory $t->{shareName}";
232 $incrDate = $bpc->timeStamp($t->{lastFull} - 3600, 1);
233 $logMsg = "incr backup started back to $incrDate for directory"
234 . " $t->{shareName}";
238 # A full dump is implemented with --ignore-times: this causes all
239 # files to be checksummed, even if the attributes are the same.
240 # That way all the file contents are checked, but you get all
241 # the efficiencies of rsync: only files deltas need to be
242 # transferred, even though it is a full dump.
244 $rsyncArgs = $conf->{RsyncArgs};
245 $rsyncArgs = [@$rsyncArgs, @fileList] if ( @fileList );
246 $rsyncArgs = [@$rsyncArgs, "--ignore-times"]
247 if ( $t->{type} eq "full" );
248 $rsyncClientCmd = $conf->{RsyncClientCmd};
249 $argList = ['--server', '--sender', @$rsyncArgs,
250 '.', $t->{shareNameSlash}];
252 client => $t->{client},
253 share => $t->{shareName},
254 viewNum => $t->{lastFullBkupNum},
255 partialNum => $t->{partialNum},
260 # Merge variables into $rsyncClientCmd
264 hostIP => $t->{hostIP},
265 client => $t->{client},
266 shareName => $t->{shareName},
267 shareNameSlash => $t->{shareNameSlash},
268 rsyncPath => $conf->{RsyncClientPath},
269 sshPath => $conf->{SshPath},
272 $rsyncClientCmd = $bpc->cmdVarSubstitute($rsyncClientCmd, $args);
275 # Create the Rsync object, and tell it to use our own File::RsyncP::FileIO
276 # module, which handles all the special BackupPC file storage
277 # (compression, mangling, hardlinks, special files, attributes etc).
279 $t->{rsyncClientCmd} = $rsyncClientCmd;
280 $t->{rs} = File::RsyncP->new({
281 logLevel => $t->{logLevel} || $conf->{RsyncLogLevel},
284 $bpc->cmdExecOrEval($rsyncClientCmd, $args);
286 rsyncCmdType => "full",
287 rsyncArgs => $rsyncArgs,
288 timeout => $conf->{ClientTimeout},
289 doPartial => defined($t->{partialNum}) ? 1 : undef,
294 $t->{XferLOG}->write(\$str);
295 if ( $str =~ /^Remote\[1\]: read errors mapping "(.*)"/ ) {
297 # Files with read errors (eg: region locked files
298 # on WinXX) are filled with 0 by rsync. Remember
299 # them and delete them later.
302 $badFile =~ s/^\/+//;
303 push(@{$t->{badFiles}}, {
304 share => $t->{shareName},
310 $t->{pidHandler}(@_);
312 fio => BackupPC::Xfer::RsyncFileIO->new({
316 backups => $t->{backups},
317 logLevel => $t->{logLevel}
318 || $conf->{RsyncLogLevel},
322 $t->{XferLOG}->write(\$str);
328 delete($t->{_errStr});
337 my $conf = $t->{conf};
338 my($remoteSend, $remoteDir, $remoteDirDaemon);
340 alarm($conf->{ClientTimeout});
341 if ( $t->{type} eq "restore" ) {
343 ($remoteDir = "$t->{shareName}/$t->{pathHdrDest}") =~ s{//+}{/}g;
344 ($remoteDirDaemon = "$t->{shareName}/$t->{pathHdrDest}") =~ s{//+}{/}g;
345 $remoteDirDaemon = $t->{shareNameSlash}
346 if ( $t->{pathHdrDest} eq ""
347 || $t->{pathHdrDest} eq "/" );
350 $remoteDir = $t->{shareNameSlash};
351 $remoteDirDaemon = ".";
353 if ( $t->{XferMethod} eq "rsync" ) {
357 my $str = "Running: "
358 . $t->{bpc}->execCmd2ShellCmd(@{$t->{rsyncClientCmd}})
360 $t->{XferLOG}->write(\$str);
361 $rs->remoteStart($remoteSend, $remoteDir);
364 # Connect to the rsync server
366 if ( defined(my $err = $rs->serverConnect($t->{hostIP},
367 $conf->{RsyncdClientPort})) ) {
368 $t->{hostError} = $err;
369 my $str = "Error connecting to rsync daemon at $t->{hostIP}"
370 . ":$conf->{RsyncdClientPort}: $err\n";
371 $t->{XferLOG}->write(\$str);
375 # Pass module name, and follow it with a slash if it already
376 # contains a slash; otherwise just keep the plain module name.
378 my $module = $t->{shareName};
379 $module = $t->{shareNameSlash} if ( $module =~ /\// );
380 if ( defined(my $err = $rs->serverService($module,
381 $conf->{RsyncdUserName},
382 $conf->{RsyncdPasswd},
383 $conf->{RsyncdAuthRequired})) ) {
384 my $str = "Error connecting to module $module at $t->{hostIP}"
385 . ":$conf->{RsyncdClientPort}: $err\n";
386 $t->{XferLOG}->write(\$str);
387 $t->{hostError} = $err;
390 $rs->serverStart($remoteSend, $remoteDirDaemon);
392 my $error = $rs->go($t->{shareNameSlash});
396 # TODO: generate sensible stats
398 # $rs->{stats}{totalWritten}
399 # $rs->{stats}{totalSize}
401 my $stats = $rs->statsFinal;
402 if ( !defined($error) && defined($stats) ) {
407 $t->{xferErrCnt} = $stats->{remoteErrCnt}
408 + $stats->{childStats}{errorCnt}
409 + $stats->{parentStats}{errorCnt};
410 $t->{byteCnt} = $stats->{childStats}{TotalFileSize}
411 + $stats->{parentStats}{TotalFileSize};
412 $t->{fileCnt} = $stats->{childStats}{TotalFileCnt}
413 + $stats->{parentStats}{TotalFileCnt};
414 my $str = "Done: $t->{fileCnt} files, $t->{byteCnt} bytes\n";
415 $t->{XferLOG}->write(\$str);
417 # TODO: get error count, and call fio to get stats...
419 $t->{hostError} = $error if ( defined($error) );
421 if ( $t->{type} eq "restore" ) {
431 $stats->{childStats}{ExistFileCnt}
432 + $stats->{parentStats}{ExistFileCnt},
433 $stats->{childStats}{ExistFileSize}
434 + $stats->{parentStats}{ExistFileSize},
435 $stats->{childStats}{ExistFileCompSize}
436 + $stats->{parentStats}{ExistFileCompSize},
437 $stats->{childStats}{TotalFileCnt}
438 + $stats->{parentStats}{TotalFileCnt},
439 $stats->{childStats}{TotalFileSize}
440 + $stats->{parentStats}{TotalFileSize},
447 my($t, $reason) = @_;
456 my($t, $FDreadRef) = @_;
463 return $RsyncLibErr if ( !defined($t) || ref($t) ne "HASH" );
464 return $t->{_errStr};
478 push(@{$t->{_logMsg}}, $msg);
485 return shift(@{$t->{_logMsg}});
489 # Returns a hash ref giving various status information about
496 return { map { $_ => $t->{$_} }
497 qw(byteCnt fileCnt xferErrCnt xferBadShareCnt xferBadFileCnt
498 xferOK hostAbort hostError lastOutputLine)
506 return @{$t->{badFiles}};