]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - make/configure.pm
Add a new runtime directory and move the pid file to it.
[user/henk/code/inspircd.git] / make / configure.pm
index 4654fea21761ecb7502fdab1c008a6370892fced..001de5fc748f4014576e5426581e223be40ddf54 100644 (file)
@@ -1,10 +1,10 @@
 #
 # InspIRCd -- Internet Relay Chat Daemon
 #
-#   Copyright (C) 2012-2017 Sadie Powell <sadie@witchery.services>
-#   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
-#   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
-#   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+#   Copyright (C) 2020 Nicole Kleinhoff <ilbelkyr@shalture.org>
+#   Copyright (C) 2013-2020 Sadie Powell <sadie@witchery.services>
+#   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+#   Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
 #   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
 #
 # This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -31,10 +31,9 @@ use feature ':5.10';
 use strict;
 use warnings FATAL => qw(all);
 
-use Cwd                   qw(getcwd);
 use Exporter              qw(import);
 use File::Basename        qw(basename dirname);
-use File::Spec::Functions qw(catdir catfile);
+use File::Spec::Functions qw(abs2rel catdir catfile);
 
 use make::common;
 use make::console;
@@ -47,12 +46,15 @@ use constant CONFIGURE_ERROR_PIPE    => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/nu
 
 our @EXPORT = qw(CONFIGURE_CACHE_FILE
                  CONFIGURE_CACHE_VERSION
+                 CONFIGURE_DIRECTORY
                  cmd_clean
                  cmd_help
                  cmd_update
                  run_test
                  test_file
                  test_header
+                 module_expand
+                 module_shrink
                  write_configure_cache
                  get_compiler_info
                  find_compiler
@@ -60,7 +62,7 @@ our @EXPORT = qw(CONFIGURE_CACHE_FILE
 
 sub __get_socketengines {
        my @socketengines;
-       foreach (<src/socketengines/socketengine_*.cpp>) {
+       foreach (<${\CONFIGURE_ROOT}/src/socketengines/socketengine_*.cpp>) {
                s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
                push @socketengines, $1;
        }
@@ -107,7 +109,6 @@ sub cmd_clean {
 }
 
 sub cmd_help {
-       my $PWD = getcwd();
        my $SELIST = join ', ', __get_socketengines();
        print <<EOH;
 Usage: $0 [options]
@@ -122,29 +123,29 @@ PATH OPTIONS
                                 for system-wide installation.
   --prefix=[dir]                The root install directory. If this is set then
                                 all subdirectories will be adjusted accordingly.
-                                [$PWD/run]
+                                [${\CONFIGURE_ROOT}/run]
   --binary-dir=[dir]            The location where the main server binary is
                                 stored.
-                                [$PWD/run/bin]
+                                [${\CONFIGURE_ROOT}/run/bin]
   --config-dir=[dir]            The location where the configuration files and
                                 SSL certificates are stored.
-                                [$PWD/run/conf]
+                                [${\CONFIGURE_ROOT}/run/conf]
   --data-dir=[dir]              The location where the data files, such as the
                                 pid file, are stored.
-                                [$PWD/run/data]
+                                [${\CONFIGURE_ROOT}/run/data]
   --example-dir=[dir]           The location where the example configuration files
                                 and SQL schemas are stored.
-                                [$PWD/run/conf/examples]
+                                [${\CONFIGURE_ROOT}/run/conf/examples]
   --log-dir=[dir]               The location where the log files are stored.
-                                [$PWD/run/logs]
+                                [${\CONFIGURE_ROOT}/run/logs]
   --manual-dir=[dir]            The location where the manual files are stored.
-                                [$PWD/run/manuals]
+                                [${\CONFIGURE_ROOT}/run/manuals]
   --module-dir=[dir]            The location where the loadable modules are
                                 stored.
-                                [$PWD/run/modules]
+                                [${\CONFIGURE_ROOT}/run/modules]
   --script-dir=[dir]            The location where the scripts, such as the
                                 init scripts, are stored.
-                                [$PWD/run]
+                                [${\CONFIGURE_ROOT}/run]
 
 EXTRA MODULE OPTIONS
 
@@ -178,8 +179,10 @@ FLAGS
                                 will search for c++, g++, clang++ or icpc.
 
 If you have any problems with configuring InspIRCd then visit our IRC channel
-at irc.inspircd.org #InspIRCd for support.
+at irc.inspircd.org #InspIRCd or create a support discussion at
+https://github.com/inspircd/inspircd/discussions.
 
+Packagers: see https://docs.inspircd.org/packaging/ for packaging advice.
 EOH
        exit 0;
 }
@@ -188,6 +191,8 @@ sub cmd_update {
        print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE;
        say 'Updating...';
        my %config = read_config_file(CONFIGURE_CACHE_FILE);
+       $config{EXAMPLE_DIR} //= catdir $config{CONFIG_DIR}, 'examples';
+       $config{RUNTIME_DIR} //= $config{DATA_DIR};
        my %compiler = get_compiler_info($config{CXX});
        my %version = get_version $config{DISTRIBUTION};
        parse_templates(\%config, \%compiler, \%version);
@@ -207,9 +212,9 @@ sub test_file($$;$) {
        my ($compiler, $file, $args) = @_;
        my $status = 0;
        $args //= '';
-       $status ||= system "$compiler -o __test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
-       $status ||= system "./__test_$file ${\CONFIGURE_ERROR_PIPE}";
-       unlink "./__test_$file";
+       $status ||= system "$compiler -o ${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
+       $status ||= system "${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ERROR_PIPE}";
+       unlink "${\CONFIGURE_ROOT}/__test_$file";
        return !$status;
 }
 
@@ -222,13 +227,25 @@ sub test_header($$;$) {
        return !$?;
 }
 
+sub module_expand($) {
+       my $module = shift;
+       $module = "m_$module" unless $module =~ /^(?:m|core)_/;
+       $module = "$module.cpp" unless $module =~ /\.cpp$/;
+       return $module;
+}
+
+sub module_shrink($) {
+       my $module = basename shift;
+       return $module =~ s/(?:^m_|\.cpp$)//gr;
+}
+
 sub write_configure_cache(%) {
        unless (-e CONFIGURE_DIRECTORY) {
-               print_format "Creating <|GREEN ${\CONFIGURE_DIRECTORY}|> ...\n";
+               print_format "Creating <|GREEN ${\abs2rel CONFIGURE_DIRECTORY, CONFIGURE_ROOT}|> ...\n";
                create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
        }
 
-       print_format "Writing <|GREEN ${\CONFIGURE_CACHE_FILE}|> ...\n";
+       print_format "Writing <|GREEN ${\abs2rel CONFIGURE_CACHE_FILE, CONFIGURE_ROOT}|> ...\n";
        my %config = @_;
        write_config_file CONFIGURE_CACHE_FILE, %config;
 }
@@ -263,9 +280,9 @@ sub parse_templates($$$) {
        my %settings = __get_template_settings($config, $compiler, $version);
 
        # Iterate through files in make/template.
-       foreach (<make/template/*>) {
-               print_format "Parsing <|GREEN $_|> ...\n";
-               open(my $fh, $_) or print_error "unable to read $_: $!";
+       foreach my $template (<${\CONFIGURE_ROOT}/make/template/*>) {
+               print_format "Parsing <|GREEN ${\abs2rel $template, CONFIGURE_ROOT}|> ...\n";
+               open(my $fh, $template) or print_error "unable to read $template: $!";
                my (@lines, $mode, @platforms, @targets);
 
                # First pass: parse template variables and directives.
@@ -273,12 +290,14 @@ sub parse_templates($$$) {
                        chomp $line;
 
                        # Does this line match a variable?
-                       while ($line =~ /(@(\w+?)@)/) {
-                               my ($variable, $name) = ($1, $2);
+                       while ($line =~ /(@(\w+?)(?:\|(\w*))?@)/) {
+                               my ($variable, $name, $default) = ($1, $2, $3);
                                if (defined $settings{$name}) {
                                        $line =~ s/\Q$variable\E/$settings{$name}/;
+                               } elsif (defined $default) {
+                                       $line =~ s/\Q$variable\E/$default/;
                                } else {
-                                       print_warning "unknown template variable '$name' in $_!";
+                                       print_warning "unknown template variable '$name' in $template!";
                                        last;
                                }
                        }
@@ -296,9 +315,9 @@ sub parse_templates($$$) {
                                } elsif ($2 eq 'platform') {
                                        push @platforms, $3;
                                } elsif ($2 eq 'target') {
-                                       push @targets, $3
+                                       push @targets, catfile CONFIGURE_ROOT, $3;
                                } else {
-                                       print_warning "unknown template command '$2' in $_!";
+                                       print_warning "unknown template command '$2' in $template!";
                                        push @lines, $line;
                                }
                                next;
@@ -312,7 +331,7 @@ sub parse_templates($$$) {
 
                        # Add a default target if the template has not defined one.
                        unless (@targets) {
-                               push @targets, catfile(CONFIGURE_DIRECTORY, basename $_);
+                               push @targets, catfile(CONFIGURE_DIRECTORY, basename $template);
                        }
 
                        # Write the templated files to disk.
@@ -321,12 +340,12 @@ sub parse_templates($$$) {
                                # Create the directory if it doesn't already exist.
                                my $directory = dirname $target;
                                unless (-e $directory) {
-                                       print_format "Creating <|GREEN $directory|> ...\n";
+                                       print_format "Creating <|GREEN ${\abs2rel $directory, CONFIGURE_ROOT}|> ...\n";
                                        create_directory $directory, 0750 or print_error "unable to create $directory: $!";
                                };
 
                                # Write the template file.
-                               print_format "Writing <|GREEN $target|> ...\n";
+                               print_format "Writing <|GREEN ${\abs2rel $target, CONFIGURE_ROOT}|> ...\n";
                                open(my $fh, '>', $target) or print_error "unable to write $target: $!";
                                foreach (@lines) {
                                        say $fh $_;