#
# dist/BackupPC-$Version.tar.gz.
#
+# Often the language files are not up to date, and makeDist
+# exits after complaining about the lang files being inconsistent.
+# Use the -l option to turn off that behavior.
+#
# AUTHOR
# Craig Barratt <cbarratt@users.sourceforge.net>
#
# COPYRIGHT
-# Copyright (C) 2001-2003 Craig Barratt
+# Copyright (C) 2001-2007 Craig Barratt
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
use strict;
use File::Path;
use File::Copy;
+use Getopt::Std;
+use lib "./lib";
+use BackupPC::Lib;
+use BackupPC::Config::Meta qw(:all);
+
+my $bpc;
+die("BackupPC::Lib->new failed\n")
+ if ( !($bpc = BackupPC::Lib->new(".", ".", "./conf", 1)) );
umask(0022);
-my $Version = "2.0.0_CVS";
-my $ReleaseDate = "18 Jan 2003";
+my $Version = "3.1.0beta0";
+my $ReleaseDate = "3 Sep 2007";
my $DistDir = "dist/BackupPC-$Version";
my @PerlSrc = qw(
bin/BackupPC
+ bin/BackupPC_archive
+ bin/BackupPC_archiveHost
+ bin/BackupPC_archiveStart
+ bin/BackupPC_attribPrint
bin/BackupPC_dump
+ bin/BackupPC_fixupBackupSummary
bin/BackupPC_link
bin/BackupPC_nightly
bin/BackupPC_restore
bin/BackupPC_trashClean
bin/BackupPC_tarExtract
bin/BackupPC_tarCreate
+ bin/BackupPC_tarPCCopy
bin/BackupPC_compressPool
bin/BackupPC_zipCreate
bin/BackupPC_zcat
lib/BackupPC/Attrib.pm
+ lib/BackupPC/Config.pm
lib/BackupPC/FileZIO.pm
lib/BackupPC/Lib.pm
- lib/BackupPC/Lang/en.pm
- lib/BackupPC/Lang/fr.pm
lib/BackupPC/PoolWrite.pm
+ lib/BackupPC/Storage.pm
lib/BackupPC/View.pm
+ lib/BackupPC/CGI/AdminOptions.pm
+ lib/BackupPC/CGI/Archive.pm
+ lib/BackupPC/CGI/ArchiveInfo.pm
+ lib/BackupPC/CGI/Browse.pm
+ lib/BackupPC/CGI/DirHistory.pm
+ lib/BackupPC/CGI/EditConfig.pm
+ lib/BackupPC/CGI/EmailSummary.pm
+ lib/BackupPC/CGI/GeneralInfo.pm
+ lib/BackupPC/CGI/HostInfo.pm
+ lib/BackupPC/CGI/Lib.pm
+ lib/BackupPC/CGI/LOGlist.pm
+ lib/BackupPC/CGI/Queue.pm
+ lib/BackupPC/CGI/ReloadServer.pm
+ lib/BackupPC/CGI/RestoreFile.pm
+ lib/BackupPC/CGI/RestoreInfo.pm
+ lib/BackupPC/CGI/Restore.pm
+ lib/BackupPC/CGI/RSS.pm
+ lib/BackupPC/CGI/StartServer.pm
+ lib/BackupPC/CGI/StartStopBackup.pm
+ lib/BackupPC/CGI/StopServer.pm
+ lib/BackupPC/CGI/Summary.pm
+ lib/BackupPC/CGI/View.pm
+ lib/BackupPC/Config/Meta.pm
+ lib/BackupPC/Lang/de.pm
+ lib/BackupPC/Lang/en.pm
+ lib/BackupPC/Lang/es.pm
+ lib/BackupPC/Lang/fr.pm
+ lib/BackupPC/Lang/it.pm
+ lib/BackupPC/Lang/nl.pm
+ lib/BackupPC/Lang/pl.pm
+ lib/BackupPC/Lang/pt_br.pm
+ lib/BackupPC/Lang/zh_CN.pm
+ lib/BackupPC/Storage/Text.pm
+ lib/BackupPC/Xfer/Archive.pm
+ lib/BackupPC/Xfer/BackupPCd.pm
lib/BackupPC/Xfer/Smb.pm
lib/BackupPC/Xfer/Tar.pm
lib/BackupPC/Xfer/Rsync.pm
+ lib/BackupPC/Xfer/RsyncDigest.pm
lib/BackupPC/Xfer/RsyncFileIO.pm
lib/BackupPC/Zip/FileMember.pm
cgi-bin/BackupPC_Admin
);
+my %opts;
+if ( !getopts("l", \%opts) || @ARGV != 0 ) {
+ print("usage: $0 [-l]\n");
+ exit(1);
+}
+
#
# Check config parameters
#
my $errCnt;
$errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
+
+$errCnt += CheckConfigParams("doc-src/BackupPC.pod", $ConfVars, 1);
+
+$errCnt += CheckMetaDataVsConfig($ConfVars, "lib/BackupPC/Config/Meta.pm");
+
+$errCnt += CheckEditorVsConfig($ConfVars, "lib/BackupPC/CGI/EditConfig.pm");
+
+#
+# These config parameters are not used in the code, so ignore them.
+#
$ConfVars->{BackupPCUser} = 2;
-$ConfVars->{CgiDir} = 2;
-$ConfVars->{InstallDir} = 2;
-$ConfVars->{CgiImageDir} = 2;
+$ConfVars->{CgiDir} = 2;
+$ConfVars->{TopDir} = 2;
+$ConfVars->{LogDir} = 2;
+$ConfVars->{ConfDir} = 2;
+$ConfVars->{InstallDir} = 2;
+$ConfVars->{CgiImageDir} = 2;
+$ConfVars->{ClientCharsetLegacy} = 2; # actually used
+
+#
+# These config parameters are used in the code to be backward compatible,
+# but are not present in the current config file, so ignore them.
+#
+$ConfVars->{BlackoutHourBegin} = 2;
+$ConfVars->{BlackoutHourEnd} = 2;
+$ConfVars->{BlackoutWeekDays} = 2;
+$ConfVars->{RsyncLogLevel} = 2;
+
foreach my $file ( @PerlSrc ) {
$errCnt += CheckConfigParams($file, $ConfVars, 1);
}
-$errCnt += CheckLangUsage();
-exit(1) if ( $errCnt );
+if ( !$opts{l} ) {
+ $errCnt += CheckLangUsage();
+ $errCnt += CheckLangTags();
+}
+if ( $errCnt ) {
+ print("Exiting because of errors\n");
+ exit(1)
+}
+$errCnt = 0;
foreach my $var ( sort(keys(%$ConfVars) ) ) {
next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
printf("Unused config parameter $var\n");
$errCnt++;
}
-exit(1) if ( $errCnt );
+if ( $errCnt ) {
+ print("Exiting because of errors\n");
+ exit(1)
+}
rmtree($DistDir, 0, 0);
mkpath($DistDir, 0, 0777);
-foreach my $dir ( qw(bin lib/BackupPC/Xfer lib/BackupPC/Zip lib/BackupPC/Lang
- doc conf images init.d/src cgi-bin) ) {
+foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin
+ lib/BackupPC/CGI
+ lib/BackupPC/Config
+ lib/BackupPC/Lang
+ lib/BackupPC/Storage
+ lib/BackupPC/Xfer
+ lib/BackupPC/Zip
+ ) ) {
mkpath("$DistDir/$dir", 0, 0777);
}
"--outfile=doc/BackupPC.html");
foreach my $file ( (@PerlSrc,
- <images/*>,
+ <images/*.gif>,
+ <images/*.png>,
qw(
conf/config.pl
conf/hosts
+ conf/BackupPC_stnd.css
+ conf/BackupPC_stnd_orig.css
+ conf/sorttable.js
init.d/README
init.d/src/debian-backuppc
+ init.d/src/freebsd-backuppc
+ init.d/src/gentoo-backuppc
+ init.d/src/gentoo-backuppc.conf
init.d/src/linux-backuppc
+ init.d/src/slackware-backuppc
init.d/src/solaris-backuppc
+ init.d/src/suse-backuppc
doc/BackupPC.pod
doc/BackupPC.html
README
print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
unlink("pod2htmd.x~~");
unlink("pod2htmi.x~~");
+unlink("pod2htmd.tmp");
+unlink("pod2htmi.tmp");
###########################################################################
# Subroutines
my($file, $dest) = @_;
unlink($dest) if ( -d $dest );
- if ( $file =~ /\.gif/ ) {
+ if ( $file =~ /\.gif/ || $file =~ /\.png/ ) {
die("can't copy($file, $dest)\n") unless copy($file, $dest);
} else {
open(FILE, $file) || die("can't open $file for reading\n");
open(OUT, ">$dest") || die("can't open $dest for writing\n");
+ binmode(FILE);
+ binmode(OUT);
while ( <FILE> ) {
- s/^# *Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/# Version __VERSION__, released __RELEASEDATE__./;
+ s/^([#*\s]+)Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/$1Version __VERSION__, released __RELEASEDATE__./;
s/__VERSION__/$Version/g;
s/__RELEASEDATE__/$ReleaseDate/g;
- if ( $file =~ /BackupPC\.html$/ && !/A NAME="item_%24Conf/ ) {
- s/\$Conf{([^}]*)}/
+ if ( $file =~ /BackupPC\.html$/ ) {
+ #
+ # fixup for conf links
+ #
+ if ( !/A NAME="item_(%|_)conf/i ) {
+ s/\$Conf{([^}]*)}/
defined($ConfName{$1})
- ? "<A HREF=\"#$ConfName{$1}\">\$Conf{$1}<\/A>"
+ ? "\L<a href=\"#$ConfName{$1}\">\E\$Conf{$1}<\/A>"
: "\$Conf{$1}"/eg;
+ }
+ s/^<DD>/<DD><P>/;
+ s/^<li><\/li>/<li>/;
}
if ( /__CONFIGPOD__/ ) {
print OUT $ConfPod;
} elsif ( /^use lib ".*BackupPC\/lib";/
|| /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
print OUT "use lib \"__INSTALLDIR__/lib\";\n";
- } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
- print OUT "$1'__TOPDIR__',\n";
- } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
- print OUT "$1'$Version',\n";
- } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
- print OUT "$1'__INSTALLDIR__',\n";
- } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
- print OUT "$1'__INSTALLDIR__',\n";
+ } elsif ( $file =~ /Lib.pm/ && /^(\s*\$topDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
+ print OUT "$1'__TOPDIR__'$2\n";
+ } elsif ( $file =~ /Lib.pm/ && /^(\s*\$installDir\s*=\s*)'.*'(\s*if\s.*)/ ) {
+ print OUT "$1'__INSTALLDIR__'$2\n";
+ } elsif ( $file =~ /Lib.pm/ && /^(\s*ConfDir\s*=\>\s*\$confDir eq.*)'.*'(.*)/ ) {
+ print OUT "$1'__CONFDIR__'$2\n";
+ } elsif ( $file =~ /Lib.pm/ && /^(\s*my \$useFHS\s*=\s*)\d;/ ) {
+ print OUT "${1}0;\n";
+ } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
+ print OUT "$1'$Version',\n";
+ } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_BIN_LIST__/ ) {
+ print OUT " ", join("\n ", grep(/^bin\//, @PerlSrc)), "\n";
+ } elsif ( $file =~ /configure.pl/ && /__CONFIGURE_LIB_LIST__/ ) {
+ print OUT " ", join("\n ", grep(/^lib\//, @PerlSrc)), "\n";
+ } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
+ print OUT "$1'__INSTALLDIR__/lib';\n";
} else {
print OUT;
}
sub config2pod
{
open(C, "conf/config.pl") || die("can't open conf/config.pl");
+ binmode(C);
my($str, $out, $getHdr, @conf);
my $first = 1;
while ( <C> ) {
s/([^;])\s*$/$1 .../;
}
push(@conf, $_);
- my $text = $_;
- $text =~ s/\s+/_/sg;
- $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
- $text = substr($text, 0, 50);
+ my $text = "_conf_${var}_";
+ $text =~ s{[\W\s]}{_}g;
$ConfName{$var} = "item_$text";
} elsif ( /^$/ ) {
if ( $str ne "" && @conf ) {
my $errors;
open(F, $file) || die("can't open $file\n");
+ binmode(F);
if ( $check ) {
while ( <F> ) {
s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
} else {
$vars->{$1}++;
}/eg;
- s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
+ s/UserCommandRun\("([^"]*)"/if ( !defined($vars->{$1}) ) {
print("Unexpected Conf var $1 in $file\n");
$errors++;
} else {
return $errors;
}
+sub CheckMetaDataVsConfig
+{
+ my($confVars, $file) = @_;
+ my $done = {};
+ my $errors;
+
+ #
+ # Check that the meta file mentions all the config
+ # parameters
+ #
+ open(F, $file) || die("can't open $file");
+
+ while ( <F> ) {
+ next if ( !/^\s{4}(\w+)\s+=>/ );
+ if ( $confVars->{$1} ) {
+ $done->{$1} = 1;
+ next;
+ }
+ next if ( $1 eq "Hosts" );
+ print("$file has $1 but missing from conf/config.pl\n");
+ $errors++;
+ }
+ close(F);
+ foreach my $v ( keys(%$confVars) ) {
+ next if ( $done->{$v} );
+ print("$file missing $v from conf/config.pl\n");
+ $errors++;
+ }
+
+ #
+ # Do extra checks that the CgiUserConfigEdit hash in the Meta
+ # file matches the config file
+ #
+ foreach my $p ( keys(%{$ConfigMeta{CgiUserConfigEdit}{child}}) ) {
+ if ( !defined($bpc->{Conf}{CgiUserConfigEdit}{$p}) ) {
+ print("lib/BackupPC/Config/Meta.pm has $p in CgiUserConfigEdit,"
+ . " but conf/config.pl CgiUserConfigEdit does not\n");
+ $errors++;
+ }
+ }
+ foreach my $p ( keys(%{$bpc->{Conf}{CgiUserConfigEdit}}) ) {
+ if ( !defined($ConfigMeta{CgiUserConfigEdit}{child}{$p}) ) {
+ print("conf/config.pl CgiUserConfigEdit has $p, but"
+ . " lib/BackupPC/Config/Meta.pm does not\n");
+ $errors++;
+ }
+ }
+ return $errors;
+}
+
+sub CheckEditorVsConfig
+{
+ my($confVars, $file) = @_;
+ my $done = {};
+ my $errors;
+
+ #
+ # Check that the config editor file mentions all the config
+ # parameters
+ #
+ open(F, $file) || die("can't open $file");
+
+ while ( <F> ) {
+ next if ( !/name\s*=>\s*"(\w+)"/ );
+ if ( $confVars->{$1} ) {
+ $done->{$1} = 1;
+ next;
+ }
+ next if ( $1 eq "Hosts" );
+ print("$file has $1 but missing from conf/config.pl\n");
+ $errors++;
+ }
+ close(F);
+ foreach my $v ( keys(%$confVars) ) {
+ next if ( $done->{$v} );
+ print("$file missing $v from conf/config.pl\n");
+ $errors++;
+ }
+ return $errors;
+}
+
#
# Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
# the strings in each lib/BackupPC/Lang/*.pm file. This makes sure
my $errors;
my $vars = {};
- foreach my $file ( qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail) ) {
+ foreach my $file ( (
+ qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
+ <lib/BackupPC/CGI/*pm>,
+ <lib/BackupPC/Lang/en.pm>,
+ ) ) {
open(F, $file) || die("can't open $file");
+ binmode(F);
while ( <F> ) {
+ next if ( /^\s*#/ );
s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
+ s/(text|comment)\s*=>\s*"(CfgEdit_.*)"/$vars->{$2} = 1;/eg;
}
close(F);
}
+
foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
my $done = {};
open(F, $f) || die("can't open $f\n");
+ binmode(F);
while ( <F> ) {
s/#.*//g;
s/\$Lang{([^}]*)}/
my $var = $1;
- next if ( $var =~ m{^(Reason_|Status_)} );
+ next if ( $var =~ m{^(Reason_|Status_|backupType_|Disabled_)} );
+ next if ( $var eq "Documentation" );
if ( !defined($vars->{$var}) ) {
print("Unexpected Lang var $var in $f\n");
$errors++;
}
return $errors;
}
+
+#
+# Pedantically check that all the html tags in each language file
+# match.
+#
+sub CheckLangTags
+{
+ my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
+ my($errors);
+
+ foreach my $lang ( qw(fr.pm de.pm es.pm it.pm nl.pm pl.pm pt_br.pm zh_CN.pm) ) {
+ my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
+ foreach my $v1 ( @$en ) {
+ my $v2 = shift(@$d);
+ if ( $v1->{var} ne $v2->{var} ) {
+ print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
+ exit;
+ }
+ my $t1 = LangTextStrip($v1->{val});
+ my $t2 = LangTextStrip($v2->{val});
+ if ( $t1 ne $t2 ) {
+ my $i;
+ for ( $i = 0 ; $i < length($t1) ; $i++ ) {
+ last if ( substr($t1, 0, $i) ne substr($t2, 0, $i) );
+ }
+ print("$v1->{var}: ($i) got en.pm $t1\nvs $lang $t2\n\n");
+ $errors++;
+ }
+ }
+ }
+ return $errors;
+}
+
+sub LangTextStrip
+{
+ my($t) = @_;
+
+ $t = "" if ( $t !~ /<.*>/ );
+ $t =~ s/^[^<]*</</s;
+ $t =~ s/([}>])[^<]*</$1</g;
+ $t =~ s/>[^<]*$/>/;
+ $t =~ s/(value=)"[^"]*"/$1""/sg;
+ $t =~ s/({h[12]\()"[^"]*"/$1""/g;
+ $t =~ s/ENG[\s\n]*//sg;
+ $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
+ return $t;
+}
+
+sub LangParse
+{
+ my($file) = @_;
+ open(C, $file) || die("can't open $file");
+ binmode(C);
+ my($out, @lang, $var);
+ my $comment = 1;
+ my $allVars = {};
+ my $endLine = undef;
+ while ( <C> ) {
+ if ( /^#/ && !defined($endLine) ) {
+ if ( $comment ) {
+ $out .= $_;
+ } else {
+ if ( $out ne "" ) {
+ $allVars->{$var} = @lang if ( defined($var) );
+ push(@lang, {
+ text => $out,
+ var => $var,
+ });
+ }
+ $var = undef;
+ $comment = 1;
+ $out = $_;
+ }
+ } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
+ $comment = 0;
+ if ( defined($var) ) {
+ $allVars->{$var} = @lang if ( defined($var) );
+ push(@lang, {
+ text => $out,
+ var => $var,
+ });
+ $out = $_;
+ } else {
+ $out .= $_;
+ }
+ $var = $1;
+ $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
+ $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
+ } else {
+ $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
+ $out .= $_;
+ }
+ }
+ if ( $out ne "" ) {
+ $allVars->{$var} = @lang if ( defined($var) );
+ push(@lang, {
+ text => $out,
+ var => $var,
+ });
+ }
+ close(C);
+ foreach my $v ( @lang ) {
+ if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
+ $v->{val} = $1;
+ }
+ }
+ return (\@lang, $allVars);
+}