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-2007 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 #========================================================================
48 use BackupPC::Config::Meta qw(:all);
51 die("BackupPC::Lib->new failed\n")
52 if ( !($bpc = BackupPC::Lib->new(".", ".", "./conf", 1)) );
56 my $Version = "3.2.0";
57 my $ReleaseDate = "31 Dec 2008";
58 my $DistDir = "dist/BackupPC-$Version";
63 bin/BackupPC_archiveHost
64 bin/BackupPC_archiveStart
65 bin/BackupPC_attribPrint
67 bin/BackupPC_fixupBackupSummary
71 bin/BackupPC_sendEmail
72 bin/BackupPC_serverMesg
73 bin/BackupPC_trashClean
74 bin/BackupPC_tarExtract
75 bin/BackupPC_tarCreate
76 bin/BackupPC_tarPCCopy
77 bin/BackupPC_compressPool
78 bin/BackupPC_zipCreate
80 lib/BackupPC/Attrib.pm
81 lib/BackupPC/Config.pm
82 lib/BackupPC/FileZIO.pm
84 lib/BackupPC/PoolWrite.pm
85 lib/BackupPC/Storage.pm
87 lib/BackupPC/CGI/AdminOptions.pm
88 lib/BackupPC/CGI/Archive.pm
89 lib/BackupPC/CGI/ArchiveInfo.pm
90 lib/BackupPC/CGI/Browse.pm
91 lib/BackupPC/CGI/DirHistory.pm
92 lib/BackupPC/CGI/EditConfig.pm
93 lib/BackupPC/CGI/EmailSummary.pm
94 lib/BackupPC/CGI/GeneralInfo.pm
95 lib/BackupPC/CGI/HostInfo.pm
96 lib/BackupPC/CGI/Lib.pm
97 lib/BackupPC/CGI/LOGlist.pm
98 lib/BackupPC/CGI/Queue.pm
99 lib/BackupPC/CGI/ReloadServer.pm
100 lib/BackupPC/CGI/RestoreFile.pm
101 lib/BackupPC/CGI/RestoreInfo.pm
102 lib/BackupPC/CGI/Restore.pm
103 lib/BackupPC/CGI/RSS.pm
104 lib/BackupPC/CGI/StartServer.pm
105 lib/BackupPC/CGI/StartStopBackup.pm
106 lib/BackupPC/CGI/StopServer.pm
107 lib/BackupPC/CGI/Summary.pm
108 lib/BackupPC/CGI/View.pm
109 lib/BackupPC/Config/Meta.pm
110 lib/BackupPC/Lang/de.pm
111 lib/BackupPC/Lang/en.pm
112 lib/BackupPC/Lang/es.pm
113 lib/BackupPC/Lang/fr.pm
114 lib/BackupPC/Lang/it.pm
115 lib/BackupPC/Lang/nl.pm
116 lib/BackupPC/Lang/pl.pm
117 lib/BackupPC/Lang/pt_br.pm
118 lib/BackupPC/Lang/zh_CN.pm
119 lib/BackupPC/Storage/Text.pm
121 lib/BackupPC/Xfer/Archive.pm
122 lib/BackupPC/Xfer/BackupPCd.pm
123 lib/BackupPC/Xfer/Ftp.pm
124 lib/BackupPC/Xfer/Protocol.pm
125 lib/BackupPC/Xfer/Rsync.pm
126 lib/BackupPC/Xfer/RsyncDigest.pm
127 lib/BackupPC/Xfer/RsyncFileIO.pm
128 lib/BackupPC/Xfer/Smb.pm
129 lib/BackupPC/Xfer/Tar.pm
130 lib/BackupPC/Zip/FileMember.pm
131 lib/Net/FTP/AutoReconnect.pm
132 lib/Net/FTP/RetrHandle.pm
133 cgi-bin/BackupPC_Admin
137 if ( !getopts("l", \%opts) || @ARGV != 0 ) {
138 print("usage: $0 [-l]\n");
143 # Check config parameters
148 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
150 $errCnt += CheckConfigParams("doc-src/BackupPC.pod", $ConfVars, 1);
152 $errCnt += CheckMetaDataVsConfig($ConfVars, "lib/BackupPC/Config/Meta.pm");
154 $errCnt += CheckEditorVsConfig($ConfVars, "lib/BackupPC/CGI/EditConfig.pm");
157 # These config parameters are not used in the code, so ignore them.
159 $ConfVars->{BackupPCUser} = 2;
160 $ConfVars->{CgiDir} = 2;
161 $ConfVars->{TopDir} = 2;
162 $ConfVars->{LogDir} = 2;
163 $ConfVars->{ConfDir} = 2;
164 $ConfVars->{InstallDir} = 2;
165 $ConfVars->{CgiImageDir} = 2;
166 $ConfVars->{ClientCharsetLegacy} = 2; # actually used
169 # These config parameters are used in the code to be backward compatible,
170 # but are not present in the current config file, so ignore them.
172 $ConfVars->{BlackoutHourBegin} = 2;
173 $ConfVars->{BlackoutHourEnd} = 2;
174 $ConfVars->{BlackoutWeekDays} = 2;
175 $ConfVars->{RsyncLogLevel} = 2;
177 system("perl -Ilib -c conf/config.pl >& /dev/null")
178 && die("$0: conf/config.pl contains a syntax error\n");
179 foreach my $file ( @PerlSrc ) {
180 system("perl -Ilib -c $file >& /dev/null")
181 && die("$0: $file contains a syntax error\n");
182 $errCnt += CheckConfigParams($file, $ConfVars, 1);
185 $errCnt += CheckLangUsage();
186 $errCnt += CheckLangTags();
189 print("Exiting because of errors\n");
194 foreach my $var ( sort(keys(%$ConfVars) ) ) {
195 next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
196 printf("Unused config parameter $var\n");
200 print("Exiting because of errors\n");
204 rmtree($DistDir, 0, 0);
205 mkpath($DistDir, 0, 0777);
207 foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin httpd/src
216 mkpath("$DistDir/$dir", 0, 0777);
220 my $ConfPod = config2pod();
222 mkpath("doc", 0, 0777);
223 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
226 pod2html("doc/BackupPC.pod",
227 "--backlink=Back to Top",
230 "--outfile=doc/BackupPC.html");
232 foreach my $file ( (@PerlSrc,
238 conf/BackupPC_stnd.css
239 conf/BackupPC_stnd_orig.css
242 init.d/src/debian-backuppc
243 init.d/src/freebsd-backuppc
244 init.d/src/gentoo-backuppc
245 init.d/src/gentoo-backuppc.conf
246 init.d/src/linux-backuppc
247 init.d/src/slackware-backuppc
248 init.d/src/solaris-backuppc
249 init.d/src/suse-backuppc
250 httpd/src/BackupPC.conf
258 InstallFile("$file", "$DistDir/$file");
261 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
262 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
263 unlink("pod2htmd.x~~");
264 unlink("pod2htmi.x~~");
265 unlink("pod2htmd.tmp");
266 unlink("pod2htmi.tmp");
268 ###########################################################################
270 ###########################################################################
274 my($file, $dest) = @_;
276 unlink($dest) if ( -d $dest );
277 if ( $file =~ /\.gif/ || $file =~ /\.png/ ) {
278 die("can't copy($file, $dest)\n") unless copy($file, $dest);
280 open(FILE, $file) || die("can't open $file for reading\n");
281 open(OUT, ">$dest") || die("can't open $dest for writing\n");
285 s/^([#*\s]+)Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/$1Version __VERSION__, released __RELEASEDATE__./;
286 s/__VERSION__/$Version/g;
287 s/__RELEASEDATE__/$ReleaseDate/g;
288 if ( $file =~ /BackupPC\.html$/ ) {
290 # fixup for conf links
292 if ( !/A NAME="item_(%|_)conf/i ) {
294 defined($ConfName{$1})
295 ? "\L<a href=\"#$ConfName{$1}\">\E\$Conf{$1}<\/A>"
301 if ( /__CONFIGPOD__/ ) {
303 } elsif ( /^use lib ".*BackupPC\/lib";/
304 || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
305 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
306 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$topDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
307 print OUT "$1'__TOPDIR__'$2\n";
308 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$installDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
309 print OUT "$1'__INSTALLDIR__'$2\n";
310 } elsif ( $file =~ /Lib.pm/ && /^(\s*ConfDir\s*=\>\s*\$confDir eq.*)'.*'(.*)/ ) {
311 print OUT "$1'__CONFDIR__'$2\n";
312 } elsif ( $file =~ /Lib.pm/ && /^(\s*my \$useFHS\s*=\s*)\d;/ ) {
313 print OUT "${1}0;\n";
314 } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
315 print OUT "$1'$Version',\n";
316 } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_BIN_LIST__/ ) {
317 print OUT " ", join("\n ", grep(/^bin\//, @PerlSrc)), "\n";
318 } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_LIB_LIST__/ ) {
319 print OUT " ", join("\n ", grep(/^lib\//, @PerlSrc)), "\n";
320 } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
321 print OUT "$1'__INSTALLDIR__/lib';\n";
338 open(C, "conf/config.pl") || die("can't open conf/config.pl");
340 my($str, $out, $getHdr, @conf);
345 if ( /^#########################/ ) {
348 $out .= "=back\n\n" if ( !$first );
349 $out .= "=head2 $str\n\n=over 4\n\n";
358 next if ( $str eq "" && /^$/ );
360 $str .= "\n" if ( $str =~ /examples?:\n$/i );
361 } elsif ( /^\$Conf{([^}]*)/ ) {
365 if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
366 s/([^;])\s*$/$1 .../;
369 my $text = "_conf_${var}_";
370 $text =~ s{[\W\s]}{_}g;
371 $ConfName{$var} = "item_$text";
373 if ( $str ne "" && @conf ) {
374 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
376 $out .= "\n" if ( $str !~ /\n$/ );
382 if ( $str ne "" && @conf ) {
383 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
385 $out .= "\n" if ( $str !~ /\n$/ );
387 $out .= "=back\n\n" if ( !$first );
391 sub CheckConfigParams
393 my($file, $vars, $check) = @_;
396 open(F, $file) || die("can't open $file\n");
400 s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
401 print("Unexpected Conf var $2 in $file\n");
406 s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
407 print("Unexpected Conf var $1 in $file\n");
412 s/UserCommandRun\("([^"]*)"/if ( !defined($vars->{$1}) ) {
413 print("Unexpected Conf var $1 in $file\n");
421 s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
422 s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
429 sub CheckMetaDataVsConfig
431 my($confVars, $file) = @_;
436 # Check that the meta file mentions all the config
439 open(F, $file) || die("can't open $file");
442 next if ( !/^\s{4}(\w+)\s+=>/ );
443 if ( $confVars->{$1} ) {
447 next if ( $1 eq "Hosts" );
448 print("$file has $1 but missing from conf/config.pl\n");
452 foreach my $v ( keys(%$confVars) ) {
453 next if ( $done->{$v} );
454 print("$file missing $v from conf/config.pl\n");
459 # Do extra checks that the CgiUserConfigEdit hash in the Meta
460 # file matches the config file
462 foreach my $p ( keys(%{$ConfigMeta{CgiUserConfigEdit}{child}}) ) {
463 if ( !defined($bpc->{Conf}{CgiUserConfigEdit}{$p}) ) {
464 print("lib/BackupPC/Config/Meta.pm has $p in CgiUserConfigEdit,"
465 . " but conf/config.pl CgiUserConfigEdit does not\n");
469 foreach my $p ( keys(%{$bpc->{Conf}{CgiUserConfigEdit}}) ) {
470 if ( !defined($ConfigMeta{CgiUserConfigEdit}{child}{$p}) ) {
471 print("conf/config.pl CgiUserConfigEdit has $p, but"
472 . " lib/BackupPC/Config/Meta.pm does not\n");
479 sub CheckEditorVsConfig
481 my($confVars, $file) = @_;
486 # Check that the config editor file mentions all the config
489 open(F, $file) || die("can't open $file");
492 next if ( !/name\s*=>\s*"(\w+)"/ );
493 if ( $confVars->{$1} ) {
497 next if ( $1 eq "Hosts" );
498 print("$file has $1 but missing from conf/config.pl\n");
502 foreach my $v ( keys(%$confVars) ) {
503 next if ( $done->{$v} );
504 print("$file missing $v from conf/config.pl\n");
511 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
512 # the strings in each lib/BackupPC/Lang/*.pm file. This makes sure
513 # we didn't miss any translations in any of the languages.
521 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
522 <lib/BackupPC/CGI/*pm>,
523 <lib/BackupPC/Lang/en.pm>,
525 open(F, $file) || die("can't open $file");
529 s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
530 s/(text|comment)\s*=>\s*"(CfgEdit_.*)"/$vars->{$2} = 1;/eg;
535 foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
537 open(F, $f) || die("can't open $f\n");
543 next if ( $var =~ m{^(Reason_|Status_|backupType_|Disabled_)} );
544 next if ( $var eq "Documentation" );
545 if ( !defined($vars->{$var}) ) {
546 print("Unexpected Lang var $var in $f\n");
553 foreach my $v ( keys(%$vars) ) {
555 # skip "variables" with "$", since they are like expressions
557 next if ( $v =~ /\$/ );
558 if ( !defined($done->{$v}) ) {
559 print("Lang var $v missing from $f\n");
568 # Pedantically check that all the html tags in each language file
573 my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
576 foreach my $lang ( qw(fr.pm de.pm es.pm it.pm nl.pm pl.pm pt_br.pm zh_CN.pm) ) {
577 my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
578 foreach my $v1 ( @$en ) {
580 if ( $v1->{var} ne $v2->{var} ) {
581 print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
584 my $t1 = LangTextStrip($v1->{val});
585 my $t2 = LangTextStrip($v2->{val});
588 for ( $i = 0 ; $i < length($t1) ; $i++ ) {
589 last if ( substr($t1, 0, $i) ne substr($t2, 0, $i) );
591 print("$v1->{var}: ($i) got en.pm $t1\nvs $lang $t2\n\n");
603 $t = "" if ( $t !~ /<.*>/ );
605 $t =~ s/([}>])[^<]*</$1</g;
607 $t =~ s/(value=)"[^"]*"/$1""/sg;
608 $t =~ s/({h[12]\()"[^"]*"/$1""/g;
609 $t =~ s/ENG[\s\n]*//sg;
610 $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
617 open(C, $file) || die("can't open $file");
619 my($out, @lang, $var);
624 if ( /^#/ && !defined($endLine) ) {
629 $allVars->{$var} = @lang if ( defined($var) );
639 } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
641 if ( defined($var) ) {
642 $allVars->{$var} = @lang if ( defined($var) );
652 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
653 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
655 $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
660 $allVars->{$var} = @lang if ( defined($var) );
667 foreach my $v ( @lang ) {
668 if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
672 return (\@lang, $allVars);