make/utilities.pm

   1 #       +------------------------------------+
   2 #       | Inspire Internet Relay Chat Daemon |
   3 #       +------------------------------------+
   4 #
   5 #  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6 # See: http://www.inspircd.org/wiki/index.php/Credits
   7 #
   8 # This program is free but copyrighted software; see
   9 #      the file COPYING for details.
  10 #
  11 # ---------------------------------------------------
  12
  13 package make::utilities;
  14
  15 require 5.8.0;
  16
  17 use strict;
  18 use warnings FATAL => qw(all);
  19
  20 use Exporter 'import';
  21 use POSIX;
  22 use Getopt::Long;
  23 use Fcntl;
  24 our @EXPORT = qw(make_rpath pkgconfig_get_include_dirs pkgconfig_get_lib_dirs pkgconfig_check_version translate_functions promptstring vcheck);
  25
  26 # Parse the output of a *_config program,
  27 # such as pcre_config, take out the -L
  28 # directive and return an rpath for it.
  29
  30 # \e[1;32msrc/Makefile\e[0m
  31
  32 my %already_added = ();
  33
  34 sub promptstring($$$$$)
  35 {
  36         my ($prompt, $configitem, $default, $package, $commandlineswitch) = @_;
  37         my $var;
  38         if (!$main::interactive)
  39         {
  40                 my $opt_commandlineswitch;
  41                 GetOptions ("$commandlineswitch=s" => \$opt_commandlineswitch);
  42                 if (defined $opt_commandlineswitch)
  43                 {
  44                         print "\e[1;32m$opt_commandlineswitch\e[0m\n";
  45                         $var = $opt_commandlineswitch;
  46                 }
  47                 else
  48                 {
  49                         die "Could not detect $package! Please specify the $prompt via the command line option \e[1;32m--$commandlineswitch=\"/path/to/file\"\e[0m";
  50                 }
  51         }
  52         else
  53         {
  54                 print "\nPlease enter the $prompt?\n";
  55                 print "[\e[1;32m$default\e[0m] -> ";
  56                 chomp($var = <STDIN>);
  57         }
  58         if ($var eq "")
  59         {
  60                 $var = $default;
  61         }
  62         $main::config{$configitem} = $var;
  63 }
  64
  65 sub make_rpath($;$)
  66 {
  67         my ($executable, $module) = @_;
  68         chomp(my $data = `$executable`);
  69         my $output = "";
  70         while ($data =~ /-L(\S+)/)
  71         {
  72                 my $libpath = $1;
  73                 if (!exists $already_added{$libpath})
  74                 {
  75                         print "Adding extra library path to \e[1;32m$module\e[0m ... \e[1;32m$libpath\e[0m\n";
  76                         $already_added{$libpath} = 1;
  77                 }
  78                 $output .= "-Wl,--rpath -Wl,$libpath -L$libpath " unless defined $main::opt_disablerpath;
  79                 $data =~ s/-L(\S+)//;
  80         }
  81         return $output;
  82 }
  83
  84 sub extend_pkg_path()
  85 {
  86         if (!exists $ENV{PKG_CONFIG_PATH})
  87         {
  88                 $ENV{PKG_CONFIG_PATH} = "/usr/lib/pkgconfig:/usr/local/lib/pkgconfig:/usr/local/libdata/pkgconfig:/usr/X11R6/libdata/pkgconfig";
  89         }
  90         else
  91         {
  92                 $ENV{PKG_CONFIG_PATH} .= ":/usr/local/lib/pkgconfig:/usr/local/libdata/pkgconfig:/usr/X11R6/libdata/pkgconfig";
  93         }
  94 }
  95
  96 sub pkgconfig_get_include_dirs($$$;$)
  97 {
  98         my ($packagename, $headername, $defaults, $module) = @_;
  99
 100         my $key = "default_includedir_$packagename";
 101         if (exists $main::config{$key})
 102         {
 103                 print "Locating include directory for package \e[1;32m$packagename\e[0m for module \e[1;32m$module\e[0m... ";
 104                 my $ret = $main::config{$key};
 105                 print "\e[1;32m$ret\e[0m (cached)\n";
 106                 return $ret;
 107         }
 108
 109         extend_pkg_path();
 110
 111         print "Locating include directory for package \e[1;32m$packagename\e[0m for module \e[1;32m$module\e[0m... ";
 112
 113         my $v = `pkg-config --modversion $packagename 2>/dev/null`;
 114         my $ret = `pkg-config --cflags $packagename 2>/dev/null`;
 115         my $foo = "";
 116
 117         if ((!defined $v) || ($v eq ""))
 118         {
 119                 $foo = `locate "$headername" | head -n 1`;
 120                 $foo =~ /(.+)\Q$headername\E/;
 121                 my $find = $1;
 122                 chomp($find);
 123                 if ((defined $find) && ($find ne "") && ($find ne $packagename))
 124                 {
 125                         print "(\e[1;32mFound via search\e[0m) ";
 126                         $foo = "-I$1";
 127                 }
 128                 else
 129                 {
 130                         $foo = " ";
 131                         undef $v;
 132                 }
 133                 $ret = "$foo";
 134         }
 135         if (($defaults ne "") && (($ret eq "") || (!defined $ret)))
 136         {
 137                 $ret = "$foo " . $defaults;
 138         }
 139         chomp($ret);
 140         if ((($ret eq " ") || (!defined $ret)) && ((!defined $v) || ($v eq "")))
 141         {
 142                 my $key = "default_includedir_$packagename";
 143                 if (exists $main::config{$key})
 144                 {
 145                         $ret = $main::config{$key};
 146                 }
 147                 else
 148                 {
 149                         $headername =~ s/^\///;
 150                         promptstring("path to the directory containing $headername", $key, "/usr/include",$packagename,"$packagename-includes");
 151                         $packagename =~ tr/a-z/A-Z/;
 152                         $main::config{$key} = "-I$main::config{$key}" . " $defaults -DVERSION_$packagename=\"$v\"";
 153                         $main::config{$key} =~ s/^\s+//g;
 154                         $ret = $main::config{$key};
 155                         return $ret;
 156                 }
 157         }
 158         else
 159         {
 160                 chomp($v);
 161                 my $key = "default_includedir_$packagename";
 162                 $packagename =~ tr/a-z/A-Z/;
 163                 $main::config{$key} = "$ret -DVERSION_$packagename=\"$v\"";
 164                 $main::config{$key} =~ s/^\s+//g;
 165                 $ret = $main::config{$key};
 166                 print "\e[1;32m$ret\e[0m (version $v)\n";
 167         }
 168         $ret =~ s/^\s+//g;
 169         return $ret;
 170 }
 171
 172 sub vcheck($$)
 173 {
 174         my ($version1, $version2) = @_;
 175         $version1 =~ s/\-r(\d+)/\.$1/g; # minor revs/patchlevels
 176         $version2 =~ s/\-r(\d+)/\.$1/g;
 177         $version1 =~ s/p(\d+)/\.$1/g;
 178         $version2 =~ s/p(\d+)/\.$1/g;
 179         $version1 =~ s/\-//g;
 180         $version2 =~ s/\-//g;
 181         $version1 =~ s/[a-z]//g;
 182         $version2 =~ s/[a-z]//g;
 183         my @v1 = split('\.', $version1);
 184         my @v2 = split('\.', $version2);
 185         for (my $curr = 0; $curr < scalar(@v1); $curr++)
 186         {
 187                 if ($v1[$curr] < $v2[$curr])
 188                 {
 189                         return 0;
 190                 }
 191         }
 192         return 1;
 193 }
 194
 195 sub pkgconfig_check_version($$;$)
 196 {
 197         my ($packagename, $version, $module) = @_;
 198
 199         extend_pkg_path();
 200
 201         print "Checking version of package \e[1;32m$packagename\e[0m is >= \e[1;32m$version\e[0m... ";
 202
 203         my $v = `pkg-config --modversion $packagename 2>/dev/null`;
 204         if (defined $v)
 205         {
 206                 chomp($v);
 207         }
 208         if ((defined $v) && ($v ne ""))
 209         {
 210                 if (vcheck($v,$version) == 1)
 211                 {
 212                         print "\e[1;32mYes (version $v)\e[0m\n";
 213                         return 1;
 214                 }
 215                 else
 216                 {
 217                         print "\e[1;32mNo (version $v)\e[0m\n";
 218                         return 0;
 219                 }
 220         }
 221         # If we didnt find it, we  cant definitively say its too old.
 222         # Return ok, and let pkgconflibs() or pkgconfincludes() pick up
 223         # the missing library later on.
 224         print "\e[1;32mNo (not found)\e[0m\n";
 225         return 1;
 226 }
 227
 228 sub pkgconfig_get_lib_dirs($$$;$)
 229 {
 230         my ($packagename, $libname, $defaults, $module) = @_;
 231
 232         my $key = "default_libdir_$packagename";
 233         if (exists $main::config{$key})
 234         {
 235                 print "Locating library directory for package \e[1;32m$packagename\e[0m for module \e[1;32m$module\e[0m... ";
 236                 my $ret = $main::config{$key};
 237                 print "\e[1;32m$ret\e[0m (cached)\n";
 238                 return $ret;
 239         }
 240
 241         extend_pkg_path();
 242
 243         print "Locating library directory for package \e[1;32m$packagename\e[0m for module \e[1;32m$module\e[0m... ";
 244
 245         my $v = `pkg-config --modversion $packagename 2>/dev/null`;
 246         my $ret = `pkg-config --libs $packagename 2>/dev/null`;
 247
 248         my $foo = "";
 249         if ((!defined $v) || ($v eq ""))
 250         {
 251                 $foo = `locate "$libname" | head -n 1`;
 252                 $foo =~ /(.+)\Q$libname\E/;
 253                 my $find = $1;
 254                 chomp($find);
 255                 if ((defined $find) && ($find ne "") && ($find ne $packagename))
 256                 {
 257                         print "(\e[1;32mFound via search\e[0m) ";
 258                         $foo = "-L$1";
 259                 }
 260                 else
 261                 {
 262                         $foo = " ";
 263                         undef $v;
 264                 }
 265                 $ret = "$foo";
 266         }
 267
 268         if (($defaults ne "") && (($ret eq "") || (!defined $ret)))
 269         {
 270                 $ret = "$foo " . $defaults;
 271         }
 272         chomp($ret);
 273         if ((($ret eq " ") || (!defined $ret)) && ((!defined $v) || ($v eq "")))
 274         {
 275                 my $key = "default_libdir_$packagename";
 276                 if (exists $main::config{$key})
 277                 {
 278                         $ret = $main::config{$key};
 279                 }
 280                 else
 281                 {
 282                         $libname =~ s/^\///;
 283                         promptstring("path to the directory containing $libname", $key, "/usr/lib",$packagename,"$packagename-libs");
 284                         $main::config{$key} = "-L$main::config{$key}" . " $defaults";
 285                         $main::config{$key} =~ s/^\s+//g;
 286                         $ret = $main::config{$key};
 287                         return $ret;
 288                 }
 289         }
 290         else
 291         {
 292                 chomp($v);
 293                 print "\e[1;32m$ret\e[0m (version $v)\n";
 294                 my $key = "default_libdir_$packagename";
 295                 $main::config{$key} = $ret;
 296                 $main::config{$key} =~ s/^\s+//g;
 297                 $ret =~ s/^\s+//g;
 298         }
 299         $ret =~ s/^\s+//g;
 300         return $ret;
 301 }
 302
 303 # Translate a $CompileFlags etc line and parse out function calls
 304 # to functions within these modules at configure time.
 305 sub translate_functions($$)
 306 {
 307         my ($line,$module) = @_;
 308
 309         eval
 310         {
 311                 $module =~ /modules*\/(.+?)$/;
 312                 $module = $1;
 313
 314                 # This is only a cursory check, just designed to catch casual accidental use of backticks.
 315                 # There are pleanty of ways around it, but its not supposed to be for security, just checking
 316                 # that people are using the new configuration api as theyre supposed to and not just using
 317                 # backticks instead of eval(), being as eval has accountability. People wanting to get around
 318                 # the accountability will do so anyway.
 319                 if (($line =~ /`/) && ($line !~ /eval\(.+?`.+?\)/))
 320                 {
 321                         die "Developers should no longer use backticks in configuration macros. Please use exec() and eval() macros instead. Offending line: $line (In module: $module)";
 322                 }
 323                 while ($line =~ /exec\("(.+?)"\)/)
 324                 {
 325                         print "Executing program for module \e[1;32m$module\e[0m ... \e[1;32m$1\e[0m\n";
 326                         my $replace = `$1`;
 327                         die $replace if ($replace =~ /Configuration failed/);
 328                         chomp($replace);
 329                         $line =~ s/exec\("(.+?)"\)/$replace/;
 330                 }
 331                 while ($line =~ /execruntime\("(.+?)"\)/)
 332                 {
 333                         $line =~ s/execruntime\("(.+?)"\)/`$1`/;
 334                 }
 335                 while ($line =~ /eval\("(.+?)"\)/)
 336                 {
 337                         print "Evaluating perl code for module \e[1;32m$module\e[0m ... ";
 338                         my $tmpfile;
 339                         do
 340                         {
 341                                 $tmpfile = tmpnam();
 342                         } until sysopen(TF, $tmpfile, O_RDWR|O_CREAT|O_EXCL|O_NOFOLLOW, 0700);
 343                         print "(Created and executed \e[1;32m$tmpfile\e[0m)\n";
 344                         print TF $1;
 345                         close TF;
 346                         my $replace = `perl $tmpfile`;
 347                         chomp($replace);
 348                         $line =~ s/eval\("(.+?)"\)/$replace/;
 349                 }
 350                 while ($line =~ /pkgconflibs\("(.+?)","(.+?)","(.+?)"\)/)
 351                 {
 352                         my $replace = pkgconfig_get_lib_dirs($1, $2, $3, $module);
 353                         $line =~ s/pkgconflibs\("(.+?)","(.+?)","(.+?)"\)/$replace/;
 354                 }
 355                 while ($line =~ /pkgconfversion\("(.+?)","(.+?)"\)/)
 356                 {
 357                         if (pkgconfig_check_version($1, $2, $module) != 1)
 358                         {
 359                                 die "Version of package $1 is too old. Please upgrade it to version \e[1;32m$2\e[0m or greater and try again.";
 360                         }
 361                         # This doesnt actually get replaced with anything
 362                         $line =~ s/pkgconfversion\("(.+?)","(.+?)"\)//;
 363                 }
 364                 while ($line =~ /pkgconflibs\("(.+?)","(.+?)",""\)/)
 365                 {
 366                         my $replace = pkgconfig_get_lib_dirs($1, $2, "", $module);
 367                         $line =~ s/pkgconflibs\("(.+?)","(.+?)",""\)/$replace/;
 368                 }
 369                 while ($line =~ /pkgconfincludes\("(.+?)","(.+?)",""\)/)
 370                 {
 371                         my $replace = pkgconfig_get_include_dirs($1, $2, "", $module);
 372                         $line =~ s/pkgconfincludes\("(.+?)","(.+?)",""\)/$replace/;
 373                 }
 374                 while ($line =~ /pkgconfincludes\("(.+?)","(.+?)","(.+?)"\)/)
 375                 {
 376                         my $replace = pkgconfig_get_include_dirs($1, $2, $3, $module);
 377                         $line =~ s/pkgconfincludes\("(.+?)","(.+?)","(.+?)"\)/$replace/;
 378                 }
 379                 while ($line =~ /rpath\("(.+?)"\)/)
 380                 {
 381                         my $replace = make_rpath($1,$module);
 382                         $replace = "" if ($^O =~ /darwin/i);
 383                         $line =~ s/rpath\("(.+?)"\)/$replace/;
 384                 }
 385         };
 386         if ($@)
 387         {
 388                 my $err = $@;
 389                 $err =~ s/at .+? line \d+.*//g;
 390                 print "\n\nConfiguration failed. The following error occured:\n\n$err\n";
 391                 exit;
 392         }
 393         else
 394         {
 395                 return $line;
 396         }
 397 }
 398
 399 1;
 400