Minor tweaks for 3.1.0beta0 release.

[BackupPC.git] / configure.pl

diff --git a/configure.pl b/configure.pl
index d592b8f..7ec545c 100755 (executable)
--- a/configure.pl
+++ b/configure.pl
@@ -19,7 +19,7 @@
 #   Craig Barratt <cbarratt@users.sourceforge.net>
 #
 # COPYRIGHT
 #   Craig Barratt <cbarratt@users.sourceforge.net>
 #
 # COPYRIGHT

-#   Copyright (C) 2001-2006  Craig Barratt
+#   Copyright (C) 2001-2007  Craig Barratt

 #
 #   This program is free software; you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
 #
 #   This program is free software; you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by


@@ -37,7 +37,7 @@
 #
 #========================================================================
 #
 #
 #========================================================================
 #

-# Version 3.0.0alpha, released 23 Jan 2006
+# Version 3.1.0beta0, released 3 Sep 2007.

 #
 # See http://backuppc.sourceforge.net.
 #
 #
 # See http://backuppc.sourceforge.net.
 #


@@ -47,6 +47,15 @@ use strict;
 no  utf8;
 use vars qw(%Conf %OrigConf);
 use lib "./lib";
 no  utf8;
 use vars qw(%Conf %OrigConf);
 use lib "./lib";

