nokogiri 1.6.1-java → 1.6.2-java

data/ext/nokogiri/extconf.rb

@@ -1,183 +1,472 @@
-ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
-
 # :stopdoc:
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
 
 require 'mkmf'
 
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+if arg_config('--help')
+  print <<HELP
+usage: ruby #{$0} [options]
 
-ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-LIBDIR = RbConfig::CONFIG['libdir']
-@libdir_basename = "lib" # shrug, ruby 2.0 won't work for me.
-INCLUDEDIR = RbConfig::CONFIG['includedir']
+    --disable-clean
+        Do not clean out intermediate files after successful build.
 
-if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'macruby'
-  $LIBRUBYARG_STATIC.gsub!(/-static/, '')
-end
+    --disable-static
+        Do not statically link bundled libraries.
 
-$CFLAGS << " #{ENV["CFLAGS"]}"
-$LIBS << " #{ENV["LIBS"]}"
+    --with-iconv-dir=DIR
+        Use the iconv library placed under DIR.
 
-windows_p = RbConfig::CONFIG['target_os'] == 'mingw32' || RbConfig::CONFIG['target_os'] =~ /mswin/
+    --with-zlib-dir=DIR
+        Use the zlib library placed under DIR.
 
-if windows_p
-  $CFLAGS << " -DXP_WIN -DXP_WIN32 -DUSE_INCLUDED_VASPRINTF"
-elsif RbConfig::CONFIG['target_os'] =~ /solaris/
-  $CFLAGS << " -DUSE_INCLUDED_VASPRINTF"
-else
-  $CFLAGS << " -g -DXP_UNIX"
-end
+    --use-system-libraries
+        Use system libraries intead of building and using the bundled
+        libraries.
+
+    --with-xml2-dir=DIR / --with-xml2-config=CONFIG
+    --with-xslt-dir=DIR / --with-xslt-config=CONFIG
+    --with-exslt-dir=DIR / --with-exslt-config=CONFIG
+        Use libxml2/libxslt/libexslt as specified.
 
-if RbConfig::MAKEFILE_CONFIG['CC'] =~ /mingw/
-  $CFLAGS << " -DIN_LIBXML"
-  $LIBS << " -lz" # TODO why is this necessary?
+    --enable-cross-build
+        Do cross-build.
+HELP
+  exit! 0
 end
 
-if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
-  $CFLAGS << " -O3" unless $CFLAGS[/-O\d/]
-  $CFLAGS << " -Wall -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline"
+def message!(important_message)
+  message important_message
+  if !$stdout.tty? && File.chardev?('/dev/tty')
+    File.open('/dev/tty', 'w') { |tty|
+      tty.print important_message
+    }
+  end
+rescue Errno::ENXIO
 end
 
-if windows_p
-  # I'm cross compiling!
-  HEADER_DIRS = [INCLUDEDIR]
-  LIB_DIRS = [LIBDIR]
-  XML2_HEADER_DIRS = [File.join(INCLUDEDIR, "libxml2"), INCLUDEDIR]
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
 
-else
-  if ENV['NOKOGIRI_USE_SYSTEM_LIBRARIES']
-    HEADER_DIRS = [
-      # First search /opt/local for macports
-      '/opt/local/include',
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+# Workaround for Ruby bug #8074, introduced in Ruby 2.0.0, fixed in Ruby 2.1.0
+# https://bugs.ruby-lang.org/issues/8074
+@libdir_basename = "lib" if RUBY_VERSION < '2.1.0'
+
+# Workaround for Ruby bug #9760, will be fixed in Ruby 2.2
+class Array
+  alias orig_or |
+
+  def | other
+    if self.equal?($DEFLIBPATH) && other.equal?($LIBPATH)
+      # Make sure library directories we set take precedence over $(libdir)
+      other.orig_or(self)
+    else
+      self.orig_or(other)
+    end
+  end
+end if RUBY_VERSION < '2.2.0'
 
-      # Then search /usr/local for people that installed from source
-      '/usr/local/include',
+if arg_config('--clean')
+  require 'pathname'
+  require 'fileutils'
 
-      # Check the ruby install locations
-      INCLUDEDIR,
+  root = Pathname(ROOT)
+  pwd  = Pathname(Dir.pwd)
 
-      # Finally fall back to /usr
-      '/usr/include',
-      '/usr/include/libxml2',
-    ]
+  # Skip if this is a development work tree
+  unless (root + '.git').exist?
+    message "Cleaning files only used during build.\n"
 
