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