+use Encode;
+
+my $EncodeVersion = eval($Encode::VERSION);
+if ( $EncodeVersion < 1.99 ) {
+    print("Error: you need to upgrade perl's Encode package.\n"
+        . "I found $EncodeVersion and BackupPC needs >= 1.99\n"
+        . "Please go to www.cpan.org or use the cpan command.\n");
+    exit(1);
+}

 
 my @Packages = qw(File::Path File::Spec File::Copy DirHandle Digest::MD5
                   Data::Dumper Getopt::Std Getopt::Long Pod::Usage
 
 my @Packages = qw(File::Path File::Spec File::Copy DirHandle Digest::MD5
                   Data::Dumper Getopt::Std Getopt::Long Pod::Usage


@@ -58,7 +67,8 @@ foreach my $pkg ( @Packages ) {
     if ( $pkg =~ /BackupPC/ ) {
         die <<EOF;
 
     if ( $pkg =~ /BackupPC/ ) {
         die <<EOF;
 

-BackupPC cannot find the package $pkg, which is included in the
+Error loading $pkg: $@
+BackupPC cannot load the package $pkg, which is included in the

 BackupPC distribution.  This probably means you did not cd to the
 unpacked BackupPC distribution before running configure.pl, eg:
 
 BackupPC distribution.  This probably means you did not cd to the
 unpacked BackupPC distribution before running configure.pl, eg:
 


@@ -87,6 +97,7 @@ if ( !GetOptions(
             "cgi-dir=s",
             "compress-level=i",
             "config-path=s",
             "cgi-dir=s",
             "compress-level=i",
             "config-path=s",

+            "config-dir=s",

             "data-dir=s",
             "dest-dir=s",
             "fhs!",
             "data-dir=s",
             "dest-dir=s",
             "fhs!",


@@ -95,6 +106,7 @@ if ( !GetOptions(
             "html-dir=s",
             "html-dir-url=s",
             "install-dir=s",
             "html-dir=s",
             "html-dir-url=s",
             "install-dir=s",

+            "log-dir=s",

             "man",
             "set-perms!",
             "uid-ignore!",
             "man",
             "set-perms!",
             "uid-ignore!",


@@ -105,6 +117,7 @@ pod2usage(1) if ( $opts{help} );
 pod2usage(-exitstatus => 0, -verbose => 2) if $opts{man};
 
 my $DestDir = $opts{"dest-dir"};
 pod2usage(-exitstatus => 0, -verbose => 2) if $opts{man};
 
 my $DestDir = $opts{"dest-dir"};

+$DestDir = "" if ( $DestDir eq "/" );

 
 if ( !$opts{"uid-ignore"} && $< != 0 ) {
     print <<EOF;
 
 if ( !$opts{"uid-ignore"} && $< != 0 ) {
     print <<EOF;


@@ -139,25 +152,32 @@ EOF
 #    /var/log/BackupPC        Pid, status and email info (was $TopDir/log)
 #
 
 #    /var/log/BackupPC        Pid, status and email info (was $TopDir/log)
 #
 

-print <<EOF if ( !$opts{fhs} || !-f "/etc/BackupPC/config.pl" );
-
-Is this a new installation or upgrade for BackupPC?  If this is
-an upgrade please tell me the full path of the existing BackupPC
-configuration file (eg: /etc/BackupPC/config.pl).  Otherwise, just
-hit return.
-
-EOF
-

 #
 # Check if this is an upgrade, in which case read the existing
 # config file to get all the defaults.
 #
 my $ConfigPath = "";
 #
 # Check if this is an upgrade, in which case read the existing
 # config file to get all the defaults.
 #
 my $ConfigPath = "";

+my $ConfigFileOK = 1;

 while ( 1 ) {
 while ( 1 ) {

-    if ( -f "/etc/BackupPC/config.pl" ) {
+    if ( $ConfigFileOK && -f "/etc/BackupPC/config.pl" ) {

         $ConfigPath = "/etc/BackupPC/config.pl";
         $opts{fhs} = 1 if ( !defined($opts{fhs}) );
         $ConfigPath = "/etc/BackupPC/config.pl";
         $opts{fhs} = 1 if ( !defined($opts{fhs}) );

+        print <<EOF;
+
+Found /etc/BackupPC/config.pl, so this is an upgrade of an
+existing BackupPC installation.  We will verify some existing
+information, but you will probably not need to make any
+changes - just hit ENTER to each question.
+EOF

     } else {
     } else {

+        print <<EOF;
+
+Is this a new installation or upgrade for BackupPC?  If this is
+an upgrade please tell me the full path of the existing BackupPC
+configuration file (eg: /etc/BackupPC/config.pl).  Otherwise, just
+hit return.
+
+EOF

         $ConfigPath = prompt("--> Full path to existing main config.pl",
                              $ConfigPath,
                              "config-path");
         $ConfigPath = prompt("--> Full path to existing main config.pl",
                              $ConfigPath,
                              "config-path");


@@ -174,6 +194,7 @@ while ( 1 ) {
         print("Need to specify a valid --config-path for upgrade\n");
         exit(1);
     }
         print("Need to specify a valid --config-path for upgrade\n");
         exit(1);
     }

+    $ConfigFileOK = 0;

 }
 $opts{fhs} = 1 if ( !defined($opts{fhs}) && $ConfigPath eq "" );
 $opts{fhs} = 0 if ( !defined($opts{fhs}) );
 }
 $opts{fhs} = 1 if ( !defined($opts{fhs}) && $ConfigPath eq "" );
 $opts{fhs} = 0 if ( !defined($opts{fhs}) );


@@ -210,9 +231,9 @@ EOF
 #
 if ( $opts{fhs} ) {
     $Conf{TopDir}       ||= "/data/BackupPC";
 #
 if ( $opts{fhs} ) {
     $Conf{TopDir}       ||= "/data/BackupPC";

-    $Conf{ConfDir}      ||= "/etc/BackupPC";
+    $Conf{ConfDir}      ||= $opts{"config-dir"} || "/etc/BackupPC";

     $Conf{InstallDir}   ||= "/usr/local/BackupPC";
     $Conf{InstallDir}   ||= "/usr/local/BackupPC";

-    $Conf{LogDir}       ||= "/var/log/BackupPC";
+    $Conf{LogDir}       ||= $opts{"log-dir"} || "/var/log/BackupPC";

 }
 
 #
 }
 
 #


@@ -262,13 +283,13 @@ EOF
     }
 }
 
     }
 }
 

-my $Perl56 = system($Conf{PerlPath}
-                        . q{ -e 'exit($^V && $^V ge v5.6.0 ? 1 : 0);'});
+my $Perl58 = system($Conf{PerlPath}
+                        . q{ -e 'exit($^V && $^V ge v5.8.0 ? 1 : 0);'});

 
 

-if ( !$Perl56 ) {
+if ( !$Perl58 ) {

     print <<EOF;
 
     print <<EOF;
 

-BackupPC needs perl version 5.6.0 or later.  $Conf{PerlPath} appears
+BackupPC needs perl version 5.8.0 or later.  $Conf{PerlPath} appears

 to be an older version.  Please upgrade to a newer version of perl
 and re-run this configure script.
 
 to be an older version.  Please upgrade to a newer version of perl
 and re-run this configure script.
 


@@ -295,9 +316,8 @@ the main data directory and read/execute permission on the install
 directory (these directories will be setup shortly).
 
 The primary group for this user should also be chosen carefully.
 directory (these directories will be setup shortly).
 
 The primary group for this user should also be chosen carefully.

-By default the install directories will have group write permission.
-The data directories and files will have group read permission but
-no other permission.
+The data directories and files will have group read permission,
+so group members can access backup files.

 
 EOF
 my($name, $passwd, $Uid, $Gid);
 
 EOF
 my($name, $passwd, $Uid, $Gid);


@@ -315,6 +335,8 @@ check the name and verify that this user is in the passwd file.
 
 EOF
         exit(1) if ( $opts{batch} );
 
 EOF
         exit(1) if ( $opts{batch} );

+    } else {
+        last;

     }
 }
 
     }
 }
 


@@ -338,10 +360,10 @@ while ( 1 ) {
 
 print <<EOF;
 
 
 print <<EOF;
 

-Please specify a data directory for BackupPC.  This is where the
-all the PC backup data is stored.  This file system needs to be
-big enough to accommodate all the PCs you expect to backup (eg:
-at least several GB per machine).
+Please specify a data directory for BackupPC.  This is where all the
+PC backup data is stored.  This file system needs to be big enough to
+accommodate all the PCs you expect to backup (eg: at least several GB
+per machine).

 
 EOF
 
 
 EOF
 


@@ -452,7 +474,7 @@ if ( $Conf{CgiDir} ne "" ) {
 
 BackupPC's CGI script needs to display various GIF images that
 should be stored where Apache can serve them.  They should be
 
 BackupPC's CGI script needs to display various GIF images that
 should be stored where Apache can serve them.  They should be

-placed somewher under Apache's DocumentRoot.  BackupPC also
+placed somewhere under Apache's DocumentRoot.  BackupPC also

 needs to know the URL to access these images.  Example:
 
     Apache image directory:  /usr/local/apache/htdocs/BackupPC
 needs to know the URL to access these images.  Example:
 
     Apache image directory:  /usr/local/apache/htdocs/BackupPC


@@ -508,7 +530,7 @@ foreach my $dir ( qw(bin doc
                     lib/BackupPC/Zip
                 ) ) {
     next if ( -d "$DestDir$Conf{InstallDir}/$dir" );
                     lib/BackupPC/Zip
                 ) ) {
     next if ( -d "$DestDir$Conf{InstallDir}/$dir" );

-    mkpath("$DestDir$Conf{InstallDir}/$dir", 0, 0775);
+    mkpath("$DestDir$Conf{InstallDir}/$dir", 0, 0755);

     if ( !-d "$DestDir$Conf{InstallDir}/$dir"
             || !my_chown($Uid, $Gid, "$DestDir$Conf{InstallDir}/$dir") ) {
         die("Failed to create or chown $DestDir$Conf{InstallDir}/$dir\n");
     if ( !-d "$DestDir$Conf{InstallDir}/$dir"
             || !my_chown($Uid, $Gid, "$DestDir$Conf{InstallDir}/$dir") ) {
         die("Failed to create or chown $DestDir$Conf{InstallDir}/$dir\n");


@@ -521,8 +543,8 @@ foreach my $dir ( qw(bin doc
 # Create CGI image directory
 #
 foreach my $dir ( ($Conf{CgiImageDir}) ) {
 # Create CGI image directory
 #
 foreach my $dir ( ($Conf{CgiImageDir}) ) {

-    next if ( $dir eq "" || -d $dir );
-    mkpath("$DestDir$dir", 0, 0775);
+    next if ( $dir eq "" || -d "$DestDir$dir" );
+    mkpath("$DestDir$dir", 0, 0755);

     if ( !-d "$DestDir$dir" || !my_chown($Uid, $Gid, "$DestDir$dir") ) {
         die("Failed to create or chown $DestDir$dir");
     } else {
     if ( !-d "$DestDir$dir" || !my_chown($Uid, $Gid, "$DestDir$dir") ) {
         die("Failed to create or chown $DestDir$dir");
     } else {


@@ -542,12 +564,12 @@ foreach my $dir ( (
             "$Conf{ConfDir}",
             "$Conf{LogDir}",
         ) ) {
             "$Conf{ConfDir}",
             "$Conf{LogDir}",
         ) ) {

-    mkpath("$DestDir/$dir", 0, 0750) if ( !-d "$DestDir/$dir" );
-    if ( !-d "$DestDir/$dir"
-            || !my_chown($Uid, $Gid, "$DestDir/$dir") ) {
-        die("Failed to create or chown $DestDir/$dir\n");
+    mkpath("$DestDir$dir", 0, 0750) if ( !-d "$DestDir$dir" );
+    if ( !-d "$DestDir$dir"
+            || !my_chown($Uid, $Gid, "$DestDir$dir") ) {
+        die("Failed to create or chown $DestDir$dir\n");

     } else {
     } else {

-        print("Created $DestDir/$dir\n");
+        print("Created $DestDir$dir\n");

     }
 }
 
     }
 }
 


@@ -581,12 +603,16 @@ if ( $Conf{CgiImageDir} ne "" ) {
     }
     InstallFile("conf/BackupPC_stnd.css",
                "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", 0444, 0);
     }
     InstallFile("conf/BackupPC_stnd.css",
                "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", 0444, 0);

+    InstallFile("conf/BackupPC_stnd_orig.css",
+               "$DestDir$Conf{CgiImageDir}/BackupPC_stnd_orig.css", 0444, 0);
+    InstallFile("conf/sorttable.js",
+                "$DestDir$Conf{CgiImageDir}/sorttable.js", 0444, 0);

 }
 
 printf("Making init.d scripts\n");
 foreach my $init ( qw(gentoo-backuppc gentoo-backuppc.conf linux-backuppc
 }
 
 printf("Making init.d scripts\n");
 foreach my $init ( qw(gentoo-backuppc gentoo-backuppc.conf linux-backuppc

-                     solaris-backuppc debian-backuppc suse-backuppc
-                     slackware-backuppc ) ) {
+                     solaris-backuppc debian-backuppc freebsd-backuppc
+                      suse-backuppc slackware-backuppc ) ) {

     InstallFile("init.d/src/$init", "init.d/$init", 0444);
 }
 
     InstallFile("init.d/src/$init", "init.d/$init", 0444);
 }
 


@@ -605,18 +631,20 @@ InstallFile("conf/hosts", "$DestDir$Conf{ConfDir}/hosts", 0644)
 # parameters and deleting ones that are no longer needed.
 #
 my $dest = "$DestDir$Conf{ConfDir}/config.pl";
 # parameters and deleting ones that are no longer needed.
 #
 my $dest = "$DestDir$Conf{ConfDir}/config.pl";

-my ($newConf, $newVars) = ConfigParse("conf/config.pl");
+my ($distConf, $distVars) = ConfigParse("conf/config.pl");

 my ($oldConf, $oldVars);
 my ($oldConf, $oldVars);

+my ($newConf, $newVars) = ($distConf, $distVars);

 if ( -f $dest ) {
     ($oldConf, $oldVars) = ConfigParse($dest);
 if ( -f $dest ) {
     ($oldConf, $oldVars) = ConfigParse($dest);

-    $newConf = ConfigMerge($oldConf, $oldVars, $newConf, $newVars);
+    ($newConf, $newVars) = ConfigMerge($oldConf, $oldVars, $distConf, $distVars);

 }
 }

-$Conf{EMailFromUserName}  ||= $Conf{BackupPCUser};
-$Conf{EMailAdminUserName} ||= $Conf{BackupPCUser};

 
 #
 
 #

-# Update various config parameters
+# Update various config parameters.  The old config is in Conf{}
+# and the new config is an array in text form in $newConf->[].

 #
 #

+$Conf{EMailFromUserName}  ||= $Conf{BackupPCUser};
+$Conf{EMailAdminUserName} ||= $Conf{BackupPCUser};

 
 #
 # Guess $Conf{CgiURL}
 
 #
 # Guess $Conf{CgiURL}


@@ -685,6 +713,13 @@ $Conf{CgiNavBarAdminAllHosts} = 1;
 #
 $Conf{IncrFill} = 0;
 
 #
 $Conf{IncrFill} = 0;
 

+#
+# Empty $Conf{ParPath} if it isn't a valid executable
+# (pre-3.0.0 configure.pl incorrectly set it to a
+# hardcoded value).
+#
+$Conf{ParPath} = '' if ( $Conf{ParPath} ne '' && !-x $Conf{ParPath} );
+

 #
 # Figure out sensible arguments for the ping command
 #
 #
 # Figure out sensible arguments for the ping command
 #


@@ -719,6 +754,47 @@ if ( defined($Conf{SmbClientTimeout}) ) {
     delete($Conf{SmbClientTimeout});
 }
 
     delete($Conf{SmbClientTimeout});
 }
 

+#
+# Replace --devices with -D in RsyncArgs and RsyncRestoreArgs
+#
+foreach my $param ( qw(RsyncArgs RsyncRestoreArgs) ) {
+    next if ( !defined($newVars->{$param}) );
+    $newConf->[$newVars->{$param}]{text} =~ s/--devices/-D/g;
+}
+
+#
+# Merge any new user-editable parameters into CgiUserConfigEdit
+# by copying the old settings forward.
+#
+if ( defined($Conf{CgiUserConfigEdit}) ) {
+    #
+    # This is a real hack.  The config file merging is done in text
+    # form without actually instantiating the new conf structure.
+    # So we need to extract the new hash of settings, update it,
+    # and merge the text.  Ugh...
+    #
+    my $new;
+    my $str = $distConf->[$distVars->{CgiUserConfigEdit}]{text};
+
+    $str =~ s/^\s*\$Conf\{.*?\}\s*=\s*/\$new = /m;
+    eval($str);
+    foreach my $p ( keys(%$new) ) {
+        $new->{$p} = $Conf{CgiUserConfigEdit}{$p}
+                if ( defined($Conf{CgiUserConfigEdit}{$p}) );
+    }
+    $Conf{CgiUserConfigEdit} = $new;
+    my $d = Data::Dumper->new([$new], [*value]);
+    $d->Indent(1);
+    $d->Terse(1);
+    my $value = $d->Dump;
+    $value =~ s/(.*)\n/$1;\n/s;
+    $newConf->[$newVars->{CgiUserConfigEdit}]{text}
+            =~ s/(\s*\$Conf\{.*?\}\s*=\s*).*/$1$value/s;
+}
+
+#
+# Now backup and write the config file
+#

 my $confCopy = "$dest.pre-__VERSION__";
 if ( -f $dest && !-f $confCopy ) {
     #
 my $confCopy = "$dest.pre-__VERSION__";
 if ( -f $dest && !-f $confCopy ) {
     #


@@ -772,9 +848,9 @@ Ok, it looks like we are finished.  There are several more things you
 will need to do:
 
   - Browse through the config file, $Conf{ConfDir}/config.pl,
 will need to do:
 
   - Browse through the config file, $Conf{ConfDir}/config.pl,

-    and make sure all the settings are correct.  In particular, you
-    will need to set the smb share password and user name, backup
-    policies and check the email message headers and bodies.
+    and make sure all the settings are correct.  In particular,
+    you will need to set \$Conf{CgiAdminUsers} so you have
+    administration privileges in the CGI interface.

 
   - Edit the list of hosts to backup in $Conf{ConfDir}/hosts.
 
 
   - Edit the list of hosts to backup in $Conf{ConfDir}/hosts.
 


@@ -783,6 +859,8 @@ will need to do:
 
   - Verify that the CGI script BackupPC_Admin runs correctly.  You might
     need to change the permissions or group ownership of BackupPC_Admin.
 
   - Verify that the CGI script BackupPC_Admin runs correctly.  You might
     need to change the permissions or group ownership of BackupPC_Admin.

+    If this is an upgrade and you are using mod_perl, you will need
+    to restart Apache.  Otherwise it will have stale code.

 
   - BackupPC should be ready to start.  Don't forget to run it
     as user $Conf{BackupPCUser}!  The installation also contains an
 
   - BackupPC should be ready to start.  Don't forget to run it
     as user $Conf{BackupPCUser}!  The installation also contains an


@@ -809,9 +887,9 @@ EOF
 }
 
 eval "use File::RsyncP;";
 }
 
 eval "use File::RsyncP;";

-if ( !$@ && $File::RsyncP::VERSION < 0.52 ) {
+if ( !$@ && $File::RsyncP::VERSION < 0.68 ) {

     print("\nWarning: you need to upgrade File::RsyncP;"
     print("\nWarning: you need to upgrade File::RsyncP;"

-        . " I found $File::RsyncP::VERSION and BackupPC needs 0.52\n");
+        . " I found $File::RsyncP::VERSION and BackupPC needs 0.68\n");

 }
 
 exit(0);
 }
 
 exit(0);


@@ -943,7 +1021,7 @@ sub ConfigMerge
 {
     my($old, $oldVars, $new, $newVars) = @_;
     my $posn = 0;
 {
     my($old, $oldVars, $new, $newVars) = @_;
     my $posn = 0;

-    my $res;
+    my($res, $resVars);

 
     #
     # Find which config parameters are not needed any longer
 
     #
     # Find which config parameters are not needed any longer


@@ -975,7 +1053,10 @@ sub ConfigMerge
             push(@$res, $new);
         }
     }
             push(@$res, $new);
         }
     }

-    return $res;
+    for ( my $i = 0 ; $i < @$res ; $i++ ) {
+        $resVars->{$res->[$i]{var}} = $i;
+    }
+    return ($res, $resVars);

 }
 
 sub my_chown
 }
 
 sub my_chown


@@ -1065,6 +1146,12 @@ Examples
 Set the configuration compression level to N.  Default is 3
 if Compress::Zlib is installed.
 
 Set the configuration compression level to N.  Default is 3
 if Compress::Zlib is installed.
 

+=item B<--config-dir CONFIG_DIR>
+
+Configuration directory for new installations.  Defaults
+to /etc/BackupPC with FHS.  Automatically extracted
+from --config-path for existing installations.
+

 =item B<--config-path CONFIG_PATH>
 
 Path to the existing config.pl configuration file for BackupPC.
 =item B<--config-path CONFIG_PATH>
 
 Path to the existing config.pl configuration file for BackupPC.


@@ -1104,7 +1191,7 @@ final locations.
 
 Use locations specified by the Filesystem Hierarchy Standard
 for installing BackupPC.  This is enabled by default for new
 
 Use locations specified by the Filesystem Hierarchy Standard
 for installing BackupPC.  This is enabled by default for new

-installatios.  To use the pre-3.0 installation locations,
+installations.  To use the pre-3.0 installation locations,

 specify --no-fhs.
 
 =item B<--help|?>
 specify --no-fhs.
 
 =item B<--help|?>


@@ -1147,6 +1234,10 @@ Example:
 
     --install-dir /usr/local/BackupPC
 
 
     --install-dir /usr/local/BackupPC
 

+=item B<--log-dir LOG_DIR>
+
+Log directory.  Defaults to /var/log/BackupPC with FHS.
+

 =item B<--man>
 
 Prints the manual page and exits.
 =item B<--man>
 
 Prints the manual page and exits.


@@ -1195,7 +1286,7 @@ Craig Barratt <cbarratt@users.sourceforge.net>
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 

-Copyright (C) 2001-2004  Craig Barratt.
+Copyright (C) 2001-2007  Craig Barratt.

 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by