-    LIB_DIRS = [
-      # First search /opt/local for macports
-      '/opt/local/lib',
+    # (root + 'tmp') cannot be removed at this stage because
+    # nokogiri.so is yet to be copied to lib.
 
-      # Then search /usr/local for people that installed from source
-      '/usr/local/lib',
+    # clean the ports build directory
+    Pathname.glob(pwd.join('tmp', '*', 'ports')) { |dir|
+      FileUtils.rm_rf(dir, verbose: true)
+      FileUtils.rmdir(dir.parent, parents: true, verbose: true)
+    }
 
-      # Check the ruby install locations
-      LIBDIR,
+    if enable_config('static')
+      # ports installation can be safely removed if statically linked.
+      FileUtils.rm_rf(root + 'ports', verbose: true)
+    else
+      FileUtils.rm_rf(root + 'ports' + 'archives', verbose: true)
+    end
+  end
 
-      # Finally fall back to /usr
-      '/usr/lib',
-    ]
+  exit
+end
 
-    XML2_HEADER_DIRS = [
-      '/opt/local/include/libxml2',
-      '/usr/local/include/libxml2',
-      File.join(INCLUDEDIR, "libxml2")
-    ] + HEADER_DIRS
-
-    # If the user has homebrew installed, use the libxml2 inside homebrew
-    brew_prefix = `brew --prefix libxml2 2> /dev/null`.chomp
-    unless brew_prefix.empty?
-      LIB_DIRS.unshift File.join(brew_prefix, 'lib')
-      XML2_HEADER_DIRS.unshift File.join(brew_prefix, 'include/libxml2')
-    end
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'macruby'
+  $LIBRUBYARG_STATIC.gsub!(/-static/, '')
+end
 
-  else
-    require 'mini_portile'
-    require 'yaml'
+$CFLAGS << " #{ENV["CFLAGS"]}"
+$LIBS << " #{ENV["LIBS"]}"
 
-    common_recipe = lambda do |recipe|
-      recipe.target = File.join(ROOT, "ports")
-      recipe.files = ["ftp://ftp.xmlsoft.org/libxml2/#{recipe.name}-#{recipe.version}.tar.gz"]
+def preserving_globals
+  values = [
+    $arg_config,
+    $CFLAGS, $CPPFLAGS,
+    $LDFLAGS, $LIBPATH, $libs
+  ].map(&:dup)
+  yield
+ensure
+  $arg_config,
+  $CFLAGS, $CPPFLAGS,
+  $LDFLAGS, $LIBPATH, $libs =
+    values
+end
 
-      checkpoint = "#{recipe.target}/#{recipe.name}-#{recipe.version}-#{recipe.host}.installed"
-      unless File.exist?(checkpoint)
-        recipe.cook
-        FileUtils.touch checkpoint
-      end
-      recipe.activate
-    end
+def asplode(lib)
+  abort "-----\n#{lib} is missing.  please visit http://nokogiri.org/tutorials/installing_nokogiri.html for help with installing dependencies.\n-----"
+end
 
-    dependencies = YAML.load_file(File.join(ROOT, "dependencies.yml"))
+def have_iconv?
+  have_header('iconv.h') or return false
+  %w{ iconv_open libiconv_open }.any? do |method|
+    have_func(method, 'iconv.h') or
+      have_library('iconv', method, 'iconv.h')
+  end
+end
+
+def each_iconv_idir
+  # If --with-iconv-dir or --with-opt-dir is given, it should be
+  # the first priority
+  %w[iconv opt].each { |config|
+    idir = preserving_globals {
+      dir_config(config)
+    }.first and yield idir
+  }
+
+  # Try the system default
+  yield "/usr/include"
+
+  cflags, = preserving_globals {
+    pkg_config('libiconv')
+  }
+  if cflags
+    cflags.shellsplit.each { |arg|
+      arg.sub!(/\A-I/, '') and
+      yield arg
+    }
+  end
 
