]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - configure
Allow customising the example config directory at build time.
[user/henk/code/inspircd.git] / configure
index ef6846e50ad6545e60225e7542d1fc1b79142657..6d729292fd5bf7d29bb72a91eaff42bb6931040b 100755 (executable)
--- a/configure
+++ b/configure
@@ -3,6 +3,7 @@
 #
 # InspIRCd -- Internet Relay Chat Daemon
 #
+#   Copyright (C) 2012-2017 Peter Powell <petpow@saberuk.com>
 #   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
 #   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
 #   Copyright (C) 2003, 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
@@ -37,24 +38,30 @@ use warnings FATAL => qw(all);
 use File::Basename        qw(basename);
 use File::Copy            ();
 use File::Spec::Functions qw(rel2abs);
+use FindBin               qw($RealDir);
 use Getopt::Long          qw(GetOptions);
 use POSIX                 qw(getgid getuid);
 
+use lib $RealDir;
 use make::common;
 use make::configure;
 use make::console;
+use make::directive;
 
 my ($opt_binary_dir,
     $opt_config_dir,
     $opt_data_dir,
     $opt_development,
+    $opt_disable_auto_extras,
     $opt_disable_interactive,
     $opt_distribution_label,
+    $opt_example_dir,
     $opt_gid,
     $opt_log_dir,
     $opt_manual_dir,
     $opt_module_dir,
     $opt_prefix,
+    $opt_script_dir,
     $opt_socketengine,
     $opt_system,
     $opt_uid);
@@ -68,22 +75,25 @@ sub disable_extras (@);
 my @opt_enableextras;
 my @opt_disableextras;
 
