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
  42 umask(0022);
  43
  44 my $Version     = "2.0.0beta3";
  45 my $ReleaseDate = "1 Jun 2003";
  46 my $DistDir     = "dist/BackupPC-$Version";
  47
  48 my @PerlSrc = qw(
  49     bin/BackupPC
  50     bin/BackupPC_dump
  51     bin/BackupPC_link
  52     bin/BackupPC_nightly
  53     bin/BackupPC_restore
  54     bin/BackupPC_sendEmail
  55     bin/BackupPC_serverMesg
  56     bin/BackupPC_trashClean
  57     bin/BackupPC_tarExtract
  58     bin/BackupPC_tarCreate
  59     bin/BackupPC_compressPool
  60     bin/BackupPC_zipCreate
  61     bin/BackupPC_zcat
  62     lib/BackupPC/Attrib.pm
  63     lib/BackupPC/FileZIO.pm
  64     lib/BackupPC/Lib.pm
  65     lib/BackupPC/Lang/de.pm
  66     lib/BackupPC/Lang/en.pm
  67     lib/BackupPC/Lang/es.pm
  68     lib/BackupPC/Lang/fr.pm
  69     lib/BackupPC/PoolWrite.pm
  70     lib/BackupPC/View.pm
  71     lib/BackupPC/Xfer/Smb.pm
  72     lib/BackupPC/Xfer/Tar.pm
  73     lib/BackupPC/Xfer/Rsync.pm
  74     lib/BackupPC/Xfer/RsyncFileIO.pm
  75     lib/BackupPC/Zip/FileMember.pm
  76     cgi-bin/BackupPC_Admin
  77 );
  78
  79 #
  80 # Check config parameters
  81 #
  82 my $ConfVars = {};
  83 my $errCnt;
  84
  85 $errCnt += CheckConfigParams("conf/config.pl", $ConfVars, 0);
  86 $ConfVars->{BackupPCUser} = 2;
  87 $ConfVars->{CgiDir} = 2;
  88 $ConfVars->{InstallDir} = 2;
  89 $ConfVars->{CgiImageDir} = 2;
  90 foreach my $file ( @PerlSrc ) {
  91     $errCnt += CheckConfigParams($file, $ConfVars, 1);
  92 }
  93 $errCnt += CheckLangUsage();
  94 exit(1) if ( $errCnt );
  95
  96 foreach my $var ( sort(keys(%$ConfVars) ) ) {
  97     next if ( $ConfVars->{$var} >= 2 || $var =~ /^\$/ );
  98     printf("Unused config parameter $var\n");
  99     $errCnt++;
 100 }
 101 exit(1) if ( $errCnt );
 102
 103 rmtree($DistDir, 0, 0);
 104 mkpath($DistDir, 0, 0777);
 105
 106 foreach my $dir ( qw(bin lib/BackupPC/Xfer lib/BackupPC/Zip lib/BackupPC/Lang
 107                      doc conf images init.d/src cgi-bin) ) {
 108     mkpath("$DistDir/$dir", 0, 0777);
 109 }
 110
 111 my %ConfName;
 112 my $ConfPod = config2pod();
 113 rmtree("doc", 0, 0);
 114 mkpath("doc", 0, 0777);
 115 InstallFile("doc-src/BackupPC.pod", "doc/BackupPC.pod");
 116
 117 use Pod::Html;
 118 pod2html("doc/BackupPC.pod",
 119         "--backlink=Back to Top",
 120         "--header",
 121         "--title=BackupPC",
 122         "--outfile=doc/BackupPC.html");
 123
 124 foreach my $file ( (@PerlSrc,
 125             <images/*>,
 126             qw(
 127                 conf/config.pl
 128                 conf/hosts
 129                 init.d/README
 130                 init.d/src/debian-backuppc
 131                 init.d/src/gentoo-backuppc
 132                 init.d/src/gentoo-backuppc.conf
 133                 init.d/src/linux-backuppc
 134                 init.d/src/solaris-backuppc
 135                 init.d/src/suse-backuppc
 136                 doc/BackupPC.pod
 137                 doc/BackupPC.html
 138                 README
 139                 LICENSE
 140                 ChangeLog
 141                 configure.pl
 142         )) ) {
 143     InstallFile("$file", "$DistDir/$file");
 144 }
 145 rmtree("doc", 0, 0);
 146 system("cd dist ; tar zcf BackupPC-$Version.tar.gz BackupPC-$Version");
 147 print("Distribution written to dist/BackupPC-$Version.tar.gz\n");
 148 unlink("pod2htmd.x~~");
 149 unlink("pod2htmi.x~~");
 150
 151 ###########################################################################
 152 # Subroutines
 153 ###########################################################################
 154
 155 sub InstallFile
 156 {
 157     my($file, $dest) = @_;
 158
 159     unlink($dest) if ( -d $dest );
 160     if ( $file =~ /\.gif/ ) {
 161         die("can't copy($file, $dest)\n") unless copy($file, $dest);
 162     } else {
 163         open(FILE, $file)   || die("can't open $file for reading\n");
 164         open(OUT, ">$dest") || die("can't open $dest for writing\n");
 165         while ( <FILE> ) {
 166             s/^# *Version \d+\.\d+[\.\w]*, released \d+ \w+ \d{4}\.?/# Version __VERSION__, released __RELEASEDATE__./;
 167             s/__VERSION__/$Version/g;
 168             s/__RELEASEDATE__/$ReleaseDate/g;
 169             if ( $file =~ /BackupPC\.html$/ && !/A NAME="item_%24Conf/ ) {
 170                 s/\$Conf{([^}]*)}/
 171                         defined($ConfName{$1})
 172                             ? "<A HREF=\"#$ConfName{$1}\">\$Conf{$1}<\/A>"
 173                             : "\$Conf{$1}"/eg;
 174             }
 175             if ( /__CONFIGPOD__/ ) {
 176                 print OUT $ConfPod;
 177             } elsif ( /^use lib ".*BackupPC\/lib";/
 178                     || /^use lib "\/home\/pcbackup\/install\/lib";/ ) {
 179                 print OUT "use lib \"__INSTALLDIR__/lib\";\n";
 180             } elsif ( $file =~ /Lib.pm/ && /(.*TopDir *=> .*)'.*',/ ) {
 181                 print OUT "$1'__TOPDIR__',\n";
 182             } elsif ( $file =~ /Lib.pm/ && /(.*Version *=> .*)'[\w\d\.]+',/ ) {
 183                 print OUT "$1'$Version',\n";
 184             } elsif ( $file =~ /Lib.pm/ && /(.*BinDir *=> .*)'.*',/ ) {
 185                 print OUT "$1'__INSTALLDIR__',\n";
 186             } elsif ( $file =~ /Lib.pm/ && /(.*LibDir *=> .*)'.*',/ ) {
 187                 print OUT "$1'__INSTALLDIR__',\n";
 188             } else {
 189                 print OUT;
 190             }
 191         }
 192         close(FILE);
 193         close(OUT);
 194     }
 195     if ( -x $file ) {
 196         chmod(0555, $dest);
 197     } else {
 198         chmod(0444, $dest);
 199     }
 200 }
 201
 202 sub config2pod
 203 {
 204     open(C, "conf/config.pl") || die("can't open conf/config.pl");
 205     my($str, $out, $getHdr, @conf);
 206     my $first = 1;
 207     while ( <C> ) {
 208         chomp;
 209         s/ +$//;
 210         if ( /^#########################/ ) {
 211             if ( $getHdr ) {
 212                 $str =~ s/\n.*//sg;
 213                 $out .= "=back\n\n" if ( !$first );
 214                 $out .= "=head2 $str\n\n=over 4\n\n";
 215                 $str = "";
 216                 $first = 0;
 217             }
 218             $getHdr = !$getHdr;
 219             next;
 220         }
 221         if ( /^#/ ) {
 222             s/# ?//;
 223             next if ( $str eq "" && /^$/ );
 224             $str .= $_ . "\n";
 225             $str .= "\n" if ( $str =~ /examples?:\n$/i );
 226         } elsif ( /^\$Conf{([^}]*)/ ) {
 227             my $var = $1;
 228             s/  +/ /g;
 229             s/;\s*#.*/;/;
 230             if ( !s/\[$/[ ... ];/ && !s/<<'EOF'/.../ ) {
 231                 s/([^;])\s*$/$1 .../;
 232             }
 233             push(@conf, $_);
 234             my $text = $_;
 235             $text =~ s/\s+/_/sg;
 236             $text =~ s{(\W)}{sprintf("%%%02X", ord($1) )}gxe;
 237             $text = substr($text, 0, 50);
 238             $ConfName{$var} = "item_$text";
 239         } elsif ( /^$/ ) {
 240             if ( $str ne "" && @conf ) {
 241                 $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 242                 $out .= $str;
 243                 $out .= "\n" if ( $str !~ /\n$/ );
 244             }
 245             $str = "";
 246             @conf = ();
 247         }
 248     }
 249     if ( $str ne "" && @conf ) {
 250         $out .= "=item " . join("\n\n=item ", @conf) . "\n\n";
 251         $out .= $str;
 252         $out .= "\n" if ( $str !~ /\n$/ );
 253     }
 254     $out .= "=back\n\n" if ( !$first );
 255     return $out;
 256 }
 257
 258 sub CheckConfigParams
 259 {
 260     my($file, $vars, $check) = @_;
 261     my $errors;
 262
 263     open(F, $file) || die("can't open $file\n");
 264     if ( $check ) {
 265         while ( <F> ) {
 266             s/\$(self|bpc)->{Conf}{([^}\$]+)}/if ( !defined($vars->{$2}) ) {
 267                     print("Unexpected Conf var $2 in $file\n");
 268                     $errors++;
 269                 } else {
 270                     $vars->{$2}++;
 271                 }/eg;
 272             s/\$[Cc]onf(?:->)?{([^}\$]+)}/if ( !defined($vars->{$1}) ) {
 273                     print("Unexpected Conf var $1 in $file\n");
 274                     $errors++;
 275                 } else {
 276                     $vars->{$1}++;
 277                 }/eg;
 278             s/UserCommandRun\("([^"]*)"\)/if ( !defined($vars->{$1}) ) {
 279                     print("Unexpected Conf var $1 in $file\n");
 280                     $errors++;
 281                 } else {
 282                     $vars->{$1}++;
 283                 }/eg;
 284         }
 285     } else {
 286         while ( <F> ) {
 287             s/^[^#]*\$self->{Conf}{([^}]*)/$vars->{$1} = 1;/eg;
 288             s/^[^#]*\$Conf{([^}]*)/$vars->{$1} = 1;/eg;
 289         }
 290     }
 291     close(F);
 292     return $errors;
 293 }
 294
 295 #
 296 # Make sure that every lang variable in cgi-bin/BackupPC_Admin matches
 297 # the strings in each lib/BackupPC/Lang/*.pm file.  This makes sure
 298 # we didn't miss any translations in any of the languages.
 299 #
 300 sub CheckLangUsage
 301 {
 302     my $errors;
 303     my $vars = {};
 304
 305     foreach my $file ( qw(cgi-bin/BackupPC_Admin bin/BackupPC_sendEmail) ) {
 306         open(F, $file) || die("can't open $file");
 307         while ( <F> ) {
 308             s/\$Lang->{([^}]*)}/$vars->{$1} = 1;/eg;
 309         }
 310         close(F);
 311     }
 312     foreach my $f ( <lib/BackupPC/Lang/*.pm> ) {
 313         my $done = {};
 314         open(F, $f) || die("can't open $f\n");
 315         while ( <F> ) {
 316             s/#.*//g;
 317             s/\$Lang{([^}]*)}/
 318                     my $var = $1;
 319                     next if ( $var =~ m{^(Reason_|Status_)} );
 320                     if ( !defined($vars->{$var}) ) {
 321                         print("Unexpected Lang var $var in $f\n");
 322                         $errors++;
 323                     } else {
 324                         $done->{$var} = 1;
 325                     }/eg;
 326         }
 327         close(F);
 328         foreach my $v ( keys(%$vars) ) {
 329             #
 330             # skip "variables" with "$", since they are like expressions
 331             #
 332             next if ( $v =~ /\$/ );
 333             if ( !defined($done->{$v}) ) {
 334                 print("Lang var $v missing from $f\n");
 335                 $errors++;
 336             }
 337         }
 338     }
 339     return $errors;
 340 }