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 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.0.0_CVS, released 3 Feb 2003.
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
97 $conf->{TarShareName} = [ $conf->{TarShareName} ]
98 unless ref($conf->{TarShareName}) eq "ARRAY";
99 foreach my $param qw(BackupFilesOnly BackupFilesExclude) {
100 next if ( !defined($conf->{$param}) );
101 if ( ref($conf->{$param}) eq "ARRAY" ) {
103 $conf->{TarShareName}[0] => $conf->{$param}
105 } elsif ( ref($conf->{$param}) eq "HASH" ) {
109 $conf->{TarShareName}[0] => [ $conf->{$param} ]
113 if ( defined($conf->{BackupFilesExclude}{$t->{shareName}}) ) {
114 foreach my $file ( @{$conf->{BackupFilesExclude}{$t->{shareName}}} )
116 $file = ".$file" if ( $file =~ /^\// );
117 push(@fileList, "--exclude=$file");
120 if ( defined($conf->{BackupFilesOnly}{$t->{shareName}}) ) {
121 foreach my $file ( @{$conf->{BackupFilesOnly}{$t->{shareName}}} ) {
122 $file = ".$file" if ( $file =~ /^\// );
123 push(@fileList, $file);
126 push(@fileList, ".");
128 if ( ref($conf->{TarClientCmd}) eq "ARRAY" ) {
129 $tarClientCmd = $conf->{TarClientCmd};
131 $tarClientCmd = [split(/ +/, $conf->{TarClientCmd})];
134 if ( $t->{type} eq "full" ) {
135 $args = $conf->{TarFullArgs};
136 $logMsg = "full backup started for directory $t->{shareName}";
138 $incrDate = $bpc->timeStampISO($t->{lastFull} - 3600, 1);
139 $args = $conf->{TarIncrArgs};
140 $logMsg = "incr backup started back to $incrDate for directory"
141 . " $t->{shareName}";
143 push(@$tarClientCmd, split(/ +/, $args));
146 # Merge variables into @tarClientCmd
150 hostIP => $t->{hostIP},
151 client => $t->{client},
152 incrDate => $incrDate,
153 shareName => $t->{shareName},
154 fileList => \@fileList,
155 tarPath => $conf->{TarClientPath},
156 sshPath => $conf->{SshPath},
158 $tarClientCmd = $bpc->cmdVarSubstitute($tarClientCmd, $args);
159 if ( !defined($t->{xferPid} = open(TAR, "-|")) ) {
160 $t->{_errStr} = "Can't fork to run tar";
163 $t->{pipeTar} = *TAR;
164 if ( !$t->{xferPid} ) {
166 # This is the tar child.
169 if ( $t->{type} eq "restore" ) {
171 # For restores, close the write end of the pipe,
176 open(STDERR, ">&STDOUT");
178 open(STDIN, "<&$t->{pipeRH}");
181 # For backups, close the read end of the pipe,
182 # clone STDOUT to WH, and STDERR to STDOUT
186 open(STDERR, ">&STDOUT");
187 open(STDOUT, ">&$t->{pipeWH}");
190 # Run the tar command
192 $bpc->cmdExecOrEval($tarClientCmd, $args);
193 # should not be reached, but just in case...
194 $t->{_errStr} = "Can't exec @$tarClientCmd";
197 my $str = "Running: " . $bpc->execCmd2ShellCmd(@$tarClientCmd) . "\n";
198 $t->{XferLOG}->write(\"Running: @$tarClientCmd\n");
199 alarm($conf->{ClientTimeout});
200 $t->{_errStr} = undef;
206 my($t, $FDreadRef, $rout) = @_;
207 my $conf = $t->{conf};
209 if ( vec($rout, fileno($t->{pipeTar}), 1) ) {
211 if ( sysread($t->{pipeTar}, $mesg, 8192) <= 0 ) {
212 vec($$FDreadRef, fileno($t->{pipeTar}), 1) = 0;
213 if ( !close($t->{pipeTar}) ) {
214 $t->{tarOut} .= "Tar exited with error $? ($!) status\n";
215 $t->{xferOK} = 0 if ( !$t->{tarBadExitOk} );
218 $t->{tarOut} .= $mesg;
221 while ( $t->{tarOut} =~ /(.*?)[\n\r]+(.*)/s ) {
224 $t->{XferLOG}->write(\"$_\n");
226 # refresh our inactivity alarm
228 alarm($conf->{ClientTimeout});
229 $t->{lastOutputLine} = $_ if ( !/^$/ );
230 if ( /^Total bytes written: / ) {
237 # If tar encounters a minor error, it will exit with a non-zero
238 # status. We still consider that ok. Remember if tar prints
239 # this message indicating a non-fatal error.
241 $t->{tarBadExitOk} = 1
242 if ( $t->{xferOK} && /Error exit delayed from previous / );
250 my($t, $FDreadRef) = @_;
252 vec($$FDreadRef, fileno($t->{pipeTar}), 1) = 1;
259 return $t->{_errStr};
266 return $t->{xferPid};
273 push(@{$t->{_logMsg}}, $msg);
280 return shift(@{$t->{_logMsg}});
284 # Returns a hash ref giving various status information about
291 return { map { $_ => $t->{$_} }
292 qw(byteCnt fileCnt xferErrCnt xferBadShareCnt xferBadFileCnt
293 xferOK hostAbort hostError lastOutputLine)
301 return @{$t->{badFiles}};