-GetOptions(
+exit 1 unless GetOptions(
        'clean'  => \&cmd_clean,
        'help'   => \&cmd_help,
        'update' => \&cmd_update,
 
-       'development'          => \$opt_development,
-       'disable-interactive'  => \$opt_disable_interactive,
-       'distribution-label=s' => \$opt_distribution_label,
        'binary-dir=s'         => \$opt_binary_dir,
        'config-dir=s'         => \$opt_config_dir,
        'data-dir=s'           => \$opt_data_dir,
+       'development'          => \$opt_development,
+       'disable-auto-extras'  => \$opt_disable_auto_extras,
+       'disable-interactive'  => \$opt_disable_interactive,
+       'distribution-label=s' => \$opt_distribution_label,
+       'example-dir=s'        => \$opt_example_dir,
        'gid=s'                => \$opt_gid,
        'log-dir=s'            => \$opt_log_dir,
        'manual-dir=s'         => \$opt_manual_dir,
        'module-dir=s'         => \$opt_module_dir,
        'prefix=s'             => \$opt_prefix,
+       'script-dir=s'         => \$opt_script_dir,
        'socketengine=s'       => \$opt_socketengine,
        'system'               => \$opt_system,
        'uid=s'                => \$opt_uid,
@@ -111,24 +121,27 @@ our $interactive = !(
        defined $opt_config_dir ||
        defined $opt_data_dir ||
        defined $opt_development ||
+       defined $opt_disable_auto_extras ||
        defined $opt_disable_interactive ||
        defined $opt_distribution_label ||
+       defined $opt_example_dir ||
        defined $opt_gid ||
        defined $opt_log_dir ||
        defined $opt_manual_dir ||
        defined $opt_module_dir ||
        defined $opt_prefix ||
+       defined $opt_script_dir ||
        defined $opt_socketengine ||
        defined $opt_system ||
        defined $opt_uid
 );
 
-my %version = get_version();
-print_format "<|BOLD Configuring InspIRCd $version{MAJOR}.$version{MINOR}.$version{PATCH}+$version{LABEL} on $^O.|>\n";
+my %version = get_version $opt_distribution_label;
+print_format "<|BOLD Configuring InspIRCd $version{FULL} on $^O.|>\n";
 
-our %config;
+my %config;
 if ($interactive) {
-       %config = read_configure_cache();
+       %config = read_config_file(CONFIGURE_CACHE_FILE);
        run_test CONFIGURE_CACHE_FILE, %config;
        if (!defined $config{VERSION}) {
                $config{VERSION} = CONFIGURE_CACHE_VERSION;
@@ -140,73 +153,58 @@ if ($interactive) {
 
 $config{CXX} = find_compiler($config{CXX} // $ENV{CXX});
 unless ($config{CXX}) {
-       print "A suitable C++ compiler could not be detected on your system!\n";
-       print "Set the CXX environment variable to the compiler binary path if this is incorrect.\n";
-       exit 1; 
+       say 'A suitable C++ compiler could not be detected on your system!';
+       unless ($interactive) {
+               say 'Set the CXX environment variable to the path to a C++ compiler binary if this is incorrect.';
+               exit 1;
+       }
+       until ($config{CXX}) {
+               my $compiler_path = prompt_string 1, 'Please enter the path to a C++ compiler binary:', 'c++';
+               $config{CXX} = find_compiler $compiler_path;
+       }
 }
 my %compiler = get_compiler_info($config{CXX});
 
-$config{HAS_CLOCK_GETTIME} = run_test 'clock_gettime()', test_file($config{CXX}, 'clock_gettime.cpp', '-lrt');
+$config{HAS_ARC4RANDOM_BUF} = run_test 'arc4random_buf()', test_file($config{CXX}, 'arc4random_buf.cpp');
+$config{HAS_CLOCK_GETTIME} = run_test 'clock_gettime()', test_file($config{CXX}, 'clock_gettime.cpp', $^O eq 'darwin' ? undef : '-lrt');
 $config{HAS_EVENTFD} = run_test 'eventfd()', test_file($config{CXX}, 'eventfd.cpp');
 
-if ($config{HAS_EPOLL} = run_test 'epoll', test_header($config{CXX}, 'sys/epoll.h')) {
-       $config{SOCKETENGINE} //= 'epoll';
-}
-
-if ($config{HAS_KQUEUE} = run_test 'kqueue', test_file($config{CXX}, 'kqueue.cpp')) {
-       $config{SOCKETENGINE} //= 'kqueue';
-}
-
-if ($config{HAS_PORTS} = run_test 'Solaris IOCP', test_header($config{CXX}, 'port.h')) {
-       $config{SOCKETENGINE} //= 'ports';
-}
-
-if ($config{HAS_POLL} = run_test 'poll', test_header($config{CXX}, 'poll.h')) {
-       $config{SOCKETENGINE} //= 'poll';
-}
-
-# Select is available on all platforms
-$config{HAS_SELECT} = 1;
-$config{SOCKETENGINE} //= 'select';
+my @socketengines;
+push @socketengines, 'epoll'  if run_test 'epoll', test_header $config{CXX}, 'sys/epoll.h';
+push @socketengines, 'kqueue' if run_test 'kqueue', test_file $config{CXX}, 'kqueue.cpp';
+push @socketengines, 'poll'   if run_test 'poll', test_header $config{CXX}, 'poll.h';
+push @socketengines, 'select';
 
 if (defined $opt_socketengine) {
-       my $cfgkey = 'HAS_' . uc $opt_socketengine;
-       if ($config{$cfgkey} && -f "src/socketengines/socketengine_$opt_socketengine.cpp") {
-               $config{SOCKETENGINE} = $opt_socketengine;
-       } else {
-               print "Unable to use a socket engine which is not supported on this platform ($opt_socketengine)!\n";
-               print "Available socket engines are:";
-               foreach (<src/socketengines/socketengine_*.cpp>) {
-                       s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
-                       print " $1" if $config{'HAS_' . uc $1};
-               }
-               print "\n";     
-               exit 1;
+       unless (grep { $_ eq $opt_socketengine } @socketengines) {
+               my $reason = -f "src/socketengines/socketengine_$opt_socketengine.cpp" ? 'is not available on this platform' : 'does not exist';
+               print_error "The socket engine you requested ($opt_socketengine) $reason!",
+                       'Available socket engines are:',
+                       map { "  * $_" } @socketengines;
        }
 }
-
-# If the user has specified a distribution label then we use it in
-# place of the label from src/version.sh or Git.
-if (defined $opt_distribution_label) {
-       $version{LABEL} = $opt_distribution_label;
-}
+$config{SOCKETENGINE} = $opt_socketengine // $socketengines[0];
 
 if (defined $opt_system) {
-       $config{BASE_DIR}   = $opt_prefix     // '/var/lib/inspircd';
-       $config{BINARY_DIR} = $opt_binary_dir // '/usr/sbin';
-       $config{CONFIG_DIR} = $opt_config_dir // '/etc/inspircd';
-       $config{DATA_DIR}   = $opt_data_dir   // '/var/inspircd';
-       $config{LOG_DIR}    = $opt_module_dir // '/var/log/inspircd';
-       $config{MANUAL_DIR} = $opt_manual_dir // '/usr/share/man/man1';
-       $config{MODULE_DIR} = $opt_module_dir // '/usr/lib/inspircd';
+       $config{BASE_DIR}    = $opt_prefix      // '/var/lib/inspircd';
+       $config{BINARY_DIR}  = $opt_binary_dir  // '/usr/sbin';
+       $config{CONFIG_DIR}  = $opt_config_dir  // '/etc/inspircd';
+       $config{DATA_DIR}    = $opt_data_dir    // '/var/inspircd';
+       $config{EXAMPLE_DIR} = $opt_example_dir // '/usr/share/doc/inspircd';
+       $config{LOG_DIR}     = $opt_log_dir     // '/var/log/inspircd';
+       $config{MANUAL_DIR}  = $opt_manual_dir  // '/usr/share/man/man1';
+       $config{MODULE_DIR}  = $opt_module_dir  // '/usr/lib/inspircd';
+       $config{SCRIPT_DIR}  = $opt_script_dir  // '/usr/share/inspircd'
 } else {
-       $config{BASE_DIR}   = $opt_prefix     // $config{BASE_DIR}   // rel2abs 'run';
-       $config{BINARY_DIR} = $opt_binary_dir // $config{BINARY_DIR} // rel2abs $config{BASE_DIR} . '/bin';
-       $config{CONFIG_DIR} = $opt_config_dir // $config{CONFIG_DIR} // rel2abs $config{BASE_DIR} . '/conf';
-       $config{DATA_DIR}   = $opt_data_dir   // $config{DATA_DIR}   // rel2abs $config{BASE_DIR} . '/data';
-       $config{LOG_DIR}    = $opt_log_dir    // $config{LOG_DIR}    // rel2abs $config{BASE_DIR} . '/logs';
-       $config{MANUAL_DIR} = $opt_manual_dir // $config{MANUAL_DIR} // rel2abs $config{BASE_DIR} . '/manuals';
-       $config{MODULE_DIR} = $opt_module_dir // $config{MODULE_DIR} // rel2abs $config{BASE_DIR} . '/modules';
+       $config{BASE_DIR}    = $opt_prefix      // $config{BASE_DIR}    // rel2abs 'run';
+       $config{BINARY_DIR}  = $opt_binary_dir  // $config{BINARY_DIR}  // rel2abs $config{BASE_DIR} . '/bin';
+       $config{CONFIG_DIR}  = $opt_config_dir  // $config{CONFIG_DIR}  // rel2abs $config{BASE_DIR} . '/conf';
+       $config{DATA_DIR}    = $opt_data_dir    // $config{DATA_DIR}    // rel2abs $config{BASE_DIR} . '/data';
+       $config{EXAMPLE_DIR} = $opt_example_dir // $config{EXAMPLE_DIR} // $config{CONFIG_DIR} . '/examples';
+       $config{LOG_DIR}     = $opt_log_dir     // $config{LOG_DIR}     // rel2abs $config{BASE_DIR} . '/logs';
+       $config{MANUAL_DIR}  = $opt_manual_dir  // $config{MANUAL_DIR}  // rel2abs $config{BASE_DIR} . '/manuals';
+       $config{MODULE_DIR}  = $opt_module_dir  // $config{MODULE_DIR}  // rel2abs $config{BASE_DIR} . '/modules';
+       $config{SCRIPT_DIR}  = $opt_script_dir  // $config{SCRIPT_DIR}  // $config{BASE_DIR};
 }
 
 # Parse --gid=123 or --gid=foo and extract the group id.
@@ -217,6 +215,20 @@ if (defined $opt_gid) {
 } else {
        @group = $opt_system ? getgrnam('irc') : getgrgid($config{GID} // getgid());
        print_error "you need to specify a group to run as using '--gid [id|name]'!" unless @group;
+       unless ($group[2]) {
+               print_warning <<"EOW";
+You are building as the privileged $group[0] group and have not specified
+an unprivileged group to run InspIRCd as.
+
+This is almost never what you should do. You should probably either create a new
+unprivileged user/group to build and run as or pass the '--gid [id|name]' flag
+to specify an unprivileged group to run as.
+EOW
+               if (!prompt_bool $interactive, "Are you sure you want to build as the $group[0] group?", 0) {
+                       say STDERR "If you are sure you want to build as the $group[0] group pass the --gid $group[2] flag." unless $interactive;
+                       exit 1;
+               }
+       }
 }
 $config{GROUP} = $group[0];
 $config{GID}   = $group[2];
@@ -229,23 +241,53 @@ if (defined $opt_uid) {
 } else {
        @user = $opt_system ? getpwnam('irc') : getpwuid($config{UID} // getuid());
        print_error "you need to specify a user to run as using '--uid [id|name]'!" unless @user;
+       unless ($user[2]) {
+               print_warning <<"EOW";
+You are building as the privileged $user[0] user and have not specified
+an unprivileged user to run InspIRCd as.
+
+This is almost never what you should do. You should probably either create a new
+unprivileged user/group to build and run as or pass the '--uid [id|name]' flag
+to specify an unprivileged user to run as.
+EOW
+               if (!prompt_bool $interactive, "Are you sure you want to build as the $user[0] user?", 0) {
+                       say STDERR "If you are sure you want to build as the $user[0] user pass the --uid $user[2] flag." unless $interactive;
+                       exit 1;
+               }
+       }
 }
 $config{USER} = $user[0];
 $config{UID}  = $user[2];
 
-# Clear the screen.
-system 'tput', 'clear' if $interactive;
+# Warn the user about clock drifting when running on OpenVZ.
+if (-e '/proc/user_beancounters' || -e '/proc/vz/vzaquota') {
+       print_warning <<'EOW';
+You are building InspIRCd inside of an OpenVZ container. If you
+plan to use InspIRCd in this container then you should make sure that NTP is
+configured on the Hardware Node. Failure to do so may result in clock drifting!
+EOW
+}
+
+# Warn the user about OpenBSD shipping incredibly broken compilers/linkers.
+if ($^O eq 'openbsd') {
+       print_warning <<'EOW';
+You are building InspIRCd on OpenBSD. The C++ compilers and linkers
+that OpenBSD ship are incredibly broken. You may have strange linker errors
+and crashes. Please consider using a different OS like FreeBSD/NetBSD instead.
+EOW
+}
 
 # Check that the user actually wants this version.
-if ($version{LABEL} ne 'release') {
+if (defined $version{REAL_LABEL}) {
        print_warning <<'EOW';
 You are building a development version. This contains code which has
 not been tested as heavily and may contain various faults which could seriously
 affect the running of your server. It is recommended that you use a stable
 version instead.
 
-You can obtain the latest stable version from http://www.inspircd.org/ or by
-running `git checkout insp20` if you are installing from Git.
+You can obtain the latest stable version from https://www.inspircd.org or by
+running `<|GREEN git checkout $(git describe --abbrev=0 --tags insp3)|>` if you are
+installing from Git.
 EOW
        if (!prompt_bool $interactive, 'I understand this warning and want to continue anyway.', $opt_development // 0) {
                say STDERR 'If you understand this warning and still want to continue pass the --development flag.' unless $interactive;
@@ -264,13 +306,14 @@ Currently, InspIRCd is configured with the following paths:
 <|BOLD Log:|>    $config{LOG_DIR}
 <|BOLD Manual:|> $config{MANUAL_DIR}
 <|BOLD Module:|> $config{MODULE_DIR}
+<|BOLD Script:|> $config{SCRIPT_DIR}
 
 Do you want to change these settings?
 EOQ
 if (prompt_bool $interactive, $question, 0) {
        my $original_base_dir = $config{BASE_DIR};
        $config{BASE_DIR} = prompt_dir $interactive, 'In what directory do you wish to install the InspIRCd base?', $config{BASE_DIR};
-       foreach my $key (qw(BINARY_DIR CONFIG_DIR DATA_DIR LOG_DIR MANUAL_DIR MODULE_DIR)) {
+       foreach my $key (qw(BINARY_DIR CONFIG_DIR DATA_DIR LOG_DIR MANUAL_DIR MODULE_DIR SCRIPT_DIR)) {
                $config{$key} =~ s/^\Q$original_base_dir\E/$config{BASE_DIR}/;
        }
        $config{BINARY_DIR} = prompt_dir $interactive, 'In what directory should the InspIRCd binary be placed?', $config{BINARY_DIR};
@@ -279,6 +322,7 @@ if (prompt_bool $interactive, $question, 0) {
        $config{LOG_DIR}    = prompt_dir $interactive, 'In what directory are log files to be stored?',           $config{LOG_DIR};
        $config{MANUAL_DIR} = prompt_dir $interactive, 'In what directory are manual pages to be placed?',        $config{MANUAL_DIR};
        $config{MODULE_DIR} = prompt_dir $interactive, 'In what directory are modules to be placed?',             $config{MODULE_DIR};
+       $config{SCRIPT_DIR} = prompt_dir $interactive, 'In what directory are scripts to be placed?',             $config{SCRIPT_DIR};
 }
 
 # Configure module settings.
@@ -294,18 +338,60 @@ if (prompt_bool $interactive, $question, 0) {
                        enable_extras "$module_name.cpp";
                }
        }
-} else {
+} elsif (!defined $opt_disable_auto_extras) {
        # TODO: finish modulemanager rewrite and replace this code with:
        # system './modulemanager', 'enable', '--auto';
-       enable_extras 'm_ssl_gnutls.cpp' unless system 'pkg-config --exists gnutls >/dev/null 2>&1';
-       enable_extras 'm_ssl_openssl.cpp' unless system 'pkg-config --exists openssl >/dev/null 2>&1';
+       my %modules = (
+               # Missing: m_ldap, m_regex_stdlib, m_ssl_mbedtls
+               'm_geo_maxmind.cpp'     => 'pkg-config --exists libmaxminddb',
+               'm_mysql.cpp'           => 'mysql_config --version',
+               'm_pgsql.cpp'           => 'pg_config --version',
+               'm_regex_pcre.cpp'      => 'pcre-config --version',
+               'm_regex_posix.cpp'     => undef,
+               'm_regex_re2.cpp'       => 'pkg-config --exists re2',
+               'm_regex_tre.cpp'       => 'pkg-config --exists tre',
+               'm_sqlite3.cpp'         => 'pkg-config --exists sqlite3',
+               'm_ssl_gnutls.cpp'      => 'pkg-config --exists gnutls',
+               'm_ssl_openssl.cpp'     => 'pkg-config --exists openssl',
+               'm_sslrehashsignal.cpp' => undef,
+       );
+       while (my ($module, $command) = each %modules) {
+               unless (defined $command && system "$command 1>/dev/null 2>/dev/null") {
+                       enable_extras $module;
+               }
+       }
 }
 
 # Generate SSL certificates.
-if (<src/modules/m_ssl_*.cpp> && prompt_bool $interactive, 'Would you like to generate SSL certificates now?', $interactive) {
-       system './tools/genssl', 'auto';
+$question = <<EOQ;
+Would you like to generate a self-signed SSL certificate now? This certificate
+can be used for testing but <|BOLD should not|> be used on a production network.
+
+Note: you can get a <|BOLD free|> CA-signed certificate from Let's Encrypt. See
+https://letsencrypt.org/getting-started/ for more details.
+EOQ
+
+if (<src/modules/m_ssl_*.cpp>) {
+       if (prompt_bool $interactive, $question, $interactive) {
+               system './tools/genssl', 'auto';
+       }
+} else {
+       print_warning <<"EOM";
+You are building without enabling any SSL modules. This is not
+recommended as SSL greatly enhances the security and privacy of your IRC server
+and in a future version will be <|BOLD required|> for linking servers.
+
+Please read the following documentation pages on how to enable SSL support:
+
+GnuTLS (recommended): https://docs.inspircd.org/3/modules/ssl_gnutls
+mbedTLS:              https://docs.inspircd.org/3/modules/ssl_mbedtls
+OpenSSL:              https://docs.inspircd.org/3/modules/ssl_openssl
+EOM
 }
 
+# Cache the distribution label so that its not lost when --update is run.
+$config{DISTRIBUTION} = $opt_distribution_label if $opt_distribution_label;
+
 write_configure_cache %config;
 parse_templates \%config, \%compiler, \%version;
 
@@ -329,19 +415,21 @@ for my $file (<src/modules/m_*>) {
 print_format <<"EOM";
 
 <|GREEN Paths:|>
-  <|GREEN Base:|>   $config{BASE_DIR}
-  <|GREEN Binary:|> $config{BINARY_DIR}
-  <|GREEN Config:|> $config{CONFIG_DIR}
-  <|GREEN Data:|>   $config{DATA_DIR}
-  <|GREEN Log:|>    $config{LOG_DIR}
-  <|GREEN Manual:|> $config{MANUAL_DIR}
-  <|GREEN Module:|> $config{MODULE_DIR}
+  <|GREEN Base:|>    $config{BASE_DIR}
+  <|GREEN Binary:|>  $config{BINARY_DIR}
+  <|GREEN Config:|>  $config{CONFIG_DIR}
+  <|GREEN Data:|>    $config{DATA_DIR}
+  <|GREEN Example:|> $config{EXAMPLE_DIR}
+  <|GREEN Log:|>     $config{LOG_DIR}
+  <|GREEN Manual:|>  $config{MANUAL_DIR}
+  <|GREEN Module:|>  $config{MODULE_DIR}
+  <|GREEN Script:|>  $config{SCRIPT_DIR}
 
 <|GREEN Execution Group:|> $config{GROUP} ($config{GID})
 <|GREEN Execution User:|>  $config{USER} ($config{UID})
 <|GREEN Socket Engine:|>   $config{SOCKETENGINE}
 
-To build with these settings run '<|GREEN make -j${\get_cpu_count}|>' now.
+To build with these settings run '<|GREEN make -j${\get_cpu_count} install|>' now.
 
 EOM
 
@@ -408,7 +496,7 @@ EXTRA:      for my $extra (@extras) {
        for my $extra (keys(%extras)) {
                next unless $extras{$extra} =~ m/enabled/; # only process enabled extras.
                my $abs_extra = File::Spec->catfile($abs_srcdir, "extra", $extra);
-               my @deps = split /\s+/, get_property($abs_extra, 'ModDep');
+               my @deps = split /\s+/, get_directive($abs_extra, 'ModDep', '');
                for my $dep (@deps) {
                        if (exists($extras{$dep})) {
                                my $ref = \$extras{$dep}; # Take reference.
@@ -455,7 +543,7 @@ sub enable_extras (@) {
                        next;
                }
                # Get dependencies, and add them to be processed.
-               my @deps = split /\s+/, get_property($extrapath, 'ModDep');
+               my @deps = split /\s+/, get_directive($extrapath, 'ModDep', '');
                for my $dep (@deps) {
                        next if scalar(grep { $_ eq $dep } (@extras)) > 0; # Skip if we're going to be enabling it anyway.
                        if (!-e "src/modules/$dep" && !-e "include/$dep") {
@@ -491,7 +579,7 @@ EXTRA:      for my $extra (@extras) {
                }
                # Check if anything needs this.
                for my $file (@files) {
-                       my @deps = split /\s+/, get_property("src/modules/extra/$file", 'ModDep');
+                       my @deps = split /\s+/, get_directive("src/modules/extra/$file", 'ModDep', '');
                        # File depends on this extra...
                        if (scalar(grep { $_ eq $extra } @deps) > 0) {
                                # And is both enabled and not about to be disabled.