-    libxml2_recipe = MiniPortile.new("libxml2", dependencies["libxml2"]).tap do |recipe|
+  nil
+end
+
+def iconv_prefix
+  # Make sure libxml2 is built with iconv
+  each_iconv_idir { |idir|
+    next unless File.file?(File.join(idir, 'iconv.h'))
+
+    prefix, dir = File.split(idir)
+    next unless dir == 'include'
+
+    preserving_globals {
+      # Follow the way libxml2's configure uses a value given with
+      # --with-iconv[=DIR]
+      $CPPFLAGS = "-I#{idir}".quote << ' ' << $CPPFLAGS
+      $LIBPATH.unshift(File.join(prefix, "lib"))
+      have_iconv?
+    } and break prefix
+  } or asplode "libiconv"
+end
+
+def process_recipe(name, version, static_p, cross_p)
+  MiniPortile.new(name, version).tap do |recipe|
+    recipe.target = portsdir = File.join(ROOT, "ports")
+    # Prefer host_alias over host in order to use i586-mingw32msvc as
+    # correct compiler prefix for cross build, but use host if not set.
+    recipe.host = RbConfig::CONFIG["host_alias"].empty? ? RbConfig::CONFIG["host"] : RbConfig::CONFIG["host_alias"]
+    recipe.patch_files = Dir[File.join(portsdir, "patches", name, "*.patch")].sort
+
+    if static_p
+      recipe.configure_options = [
+        "--disable-shared",
+        "--enable-static",
+        "CFLAGS='-fPIC #{ENV["CFLAGS"]}'",
+      ]
+    else
       recipe.configure_options = [
         "--enable-shared",
         "--disable-static",
-        "--without-python",
-        "--without-readline",
-        "--with-c14n",
-        "--with-debug",
-        "--with-threads"
       ]
-      common_recipe.call recipe
     end
 
