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