configure

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