]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - make/directive.pm
Update copyright headers.
[user/henk/code/inspircd.git] / make / directive.pm
index 4501fc5ec40b71ea445ce5ea64e0fd8c3e6c7a91..698934001e07c3f7c763934faee598523bd9e2c3 100644 (file)
@@ -1,7 +1,7 @@
 #
 # InspIRCd -- Internet Relay Chat Daemon
 #
-#   Copyright (C) 2016 Peter Powell <petpow@saberuk.com>
+#   Copyright (C) 2016-2021 Sadie Powell <sadie@witchery.services>
 #
 # This file is part of InspIRCd.  InspIRCd is free software: you can
 # redistribute it and/or modify it under the terms of the GNU General Public
 
 package make::directive;
 
-BEGIN {
-       require 5.10.0;
-}
-
-use feature ':5.10';
+use v5.10.0;
 use strict;
 use warnings FATAL => qw(all);
 
-use File::Basename qw(basename);
-use Exporter       qw(import);
+use File::Basename        qw(dirname);
+use File::Spec::Functions qw(catdir);
+use Exporter              qw(import);
 
 use make::configure;
 use make::console;
 
 use constant DIRECTIVE_ERROR_PIPE => $ENV{INSPIRCD_VERBOSE} ? '' : '2>/dev/null';
+use constant VENDOR_DIRECTORY     => catdir(dirname(dirname(__FILE__)), 'vendor');
 
 our @EXPORT = qw(get_directive
                  execute_functions);
