forked from backuppc/backuppc
-
Notifications
You must be signed in to change notification settings - Fork 7
/
configure.pl
executable file
·1468 lines (1235 loc) · 47.3 KB
/
configure.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env perl
#============================================================= -*-perl-*-
#
# configure.pl: Configuration and installation program for BackupPC
#
# DESCRIPTION
#
# This script should be run as root:
#
# 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 <cbarratt@users.sourceforge.net>
#
# COPYRIGHT
# Copyright (C) 2001-2017 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
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#========================================================================
#
# Version __VERSION__, released __RELEASEDATE__.
#
# See http://backuppc.sourceforge.net.
#
#========================================================================
use strict;
no utf8;
use vars qw(%Conf %OrigConf $Upgrade);
use lib "./lib";
#
# The two strings below are replaced with the full list of BackupPC executables
# and libraries by makeDist.
#
my @ConfigureBinList = qw(
__CONFIGURE_BIN_LIST__
);
my @ConfigureLibList = qw(
__CONFIGURE_LIB_LIST__
);
#
# Check that makeDist has been run; need to avoid having the magic string
# appear exactly (otherwise makeDist will replace it), so compute it instead
#
if ( $ConfigureBinList[0] eq "__" . "CONFIGURE_BIN_LIST__" ) {
die <<EOF;
You need to run makeDist first to create a tarball release that includes an
updated configure.pl. After you unpack the tarball, run configure.pl from
there.
EOF
}
my @Packages = qw(version Encode Socket File::Path File::Spec File::Copy
Digest::MD5 Data::Dumper Getopt::Std Getopt::Long Pod::Usage
File::Listing CGI BackupPC::XS BackupPC::Lib);
my $PackageVersion = {
"Encode" => "1.99",
"BackupPC::XS" => "0.62",
};
foreach my $pkg ( @Packages ) {
eval "use $pkg";
if ( !$@ ) {
next if ( !defined($PackageVersion->{$pkg}) );
my $ver = eval "\$${pkg}::VERSION";
next if ( version->parse($ver) >= version->parse($PackageVersion->{$pkg}) );
die <<EOF;
Perl package $pkg needs to be at least version $PackageVersion->{$pkg}.
The currently installed $pkg is version $ver.
Please upgrade package $pkg to the latest version and then re-run
this script.
EOF
}
if ( $pkg =~ /BackupPC::Lib/ ) {
die <<EOF;
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:
cd BackupPC-__VERSION__
./configure.pl
Please try again.
EOF
}
die <<EOF;
BackupPC needs the perl package "$pkg". Please install "$pkg"
(eg, using cpan) before installing BackupPC.
EOF
}
my %opts;
$opts{"set-perms"} = 1;
if (
!GetOptions(
\%opts, "batch", "backuppc-user=s", "bin-path=s%",
"cgi-dir=s", "compress-level=i", "config-path=s", "config-override=s%",
"config-dir=s", "config-only", "data-dir=s", "dest-dir=s",
"fhs!", "help|?", "hostname=s", "html-dir=s",
"html-dir-url=s", "install-dir=s", "log-dir=s", "man",
"run-dir=s", "scgi-port=i", "set-perms!", "uid-ignore!",
)
|| @ARGV
) {
pod2usage(2);
}
pod2usage(1) if ( $opts{help} );
pod2usage(-exitstatus => 0, -verbose => 2) if $opts{man};
my $DestDir = $opts{"dest-dir"};
$DestDir = "" if ( $DestDir eq "/" );
if ( !$opts{"uid-ignore"} && $< != 0 ) {
print <<EOF;
This configure script should be run as root, rather than uid $<.
Provided uid $< has sufficient permissions to create the data and
install directories, then it should be ok to proceed. Otherwise,
please quit and restart as root.
EOF
exit(1) if ( prompt("--> Do you want to continue?", "y") !~ /y/i );
exit(1) if ( $opts{batch} && !$opts{"uid-ignore"} );
}
#
# Whether we use the file system hierarchy conventions or not.
# Older versions did not. BackupPC used to be installed in
# two main directories (in addition to CGI and html pages)
#
# TopDir which includes subdirs conf, log, pc, pool, cpool
#
# InstallDir which includes subdirs bin, lib, share/doc/BackupPC
#
# 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)
# /var/log/BackupPC Pid, status and email info (was $TopDir/log)
#
#
# Check if this is an upgrade, in which case read the existing
# config file to get all the defaults.
#
my $ConfigDir = $opts{"config-dir"} || "/etc/BackupPC";
my $ConfigPath = "";
my $ConfigFileOK = 1;
while ( 1 ) {
if ( $ConfigFileOK
&& -f "$DestDir$ConfigDir/config.pl"
&& (!defined($opts{fhs}) || $opts{fhs})
&& !defined($opts{"config-path"}) ) {
$ConfigPath = "$ConfigDir/config.pl";
$opts{fhs} = 1 if ( !defined($opts{fhs}) );
print <<EOF;
Found $DestDir$ConfigDir/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 {
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: $ConfigDir/config.pl). Otherwise, just
hit return.
EOF
$ConfigPath = prompt("--> Full path to existing main config.pl", $ConfigPath, "config-path");
}
last if ( $ConfigPath eq ""
|| ($ConfigPath =~ /^\// && -f "$DestDir$ConfigPath" && -w "$DestDir$ConfigPath") );
my $problem = "is not an absolute path";
$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 '$DestDir$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 "" );
my $bpc;
if ( $ConfigPath ne "" && -r "$DestDir$ConfigPath" ) {
($ConfigDir = $ConfigPath) =~ s{/[^/]+$}{};
# In config-only mode use installed BackupPC if distribution files are not available.
my $libPath = ($opts{"config-only"} && ($INC{"BackupPC/Lib.pm"} ne "lib/BackupPC/Lib.pm")) ? "" : ".";
die("BackupPC::Lib->new failed\n")
if ( !($bpc = BackupPC::Lib->new(".", $libPath, "$DestDir$ConfigDir", 1)) );
%Conf = $bpc->Conf();
%OrigConf = %Conf;
$Upgrade = 1;
if ( !defined($opts{fhs}) ) {
if ( $ConfigPath eq "$Conf{TopDir}/conf/config.pl" ) {
$opts{fhs} = 0;
} else {
$opts{fhs} = 1;
}
}
if ( !$opts{fhs} ) {
($Conf{TopDir} = $ConfigPath) =~ s{/[^/]+/[^/]+$}{}
if ( $Conf{TopDir} eq '' );
$bpc->{LogDir} = $Conf{LogDir} = "$Conf{TopDir}/log"
if ( $Conf{LogDir} eq '' );
$bpc->{RunDir} = $Conf{RunDir} = "$Conf{TopDir}/log"
if ( $Conf{RunDir} eq '' );
}
$bpc->{ConfDir} = $Conf{ConfDir} = $ConfigDir;
if ( !length($DestDir) ) {
my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}, 1);
if ( $err eq "" ) {
print <<EOF;
BackupPC is running on $Conf{ServerHost}. You need to stop BackupPC before
you can upgrade the code. Depending upon your installation, you could
run "systemctl stop backuppc.service" if you use systemd,
or "/etc/init.d/backuppc stop" if you use init.d.
EOF
exit(1);
}
}
}
#
# Create filesystem hierarchy defaults
#
$Conf{TopDir} ||= $opts{"data-dir"} || "/data/BackupPC";
$Conf{InstallDir} ||= $opts{"install-dir"} || "/usr/local/BackupPC";
#
# These are the programs whose paths we need to find
#
my %Programs = (
perl => "PerlPath",
rsync_bpc => "RsyncBackupPCPath",
'gtar/tar' => "TarClientPath",
smbclient => "SmbClientPath",
nmblookup => "NmbLookupPath",
rsync => "RsyncClientPath",
ping => "PingPath",
ping6 => "Ping6Path",
df => "DfPath",
'ssh/ssh2' => "SshPath",
sendmail => "SendmailPath",
hostname => "HostnamePath",
split => "SplitPath",
par2 => "ParPath",
cat => "CatPath",
gzip => "GzipPath",
bzip2 => "Bzip2Path",
rrdtool => "RrdToolPath",
);
foreach my $prog ( sort(keys(%Programs)) ) {
my $path;
foreach my $subProg ( split(/\//, $prog) ) {
$path = FindProgram("$ENV{PATH}:/usr/bin:/bin:/sbin:/usr/sbin:/usr/local/bin", $subProg) if ( !length($path) );
}
$Conf{$Programs{$prog}} = $path if ( !length($Conf{$Programs{$prog}}) );
}
while ( 1 ) {
print <<EOF;
I found the following locations for these programs:
EOF
foreach my $prog ( sort(keys(%Programs)) ) {
printf(" %-12s => %s\n", $prog, $Conf{$Programs{$prog}});
}
print "\n";
last if ( prompt('--> Are these paths correct?', 'y') =~ /^y/i );
foreach my $prog ( sort(keys(%Programs)) ) {
$Conf{$Programs{$prog}} = prompt("--> $prog path", $Conf{$Programs{$prog}});
}
}
my $Perl58 = system($Conf{PerlPath} . q{ -e 'exit($^V && $^V ge v5.8.0 ? 1 : 0);'});
if ( !$Perl58 ) {
print <<EOF;
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.
EOF
exit(1);
}
print <<EOF;
Please tell me the hostname of the machine that BackupPC will run on.
EOF
chomp($Conf{ServerHost} = `$Conf{HostnamePath}`)
if ( defined($Conf{HostnamePath}) && !defined($Conf{ServerHost}) );
$Conf{ServerHost} = prompt("--> BackupPC will run on host", $Conf{ServerHost}, "hostname");
print <<EOF;
BackupPC should run as a dedicated user with limited privileges. You
need to create a user. This user will need read/write permission on
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.
The data directories and files will have group read permission,
so group members can access backup files.
EOF
my($name, $passwd, $Uid, $Gid);
while ( 1 ) {
$Conf{BackupPCUser} = prompt("--> BackupPC should run as user", $Conf{BackupPCUser} || "backuppc", "backuppc-user");
if ( $opts{"set-perms"} ) {
($name, $passwd, $Uid, $Gid) = getpwnam($Conf{BackupPCUser});
last if ( $name ne "" );
print <<EOF;
getpwnam() says that user $Conf{BackupPCUser} doesn't exist. Please
check the name and verify that this user is in the passwd file.
EOF
exit(1) if ( $opts{batch} );
} else {
last;
}
}
print <<EOF;
Please specify an install directory for BackupPC. This is where the
BackupPC scripts, library and documentation will be installed.
EOF
while ( 1 ) {
$Conf{InstallDir} = prompt("--> Install directory (full path)", $Conf{InstallDir}, "install-dir");
last if ( $Conf{InstallDir} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --install-dir for new installation\n");
exit(1);
}
}
print <<EOF;
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
while ( 1 ) {
$Conf{TopDir} = prompt("--> Data directory (full path)", $Conf{TopDir}, "data-dir");
last if ( $Conf{TopDir} =~ /^\// );
if ( $opts{batch} ) {
print("Need to specify --data-dir for new installation\n");
exit(1);
}
}
if ( $opts{fhs} ) {
$Conf{ConfDir} ||= $ConfigDir || "/etc/BackupPC";
$Conf{LogDir} ||= $opts{"log-dir"} || "/var/log/BackupPC";
$Conf{RunDir} ||= $opts{"run-dir"} || "/var/run/BackupPC";
} else {
$Conf{ConfDir} ||= $ConfigDir || "$Conf{TopDir}/conf";
$Conf{LogDir} ||= $opts{"log-dir"} || "$Conf{TopDir}/log";
$Conf{RunDir} ||= $opts{"run-dir"} || "$Conf{TopDir}/log";
}
$Conf{CompressLevel} = $opts{"compress-level"}
if ( defined($opts{"compress-level"}) );
print <<EOF;
BackupPC has SCGI and CGI perl interfaces that run under Apache. You need
to pick which one to run.
For SCGI, Apache uses the scgi_mod module to communicate with BackupPC_Admin_SCGI,
which handles the requests. This allows Apache to run as a different user as
$Conf{BackupPCUser}. To use SCGI you need to set SCGIServerPort to any spare
non-privileged TCP port number. A negative value disables SCGI.
** Important security warning!! The SCGIServerPort must not be accessible by
** anyone untrusted. That means you can't allow untrusted users access to the
** BackupPC server, and you should block the SCGIServerPort TCP port from
** network access.
The traditional alternative is to use CGI. In this case, an executable needs
to be installed Apache's cgi-bin directory. This executable needs to run as
set-uid $Conf{BackupPCUser}, or it can be run under mod_perl with Apache
running as user $Conf{BackupPCUser}.
EOF
$Conf{SCGIServerPort} = prompt("--> SCGI port (-1 to disable)", $Conf{SCGIServerPort} || -1, "scgi-port");
if ( $Conf{SCGIServerPort} < 0 ) {
while ( 1 ) {
$Conf{CgiDir} = prompt("--> CGI bin directory (full path, or empty for no CGI)", $Conf{CgiDir}, "cgi-dir");
last if ( $Conf{CgiDir} =~ /^\// || $Conf{CgiDir} eq "" );
if ( $opts{batch} ) {
print("Need to specify --cgi-dir for new installation\n");
exit(1);
}
}
}
if ( $Conf{SCGIServerPort} > 0 || $Conf{CgiDir} ne "" ) {
print <<EOF;
BackupPC's CGI and SCGI script need to display various PNG/GIF
images that should be stored where Apache can serve them. They
should be placed somewhere under Apache's DocumentRoot. BackupPC
also needs to know the URL to access these images. Example:
Apache image directory: /var/www/htdocs/BackupPC
URL for image directory: /BackupPC
The URL for the image directory should start with a slash.
EOF
while ( 1 ) {
$Conf{CgiImageDir} =
prompt("--> Apache image directory (full path, or empty for no S/CGI)", $Conf{CgiImageDir}, "html-dir");
last if ( $Conf{CgiImageDir} =~ /^\// || $Conf{CgiImageDir} eq "" );
if ( $opts{batch} ) {
print("Need to specify --html-dir for new installation\n");
exit(1);
}
}
while ( 1 ) {
$Conf{CgiImageDirURL} =
prompt("--> URL for image directory (omit http://host; starts with '/', or empty for no S/CGI)",
$Conf{CgiImageDirURL}, "html-dir-url");
last if ( $Conf{CgiImageDirURL} =~ /^\// || $Conf{CgiImageDirURL} eq "" );
if ( $opts{batch} ) {
print("Need to specify --html-dir-url for new installation\n");
exit(1);
}
}
}
print <<EOF;
Ok, we're about to:
EOF
print <<EOF if ( !$opts{"config-only"} );
- install the binaries, lib and docs in $DestDir$Conf{InstallDir}
- create the data directory $DestDir$Conf{TopDir}
- optionally install the cgi-bin interface
EOF
print <<EOF;
- create/update the config.pl file $DestDir$Conf{ConfDir}/config.pl
EOF
exit unless prompt("--> Do you want to continue?", "y") =~ /y/i;
CleanPidSock();
DoInstall() if ( !$opts{"config-only"} );
print("Installing config.pl and hosts in $DestDir$Conf{ConfDir}\n");
InstallFile("conf/hosts", "$DestDir$Conf{ConfDir}/hosts.sample", 0644)
if ( !$opts{"config-only"} );
my $hostsSample = $opts{"config-only"} ? "$DestDir$Conf{ConfDir}/hosts.sample" : "conf/hosts";
InstallFile($hostsSample, "$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{ConfDir}/config.pl";
my $configSample = $opts{"config-only"} ? "$DestDir$Conf{ConfDir}/config.pl.sample" : "conf/config.pl";
my($distConf, $distVars) = ConfigParse($configSample);
my($oldConf, $oldVars);
my($newConf, $newVars) = ($distConf, $distVars);
if ( -f $dest ) {
($oldConf, $oldVars) = ConfigParse($dest);
($newConf, $newVars) = ConfigMerge($oldConf, $oldVars, $distConf, $distVars);
}
#
# 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}
#
if ( $Conf{CgiURL} eq '' ) {
if ( $Conf{CgiDir} =~ m{cgi-bin(/.*)} ) {
$Conf{CgiURL} = "http://$Conf{ServerHost}/cgi-bin$1/BackupPC_Admin";
} else {
$Conf{CgiURL} = "http://$Conf{ServerHost}/cgi-bin/BackupPC_Admin";
}
}
#
# The smbclient commands have moved from hard-coded to the config file.
# $Conf{SmbClientArgs} no longer exists, so merge it into the new
# commands if it still exists.
#
if ( defined($Conf{SmbClientArgs}) ) {
if ( $Conf{SmbClientArgs} ne "" ) {
foreach my $param ( qw(SmbClientRestoreCmd SmbClientFullCmd
SmbClientIncrCmd) ) {
$newConf->[$newVars->{$param}]{text} =~ s/(-E\s+-N)/$1 $Conf{SmbClientArgs}/;
}
}
delete($Conf{SmbClientArgs});
}
#
# CSS is now stored in a file rather than a big config variable.
#
delete($Conf{CSSstylesheet});
#
# The blackout timing settings are now stored in a list of hashes, rather
# than three scalar parameters.
#
if ( defined($Conf{BlackoutHourBegin}) ) {
$Conf{BlackoutPeriods} = [{
hourBegin => $Conf{BlackoutHourBegin},
hourEnd => $Conf{BlackoutHourEnd},
weekDays => $Conf{BlackoutWeekDays},
}];
delete($Conf{BlackoutHourBegin});
delete($Conf{BlackoutHourEnd});
delete($Conf{BlackoutWeekDays});
}
#
# $Conf{RsyncLogLevel} has been replaced by $Conf{XferLogLevel}
#
if ( defined($Conf{RsyncLogLevel}) ) {
$Conf{XferLogLevel} = $Conf{RsyncLogLevel};
delete($Conf{RsyncLogLevel});
}
#
# Since 2.1.0 the default for $Conf{CgiNavBarAdminAllHosts} is now 1
#
$Conf{CgiNavBarAdminAllHosts} = 1;
#
# 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
#
if ( defined($Conf{PingArgs}) ) {
$Conf{PingCmd} = '$pingPath ' . $Conf{PingArgs};
delete($Conf{PingArgs});
} elsif ( $Upgrade && !defined($Conf{PingCmd}) ) {
if ( $^O eq "solaris" || $^O eq "sunos" ) {
$Conf{PingCmd} = '$pingPath -s $host 56 1';
} elsif ( ($^O eq "linux" || $^O eq "openbsd" || $^O eq "netbsd")
&& !system("$Conf{PingPath} -c 1 -w 3 localhost") ) {
$Conf{PingCmd} = '$pingPath -c 1 -w 3 $host';
} else {
$Conf{PingCmd} = '$pingPath -c 1 $host';
}
}
#
# Figure out sensible arguments for the df command
#
if ( !defined($Conf{DfCmd}) ) {
if ( $^O eq "solaris" || $^O eq "sunos" ) {
$Conf{DfCmd} = '$dfPath -k $topDir';
}
}
#
# $Conf{SmbClientTimeout} is now $Conf{ClientTimeout}
#
if ( defined($Conf{SmbClientTimeout}) ) {
$Conf{ClientTimeout} = $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);
$d->Sortkeys(1);
my $value = $d->Dump;
$value =~ s/(.*)\n/$1;\n/s;
$newConf->[$newVars->{CgiUserConfigEdit}]{text} =~ s/^(\s*\$Conf\{.*?\}\s*=\s*).*/$1$value/ms;
}
#
# If this is an upgrade from V3, then set $Conf{PoolV3Enabled}
# and update $Conf{RsyncArgs} and $Conf{RsyncRestoreArgs}.
#
if ( $Upgrade && !defined($Conf{PoolV3Enabled}) ) {
$Conf{PoolV3Enabled} = 1;
#
# for an upgrade, remove the new --one-file-system flag if it wasn't there before
#
if ( $oldConf->[$oldVars->{RsyncArgs}]{text} !~ /--one-file-system/ ) {
$distConf->[$distVars->{RsyncArgs}]{text} =~ s/\n\s*'--one-file-system',\n/\n/;
}
$newConf->[$newVars->{RsyncArgs}]{text} = $distConf->[$distVars->{RsyncArgs}]{text};
$newConf->[$newVars->{RsyncRestoreArgs}]{text} = $distConf->[$distVars->{RsyncRestoreArgs}]{text};
#
# If it exists, use $Conf{RsyncClientCmd} to create the default $Conf{RsyncSshArgs}.
#
if ( $Conf{RsyncClientCmd} =~ /(\$sshPath.* +-l +\S+)/ && defined($newVars->{RsyncSshArgs}) ) {
my $sshEArg = $1;
my $value = "[\n '-e', '$sshEArg',\n];\n\n";
$newConf->[$newVars->{RsyncSshArgs}]{text} =~ s/^(\s*\$Conf\{RsyncSshArgs}\s*=\s*).*/$1$value/ms;
printf("** Warning: setting \$Conf{RsyncSshArgs} to ['-e', '%s'] based on deprecated V3 setting"
. " \$Conf{RsyncClientCmd} = '%s'; please"
. " check & fix \$Conf{RsyncClientPath} and \$Conf{RsyncSshArgs}\n",
$sshEArg, $Conf{RsyncClientCmd});
} else {
printf(
"** Warning: unable to set \$Conf{RsyncSshArgs} based on deprecated V3 setting"
. " \$Conf{RsyncClientCmd} = '%s'; please"
. " check & fix \$Conf{RsyncClientPath} and \$Conf{RsyncSshArgs}\n",
$Conf{RsyncClientCmd}
);
}
#
# check if any per-host config files have a $Conf{RsyncClientCmd} setting; if so
# warn the user they need to manually check/update them
#
my @hostConfigs = (
<$DestDir$Conf{ConfDir}/pc/*.pl>, # FHS case
<$DestDir$Conf{TopDir}/pc/*/config.pl> # non-FHS case
);
foreach my $hostConfigFile ( @hostConfigs ) {
next if ( !-f $hostConfigFile );
my($hostConf, $hostVars) = ConfigParse($hostConfigFile);
if ( defined($hostVars->{RsyncClientCmd}) ) {
print( "** Warning: host config $hostConfigFile contains deprecated V3 \$Conf{RsyncClientCmd} setting;"
. " you need to manually update \$Conf{RsyncClientPath} and \$Conf{RsyncSshArgs} for this host\n");
}
if ( defined($hostVars->{RsyncClientRestoreCmd}) ) {
print(
"** Warning: host config $hostConfigFile contains deprecated V3 \$Conf{RsyncClientRestoreCmd} setting;"
. " you need to manually update \$Conf{RsyncClientPath} and \$Conf{RsyncSshArgs} for this host\n");
}
}
}
#
# Update $Conf{CgiNavBarLinks} with github URLs
#
$newConf->[$newVars->{CgiNavBarLinks}]{text} =~
s{http://backuppc.wiki.sourceforge.net}{https://github.com/backuppc/backuppc/wiki}g;
$newConf->[$newVars->{CgiNavBarLinks}]{text} =~
s{http://backuppc.sourceforge.net}{https://backuppc.github.io/backuppc}g;
$newConf->[$newVars->{CgiNavBarLinks}]{text} =~ s{SourceForge}{Homepage}g;
#
# Apply any command-line configuration parameter settings
#
foreach my $param ( keys(%{$opts{"config-override"}}) ) {
my $value = $opts{"config-override"}{$param};
my $val = eval {$value};
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);
}
$value .= ";\n\n";
$newConf->[$newVars->{$param}]{text} =~ s/^(\s*\$Conf\{$param}\s*=\s*).*/$1$value/ms;
}
#
# Now backup and write the config file
#
my $confCopy = "$dest.pre-__VERSION__";
if ( -f $dest && !-f $confCopy ) {
#
# Make copy of config file, preserving ownership and modes
#
print("Making backup copy of $dest -> $confCopy\n");
my @stat = stat($dest);
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 chown $uid, $gid $confCopy\n")
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);
my $blockComment;
foreach my $var ( @$newConf ) {
if ( length($blockComment)
&& substr($var->{text}, 0, length($blockComment)) eq $blockComment ) {
$var->{text} = substr($var->{text}, length($blockComment));
$blockComment = undef;
}
$blockComment = $1 if ( $var->{text} =~ /^(\s*#{70}.*#{70}\s+)/s );
$var->{text} =~ s/^\s*\$Conf\{(.*?)\}(\s*=\s*['"]?)(.*?)(['"]?\s*;)/
my $varName = $1;
my $a = $2;
my $varValue = $3;
my $b = $4;
# Get quotes from default config to avoid missing or extra quotes
# when replacing misused undef or empty string values
($a, $b) = GetQuotes($varName)
if ( (!defined($OrigConf{$varName}) || $OrigConf{$varName} eq "")
&& $Conf{$varName} ne $OrigConf{$varName} );
defined($Conf{$varName}) && ref($Conf{$varName}) eq ""
&& !defined($opts{"config-override"}{$varName})
&& $Conf{$varName} ne $OrigConf{$varName}
? "\$Conf{$varName}$a$Conf{$varName}$b"
: "\$Conf{$varName}$a$varValue$b"/emsg;
print OUT $var->{text};
}
close(OUT);
if ( !defined($oldConf) ) {
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);
}
InstallFile($dest, "$DestDir$Conf{ConfDir}/config.pl.sample", 0644)
if ( !$opts{"config-only"} );
print <<EOF;
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,
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.
- Read the documentation in $Conf{InstallDir}/doc/BackupPC.html.
Please pay special attention to the security section.
- 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
a systemd/backuppc.service script that can be installed so
that BackupPC can auto-start on boot. This will also enable
administrative users to start the server from the CGI interface.
See systemd/README.
Enjoy!
EOF
if ( `$Conf{PerlPath} -V` =~ /uselargefiles=undef/ ) {
print <<EOF;
Warning: your perl, $Conf{PerlPath}, does not support large files.
This means BackupPC won't be able to backup files larger than 2GB.
To solve this problem you should build/install a new version of perl
with large file support enabled. Use
$Conf{PerlPath} -V | egrep uselargefiles
to check if perl has large file support (undef means no support).
EOF
}
exit(0);
###########################################################################
# Subroutines
###########################################################################
sub DoInstall
{
#
# Create install directories
#
foreach my $dir ( qw(bin
share share/doc share/doc/BackupPC
lib lib/BackupPC
lib/BackupPC/CGI
lib/BackupPC/Config
lib/BackupPC/Lang
lib/BackupPC/Storage
lib/BackupPC/Xfer
lib/BackupPC/Zip
lib/Net lib/Net/FTP
) ) {
next if ( -d "$DestDir$Conf{InstallDir}/$dir" );
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");
} else {
print("Created $DestDir$Conf{InstallDir}/$dir\n");
}
}
#
# Create CGI image directory
#
foreach my $dir ( ($Conf{CgiImageDir}) ) {
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");
}
}
#
# Create other directories
#
foreach my $dir ( (
"$Conf{TopDir}", "$Conf{TopDir}/pool", "$Conf{TopDir}/cpool", "$Conf{TopDir}/pc",
"$Conf{ConfDir}", "$Conf{LogDir}", "$Conf{RunDir}",
) ) {
eval { mkpath("$DestDir$dir", 0, 0750) } if ( !-d "$DestDir$dir" );
if ( $@
|| !-d "$DestDir$dir"
|| !my_chown($Uid, $Gid, "$DestDir$dir") ) {
if ( $dir eq $Conf{RunDir} ) {
print("Failed to create or chown $DestDir$dir... continuing\n");
} else {
die("Failed to create or chown $DestDir$dir\n");
}
} else {
print("Created $DestDir$dir\n");
}
}
print("Installing binaries in $DestDir$Conf{InstallDir}/bin\n");
foreach my $prog ( @ConfigureBinList ) {
InstallFile($prog, "$DestDir$Conf{InstallDir}/$prog", 0555);
}
#
# remove old pre-v4 programs
#
foreach my $prog ( qw(
bin/BackupPC_link
bin/BackupPC_tarPCCopy
bin/BackupPC_trashClean
bin/BackupPC_compressPool
) ) {
unlink("$DestDir$Conf{InstallDir}/$prog");
}
print("Installing library in $DestDir$Conf{InstallDir}/lib\n");
foreach my $lib ( @ConfigureLibList ) {
InstallFile($lib, "$DestDir$Conf{InstallDir}/$lib", 0444);
}
#
# remove old pre-v4 libraries
#
foreach my $lib ( qw(
lib/BackupPC/Attrib.pm
lib/BackupPC/Config.pm
lib/BackupPC/FileZIO.pm
lib/BackupPC/PoolWrite.pm
lib/BackupPC/Xfer/RsyncDigest.pm
lib/BackupPC/Xfer/RsyncFileIO.pm
) ) {
unlink("$DestDir$Conf{InstallDir}/$lib");
}
if ( $Conf{CgiImageDir} ne "" ) {
print("Installing images in $DestDir$Conf{CgiImageDir}\n");
foreach my $img ( <images/*> ) {
(my $destImg = $img) =~ s{^images/}{};
InstallFile($img, "$DestDir$Conf{CgiImageDir}/$destImg", 0444, 1);
}
#
# Install new CSS file, making a backup copy if necessary
#
my $cssBackup = "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css.pre-__VERSION__";
if ( -f "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css" && !-f $cssBackup ) {
rename("$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", $cssBackup);
}
InstallFile("conf/BackupPC_stnd.css", "$DestDir$Conf{CgiImageDir}/BackupPC_stnd.css", 0444, 0);
InstallFile("conf/BackupPC_retro_v2.css", "$DestDir$Conf{CgiImageDir}/BackupPC_retro_v2.css", 0444, 0);
InstallFile("conf/BackupPC_retro_v3.css", "$DestDir$Conf{CgiImageDir}/BackupPC_retro_v3.css", 0444, 0);
InstallFile("conf/sorttable.js", "$DestDir$Conf{CgiImageDir}/sorttable.js", 0444, 0);
}
print("Making systemd and init.d scripts\n");
foreach my $dir ( qw(systemd systemd/init.d) ) {
mkpath($dir, 0, 0755);
if ( !-d $dir || !my_chown($Uid, $Gid, $dir) ) {
die("Failed to create or chown $dir\n");
}
}
InstallFile("systemd/src/backuppc.service", "systemd/backuppc.service", 0644);
foreach my $init ( qw(init.d/gentoo-backuppc init.d/gentoo-backuppc.conf
init.d/linux-backuppc init.d/solaris-backuppc init.d/debian-backuppc
init.d/freebsd-backuppc init.d/freebsd-backuppc2 init.d/suse-backuppc
init.d/slackware-backuppc init.d/ubuntu-backuppc ) ) {
InstallFile("systemd/src/$init", "systemd/$init", 0755);
}
print("Making Apache configuration file for suid-perl\n");