3 # InspIRCd -- Internet Relay Chat Daemon
5 # Copyright (C) 2020 Nicole Kleinhoff <ilbelkyr@shalture.org>
6 # Copyright (C) 2020 Daniel Vassdal <shutter@canternet.org>
7 # Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
8 # Copyright (C) 2019 Anatole Denis <natolumin@rezel.net>
9 # Copyright (C) 2017 emerson <github@emersonveenstra.net>
10 # Copyright (C) 2013-2020 Sadie Powell <sadie@witchery.services>
11 # Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
12 # Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
13 # Copyright (C) 2010 Daniel De Graaf <danieldg@inspircd.org>
14 # Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
15 # Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
16 # Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
17 # Copyright (C) 2006-2008 Craig Edwards <brain@inspircd.org>
19 # This file is part of InspIRCd. InspIRCd is free software: you can
20 # redistribute it and/or modify it under the terms of the GNU General Public
21 # License as published by the Free Software Foundation, version 2.
23 # This program is distributed in the hope that it will be useful, but WITHOUT
24 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
25 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
28 # You should have received a copy of the GNU General Public License
29 # along with this program. If not, see <http://www.gnu.org/licenses/>.
39 use warnings FATAL => qw(all);
42 use File::Basename qw(basename);
44 use File::Spec::Functions qw(abs2rel catfile catdir rel2abs);
45 use FindBin qw($RealDir);
46 use Getopt::Long qw(GetOptions);
47 use POSIX qw(getgid getuid);
59 $opt_disable_auto_extras,
60 $opt_disable_interactive,
61 $opt_distribution_label,
77 sub enable_extras (@);
79 sub disable_extras (@);
82 my @opt_disableextras;
84 exit 1 unless GetOptions(
85 'clean' => \&cmd_clean,
87 'update' => \&cmd_update,
89 'binary-dir=s' => \$opt_binary_dir,
90 'config-dir=s' => \$opt_config_dir,
91 'data-dir=s' => \$opt_data_dir,
92 'development' => \$opt_development,
93 'disable-auto-extras' => \$opt_disable_auto_extras,
94 'disable-interactive' => \$opt_disable_interactive,
95 'distribution-label=s' => \$opt_distribution_label,
96 'example-dir=s' => \$opt_example_dir,
98 'log-dir=s' => \$opt_log_dir,
99 'manual-dir=s' => \$opt_manual_dir,
100 'module-dir=s' => \$opt_module_dir,
101 'portable' => \$opt_portable,
102 'prefix=s' => \$opt_prefix,
103 'runtime-dir=s' => \$opt_runtime_dir,
104 'script-dir=s' => \$opt_script_dir,
105 'socketengine=s' => \$opt_socketengine,
106 'system' => \$opt_system,
107 'uid=s' => \$opt_uid,
109 # TODO: when the modulemanager rewrite is done these should be removed.
110 'disable-extras=s@' => \@opt_disableextras,
111 'enable-extras=s@' => \@opt_enableextras,
112 'list-extras' => sub { list_extras; exit 0; },
115 if (scalar(@opt_enableextras) + scalar(@opt_disableextras) > 0) {
116 @opt_enableextras = grep { /\S/ } split /[, ]+/, join(',', @opt_enableextras);
117 @opt_disableextras = grep { /\S/ } split /[, ]+/, join(',', @opt_disableextras);
118 enable_extras(@opt_enableextras);
119 disable_extras(@opt_disableextras);
121 print "Remember: YOU are responsible for making sure any libraries needed have been installed!\n";
125 our $interactive = !(
128 defined $opt_binary_dir ||
129 defined $opt_config_dir ||
130 defined $opt_data_dir ||
131 defined $opt_development ||
132 defined $opt_disable_auto_extras ||
133 defined $opt_disable_interactive ||
134 defined $opt_distribution_label ||
135 defined $opt_example_dir ||
137 defined $opt_log_dir ||
138 defined $opt_manual_dir ||
139 defined $opt_module_dir ||
140 defined $opt_portable ||
141 defined $opt_prefix ||
142 defined $opt_runtime_dir ||
143 defined $opt_script_dir ||
144 defined $opt_socketengine ||
145 defined $opt_system ||
149 my %version = get_version $opt_distribution_label;
150 print_format "<|BOLD Configuring InspIRCd $version{FULL} on $^O.|>\n";
154 %config = read_config_file(CONFIGURE_CACHE_FILE);
155 run_test abs2rel(CONFIGURE_CACHE_FILE, $RealDir), %config;
156 if (!defined $config{VERSION}) {
157 $config{VERSION} = CONFIGURE_CACHE_VERSION;
158 } elsif ($config{VERSION} != CONFIGURE_CACHE_VERSION) {
159 print_warning "ignoring contents of ${\CONFIGURE_CACHE_FILE} as it was generated by an incompatible version of $0!";
160 %config = ('VERSION', CONFIGURE_CACHE_VERSION);
164 $config{CXX} = find_compiler($config{CXX} // $ENV{CXX});
165 unless ($config{CXX}) {
166 say 'A suitable C++ compiler could not be detected on your system!';
167 unless ($interactive) {
168 say 'Set the CXX environment variable to the path to a C++ compiler binary if this is incorrect.';
171 until ($config{CXX}) {
172 my $compiler_path = prompt_string 1, 'Please enter the path to a C++ compiler binary:', 'c++';
173 $config{CXX} = find_compiler $compiler_path;
176 my %compiler = get_compiler_info($config{CXX});
178 $config{HAS_ARC4RANDOM_BUF} = run_test 'arc4random_buf()', test_file($config{CXX}, 'arc4random_buf.cpp');
179 $config{HAS_CLOCK_GETTIME} = run_test 'clock_gettime()', test_file($config{CXX}, 'clock_gettime.cpp', $^O eq 'darwin' ? undef : '-lrt');
180 $config{HAS_EVENTFD} = run_test 'eventfd()', test_file($config{CXX}, 'eventfd.cpp');
183 push @socketengines, 'epoll' if run_test 'epoll', test_header $config{CXX}, 'sys/epoll.h';
184 push @socketengines, 'kqueue' if run_test 'kqueue', test_file $config{CXX}, 'kqueue.cpp';
185 push @socketengines, 'poll' if run_test 'poll', test_header $config{CXX}, 'poll.h';
186 push @socketengines, 'select';
188 if (defined $opt_socketengine) {
189 unless (grep { $_ eq $opt_socketengine } @socketengines) {
190 my $reason = -f "src/socketengines/socketengine_$opt_socketengine.cpp" ? 'is not available on this platform' : 'does not exist';
191 print_error "The socket engine you requested ($opt_socketengine) $reason!",
192 'Available socket engines are:',
193 map { " * $_" } @socketengines;
196 $config{SOCKETENGINE} = $opt_socketengine // $socketengines[0];
198 if (defined $opt_portable) {
199 print_error '--portable and --system can not be used together!' if defined $opt_system;
200 $config{DESTDIR} = catfile $RealDir, 'run', '';
201 $config{BASE_DIR} = $opt_prefix // '';
202 $config{BINARY_DIR} = $opt_binary_dir // 'bin';
203 $config{CONFIG_DIR} = $opt_config_dir // 'conf';
204 $config{DATA_DIR} = $opt_data_dir // 'data';
205 $config{EXAMPLE_DIR} = $opt_example_dir // catdir $config{CONFIG_DIR}, 'examples';
206 $config{LOG_DIR} = $opt_log_dir // 'logs';
207 $config{MANUAL_DIR} = $opt_manual_dir // 'manuals';
208 $config{MODULE_DIR} = $opt_module_dir // 'modules';
209 $config{RUNTIME_DIR} = $opt_runtime_dir // $config{DATA_DIR};
210 $config{SCRIPT_DIR} = $opt_script_dir // $config{BASE_DIR};
211 } elsif (defined $opt_system) {
212 $config{BASE_DIR} = $opt_prefix // '/var/lib/inspircd';
213 $config{BINARY_DIR} = $opt_binary_dir // '/usr/sbin';
214 $config{CONFIG_DIR} = $opt_config_dir // '/etc/inspircd';
215 $config{DATA_DIR} = $opt_data_dir // '/var/inspircd';
216 $config{EXAMPLE_DIR} = $opt_example_dir // '/usr/share/doc/inspircd';
217 $config{LOG_DIR} = $opt_log_dir // '/var/log/inspircd';
218 $config{MANUAL_DIR} = $opt_manual_dir // '/usr/share/man/man1';
219 $config{MODULE_DIR} = $opt_module_dir // '/usr/lib/inspircd';
220 $config{RUNTIME_DIR} = $opt_runtime_dir // '/var/run';
221 $config{SCRIPT_DIR} = $opt_script_dir // '/usr/share/inspircd';
223 $config{BASE_DIR} = rel2abs $opt_prefix // $config{BASE_DIR} // catdir $RealDir, 'run';
224 $config{BINARY_DIR} = $opt_binary_dir // $config{BINARY_DIR} // catdir $config{BASE_DIR}, 'bin';
225 $config{CONFIG_DIR} = $opt_config_dir // $config{CONFIG_DIR} // catdir $config{BASE_DIR}, 'conf';
226 $config{DATA_DIR} = $opt_data_dir // $config{DATA_DIR} // catdir $config{BASE_DIR}, 'data';
227 $config{EXAMPLE_DIR} = $opt_example_dir // $config{EXAMPLE_DIR} // catdir $config{CONFIG_DIR}, 'examples';
228 $config{LOG_DIR} = $opt_log_dir // $config{LOG_DIR} // catdir $config{BASE_DIR}, 'logs';
229 $config{MANUAL_DIR} = $opt_manual_dir // $config{MANUAL_DIR} // catdir $config{BASE_DIR}, 'manuals';
230 $config{MODULE_DIR} = $opt_module_dir // $config{MODULE_DIR} // catdir $config{BASE_DIR}, 'modules';
231 $config{RUNTIME_DIR} = $opt_runtime_dir // $config{RUNTIME_DIR} // $config{DATA_DIR};
232 $config{SCRIPT_DIR} = $opt_script_dir // $config{SCRIPT_DIR} // $config{BASE_DIR};
235 # Parse --gid=123 or --gid=foo and extract the group id.
237 if (defined $opt_gid) {
238 @group = $opt_gid =~ /^\d+$/ ? getgrgid($opt_gid) : getgrnam($opt_gid);
239 print_error "there is no '$opt_gid' group on this system!" unless @group;
241 @group = $opt_system ? getgrnam('irc') : getgrgid($config{GID} // getgid());
242 print_error "you need to specify a group to run as using '--gid [id|name]'!" unless @group;
244 print_warning <<"EOW";
245 You are building as the privileged $group[0] group and have not specified
246 an unprivileged group to run InspIRCd as.
248 This is almost never what you should do. You should probably either create a new
249 unprivileged user/group to build and run as or pass the '--gid [id|name]' flag
250 to specify an unprivileged group to run as.
252 if (!prompt_bool $interactive, "Are you sure you want to build as the $group[0] group?", 0) {
253 # PACKAGERS: You do not need to delete this check. Use `--gid $(id -g)` or `--gid 0` instead.
254 say STDERR "If you are sure you want to build as the $group[0] group pass the --gid $group[2] flag." unless $interactive;
259 $config{GROUP} = $group[0];
260 $config{GID} = $group[2];
262 # Parse --uid=123 or --uid=foo and extract the user id.
264 if (defined $opt_uid) {
265 @user = $opt_uid =~ /^\d+$/ ? getpwuid($opt_uid) : getpwnam($opt_uid);
266 print_error "there is no '$opt_uid' user on this system!" unless @user;
268 @user = $opt_system ? getpwnam('irc') : getpwuid($config{UID} // getuid());
269 print_error "you need to specify a user to run as using '--uid [id|name]'!" unless @user;
271 print_warning <<"EOW";
272 You are building as the privileged $user[0] user and have not specified
273 an unprivileged user to run InspIRCd as.
275 This is almost never what you should do. You should probably either create a new
276 unprivileged user/group to build and run as or pass the '--uid [id|name]' flag
277 to specify an unprivileged user to run as.
279 if (!prompt_bool $interactive, "Are you sure you want to build as the $user[0] user?", 0) {
280 # PACKAGERS: You do not need to delete this check. Use `--uid $(id -u)` or `--uid 0` instead.
281 say STDERR "If you are sure you want to build as the $user[0] user pass the --uid $user[2] flag." unless $interactive;
286 $config{USER} = $user[0];
287 $config{UID} = $user[2];
289 # Warn the user about clock drifting when running on OpenVZ.
290 if (-e '/proc/user_beancounters' || -e '/proc/vz/vzaquota') {
291 print_warning <<'EOW';
292 You are building InspIRCd inside of an OpenVZ container. If you
293 plan to use InspIRCd in this container then you should make sure that NTP is
294 configured on the Hardware Node. Failure to do so may result in clock drifting!
298 # Warn the user about OpenBSD shipping incredibly broken compilers/linkers.
299 if ($^O eq 'openbsd') {
300 print_warning <<'EOW';
301 You are building InspIRCd on OpenBSD. The C++ compilers and linkers
302 that OpenBSD ship are incredibly broken. You may have strange linker errors
303 and crashes. Please consider using a different OS like FreeBSD/NetBSD instead.
307 # Check that the user actually wants this version.
308 if (defined $version{REAL_LABEL}) {
309 print_warning <<'EOW';
310 You are building a development version. This contains code which has
311 not been tested as heavily and may contain various faults which could seriously
312 affect the running of your server. It is recommended that you use a stable
315 You can obtain the latest stable version from https://www.inspircd.org or by
316 running `<|GREEN git checkout $(git describe --abbrev=0 --tags insp3)|>` if you are
319 if (!prompt_bool $interactive, 'I understand this warning and want to continue anyway.', $opt_development // 0) {
320 say STDERR 'If you understand this warning and still want to continue pass the --development flag.' unless $interactive;
325 # Configure directory settings.
326 my $question = <<"EOQ";
327 Currently, InspIRCd is configured with the following paths:
329 <|BOLD Base:|> $config{BASE_DIR}
330 <|BOLD Binary:|> $config{BINARY_DIR}
331 <|BOLD Config:|> $config{CONFIG_DIR}
332 <|BOLD Data:|> $config{DATA_DIR}
333 <|BOLD Log:|> $config{LOG_DIR}
334 <|BOLD Manual:|> $config{MANUAL_DIR}
335 <|BOLD Module:|> $config{MODULE_DIR}
336 <|BOLD Script:|> $config{SCRIPT_DIR}
338 Do you want to change these settings?
340 if (prompt_bool $interactive, $question, 0) {
341 my $original_base_dir = $config{BASE_DIR};
342 $config{BASE_DIR} = prompt_dir $interactive, 'In what directory do you wish to install the InspIRCd base?', $config{BASE_DIR};
343 foreach my $key (qw(BINARY_DIR CONFIG_DIR DATA_DIR LOG_DIR MANUAL_DIR MODULE_DIR SCRIPT_DIR)) {
344 $config{$key} =~ s/^\Q$original_base_dir\E/$config{BASE_DIR}/;
346 $config{BINARY_DIR} = prompt_dir $interactive, 'In what directory should the InspIRCd binary be placed?', $config{BINARY_DIR};
347 $config{CONFIG_DIR} = prompt_dir $interactive, 'In what directory are configuration files to be stored?', $config{CONFIG_DIR};
348 $config{DATA_DIR} = prompt_dir $interactive, 'In what directory are variable data files to be stored?', $config{DATA_DIR};
349 $config{LOG_DIR} = prompt_dir $interactive, 'In what directory are log files to be stored?', $config{LOG_DIR};
350 $config{MANUAL_DIR} = prompt_dir $interactive, 'In what directory are manual pages to be placed?', $config{MANUAL_DIR};
351 $config{MODULE_DIR} = prompt_dir $interactive, 'In what directory are modules to be placed?', $config{MODULE_DIR};
352 $config{SCRIPT_DIR} = prompt_dir $interactive, 'In what directory are scripts to be placed?', $config{SCRIPT_DIR};
353 $config{EXAMPLE_DIR} = $config{CONFIG_DIR} . '/examples';
354 $config{RUNTIME_DIR} = $config{DATA_DIR};
357 # Configure module settings.
359 Currently, InspIRCd is configured to automatically enable all available extra modules.
361 Would you like to enable extra modules manually?
363 if (prompt_bool $interactive, $question, 0) {
364 foreach my $extra (<$RealDir/src/modules/extra/m_*.cpp>) {
365 my $module_name = module_shrink $extra;
366 if (prompt_bool $interactive, "Would you like to enable the <|BOLD $module_name|> module?", 0) {
367 enable_extras $module_name;
370 } elsif (!defined $opt_disable_auto_extras) {
371 # TODO: finish modulemanager rewrite and replace this code with:
372 # system './modulemanager', 'enable', '--auto';
374 # Missing: m_ldap, m_regex_stdlib, m_ssl_mbedtls
375 'm_argon2.cpp' => 'pkg-config --exists libargon2',
376 'm_geo_maxmind.cpp' => 'pkg-config --exists libmaxminddb',
377 'm_mysql.cpp' => 'mysql_config --version',
378 'm_pgsql.cpp' => 'pg_config --version',
379 'm_regex_pcre.cpp' => 'pcre-config --version',
380 'm_regex_posix.cpp' => undef,
381 'm_regex_re2.cpp' => 'pkg-config --exists re2',
382 'm_regex_tre.cpp' => 'pkg-config --exists tre',
383 'm_sqlite3.cpp' => 'pkg-config --exists sqlite3',
384 'm_ssl_gnutls.cpp' => 'pkg-config --exists gnutls',
385 'm_ssl_openssl.cpp' => 'pkg-config --exists openssl',
386 'm_sslrehashsignal.cpp' => undef,
388 while (my ($module, $command) = each %modules) {
389 unless (defined $command && system "$command 1>/dev/null 2>/dev/null") {
390 enable_extras $module;
395 # Generate SSL certificates.
397 Would you like to generate a self-signed SSL certificate now? This certificate
398 can be used for testing but <|BOLD should not|> be used on a production network.
400 Note: you can get a <|BOLD free|> CA-signed certificate from Let's Encrypt. See
401 https://letsencrypt.org/getting-started/ for more details.
404 if (<$RealDir/src/modules/m_ssl_*.cpp>) {
405 if (prompt_bool $interactive, $question, $interactive) {
406 create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
407 system './tools/genssl', 'auto', CONFIGURE_DIRECTORY;
409 my @pems = <${\CONFIGURE_DIRECTORY}/{cert,csr,dhparams,key}.pem>;
411 The following self-signed files were previously generated and will be installed
412 when you run Make. Do you want to delete them?
414 * ${\join "\n * ", @pems}
416 if (@pems && prompt_bool $interactive, $question, 0) {
420 } elsif (!defined $opt_disable_auto_extras) {
421 print_warning <<"EOM";
422 You are building without enabling any SSL modules. This is not
423 recommended as SSL greatly enhances the security and privacy of your IRC server
424 and in a future version will be <|BOLD required|> for linking servers.
426 Please read the following documentation pages on how to enable SSL support:
428 GnuTLS (recommended): https://docs.inspircd.org/3/modules/ssl_gnutls
429 mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls
430 OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl
434 # Cache the distribution label so that its not lost when --update is run.
435 $config{DISTRIBUTION} = $opt_distribution_label if $opt_distribution_label;
437 write_configure_cache %config;
438 parse_templates \%config, \%compiler, \%version;
440 print_format <<"EOM";
442 Configuration is complete! You have chosen to build with the following settings:
445 <|GREEN Binary:|> $config{CXX}
446 <|GREEN Name:|> $compiler{NAME}
447 <|GREEN Version:|> $compiler{VERSION}
449 <|GREEN Extra Modules:|>
452 for my $file (<$RealDir/src/modules/m_*>) {
453 say " * ${\module_shrink $file}" if -l $file;
457 push @makeargs, "-C${\abs2rel $RealDir}" unless getcwd eq $RealDir;
458 push @makeargs, "-j${\(get_cpu_count() + 1)}";
460 print_format <<"EOM";
463 <|GREEN Base:|> $config{BASE_DIR}
464 <|GREEN Binary:|> $config{BINARY_DIR}
465 <|GREEN Config:|> $config{CONFIG_DIR}
466 <|GREEN Data:|> $config{DATA_DIR}
467 <|GREEN Example:|> $config{EXAMPLE_DIR}
468 <|GREEN Log:|> $config{LOG_DIR}
469 <|GREEN Manual:|> $config{MANUAL_DIR}
470 <|GREEN Module:|> $config{MODULE_DIR}
471 <|GREEN Runtime:|> $config{RUNTIME_DIR}
472 <|GREEN Script:|> $config{SCRIPT_DIR}
474 <|GREEN Execution Group:|> $config{GROUP} ($config{GID})
475 <|GREEN Execution User:|> $config{USER} ($config{UID})
476 <|GREEN Socket Engine:|> $config{SOCKETENGINE}
478 To build with these settings run '<|GREEN make ${\join ' ', @makeargs} install|>' now.
482 # Routine to list out the extra/ modules that have been enabled.
483 # Note: when getting any filenames out and comparing, it's important to lc it if the
484 # file system is not case-sensitive (== Epoc, MacOS, OS/2 (incl DOS/DJGPP), VMS, Win32
485 # (incl NetWare, Symbian)). Cygwin may or may not be case-sensitive, depending on
486 # configuration, however, File::Spec does not currently tell us (it assumes Unix behavior).
490 my $srcdir = File::Spec->catdir("src", "modules");
491 my $abs_srcdir = File::Spec->rel2abs($srcdir);
494 opendir $dd, File::Spec->catdir($abs_srcdir, "extra") or die (File::Spec->catdir($abs_srcdir, "extra") . ": $!\n");
495 my @extras = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
498 opendir $dd, $abs_srcdir or die "$abs_srcdir: $!\n";
499 my @sources = map { File::Spec->case_tolerant() ? lc($_) : $_ } (readdir($dd));
502 my $maxlen = (sort { $b <=> $a } (map { length module_shrink $_ } (@extras)))[0];
504 EXTRA: for my $extra (@extras) {
505 next if (File::Spec->curdir() eq $extra || File::Spec->updir() eq $extra);
506 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
507 my $abs_source = File::Spec->catfile($abs_srcdir, $extra);
508 next unless ($extra =~ m/\.(cpp|h)$/ || (-d $abs_extra)); # C++ Source/Header, or directory
509 if (-l $abs_source) {
510 # Symlink, is it in the right place?
511 my $targ = readlink($abs_source);
512 my $abs_targ = File::Spec->rel2abs($targ, $abs_srcdir);
513 if ($abs_targ eq $abs_extra) {
514 $extras{$extra} = "\e[32;1menabled\e[0m";
516 $extras{$extra} = sprintf("\e[31;1mwrong symlink target (%s)\e[0m", $abs_targ);
518 } elsif (-e $abs_source) {
519 my ($devext, $inoext) = stat($abs_extra);
520 my ($devsrc, $inosrc, undef, $lnksrc) = stat($abs_source);
522 if ($devsrc == $devext && $inosrc == $inoext) {
523 $extras{$extra} = "\e[32;1menabled\e[0m";
525 $extras{$extra} = sprintf("\e[31;1mwrong hardlink target (%d:%d)\e[0m", $devsrc, $inosrc);
528 open my $extfd, "<", $abs_extra;
529 open my $srcfd, "<", $abs_source;
531 if (scalar(<$extfd>) eq scalar(<$srcfd>)) {
532 $extras{$extra} = "\e[32;1menabled\e[0m";
534 $extras{$extra} = sprintf("\e[31;1mout of synch (re-copy)\e[0m");
538 $extras{$extra} = "\e[33;1mdisabled\e[0m";
541 # Now let's add dependency info
542 for my $extra (keys(%extras)) {
543 next unless $extras{$extra} =~ m/enabled/; # only process enabled extras.
544 my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
545 my @deps = split /\s+/, get_directive($abs_extra, 'ModDep', '');
546 for my $dep (@deps) {
547 if (exists($extras{$dep})) {
548 my $ref = \$extras{$dep}; # Take reference.
549 if ($$ref !~ m/needed by/) {
550 # First dependency found.
551 if ($$ref =~ m/enabled/) {
552 $$ref .= " (needed by \e[32;1m$extra\e[0m";
554 $$ref =~ s/\e\[.*?m//g; # Strip out previous coloring. Will be set in bold+red+blink later.
555 $$ref .= " (needed by \e[0;32;1;5m$extra\e[0;31;1;5m";
558 if ($$ref =~ m/enabled/) {
559 $$ref .= ", \e[32;1m$extra\e[0m";
561 $$ref .= ", \e[0;32;1;5m$extra\e[0;31;1;5m";
567 for my $extra (sort {$a cmp $b} keys(%extras)) {
568 my $text = $extras{$extra};
569 if ($text =~ m/needed by/ && $text !~ m/enabled/) {
570 printf "\e[31;1;5m%-*s = %s%s\e[0m\n", $maxlen, module_shrink($extra), $text, ($text =~ m/needed by/ ? ")" : "");
572 printf "%-*s = %s%s\n", $maxlen, module_shrink($extra), $text, ($text =~ m/needed by/ ? "\e[0m)" : "");
575 return keys(%extras) if wantarray; # Can be used by manage_extras.
578 sub enable_extras(@) {
579 my $moduledir = catdir $RealDir, 'src', 'modules';
580 my $extradir = catdir $moduledir, 'extra';
583 my $shortname = module_shrink $extra;
584 my $extrafile = module_expand $extra;
586 my $extrapath = catfile $extradir, $extrafile;
587 if (!-f $extrapath) {
588 print_error "<|GREEN $extra|> is not an extra module!";
591 my $modulepath = catfile $moduledir, $extrafile;
592 if (-l $modulepath) {
593 if (readlink($modulepath) ne $extrapath) {
594 unlink $modulepath; # Remove the dead symlink.
596 next; # Module is already enabled.
600 if (-e $modulepath) {
601 print_error "unable to symlink <|GREEN ${\abs2rel $modulepath}|> to <|GREEN ${\abs2rel $extrapath}|>: the target exists and is not a symlink.";
603 print_format "Enabling the <|GREEN $shortname|> module ...\n";
604 symlink $extrapath, $modulepath or print_error "unable to symlink <|GREEN ${\abs2rel $modulepath}|> to <|GREEN ${\abs2rel $extrapath}|>: $!";
609 sub disable_extras(@) {
610 my $moduledir = catdir $RealDir, 'src', 'modules';
611 my $extradir = catdir $moduledir, 'extra';
614 my $shortname = module_shrink $extra;
615 my $extrafile = module_expand $extra;
617 my $modulepath = catfile $moduledir, $extrafile;
618 my $extrapath = catfile $extradir, $extrafile;
619 if (!-e $modulepath && !-e $extrapath) {
620 print_error "the <|GREEN $shortname|> module does not exist!";
621 } elsif (!-e $modulepath && -e $extrapath) {
622 print_error "the <|GREEN $shortname|> module is not currently enabled!";
623 } elsif ((-e $modulepath && !-e $extrapath) || !-l $modulepath) {
624 print_error "the <|GREEN $shortname|> module is not an extra module!";
626 print_format "Disabling the <|GREEN $shortname|> module ...\n";
627 unlink $modulepath or print_error "unable to unlink <|GREEN $extrapath|>: $!";