4 # InspIRCd -- Internet Relay Chat Daemon
6 # Copyright (C) 2012-2017 Peter Powell <petpow@saberuk.com>
7 # Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
8 # Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
9 # Copyright (C) 2003, 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
10 # Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
11 # Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
12 # Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
13 # Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
14 # Copyright (C) 2003-2006 Craig McLure <craig@chatspike.net>
16 # This file is part of InspIRCd. InspIRCd is free software: you can
17 # redistribute it and/or modify it under the terms of the GNU General Public
18 # License as published by the Free Software Foundation, version 2.
20 # This program is distributed in the hope that it will be useful, but WITHOUT
21 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
25 # You should have received a copy of the GNU General Public License
26 # along with this program. If not, see <http://www.gnu.org/licenses/>.
36 use warnings FATAL => qw(all);
38 use File::Basename qw(basename);
40 use File::Spec::Functions qw(rel2abs);
41 use FindBin qw($RealDir);
42 use Getopt::Long qw(GetOptions);
43 use POSIX qw(getgid getuid);
55 $opt_disable_interactive,
56 $opt_distribution_label,
69 sub enable_extras (@);
71 sub disable_extras (@);
74 my @opt_disableextras;
77 'clean' => \&cmd_clean,
79 'update' => \&cmd_update,
81 'development' => \$opt_development,
82 'disable-interactive' => \$opt_disable_interactive,
83 'distribution-label=s' => \$opt_distribution_label,
84 'binary-dir=s' => \$opt_binary_dir,
85 'config-dir=s' => \$opt_config_dir,
86 'data-dir=s' => \$opt_data_dir,
88 'log-dir=s' => \$opt_log_dir,
89 'manual-dir=s' => \$opt_manual_dir,
90 'module-dir=s' => \$opt_module_dir,
91 'prefix=s' => \$opt_prefix,
92 'script-dir=s' => \$opt_script_dir,
93 'socketengine=s' => \$opt_socketengine,
94 'system' => \$opt_system,
97 # TODO: when the modulemanager rewrite is done these should be removed.
98 'disable-extras=s@' => \@opt_disableextras,
99 'enable-extras=s@' => \@opt_enableextras,
100 'list-extras' => sub { list_extras; exit 0; },
103 if (scalar(@opt_enableextras) + scalar(@opt_disableextras) > 0) {
104 @opt_enableextras = split /,/, join(',', @opt_enableextras);
105 @opt_disableextras = split /,/, join(',', @opt_disableextras);
106 enable_extras(@opt_enableextras);
107 disable_extras(@opt_disableextras);
109 print "Remember: YOU are responsible for making sure any libraries needed have been installed!\n";
113 our $interactive = !(
116 defined $opt_binary_dir ||
117 defined $opt_config_dir ||
118 defined $opt_data_dir ||
119 defined $opt_development ||
120 defined $opt_disable_interactive ||
121 defined $opt_distribution_label ||
123 defined $opt_log_dir ||
124 defined $opt_manual_dir ||
125 defined $opt_module_dir ||
126 defined $opt_prefix ||
127 defined $opt_script_dir ||
128 defined $opt_socketengine ||
129 defined $opt_system ||
133 my %version = get_version $opt_distribution_label;
134 print_format "<|BOLD Configuring InspIRCd $version{FULL} on $^O.|>\n";
138 %config = read_config_file(CONFIGURE_CACHE_FILE);
139 run_test CONFIGURE_CACHE_FILE, %config;
140 if (!defined $config{VERSION}) {
141 $config{VERSION} = CONFIGURE_CACHE_VERSION;
142 } elsif ($config{VERSION} != CONFIGURE_CACHE_VERSION) {
143 print_warning "ignoring contents of ${\CONFIGURE_CACHE_FILE} as it was generated by an incompatible version of $0!";
144 %config = ('VERSION', CONFIGURE_CACHE_VERSION);
148 $config{CXX} = find_compiler($config{CXX} // $ENV{CXX});
149 unless ($config{CXX}) {
150 say 'A suitable C++ compiler could not be detected on your system!';
151 unless ($interactive) {
152 say 'Set the CXX environment variable to the path to a C++ compiler binary if this is incorrect.';
155 until ($config{CXX}) {
156 my $compiler_path = prompt_string 1, 'Please enter the path to a C++ compiler binary:', 'c++';
157 $config{CXX} = find_compiler $compiler_path;
160 my %compiler = get_compiler_info($config{CXX});
162 $config{HAS_ARC4RANDOM_BUF} = run_test 'arc4random_buf()', test_file($config{CXX}, 'arc4random_buf.cpp');
163 $config{HAS_CLOCK_GETTIME} = run_test 'clock_gettime()', test_file($config{CXX}, 'clock_gettime.cpp', $^O eq 'darwin' ? undef : '-lrt');
164 $config{HAS_EVENTFD} = run_test 'eventfd()', test_file($config{CXX}, 'eventfd.cpp');
167 push @socketengines, 'epoll' if run_test 'epoll', test_header $config{CXX}, 'sys/epoll.h';
168 push @socketengines, 'kqueue' if run_test 'kqueue', test_file $config{CXX}, 'kqueue.cpp';
169 push @socketengines, 'poll' if run_test 'poll', test_header $config{CXX}, 'poll.h';
170 push @socketengines, 'select';
172 if (defined $opt_socketengine) {
173 unless (grep { $_ eq $opt_socketengine } @socketengines) {
174 my $reason = -f "src/socketengines/socketengine_$opt_socketengine.cpp" ? 'is not available on this platform' : 'does not exist';
175 print_error "The socket engine you requested ($opt_socketengine) $reason!",
176 'Available socket engines are:',
177 map { " * $_" } @socketengines;
180 $config{SOCKETENGINE} = $opt_socketengine // $socketengines[0];
182 if (defined $opt_system) {
183 $config{BASE_DIR} = $opt_prefix // '/var/lib/inspircd';
184 $config{BINARY_DIR} = $opt_binary_dir // '/usr/sbin';
185 $config{CONFIG_DIR} = $opt_config_dir // '/etc/inspircd';
186 $config{DATA_DIR} = $opt_data_dir // '/var/inspircd';
187 $config{LOG_DIR} = $opt_module_dir // '/var/log/inspircd';
188 $config{MANUAL_DIR} = $opt_manual_dir // '/usr/share/man/man1';
189 $config{MODULE_DIR} = $opt_module_dir // '/usr/lib/inspircd';
190 $config{SCRIPT_DIR} = $opt_script_dir // '/usr/share/inspircd'
192 $config{BASE_DIR} = $opt_prefix // $config{BASE_DIR} // rel2abs 'run';
193 $config{BINARY_DIR} = $opt_binary_dir // $config{BINARY_DIR} // rel2abs $config{BASE_DIR} . '/bin';
194 $config{CONFIG_DIR} = $opt_config_dir // $config{CONFIG_DIR} // rel2abs $config{BASE_DIR} . '/conf';
195 $config{DATA_DIR} = $opt_data_dir // $config{DATA_DIR} // rel2abs $config{BASE_DIR} . '/data';
196 $config{LOG_DIR} = $opt_log_dir // $config{LOG_DIR} // rel2abs $config{BASE_DIR} . '/logs';
197 $config{MANUAL_DIR} = $opt_manual_dir // $config{MANUAL_DIR} // rel2abs $config{BASE_DIR} . '/manuals';
198 $config{MODULE_DIR} = $opt_module_dir // $config{MODULE_DIR} // rel2abs $config{BASE_DIR} . '/modules';
199 $config{SCRIPT_DIR} = $opt_script_dir // $config{SCRIPT_DIR} // $config{BASE_DIR};
202 # Parse --gid=123 or --gid=foo and extract the group id.
204 if (defined $opt_gid) {
205 @group = $opt_gid =~ /^\d+$/ ? getgrgid($opt_gid) : getgrnam($opt_gid);
206 print_error "there is no '$opt_gid' group on this system!" unless @group;
208 @group = $opt_system ? getgrnam('irc') : getgrgid($config{GID} // getgid());
209 print_error "you need to specify a group to run as using '--gid [id|name]'!" unless @group;
211 $config{GROUP} = $group[0];
212 $config{GID} = $group[2];
214 # Parse --uid=123 or --uid=foo and extract the user id.
216 if (defined $opt_uid) {
217 @user = $opt_uid =~ /^\d+$/ ? getpwuid($opt_uid) : getpwnam($opt_uid);
218 print_error "there is no '$opt_uid' user on this system!" unless @user;
220 @user = $opt_system ? getpwnam('irc') : getpwuid($config{UID} // getuid());
221 print_error "you need to specify a user to run as using '--uid [id|name]'!" unless @user;
223 $config{USER} = $user[0];
224 $config{UID} = $user[2];
227 system 'tput', 'clear' if $interactive;
229 # Warn the user about clock drifting when running on OpenVZ.
230 if (-e '/proc/user_beancounters' || -e '/proc/vz/vzaquota') {
231 print_warning <<'EOW';
232 You are building InspIRCd inside of an an OpenVZ container. If you
233 plan to use InspIRCd in this container then you should make sure that NTP is
234 configured on the Hardware Node. Failure to do so may result in clock drifting!
238 # Check that the user actually wants this version.
239 if ($version{LABEL} ne 'release') {
240 print_warning <<'EOW';
241 You are building a development version. This contains code which has
242 not been tested as heavily and may contain various faults which could seriously
243 affect the running of your server. It is recommended that you use a stable
246 You can obtain the latest stable version from http://www.inspircd.org/ or by
247 running `<|GREEN git checkout $(git describe --abbrev=0 --tags insp3)|>` if you are
250 if (!prompt_bool $interactive, 'I understand this warning and want to continue anyway.', $opt_development // 0) {
251 say STDERR 'If you understand this warning and still want to continue pass the --development flag.' unless $interactive;
256 # Configure directory settings.
257 my $question = <<"EOQ";
258 Currently, InspIRCd is configured with the following paths:
260 <|BOLD Base:|> $config{BASE_DIR}
261 <|BOLD Binary:|> $config{BINARY_DIR}
262 <|BOLD Config:|> $config{CONFIG_DIR}
263 <|BOLD Data:|> $config{DATA_DIR}
264 <|BOLD Log:|> $config{LOG_DIR}
265 <|BOLD Manual:|> $config{MANUAL_DIR}
266 <|BOLD Module:|> $config{MODULE_DIR}
267 <|BOLD Script:|> $config{SCRIPT_DIR}
269 Do you want to change these settings?
271 if (prompt_bool $interactive, $question, 0) {
272 my $original_base_dir = $config{BASE_DIR};
273 $config{BASE_DIR} = prompt_dir $interactive, 'In what directory do you wish to install the InspIRCd base?', $config{BASE_DIR};
274 foreach my $key (qw(BINARY_DIR CONFIG_DIR DATA_DIR LOG_DIR MANUAL_DIR MODULE_DIR SCRIPT_DIR)) {
275 $config{$key} =~ s/^\Q$original_base_dir\E/$config{BASE_DIR}/;
277 $config{BINARY_DIR} = prompt_dir $interactive, 'In what directory should the InspIRCd binary be placed?', $config{BINARY_DIR};
278 $config{CONFIG_DIR} = prompt_dir $interactive, 'In what directory are configuration files to be stored?', $config{CONFIG_DIR};
279 $config{DATA_DIR} = prompt_dir $interactive, 'In what directory are variable data files to be stored?', $config{DATA_DIR};
280 $config{LOG_DIR} = prompt_dir $interactive, 'In what directory are log files to be stored?', $config{LOG_DIR};
281 $config{MANUAL_DIR} = prompt_dir $interactive, 'In what directory are manual pages to be placed?', $config{MANUAL_DIR};
282 $config{MODULE_DIR} = prompt_dir $interactive, 'In what directory are modules to be placed?', $config{MODULE_DIR};
283 $config{SCRIPT_DIR} = prompt_dir $interactive, 'In what directory are scripts to be placed?', $config{SCRIPT_DIR};
286 # Configure module settings.
288 Currently, InspIRCd is configured to automatically enable all available extra modules.
290 Would you like to enable extra modules manually?
292 if (prompt_bool $interactive, $question, 0) {
293 foreach my $extra (<src/modules/extra/m_*.cpp>) {
294 my $module_name = basename $extra, '.cpp';
295 if (prompt_bool $interactive, "Would you like to enable $module_name?", 0) {
296 enable_extras "$module_name.cpp";
300 # TODO: finish modulemanager rewrite and replace this code with:
301 # system './modulemanager', 'enable', '--auto';
303 # Missing: m_ldap, m_regex_stdlib, m_ssl_mbedtls
304 'm_geoip.cpp' => 'pkg-config --exists geoip',
305 'm_mysql.cpp' => 'mysql_config --version',
306 'm_pgsql.cpp' => 'pg_config --version',
307 'm_regex_pcre.cpp' => 'pcre-config --version',
308 'm_regex_posix.cpp' => undef,
309 'm_regex_re2.cpp' => 'pkg-config --exists re2',
310 'm_regex_tre.cpp' => 'pkg-config --exists tre',
311 'm_sqlite3.cpp' => 'pkg-config --exists sqlite3',
312 'm_ssl_gnutls.cpp' => 'pkg-config --exists gnutls',
313 'm_ssl_openssl.cpp' => 'pkg-config --exists openssl',
314 'm_sslrehashsignal.cpp' => undef,
316 while (my ($module, $command) = each %modules) {
317 unless (defined $command && system "$command 1>/dev/null 2>/dev/null") {
318 enable_extras $module;
323 # Generate SSL certificates.
325 Would you like to generate a self-signed SSL certificate now? This certificate
326 can be used for testing but <|BOLD should not|> be used on a production network.
328 Note: you can get a <|BOLD free|> CA-signed certificate from Let's Encrypt. See
329 https://letsencrypt.org/getting-started/ for more details.
332 if (<src/modules/m_ssl_*.cpp> && prompt_bool $interactive, $question, $interactive) {
333 system './tools/genssl', 'auto';
336 # Cache the distribution label so that its not lost when --update is run.
337 $config{DISTRIBUTION} = $opt_distribution_label if $opt_distribution_label;
339 write_configure_cache %config;
340 parse_templates \%config, \%compiler, \%version;
342 print_format <<"EOM";
344 Configuration is complete! You have chosen to build with the following settings:
347 <|GREEN Binary:|> $config{CXX}
348 <|GREEN Name:|> $compiler{NAME}
349 <|GREEN Version:|> $compiler{VERSION}
351 <|GREEN Extra Modules:|>
354 for my $file (<src/modules/m_*>) {
355 my $module = basename $file, '.cpp';
356 say " * $module" if -l $file;
359 print_format <<"EOM";
362 <|GREEN Base:|> $config{BASE_DIR}
363 <|GREEN Binary:|> $config{BINARY_DIR}
364 <|GREEN Config:|> $config{CONFIG_DIR}
365 <|GREEN Data:|> $config{DATA_DIR}
366 <|GREEN Log:|> $config{LOG_DIR}
367 <|GREEN Manual:|> $config{MANUAL_DIR}
368 <|GREEN Module:|> $config{MODULE_DIR}
369 <|GREEN Script:|> $config{SCRIPT_DIR}
371 <|GREEN Execution Group:|> $config{GROUP} ($config{GID})
372 <|GREEN Execution User:|> $config{USER} ($config{UID})
373 <|GREEN Socket Engine:|> $config{SOCKETENGINE}
375 To build with these settings run '<|GREEN make -j${\get_cpu_count}|>' now.
379 # Routine to list out the extra/ modules that have been enabled.
380 # Note: when getting any filenames out and comparing, it's important to lc it if the
381 # file system is not case-sensitive (== Epoc, MacOS, OS/2 (incl DOS/DJGPP), VMS, Win32
382 # (incl NetWare, Symbian)). Cygwin may or may not be case-sensitive, depending on
383 # configuration, however, File::Spec does not currently tell us (it assumes Unix behavior).
387 my $srcdir = File::Spec->catdir("src", "modules");
388 my $abs_srcdir = File::Spec->rel2abs($srcdir);
391 opendir $dd, File::Spec->catdir($abs_srcdir, "extra") or die (File::Spec->catdir($abs_srcdir, "extra") . ": $!\n");
392 my @extras = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
395 opendir $dd, $abs_srcdir or die "$abs_srcdir: $!\n";
396 my @sources = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
399 my $maxlen = (sort { $b <=> $a } (map {length($_)} (@extras)))[0];
401 EXTRA: for my $extra (@extras) {
402 next if (File::Spec->curdir() eq $extra || File::Spec->updir() eq $extra);
403 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
404 my $abs_source = File::Spec->catfile($abs_srcdir, $extra);
405 next unless ($extra =~ m/\.(cpp|h)$/ || (-d $abs_extra)); # C++ Source/Header, or directory
406 if (-l $abs_source) {
407 # Symlink, is it in the right place?
408 my $targ = readlink($abs_source);
409 my $abs_targ = File::Spec->rel2abs($targ, $abs_srcdir);
410 if ($abs_targ eq $abs_extra) {
411 $extras{$extra} = "\e[32;1menabled\e[0m";
413 $extras{$extra} = sprintf("\e[31;1mwrong symlink target (%s)\e[0m", $abs_targ);
415 } elsif (-e $abs_source) {
416 my ($devext, $inoext) = stat($abs_extra);
417 my ($devsrc, $inosrc, undef, $lnksrc) = stat($abs_source);
419 if ($devsrc == $devext && $inosrc == $inoext) {
420 $extras{$extra} = "\e[32;1menabled\e[0m";
422 $extras{$extra} = sprintf("\e[31;1mwrong hardlink target (%d:%d)\e[0m", $devsrc, $inosrc);
425 open my $extfd, "<", $abs_extra;
426 open my $srcfd, "<", $abs_source;
428 if (scalar(<$extfd>) eq scalar(<$srcfd>)) {
429 $extras{$extra} = "\e[32;1menabled\e[0m";
431 $extras{$extra} = sprintf("\e[31;1mout of synch (re-copy)\e[0m");
435 $extras{$extra} = "\e[33;1mdisabled\e[0m";
438 # Now let's add dependency info
439 for my $extra (keys(%extras)) {
440 next unless $extras{$extra} =~ m/enabled/; # only process enabled extras.
441 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
442 my @deps = split /\s+/, get_directive($abs_extra, 'ModDep', '');
443 for my $dep (@deps) {
444 if (exists($extras{$dep})) {
445 my $ref = \$extras{$dep}; # Take reference.
446 if ($$ref !~ m/needed by/) {
447 # First dependency found.
448 if ($$ref =~ m/enabled/) {
449 $$ref .= " (needed by \e[32;1m$extra\e[0m";
451 $$ref =~ s/\e\[.*?m//g; # Strip out previous coloring. Will be set in bold+red+blink later.
452 $$ref .= " (needed by \e[0;32;1;5m$extra\e[0;31;1;5m";
455 if ($$ref =~ m/enabled/) {
456 $$ref .= ", \e[32;1m$extra\e[0m";
458 $$ref .= ", \e[0;32;1;5m$extra\e[0;31;1;5m";
464 for my $extra (sort {$a cmp $b} keys(%extras)) {
465 my $text = $extras{$extra};
466 if ($text =~ m/needed by/ && $text !~ m/enabled/) {
467 printf "\e[31;1;5m%-*s = %s%s\e[0m\n", $maxlen, $extra, $text, ($text =~ m/needed by/ ? ")" : "");
469 printf "%-*s = %s%s\n", $maxlen, $extra, $text, ($text =~ m/needed by/ ? "\e[0m)" : "");
472 return keys(%extras) if wantarray; # Can be used by manage_extras.
475 sub enable_extras (@) {
477 for my $extra (@extras) {
478 my $extrapath = "src/modules/extra/$extra";
479 if (!-e $extrapath) {
480 print STDERR "Cannot enable \e[32;1m$extra\e[0m : No such file or directory in src/modules/extra\n";
483 my $source = "src/modules/$extra";
485 print STDERR "Cannot enable \e[32;1m$extra\e[0m : destination in src/modules exists (might already be enabled?)\n";
488 # Get dependencies, and add them to be processed.
489 my @deps = split /\s+/, get_directive($extrapath, 'ModDep', '');
490 for my $dep (@deps) {
491 next if scalar(grep { $_ eq $dep } (@extras)) > 0; # Skip if we're going to be enabling it anyway.
492 if (!-e "src/modules/$dep" && !-e "include/$dep") {
493 if (-e "src/modules/extra/$dep") {
494 print STDERR "Will also enable extra \e[32;1m$dep\e[0m (needed by \e[32;1m$extra\e[0m)\n";
497 print STDERR "\e[33;1mWARNING:\e[0m module \e[32;1m$extra\e[0m might be missing dependency \e[32;1m$dep\e[0m - YOU are responsible for satisfying it!\n";
501 print "Enabling $extra ... \n";
502 symlink "extra/$extra", $source or print STDERR "$source: Cannot link to 'extra/$extra': $!\n";
506 sub disable_extras (@)
508 opendir my $dd, "src/modules/extra/";
509 my @files = readdir($dd);
512 EXTRA: for my $extra (@extras) {
513 my $extrapath = "src/modules/extra/$extra";
514 my $source = "src/modules/$extra";
515 if (!-e $extrapath) {
516 print STDERR "Cannot disable \e[32;1m$extra\e[0m : Is not an extra\n";
519 if ((! -l $source) || readlink($source) ne "extra/$extra") {
520 print STDERR "Cannot disable \e[32;1m$extra\e[0m : Source is not a link or doesn't refer to the right file. Remove manually if this is in error.\n";
523 # Check if anything needs this.
524 for my $file (@files) {
525 my @deps = split /\s+/, get_directive("src/modules/extra/$file", 'ModDep', '');
526 # File depends on this extra...
527 if (scalar(grep { $_ eq $extra } @deps) > 0) {
528 # And is both enabled and not about to be disabled.
529 if (-e "src/modules/$file" && scalar(grep { $_ eq $file } @extras) < 1) {
530 print STDERR "Cannot disable \e[32;1m$extra\e[0m : is needed by \e[32;1m$file\e[0m\n";
536 print "Disabling $extra ... \n";
537 unlink "src/modules/$extra" or print STDERR "Cannot disable \e[32;1m$extra\e[0m : $!\n";