-    libxslt_recipe = MiniPortile.new("libxslt", dependencies["libxslt"]).tap do |recipe|
-      recipe.configure_options = [
-        "--enable-shared",
-        "--disable-static",
-        "--without-python",
-        "--without-crypto",
-        "--with-debug",
-        "--with-libxml-prefix=#{libxml2_recipe.path}"
+    if cross_p
+      recipe.configure_options += [
+        "--target=#{recipe.host}",
+        "--host=#{recipe.host}",
       ]
-      common_recipe.call recipe
     end
 
-    $LDFLAGS << " -Wl,-rpath,#{libxml2_recipe.path}/lib"
-    $LDFLAGS << " -Wl,-rpath,#{libxslt_recipe.path}/lib"
+    yield recipe
+
+    if recipe.patch_files.empty?
+      message! "Building #{name}-#{version} for nokogiri.\n"
+    else
+      message! "Building #{name}-#{version} for nokogiri with the following patches applied:\n"
+
+      recipe.patch_files.each { |patch|
+        message! "\t- %s\n" % File.basename(patch)
+      }
+    end
+
+    message! <<-"EOS"
+************************************************************************
+IMPORTANT!  Nokogiri builds and uses a packaged version of #{name}.
+
+If this is a concern for you and you want to use the system library
+instead, abort this installation process and reinstall nokogiri as
+follows:
+
+    gem install nokogiri -- --use-system-libraries
+
+If you are using Bundler, tell it to use the option:
+
+    bundle config build.nokogiri --use-system-libraries
+    bundle install
+    EOS
+
+    message! <<-"EOS" if name == 'libxml2'
+
+However, note that nokogiri does not necessarily support all versions
+of libxml2.
 
-    $CFLAGS << " -DNOKOGIRI_USE_PACKAGED_LIBRARIES -DNOKOGIRI_LIBXML2_PATH='\"#{libxml2_recipe.path}\"' -DNOKOGIRI_LIBXSLT_PATH='\"#{libxslt_recipe.path}\"'"
+For example, libxml2-2.9.0 and higher are currently known to be broken
+and thus unsupported by nokogiri, due to compatibility problems and
+XPath optimization bugs.
+    EOS
 
-    HEADER_DIRS = [libxml2_recipe, libxslt_recipe].map { |f| File.join(f.path, "include") }
-    LIB_DIRS = [libxml2_recipe, libxslt_recipe].map { |f| File.join(f.path, "lib") }
-    XML2_HEADER_DIRS = HEADER_DIRS + [File.join(libxml2_recipe.path, "include", "libxml2")]
+    message! <<-"EOS"
+************************************************************************
+    EOS
+
+    checkpoint = "#{recipe.target}/#{recipe.name}-#{recipe.version}-#{recipe.host}.installed"
+    unless File.exist?(checkpoint)
+      recipe.cook
+      FileUtils.touch checkpoint
+    end
+    recipe.activate
   end
 end
 
-dir_config('zlib', HEADER_DIRS, LIB_DIRS)
-dir_config('iconv', HEADER_DIRS, LIB_DIRS)
-dir_config('xml2', XML2_HEADER_DIRS, LIB_DIRS)
-dir_config('xslt', HEADER_DIRS, LIB_DIRS)
+case RbConfig::CONFIG['target_os']
+when 'mingw32', /mswin/
+  windows_p = true
+  $CFLAGS << " -DXP_WIN -DXP_WIN32 -DUSE_INCLUDED_VASPRINTF"
+when /solaris/
+  $CFLAGS << " -DUSE_INCLUDED_VASPRINTF"
+else
+  $CFLAGS << " -g -DXP_UNIX"
+end
 
-def asplode(lib)
-  abort "-----\n#{lib} is missing.  please visit http://nokogiri.org/tutorials/installing_nokogiri.html for help with installing dependencies.\n-----"
+if RUBY_PLATFORM =~ /mingw/i
+  # Work around a character escaping bug in MSYS by passing an arbitrary
+  # double quoted parameter to gcc. See https://sourceforge.net/p/mingw/bugs/2142
+  $CPPFLAGS << ' "-Idummypath"'
+end
+
+if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
+  $CFLAGS << " -O3" unless $CFLAGS[/-O\d/]
+  $CFLAGS << " -Wall -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline"
 end
 
-pkg_config('libxslt')
-pkg_config('libxml-2.0')
-pkg_config('libiconv')
+case
+when arg_config('--use-system-libraries', !!ENV['NOKOGIRI_USE_SYSTEM_LIBRARIES'])
+  message! "Building nokogiri using system libraries.\n"
 
-def have_iconv?
-  %w{ iconv_open libiconv_open }.any? do |method|
-    have_func(method, 'iconv.h') or
-      have_library('iconv', method, 'iconv.h') or
-      find_library('iconv', method, 'iconv.h')
+  dir_config('zlib')
+
+  # Using system libraries means we rely on the system libxml2 with
+  # regard to the iconv support.
+
+  dir_config('xml2').any?  or pkg_config('libxml-2.0')
+  dir_config('xslt').any?  or pkg_config('libxslt')
+  dir_config('exslt').any? or pkg_config('libexslt')
+
+  try_cpp(<<-SRC) or abort "libxml2 version 2.6.21 or later is required!"
+#include <libxml/xmlversion.h>
+
+#if LIBXML_VERSION < 20621
+#error libxml2 is too old
+#endif
+  SRC
+
+  try_cpp(<<-SRC) or warn "libxml2 version 2.9.0 and later is not yet supported, but proceeding anyway."
+#include <libxml/xmlversion.h>
+
+#if LIBXML_VERSION >= 20900
+#error libxml2 is too new
+#endif
+  SRC
+else
+  message! "Building nokogiri using packaged libraries.\n"
+
+  require 'mini_portile'
+  require 'yaml'
+
+  static_p = enable_config('static', true) or
+    message! "Static linking is disabled.\n"
+
+  dir_config('zlib')
+
+  dependencies = YAML.load_file(File.join(ROOT, "dependencies.yml"))
+
+  cross_build_p = enable_config("cross-build")
+  if cross_build_p || windows_p
+    zlib_recipe = process_recipe("zlib", dependencies["zlib"], static_p, cross_build_p) do |recipe|
+      recipe.files = ["http://zlib.net/#{recipe.name}-#{recipe.version}.tar.gz"]
+      class << recipe
+        attr_accessor :cross_build_p
+
+        def configure
+          Dir.chdir work_path do
+            mk = File.read 'win32/Makefile.gcc'
+            File.open 'win32/Makefile.gcc', 'wb' do |f|
+              f.puts "BINARY_PATH = #{path}/bin"
+              f.puts "LIBRARY_PATH = #{path}/lib"
+              f.puts "INCLUDE_PATH = #{path}/include"
+              mk.sub!(/^PREFIX\s*=\s*$/, "PREFIX = #{host}-") if cross_build_p
+              f.puts mk
+            end
+          end
+        end
+
+        def configured?
+          Dir.chdir work_path do
+            !! (File.read('win32/Makefile.gcc') =~ /^BINARY_PATH/)
+          end
+        end
+
+        def compile
+          execute "compile", "make -f win32/Makefile.gcc"
+        end
+
+        def install
+          execute "install", "make -f win32/Makefile.gcc install"
+        end
+      end
+      recipe.cross_build_p = cross_build_p
+    end
+
+    libiconv_recipe = process_recipe("libiconv", dependencies["libiconv"], static_p, cross_build_p) do |recipe|
+      recipe.files = ["http://ftp.gnu.org/pub/gnu/libiconv/#{recipe.name}-#{recipe.version}.tar.gz"]
+      recipe.configure_options += [
+        "CPPFLAGS='-Wall'",
+        "CFLAGS='-O2 -g'",
+        "CXXFLAGS='-O2 -g'",
+        "LDFLAGS="
+      ]
+    end
   end
-end
 
-asplode "libxml2"  unless find_header('libxml/parser.h')
-asplode "libxslt"  unless find_header('libxslt/xslt.h')
-asplode "libexslt" unless find_header('libexslt/exslt.h')
-asplode "libiconv" unless have_iconv?
-asplode "libxml2"  unless find_library("xml2", 'xmlParseDoc')
-asplode "libxslt"  unless find_library("xslt", 'xsltParseStylesheetDoc')
-asplode "libexslt" unless find_library("exslt", 'exsltFuncRegister')
+  libxml2_recipe = process_recipe("libxml2", dependencies["libxml2"], static_p, cross_build_p) do |recipe|
+    recipe.files = ["ftp://ftp.xmlsoft.org/libxml2/#{recipe.name}-#{recipe.version}.tar.gz"]
+    recipe.configure_options += [
+      "--without-python",
+      "--without-readline",
+      "--with-iconv=#{libiconv_recipe ? libiconv_recipe.path : iconv_prefix}",
+      "--with-c14n",
+      "--with-debug",
+      "--with-threads"
+    ]
+  end
 
-unless have_func('xmlHasFeature')
-  abort "-----\nThe function 'xmlHasFeature' is missing from your installation of libxml2.  Likely this means that your installed version of libxml2 is old enough that nokogiri will not work well.  To get around this problem, please upgrade your installation of libxml2.
+  libxslt_recipe = process_recipe("libxslt", dependencies["libxslt"], static_p, cross_build_p) do |recipe|
+    recipe.files = ["ftp://ftp.xmlsoft.org/libxml2/#{recipe.name}-#{recipe.version}.tar.gz"]
+    recipe.configure_options += [
+      "--without-python",
+      "--without-crypto",
+      "--with-debug",
+      "--with-libxml-prefix=#{libxml2_recipe.path}"
+    ]
+  end
 
-Please visit http://nokogiri.org/tutorials/installing_nokogiri.html for more help!"
+  $CFLAGS << ' ' << '-DNOKOGIRI_USE_PACKAGED_LIBRARIES'
+  $LIBPATH = ["#{zlib_recipe.path}/lib"] | $LIBPATH if zlib_recipe
+  $LIBPATH = ["#{libiconv_recipe.path}/lib"] | $LIBPATH if libiconv_recipe
+
+  have_lzma = preserving_globals {
+    have_library('lzma')
+  }
+
+  $libs = $libs.shellsplit.tap { |libs|
+    [libxml2_recipe, libxslt_recipe].each { |recipe|
+      libname = recipe.name[/\Alib(.+)\z/, 1]
+      File.join(recipe.path, "bin", "#{libname}-config").tap { |config|
+        # call config scripts explicit with 'sh' for compat with Windows
+        $CPPFLAGS = `sh #{config} --cflags`.strip << ' ' << $CPPFLAGS
+        `sh #{config} --libs`.strip.shellsplit.each { |arg|
+          case arg
+          when /\A-L(.+)\z/
+            # Prioritize ports' directories
+            if $1.start_with?(ROOT + '/')
+              $LIBPATH = [$1] | $LIBPATH
+            else
+              $LIBPATH = $LIBPATH | [$1]
+            end
+          when /\A-l./
+            libs.unshift(arg)
+          else
+            $LDFLAGS << ' ' << arg.shellescape
+          end
+        }
+      }
+
+      $CPPFLAGS << ' ' << "-DNOKOGIRI_#{recipe.name.upcase}_PATH=\"#{recipe.path}\"".shellescape
+
+      case libname
+      when 'xml2'
+        # xslt-config --libs or pkg-config libxslt --libs does not include
+        # -llzma, so we need to add it manually when linking statically.
+        if static_p && have_lzma
+          # Add it at the end; GH #988
+          libs << '-llzma'
+        end
+      when 'xslt'
+        # xslt-config does not have a flag to emit options including
+        # -lexslt, so add it manually.
+        libs.unshift('-lexslt')
+      end
+    }
+  }.shelljoin
+
+  if static_p
+    message 'checking for linker flags for static linking... '
+
+    case
+    when try_link('int main(void) { return 0; }',
+                  ['-Wl,-Bstatic', '-lxml2', '-Wl,-Bdynamic'].shelljoin)
+      message "-Wl,-Bstatic\n"
+
+      $libs = $libs.shellsplit.flat_map { |arg|
+        case arg
+        when '-lxml2', '-lxslt', '-lexslt'
+          ['-Wl,-Bstatic', arg, '-Wl,-Bdynamic']
+        else
+          arg
+        end
+      }.shelljoin
+    else
+      message "NONE\n"
+    end
+  end
 end
 
-have_func 'xmlFirstElementChild'
+{
+  "xml2"  => ['xmlParseDoc',            'libxml/parser.h'],
+  "xslt"  => ['xsltParseStylesheetDoc', 'libxslt/xslt.h'],
+  "exslt" => ['exsltFuncRegister',      'libexslt/exslt.h'],
+}.each { |lib, (func, header)|
+  have_func(func, header) ||
+  have_library(lib, func, header) ||
+  have_library("lib#{lib}", func, header) or
+    asplode("lib#{lib}")
+}
+
+have_func('xmlHasFeature') or abort "xmlHasFeature() is missing."
+have_func('xmlFirstElementChild')
 have_func('xmlRelaxNGSetParserStructuredErrors')
 have_func('xmlRelaxNGSetParserStructuredErrors')
 have_func('xmlRelaxNGSetValidStructuredErrors')
@@ -192,4 +481,16 @@ end
 
 create_makefile('nokogiri/nokogiri')
 
+if enable_config('clean', true)
+  # Do not clean if run in a development work tree.
+  File.open('Makefile', 'at') { |mk|
+    mk.print <<EOF
+all: clean-ports
+
+clean-ports: $(DLLIB)
+	-$(Q)$(RUBY) $(srcdir)/extconf.rb --clean --#{static_p ? 'enable' : 'disable'}-static
+EOF
+  }
+end
+
 # :startdoc: