2 # InspIRCd -- Internet Relay Chat Daemon
4 # Copyright (C) 2013-2020 Sadie Powell <sadie@witchery.services>
5 # Copyright (C) 2012 Robby <robby@chatbelgie.be>
6 # Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
7 # Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 # This file is part of InspIRCd. InspIRCd is free software: you can
10 # redistribute it and/or modify it under the terms of the GNU General Public
11 # License as published by the Free Software Foundation, version 2.
13 # This program is distributed in the hope that it will be useful, but WITHOUT
14 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
27 package make::configure;
31 use warnings FATAL => qw(all);
33 use Exporter qw(import);
34 use File::Basename qw(basename dirname);
35 use File::Spec::Functions qw(abs2rel catdir catfile);
40 use constant CONFIGURE_ROOT => dirname dirname __FILE__;
41 use constant CONFIGURE_DIRECTORY => catdir(CONFIGURE_ROOT, '.configure');
42 use constant CONFIGURE_CACHE_FILE => catfile(CONFIGURE_DIRECTORY, 'cache.cfg');
43 use constant CONFIGURE_CACHE_VERSION => '1';
44 use constant CONFIGURE_ERROR_PIPE => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/null 2>/dev/null';
46 our @EXPORT = qw(CONFIGURE_CACHE_FILE
47 CONFIGURE_CACHE_VERSION
60 sub __get_socketengines {
62 foreach (<${\CONFIGURE_ROOT}/src/socketengines/socketengine_*.cpp>) {
63 s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
64 push @socketengines, $1;
66 return @socketengines;
69 # TODO: when buildtool is done this can be mostly removed with
70 # the remainder being merged into parse_templates.
71 sub __get_template_settings($$$) {
73 # These are actually hash references
74 my ($config, $compiler, $version) = @_;
76 # Start off by populating with the config
77 my %settings = %$config;
79 # Compiler information
80 while (my ($key, $value) = each %{$compiler}) {
81 $settings{'COMPILER_' . $key} = $value;
85 while (my ($key, $value) = each %{$version}) {
86 $settings{'VERSION_' . $key} = $value;
89 # Miscellaneous information
90 $settings{CONFIGURE_DIRECTORY} = CONFIGURE_DIRECTORY;
91 $settings{CONFIGURE_CACHE_FILE} = CONFIGURE_CACHE_FILE;
92 $settings{SYSTEM_NAME} = lc $^O;
97 sub __test_compiler($) {
99 return 0 unless run_test("`$compiler`", !system "$compiler -v ${\CONFIGURE_ERROR_PIPE}");
100 return 0 unless run_test("`$compiler`", test_file($compiler, 'compiler.cpp', '-fno-rtti'), 'compatible');
105 unlink CONFIGURE_CACHE_FILE;
109 my $SELIST = join ', ', __get_socketengines();
113 When no options are specified, configure runs in interactive mode and you must
114 specify any required values manually. If one or more options are specified,
115 non-interactive configuration is started and any omitted values are defaulted.
119 --system Automatically set up the installation paths
120 for system-wide installation.
121 --prefix=[dir] The root install directory. If this is set then
122 all subdirectories will be adjusted accordingly.
123 [${\CONFIGURE_ROOT}/run]
124 --binary-dir=[dir] The location where the main server binary is
126 [${\CONFIGURE_ROOT}/run/bin]
127 --config-dir=[dir] The location where the configuration files and
128 SSL certificates are stored.
129 [${\CONFIGURE_ROOT}/run/conf]
130 --data-dir=[dir] The location where the data files, such as the
131 pid file, are stored.
132 [${\CONFIGURE_ROOT}/run/data]
133 --example-dir=[dir] The location where the example configuration files
134 and SQL schemas are stored.
135 [${\CONFIGURE_ROOT}/run/conf/examples]
136 --log-dir=[dir] The location where the log files are stored.
137 [${\CONFIGURE_ROOT}/run/logs]
138 --manual-dir=[dir] The location where the manual files are stored.
139 [${\CONFIGURE_ROOT}/run/manuals]
140 --module-dir=[dir] The location where the loadable modules are
142 [${\CONFIGURE_ROOT}/run/modules]
143 --script-dir=[dir] The location where the scripts, such as the
144 init scripts, are stored.
145 [${\CONFIGURE_ROOT}/run]
149 --enable-extras=[extras] Enables a comma separated list of extra modules.
150 --disable-extras=[extras] Disables a comma separated list of extra modules.
151 --list-extras Shows the availability status of all extra
156 --clean Remove the configuration cache file and start
157 the interactive configuration wizard.
158 --disable-auto-extras Disables automatically enabling extra modules
159 for which the dependencies are available.
160 --disable-interactive Disables the interactive configuration wizard.
161 --distribution-label=[text] Sets a distribution specific version label in
162 the build configuration.
163 --gid=[id|name] Sets the group to run InspIRCd as.
164 --help Show this message and exit.
165 --socketengine=[name] Sets the socket engine to be used. Possible
167 --uid=[id|name] Sets the user to run InspIRCd as.
168 --update Updates the build environment with the settings
174 CXX=[name] Sets the C++ compiler to use when building the
175 server. If not specified then the build system
176 will search for c++, g++, clang++ or icpc.
178 If you have any problems with configuring InspIRCd then visit our IRC channel
179 at irc.inspircd.org #InspIRCd for support.
181 Packagers: see https://docs.inspircd.org/packaging/ for packaging advice.
187 print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE;
189 my %config = read_config_file(CONFIGURE_CACHE_FILE);
190 my %compiler = get_compiler_info($config{CXX});
191 my %version = get_version $config{DISTRIBUTION};
192 parse_templates(\%config, \%compiler, \%version);
193 say 'Update complete!';
198 my ($what, $result, $adjective) = @_;
199 $adjective //= 'available';
200 print_format "Checking whether <|GREEN $what|> is $adjective ... ";
201 print_format $result ? "<|GREEN yes|>\n" : "<|RED no|>\n";
205 sub test_file($$;$) {
206 my ($compiler, $file, $args) = @_;
209 $status ||= system "$compiler -o ${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
210 $status ||= system "${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ERROR_PIPE}";
211 unlink "${\CONFIGURE_ROOT}/__test_$file";
215 sub test_header($$;$) {
216 my ($compiler, $header, $args) = @_;
218 open(my $fh, "| $compiler -E - $args ${\CONFIGURE_ERROR_PIPE}") or return 0;
219 print $fh "#include <$header>";
224 sub write_configure_cache(%) {
225 unless (-e CONFIGURE_DIRECTORY) {
226 print_format "Creating <|GREEN ${\abs2rel CONFIGURE_DIRECTORY, CONFIGURE_ROOT}|> ...\n";
227 create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
230 print_format "Writing <|GREEN ${\abs2rel CONFIGURE_CACHE_FILE, CONFIGURE_ROOT}|> ...\n";
232 write_config_file CONFIGURE_CACHE_FILE, %config;
235 sub get_compiler_info($) {
237 my %info = (NAME => 'Unknown', VERSION => '0.0');
238 return %info if system "$binary -o __compiler_info ${\CONFIGURE_ROOT}/make/test/compiler_info.cpp ${\CONFIGURE_ERROR_PIPE}";
239 open(my $fh, '-|', './__compiler_info 2>/dev/null');
240 while (my $line = <$fh>) {
241 $info{$1} = $2 if $line =~ /^([A-Z]+)\s(.+)$/;
244 unlink './__compiler_info';
249 my @compilers = qw(c++ g++ clang++ icpc);
250 foreach my $compiler (shift // @compilers) {
251 return $compiler if __test_compiler $compiler;
252 return "xcrun $compiler" if $^O eq 'darwin' && __test_compiler "xcrun $compiler";
256 sub parse_templates($$$) {
258 # These are actually hash references
259 my ($config, $compiler, $version) = @_;
261 # Collect settings to be used when generating files
262 my %settings = __get_template_settings($config, $compiler, $version);
264 # Iterate through files in make/template.
265 foreach my $template (<${\CONFIGURE_ROOT}/make/template/*>) {
266 print_format "Parsing <|GREEN ${\abs2rel $template, CONFIGURE_ROOT}|> ...\n";
267 open(my $fh, $template) or print_error "unable to read $template: $!";
268 my (@lines, $mode, @platforms, @targets);
270 # First pass: parse template variables and directives.
271 while (my $line = <$fh>) {
274 # Does this line match a variable?
275 while ($line =~ /(@(\w+?)(?:\|(\w*))?@)/) {
276 my ($variable, $name, $default) = ($1, $2, $3);
277 if (defined $settings{$name}) {
278 $line =~ s/\Q$variable\E/$settings{$name}/;
279 } elsif (defined $default) {
280 $line =~ s/\Q$variable\E/$default/;
282 print_warning "unknown template variable '$name' in $template!";
287 # Does this line match a directive?
288 if ($line =~ /^(\s*)%(\w+)\s+(.+)$/) {
289 if ($2 eq 'define') {
291 push @lines, "#$1define $3";
293 push @lines, "#$1undef $3";
295 } elsif ($2 eq 'mode') {
297 } elsif ($2 eq 'platform') {
299 } elsif ($2 eq 'target') {
300 push @targets, catfile CONFIGURE_ROOT, $3;
302 print_warning "unknown template command '$2' in $template!";
311 # Only proceed if this file should be templated on this platform.
312 if ($#platforms < 0 || grep { $_ eq $^O } @platforms) {
314 # Add a default target if the template has not defined one.
316 push @targets, catfile(CONFIGURE_DIRECTORY, basename $template);
319 # Write the templated files to disk.
320 for my $target (@targets) {
322 # Create the directory if it doesn't already exist.
323 my $directory = dirname $target;
324 unless (-e $directory) {
325 print_format "Creating <|GREEN ${\abs2rel $directory, CONFIGURE_ROOT}|> ...\n";
326 create_directory $directory, 0750 or print_error "unable to create $directory: $!";
329 # Write the template file.
330 print_format "Writing <|GREEN ${\abs2rel $target, CONFIGURE_ROOT}|> ...\n";
331 open(my $fh, '>', $target) or print_error "unable to write $target: $!";
337 # Set file permissions.
339 chmod $mode, $target;