* Various changes for 3.0.0beta1

[BackupPC.git] / configure.pl

diff --git a/configure.pl b/configure.pl
index f20682a..433a016 100755 (executable)
--- a/configure.pl
+++ b/configure.pl
@@ -37,7 +37,7 @@
 #
 #========================================================================
 #
 #
 #========================================================================
 #

-# Version 2.1.0beta1, released 9 Apr 2004.
+# Version 3.0.0alpha, released 8 Jul 2006.

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


@@ -87,6 +87,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 +96,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 +107,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;


@@ -129,34 +132,42 @@ EOF
 #                
 #    InstallDir   which includes subdirs bin, lib, doc
 #
 #                
 #    InstallDir   which includes subdirs bin, lib, doc
 #

-# With FHS enabled (which is the default for new installations):
+# With FHS enabled (which is the default for new installations)
+# the config files move to /etc/BackupPC and log files to /var/log:

 #
 #    /etc/BackupPC/config.pl  main config file (was $TopDir/conf/config.pl)
 #    /etc/BackupPC/hosts      hosts file (was $TopDir/conf/hosts)
 #    /etc/BackupPC/pc/HOST.pl per-pc config file (was $TopDir/pc/HOST/config.pl)
 #    /var/log/BackupPC        log files (was $TopDir/log)
 #
 #    /etc/BackupPC/config.pl  main config file (was $TopDir/conf/config.pl)
 #    /etc/BackupPC/hosts      hosts file (was $TopDir/conf/hosts)
 #    /etc/BackupPC/pc/HOST.pl per-pc config file (was $TopDir/pc/HOST/config.pl)
 #    /var/log/BackupPC        log files (was $TopDir/log)

-#    /var/lib/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");


@@ -173,6 +184,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}) );


@@ -185,9 +197,12 @@ if ( $ConfigPath ne "" && -r $ConfigPath ) {
     %Conf = $bpc->Conf();
     %OrigConf = %Conf;
     if ( !$opts{fhs} ) {
     %Conf = $bpc->Conf();
     %OrigConf = %Conf;
     if ( !$opts{fhs} ) {

-        ($Conf{TopDir} = $ConfigPath) =~ s{/[^/]+/[^/]+$}{};
+        ($Conf{TopDir} = $ConfigPath) =~ s{/[^/]+/[^/]+$}{}
+                    if ( $Conf{TopDir} eq '' );
+        $bpc->{LogDir} = $Conf{LogDir}  = "$Conf{TopDir}/log"
+                    if ( $Conf{LogDir} eq '' );

     }
     }

-    $Conf{ConfDir} = $confDir;
+    $bpc->{ConfDir} = $Conf{ConfDir} = $confDir;

     my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1);
     if ( $err eq "" ) {
         print <<EOF;
     my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1);
     if ( $err eq "" ) {
         print <<EOF;


@@ -206,9 +221,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";

 }
 
 #
 }
 
 #


@@ -291,9 +306,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);


@@ -504,7 +518,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");


@@ -518,7 +532,7 @@ foreach my $dir ( qw(bin doc
 #
 foreach my $dir ( ($Conf{CgiImageDir}) ) {
     next if ( $dir eq "" || -d $dir );
 #
 foreach my $dir ( ($Conf{CgiImageDir}) ) {
     next if ( $dir eq "" || -d $dir );

-    mkpath("$DestDir$dir", 0, 0775);
+    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 {


@@ -538,12 +552,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");

     }
 }
 
     }
 }
 


@@ -601,18 +615,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}


@@ -715,6 +731,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 ) {
     #


@@ -768,9 +825,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.
 


@@ -805,9 +862,9 @@ EOF
 }
 
 eval "use File::RsyncP;";
 }
 
 eval "use File::RsyncP;";

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

     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.64\n");

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


@@ -939,7 +996,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


@@ -971,7 +1028,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


@@ -1061,6 +1121,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.


@@ -1143,6 +1209,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.


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

-Copyright (C) 2001-2004  Craig Barratt.
+Copyright (C) 2001-2006  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