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";
  46 my $ReleaseDate = "20 Jun 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 first one no longer needed after
 251                 # fix in CSS)
 252                 #
 253 #               if ( /^<\/dt>/ ) {
 254 #                   $_ .= <FILE>;
 255 #                   s/^(<\/dt>\n<dd>)/$1<p>/s;
 256 #               }
 257                 s/^<li><\/li>/<li>/;
 258             }
 259             if ( /__CONFIGPOD__/ ) {
 260                 print OUT $ConfPod;
 261             } elsif ( /^use lib ".*BackupPC\/lib";/
 262                     || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
 263                 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
 264             } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
 265                 print OUT "$1'__TOPDIR__',\n";
 266             } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
 267                 print OUT "$1'$Version',\n";
 268             } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
 269                 print OUT "$1'__INSTALLDIR__',\n";
 270             } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
 271                 print OUT "$1'__INSTALLDIR__',\n";
 272             } elsif ( $file =~ /BackupPC_Admin/ && /(my *\$installDir *= *)'.*'/ ) {
 273                 print OUT "$1'__INSTALLDIR__/lib';\n";
 274             } else {
 275                 print OUT;
 276             }
 277         }
 278         close(FILE);
 279         close(OUT);
 280     }
 281     if ( -x $file ) {
 282         chmod(0555, $dest);
 283     } else {
 284         chmod(0444, $dest);
 285     }
 286 }
 287
 288 sub config2pod
 289 {
 290     open(C, "conf/config.pl") || die("can't open conf/config.pl");
 291     binmode(C);
 292     my($str, $out, $getHdr, @conf);
 293     my $first = 1;
 294     while ( <C> ) {
 295         chomp;
 296         s/ +$//;
 297         if ( /^#########################/ ) {
 298             if ( $getHdr ) {
 299                 $str =~ s/\n.*//sg;
 300                 $out .= "=back\n\n" if ( !$first );
 301                 $out .= "=head2 $str\n\n=over 4\n\n";
 302                 $str = "";
 303                 $first = 0;
 304             }
 305             $getHdr = !$getHdr;
 306             next;
 307         }
 308         if ( /^#/ ) {
 309             s/# ?//;
 310             next if ( $str eq "" && /^$/ );
 311             $str .= $_ . "\n";
 312             $str .= "\n" if ( $str =~ /examples?:\n$/i );
 313         } elsif ( /^\$Conf{([^}]*)/ ) {
 314             my $var = $1;
 315             s/  +/ /g;
 316             s/;\s*#.*/;/;
 317             if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
 318                 s/([^;])\s*$/$1 .../;
 319             }
 320             push(@conf, $_);
 321             my $text = "\$Conf{$var}";
 322             $text =~ s/\s+/_/sg;
 323             $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
 324             $text = substr($text, 0, 50);
 325             $ConfName{$var} = "item_$text";
 326         } elsif ( /^$/ ) {
 327             if ( $str ne "" && @conf ) {
 328                 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 329                 $out .= $str;
 330                 $out .= "\n" if ( $str !~ /\n$/ );
 331             }
 332             $str = "";
 333             @conf = ();
 334         }
 335     }
 336     if ( $str ne "" && @conf ) {
 337         $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 338         $out .= $str;
 339         $out .= "\n" if ( $str !~ /\n$/ );
 340     }
 341     $out .= "=back\n\n" if ( !$first );
 342     return $out;
 343 }
 344
 345 sub CheckConfigParams
 346 {
 347     my($file, $vars, $check) = @_;
 348     my $errors;
 349
 350     open(F, $file) || die("can't open $file\n");
 351     binmode(F);
 352     if ( $check ) {
 353         while ( <F> ) {
 354             s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
 355                     print("Unexpected Conf var $2 in $file\n");
 356                     $errors++;
 357                 } else {
 358                     $vars->{$2}++;
 359                 }/eg;
 360             s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
 361                     print("Unexpected Conf var $1 in $file\n");
 362                     $errors++;
 363                 } else {
 364                     $vars->{$1}++;
 365                 }/eg;
 366             s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
 367                     print("Unexpected Conf var $1 in $file\n");
 368                     $errors++;
 369                 } else {
 370                     $vars->{$1}++;
 371                 }/eg;
 372         }
 373     } else {
 374         while ( <F> ) {
 375             s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
 376             s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
 377         }
 378     }
 379     close(F);
 380     return $errors;
 381 }
 382
 383 #
 384 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
 385 # the strings in each lib/BackupPC/Lang/*.pm file.  This makes sure
 386 # we didn't miss any translations in any of the languages.
 387 #
 388 sub CheckLangUsage
 389 {
 390     my $errors;
 391     my $vars = {};
 392
 393     foreach my $file ( (
 394                 qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail),
 395                 <lib/BackupPC/CGI/*pm>
 396             ) ) {
 397         open(F, $file) || die("can't open $file");
 398         binmode(F);
 399         while ( <F> ) {
 400             s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
 401         }
 402         close(F);
 403     }
 404
 405     foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
 406         my $done = {};
 407         open(F, $f) || die("can't open $f\n");
 408         binmode(F);
 409         while ( <F> ) {
 410             s/#.*//g;
 411             s/\$Lang{([^}]*)}/
 412                     my $var = $1;
 413                     next if ( $var =~ m{^(Reason_|Status_|backupType_)} );
 414                     next if ( $var eq "Documentation" );
 415                     if ( !defined($vars->{$var}) ) {
 416                         print("Unexpected Lang var $var in $f\n");
 417                         $errors++;
 418                     } else {
 419                         $done->{$var} = 1;
 420                     }/eg;
 421         }
 422         close(F);
 423         foreach my $v ( keys(%$vars) ) {
 424             #
 425             # skip "variables" with "$", since they are like expressions
 426             #
 427             next if ( $v =~ /\$/ );
 428             if ( !defined($done->{$v}) ) {
 429                 print("Lang var $v missing from $f\n");
 430                 $errors++;
 431             }
 432         }
 433     }
 434     return $errors;
 435 }
 436
 437 #
 438 # Pedantically check that all the html tags in each language file
 439 # match.
 440 #
 441 sub CheckLangTags
 442 {
 443     my($en, $enVars) = LangParse("lib/BackupPC/Lang/en.pm");
 444     my($errors);
 445
 446     foreach my $lang ( qw(fr.pm de.pm es.pm it.pm nl.pm) ) {
 447         my($d, $dVars) = LangParse("lib/BackupPC/Lang/$lang");
 448         foreach my $v1 ( @$en ) {
 449             my $v2 = shift(@$d);
 450             if ( $v1->{var} ne $v2->{var} ) {
 451                 print("Botch: got $lang var $v2->{var} vs en.pm $v1->{var}\n");
 452                 exit;
 453             }
 454             my $t1 = LangTextStrip($v1->{val});
 455             my $t2 = LangTextStrip($v2->{val});
 456             if ( $t1 ne $t2 ) {
 457                 print("$v1->{var}: got en.pm $t1\nvs $lang $t2\n\n");
 458                 $errors++;
 459             }
 460         }
 461     }
 462     return $errors;
 463 }
 464
 465 sub LangTextStrip
 466 {
 467     my($t) = @_;
 468
 469     $t = "" if ( $t !~ /<.*>/ );
 470     $t =~ s/^[^<]*</</s;
 471     $t =~ s/([}>])[^<]*</$1</g;
 472     $t =~ s/>[^<]*$/>/;
 473     $t =~ s/(value=)"[^"]*"/$1""/sg;
 474     $t =~ s/({h[12]\()"[^"]*"/$1""/g;
 475     $t =~ s/ENG[\s\n]*//sg;
 476     $t =~ s/^(<<EOF;\n)[^<]*/$1/g;
 477     return $t;
 478 }
 479
 480 sub LangParse
 481 {
 482     my($file) = @_;
 483     open(C, $file) || die("can't open $file");
 484     binmode(C);
 485     my($out, @lang, $var);
 486     my $comment = 1;
 487     my $allVars = {};
 488     my $endLine = undef;
 489     while ( <C> ) {
 490         if ( /^#/ && !defined($endLine) ) {
 491             if ( $comment ) {
 492                 $out .= $_;
 493             } else {
 494                 if ( $out ne "" ) {
 495                     $allVars->{$var} = @lang if ( defined($var) );
 496                     push(@lang, {
 497                         text => $out,
 498                         var => $var,
 499                     });
 500                 }
 501                 $var = undef;
 502                 $comment = 1;
 503                 $out = $_;
 504             }
 505         } elsif ( /^\s*\$Lang\{([^}]*)/ ) {
 506             $comment = 0;
 507             if ( defined($var) ) {
 508                 $allVars->{$var} = @lang if ( defined($var) );
 509                 push(@lang, {
 510                     text => $out,
 511                     var => $var,
 512                 });
 513                 $out = $_;
 514             } else {
 515                 $out .= $_;
 516             }
 517             $var = $1;
 518             $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<(.*);/ );
 519             $endLine = $1 if ( /^\s*\$Lang\{[^}]*} *= *<<'(.*)';/ );
 520         } else {
 521             $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
 522             $out .= $_;
 523         }
 524     }
 525     if ( $out ne "" ) {
 526         $allVars->{$var} = @lang if ( defined($var) );
 527         push(@lang, {
 528             text => $out,
 529             var  => $var,
 530         });
 531     }
 532     close(C);
 533     foreach my $v ( @lang ) {
 534         if ( $v->{text} =~ /\$Lang{$v->{var}}\s*=\s*(.*)/s ) {
 535             $v->{val} = $1;
 536         }
 537     }
 538     return (\@lang, $allVars);
 539 }