/
imscp-setup-methods.pl
1787 lines (1475 loc) · 57.5 KB
/
imscp-setup-methods.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/perl
# i-MSCP - internet Multi Server Control Panel
# Copyright (C) 2010-2016 by internet Multi Server Control Panel
#
# 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 2
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
use strict;
use warnings;
use FindBin;
use DateTime;
use DateTime::TimeZone;
use Net::LibIDN qw/idn_to_ascii idn_to_unicode/;
use Data::Validate::Domain qw/is_domain/;
use Scalar::Util qw(openhandle);
use File::Basename;
use iMSCP::Debug;
use iMSCP::Net;
use iMSCP::Bootstrapper;
use iMSCP::Dialog;
use iMSCP::Stepper;
use iMSCP::Crypt qw/encryptBlowfishCBC decryptBlowfishCBC/;
use iMSCP::Database;
use iMSCP::DbTasksProcessor;
use iMSCP::Dir;
use iMSCP::File;
use iMSCP::Execute;
use iMSCP::EventManager;
use iMSCP::Rights;
use iMSCP::TemplateParser;
use iMSCP::SystemGroup;
use iMSCP::SystemUser;
use iMSCP::OpenSSL;
use iMSCP::Servers;
use iMSCP::Packages;
use iMSCP::Plugins;
use iMSCP::Getopt;
use iMSCP::Service;
use iMSCP::Mount qw / mount addMountEntry /;
use Servers::sqld;
use Quota;
# Boot
sub setupBoot
{
# Reset config variables
undef %main::imscpConfig;
undef %main::imscpOldConfig;
# We do not try to establish connection to the database since needed data can be unavailable at this stage
iMSCP::Bootstrapper->getInstance()->boot({ mode => 'setup', nodatabase => 'yes' });
# Make sure that we have an old conffile
unless (-f "$main::imscpConfig{'CONF_DIR'}/imscp.old.conf") {
my $rs = iMSCP::File->new( filename => "$main::imscpConfig{'CONF_DIR'}/imscp.conf" )->copyFile(
"$main::imscpConfig{'CONF_DIR'}/imscp.old.conf"
);
return $rs if $rs;
}
tie %main::imscpOldConfig, 'iMSCP::Config', fileName => "$main::imscpConfig{'CONF_DIR'}/imscp.old.conf";
0;
}
# Set server capabilities
# Currently used for detecting IPv6 support
sub setServerCapabilities
{
# FIXME: It is sufficient for check of IPv6 support?
$main::imscpConfig{'IPV6_SUPPORT'} = -f '/proc/net/if_inet6' ? 1 : 0;
0;
}
# Allow any server/package to register its setup event listeners before any other task
sub setupRegisterListeners
{
my ($eventManager, $rs) = (iMSCP::EventManager->getInstance(), 0);
for(iMSCP::Servers->getInstance()->get()) {
next if $_ eq 'noserver';
my $server = "Servers::$_";
eval "require $server";
unless($@) {
my $instance = $server->factory();
$rs = $instance->registerSetupListeners($eventManager) if $instance->can('registerSetupListeners');
return $rs if $rs;
next;
}
error($@);
return 1;
}
for(iMSCP::Packages->getInstance()->get()) {
my $package = "Package::$_";
eval "require $package";
unless($@) {
my $instance = $package->getInstance();
$rs = $instance->registerSetupListeners($eventManager) if $instance->can('registerSetupListeners');
return $rs if $rs;
next;
}
error($@);
return 1;
}
$rs;
}
# Trigger all dialog subroutines
sub setupDialog
{
my $dialogStack = [];
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupDialog', $dialogStack);
return $rs if $rs;
unshift(@{$dialogStack}, (
\&setupAskServerHostname,
\&setupAskServerPrimaryIP,
\&askMasterSqlUser,
\&setupAskSqlUserHost,
\&setupAskImscpDbName,
\&setupAskDbPrefixSuffix,
\&setupAskTimezone,
\&setupAskServicesSsl,
\&setupAskImscpBackup,
\&setupAskDomainBackup
));
my $dialog = iMSCP::Dialog->getInstance();
$dialog->set('ok-label', 'Ok');
$dialog->set('yes-label', 'Yes');
$dialog->set('no-label', 'No');
$dialog->set('cancel-label', 'Back');
# Implements a simple state machine (backup capability)
# Any dialog subroutine *should* allow user to step back by returning 30 when 'back' button is pushed
# In case of yesno dialog box, there is no back button. Instead, user can back up using the ESC keystroke
# In any other context, the ESC keystroke allows user to abort.
my ($state, $nbDialog) = (0, scalar @{$dialogStack});
while($state != $nbDialog) {
$rs = $dialogStack->[$state]->($dialog);
exit($rs) if $rs > 30;
return $rs if $rs && $rs < 30;
# User asked for step back?
if($rs == 30) {
if($state > 0) {
$state = $state - 1;
} else {
$state = 0; # We don't allow to step back before first question
}
$main::reconfigure = 'forced' if $main::reconfigure eq 'none';
} else {
$main::reconfigure = 'none' if $main::reconfigure eq 'forced';
$state++;
}
}
iMSCP::EventManager->getInstance()->trigger('afterSetupDialog');
}
# Process setup tasks
sub setupTasks
{
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupTasks');
return $rs if $rs;
my @steps = (
[ \&setupSaveConfig, 'Saving configuration' ],
[ \&setupCreateMasterUser, 'Creating system master user' ],
[ \&setupSystemDirectories, 'Setup system directories' ],
[ \&setupServerHostname, 'Setting server hostname' ],
[ \&setupServiceSsl, 'Setup SSL for i-MSCP services' ],
[ \&setupServices, 'Setup i-MSCP services' ],
[ \&setupRegisterDelayedTasks, 'Register delayed tasks' ],
[ \&setupRegisterPluginListeners, 'Register plugin setup listeners' ],
[ \&setupPreInstallServers, 'Servers pre-installation...' ],
[ \&setupPreInstallPackages, 'Packages pre-installation...' ],
[ \&setupInstallServers, 'Servers installation...' ],
[ \&setupInstallPackages, 'Packages installation...' ],
[ \&setupPostInstallServers, 'Servers post-installation...' ],
[ \&setupPostInstallPackages, 'Packages post-installation...' ],
[ \&setupSetPermissions, 'Setting permissions...' ],
[ \&setupDbTasks, 'Processing DB tasks...' ],
[ \&setupRestartServices, 'Restarting services...' ],
[ \&setupSyncConfig, 'Syncing configuration file...']
);
my $step = 1;
my $nbSteps = @steps;
for (@steps) {
$rs = step($_->[0], $_->[1], $nbSteps, $step);
return $rs if $rs;
$step++;
}
iMSCP::Dialog->getInstance()->endGauge();
iMSCP::EventManager->getInstance()->trigger('afterSetupTasks');
}
#
## Dialog subroutines
#
# Ask for server hostname
sub setupAskServerHostname
{
my $dialog = shift;
my $hostname = setupGetQuestion('SERVER_HOSTNAME');
my $options = { domain_private_tld => qr /.*/ };
my ($rs, $msg) = (0, '');
if($main::reconfigure =~ /^(?:system_hostname|hostnames|all|forced)$/
|| split(/\./, $hostname) < 3 || !is_domain($hostname, $options)
) {
chomp($hostname) unless($hostname || execute('hostname -f', \$hostname, \my $stderr));
$hostname = idn_to_unicode($hostname, 'utf-8');
do {
($rs, $hostname) = $dialog->inputbox(<<"EOF", $hostname);
Please enter a fully-qualified hostname for the server:$msg
EOF
$msg = "\n\n\\Z1'$hostname' is not a valid fully-qualified host name.\\Zn\n\nPlease try again:";
} while($rs < 30 && (split(/\./, $hostname) < 3 || !is_domain(idn_to_ascii($hostname, 'utf-8'), $options)));
}
setupSetQuestion('SERVER_HOSTNAME', idn_to_ascii($hostname, 'utf-8')) if $rs < 30;
$rs;
}
# Ask for server's primary IP
sub setupAskServerPrimaryIP
{
my $dialog = shift;
my $primaryIP = setupGetQuestion('BASE_SERVER_IP');
my $publicIP = setupGetQuestion('BASE_SERVER_PUBLIC_IP');
my $net = iMSCP::Net->getInstance();
my ($rs, $msg) = (0, '');
# Retrieve list of available IP addresses
my @ipAddresses = sort grep {
$net->getAddrType($_) =~ /^(?:PRIVATE|UNIQUE-LOCAL-UNICAST|PUBLIC|GLOBAL-UNICAST)$/
} $net->getAddresses();
unless(@ipAddresses) {
error('Could not retrieve server IP addresses. At least one public or private IP adddress must be configured.');
return 1;
}
if($main::reconfigure =~ /^(?:primary_ip|all|forced)$/
|| !grep($_ eq $primaryIP, @ipAddresses)
|| !$net->isValidAddr($publicIP)
|| $net->getAddrType($publicIP) !~ /^(?:PRIVATE|UNIQUE-LOCAL-UNICAST|PUBLIC|GLOBAL-UNICAST)$/
) {
do {
# Ask user for the primary server IP
($rs, $primaryIP) = $dialog->radiolist(
<<"EOF", [ @ipAddresses ], grep($_ eq $primaryIP, @ipAddresses) ? $primaryIP : $ipAddresses[0]);
Please, select your primary server IP address:
EOF
} while($rs < 30 && !$primaryIP);
if($rs < 30) {
# Server inside private LAN?
if($net->getAddrType($primaryIP) =~ /^(?:PRIVATE|UNIQUE-LOCAL-UNICAST)$/) {
if (!$net->isValidAddr($publicIP)
|| $net->getAddrType($publicIP) !~ /^(?:PUBLIC|GLOBAL-UNICAST)$/
) {
$publicIP = '';
}
$msg = '';
do {
($rs, $publicIP) = $dialog->inputbox(<<"EOF", $publicIP);
The system has detected that your server is inside a private LAN.
Please enter your public IP address:$msg
\\ZbNote:\\Zn Leave blank to force usage of the private IP address.
EOF
if($publicIP) {
unless($net->isValidAddr($publicIP)) {
$msg = "\n\n\\Z1Invalid or unallowed IP address.\\Zn\n\nPlease try again:";
} elsif($net->getAddrType($publicIP) !~ /^(?:PUBLIC|GLOBAL-UNICAST)$/) {
$msg = "\n\n\\Z1Unallowed IP address. IP address must be public.\\Zn\n\nPlease try again:";
} else {
$msg = '';
}
} else {
$publicIP = $primaryIP;
$msg = ''
}
} while($rs < 30 && $msg);
} else {
$publicIP = $primaryIP
}
}
}
if($rs < 30) {
setupSetQuestion('BASE_SERVER_IP', $primaryIP);
setupSetQuestion('BASE_SERVER_PUBLIC_IP', $publicIP);
}
$rs;
}
sub askSqlRootUser
{
my ($dialog) = @_;
my $host = setupGetQuestion('DATABASE_HOST', $main::imscpConfig{'SQL_SERVER'} eq 'remote_server' ? '' : 'localhost');
my $port = setupGetQuestion('DATABASE_PORT', 3306);
my $user = setupGetQuestion('SQL_ROOT_USER', 'root');
my $pwd = setupGetQuestion('SQL_ROOT_PASSWORD');
my ($rs, $msg) = (0, '');
if($host eq 'localhost') {
# If authentication is made through unix socket, password is normally not required.
# We try a connect without password with 'root' as user and we return on success
for('localhost', '127.0.0.1') {
next if tryDbConnect($_, $port, $user, $pwd);
setupSetQuestion('DATABASE_TYPE', 'mysql');
setupSetQuestion('DATABASE_HOST', $_);
setupSetQuestion('DATABASE_PORT', $port);
setupSetQuestion('SQL_ROOT_USER', $user);
setupSetQuestion('SQL_ROOT_PASSWORD', $pwd);
return 0;
}
}
do {
($rs, $host) = $dialog->inputbox(<<"EOF", $host, 'utf-8');
Please enter your SQL server hostname or IP address:$msg
EOF
$msg = ($host eq '' || $host ne 'localhost') && !is_domain($host, { domain_private_tld => qr /.*/ } )
&& !iMSCP::Net->getInstance()->isValidAddr($host)
? "\n\n\\Z1SQL server hostname or IP address is not valid.\\Zn\n\nPlease try again:" : '';
} while($rs < 30 && $msg ne '');
return $rs if $rs >= 30;
do {
($rs, $port) = $dialog->inputbox(<<"EOF", $port);
Please enter your SQL server port:$msg
EOF
$msg = $port !~ /^[\d]+$/ || $port < 1025 || $port > 65535
? "\n\n\\Z1SQL server port is not valid.\\Zn\n\nPlease try again:" : '';
} while($rs < 30 && $msg ne '');
return $rs if $rs >= 30;
do {
($rs, $user) = $dialog->inputbox(<<"EOF", $user);
Please enter your SQL root username:$msg
Note that this user must have full privileges on the SQL server.
i-MSCP only uses that user while installation or reconfiguration.
EOF
$msg = $user eq '' ? "\n\n\\Z1A SQL root user is required.\\Zn\n\nPlease try again:" : '';
} while($rs < 30 && $msg) ne '';
return $rs if $rs >= 30;
do {
($rs, $pwd) = $dialog->passwordbox(<<"EOF");
Please enter your SQL root user password:$msg
EOF
$msg = $pwd eq ''? "\n\n\\Z1SQL root user password is required.\\Zn\n\nPlease try again:" : '';
} while($rs < 30 && $msg);
return $rs if $rs >= 30;
if(my $connectError = tryDbConnect($host, $port, $user, $pwd)) {
$rs = $dialog->msgbox(<<"EOF");
\\Z1Connection to SQL server failed\\Zn
i-MSCP installer could not connect to SQL server using the following data:
\\Z4Host:\\Zn $host
\\Z4Port:\\Zn $port
\\Z4Username:\\Zn $user
\\Z4Password:\\Zn $pwd
Error was: \\Z1$connectError\\Zn
Please try again.
EOF
goto &{askSqlRootUser} unless $rs >= 30;
}
if($rs < 30) {
setupSetQuestion('DATABASE_TYPE', 'mysql');
setupSetQuestion('DATABASE_HOST', idn_to_ascii($host, 'utf-8'));
setupSetQuestion('DATABASE_PORT', $port);
setupSetQuestion('SQL_ROOT_USER', $user);
setupSetQuestion('SQL_ROOT_PASSWORD', $pwd);
}
$rs;
}
sub askMasterSqlUser
{
my $dialog = shift;
my $host = setupGetQuestion('DATABASE_HOST');
my $port = setupGetQuestion('DATABASE_PORT');
my $user = setupGetQuestion('DATABASE_USER', 'imscp_user');
$user = 'imscp_user' if lc($user) eq 'root'; # Handle upgrade case
my $pwd = setupGetQuestion('DATABASE_PASSWORD');
my ($rs, $msg) = (0, '');
$pwd = decryptBlowfishCBC($main::imscpDBKey, $main::imscpDBiv, $pwd) unless $pwd eq '' || iMSCP::Getopt->preseed;
if($main::reconfigure =~ /^(?:sql|servers|all|forced)$/
|| $host eq '' || $port eq '' || $user eq '' || $user eq 'root' || $pwd eq ''
|| tryDbConnect($host, $port, $user, $pwd)
) {
$rs = askSqlRootUser($dialog);
return $rs if $rs >= 30;
do {
($rs, $user) = $dialog->inputbox( <<"EOF", $msg eq '' ? $user : '' );
Please enter a username for the master i-MSCP SQL user:$msg
EOF
if (lc($user) eq 'root') {
$msg = "\n\n\\Z1Usage of SQL root user is prohibited. \\Zn\n\nPlease try again:";
} elsif (length $user > 16) {
$msg = "\n\n\\Username can be up to 16 characters long.\\Zn\n\nPlease try again:";
} elsif (length $user < 6) {
$msg = "\n\n\\Z1Username must be at least 6 characters long.\\Zn\n\nPlease try again:";
} elsif ($user !~ /^[\x21-\x5b\x5d-\x7e]+$/) {
$msg = "\n\n\\Z1Only printable ASCII characters (excepted space and backslash) are allowed.\\Zn\n\nPlease try again:";
} else {
$msg = '';
}
} while ($rs < 30 && $msg ne '');
if ($rs < 30) {
$pwd = '';
do {
($rs, $pwd) = $dialog->passwordbox( <<"EOF", $msg eq '' ? $pwd : '');
Please enter a password for the master i-MSCP SQL user (blank for autogenerate):$msg
EOF
if ($pwd ne '' && length $pwd < 6) {
$msg = "\n\n\\Z1Password must be at least 6 characters long.\\Zn\n\nPlease try again:";
} elsif ($pwd =~ /[^\x30-\x39\x41-\x5a\x61-\x7a]/) {
$msg = "\n\n\\Z1Only ASCII alphabet characters and numbers are allowed.\\Zn\n\nPlease try again:";
} else {
$msg = '';
}
} while ($rs < 30 && $msg ne '');
if ($rs < 30) {
unless ($pwd) {
my @allowedChr = map { chr } (0x30 .. 0x39, 0x41 .. 0x5a, 0x61 .. 0x7a);
$pwd = '';
$pwd .= $allowedChr[rand @allowedChr] for 1 .. 16;
}
$dialog->msgbox( <<"EOF" );
Password for master i-MSCP SQL user set to: $pwd
EOF
}
}
}
if($rs < 30) {
setupSetQuestion('DATABASE_USER', $user);
setupSetQuestion('DATABASE_PASSWORD', encryptBlowfishCBC($main::imscpDBKey, $main::imscpDBiv, $pwd));
# Substitute SQL root user data with i-MSCP master user data if needed
setupSetQuestion('SQL_ROOT_USER', setupGetQuestion('SQL_ROOT_USER', $user));
setupSetQuestion('SQL_ROOT_PASSWORD', setupGetQuestion('SQL_ROOT_PASSWORD', $pwd));
}
$rs;
}
# Ask for hosts from which SQL users are allowed to connect from
sub setupAskSqlUserHost
{
my $dialog = shift;
my $host = idn_to_ascii(setupGetQuestion('DATABASE_USER_HOST', setupGetQuestion('BASE_SERVER_PUBLIC_IP')), 'utf-8');
my %options = (domain_private_tld => qr /.*/);
my $net = iMSCP::Net->getInstance();
my $rs = 0;
if($main::imscpConfig{'SQL_SERVER'} eq 'remote_server') { # Remote MySQL server
if(($main::reconfigure =~ /^(?:sql|servers|all|forced)$/ || $host ne '%') && !is_domain($host, \%options)
&& !$net->isValidAddr($host)
) {
my $msg = '';
do {
($rs, $host) = $dialog->inputbox(<<"EOF", idn_to_unicode($host, 'utf-8'));
Please, enter the host from which SQL users created by i-MSCP must be allowed to connect to your SQL server:$msg
Please refer to http://dev.mysql.com/doc/refman/5.5/en/account-names.html for allowed values.
EOF
$msg = '';
$host = idn_to_ascii($host, 'utf-8');
if($host ne '%'
&& !is_domain($host, \%options)
&& !$net->isValidAddr($host)
|| $net->getAddrType($host) =~ /^(?:LOOPBACK|LINK-LOCAL-UNICAST)$/
) {
$msg = sprintf("\n\n\\Z1Error: '%s' is not valid or not allowed.\\Zn\n\nPlease try again:", $host);
}
} while($rs < 30 && $msg ne '');
}
setupSetQuestion('DATABASE_USER_HOST', $host) if $rs < 30;
} else {
setupSetQuestion('DATABASE_USER_HOST', 'localhost');
}
$rs;
}
# Ask for i-MSCP database name
sub setupAskImscpDbName
{
my($dialog) = @_;
my $dbName = setupGetQuestion('DATABASE_NAME', 'imscp');
my $rs = 0;
if($main::reconfigure =~ /^(?:sql|servers|all|forced)$/ || (!setupIsImscpDb($dbName) && !iMSCP::Getopt->preseed)) {
my $msg = '';
do {
($rs, $dbName) = $dialog->inputbox(<<"EOF", $dbName);
Please enter a database name for i-MSCP:$msg
EOF
$msg = '';
unless($dbName) {
$msg = "\n\n\\Z1Database name cannot be empty.\\Zn\n\nPlease try again:";
} elsif($dbName =~ /[:;]/) {
$msg = "\n\n\\Z1Database name contain illegal characters ':' and/or ';'.\\Zn\n\nPlease try again:";
} else {
my $db = iMSCP::Database->factory();
local $@;
eval { $db->useDatabase($dbName); };
if(!$@ && !setupIsImscpDb($dbName)) {
$msg = "\n\n\\Z1Database '$dbName' exists but do not look like an i-MSCP database.\\Zn\n\nPlease try again:";
}
}
} while ($rs < 30 && $msg ne '');
if($rs < 30) {
my $oldDbName = setupGetQuestion('DATABASE_NAME');
if($oldDbName && $dbName ne $oldDbName && setupIsImscpDb($oldDbName)) {
if($dialog->yesno(<<"EOF", 1)) {
A database '$main::imscpConfig{'DATABASE_NAME'}' for i-MSCP already exists.
Are you sure you want to create a new database?
Keep in mind that the new database will be free of any reseller and customer data.
\\Z4Note:\\Zn If the database you want to create already exists, nothing will happen.
EOF
goto &{setupAskImscpDbName};
}
}
}
}
setupSetQuestion('DATABASE_NAME', $dbName) if $rs < 30;
$rs;
}
# Ask for database prefix/suffix
sub setupAskDbPrefixSuffix
{
my $dialog = shift;
my $prefix = setupGetQuestion('MYSQL_PREFIX');
my $rs = 0;
if($main::reconfigure =~ /^(?:sql|servers|all|forced)$/ || $prefix !~ /^(?:behind|infront|none)$/) {
($rs, $prefix) = $dialog->radiolist(
<<"EOF", [ 'infront', 'behind', 'none' ], $prefix =~ /^(?:behind|infront)$/ ? $prefix : 'none');
\\Z4\\Zb\\ZuMySQL Database Prefix/Suffix\\Zn
Do you want use a prefix or suffix for customer's SQL databases?
\\Z4Infront:\\Zn A numeric prefix such as '1_' will be added to each customer
SQL user and database name.
\\Z4Behind:\\Zn A numeric suffix such as '_1' will be added to each customer
SQL user and database name.
\\Z4None\\Zn: Choice will be let to customer.
EOF
}
if($rs < 30) {
setupSetQuestion('MYSQL_PREFIX', $prefix);
}
$rs;
}
# Ask for timezone
sub setupAskTimezone
{
my $dialog = shift;
my $defaultTimezone = DateTime->new(year => 0, time_zone => 'local')->time_zone->name;
my $timezone = setupGetQuestion('TIMEZONE');
my $rs = 0;
if($main::reconfigure =~ /^(?:timezone|all|forced)$/ || !($timezone && DateTime::TimeZone->is_valid_name($timezone))) {
$timezone = $defaultTimezone unless $timezone;
my $msg = '';
do {
($rs, $timezone) = $dialog->inputbox(<<"EOF", $timezone);
Please enter your timezone:$msg
EOF
$msg = "\n\n\\Z1'$timezone' is not a valid timezone.\\Zn\n\nPlease try again:";
} while($rs < 30 && !DateTime::TimeZone->is_valid_name($timezone));
}
setupSetQuestion('TIMEZONE', $timezone) if $rs < 30;
$rs;
}
# Ask for services SSL
sub setupAskServicesSsl
{
my ($dialog) = @_;
my $hostname = setupGetQuestion('SERVER_HOSTNAME');
my $hostnameUnicode = idn_to_unicode($hostname, 'utf-8');
my $sslEnabled = setupGetQuestion('SERVICES_SSL_ENABLED');
my $selfSignedCertificate = setupGetQuestion('SERVICES_SSL_SELFSIGNED_CERTIFICATE', 'no');
my $privateKeyPath = setupGetQuestion('SERVICES_SSL_PRIVATE_KEY_PATH', '/root');
my $passphrase = setupGetQuestion('SERVICES_SSL_PRIVATE_KEY_PASSPHRASE');
my $certificatPath = setupGetQuestion('SERVICES_SSL_CERTIFICATE_PATH', '/root');
my $caBundlePath = setupGetQuestion('SERVICES_SSL_CA_BUNDLE_PATH', '/root');
my $openSSL = iMSCP::OpenSSL->new();
my $rs = 0;
if($main::reconfigure =~ /^(?:services_ssl|ssl|all|forced)$/ || $sslEnabled !~ /^(?:yes|no)$/
|| ($sslEnabled eq 'yes' && $main::reconfigure =~ /^(?:system_hostname|hostnames)$/)
) {
# Ask for SSL
$rs = $dialog->yesno(<<"EOF", $sslEnabled eq 'no' ? 1 : 0);
Do you want to activate SSL for SMTP, POP/IMAP and FTP services?
EOF
if($rs == 0) {
$sslEnabled = 'yes';
# Ask for self-signed certificate
$rs = $dialog->yesno(<<"EOF", $selfSignedCertificate eq 'no' ? 1 : 0);
Do you have an SSL certificate for the $hostnameUnicode domain?
EOF
if($rs == 0) {
# Ask for private key
my $msg = '';
do {
$dialog->msgbox(<<"EOF");
$msg
Please select your private key in next dialog.
EOF
do {
($rs, $privateKeyPath) = $dialog->fselect($privateKeyPath);
} while($rs < 30 && !($privateKeyPath && -f $privateKeyPath));
if($rs < 30) {
($rs, $passphrase) = $dialog->passwordbox(<<"EOF", $passphrase);
Please enter the passphrase for your private key if any:
EOF
}
if($rs < 30) {
$openSSL->{'private_key_container_path'} = $privateKeyPath;
$openSSL->{'private_key_passphrase'} = $passphrase;
if($openSSL->validatePrivateKey()) {
getMessageByType('error', { remove => 1 });
$msg = "\n\\Z1Wrong private key or passphrase. Please try again.\\Zn\n\n";
} else {
$msg = '';
}
}
} while($rs < 30 && $msg);
# Ask for CA bundle
if($rs < 30) {
$rs = $dialog->yesno(<<"EOF");
Do you have an SSL CA Bundle?
EOF
if($rs == 0) {
do {
($rs, $caBundlePath) = $dialog->fselect($caBundlePath);
} while($rs < 30 && !($caBundlePath && -f $caBundlePath));
$openSSL->{'ca_bundle_container_path'} = $caBundlePath if $rs < 30;
} else {
$openSSL->{'ca_bundle_container_path'} = '';
}
}
if($rs < 30) {
$dialog->msgbox(<<"EOF");
Please select your SSL certificate in next dialog.
EOF
$rs = 1;
do {
$dialog->msgbox(<<"EOF") unless $rs;
\\Z1Wrong SSL certificate. Please try again.\\Zn
EOF
do {
($rs, $certificatPath) = $dialog->fselect($certificatPath);
} while($rs < 30 && !($certificatPath && -f $certificatPath));
getMessageByType('error', { remove => 1 });
$openSSL->{'certificate_container_path'} = $certificatPath if $rs < 30;
} while($rs < 30 && $openSSL->validateCertificate());
}
} else {
$rs = 0;
$selfSignedCertificate = 'yes';
}
} else {
$rs = 0;
$sslEnabled = 'no';
}
} elsif($sslEnabled eq 'yes' && !iMSCP::Getopt->preseed) {
$openSSL->{'private_key_container_path'} = "$main::imscpConfig{'CONF_DIR'}/imscp_services.pem";
$openSSL->{'ca_bundle_container_path'} = "$main::imscpConfig{'CONF_DIR'}/imscp_services.pem";
$openSSL->{'certificate_container_path'} = "$main::imscpConfig{'CONF_DIR'}/imscp_services.pem";
if($openSSL->validateCertificateChain()) {
getMessageByType('error', { remove => 1 });
iMSCP::Dialog->getInstance()->msgbox(<<"EOF");
Your SSL certificate for the SMTP, POP/IMAP and FTP services is missing or not valid.
EOF
setupSetQuestion('SERVICES_SSL_ENABLED', '');
goto &{setupAskServicesSsl};
}
# In case the certificate is valid, we skip SSL setup process
setupSetQuestion('SERVICES_SSL_SETUP', 'no');
}
if($rs < 30) {
setupSetQuestion('SERVICES_SSL_ENABLED', $sslEnabled);
setupSetQuestion('SERVICES_SSL_SELFSIGNED_CERTIFICATE', $selfSignedCertificate);
setupSetQuestion('SERVICES_SSL_PRIVATE_KEY_PATH', $privateKeyPath);
setupSetQuestion('SERVICES_SSL_PRIVATE_KEY_PASSPHRASE', $passphrase);
setupSetQuestion('SERVICES_SSL_CERTIFICATE_PATH', $certificatPath);
setupSetQuestion('SERVICES_SSL_CA_BUNDLE_PATH', $caBundlePath);
}
$rs;
}
# Ask for i-MSCP backup feature
sub setupAskImscpBackup
{
my $dialog = shift;
my $backupImscp = setupGetQuestion('BACKUP_IMSCP');
my $rs = 0;
if($main::reconfigure =~ /^(?:backup|all|forced)$/ || $backupImscp !~ /^(?:yes|no)$/) {
($rs, $backupImscp) = $dialog->radiolist(<<"EOF", [ 'yes', 'no' ], $backupImscp ne 'no' ? 'yes' : 'no');
\\Z4\\Zb\\Zui-MSCP Backup Feature\\Zn
Do you want to activate the backup feature for i-MSCP?
The backup feature for i-MSCP allows the daily save of all i-MSCP configuration files and its database. It's greatly recommended to activate this feature.
EOF
}
setupSetQuestion('BACKUP_IMSCP', $backupImscp) if $rs < 30;
$rs;
}
# Ask for customer backup feature
sub setupAskDomainBackup
{
my $dialog = shift;
my $backupDomains = setupGetQuestion('BACKUP_DOMAINS');
my $rs = 0;
if($main::reconfigure =~ /^(?:backup|all|forced)$/ || $backupDomains !~ /^(?:yes|no)$/) {
($rs, $backupDomains) = $dialog->radiolist(<<"EOF", [ 'yes', 'no' ], $backupDomains ne 'no' ? 'yes' : 'no');
\\Z4\\Zb\\ZuDomains Backup Feature\\Zn
Do you want to activate the backup feature for customers?
This feature allows resellers to enable backup for their customers such as:
- Full (domains and SQL databases)
- Domains only (Web files)
- SQL databases only
- None (no backup)
EOF
}
setupSetQuestion('BACKUP_DOMAINS', $backupDomains) if $rs < 30;
$rs;
}
#
## Setup subroutines
#
#sub setupSaveOldConfig
#{
# my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupSaveOldConfig');
# return $rs if $rs;
#
# unless(-f "$main::imscpConfig{'CONF_DIR'}/imscp.conf") {
# error(sprintf('File %s not found', "$main::imscpConfig{'CONF_DIR'}/imscp.conf"));
# return 1;
# }
#
# $rs = iMSCP::File->new( filename => "$main::imscpConfig{'CONF_DIR'}/imscp.conf" )->copyFile(
# "$main::imscpConfig{'CONF_DIR'}/imscp.old.conf"
# );
# $rs ||= iMSCP::EventManager->getInstance()->trigger('afterSetupSaveOldConfig');
#}
# Write configuration into imscp.conf file
sub setupSaveConfig
{
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupSaveConfig');
return $rs if $rs;
for my $question(keys %main::questions) {
if(exists $main::imscpConfig{$question}) {
$main::imscpConfig{$question} = $main::questions{$question};
}
}
iMSCP::EventManager->getInstance()->trigger('afterSetupSaveConfig');
}
sub setupCreateMasterUser
{
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupCreateMasterUser');
$rs ||= iMSCP::SystemGroup->getInstance()->addSystemGroup($main::imscpConfig{'IMSCP_GROUP'});
$rs ||= iMSCP::SystemUser->new(
username => $main::imscpConfig{'IMSCP_USER'},
group => $main::imscpConfig{'IMSCP_GROUP'},
comment => 'i-MSCP master user',
home => $main::imscpConfig{'IMSCP_HOMEDIR'}
)->addSystemUser();
# Ensure that correct permissions are set on i-MSCP master user homedir (handle upgrade case)
$rs ||= iMSCP::Dir->new( dirname => $main::imscpConfig{'IMSCP_HOMEDIR'} )->make(
{
user => $main::imscpConfig{'IMSCP_USER'},
group => $main::imscpConfig{'IMSCP_GROUP'},
mode => 0755,
fixpermissions => 1 # We fix permissions in any case
}
);
$rs ||= iMSCP::EventManager->getInstance()->trigger('afterSetupCreateMasterUser');
}
sub setupSystemDirectories
{
my @systemDirectories = (
[ $main::imscpConfig{'BACKUP_FILE_DIR'}, $main::imscpConfig{'ROOT_USER'}, $main::imscpConfig{'ROOT_GROUP'}, 0750 ]
);
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupSystemDirectories', \@systemDirectories);
return $rs if $rs;
for my $dir(@systemDirectories) {
$rs = iMSCP::Dir->new( dirname => $dir->[0] )->make(
{
user => $dir->[1],
group => $dir->[2],
mode => $dir->[3],
fixpermissions => iMSCP::Getopt->fixPermissions
}
);
return $rs if $rs;
}
# Make sure that the root directory is marked as shared in regards to mount
# propagation, even when not using systemd.
# See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=739593 for explanations
my ($device, $path, $type, $options);
Quota::setmntent();
while(($device, $path, $type, $options) = Quota::getmntent()) {
last if $path eq '/';
}
Quota::endmntent();
unless(defined $device) {
error('Could not find device name for the root directory.');
return 1;
}
$rs = mount(
{
fs_spec => $device,
fs_file => '/',
fs_vfstype => $type,
fs_mntops => "remount,rshared,$options"
}
);
$rs ||= addMountEntry("$device / $type remount,rshared,$options");
$rs ||= iMSCP::EventManager->getInstance()->trigger('afterSetupSystemDirectories');
}
sub setupServerHostname
{
my $hostname = setupGetQuestion('SERVER_HOSTNAME');
my $primaryIP = setupGetQuestion('BASE_SERVER_IP');
my $rs = iMSCP::EventManager->getInstance()->trigger('beforeSetupServerHostname', \$hostname, \$primaryIP);
return $rs if $rs;
my @labels = split /\./, $hostname;
my $host = shift @labels;
my $hostnameLocal = "$hostname.local";
my $file = iMSCP::File->new( filename => '/etc/hosts' );
$rs = $file->copyFile('/etc/hosts.bkp') unless -f '/etc/hosts.bkp';
return $rs if $rs;
my $net = iMSCP::Net->getInstance();
my $content = "# 'hosts' file configuration.\n\n";
$content .= "127.0.0.1\t$hostnameLocal\tlocalhost\n";
$content .= "$primaryIP\t$hostname\t$host\n";
$content .= "::ffff:$primaryIP\t$hostname\t$host\n" if $net->getAddrVersion($primaryIP) eq 'ipv4';
$content .= "::1\tip6-localhost\tip6-loopback\n" if $net->getAddrVersion($primaryIP) eq 'ipv4';
$content .= "::1\tip6-localhost\tip6-loopback\t$host\n" if $net->getAddrVersion($primaryIP) eq 'ipv6';
$content .= "fe00::0\tip6-localnet\n";
$content .= "ff00::0\tip6-mcastprefix\n";
$content .= "ff02::1\tip6-allnodes\n";
$content .= "ff02::2\tip6-allrouters\n";
$content .= "ff02::3\tip6-allhosts\n";
$rs = $file->set($content);
$rs ||= $file->save();
$rs ||= $file->mode(0644);
$rs ||= $file->owner($main::imscpConfig{'ROOT_USER'}, $main::imscpConfig{'ROOT_GROUP'});
return $rs if $rs;
$file = iMSCP::File->new( filename => '/etc/hostname' );
$rs = $file->set($host);