2 # InspIRCd -- Internet Relay Chat Daemon
4 # Copyright (C) 2020 Nicole Kleinhoff <ilbelkyr@shalture.org>
5 # Copyright (C) 2013-2020 Sadie Powell <sadie@witchery.services>
6 # Copyright (C) 2012 Robby <robby@chatbelgie.be>
7 # Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
8 # Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 # This file is part of InspIRCd. InspIRCd is free software: you can
11 # redistribute it and/or modify it under the terms of the GNU General Public
12 # License as published by the Free Software Foundation, version 2.
14 # This program is distributed in the hope that it will be useful, but WITHOUT
15 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
28 package make::configure;
32 use warnings FATAL => qw(all);
34 use Exporter qw(import);
35 use File::Basename qw(basename dirname);
36 use File::Spec::Functions qw(abs2rel catdir catfile);
41 use constant CONFIGURE_ROOT => dirname dirname __FILE__;
42 use constant CONFIGURE_DIRECTORY => catdir(CONFIGURE_ROOT, '.configure');
43 use constant CONFIGURE_CACHE_FILE => catfile(CONFIGURE_DIRECTORY, 'cache.cfg');
44 use constant CONFIGURE_CACHE_VERSION => '1';
45 use constant CONFIGURE_ERROR_PIPE => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/null 2>/dev/null';
47 our @EXPORT = qw(CONFIGURE_CACHE_FILE
48 CONFIGURE_CACHE_VERSION
63 sub __get_socketengines {
65 foreach (<${\CONFIGURE_ROOT}/src/socketengines/socketengine_*.cpp>) {
66 s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
67 push @socketengines, $1;
69 return @socketengines;
72 # TODO: when buildtool is done this can be mostly removed with
73 # the remainder being merged into parse_templates.
74 sub __get_template_settings($$$) {
76 # These are actually hash references
77 my ($config, $compiler, $version) = @_;
79 # Start off by populating with the config
80 my %settings = %$config;
82 # Compiler information
83 while (my ($key, $value) = each %{$compiler}) {
84 $settings{'COMPILER_' . $key} = $value;
88 while (my ($key, $value) = each %{$version}) {
89 $settings{'VERSION_' . $key} = $value;
92 # Miscellaneous information
93 $settings{CONFIGURE_DIRECTORY} = CONFIGURE_DIRECTORY;
94 $settings{CONFIGURE_CACHE_FILE} = CONFIGURE_CACHE_FILE;
95 $settings{SYSTEM_NAME} = lc $^O;
100 sub __test_compiler($) {
101 my $compiler = shift;
102 return 0 unless run_test("`$compiler`", !system "$compiler -v ${\CONFIGURE_ERROR_PIPE}");
103 return 0 unless run_test("`$compiler`", test_file($compiler, 'compiler.cpp', '-fno-rtti'), 'compatible');
108 unlink CONFIGURE_CACHE_FILE;
112 my $SELIST = join ', ', __get_socketengines();
116 When no options are specified, configure runs in interactive mode and you must
117 specify any required values manually. If one or more options are specified,
118 non-interactive configuration is started and any omitted values are defaulted.
122 --system Automatically set up the installation paths
123 for system-wide installation.
124 --prefix=[dir] The root install directory. If this is set then
125 all subdirectories will be adjusted accordingly.
126 [${\CONFIGURE_ROOT}/run]
127 --binary-dir=[dir] The location where the main server binary is
129 [${\CONFIGURE_ROOT}/run/bin]
130 --config-dir=[dir] The location where the configuration files and
131 SSL certificates are stored.
132 [${\CONFIGURE_ROOT}/run/conf]
133 --data-dir=[dir] The location where the data files, such as the
134 pid file, are stored.
135 [${\CONFIGURE_ROOT}/run/data]
136 --example-dir=[dir] The location where the example configuration files
137 and SQL schemas are stored.
138 [${\CONFIGURE_ROOT}/run/conf/examples]
139 --log-dir=[dir] The location where the log files are stored.
140 [${\CONFIGURE_ROOT}/run/logs]
141 --manual-dir=[dir] The location where the manual files are stored.
142 [${\CONFIGURE_ROOT}/run/manuals]
143 --module-dir=[dir] The location where the loadable modules are
145 [${\CONFIGURE_ROOT}/run/modules]
146 --script-dir=[dir] The location where the scripts, such as the
147 init scripts, are stored.
148 [${\CONFIGURE_ROOT}/run]
152 --enable-extras=[extras] Enables a comma separated list of extra modules.
153 --disable-extras=[extras] Disables a comma separated list of extra modules.
154 --list-extras Shows the availability status of all extra
159 --clean Remove the configuration cache file and start
160 the interactive configuration wizard.
161 --disable-auto-extras Disables automatically enabling extra modules
162 for which the dependencies are available.
163 --disable-interactive Disables the interactive configuration wizard.
164 --distribution-label=[text] Sets a distribution specific version label in
165 the build configuration.
166 --gid=[id|name] Sets the group to run InspIRCd as.
167 --help Show this message and exit.
168 --socketengine=[name] Sets the socket engine to be used. Possible
170 --uid=[id|name] Sets the user to run InspIRCd as.
171 --update Updates the build environment with the settings
177 CXX=[name] Sets the C++ compiler to use when building the
178 server. If not specified then the build system
179 will search for c++, g++, clang++ or icpc.
181 If you have any problems with configuring InspIRCd then visit our IRC channel
182 at irc.inspircd.org #InspIRCd or create a support discussion at
183 https://github.com/inspircd/inspircd/discussions.
185 Packagers: see https://docs.inspircd.org/packaging/ for packaging advice.
191 print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE;
193 my %config = read_config_file(CONFIGURE_CACHE_FILE);
194 $config{EXAMPLE_DIR} //= catdir $config{CONFIG_DIR}, 'examples';
195 $config{RUNTIME_DIR} //= $config{DATA_DIR};
196 my %compiler = get_compiler_info($config{CXX});
197 my %version = get_version $config{DISTRIBUTION};
198 parse_templates(\%config, \%compiler, \%version);
199 say 'Update complete!';
204 my ($what, $result, $adjective) = @_;
205 $adjective //= 'available';
206 print_format "Checking whether <|GREEN $what|> is $adjective ... ";
207 print_format $result ? "<|GREEN yes|>\n" : "<|RED no|>\n";
211 sub test_file($$;$) {
212 my ($compiler, $file, $args) = @_;
215 $status ||= system "$compiler -o ${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
216 $status ||= system "${\CONFIGURE_ROOT}/__test_$file ${\CONFIGURE_ERROR_PIPE}";
217 unlink "${\CONFIGURE_ROOT}/__test_$file";
221 sub test_header($$;$) {
222 my ($compiler, $header, $args) = @_;
224 open(my $fh, "| $compiler -E - $args ${\CONFIGURE_ERROR_PIPE}") or return 0;
225 print $fh "#include <$header>";
230 sub module_expand($) {
232 $module = "m_$module" unless $module =~ /^(?:m|core)_/;
233 $module = "$module.cpp" unless $module =~ /\.cpp$/;
237 sub module_shrink($) {
238 my $module = basename shift;
239 return $module =~ s/(?:^m_|\.cpp$)//gr;
242 sub write_configure_cache(%) {
243 unless (-e CONFIGURE_DIRECTORY) {
244 print_format "Creating <|GREEN ${\abs2rel CONFIGURE_DIRECTORY, CONFIGURE_ROOT}|> ...\n";
245 create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
248 print_format "Writing <|GREEN ${\abs2rel CONFIGURE_CACHE_FILE, CONFIGURE_ROOT}|> ...\n";
250 write_config_file CONFIGURE_CACHE_FILE, %config;
253 sub get_compiler_info($) {
255 my %info = (NAME => 'Unknown', VERSION => '0.0');
256 return %info if system "$binary -o __compiler_info ${\CONFIGURE_ROOT}/make/test/compiler_info.cpp ${\CONFIGURE_ERROR_PIPE}";
257 open(my $fh, '-|', './__compiler_info 2>/dev/null');
258 while (my $line = <$fh>) {
259 $info{$1} = $2 if $line =~ /^([A-Z]+)\s(.+)$/;
262 unlink './__compiler_info';
267 my @compilers = qw(c++ g++ clang++ icpc);
268 foreach my $compiler (shift // @compilers) {
269 return $compiler if __test_compiler $compiler;
270 return "xcrun $compiler" if $^O eq 'darwin' && __test_compiler "xcrun $compiler";
274 sub parse_templates($$$) {
276 # These are actually hash references
277 my ($config, $compiler, $version) = @_;
279 # Collect settings to be used when generating files
280 my %settings = __get_template_settings($config, $compiler, $version);
282 # Iterate through files in make/template.
283 foreach my $template (<${\CONFIGURE_ROOT}/make/template/*>) {
284 print_format "Parsing <|GREEN ${\abs2rel $template, CONFIGURE_ROOT}|> ...\n";
285 open(my $fh, $template) or print_error "unable to read $template: $!";
286 my (@lines, $mode, @platforms, @targets);
288 # First pass: parse template variables and directives.
289 while (my $line = <$fh>) {
292 # Does this line match a variable?
293 while ($line =~ /(@(\w+?)(?:\|(\w*))?@)/) {
294 my ($variable, $name, $default) = ($1, $2, $3);
295 if (defined $settings{$name}) {
296 $line =~ s/\Q$variable\E/$settings{$name}/;
297 } elsif (defined $default) {
298 $line =~ s/\Q$variable\E/$default/;
300 print_warning "unknown template variable '$name' in $template!";
305 # Does this line match a directive?
306 if ($line =~ /^(\s*)%(\w+)\s+(.+)$/) {
307 if ($2 eq 'define') {
309 push @lines, "#$1define $3";
311 push @lines, "#$1undef $3";
313 } elsif ($2 eq 'mode') {
315 } elsif ($2 eq 'platform') {
317 } elsif ($2 eq 'target') {
318 push @targets, catfile CONFIGURE_ROOT, $3;
320 print_warning "unknown template command '$2' in $template!";
329 # Only proceed if this file should be templated on this platform.
330 if ($#platforms < 0 || grep { $_ eq $^O } @platforms) {
332 # Add a default target if the template has not defined one.
334 push @targets, catfile(CONFIGURE_DIRECTORY, basename $template);
337 # Write the templated files to disk.
338 for my $target (@targets) {
340 # Create the directory if it doesn't already exist.
341 my $directory = dirname $target;
342 unless (-e $directory) {
343 print_format "Creating <|GREEN ${\abs2rel $directory, CONFIGURE_ROOT}|> ...\n";
344 create_directory $directory, 0750 or print_error "unable to create $directory: $!";
347 # Write the template file.
348 print_format "Writing <|GREEN ${\abs2rel $target, CONFIGURE_ROOT}|> ...\n";
349 open(my $fh, '>', $target) or print_error "unable to write $target: $!";
355 # Set file permissions.
357 chmod $mode, $target;