6079896de877e7892276cf2669d4b20a7cf7cced
[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.0.0";
45 my $ReleaseDate = "14 Jun 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/Lang/de.pm
66     lib/BackupPC/Lang/en.pm
67     lib/BackupPC/Lang/es.pm
68     lib/BackupPC/Lang/fr.pm
69     lib/BackupPC/PoolWrite.pm
70     lib/BackupPC/View.pm
71     lib/BackupPC/Xfer/Smb.pm
72     lib/BackupPC/Xfer/Tar.pm
73     lib/BackupPC/Xfer/Rsync.pm
74     lib/BackupPC/Xfer/RsyncFileIO.pm
75     lib/BackupPC/Zip/FileMember.pm
76     cgi-bin/BackupPC_Admin
77 );
78
79 #
80 # Check config parameters
81 #
82 my $ConfVars = {};
83 my $errCnt;
84
85 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
86 $ConfVars->{BackupPCUser} = 2;
87 $ConfVars->{CgiDir} = 2;
88 $ConfVars->{InstallDir} = 2;
89 $ConfVars->{CgiImageDir} = 2;
90 foreach my $file ( @PerlSrc ) {
91     $errCnt += CheckConfigParams($file, $ConfVars, 1);
92 }
93 $errCnt += CheckLangUsage();
94 exit(1) if ( $errCnt );
95
96 foreach my $var ( sort(keys(%$ConfVars) ) ) {
97     next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
98     printf("Unused config parameter $var\n");
99     $errCnt++;
100 }
101 exit(1) if ( $errCnt );
102
103 rmtree($DistDir, 0, 0);
104 mkpath($DistDir, 0, 0777);
105
106 foreach my $dir ( qw(bin lib/BackupPC/Xfer lib/BackupPC/Zip lib/BackupPC/Lang
107                      doc conf images init.d/src cgi-bin) ) {
108     mkpath("$DistDir/$dir", 0, 0777);
109 }
110
111 my %ConfName;
112 my $ConfPod = config2pod();
113 rmtree("doc", 0, 0);
114 mkpath("doc", 0, 0777);
115 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
116
117 use Pod::Html;
118 pod2html("doc/BackupPC.pod",
119         "--backlink=Back to Top",
120         "--header",
121         "--title=BackupPC",
122         "--outfile=doc/BackupPC.html");
123
124 foreach my $file ( (@PerlSrc,
125             <images/*>,
126             qw(
127                 conf/config.pl
128                 conf/hosts
129                 init.d/README
130                 init.d/src/debian-backuppc
131                 init.d/src/gentoo-backuppc
132                 init.d/src/gentoo-backuppc.conf
133                 init.d/src/linux-backuppc
134                 init.d/src/solaris-backuppc
135                 init.d/src/suse-backuppc
136                 doc/BackupPC.pod
137                 doc/BackupPC.html
138                 README
139                 LICENSE
140                 ChangeLog
141                 configure.pl
142         )) ) {
143     InstallFile("$file", "$DistDir/$file");
144 }
145 rmtree("doc", 0, 0);
146 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
147 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
148 unlink("pod2htmd.x~~");
149 unlink("pod2htmi.x~~");
150
151 ###########################################################################
152 # Subroutines
153 ###########################################################################
154
155 sub InstallFile
156 {
157     my($file, $dest) = @_;
158
159     unlink($dest) if ( -d $dest );
160     if ( $file =~ /\.gif/ ) {
161         die("can't copy($file, $dest)\n") unless copy($file, $dest);
162     } else {
163         open(FILE, $file)   || die("can't open $file for reading\n");
164         open(OUT, ">$dest") || die("can't open $dest for writing\n");
165         binmode(FILE);
166         binmode(OUT);
167         while ( <FILE> ) {
168             s/^# *Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/# Version __VERSION__, released __RELEASEDATE__./;
169             s/__VERSION__/$Version/g;
170             s/__RELEASEDATE__/$ReleaseDate/g;
171             if ( $file =~ /BackupPC\.html$/ && !/A NAME="item_%24Conf/ ) {
172                 s/\$Conf{([^}]*)}/
173                         defined($ConfName{$1})
174                             ? "<A HREF=\"#$ConfName{$1}\">\$Conf{$1}<\/A>"
175                             : "\$Conf{$1}"/eg;
176             }
177             if ( /__CONFIGPOD__/ ) {
178                 print OUT $ConfPod;
179             } elsif ( /^use lib ".*BackupPC\/lib";/
180                     || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
181                 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
182             } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
183                 print OUT "$1'__TOPDIR__',\n";
184             } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
185                 print OUT "$1'$Version',\n";
186             } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
187                 print OUT "$1'__INSTALLDIR__',\n";
188             } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
189                 print OUT "$1'__INSTALLDIR__',\n";
190             } else {
191                 print OUT;
192             }
193         }
194         close(FILE);
195         close(OUT);
196     }
197     if ( -x $file ) {
198         chmod(0555, $dest);
199     } else {
200         chmod(0444, $dest);
201     }
202 }
203
204 sub config2pod
205 {
206     open(C, "conf/config.pl") || die("can't open conf/config.pl");
207     binmode(C);
208     my($str, $out, $getHdr, @conf);
209     my $first = 1;
210     while ( <C> ) {
211         chomp;
212         s/ +$//;
213         if ( /^#########################/ ) {
214             if ( $getHdr ) {
215                 $str =~ s/\n.*//sg;
216                 $out .= "=back\n\n" if ( !$first );
217                 $out .= "=head2 $str\n\n=over 4\n\n";
218                 $str = "";
219                 $first = 0;
220             }
221             $getHdr = !$getHdr;
222             next;
223         }
224         if ( /^#/ ) {
225             s/# ?//;
226             next if ( $str eq "" && /^$/ );
227             $str .= $_ . "\n";
228             $str .= "\n" if ( $str =~ /examples?:\n$/i );
229         } elsif ( /^\$Conf{([^}]*)/ ) {
230             my $var = $1;
231             s/  +/ /g;
232             s/;\s*#.*/;/;
233             if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
234                 s/([^;])\s*$/$1 .../;
235             }
236             push(@conf, $_);
237             my $text = $_;
238             $text =~ s/\s+/_/sg;
239             $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
240             $text = substr($text, 0, 50);
241             $ConfName{$var} = "item_$text";
242         } elsif ( /^$/ ) {
243             if ( $str ne "" && @conf ) {
244                 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
245                 $out .= $str;
246                 $out .= "\n" if ( $str !~ /\n$/ );
247             }
248             $str = "";
249             @conf = ();
250         }
251     }
252     if ( $str ne "" && @conf ) {
253         $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
254         $out .= $str;
255         $out .= "\n" if ( $str !~ /\n$/ );
256     }
257     $out .= "=back\n\n" if ( !$first );
258     return $out;
259 }
260
261 sub CheckConfigParams
262 {
263     my($file, $vars, $check) = @_;
264     my $errors;
265
266     open(F, $file) || die("can't open $file\n");
267     binmode(F);
268     if ( $check ) {
269         while ( <F> ) {
270             s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
271                     print("Unexpected Conf var $2 in $file\n");
272                     $errors++;
273                 } else {
274                     $vars->{$2}++;
275                 }/eg;
276             s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
277                     print("Unexpected Conf var $1 in $file\n");
278                     $errors++;
279                 } else {
280                     $vars->{$1}++;
281                 }/eg;
282             s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
283                     print("Unexpected Conf var $1 in $file\n");
284                     $errors++;
285                 } else {
286                     $vars->{$1}++;
287                 }/eg;
288         }
289     } else {
290         while ( <F> ) {
291             s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
292             s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
293         }
294     }
295     close(F);
296     return $errors;
297 }
298
299 #
300 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
301 # the strings in each lib/BackupPC/Lang/*.pm file.  This makes sure
302 # we didn't miss any translations in any of the languages.
303 #
304 sub CheckLangUsage
305 {
306     my $errors;
307     my $vars = {};
308
309     foreach my $file ( qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail) ) {
310         open(F, $file) || die("can't open $file");
311         binmode(F);
312         while ( <F> ) {
313             s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
314         }
315         close(F);
316     }
317     foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
318         my $done = {};
319         open(F, $f) || die("can't open $f\n");
320         binmode(F);
321         while ( <F> ) {
322             s/#.*//g;
323             s/\$Lang{([^}]*)}/
324                     my $var = $1;
325                     next if ( $var =~ m{^(Reason_|Status_)} );
326                     if ( !defined($vars->{$var}) ) {
327                         print("Unexpected Lang var $var in $f\n");
328                         $errors++;
329                     } else {
330                         $done->{$var} = 1;
331                     }/eg;
332         }
333         close(F);
334         foreach my $v ( keys(%$vars) ) {
335             #
336             # skip "variables" with "$", since they are like expressions
337             #
338             next if ( $v =~ /\$/ );
339             if ( !defined($done->{$v}) ) {
340                 print("Lang var $v missing from $f\n");
341                 $errors++;
342             }
343         }
344     }
345     return $errors;
346 }