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.1.0beta0";
57 my $ReleaseDate = "3 Sep 2007";
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/pt_br.pm
117 lib/BackupPC/Lang/zh_CN.pm
118 lib/BackupPC/Storage/Text.pm
119 lib/BackupPC/Xfer/Archive.pm
120 lib/BackupPC/Xfer/BackupPCd.pm
121 lib/BackupPC/Xfer/Smb.pm
122 lib/BackupPC/Xfer/Tar.pm
123 lib/BackupPC/Xfer/Rsync.pm
124 lib/BackupPC/Xfer/RsyncDigest.pm
125 lib/BackupPC/Xfer/RsyncFileIO.pm
126 lib/BackupPC/Zip/FileMember.pm
127 cgi-bin/BackupPC_Admin
131 if ( !getopts("l", \%opts) || @ARGV != 0 ) {
132 print("usage: $0 [-l]\n");
137 # Check config parameters
142 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
144 $errCnt += CheckConfigParams("doc-src/BackupPC.pod", $ConfVars, 1);
146 $errCnt += CheckMetaDataVsConfig($ConfVars, "lib/BackupPC/Config/Meta.pm");
148 $errCnt += CheckEditorVsConfig($ConfVars, "lib/BackupPC/CGI/EditConfig.pm");
151 # These config parameters are not used in the code, so ignore them.
153 $ConfVars->{BackupPCUser} = 2;
154 $ConfVars->{CgiDir} = 2;
155 $ConfVars->{TopDir} = 2;
156 $ConfVars->{LogDir} = 2;
157 $ConfVars->{ConfDir} = 2;
158 $ConfVars->{InstallDir} = 2;
159 $ConfVars->{CgiImageDir} = 2;
160 $ConfVars->{ClientCharsetLegacy} = 2; # actually used
163 # These config parameters are used in the code to be backward compatible,
164 # but are not present in the current config file, so ignore them.
166 $ConfVars->{BlackoutHourBegin} = 2;
167 $ConfVars->{BlackoutHourEnd} = 2;
168 $ConfVars->{BlackoutWeekDays} = 2;
169 $ConfVars->{RsyncLogLevel} = 2;
171 foreach my $file ( @PerlSrc ) {
172 $errCnt += CheckConfigParams($file, $ConfVars, 1);
175 $errCnt += CheckLangUsage();
176 $errCnt += CheckLangTags();
179 print("Exiting because of errors\n");
184 foreach my $var ( sort(keys(%$ConfVars) ) ) {
185 next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
186 printf("Unused config parameter $var\n");
190 print("Exiting because of errors\n");
194 rmtree($DistDir, 0, 0);
195 mkpath($DistDir, 0, 0777);
197 foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin
205 mkpath("$DistDir/$dir", 0, 0777);
209 my $ConfPod = config2pod();
211 mkpath("doc", 0, 0777);
212 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
215 pod2html("doc/BackupPC.pod",
216 "--backlink=Back to Top",
219 "--outfile=doc/BackupPC.html");
221 foreach my $file ( (@PerlSrc,
227 conf/BackupPC_stnd.css
228 conf/BackupPC_stnd_orig.css
231 init.d/src/debian-backuppc
232 init.d/src/freebsd-backuppc
233 init.d/src/gentoo-backuppc
234 init.d/src/gentoo-backuppc.conf
235 init.d/src/linux-backuppc
236 init.d/src/slackware-backuppc
237 init.d/src/solaris-backuppc
238 init.d/src/suse-backuppc
246 InstallFile("$file", "$DistDir/$file");
249 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
250 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
251 unlink("pod2htmd.x~~");
252 unlink("pod2htmi.x~~");
253 unlink("pod2htmd.tmp");
254 unlink("pod2htmi.tmp");
256 ###########################################################################
258 ###########################################################################
262 my($file, $dest) = @_;
264 unlink($dest) if ( -d $dest );
265 if ( $file =~ /\.gif/ || $file =~ /\.png/ ) {
266 die("can't copy($file, $dest)\n") unless copy($file, $dest);
268 open(FILE, $file) || die("can't open $file for reading\n");
269 open(OUT, ">$dest") || die("can't open $dest for writing\n");
273 s/^([#*\s]+)Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/$1Version __VERSION__, released __RELEASEDATE__./;
274 s/__VERSION__/$Version/g;
275 s/__RELEASEDATE__/$ReleaseDate/g;
276 if ( $file =~ /BackupPC\.html$/ ) {
278 # fixup for conf links
280 if ( !/A NAME="item_(%|_)conf/i ) {
282 defined($ConfName{$1})
283 ? "\L<a href=\"#$ConfName{$1}\">\E\$Conf{$1}<\/A>"
289 if ( /__CONFIGPOD__/ ) {
291 } elsif ( /^use lib ".*BackupPC\/lib";/
292 || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
293 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
294 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$topDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
295 print OUT "$1'__TOPDIR__'$2\n";
296 } elsif ( $file =~ /Lib.pm/ && /^(\s*\$installDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
297 print OUT "$1'__INSTALLDIR__'$2\n";
298 } elsif ( $file =~ /Lib.pm/ && /^(\s*ConfDir\s*=\>\s*\$confDir eq.*)'.*'(.*)/ ) {
299 print OUT "$1'__CONFDIR__'$2\n";
300 } elsif ( $file =~ /Lib.pm/ && /^(\s*my \$useFHS\s*=\s*)\d;/ ) {
301 print OUT "${1}0;\n";
302 } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
303 print OUT "$1'$Version',\n";
304 } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_BIN_LIST__/ ) {
305 print OUT " ", join("\n ", grep(/^bin\//, @PerlSrc)), "\n";
306 } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_LIB_LIST__/ ) {
307 print OUT " ", join("\n ", grep(/^lib\//, @PerlSrc)), "\n";
308 } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
309 print OUT "$1'__INSTALLDIR__/lib';\n";
326 open(C, "conf/config.pl") || die("can't open conf/config.pl");
328 my($str, $out, $getHdr, @conf);
333 if ( /^#########################/ ) {
336 $out .= "=back\n\n" if ( !$first );
337 $out .= "=head2 $str\n\n=over 4\n\n";
346 next if ( $str eq "" && /^$/ );
348 $str .= "\n" if ( $str =~ /examples?:\n$/i );
349 } elsif ( /^\$Conf{([^}]*)/ ) {
353 if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
354 s/([^;])\s*$/$1 .../;
357 my $text = "_conf_${var}_";
358 $text =~ s{[\W\s]}{_}g;
359 $ConfName{$var} = "item_$text";
361 if ( $str ne "" && @conf ) {
362 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
364 $out .= "\n" if ( $str !~ /\n$/ );
370 if ( $str ne "" && @conf ) {
371 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
373 $out .= "\n" if ( $str !~ /\n$/ );
375 $out .= "=back\n\n" if ( !$first );
379 sub CheckConfigParams
381 my($file, $vars, $check) = @_;
384 open(F, $file) || die("can't open $file\n");
388 s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
389 print("Unexpected Conf var $2 in $file\n");
394 s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
395 print("Unexpected Conf var $1 in $file\n");
400 s/UserCommandRun\("([^"]*)"/if ( !defined($vars->{$1}) ) {
401 print("Unexpected Conf var $1 in $file\n");
409 s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
410 s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
417 sub CheckMetaDataVsConfig
419 my($confVars, $file) = @_;
424 # Check that the meta file mentions all the config
427 open(F, $file) || die("can't open $file");
430 next if ( !/^\s{4}(\w+)\s+=>/ );
431 if ( $confVars->{$1} ) {
435 next if ( $1 eq "Hosts" );
436 print("$file has $1 but missing from conf/config.pl\n");
440 foreach my $v ( keys(%$confVars) ) {
441 next if ( $done->{$v} );
442 print("$file missing $v from conf/config.pl\n");
447 # Do extra checks that the CgiUserConfigEdit hash in the Meta
448 # file matches the config file
450 foreach my $p ( keys(%{$ConfigMeta{CgiUserConfigEdit}{child}}) ) {
451 if ( !defined($bpc->{Conf}{CgiUserConfigEdit}{$p}) ) {
452 print("lib/BackupPC/Config/Meta.pm has $p in CgiUserConfigEdit,"
453 . " but conf/config.pl CgiUserConfigEdit does not\n");
457 foreach my $p ( keys(%{$bpc->{Conf}{CgiUserConfigEdit}}) ) {
458 if ( !defined($ConfigMeta{CgiUserConfigEdit}{child}{$p}) ) {
459 print("conf/config.pl CgiUserConfigEdit has $p, but"
460 . " lib/BackupPC/Config/Meta.pm does not\n");
467 sub CheckEditorVsConfig
469 my($confVars, $file) = @_;
474 # Check that the config editor file mentions all the config
477 open(F, $file) || die("can't open $file");
480 next if ( !/name\s*=>\s*"(\w+)"/ );
481 if ( $confVars->{$1} ) {
485 next if ( $1 eq "Hosts" );
486 print("$file has $1 but missing from conf/config.pl\n");
490 foreach my $v ( keys(%$confVars) ) {
491 next if ( $done->{$v} );
492 print("$file missing $v from conf/config.pl\n");
499 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
500 # the strings in each lib/BackupPC/Lang/*.pm file. This makes sure
501 # we didn't miss any translations in any of the languages.
509 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
510 <lib/BackupPC/CGI/*pm>,
511 <lib/BackupPC/Lang/en.pm>,
513 open(F, $file) || die("can't open $file");
517 s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
518 s/(text|comment)\s*=>\s*"(CfgEdit_.*)"/$vars->{$2} = 1;/eg;
523 foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
525 open(F, $f) || die("can't open $f\n");
531 next if ( $var =~ m{^(Reason_|Status_|backupType_|Disabled_)} );
532 next if ( $var eq "Documentation" );
533 if ( !defined($vars->{$var}) ) {
534 print("Unexpected Lang var $var in $f\n");
541 foreach my $v ( keys(%$vars) ) {
543 # skip "variables" with "$", since they are like expressions
545 next if ( $v =~ /\$/ );
546 if ( !defined($done->{$v}) ) {
547 print("Lang var $v missing from $f\n");
556 # Pedantically check that all the html tags in each language file
561 my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
564 foreach my $lang ( qw(fr.pm de.pm es.pm it.pm nl.pm pt_br.pm zh_CN.pm) ) {
565 my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
566 foreach my $v1 ( @$en ) {
568 if ( $v1->{var} ne $v2->{var} ) {
569 print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
572 my $t1 = LangTextStrip($v1->{val});
573 my $t2 = LangTextStrip($v2->{val});
576 for ( $i = 0 ; $i < length($t1) ; $i++ ) {
577 last if ( substr($t1, 0, $i) ne substr($t2, 0, $i) );
579 print("$v1->{var}: ($i) got en.pm $t1\nvs $lang $t2\n\n");
591 $t = "" if ( $t !~ /<.*>/ );
593 $t =~ s/([}>])[^<]*</$1</g;
595 $t =~ s/(value=)"[^"]*"/$1""/sg;
596 $t =~ s/({h[12]\()"[^"]*"/$1""/g;
597 $t =~ s/ENG[\s\n]*//sg;
598 $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
605 open(C, $file) || die("can't open $file");
607 my($out, @lang, $var);
612 if ( /^#/ && !defined($endLine) ) {
617 $allVars->{$var} = @lang if ( defined($var) );
627 } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
629 if ( defined($var) ) {
630 $allVars->{$var} = @lang if ( defined($var) );
640 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
641 $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
643 $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
648 $allVars->{$var} = @lang if ( defined($var) );
655 foreach my $v ( @lang ) {
656 if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
660 return (\@lang, $allVars);