3 # makeDist: Build a BackupPC distribution
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:
13 # dist/BackupPC-$Version.tar.gz.
15 # Often the language files are not up to date, and makeDist
16 # exits after complaining about the lang files being inconsistent.
17 # Use the -l option to turn off that behavior.
20 # Craig Barratt <cbarratt@users.sourceforge.net>
23 # Copyright (C) 2001-2006 Craig Barratt
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.
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.
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
39 #========================================================================
49 my $Version = "3.0.0alpha";
50 my $ReleaseDate = "23 Jan 2006";
51 my $DistDir = "dist/BackupPC-$Version";
56 bin/BackupPC_archiveHost
57 bin/BackupPC_attribPrint
59 bin/BackupPC_fixupBackupSummary
63 bin/BackupPC_sendEmail
64 bin/BackupPC_serverMesg
65 bin/BackupPC_trashClean
66 bin/BackupPC_tarExtract
67 bin/BackupPC_tarCreate
68 bin/BackupPC_tarPCCopy
69 bin/BackupPC_compressPool
70 bin/BackupPC_zipCreate
72 lib/BackupPC/Attrib.pm
73 lib/BackupPC/Config.pm
74 lib/BackupPC/FileZIO.pm
76 lib/BackupPC/PoolWrite.pm
77 lib/BackupPC/Storage.pm
79 lib/BackupPC/CGI/AdminOptions.pm
80 lib/BackupPC/CGI/Archive.pm
81 lib/BackupPC/CGI/ArchiveInfo.pm
82 lib/BackupPC/CGI/Browse.pm
83 lib/BackupPC/CGI/DirHistory.pm
84 lib/BackupPC/CGI/EditConfig.pm
85 lib/BackupPC/CGI/EmailSummary.pm
86 lib/BackupPC/CGI/GeneralInfo.pm
87 lib/BackupPC/CGI/HostInfo.pm
88 lib/BackupPC/CGI/Lib.pm
89 lib/BackupPC/CGI/LOGlist.pm
90 lib/BackupPC/CGI/Queue.pm
91 lib/BackupPC/CGI/ReloadServer.pm
92 lib/BackupPC/CGI/RestoreFile.pm
93 lib/BackupPC/CGI/RestoreInfo.pm
94 lib/BackupPC/CGI/Restore.pm
95 lib/BackupPC/CGI/StartServer.pm
96 lib/BackupPC/CGI/StartStopBackup.pm
97 lib/BackupPC/CGI/StopServer.pm
98 lib/BackupPC/CGI/Summary.pm
99 lib/BackupPC/CGI/View.pm
100 lib/BackupPC/Config/Meta.pm
101 lib/BackupPC/Lang/de.pm
102 lib/BackupPC/Lang/en.pm
103 lib/BackupPC/Lang/es.pm
104 lib/BackupPC/Lang/fr.pm
105 lib/BackupPC/Lang/it.pm
106 lib/BackupPC/Lang/nl.pm
107 lib/BackupPC/Lang/pt_br.pm
108 lib/BackupPC/Storage/Text.pm
109 lib/BackupPC/Xfer/Archive.pm
110 lib/BackupPC/Xfer/BackupPCd.pm
111 lib/BackupPC/Xfer/Smb.pm
112 lib/BackupPC/Xfer/Tar.pm
113 lib/BackupPC/Xfer/Rsync.pm
114 lib/BackupPC/Xfer/RsyncDigest.pm
115 lib/BackupPC/Xfer/RsyncFileIO.pm
116 lib/BackupPC/Zip/FileMember.pm
117 cgi-bin/BackupPC_Admin
121 if ( !getopts("l", \%opts) || @ARGV != 0 ) {
122 print("usage: $0 [-l]\n");
127 # Check config parameters
132 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
134 $errCnt += CheckConfigParams("doc-src/BackupPC.pod", $ConfVars, 1);
137 # These config parameters are not used in the code, so ignore them.
139 $ConfVars->{BackupPCUser} = 2;
140 $ConfVars->{CgiDir} = 2;
141 $ConfVars->{InstallDir} = 2;
142 $ConfVars->{CgiImageDir} = 2;
145 # These config parameters are used in the code to be backward compatible,
146 # but are not present in the current config file, so ignore them.
148 $ConfVars->{BlackoutHourBegin} = 2;
149 $ConfVars->{BlackoutHourEnd} = 2;
150 $ConfVars->{BlackoutWeekDays} = 2;
151 $ConfVars->{RsyncLogLevel} = 2;
153 foreach my $file ( @PerlSrc ) {
154 $errCnt += CheckConfigParams($file, $ConfVars, 1);
157 $errCnt += CheckLangUsage();
158 $errCnt += CheckLangTags();
161 print("Exiting because of errors\n");
166 foreach my $var ( sort(keys(%$ConfVars) ) ) {
167 next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
168 printf("Unused config parameter $var\n");
172 print("Exiting because of errors\n");
176 rmtree($DistDir, 0, 0);
177 mkpath($DistDir, 0, 0777);
179 foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin
187 mkpath("$DistDir/$dir", 0, 0777);
191 my $ConfPod = config2pod();
193 mkpath("doc", 0, 0777);
194 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
197 pod2html("doc/BackupPC.pod",
198 "--backlink=Back to Top",
201 "--outfile=doc/BackupPC.html");
203 foreach my $file ( (@PerlSrc,
208 conf/BackupPC_stnd.css
210 init.d/src/debian-backuppc
211 init.d/src/gentoo-backuppc
212 init.d/src/gentoo-backuppc.conf
213 init.d/src/linux-backuppc
214 init.d/src/slackware-backuppc
215 init.d/src/solaris-backuppc
216 init.d/src/suse-backuppc
224 InstallFile("$file", "$DistDir/$file");
227 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
228 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
229 unlink("pod2htmd.x~~");
230 unlink("pod2htmi.x~~");
231 unlink("pod2htmd.tmp");
232 unlink("pod2htmi.tmp");
234 ###########################################################################
236 ###########################################################################
240 my($file, $dest) = @_;
242 unlink($dest) if ( -d $dest );
243 if ( $file =~ /\.gif/ ) {
244 die("can't copy($file, $dest)\n") unless copy($file, $dest);
246 open(FILE, $file) || die("can't open $file for reading\n");
247 open(OUT, ">$dest") || die("can't open $dest for writing\n");
251 s/^([#*\s]+)Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/$1Version __VERSION__, released __RELEASEDATE__./;
252 s/__VERSION__/$Version/g;
253 s/__RELEASEDATE__/$ReleaseDate/g;
254 if ( $file =~ /BackupPC\.html$/ ) {
256 # fixup for perl 5.6.x
258 if ( !/A NAME="item_(%|_)24Conf/i ) {
260 defined($ConfName{$1})
261 ? "\L<A HREF=\"#$ConfName{$1}\">\E\$Conf{$1}<\/A>"
264 s/<(A NAME="item_(%|_)24Conf(%|_)7B(.*?)(%|_)7D).*?">/\L<A NAME="item_%24Conf%7b$4%7d">/ig;
267 # Fixup for perl 5.8.x first one no longer needed after
272 # s/^(<\/dt>\n<dd>)/$1<p>/s;
276 if ( /__CONFIGPOD__/ ) {
278 } elsif ( /^use lib ".*BackupPC\/lib";/
279 || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
280 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
281 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$topDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
282 print OUT "$1'__TOPDIR__'$2\n";
283 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$installDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
284 print OUT "$1'__INSTALLDIR__'$2\n";
285 } elsif ( $file =~ /Lib.pm/ && /^(\s*my \$useFHS\s*=\s*)\d;/ ) {
286 print OUT "${1}__USEFHS__;\n";
287 } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
288 print OUT "$1'$Version',\n";
289 } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
290 print OUT "$1'__INSTALLDIR__/lib';\n";
307 open(C, "conf/config.pl") || die("can't open conf/config.pl");
309 my($str, $out, $getHdr, @conf);
314 if ( /^#########################/ ) {
317 $out .= "=back\n\n" if ( !$first );
318 $out .= "=head2 $str\n\n=over 4\n\n";
327 next if ( $str eq "" && /^$/ );
329 $str .= "\n" if ( $str =~ /examples?:\n$/i );
330 } elsif ( /^\$Conf{([^}]*)/ ) {
334 if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
335 s/([^;])\s*$/$1 .../;
338 my $text = "\$Conf{$var}";
340 $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
341 $text = substr($text, 0, 50);
342 $ConfName{$var} = "item_$text";
344 if ( $str ne "" && @conf ) {
345 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
347 $out .= "\n" if ( $str !~ /\n$/ );
353 if ( $str ne "" && @conf ) {
354 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
356 $out .= "\n" if ( $str !~ /\n$/ );
358 $out .= "=back\n\n" if ( !$first );
362 sub CheckConfigParams
364 my($file, $vars, $check) = @_;
367 open(F, $file) || die("can't open $file\n");
371 s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
372 print("Unexpected Conf var $2 in $file\n");
377 s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
378 print("Unexpected Conf var $1 in $file\n");
383 s/UserCommandRun\("([^"]*)"/if ( !defined($vars->{$1}) ) {
384 print("Unexpected Conf var $1 in $file\n");
392 s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
393 s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
401 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
402 # the strings in each lib/BackupPC/Lang/*.pm file. This makes sure
403 # we didn't miss any translations in any of the languages.
411 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
412 <lib/BackupPC/CGI/*pm>
414 open(F, $file) || die("can't open $file");
418 s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
423 foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
425 open(F, $f) || die("can't open $f\n");
431 next if ( $var =~ m{^(Reason_|Status_|backupType_)} );
432 next if ( $var eq "Documentation" );
433 if ( !defined($vars->{$var}) ) {
434 print("Unexpected Lang var $var in $f\n");
441 foreach my $v ( keys(%$vars) ) {
443 # skip "variables" with "$", since they are like expressions
445 next if ( $v =~ /\$/ );
446 if ( !defined($done->{$v}) ) {
447 print("Lang var $v missing from $f\n");
456 # Pedantically check that all the html tags in each language file
461 my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
464 foreach my $lang ( qw(fr.pm de.pm es.pm it.pm nl.pm) ) {
465 my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
466 foreach my $v1 ( @$en ) {
468 if ( $v1->{var} ne $v2->{var} ) {
469 print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
472 my $t1 = LangTextStrip($v1->{val});
473 my $t2 = LangTextStrip($v2->{val});
475 print("$v1->{var}: got en.pm $t1\nvs $lang $t2\n\n");
487 $t = "" if ( $t !~ /<.*>/ );
489 $t =~ s/([}>])[^<]*</$1</g;
491 $t =~ s/(value=)"[^"]*"/$1""/sg;
492 $t =~ s/({h[12]\()"[^"]*"/$1""/g;
493 $t =~ s/ENG[\s\n]*//sg;
494 $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
501 open(C, $file) || die("can't open $file");
503 my($out, @lang, $var);
508 if ( /^#/ && !defined($endLine) ) {
513 $allVars->{$var} = @lang if ( defined($var) );
523 } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
525 if ( defined($var) ) {
526 $allVars->{$var} = @lang if ( defined($var) );
536 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
537 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
539 $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
544 $allVars->{$var} = @lang if ( defined($var) );
551 foreach my $v ( @lang ) {
552 if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
556 return (\@lang, $allVars);