* A failed full dump is now saved as a partial (incomplete) dump,
[BackupPC.git] / makeDist
1 #!/bin/perl
2 #
3 # makeDist: Build a BackupPC distribution
4 #
5 # DESCRIPTION
6 #
7 #   This script should be run with no arguments to build a
8 #   distribution.  The $Version and $ReleaseDate should be
9 #   edited below to specify the version name and the release
10 #   date.  The distribution is createede in the sub-directory
11 #   dist.  The dsitribution is in the file name:
12 #
13 #           dist/BackupPC-$Version.tar.gz.
14 #
15 # AUTHOR
16 #   Craig Barratt <cbarratt@users.sourceforge.net>
17 #
18 # COPYRIGHT
19 #   Copyright (C) 2001-2003  Craig Barratt
20 #
21 #   This program is free software; you can redistribute it and/or modify
22 #   it under the terms of the GNU General Public License as published by
23 #   the Free Software Foundation; either version 2 of the License, or
24 #   (at your option) any later version.
25 #
26 #   This program is distributed in the hope that it will be useful,
27 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
28 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29 #   GNU General Public License for more details.
30 #
31 #   You should have received a copy of the GNU General Public License
32 #   along with this program; if not, write to the Free Software
33 #   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
34 #
35 #========================================================================
36 #
37
38 use strict;
39 use File::Path;
40 use File::Copy;
41
42 umask(0022);
43
44 my $Version     = "2.1.0_CVS";
45 my $ReleaseDate = "3 Jul 2003";
46 my $DistDir     = "dist/BackupPC-$Version";
47
48 my @PerlSrc = qw(
49     bin/BackupPC
50     bin/BackupPC_dump
51     bin/BackupPC_link
52     bin/BackupPC_nightly
53     bin/BackupPC_restore
54     bin/BackupPC_sendEmail
55     bin/BackupPC_serverMesg
56     bin/BackupPC_trashClean
57     bin/BackupPC_tarExtract
58     bin/BackupPC_tarCreate
59     bin/BackupPC_compressPool
60     bin/BackupPC_zipCreate
61     bin/BackupPC_zcat
62     lib/BackupPC/Attrib.pm
63     lib/BackupPC/FileZIO.pm
64     lib/BackupPC/Lib.pm
65     lib/BackupPC/PoolWrite.pm
66     lib/BackupPC/View.pm
67     lib/BackupPC/CGI/Browse.pm
68     lib/BackupPC/CGI/DirHistory.pm
69     lib/BackupPC/CGI/EmailSummary.pm
70     lib/BackupPC/CGI/GeneralInfo.pm
71     lib/BackupPC/CGI/HostInfo.pm
72     lib/BackupPC/CGI/Lib.pm
73     lib/BackupPC/CGI/LOGlist.pm
74     lib/BackupPC/CGI/Queue.pm
75     lib/BackupPC/CGI/RestoreFile.pm
76     lib/BackupPC/CGI/RestoreInfo.pm
77     lib/BackupPC/CGI/Restore.pm
78     lib/BackupPC/CGI/StartStopBackup.pm
79     lib/BackupPC/CGI/Summary.pm
80     lib/BackupPC/CGI/View.pm
81     lib/BackupPC/Lang/de.pm
82     lib/BackupPC/Lang/en.pm
83     lib/BackupPC/Lang/es.pm
84     lib/BackupPC/Lang/fr.pm
85     lib/BackupPC/Xfer/Smb.pm
86     lib/BackupPC/Xfer/Tar.pm
87     lib/BackupPC/Xfer/Rsync.pm
88     lib/BackupPC/Xfer/RsyncFileIO.pm
89     lib/BackupPC/Zip/FileMember.pm
90     cgi-bin/BackupPC_Admin
91 );
92
93 #
94 # Check config parameters
95 #
96 my $ConfVars = {};
97 my $errCnt;
98
99 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
100 $ConfVars->{BackupPCUser} = 2;
101 $ConfVars->{CgiDir} = 2;
102 $ConfVars->{InstallDir} = 2;
103 $ConfVars->{CgiImageDir} = 2;
104 foreach my $file ( @PerlSrc ) {
105     $errCnt += CheckConfigParams($file, $ConfVars, 1);
106 }
107 $errCnt += CheckLangUsage();
108 exit(1) if ( $errCnt );
109
110 foreach my $var ( sort(keys(%$ConfVars) ) ) {
111     next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
112     printf("Unused config parameter $var\n");
113     $errCnt++;
114 }
115 exit(1) if ( $errCnt );
116
117 rmtree($DistDir, 0, 0);
118 mkpath($DistDir, 0, 0777);
119
120 foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin
121                      lib/BackupPC/CGI
122                      lib/BackupPC/Lang
123                      lib/BackupPC/Xfer
124                      lib/BackupPC/Zip
125                 ) ) {
126     mkpath("$DistDir/$dir", 0, 0777);
127 }
128
129 my %ConfName;
130 my $ConfPod = config2pod();
131 rmtree("doc", 0, 0);
132 mkpath("doc", 0, 0777);
133 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
134
135 use Pod::Html;
136 pod2html("doc/BackupPC.pod",
137         "--backlink=Back to Top",
138         "--header",
139         "--title=BackupPC",
140         "--outfile=doc/BackupPC.html");
141
142 foreach my $file ( (@PerlSrc,
143             <images/*>,
144             qw(
145                 conf/config.pl
146                 conf/hosts
147                 init.d/README
148                 init.d/src/debian-backuppc
149                 init.d/src/gentoo-backuppc
150                 init.d/src/gentoo-backuppc.conf
151                 init.d/src/linux-backuppc
152                 init.d/src/solaris-backuppc
153                 init.d/src/suse-backuppc
154                 doc/BackupPC.pod
155                 doc/BackupPC.html
156                 README
157                 LICENSE
158                 ChangeLog
159                 configure.pl
160         )) ) {
161     InstallFile("$file", "$DistDir/$file");
162 }
163 rmtree("doc", 0, 0);
164 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
165 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
166 unlink("pod2htmd.x~~");
167 unlink("pod2htmi.x~~");
168
169 ###########################################################################
170 # Subroutines
171 ###########################################################################
172
173 sub InstallFile
174 {
175     my($file, $dest) = @_;
176
177     unlink($dest) if ( -d $dest );
178     if ( $file =~ /\.gif/ ) {
179         die("can't copy($file, $dest)\n") unless copy($file, $dest);
180     } else {
181         open(FILE, $file)   || die("can't open $file for reading\n");
182         open(OUT, ">$dest") || die("can't open $dest for writing\n");
183         binmode(FILE);
184         binmode(OUT);
185         while ( <FILE> ) {
186             s/^# *Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/# Version __VERSION__, released __RELEASEDATE__./;
187             s/__VERSION__/$Version/g;
188             s/__RELEASEDATE__/$ReleaseDate/g;
189             if ( $file =~ /BackupPC\.html$/ && !/A NAME="item_%24Conf/ ) {
190                 s/\$Conf{([^}]*)}/
191                         defined($ConfName{$1})
192                             ? "<A HREF=\"#$ConfName{$1}\">\$Conf{$1}<\/A>"
193                             : "\$Conf{$1}"/eg;
194             }
195             if ( /__CONFIGPOD__/ ) {
196                 print OUT $ConfPod;
197             } elsif ( /^use lib ".*BackupPC\/lib";/
198                     || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
199                 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
200             } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
201                 print OUT "$1'__TOPDIR__',\n";
202             } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
203                 print OUT "$1'$Version',\n";
204             } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
205                 print OUT "$1'__INSTALLDIR__',\n";
206             } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
207                 print OUT "$1'__INSTALLDIR__',\n";
208             } else {
209                 print OUT;
210             }
211         }
212         close(FILE);
213         close(OUT);
214     }
215     if ( -x $file ) {
216         chmod(0555, $dest);
217     } else {
218         chmod(0444, $dest);
219     }
220 }
221
222 sub config2pod
223 {
224     open(C, "conf/config.pl") || die("can't open conf/config.pl");
225     binmode(C);
226     my($str, $out, $getHdr, @conf);
227     my $first = 1;
228     while ( <C> ) {
229         chomp;
230         s/ +$//;
231         if ( /^#########################/ ) {
232             if ( $getHdr ) {
233                 $str =~ s/\n.*//sg;
234                 $out .= "=back\n\n" if ( !$first );
235                 $out .= "=head2 $str\n\n=over 4\n\n";
236                 $str = "";
237                 $first = 0;
238             }
239             $getHdr = !$getHdr;
240             next;
241         }
242         if ( /^#/ ) {
243             s/# ?//;
244             next if ( $str eq "" && /^$/ );
245             $str .= $_ . "\n";
246             $str .= "\n" if ( $str =~ /examples?:\n$/i );
247         } elsif ( /^\$Conf{([^}]*)/ ) {
248             my $var = $1;
249             s/  +/ /g;
250             s/;\s*#.*/;/;
251             if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
252                 s/([^;])\s*$/$1 .../;
253             }
254             push(@conf, $_);
255             my $text = $_;
256             $text =~ s/\s+/_/sg;
257             $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
258             $text = substr($text, 0, 50);
259             $ConfName{$var} = "item_$text";
260         } elsif ( /^$/ ) {
261             if ( $str ne "" && @conf ) {
262                 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
263                 $out .= $str;
264                 $out .= "\n" if ( $str !~ /\n$/ );
265             }
266             $str = "";
267             @conf = ();
268         }
269     }
270     if ( $str ne "" && @conf ) {
271         $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
272         $out .= $str;
273         $out .= "\n" if ( $str !~ /\n$/ );
274     }
275     $out .= "=back\n\n" if ( !$first );
276     return $out;
277 }
278
279 sub CheckConfigParams
280 {
281     my($file, $vars, $check) = @_;
282     my $errors;
283
284     open(F, $file) || die("can't open $file\n");
285     binmode(F);
286     if ( $check ) {
287         while ( <F> ) {
288             s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
289                     print("Unexpected Conf var $2 in $file\n");
290                     $errors++;
291                 } else {
292                     $vars->{$2}++;
293                 }/eg;
294             s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
295                     print("Unexpected Conf var $1 in $file\n");
296                     $errors++;
297                 } else {
298                     $vars->{$1}++;
299                 }/eg;
300             s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
301                     print("Unexpected Conf var $1 in $file\n");
302                     $errors++;
303                 } else {
304                     $vars->{$1}++;
305                 }/eg;
306         }
307     } else {
308         while ( <F> ) {
309             s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
310             s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
311         }
312     }
313     close(F);
314     return $errors;
315 }
316
317 #
318 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
319 # the strings in each lib/BackupPC/Lang/*.pm file.  This makes sure
320 # we didn't miss any translations in any of the languages.
321 #
322 sub CheckLangUsage
323 {
324     my $errors;
325     my $vars = {};
326
327     foreach my $file ( (
328                 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
329                 <lib/BackupPC/CGI/*pm>
330             ) ) {
331         open(F, $file) || die("can't open $file");
332         binmode(F);
333         while ( <F> ) {
334             s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
335         }
336         close(F);
337     }
338     foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
339         my $done = {};
340         open(F, $f) || die("can't open $f\n");
341         binmode(F);
342         while ( <F> ) {
343             s/#.*//g;
344             s/\$Lang{([^}]*)}/
345                     my $var = $1;
346                     next if ( $var =~ m{^(Reason_|Status_)} );
347                     if ( !defined($vars->{$var}) ) {
348                         print("Unexpected Lang var $var in $f\n");
349                         $errors++;
350                     } else {
351                         $done->{$var} = 1;
352                     }/eg;
353         }
354         close(F);
355         foreach my $v ( keys(%$vars) ) {
356             #
357             # skip "variables" with "$", since they are like expressions
358             #
359             next if ( $v =~ /\$/ );
360             if ( !defined($done->{$v}) ) {
361                 print("Lang var $v missing from $f\n");
362                 $errors++;
363             }
364         }
365     }
366     return $errors;
367 }