2 #============================================================= -*-perl-*-
4 # configure.pl: Configuration and installation program for BackupPC
8 # This script should be run as root:
12 # The installation steps are described as the script runs.
15 # Craig Barratt <cbarratt@users.sourceforge.net>
18 # Copyright (C) 2001-2003 Craig Barratt
20 # This program is free software; you can redistribute it and/or modify
21 # it under the terms of the GNU General Public License as published by
22 # the Free Software Foundation; either version 2 of the License, or
23 # (at your option) any later version.
25 # This program is distributed in the hope that it will be useful,
26 # but WITHOUT ANY WARRANTY; without even the implied warranty of
27 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 # GNU General Public License for more details.
30 # You should have received a copy of the GNU General Public License
31 # along with this program; if not, write to the Free Software
32 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #========================================================================
36 # Version 2.0.0_CVS, released 18 Jan 2003.
38 # See http://backuppc.sourceforge.net.
40 #========================================================================
44 use vars qw(%Conf %OrigConf);
47 my @Packages = qw(ExtUtils::MakeMaker File::Path File::Spec File::Copy
48 DirHandle Digest::MD5 Data::Dumper Getopt::Std
49 BackupPC::Lib BackupPC::FileZIO);
51 foreach my $pkg ( @Packages ) {
56 BackupPC needs the package $pkg. Please install $pkg
57 before installing BackupPC.
65 This configure script should be run as root, rather than uid $<.
66 Provided uid $< has sufficient permissions to create the data and
67 install directories, then it should be ok to proceed. Otherwise,
68 please quit and restart as root.
71 exit unless prompt("--> Do you want to continue?", "y") =~ /y/i;
76 Is this a new installation or upgrade for BackupPC? If this is
77 an upgrade please tell me the full path of the existing BackupPC
78 configuration file (eg: /xxxx/conf/config.pl). Otherwise, just
84 # Check if this is an upgrade, in which case read the existing
85 # config file to get all the defaults.
89 $ConfigPath = prompt("--> Full path to existing conf/config.pl",
91 last if ( $ConfigPath eq ""
92 || ($ConfigPath =~ /^\// && -r $ConfigPath && -w $ConfigPath) );
93 my $problem = "is not an absolute path";
94 $problem = "is not writable" if ( !-w $ConfigPath );
95 $problem = "is not readable" if ( !-r $ConfigPath );
96 $problem = "doesn't exist" if ( !-f $ConfigPath );
97 print("The file '$ConfigPath' $problem.\n");
100 if ( $ConfigPath ne "" && -r $ConfigPath ) {
101 (my $topDir = $ConfigPath) =~ s{/[^/]+/[^/]+$}{};
102 die("BackupPC::Lib->new failed\n")
103 if ( !($bpc = BackupPC::Lib->new($topDir, ".", 1)) );
104 %Conf = $bpc->Conf();
106 $Conf{TopDir} = $topDir;
107 my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1);
111 BackupPC is running on $Conf{ServerHost}. You need to stop BackupPC
112 before you can upgrade the code. Depending upon your installation,
113 you could run "/etc/init.d/backuppc stop".
121 # These are the programs whose paths we need to find
125 'gtar/tar' => "TarClientPath",
126 smbclient => "SmbClientPath",
127 nmblookup => "NmbLookupPath",
128 rsync => "RsyncClientPath",
131 'ssh/ssh2' => "SshPath",
132 sendmail => "SendmailPath",
133 hostname => "HostnamePath",
134 split => "SplitPath",
135 'parchive/par' => "ParPath",
138 bzip2 => "Bzip2Path",
141 foreach my $prog ( sort(keys(%Programs)) ) {
143 foreach my $subProg ( split(/\//, $prog) ) {
144 $path ||= FindProgram("$ENV{PATH}:/bin:/usr/bin:/sbin:/usr/sbin",
147 $Conf{$Programs{$prog}} ||= $path;
153 I found the following locations for these programs:
156 foreach my $prog ( sort(keys(%Programs)) ) {
157 printf(" %-12s => %s\n", $prog, $Conf{$Programs{$prog}});
160 last if (prompt('--> Are these paths correct?', 'y') =~ /^y/i);
161 foreach my $prog ( sort(keys(%Programs)) ) {
162 $Conf{$Programs{$prog}} = prompt("--> $prog path",
163 $Conf{$Programs{$prog}});
167 my $Perl56 = system($Conf{PerlPath}
168 . q{ -e 'exit($^V && $^V ge v5.6.0 ? 1 : 0);'});
173 BackupPC needs perl version 5.6.0 or later. $Conf{PerlPath} appears
174 to be an older version. Please upgrade to a newer version of perl
175 and re-run this configure script.
183 Please tell me the hostname of the machine that BackupPC will run on.
186 chomp($Conf{ServerHost} = `$Conf{HostnamePath}`)
187 if ( defined($Conf{HostnamePath}) && !defined($Conf{ServerHost}) );
188 $Conf{ServerHost} = prompt("--> BackupPC will run on host", $Conf{ServerHost});
192 BackupPC should run as a dedicated user with limited privileges. You
193 need to create a user. This user will need read/write permission on
194 the main data directory and read/execute permission on the install
195 directory (these directories will be setup shortly).
197 The primary group for this user should also be chosen carefully.
198 By default the install directories will have group write permission.
199 The data directories and files will have group read permission but
203 my($name, $passwd, $Uid, $Gid);
205 $Conf{BackupPCUser} = prompt("--> BackupPC should run as user",
206 $Conf{BackupPCUser} || "backuppc");
207 ($name, $passwd, $Uid, $Gid) = getpwnam($Conf{BackupPCUser});
208 last if ( $name ne "" );
211 getpwnam() says that user $Conf{BackupPCUser} doesn't exist. Please check the
212 name and verify that this user is in the passwd file.
219 Please specify an install directory for BackupPC. This is where the
220 BackupPC scripts, library and documentation will be installed.
225 $Conf{InstallDir} = prompt("--> Install directory (full path)",
227 last if ( $Conf{InstallDir} =~ /^\// );
232 Please specify a data directory for BackupPC. This is where the
233 configuration files, LOG files and all the PC backups are stored.
234 This file system needs to be big enough to accommodate all the
235 PCs you expect to backup (eg: at least 1-2GB per machine).
240 $Conf{TopDir} = prompt("--> Data directory (full path)", $Conf{TopDir});
241 last if ( $Conf{TopDir} =~ /^\// );
244 if ( !defined($Conf{CompressLevel}) ) {
245 $Conf{CompressLevel} = BackupPC::FileZIO->compOk ? 3 : 0;
246 if ( $ConfigPath eq "" && $Conf{CompressLevel} ) {
249 BackupPC can compress pool files, providing around a 40% reduction in pool
250 size (your mileage may vary). Specify the compression level (0 turns
251 off compression, and 1 to 9 represent good/fastest to best/slowest).
252 The recommended values are 0 (off) or 3 (reasonable compression and speed).
253 Increasing the compression level to 5 will use around 20% more cpu time
254 and give perhaps 2-3% more compression.
257 } elsif ( $ConfigPath eq "" ) {
260 BackupPC can compress pool files, but it needs the Compress::Zlib
261 package installed (see www.cpan.org). Compression will provide around a
262 40% reduction in pool size, at the expense of cpu time. You can leave
263 compression off and run BackupPC without compression, in which case you
264 should leave the compression level at 0 (which means off). You could
265 install Compress::Zlib and turn compression on later, but read the
266 documentation first about how to do this. Or the better choice is
267 to quit, install Compress::Zlib, and re-run configure.pl.
270 } elsif ( $Conf{CompressLevel} ) {
271 $Conf{CompressLevel} = 0;
274 BackupPC now supports pool file compression. Since you are upgrading
275 BackupPC you probably have existing uncompressed backups. You have
276 several choices if you want to turn on compression. You can run
277 the script BackupPC_compressPool to convert everything to compressed
278 form. Or you can simply turn on compression, so that new backups
279 will be compressed. This will increase the pool storage requirement,
280 since both uncompressed and compressed copies of files will be stored.
281 But eventually the old uncompressed backups will expire, recovering
282 the pool storage. Please see the documentation for more details.
284 If you are not sure what to do, leave the Compression Level at 0,
285 which disables compression. You can always read the documentation
286 and turn it on later.
290 $Conf{CompressLevel} = 0;
293 BackupPC now supports pool file compression, but it needs the
294 Compress::Zlib module (see www.cpan.org). For now, leave
295 the compression level set at 0 to disable compression. If you
296 want you can install Compress::Zlib and turn compression on.
297 Please see the documentation for more details about converting
298 old backups to compressed form.
304 = prompt("--> Compression level", $Conf{CompressLevel});
305 last if ( $Conf{CompressLevel} =~ /^\d+$/ );
311 BackupPC has a powerful CGI perl interface that runs under Apache.
312 A single executable needs to be installed in a cgi-bin directory.
313 This executable needs to run as set-uid $Conf{BackupPCUser}, or
314 it can be run under mod_perl with Apache running as user $Conf{BackupPCUser}.
316 Leave this path empty if you don't want to install the CGI interface.
321 $Conf{CgiDir} = prompt("--> CGI bin directory (full path)", $Conf{CgiDir});
322 last if ( $Conf{CgiDir} =~ /^\// || $Conf{CgiDir} eq "" );
325 if ( $Conf{CgiDir} ne "" ) {
329 BackupPC's CGI script needs to display various GIF images that
330 should be stored where Apache can serve them. They should be
331 placed somewher under Apache's DocumentRoot. BackupPC also
332 needs to know the URL to access these images. Example:
334 Apache image directory: /usr/local/apache/htdocs/BackupPC
335 URL for image directory: /BackupPC
337 The URL for the image directory should start with a slash.
341 $Conf{CgiImageDir} = prompt("--> Apache image directory (full path)",
343 last if ( $Conf{CgiImageDir} =~ /^\// );
346 $Conf{CgiImageDirURL} = prompt("--> URL for image directory (omit http://host; starts with '/')",
347 $Conf{CgiImageDirURL});
348 last if ( $Conf{CgiImageDirURL} =~ /^\// );
356 - install the binaries, lib and docs in $Conf{InstallDir},
357 - create the data directory $Conf{TopDir},
358 - create/update the config.pl file $Conf{TopDir}/conf,
359 - optionally install the cgi-bin interface.
363 exit unless prompt("--> Do you want to continue?", "y") =~ /y/i;
366 # Create install directories
368 foreach my $dir ( qw(bin doc
374 next if ( -d "$Conf{InstallDir}/$dir" );
375 mkpath("$Conf{InstallDir}/$dir", 0, 0775);
376 if ( !-d "$Conf{InstallDir}/$dir"
377 || !chown($Uid, $Gid, "$Conf{InstallDir}/$dir") ) {
378 die("Failed to create or chown $Conf{InstallDir}/$dir\n");
380 print("Created $Conf{InstallDir}/$dir\n");
385 # Create CGI image directory
387 foreach my $dir ( ($Conf{CgiImageDir}) ) {
388 next if ( $dir eq "" || -d $dir );
389 mkpath($dir, 0, 0775);
390 if ( !-d $dir || !chown($Uid, $Gid, $dir) ) {
391 die("Failed to create or chown $dir");
393 print("Created $dir\n");
398 # Create $TopDir's top-level directories
400 foreach my $dir ( qw(. conf pool cpool pc trash log) ) {
401 mkpath("$Conf{TopDir}/$dir", 0, 0750) if ( !-d "$Conf{TopDir}/$dir" );
402 if ( !-d "$Conf{TopDir}/$dir"
403 || !chown($Uid, $Gid, "$Conf{TopDir}/$dir") ) {
404 die("Failed to create or chown $Conf{TopDir}/$dir\n");
406 print("Created $Conf{TopDir}/$dir\n");
410 printf("Installing binaries in $Conf{InstallDir}/bin\n");
411 foreach my $prog ( qw(BackupPC BackupPC_dump BackupPC_link BackupPC_nightly
412 BackupPC_sendEmail BackupPC_tarCreate BackupPC_trashClean
413 BackupPC_tarExtract BackupPC_compressPool BackupPC_zcat
414 BackupPC_archive BackupPC_archiveHost
415 BackupPC_restore BackupPC_serverMesg BackupPC_zipCreate ) ) {
416 InstallFile("bin/$prog", "$Conf{InstallDir}/bin/$prog", 0555);
420 # Remove unused binaries from older versions
422 unlink("$Conf{InstallDir}/bin/BackupPC_queueAll");
424 printf("Installing library in $Conf{InstallDir}/lib\n");
425 foreach my $lib ( qw(
429 BackupPC/PoolWrite.pm
431 BackupPC/Xfer/Archive.pm
434 BackupPC/Xfer/Rsync.pm
435 BackupPC/Xfer/RsyncFileIO.pm
436 BackupPC/Zip/FileMember.pm
441 BackupPC/CGI/AdminOptions.pm
442 BackupPC/CGI/Archive.pm
443 BackupPC/CGI/ArchiveInfo.pm
444 BackupPC/CGI/Browse.pm
445 BackupPC/CGI/DirHistory.pm
446 BackupPC/CGI/EmailSummary.pm
447 BackupPC/CGI/GeneralInfo.pm
448 BackupPC/CGI/HostInfo.pm
450 BackupPC/CGI/LOGlist.pm
451 BackupPC/CGI/Queue.pm
452 BackupPC/CGI/ReloadServer.pm
453 BackupPC/CGI/RestoreFile.pm
454 BackupPC/CGI/RestoreInfo.pm
455 BackupPC/CGI/Restore.pm
456 BackupPC/CGI/StartServer.pm
457 BackupPC/CGI/StartStopBackup.pm
458 BackupPC/CGI/StopServer.pm
459 BackupPC/CGI/Summary.pm
462 InstallFile("lib/$lib", "$Conf{InstallDir}/lib/$lib", 0444);
465 if ( $Conf{CgiImageDir} ne "" ) {
466 printf("Installing images in $Conf{CgiImageDir}\n");
467 foreach my $img ( <images/*> ) {
468 (my $destImg = $img) =~ s{^images/}{};
469 InstallFile($img, "$Conf{CgiImageDir}/$destImg", 0444, 1);
473 printf("Making init.d scripts\n");
474 foreach my $init ( qw(gentoo-backuppc gentoo-backuppc.conf linux-backuppc
475 solaris-backuppc debian-backuppc suse-backuppc) ) {
476 InstallFile("init.d/src/$init", "init.d/$init", 0444);
479 printf("Installing docs in $Conf{InstallDir}/doc\n");
480 foreach my $doc ( qw(BackupPC.pod BackupPC.html) ) {
481 InstallFile("doc/$doc", "$Conf{InstallDir}/doc/$doc", 0444);
484 printf("Installing config.pl and hosts in $Conf{TopDir}/conf\n");
485 InstallFile("conf/hosts", "$Conf{TopDir}/conf/hosts", 0644)
486 if ( !-f "$Conf{TopDir}/conf/hosts" );
489 # Now do the config file. If there is an existing config file we
490 # merge in the new config file, adding any new configuration
491 # parameters and deleting ones that are no longer needed.
493 my $dest = "$Conf{TopDir}/conf/config.pl";
494 my ($newConf, $newVars) = ConfigParse("conf/config.pl");
495 my ($oldConf, $oldVars);
497 ($oldConf, $oldVars) = ConfigParse($dest);
498 $newConf = ConfigMerge($oldConf, $oldVars, $newConf, $newVars);
500 $Conf{EMailFromUserName} ||= $Conf{BackupPCUser};
501 $Conf{EMailAdminUserName} ||= $Conf{BackupPCUser};
504 # Update various config parameters
508 # Guess $Conf{CgiURL}
510 if ( !defined($Conf{CgiURL}) ) {
511 if ( $Conf{CgiDir} =~ m{cgi-bin(/.*)} ) {
512 $Conf{CgiURL} = "'http://$Conf{ServerHost}/cgi-bin$1/BackupPC_Admin'";
514 $Conf{CgiURL} = "'http://$Conf{ServerHost}/cgi-bin/BackupPC_Admin'";
519 # The smbclient commands have moved from hard-coded to the config file.
520 # $Conf{SmbClientArgs} no longer exists, so merge it into the new
521 # commands if it still exists.
523 if ( defined($Conf{SmbClientArgs}) ) {
524 if ( $Conf{SmbClientArgs} ne "" ) {
525 foreach my $param ( qw(SmbClientRestoreCmd SmbClientFullCmd
526 SmbClientIncrCmd) ) {
527 $newConf->[$newVars->{$param}]{text}
528 =~ s/(-E\s+-N)/$1 $Conf{SmbClientArgs}/;
531 delete($Conf{SmbClientArgs});
535 # IncrFill should now be off
540 # Figure out sensible arguments for the ping command
542 if ( defined($Conf{PingArgs}) ) {
543 $Conf{PingCmd} = '$pingPath ' . $Conf{PingArgs};
544 } elsif ( !defined($Conf{PingCmd}) ) {
545 if ( $^O eq "solaris" || $^O eq "sunos" ) {
546 $Conf{PingCmd} = '$pingPath -s $host 56 1';
547 } elsif ( ($^O eq "linux" || $^O eq "openbsd" || $^O eq "netbsd")
548 && !system("$Conf{PingPath} -c 1 -w 3 localhost") ) {
549 $Conf{PingCmd} = '$pingPath -c 1 -w 3 $host';
551 $Conf{PingCmd} = '$pingPath -c 1 $host';
553 delete($Conf{PingArgs});
557 # Figure out sensible arguments for the df command
559 if ( !defined($Conf{DfCmd}) ) {
560 if ( $^O eq "solaris" || $^O eq "sunos" ) {
561 $Conf{DfCmd} = '$dfPath -k $topDir';
566 # $Conf{SmbClientTimeout} is now $Conf{ClientTimeout}
568 if ( defined($Conf{SmbClientTimeout}) ) {
569 $Conf{ClientTimeout} = $Conf{SmbClientTimeout};
570 delete($Conf{SmbClientTimeout});
573 my $confCopy = "$dest.pre-__VERSION__";
574 if ( -f $dest && !-f $confCopy ) {
576 # Make copy of config file, preserving ownership and modes
578 printf("Making backup copy of $dest -> $confCopy\n");
579 my @stat = stat($dest);
583 die("can't copy($dest, $confCopy)\n") unless copy($dest, $confCopy);
584 die("can't chown $uid, $gid $confCopy\n")
585 unless chown($uid, $gid, $confCopy);
586 die("can't chmod $mode $confCopy\n") unless chmod($mode, $confCopy);
588 open(OUT, ">", $dest) || die("can't open $dest for writing\n");
591 foreach my $var ( @$newConf ) {
592 if ( length($blockComment)
593 && substr($var->{text}, 0, length($blockComment)) eq $blockComment ) {
594 $var->{text} = substr($var->{text}, length($blockComment));
595 $blockComment = undef;
597 $blockComment = $1 if ( $var->{text} =~ /^([\s\n]*#{70}.*#{70}[\s\n]+)/s );
598 $var->{text} =~ s/^\s*\$Conf\{(.*?)\}(\s*=\s*['"]?)(.*?)(['"]?\s*;)/
599 defined($Conf{$1}) && ref($Conf{$1}) eq ""
600 && $Conf{$1} ne $OrigConf{$1}
601 ? "\$Conf{$1}$2$Conf{$1}$4"
602 : "\$Conf{$1}$2$3$4"/emg;
603 print OUT $var->{text};
606 if ( !defined($oldConf) ) {
607 die("can't chmod 0640 mode $dest\n") unless chmod(0640, $dest);
608 die("can't chown $Uid, $Gid $dest\n") unless chown($Uid, $Gid, $dest);
611 if ( $Conf{CgiDir} ne "" ) {
612 printf("Installing cgi script BackupPC_Admin in $Conf{CgiDir}\n");
613 mkpath("$Conf{CgiDir}", 0, 0755);
614 InstallFile("cgi-bin/BackupPC_Admin", "$Conf{CgiDir}/BackupPC_Admin",
620 Ok, it looks like we are finished. There are several more things you
623 - Browse through the config file, $Conf{TopDir}/conf/config.pl,
624 and make sure all the settings are correct. In particular, you
625 will need to set the smb share password and user name, backup
626 policies and check the email message headers and bodies.
628 - Edit the list of hosts to backup in $Conf{TopDir}/conf/hosts.
630 - Read the documentation in $Conf{InstallDir}/doc/BackupPC.html.
631 Please pay special attention to the security section.
633 - Verify that the CGI script BackupPC_Admin runs correctly. You might
634 need to change the permissions or group ownership of BackupPC_Admin.
636 - BackupPC should be ready to start. Don't forget to run it
637 as user $Conf{BackupPCUser}! The installation also contains an
638 init.d/backuppc script that can be copied to /etc/init.d
639 so that BackupPC can auto-start on boot. This will also enable
640 administrative users to start the server from the CGI interface.
646 if ( $ENV{LANG} =~ /utf/i && $^V ge v5.8.0 ) {
649 WARNING: Your LANG environment variable is set to $ENV{LANG}, which
650 doesn't behave well with this version of perl. Please set the
651 LANG environment variable to en_US before running BackupPC.
653 On RH-8 this setting is in the file /etc/sysconfig/i18n, or you
654 could set it in BackupPC's init.d script.
660 ###########################################################################
662 ###########################################################################
666 my($prog, $dest, $mode, $binary) = @_;
668 my($uid, $gid) = ($Uid, $Gid);
672 # preserve ownership and modes of files that already exist
674 my @stat = stat($dest);
679 unlink($dest) if ( -f $dest );
681 die("can't copy($prog, $dest)\n") unless copy($prog, $dest);
683 open(PROG, $prog) || die("can't open $prog for reading\n");
684 open(OUT, ">", $dest) || die("can't open $dest for writing\n");
688 s/__INSTALLDIR__/$Conf{InstallDir}/g;
689 s/__TOPDIR__/$Conf{TopDir}/g;
690 s/__BACKUPPCUSER__/$Conf{BackupPCUser}/g;
691 s/__CGIDIR__/$Conf{CgiDir}/g;
692 if ( $first && /^#.*bin\/perl/ ) {
694 # Fill in correct path to perl (no taint for >= 2.0.1).
696 print OUT "#!$Conf{PerlPath}\n";
705 die("can't chown $uid, $gid $dest") unless chown($uid, $gid, $dest);
706 die("can't chmod $mode $dest") unless chmod($mode, $dest);
711 my($path, $prog) = @_;
712 foreach my $dir ( split(/:/, $path) ) {
713 my $file = File::Spec->catfile($dir, $prog);
714 return $file if ( -x $file );
721 open(C, $file) || die("can't open $file");
723 my($out, @conf, $var);
728 if ( /^#/ && !defined($endLine) ) {
733 $allVars->{$var} = @conf if ( defined($var) );
743 } elsif ( /^\s*\$Conf\{([^}]*)/ ) {
745 if ( defined($var) ) {
746 $allVars->{$var} = @conf if ( defined($var) );
756 $endLine = $1 if ( /^\s*\$Conf\{[^}]*} *= *<<(.*);/ );
757 $endLine = $1 if ( /^\s*\$Conf\{[^}]*} *= *<<'(.*)';/ );
759 $endLine = undef if ( defined($endLine) && /^\Q$endLine[\n\r]*$/ );
764 $allVars->{$var} = @conf if ( defined($var) );
771 return (\@conf, $allVars);
776 my($old, $oldVars, $new, $newVars) = @_;
781 # Find which config parameters are not needed any longer
783 foreach my $var ( @$old ) {
784 next if ( !defined($var->{var}) || defined($newVars->{$var->{var}}) );
785 #print(STDERR "Deleting old config parameter $var->{var}\n");
789 # Find which config parameters are new
791 foreach my $var ( @$new ) {
792 next if ( !defined($var->{var}) );
793 if ( defined($oldVars->{$var->{var}}) ) {
794 $posn = $oldVars->{$var->{var}};
796 #print(STDERR "New config parameter $var->{var}: $var->{text}\n");
797 push(@{$old->[$posn]{new}}, $var);
801 # Create merged config file
803 foreach my $var ( @$old ) {
804 next if ( $var->{delete} );
806 foreach my $new ( @{$var->{new}} ) {