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_CLOCK_GETTIME} = run_test 'clock_gettime()', test_file($config{CXX}, 'clock_gettime.cpp', $^O eq 'darwin' ? undef : '-lrt');
163 $config{HAS_EVENTFD} = run_test 'eventfd()', test_file($config{CXX}, 'eventfd.cpp');
166 push @socketengines, 'epoll' if run_test 'epoll', test_header $config{CXX}, 'sys/epoll.h';
167 push @socketengines, 'kqueue' if run_test 'kqueue', test_file $config{CXX}, 'kqueue.cpp';
168 push @socketengines, 'ports' if run_test 'Solaris IOCP', test_header $config{CXX}, 'port.h';
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 `git checkout insp20` if you are installing from Git.
249 if (!prompt_bool $interactive, 'I understand this warning and want to continue anyway.', $opt_development // 0) {
250 say STDERR 'If you understand this warning and still want to continue pass the --development flag.' unless $interactive;
255 # Configure directory settings.
256 my $question = <<"EOQ";
257 Currently, InspIRCd is configured with the following paths:
259 <|BOLD Base:|> $config{BASE_DIR}
260 <|BOLD Binary:|> $config{BINARY_DIR}
261 <|BOLD Config:|> $config{CONFIG_DIR}
262 <|BOLD Data:|> $config{DATA_DIR}
263 <|BOLD Log:|> $config{LOG_DIR}
264 <|BOLD Manual:|> $config{MANUAL_DIR}
265 <|BOLD Module:|> $config{MODULE_DIR}
267 Do you want to change these settings?
269 if (prompt_bool $interactive, $question, 0) {
270 my $original_base_dir = $config{BASE_DIR};
271 $config{BASE_DIR} = prompt_dir $interactive, 'In what directory do you wish to install the InspIRCd base?', $config{BASE_DIR};
272 foreach my $key (qw(BINARY_DIR CONFIG_DIR DATA_DIR LOG_DIR MANUAL_DIR MODULE_DIR)) {
273 $config{$key} =~ s/^\Q$original_base_dir\E/$config{BASE_DIR}/;
275 $config{BINARY_DIR} = prompt_dir $interactive, 'In what directory should the InspIRCd binary be placed?', $config{BINARY_DIR};
276 $config{CONFIG_DIR} = prompt_dir $interactive, 'In what directory are configuration files to be stored?', $config{CONFIG_DIR};
277 $config{DATA_DIR} = prompt_dir $interactive, 'In what directory are variable data files to be stored?', $config{DATA_DIR};
278 $config{LOG_DIR} = prompt_dir $interactive, 'In what directory are log files to be stored?', $config{LOG_DIR};
279 $config{MANUAL_DIR} = prompt_dir $interactive, 'In what directory are manual pages to be placed?', $config{MANUAL_DIR};
280 $config{MODULE_DIR} = prompt_dir $interactive, 'In what directory are modules to be placed?', $config{MODULE_DIR};
283 # Configure module settings.
285 Currently, InspIRCd is configured to automatically enable all available extra modules.
287 Would you like to enable extra modules manually?
289 if (prompt_bool $interactive, $question, 0) {
290 foreach my $extra (<src/modules/extra/m_*.cpp>) {
291 my $module_name = basename $extra, '.cpp';
292 if (prompt_bool $interactive, "Would you like to enable $module_name?", 0) {
293 enable_extras "$module_name.cpp";
297 # TODO: finish modulemanager rewrite and replace this code with:
298 # system './modulemanager', 'enable', '--auto';
299 enable_extras 'm_ssl_gnutls.cpp' unless system 'pkg-config --exists gnutls >/dev/null 2>&1';
300 enable_extras 'm_ssl_mbedtls.cpp' if -e '/usr/include/mbedtls/ssl.h';
301 enable_extras 'm_ssl_openssl.cpp' unless system 'pkg-config --exists openssl >/dev/null 2>&1';
304 # Generate SSL certificates.
305 if (<src/modules/m_ssl_*.cpp> && prompt_bool $interactive, 'Would you like to generate SSL certificates now?', $interactive) {
306 system './tools/genssl', 'auto';
309 # Cache the distribution label so that its not lost when --update is run.
310 $config{DISTRIBUTION} = $opt_distribution_label if $opt_distribution_label;
312 write_configure_cache %config;
313 parse_templates \%config, \%compiler, \%version;
315 print_format <<"EOM";
317 Configuration is complete! You have chosen to build with the following settings:
320 <|GREEN Binary:|> $config{CXX}
321 <|GREEN Name:|> $compiler{NAME}
322 <|GREEN Version:|> $compiler{VERSION}
324 <|GREEN Extra Modules:|>
327 for my $file (<src/modules/m_*>) {
328 my $module = basename $file, '.cpp';
329 say " * $module" if -l $file;
332 print_format <<"EOM";
335 <|GREEN Base:|> $config{BASE_DIR}
336 <|GREEN Binary:|> $config{BINARY_DIR}
337 <|GREEN Config:|> $config{CONFIG_DIR}
338 <|GREEN Data:|> $config{DATA_DIR}
339 <|GREEN Log:|> $config{LOG_DIR}
340 <|GREEN Manual:|> $config{MANUAL_DIR}
341 <|GREEN Module:|> $config{MODULE_DIR}
342 <|GREEN Script:|> $config{SCRIPT_DIR}
344 <|GREEN Execution Group:|> $config{GROUP} ($config{GID})
345 <|GREEN Execution User:|> $config{USER} ($config{UID})
346 <|GREEN Socket Engine:|> $config{SOCKETENGINE}
348 To build with these settings run '<|GREEN make -j${\get_cpu_count}|>' now.
352 # Routine to list out the extra/ modules that have been enabled.
353 # Note: when getting any filenames out and comparing, it's important to lc it if the
354 # file system is not case-sensitive (== Epoc, MacOS, OS/2 (incl DOS/DJGPP), VMS, Win32
355 # (incl NetWare, Symbian)). Cygwin may or may not be case-sensitive, depending on
356 # configuration, however, File::Spec does not currently tell us (it assumes Unix behavior).
360 my $srcdir = File::Spec->catdir("src", "modules");
361 my $abs_srcdir = File::Spec->rel2abs($srcdir);
364 opendir $dd, File::Spec->catdir($abs_srcdir, "extra") or die (File::Spec->catdir($abs_srcdir, "extra") . ": $!\n");
365 my @extras = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
368 opendir $dd, $abs_srcdir or die "$abs_srcdir: $!\n";
369 my @sources = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
372 my $maxlen = (sort { $b <=> $a } (map {length($_)} (@extras)))[0];
374 EXTRA: for my $extra (@extras) {
375 next if (File::Spec->curdir() eq $extra || File::Spec->updir() eq $extra);
376 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
377 my $abs_source = File::Spec->catfile($abs_srcdir, $extra);
378 next unless ($extra =~ m/\.(cpp|h)$/ || (-d $abs_extra)); # C++ Source/Header, or directory
379 if (-l $abs_source) {
380 # Symlink, is it in the right place?
381 my $targ = readlink($abs_source);
382 my $abs_targ = File::Spec->rel2abs($targ, $abs_srcdir);
383 if ($abs_targ eq $abs_extra) {
384 $extras{$extra} = "\e[32;1menabled\e[0m";
386 $extras{$extra} = sprintf("\e[31;1mwrong symlink target (%s)\e[0m", $abs_targ);
388 } elsif (-e $abs_source) {
389 my ($devext, $inoext) = stat($abs_extra);
390 my ($devsrc, $inosrc, undef, $lnksrc) = stat($abs_source);
392 if ($devsrc == $devext && $inosrc == $inoext) {
393 $extras{$extra} = "\e[32;1menabled\e[0m";
395 $extras{$extra} = sprintf("\e[31;1mwrong hardlink target (%d:%d)\e[0m", $devsrc, $inosrc);
398 open my $extfd, "<", $abs_extra;
399 open my $srcfd, "<", $abs_source;
401 if (scalar(<$extfd>) eq scalar(<$srcfd>)) {
402 $extras{$extra} = "\e[32;1menabled\e[0m";
404 $extras{$extra} = sprintf("\e[31;1mout of synch (re-copy)\e[0m");
408 $extras{$extra} = "\e[33;1mdisabled\e[0m";
411 # Now let's add dependency info
412 for my $extra (keys(%extras)) {
413 next unless $extras{$extra} =~ m/enabled/; # only process enabled extras.
414 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
415 my @deps = split /\s+/, get_directive($abs_extra, 'ModDep', '');
416 for my $dep (@deps) {
417 if (exists($extras{$dep})) {
418 my $ref = \$extras{$dep}; # Take reference.
419 if ($$ref !~ m/needed by/) {
420 # First dependency found.
421 if ($$ref =~ m/enabled/) {
422 $$ref .= " (needed by \e[32;1m$extra\e[0m";
424 $$ref =~ s/\e\[.*?m//g; # Strip out previous coloring. Will be set in bold+red+blink later.
425 $$ref .= " (needed by \e[0;32;1;5m$extra\e[0;31;1;5m";
428 if ($$ref =~ m/enabled/) {
429 $$ref .= ", \e[32;1m$extra\e[0m";
431 $$ref .= ", \e[0;32;1;5m$extra\e[0;31;1;5m";
437 for my $extra (sort {$a cmp $b} keys(%extras)) {
438 my $text = $extras{$extra};
439 if ($text =~ m/needed by/ && $text !~ m/enabled/) {
440 printf "\e[31;1;5m%-*s = %s%s\e[0m\n", $maxlen, $extra, $text, ($text =~ m/needed by/ ? ")" : "");
442 printf "%-*s = %s%s\n", $maxlen, $extra, $text, ($text =~ m/needed by/ ? "\e[0m)" : "");
445 return keys(%extras) if wantarray; # Can be used by manage_extras.
448 sub enable_extras (@) {
450 for my $extra (@extras) {
451 my $extrapath = "src/modules/extra/$extra";
452 if (!-e $extrapath) {
453 print STDERR "Cannot enable \e[32;1m$extra\e[0m : No such file or directory in src/modules/extra\n";
456 my $source = "src/modules/$extra";
458 print STDERR "Cannot enable \e[32;1m$extra\e[0m : destination in src/modules exists (might already be enabled?)\n";
461 # Get dependencies, and add them to be processed.
462 my @deps = split /\s+/, get_directive($extrapath, 'ModDep', '');
463 for my $dep (@deps) {
464 next if scalar(grep { $_ eq $dep } (@extras)) > 0; # Skip if we're going to be enabling it anyway.
465 if (!-e "src/modules/$dep" && !-e "include/$dep") {
466 if (-e "src/modules/extra/$dep") {
467 print STDERR "Will also enable extra \e[32;1m$dep\e[0m (needed by \e[32;1m$extra\e[0m)\n";
470 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";
474 print "Enabling $extra ... \n";
475 symlink "extra/$extra", $source or print STDERR "$source: Cannot link to 'extra/$extra': $!\n";
479 sub disable_extras (@)
481 opendir my $dd, "src/modules/extra/";
482 my @files = readdir($dd);
485 EXTRA: for my $extra (@extras) {
486 my $extrapath = "src/modules/extra/$extra";
487 my $source = "src/modules/$extra";
488 if (!-e $extrapath) {
489 print STDERR "Cannot disable \e[32;1m$extra\e[0m : Is not an extra\n";
492 if ((! -l $source) || readlink($source) ne "extra/$extra") {
493 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";
496 # Check if anything needs this.
497 for my $file (@files) {
498 my @deps = split /\s+/, get_directive("src/modules/extra/$file", 'ModDep', '');
499 # File depends on this extra...
500 if (scalar(grep { $_ eq $extra } @deps) > 0) {
501 # And is both enabled and not about to be disabled.
502 if (-e "src/modules/$file" && scalar(grep { $_ eq $file } @extras) < 1) {
503 print STDERR "Cannot disable \e[32;1m$extra\e[0m : is needed by \e[32;1m$file\e[0m\n";
509 print "Disabling $extra ... \n";
510 unlink "src/modules/$extra" or print STDERR "Cannot disable \e[32;1m$extra\e[0m : $!\n";