1 #============================================================= -*-perl-*-
3 # BackupPC::Xfer::Tar package
7 # This library defines a BackupPC::Xfer::Tar class for managing
8 # the tar-based transport of backup data from the client.
11 # Craig Barratt <cbarratt@users.sourceforge.net>
14 # Copyright (C) 2001-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 3.0.0alpha, released 23 Jan 2006.
34 # See http://backuppc.sourceforge.net.
36 #========================================================================
38 package BackupPC::Xfer::Tar;
44 my($class, $bpc, $args) = @_;
49 conf => { $bpc->Conf },
66 foreach my $arg ( keys(%$args) ) {
67 $t->{$arg} = $args->{$arg};
80 my $conf = $t->{conf};
81 my(@fileList, $tarClientCmd, $logMsg, $incrDate);
84 if ( $t->{type} eq "restore" ) {
85 $tarClientCmd = $conf->{TarClientRestoreCmd};
86 $logMsg = "restore started below directory $t->{shareName}";
88 # restores are considered to work unless we see they fail
89 # (opposite to backups...)
94 # Turn $conf->{BackupFilesOnly} and $conf->{BackupFilesExclude}
95 # into a hash of arrays of files, and $conf->{TarShareName}
98 $bpc->backupFileConfFix($conf, "TarShareName");
100 if ( defined($conf->{BackupFilesExclude}{$t->{shareName}}) ) {
101 foreach my $file ( @{$conf->{BackupFilesExclude}{$t->{shareName}}} )
103 $file = ".$file" if ( $file =~ /^\// );
104 push(@fileList, "--exclude=$file");
107 if ( defined($conf->{BackupFilesOnly}{$t->{shareName}}) ) {
108 foreach my $file ( @{$conf->{BackupFilesOnly}{$t->{shareName}}} ) {
109 $file = ".$file" if ( $file =~ /^\// );
110 push(@fileList, $file);
113 push(@fileList, ".");
115 if ( ref($conf->{TarClientCmd}) eq "ARRAY" ) {
116 $tarClientCmd = $conf->{TarClientCmd};
118 $tarClientCmd = [split(/ +/, $conf->{TarClientCmd})];
121 if ( $t->{type} eq "full" ) {
122 $args = $conf->{TarFullArgs};
123 $logMsg = "full backup started for directory $t->{shareName}";
125 $incrDate = $bpc->timeStamp($t->{incrBaseTime} - 3600, 1);
126 $args = $conf->{TarIncrArgs};
127 $logMsg = "incr backup started back to $incrDate"
128 . " (backup #$t->{incrBaseBkupNum}) for directory"
129 . " $t->{shareName}";
131 push(@$tarClientCmd, split(/ +/, $args));
134 # Merge variables into @tarClientCmd
138 hostIP => $t->{hostIP},
139 client => $t->{client},
140 incrDate => $incrDate,
141 shareName => $t->{shareName},
142 fileList => \@fileList,
143 tarPath => $conf->{TarClientPath},
144 sshPath => $conf->{SshPath},
146 $tarClientCmd = $bpc->cmdVarSubstitute($tarClientCmd, $args);
147 if ( !defined($t->{xferPid} = open(TAR, "-|")) ) {
148 $t->{_errStr} = "Can't fork to run tar";
151 $t->{pipeTar} = *TAR;
152 if ( !$t->{xferPid} ) {
154 # This is the tar child.
157 if ( $t->{type} eq "restore" ) {
159 # For restores, close the write end of the pipe,
164 open(STDERR, ">&STDOUT");
166 open(STDIN, "<&$t->{pipeRH}");
169 # For backups, close the read end of the pipe,
170 # clone STDOUT to WH, and STDERR to STDOUT
174 open(STDERR, ">&STDOUT");
175 open(STDOUT, ">&$t->{pipeWH}");
178 # Run the tar command
181 $bpc->cmdExecOrEval($tarClientCmd, $args);
182 # should not be reached, but just in case...
183 $t->{_errStr} = "Can't exec @$tarClientCmd";
186 my $str = "Running: " . $bpc->execCmd2ShellCmd(@$tarClientCmd) . "\n";
187 $t->{XferLOG}->write(\"Running: @$tarClientCmd\n");
188 alarm($conf->{ClientTimeout});
189 $t->{_errStr} = undef;
195 my($t, $FDreadRef, $rout) = @_;
196 my $conf = $t->{conf};
198 if ( vec($rout, fileno($t->{pipeTar}), 1) ) {
200 if ( sysread($t->{pipeTar}, $mesg, 8192) <= 0 ) {
201 vec($$FDreadRef, fileno($t->{pipeTar}), 1) = 0;
202 if ( !close($t->{pipeTar}) ) {
203 $t->{tarOut} .= "Tar exited with error $? ($!) status\n";
204 $t->{xferOK} = 0 if ( !$t->{tarBadExitOk} );
207 $t->{tarOut} .= $mesg;
210 while ( $t->{tarOut} =~ /(.*?)[\n\r]+(.*)/s ) {
214 # refresh our inactivity alarm
216 alarm($conf->{ClientTimeout}) if ( !$t->{abort} );
217 $t->{lastOutputLine} = $_ if ( !/^$/ );
218 if ( /^Total bytes written: / ) {
219 $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 1 );
222 $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 2 );
226 # Ignore annoying log message on incremental for tar 1.15.x
228 if ( !/: file is unchanged; not dumped$/ ) {
229 $t->{XferLOG}->write(\"$_\n") if ( $t->{logLevel} >= 0 );
233 # If tar encounters a minor error, it will exit with a non-zero
234 # status. We still consider that ok. Remember if tar prints
235 # this message indicating a non-fatal error.
237 $t->{tarBadExitOk} = 1
238 if ( $t->{xferOK} && /Error exit delayed from previous / );
240 # Also remember files that had read errors
242 if ( /: \.\/(.*): Read error at byte / ) {
244 push(@{$t->{badFiles}}, {
245 share => $t->{shareName},
257 my($t, $reason) = @_;
258 my @xferPid = $t->xferPid;
261 $t->{abortReason} = $reason;
263 kill($t->{bpc}->sigName2num("INT"), @xferPid);
269 my($t, $FDreadRef) = @_;
271 vec($$FDreadRef, fileno($t->{pipeTar}), 1) = 1;
278 return $t->{_errStr};
285 return ($t->{xferPid});
292 push(@{$t->{_logMsg}}, $msg);
299 return shift(@{$t->{_logMsg}});
303 # Returns a hash ref giving various status information about
310 return { map { $_ => $t->{$_} }
311 qw(byteCnt fileCnt xferErrCnt xferBadShareCnt xferBadFileCnt
312 xferOK hostAbort hostError lastOutputLine)
320 return @{$t->{badFiles}};