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