X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=configure.pl;h=28c4b8661f007dc309e8d3870b6a1144c8e001be;hp=dddb7d711328e68a10f84fc6e44e890ace1dc98b;hb=06017d5181d9c62f8cbd1c6d58d831f54d7d4ad1;hpb=c91d12b33bf294fd6e4728eeb3e582efc359acc5 diff --git a/configure.pl b/configure.pl index dddb7d7..28c4b86 100755 --- a/configure.pl +++ b/configure.pl @@ -1,4 +1,4 @@ -#!/bin/perl +#!/usr/bin/env perl #============================================================= -*-perl-*- # # configure.pl: Configuration and installation program for BackupPC @@ -9,13 +9,17 @@ # # perl configure.pl # +# To read about the command-line options for this configure script: +# +# perldoc configure.pl +# # The installation steps are described as the script runs. # # AUTHOR # Craig Barratt # # COPYRIGHT -# Copyright (C) 2001-2004 Craig Barratt +# Copyright (C) 2001-2010 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 @@ -33,7 +37,7 @@ # #======================================================================== # -# Version 2.1.0beta1, released 9 Apr 2004. +# Version 3.1.0beta0, released 3 Sep 2007. # # See http://backuppc.sourceforge.net. # @@ -43,6 +47,15 @@ use strict; 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 @@ -54,7 +67,8 @@ foreach my $pkg ( @Packages ) { if ( $pkg =~ /BackupPC/ ) { die < 0, -verbose => 2) if $opts{man}; my $DestDir = $opts{"dest-dir"}; +$DestDir = "" if ( $DestDir eq "/" ); -if ( $< != 0 ) { +if ( !$opts{"uid-ignore"} && $< != 0 ) { print < Full path to existing conf/config.pl", - $ConfigPath, - "config-path"); + if ( $ConfigFileOK && -f "/etc/BackupPC/config.pl" ) { + $ConfigPath = "/etc/BackupPC/config.pl"; + $opts{fhs} = 1 if ( !defined($opts{fhs}) ); + print < Full path to existing main config.pl", + $ConfigPath, + "config-path"); + } last if ( $ConfigPath eq "" - || ($ConfigPath =~ /^\// && -r $ConfigPath && -w $ConfigPath) ); + || ($ConfigPath =~ /^\// && -f $ConfigPath && -w $ConfigPath) ); my $problem = "is not an absolute path"; - $problem = "is not writable" if ( !-w $ConfigPath ); - $problem = "is not readable" if ( !-r $ConfigPath ); - $problem = "doesn't exist" if ( !-f $ConfigPath ); + $problem = "is not writable" if ( !-w $ConfigPath ); + $problem = "is not readable" if ( !-r $ConfigPath ); + $problem = "is not a regular file" if ( !-f $ConfigPath ); + $problem = "doesn't exist" if ( !-e $ConfigPath ); print("The file '$ConfigPath' $problem.\n"); if ( $opts{batch} ) { 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}) ); + my $bpc; if ( $ConfigPath ne "" && -r $ConfigPath ) { - (my $topDir = $ConfigPath) =~ s{/[^/]+/[^/]+$}{}; + (my $confDir = $ConfigPath) =~ s{/[^/]+$}{}; die("BackupPC::Lib->new failed\n") - if ( !($bpc = BackupPC::Lib->new($topDir, ".", 1)) ); + if ( !($bpc = BackupPC::Lib->new(".", ".", $confDir, 1)) ); %Conf = $bpc->Conf(); %OrigConf = %Conf; - $Conf{TopDir} = $topDir; + if ( !$opts{fhs} ) { + ($Conf{TopDir} = $ConfigPath) =~ s{/[^/]+/[^/]+$}{} + if ( $Conf{TopDir} eq '' ); + $bpc->{LogDir} = $Conf{LogDir} = "$Conf{TopDir}/log" + if ( $Conf{LogDir} eq '' ); + } + $bpc->{ConfDir} = $Conf{ConfDir} = $confDir; my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1); if ( $err eq "" ) { print < BackupPC should run as user", $Conf{BackupPCUser} || "backuppc", - "username"); - ($name, $passwd, $Uid, $Gid) = getpwnam($Conf{BackupPCUser}); - last if ( $name ne "" ); - print <compOk ? 3 : 0; if ( $ConfigPath eq "" && $Conf{CompressLevel} ) { @@ -321,10 +407,8 @@ BackupPC can compress pool files, but it needs the Compress::Zlib package installed (see www.cpan.org). Compression will provide around a 40% reduction in pool size, at the expense of cpu time. You can leave compression off and run BackupPC without compression, in which case you -should leave the compression level at 0 (which means off). You could -install Compress::Zlib and turn compression on later, but read the -documentation first about how to do this. Or the better choice is -to quit, install Compress::Zlib, and re-run configure.pl. +should leave the compression level at 0 (which means off). Or the better +choice is to quit, install Compress::Zlib, and re-run configure.pl. EOF } elsif ( $Conf{CompressLevel} ) { @@ -332,14 +416,12 @@ EOF print < Do you want to continue?", "y") =~ /y/i; # foreach my $dir ( qw(bin doc lib/BackupPC/CGI + lib/BackupPC/Config lib/BackupPC/Lang + lib/BackupPC/Storage lib/BackupPC/Xfer lib/BackupPC/Zip + lib/Net/FTP ) ) { 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" - || !chown($Uid, $Gid, "$DestDir$Conf{InstallDir}/$dir") ) { + || !my_chown($Uid, $Gid, "$DestDir$Conf{InstallDir}/$dir") ) { die("Failed to create or chown $DestDir$Conf{InstallDir}/$dir\n"); } else { print("Created $DestDir$Conf{InstallDir}/$dir\n"); @@ -461,9 +544,9 @@ foreach my $dir ( qw(bin doc # Create CGI image directory # foreach my $dir ( ($Conf{CgiImageDir}) ) { - next if ( $dir eq "" || -d $dir ); - mkpath("$DestDir$dir", 0, 0775); - if ( !-d "$DestDir$dir" || !chown($Uid, $Gid, "$DestDir$dir") ) { + 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 { print("Created $DestDir$dir\n"); @@ -471,69 +554,38 @@ foreach my $dir ( ($Conf{CgiImageDir}) ) { } # -# Create $TopDir's top-level directories +# Create other directories # -foreach my $dir ( qw(. conf pool cpool pc trash log) ) { - mkpath("$DestDir$Conf{TopDir}/$dir", 0, 0750) if ( !-d "$DestDir$Conf{TopDir}/$dir" ); - if ( !-d "$DestDir$Conf{TopDir}/$dir" - || !chown($Uid, $Gid, "$DestDir$Conf{TopDir}/$dir") ) { - die("Failed to create or chown $DestDir$Conf{TopDir}/$dir\n"); +foreach my $dir ( ( + "$Conf{TopDir}", + "$Conf{TopDir}/pool", + "$Conf{TopDir}/cpool", + "$Conf{TopDir}/pc", + "$Conf{TopDir}/trash", + "$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"); } else { - print("Created $DestDir$Conf{TopDir}/$dir\n"); + print("Created $DestDir$dir\n"); } } printf("Installing binaries in $DestDir$Conf{InstallDir}/bin\n"); -foreach my $prog ( qw(BackupPC BackupPC_dump BackupPC_link BackupPC_nightly - BackupPC_sendEmail BackupPC_tarCreate BackupPC_trashClean - BackupPC_tarExtract BackupPC_compressPool BackupPC_zcat - BackupPC_archive BackupPC_archiveHost - BackupPC_restore BackupPC_serverMesg BackupPC_zipCreate ) ) { - InstallFile("bin/$prog", "$DestDir$Conf{InstallDir}/bin/$prog", 0555); +foreach my $prog ( qw( + __CONFIGURE_BIN_LIST__ + ) ) { + InstallFile($prog, "$DestDir$Conf{InstallDir}/$prog", 0555); } printf("Installing library in $DestDir$Conf{InstallDir}/lib\n"); foreach my $lib ( qw( - BackupPC/Lib.pm - BackupPC/FileZIO.pm - BackupPC/Attrib.pm - BackupPC/PoolWrite.pm - BackupPC/View.pm - BackupPC/Xfer/Archive.pm - BackupPC/Xfer/Tar.pm - BackupPC/Xfer/Smb.pm - BackupPC/Xfer/Rsync.pm - BackupPC/Xfer/RsyncDigest.pm - BackupPC/Xfer/RsyncFileIO.pm - BackupPC/Zip/FileMember.pm - BackupPC/Lang/en.pm - BackupPC/Lang/fr.pm - BackupPC/Lang/es.pm - BackupPC/Lang/de.pm - BackupPC/Lang/it.pm - BackupPC/Lang/nl.pm - BackupPC/CGI/AdminOptions.pm - BackupPC/CGI/Archive.pm - BackupPC/CGI/ArchiveInfo.pm - BackupPC/CGI/Browse.pm - BackupPC/CGI/DirHistory.pm - BackupPC/CGI/EmailSummary.pm - BackupPC/CGI/GeneralInfo.pm - BackupPC/CGI/HostInfo.pm - BackupPC/CGI/Lib.pm - BackupPC/CGI/LOGlist.pm - BackupPC/CGI/Queue.pm - BackupPC/CGI/ReloadServer.pm - BackupPC/CGI/RestoreFile.pm - BackupPC/CGI/RestoreInfo.pm - BackupPC/CGI/Restore.pm - BackupPC/CGI/StartServer.pm - BackupPC/CGI/StartStopBackup.pm - BackupPC/CGI/StopServer.pm - BackupPC/CGI/Summary.pm - BackupPC/CGI/View.pm + __CONFIGURE_LIB_LIST__ ) ) { - InstallFile("lib/$lib", "$DestDir$Conf{InstallDir}/lib/$lib", 0444); + InstallFile($lib, "$DestDir$Conf{InstallDir}/$lib", 0444); } if ( $Conf{CgiImageDir} ne "" ) { @@ -552,41 +604,51 @@ if ( $Conf{CgiImageDir} ne "" ) { } 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 - solaris-backuppc debian-backuppc suse-backuppc) ) { + solaris-backuppc debian-backuppc freebsd-backuppc + freebsd-backuppc2 suse-backuppc slackware-backuppc ) ) { InstallFile("init.d/src/$init", "init.d/$init", 0444); } +printf("Making Apache configuration file for suid-perl\n"); +InstallFile("httpd/src/BackupPC.conf", "httpd/BackupPC.conf", 0644); + printf("Installing docs in $DestDir$Conf{InstallDir}/doc\n"); foreach my $doc ( qw(BackupPC.pod BackupPC.html) ) { InstallFile("doc/$doc", "$DestDir$Conf{InstallDir}/doc/$doc", 0444); } -printf("Installing config.pl and hosts in $DestDir$Conf{TopDir}/conf\n"); -InstallFile("conf/hosts", "$DestDir$Conf{TopDir}/conf/hosts", 0644) - if ( !-f "$DestDir$Conf{TopDir}/conf/hosts" ); +printf("Installing config.pl and hosts in $DestDir$Conf{ConfDir}\n"); +InstallFile("conf/hosts", "$DestDir$Conf{ConfDir}/hosts", 0644) + if ( !-f "$DestDir$Conf{ConfDir}/hosts" ); # # Now do the config file. If there is an existing config file we # merge in the new config file, adding any new configuration # parameters and deleting ones that are no longer needed. # -my $dest = "$DestDir$Conf{TopDir}/conf/config.pl"; -my ($newConf, $newVars) = ConfigParse("conf/config.pl"); +my $dest = "$DestDir$Conf{ConfDir}/config.pl"; +my ($distConf, $distVars) = ConfigParse("conf/config.pl"); my ($oldConf, $oldVars); +my ($newConf, $newVars) = ($distConf, $distVars); 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} @@ -655,6 +717,13 @@ $Conf{CgiNavBarAdminAllHosts} = 1; # $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 # @@ -689,6 +758,64 @@ if ( defined($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; +} + +# +# Apply any command-line configuration parameter settings +# +foreach my $param ( keys(%{$opts{"config-override"}}) ) { + my $val = eval { $opts{"config-override"}{$param} }; + if ( @$ ) { + printf("Can't eval --config-override setting %s=%s\n", + $param, $opts{"config-override"}{$param}); + exit(1); + } + if ( !defined($newVars->{$param}) ) { + printf("Unkown config parameter %s in --config-override\n", $param); + exit(1); + } + $newConf->[$newVars->{$param}]{text} = $opts{"config-override"}{$param}; +} + +# +# Now backup and write the config file +# my $confCopy = "$dest.pre-__VERSION__"; if ( -f $dest && !-f $confCopy ) { # @@ -699,10 +826,12 @@ if ( -f $dest && !-f $confCopy ) { my $mode = $stat[2]; my $uid = $stat[4]; my $gid = $stat[5]; - die("can't copy($dest, $confCopy)\n") unless copy($dest, $confCopy); + die("can't copy($dest, $confCopy)\n") + unless copy($dest, $confCopy); die("can't chown $uid, $gid $confCopy\n") - unless chown($uid, $gid, $confCopy); - die("can't chmod $mode $confCopy\n") unless chmod($mode, $confCopy); + unless my_chown($uid, $gid, $confCopy); + die("can't chmod $mode $confCopy\n") + unless my_chmod($mode, $confCopy); } open(OUT, ">", $dest) || die("can't open $dest for writing\n"); binmode(OUT); @@ -723,8 +852,8 @@ foreach my $var ( @$newConf ) { } close(OUT); if ( !defined($oldConf) ) { - die("can't chmod 0640 mode $dest\n") unless chmod(0640, $dest); - die("can't chown $Uid, $Gid $dest\n") unless chown($Uid, $Gid, $dest); + die("can't chmod 0640 mode $dest\n") unless my_chmod(0640, $dest); + die("can't chown $Uid, $Gid $dest\n") unless my_chown($Uid, $Gid, $dest); } if ( $Conf{CgiDir} ne "" ) { @@ -739,18 +868,20 @@ print < ) { s/__INSTALLDIR__/$Conf{InstallDir}/g; + s/__LOGDIR__/$Conf{LogDir}/g; + s/__CONFDIR__/$Conf{ConfDir}/g; s/__TOPDIR__/$Conf{TopDir}/g; + s/^(\s*my \$useFHS\s*=\s*)\d;/${1}$opts{fhs};/ + if ( $prog =~ /Lib.pm/ ); s/__BACKUPPCUSER__/$Conf{BackupPCUser}/g; s/__CGIDIR__/$Conf{CgiDir}/g; + s/__IMAGEDIR__/$Conf{CgiImageDir}/g; + s/__IMAGEDIRURL__/$Conf{CgiImageDirURL}/g; if ( $first && /^#.*bin\/perl/ ) { # # Fill in correct path to perl (no taint for >= 2.0.1). @@ -829,8 +966,8 @@ sub InstallFile close(PROG); close(OUT); } - die("can't chown $uid, $gid $dest") unless chown($uid, $gid, $dest); - die("can't chmod $mode $dest") unless chmod($mode, $dest); + die("can't chown $uid, $gid $dest") unless my_chown($uid, $gid, $dest); + die("can't chmod $mode $dest") unless my_chmod($mode, $dest); } sub FindProgram @@ -907,7 +1044,7 @@ sub ConfigMerge { my($old, $oldVars, $new, $newVars) = @_; my $posn = 0; - my $res; + my($res, $resVars); # # Find which config parameters are not needed any longer @@ -939,7 +1076,26 @@ sub ConfigMerge push(@$res, $new); } } - return $res; + for ( my $i = 0 ; $i < @$res ; $i++ ) { + $resVars->{$res->[$i]{var}} = $i; + } + return ($res, $resVars); +} + +sub my_chown +{ + my($uid, $gid, $file) = @_; + + return 1 if ( !$opts{"set-perms"} ); + return chown($uid, $gid, $file); +} + +sub my_chmod +{ + my ($mode, $file) = @_; + + return 1 if ( !$opts{"set-perms"} ); + return chmod($mode, $file); } sub prompt @@ -986,6 +1142,11 @@ Run configure.pl in batch mode. configure.pl will run without prompting the user. The other command-line options are used to specify the settings that the user is usually prompted for. +=item B<--backuppc-user=USER> + +Specify the BackupPC user name that owns all the BackupPC +files and runs the BackupPC programs. Default is backuppc. + =item B<--bin-path PROG=PATH> Specify the path for various external programs that BackupPC @@ -1003,6 +1164,17 @@ Examples --bin-path cat=/bin/cat --bin-path bzip2=/home/user/bzip2 +=item B<--compress-level=N> + +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. @@ -1038,6 +1210,13 @@ to run it from below the --dest-dir directory, since all the paths are set assuming BackupPC is installed in the intended final locations. +=item B<--fhs> + +Use locations specified by the Filesystem Hierarchy Standard +for installing BackupPC. This is enabled by default for new +installations. To use the pre-3.0 installation locations, +specify --no-fhs. + =item B<--help|?> Print a brief help message and exits. @@ -1056,7 +1235,7 @@ specified for a batch new install. Example: - --html-dir /usr/local/apache/htdocs/BackupPC + --html-dir /var/www/htdocs/BackupPC =item B<--html-dir-url URL> @@ -1078,10 +1257,21 @@ Example: --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<--set-perms> + +When installing files and creating directories, chown them to +the BackupPC user and chmod them too. This is enabled by default. +To disable (for example, if staging a destination directory) +then specify --no-set-perms. + =item B<--uid-ignore> configure.pl verifies that the script is being run as the super user @@ -1119,7 +1309,7 @@ Craig Barratt =head1 COPYRIGHT -Copyright (C) 2001-2004 Craig Barratt. +Copyright (C) 2001-2010 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