fix
[BackupPC.git] / bin / BackupPC_archiveHost
1 #!/usr/bin/perl
2 #=============================================================
3 #
4 # BackupPC_archiveHost: Archive files for a single host
5 #
6 # DESCRIPTION
7 #
8 #   Usage: BackupPC_archiveHost tarCreatePath splitPath parPath host bkupNum \
9 #               compPath fileExt splitSize outLoc parFile share
10 #
11 #   This script is run for each host to create an archive.
12 #
13 #   This script is executed by BackupPC_archive, based on the setting
14 #   of $Conf{ArchiveClientCmd}.  This script can be copied and modified
15 #   for site-specific behavior.  Update $Conf{ArchiveClientCmd} to point
16 #   at your customized archive script.
17 #
18 # AUTHOR
19 #   Craig Barratt  <cbarratt@users.sourceforge.net>
20 #   Josh Marshall
21 #
22 # COPYRIGHT
23 #   Copyright (C) 2001-2009  Craig Barratt
24 #
25 #   This program is free software; you can redistribute it and/or modify
26 #   it under the terms of the GNU General Public License as published by
27 #   the Free Software Foundation; either version 2 of the License, or
28 #   (at your option) any later version.
29 #
30 #   This program is distributed in the hope that it will be useful,
31 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
32 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33 #   GNU General Public License for more details.
34 #
35 #   You should have received a copy of the GNU General Public License
36 #   along with this program; if not, write to the Free Software
37 #   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
38 #
39 #========================================================================
40 #
41 # Version 3.2.0, released 31 Jul 2010.
42 #
43 # See http://backuppc.sourceforge.net.
44 #
45 #========================================================================
46
47 use strict;
48 use File::Path;
49 use lib "/usr/local/BackupPC/lib";
50 use BackupPC::Lib;
51
52 #
53 # Pick up the command-line arguments
54 #
55 if ( @ARGV != 11 ) {
56     print <<EOF;
57 Usage: $0 tarCreatePath splitPath parPath host bkupNum \\
58           compPath fileExt splitSize outLoc parFile share
59 EOF
60     exit(1);
61 }
62 my $tarCreate    = $ARGV[0];
63 my $splitPath    = $ARGV[1];
64 my $parPath      = $ARGV[2];
65 my $host         = $ARGV[3];
66 my $bkupNum      = $ARGV[4];
67 my $compPath     = $ARGV[5];
68 my $fileExt      = $ARGV[6];
69 my $splitSize    = $ARGV[7];
70 my $outLoc       = $ARGV[8];
71 my $parfile      = $ARGV[9];
72 my $share        = $ARGV[10];
73
74 die("BackupPC::Lib->new failed\n") if ( !(my $bpc = BackupPC::Lib->new) );
75
76 #
77 # Make sure the specified programs are executable
78 #
79 foreach my $prog ( ($tarCreate, $compPath, $splitPath, $parPath) ) {
80     if ( $prog =~ /[][;&()<>{}|^\n\r\t *\$\\'"`?]/ ) {
81         print("Error: executable path $prog contains suspicious characters\n");
82         exit(1);
83     }
84     next if ( $prog eq "" || -x $prog );
85     print("Error: $prog is not an executable program\n");
86     exit(1);
87 }
88 my $mesg = "Writing tar archive for host $host, backup #$bkupNum";
89
90 #
91 # Build the command we will run
92 #
93 $share       = $bpc->shellEscape($share);
94 $host        = $bpc->shellEscape($host);
95 $bkupNum     = $bpc->shellEscape($bkupNum);
96 $fileExt     = $bpc->shellEscape($fileExt);
97 $splitSize   = $bpc->shellEscape($splitSize);
98 $parfile     = $bpc->shellEscape($parfile);
99 my $outLocE  = $bpc->shellEscape($outLoc);
100
101 #
102 # We prefer to use /bin/csh because the exit status of a pipeline
103 # is non-zero if any command is non zero.  In contrast, /bin/sh
104 # and /bin/bash use the convention that the exit status is just
105 # the exit status of the last command of the pipeline.
106 #
107 my @shell;
108 if ( -x "/bin/csh" ) {
109     @shell = ("/bin/csh", "-cf");
110 } elsif ( -x "/bin/sh" ) {
111     @shell = ("/bin/sh", "-c");
112 } else {
113     print("Error: Can't find executable /bin/csh or /bin/sh\n");
114     exit(1);
115 }
116 my $cmd = "$tarCreate -t -h $host -n $bkupNum -s $share . ";
117 $cmd   .= "| $compPath " if ( $compPath ne "cat"
118                            && $compPath ne "/bin/cat"
119                            && $compPath ne "" );
120 if ( -b $outLoc || -c $outLoc || -f $outLoc ) {
121     #
122     # Output file is a device or a regular file, so don't use split
123     #
124     $cmd  .= ">> $outLocE";
125     $mesg .= " to $outLoc";
126 } else {
127     mkpath($outLoc) if ( !-d $outLoc );
128     if ( !-d $outLoc ) {
129         print("Error: unable to create output directory $outLoc\n");
130         exit(1);
131     }
132     if ( $splitSize > 0 && -x $splitPath ) {
133         $cmd  .= "| $splitPath -b $splitSize - $outLocE/$host.$bkupNum.tar$fileExt.";
134         $mesg .= ", split to output files $outLocE/$host.$bkupNum.tar$fileExt.*";
135     } else {
136         $cmd  .= "> $outLocE/$host.$bkupNum.tar$fileExt";
137         $mesg .= " to output file $outLocE/$host.$bkupNum.tar$fileExt";
138     }
139 }
140 print("$mesg\n");
141
142 #
143 # Run the command
144 #
145 my $ret = system(@shell, $cmd);
146 if ( $ret ) {
147     print("Executing: @shell $cmd\n");
148     print("Error: $tarCreate, compress or split failed\n");
149     exit(1);
150 }
151
152 #
153 # Run optional parity file generation (only if the output is a directory,
154 # ie: not a tape device).
155 #
156 if ( -d $outLoc && -x $parPath ) {
157     if ( length($parfile) ) {
158         print("Running $parPath to create parity files\n");
159         my $parCmd = "$parPath c -r$parfile $outLocE/$host.$bkupNum.tar$fileExt.par2 $outLocE/$host.$bkupNum.tar$fileExt*";
160         $ret = system($parCmd);
161         if ( $ret ) {
162             print("Executing: $parCmd\n");
163             print("Error: $parPath failed\n");
164             exit(1);
165         }
166     }
167 }