@@ -41,16 +39,16 @@ our @EXPORT = qw(get_directive
 sub get_directive($$;$)
 {
        my ($file, $property, $default) = @_;
-       open(MODULE, $file) or return $default;
+       open(my $fh, $file) or return $default;
 
        my $value = '';
-       while (<MODULE>) {
+       while (<$fh>) {
                if ($_ =~ /^\/\* \$(\S+): (.+) \*\/$/ || $_ =~ /^\/\/\/ \$(\S+): (.+)/) {
                        next unless $1 eq $property;
                        $value .= ' ' . execute_functions($file, $1, $2);
                }
        }
-       close(MODULE);
+       close $fh;
 
        # Strip all extraneous whitespace.
        $value =~ s/^\s+|\s+$//g;
@@ -122,11 +120,15 @@ sub __error {
        } else {
                push @message, 'If you believe this error to be a bug then you can file a bug report';
                push @message, 'at https://github.com/inspircd/inspircd/issues';
+               push @message, '';
+               push @message, 'You can also refer to the documentation page for this module at';
+               push @message, "https://docs.inspircd.org/3/modules/${\module_shrink $file}";
        }
        push @message, '';
 
        push @message, 'If you would like help with fixing this problem then visit our IRC';
-       push @message, 'channel at irc.inspircd.org #InspIRCd for support.';
+       push @message, 'channel at irc.inspircd.org #InspIRCd or create a support discussion';
+       push @message, 'at https://github.com/inspircd/inspircd/discussions.';
        push @message, '';
 
        print_error @message;
@@ -143,7 +145,7 @@ sub __function_execute {
        # Try to execute the command...
        chomp(my $result = `$command ${\DIRECTIVE_ERROR_PIPE}`);
        unless ($?) {
-               print_format "Execution of `<|GREEN $command|>` succeeded: <|BOLD $result|>\n";
+               say console_format "Execution of `<|GREEN $command|>` succeeded: <|BOLD $result|>";
                return $result;
        }
 
@@ -151,18 +153,18 @@ sub __function_execute {
        if (defined $environment && $environment ne '') {
                $environment = __environment 'INSPIRCD_', $environment;
                if (defined $ENV{$environment}) {
-                       print_format "Execution of `<|GREEN $command|>` failed; using the environment: <|BOLD $ENV{$environment}|>\n";
+                       say console_format "Execution of `<|GREEN $command|>` failed; using the environment: <|BOLD $ENV{$environment}|>";
                        return $ENV{$environment};
                }
        }
 
        # If all else fails then look for the defaults..
        if (defined $defaults) {
-               print_format "Execution of `<|GREEN $command|>` failed; using the defaults: <|BOLD $defaults|>\n";
+               say console_format "Execution of `<|GREEN $command|>` failed; using the defaults: <|BOLD $defaults|>";
                return $defaults;
        }
 
-       # Executing the command failed and we don't have any defaults so give up. 
+       # Executing the command failed and we don't have any defaults so give up.
        __error $file, "`<|GREEN $command|>` exited with a non-zero exit code!";
 }
 
@@ -172,25 +174,25 @@ sub __function_find_compiler_flags {
        # Try to look up the compiler flags with pkg-config...
        chomp(my $flags = `pkg-config --cflags $name ${\DIRECTIVE_ERROR_PIPE}`);
        unless ($?) {
-               print_format "Found the compiler flags for <|GREEN ${\basename $file, '.cpp'}|> using pkg-config: <|BOLD $flags|>\n";
+               say console_format "Found the <|GREEN $name|> compiler flags for <|GREEN ${\module_shrink $file}|> using pkg-config: <|BOLD $flags|>";
                return $flags;
        }
 
        # If looking up with pkg-config fails then check the environment...
        my $key = __environment 'INSPIRCD_CXXFLAGS_', $name;
        if (defined $ENV{$key}) {
-               print_format "Found the compiler flags for <|GREEN ${\basename $file, '.cpp'}|> using the environment: <|BOLD $ENV{$key}|>\n";
+               say console_format "Found the <|GREEN $name|> compiler flags for <|GREEN ${\module_shrink $file}|> using the environment: <|BOLD $ENV{$key}|>";
                return $ENV{$key};
        }
 
        # If all else fails then look for the defaults..
        if (defined $defaults) {
-               print_format "Found the compiler flags for <|GREEN ${\basename $file, '.cpp'}|> using the defaults: <|BOLD $defaults|>\n";
+               say console_format "Using the default <|GREEN $name|> compiler flags for <|GREEN ${\module_shrink $file}|>: <|BOLD $defaults|>";
                return $defaults;
        }
 
        # We can't find it via pkg-config, via the environment, or via the defaults so give up.
-       __error $file, "unable to find the compiler flags for <|GREEN ${\basename $file, '.cpp'}|>!";
+       __error $file, "unable to find the <|GREEN $name|> compiler flags for <|GREEN ${\module_shrink $file}|>!";
 }
 
 sub __function_find_linker_flags {
@@ -199,25 +201,41 @@ sub __function_find_linker_flags {
        # Try to look up the linker flags with pkg-config...
        chomp(my $flags = `pkg-config --libs $name ${\DIRECTIVE_ERROR_PIPE}`);
        unless ($?) {
-               print_format "Found the linker flags for <|GREEN ${\basename $file, '.cpp'}|> using pkg-config: <|BOLD $flags|>\n";
+               say console_format "Found the <|GREEN $name|> linker flags for <|GREEN ${\module_shrink $file}|> using pkg-config: <|BOLD $flags|>";
                return $flags;
        }
 
        # If looking up with pkg-config fails then check the environment...
        my $key = __environment 'INSPIRCD_CXXFLAGS_', $name;
        if (defined $ENV{$key}) {
-               print_format "Found the linker flags for <|GREEN ${\basename $file, '.cpp'}|> using the environment: <|BOLD $ENV{$key}|>\n";
+               say console_format "Found the <|GREEN $name|> linker flags for <|GREEN ${\module_shrink $file}|> using the environment: <|BOLD $ENV{$key}|>";
                return $ENV{$key};
        }
 
        # If all else fails then look for the defaults..
        if (defined $defaults) {
-               print_format "Found the linker flags for <|GREEN ${\basename $file, '.cpp'}|> using the defaults: <|BOLD $defaults|>\n";
+               say console_format "Using the default <|GREEN $name|> linker flags for <|GREEN ${\module_shrink $file}|>: <|BOLD $defaults|>";
                return $defaults;
        }
 
        # We can't find it via pkg-config, via the environment, or via the defaults so give up.
-       __error $file, "unable to find the linker flags for <|GREEN ${\basename $file, '.cpp'}|>!";
+       __error $file, "unable to find the <|GREEN $name|> linker flags for <|GREEN ${\module_shrink $file}|>!";
+}
+
+sub __function_require_compiler {
+       my ($file, $name, $minimum, $maximum) =  @_;
+
+       # Look up information about the compiler.
+       return undef unless $ENV{CXX};
+       my %compiler = get_compiler_info($ENV{CXX});
+
+       # Check whether the current compiler is suitable.
+       return undef unless $compiler{NAME} eq $name;
+       return undef if defined $minimum && $compiler{VERSION} < $minimum;
+       return undef if defined $maximum && $compiler{VERSION} > $maximum;
+
+       # Requirement directives don't change anything directly.
+       return "";
 }
 
 sub __function_require_system {
@@ -251,7 +269,7 @@ sub __function_require_version {
 
        # If pkg-config isn't installed then we can't do anything here.
        if (system "pkg-config --exists $name ${\DIRECTIVE_ERROR_PIPE}") {
-               print_warning "unable to look up the version of $name using pkg-config!";
+               print_warning "unable to look up the version of <|GREEN $name|> using pkg-config!";
                return undef;
        }
 
@@ -263,6 +281,26 @@ sub __function_require_version {
        return "";
 }
 
+sub __function_vendor_directory {
+       my ($file, $name) = @_;
+
+       # Try to look the directory up in the environment...
+       my $key = __environment 'INSPIRCD_VENDOR_', $name;
+       if (defined $ENV{$key}) {
+               say console_format "Found the <|GREEN $name|> vendor directory for <|GREEN ${\module_shrink $file}|> using the environment: <|BOLD $ENV{$key}|>";
+               return $ENV{$key};
+       }
+
+       my $directory = catdir(VENDOR_DIRECTORY, $name);
+       if (-d $directory) {
+               say console_format "Using the default <|GREEN $name|> vendor directory for <|GREEN ${\module_shrink $file}|>: <|BOLD $directory|>";
+               return $directory;
+       }
+
+       # We can't find it via the environment or via the filesystem so give up.
+       __error $file, "unable to find the <|GREEN $name|> vendor directory for <|GREEN ${\module_shrink $file}|>!";
+}
+
 sub __function_warning {
        my ($file, @messages) = @_;
        print_warning @messages;