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-2004  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 use Getopt::Std;
  42
  43 umask(0022);
  44
  45 my $Version     = "2.1.0_CVS";
  46 my $ReleaseDate = "13 Mar 2004";
  47 my $DistDir     = "dist/BackupPC-$Version";
  48
  49 my @PerlSrc = qw(
  50     bin/BackupPC
  51     bin/BackupPC_archive
  52     bin/BackupPC_archiveHost
  53     bin/BackupPC_dump
  54     bin/BackupPC_link
  55     bin/BackupPC_nightly
  56     bin/BackupPC_restore
  57     bin/BackupPC_sendEmail
  58     bin/BackupPC_serverMesg
  59     bin/BackupPC_trashClean
  60     bin/BackupPC_tarExtract
  61     bin/BackupPC_tarCreate
  62     bin/BackupPC_compressPool
  63     bin/BackupPC_zipCreate
  64     bin/BackupPC_zcat
  65     lib/BackupPC/Attrib.pm
  66     lib/BackupPC/FileZIO.pm
  67     lib/BackupPC/Lib.pm
  68     lib/BackupPC/PoolWrite.pm
  69     lib/BackupPC/View.pm
  70     lib/BackupPC/CGI/AdminOptions.pm
  71     lib/BackupPC/CGI/Archive.pm
  72     lib/BackupPC/CGI/ArchiveInfo.pm
  73     lib/BackupPC/CGI/Browse.pm
  74     lib/BackupPC/CGI/DirHistory.pm
  75     lib/BackupPC/CGI/EmailSummary.pm
  76     lib/BackupPC/CGI/GeneralInfo.pm
  77     lib/BackupPC/CGI/HostInfo.pm
  78     lib/BackupPC/CGI/Lib.pm
  79     lib/BackupPC/CGI/LOGlist.pm
  80     lib/BackupPC/CGI/Queue.pm
  81     lib/BackupPC/CGI/ReloadServer.pm
  82     lib/BackupPC/CGI/RestoreFile.pm
  83     lib/BackupPC/CGI/RestoreInfo.pm
  84     lib/BackupPC/CGI/Restore.pm
  85     lib/BackupPC/CGI/StartServer.pm
  86     lib/BackupPC/CGI/StartStopBackup.pm
  87     lib/BackupPC/CGI/StopServer.pm
  88     lib/BackupPC/CGI/Summary.pm
  89     lib/BackupPC/CGI/View.pm
  90     lib/BackupPC/Lang/de.pm
  91     lib/BackupPC/Lang/en.pm
  92     lib/BackupPC/Lang/es.pm
  93     lib/BackupPC/Lang/fr.pm
  94     lib/BackupPC/Lang/it.pm
  95     lib/BackupPC/Xfer/Archive.pm
  96     lib/BackupPC/Xfer/Smb.pm
  97     lib/BackupPC/Xfer/Tar.pm
  98     lib/BackupPC/Xfer/Rsync.pm
  99     lib/BackupPC/Xfer/RsyncDigest.pm
 100     lib/BackupPC/Xfer/RsyncFileIO.pm
 101     lib/BackupPC/Zip/FileMember.pm
 102     cgi-bin/BackupPC_Admin
 103 );
 104
 105 my %opts;
 106 if ( !getopts("l", \%opts) || @ARGV != 0 ) {
 107     print("usage: $0 [-l]\n");
 108     exit(1);
 109 }
 110
 111 #
 112 # Check config parameters
 113 #
 114 my $ConfVars = {};
 115 my $errCnt;
 116
 117 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
 118
 119 #
 120 # These config parameters are not used in the code, so ignore them.
 121 #
 122 $ConfVars->{BackupPCUser} = 2;
 123 $ConfVars->{CgiDir}       = 2;
 124 $ConfVars->{InstallDir}   = 2;
 125 $ConfVars->{CgiImageDir}  = 2;
 126
 127 #
 128 # These config parameters are used in the code to be backward compatible,
 129 # but are not present in the current config file, so ignore them.
 130 #
 131 $ConfVars->{BlackoutHourBegin} = 2;
 132 $ConfVars->{BlackoutHourEnd}   = 2;
 133 $ConfVars->{BlackoutWeekDays}  = 2;
 134 $ConfVars->{RsyncLogLevel}     = 2;
 135
 136 foreach my $file ( @PerlSrc ) {
 137     $errCnt += CheckConfigParams($file, $ConfVars, 1);
 138 }
 139 if ( !$opts{l} ) {
 140     $errCnt += CheckLangUsage();
 141     $errCnt += CheckLangTags();
 142 }
 143 if ( $errCnt ) {
 144     print("Exiting because of errors\n");
 145     exit(1)
 146 }
 147
 148 $errCnt = 0;
 149 foreach my $var ( sort(keys(%$ConfVars) ) ) {
 150     next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
 151     printf("Unused config parameter $var\n");
 152     $errCnt++;
 153 }
 154 if ( $errCnt ) {
 155     print("Exiting because of errors\n");
 156     exit(1)
 157 }
 158
 159 rmtree($DistDir, 0, 0);
 160 mkpath($DistDir, 0, 0777);
 161
 162 foreach my $dir ( qw(bin doc conf images init.d/src cgi-bin
 163                      lib/BackupPC/CGI
 164                      lib/BackupPC/Lang
 165                      lib/BackupPC/Xfer
 166                      lib/BackupPC/Zip
 167                 ) ) {
 168     mkpath("$DistDir/$dir", 0, 0777);
 169 }
 170
 171 my %ConfName;
 172 my $ConfPod = config2pod();
 173 rmtree("doc", 0, 0);
 174 mkpath("doc", 0, 0777);
 175 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
 176
 177 use Pod::Html;
 178 pod2html("doc/BackupPC.pod",
 179         "--backlink=Back to Top",
 180         "--header",
 181         "--title=BackupPC",
 182         "--outfile=doc/BackupPC.html");
 183
 184 foreach my $file ( (@PerlSrc,
 185             <images/*>,
 186             qw(
 187                 conf/config.pl
 188                 conf/hosts
 189                 init.d/README
 190                 init.d/src/debian-backuppc
 191                 init.d/src/gentoo-backuppc
 192                 init.d/src/gentoo-backuppc.conf
 193                 init.d/src/linux-backuppc
 194                 init.d/src/solaris-backuppc
 195                 init.d/src/suse-backuppc
 196                 doc/BackupPC.pod
 197                 doc/BackupPC.html
 198                 README
 199                 LICENSE
 200                 ChangeLog
 201                 configure.pl
 202         )) ) {
 203     InstallFile("$file", "$DistDir/$file");
 204 }
 205 rmtree("doc", 0, 0);
 206 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
 207 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
 208 unlink("pod2htmd.x~~");
 209 unlink("pod2htmi.x~~");
 210
 211 ###########################################################################
 212 # Subroutines
 213 ###########################################################################
 214
 215 sub InstallFile
 216 {
 217     my($file, $dest) = @_;
 218
 219     unlink($dest) if ( -d $dest );
 220     if ( $file =~ /\.gif/ ) {
 221         die("can't copy($file, $dest)\n") unless copy($file, $dest);
 222     } else {
 223         open(FILE, $file)   || die("can't open $file for reading\n");
 224         open(OUT, ">$dest") || die("can't open $dest for writing\n");
 225         binmode(FILE);
 226         binmode(OUT);
 227         while ( <FILE> ) {
 228             s/^# *Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/# Version __VERSION__, released __RELEASEDATE__./;
 229             s/__VERSION__/$Version/g;
 230             s/__RELEASEDATE__/$ReleaseDate/g;
 231             if ( $file =~ /BackupPC\.html$/ && !/A NAME="item_%24Conf/ ) {
 232                 s/\$Conf{([^}]*)}/
 233                         defined($ConfName{$1})
 234                             ? "<A HREF=\"#$ConfName{$1}\">\$Conf{$1}<\/A>"
 235                             : "\$Conf{$1}"/eg;
 236             }
 237             if ( /__CONFIGPOD__/ ) {
 238                 print OUT $ConfPod;
 239             } elsif ( /^use lib ".*BackupPC\/lib";/
 240                     || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
 241                 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
 242             } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
 243                 print OUT "$1'__TOPDIR__',\n";
 244             } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
 245                 print OUT "$1'$Version',\n";
 246             } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
 247                 print OUT "$1'__INSTALLDIR__',\n";
 248             } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
 249                 print OUT "$1'__INSTALLDIR__',\n";
 250             } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
 251                 print OUT "$1'__INSTALLDIR__/lib';\n";
 252             } else {
 253                 print OUT;
 254             }
 255         }
 256         close(FILE);
 257         close(OUT);
 258     }
 259     if ( -x $file ) {
 260         chmod(0555, $dest);
 261     } else {
 262         chmod(0444, $dest);
 263     }
 264 }
 265
 266 sub config2pod
 267 {
 268     open(C, "conf/config.pl") || die("can't open conf/config.pl");
 269     binmode(C);
 270     my($str, $out, $getHdr, @conf);
 271     my $first = 1;
 272     while ( <C> ) {
 273         chomp;
 274         s/ +$//;
 275         if ( /^#########################/ ) {
 276             if ( $getHdr ) {
 277                 $str =~ s/\n.*//sg;
 278                 $out .= "=back\n\n" if ( !$first );
 279                 $out .= "=head2 $str\n\n=over 4\n\n";
 280                 $str = "";
 281                 $first = 0;
 282             }
 283             $getHdr = !$getHdr;
 284             next;
 285         }
 286         if ( /^#/ ) {
 287             s/# ?//;
 288             next if ( $str eq "" && /^$/ );
 289             $str .= $_ . "\n";
 290             $str .= "\n" if ( $str =~ /examples?:\n$/i );
 291         } elsif ( /^\$Conf{([^}]*)/ ) {
 292             my $var = $1;
 293             s/  +/ /g;
 294             s/;\s*#.*/;/;
 295             if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
 296                 s/([^;])\s*$/$1 .../;
 297             }
 298             push(@conf, $_);
 299             my $text = $_;
 300             $text =~ s/\s+/_/sg;
 301             $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
 302             $text = substr($text, 0, 50);
 303             $ConfName{$var} = "item_$text";
 304         } elsif ( /^$/ ) {
 305             if ( $str ne "" && @conf ) {
 306                 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 307                 $out .= $str;
 308                 $out .= "\n" if ( $str !~ /\n$/ );
 309             }
 310             $str = "";
 311             @conf = ();
 312         }
 313     }
 314     if ( $str ne "" && @conf ) {
 315         $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 316         $out .= $str;
 317         $out .= "\n" if ( $str !~ /\n$/ );
 318     }
 319     $out .= "=back\n\n" if ( !$first );
 320     return $out;
 321 }
 322
 323 sub CheckConfigParams
 324 {
 325     my($file, $vars, $check) = @_;
 326     my $errors;
 327
 328     open(F, $file) || die("can't open $file\n");
 329     binmode(F);
 330     if ( $check ) {
 331         while ( <F> ) {
 332             s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
 333                     print("Unexpected Conf var $2 in $file\n");
 334                     $errors++;
 335                 } else {
 336                     $vars->{$2}++;
 337                 }/eg;
 338             s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
 339                     print("Unexpected Conf var $1 in $file\n");
 340                     $errors++;
 341                 } else {
 342                     $vars->{$1}++;
 343                 }/eg;
 344             s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
 345                     print("Unexpected Conf var $1 in $file\n");
 346                     $errors++;
 347                 } else {
 348                     $vars->{$1}++;
 349                 }/eg;
 350         }
 351     } else {
 352         while ( <F> ) {
 353             s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
 354             s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
 355         }
 356     }
 357     close(F);
 358     return $errors;
 359 }
 360
 361 #
 362 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
 363 # the strings in each lib/BackupPC/Lang/*.pm file.  This makes sure
 364 # we didn't miss any translations in any of the languages.
 365 #
 366 sub CheckLangUsage
 367 {
 368     my $errors;
 369     my $vars = {};
 370
 371     foreach my $file ( (
 372                 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
 373                 <lib/BackupPC/CGI/*pm>
 374             ) ) {
 375         open(F, $file) || die("can't open $file");
 376         binmode(F);
 377         while ( <F> ) {
 378             s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
 379         }
 380         close(F);
 381     }
 382
 383     foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
 384         my $done = {};
 385         open(F, $f) || die("can't open $f\n");
 386         binmode(F);
 387         while ( <F> ) {
 388             s/#.*//g;
 389             s/\$Lang{([^}]*)}/
 390                     my $var = $1;
 391                     next if ( $var =~ m{^(Reason_|Status_|backupType_)} );
 392                     if ( !defined($vars->{$var}) ) {
 393                         print("Unexpected Lang var $var in $f\n");
 394                         $errors++;
 395                     } else {
 396                         $done->{$var} = 1;
 397                     }/eg;
 398         }
 399         close(F);
 400         foreach my $v ( keys(%$vars) ) {
 401             #
 402             # skip "variables" with "$", since they are like expressions
 403             #
 404             next if ( $v =~ /\$/ );
 405             if ( !defined($done->{$v}) ) {
 406                 print("Lang var $v missing from $f\n");
 407                 $errors++;
 408             }
 409         }
 410     }
 411     return $errors;
 412 }
 413
 414 #
 415 # Pedantically check that all the html tags in each language file
 416 # match.
 417 #
 418 sub CheckLangTags
 419 {
 420     my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
 421     my($errors);
 422
 423     foreach my $lang ( qw(fr.pm de.pm es.pm it.pm) ) {
 424         my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
 425         foreach my $v1 ( @$en ) {
 426             my $v2 = shift(@$d);
 427             if ( $v1->{var} ne $v2->{var} ) {
 428                 print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
 429                 exit;
 430             }
 431             my $t1 = LangTextStrip($v1->{val});
 432             my $t2 = LangTextStrip($v2->{val});
 433             if ( $t1 ne $t2 ) {
 434                 print("$v1->{var}: got en.pm $t1\nvs $lang $t2\n\n");
 435                 $errors++;
 436             }
 437         }
 438     }
 439     return $errors;
 440 }
 441
 442 sub LangTextStrip
 443 {
 444     my($t) = @_;
 445
 446     $t = "" if ( $t !~ /<.*>/ );
 447     $t =~ s/^[^<]*</</s;
 448     $t =~ s/([}>])[^<]*</$1</g;
 449     $t =~ s/>[^<]*$/>/;
 450     $t =~ s/(value=)"[^"]*"/$1""/sg;
 451     $t =~ s/({h[12]\()"[^"]*"/$1""/g;
 452     $t =~ s/ENG[\s\n]*//sg;
 453     $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
 454     return $t;
 455 }
 456
 457 sub LangParse
 458 {
 459     my($file) = @_;
 460     open(C, $file) || die("can't open $file");
 461     binmode(C);
 462     my($out, @lang, $var);
 463     my $comment = 1;
 464     my $allVars = {};
 465     my $endLine = undef;
 466     while ( <C> ) {
 467         if ( /^#/ && !defined($endLine) ) {
 468             if ( $comment ) {
 469                 $out .= $_;
 470             } else {
 471                 if ( $out ne "" ) {
 472                     $allVars->{$var} = @lang if ( defined($var) );
 473                     push(@lang, {
 474                         text => $out,
 475                         var => $var,
 476                     });
 477                 }
 478                 $var = undef;
 479                 $comment = 1;
 480                 $out = $_;
 481             }
 482         } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
 483             $comment = 0;
 484             if ( defined($var) ) {
 485                 $allVars->{$var} = @lang if ( defined($var) );
 486                 push(@lang, {
 487                     text => $out,
 488                     var => $var,
 489                 });
 490                 $out = $_;
 491             } else {
 492                 $out .= $_;
 493             }
 494             $var = $1;
 495             $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
 496             $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
 497         } else {
 498             $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
 499             $out .= $_;
 500         }
 501     }
 502     if ( $out ne "" ) {
 503         $allVars->{$var} = @lang if ( defined($var) );
 504         push(@lang, {
 505             text => $out,
 506             var  => $var,
 507         });
 508     }
 509     close(C);
 510     foreach my $v ( @lang ) {
 511         if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
 512             $v->{val} = $1;
 513         }
 514     }
 515     return (\@lang, $allVars);
 516 }