tiny_tds 1.0.4 → 3.2.0

data/ext/tiny_tds/extconf.rb

@@ -1,329 +1,190 @@
-ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
-
-# :stopdoc:
-
-require 'mkmf'
-require 'fileutils'
-
-# The gem version constraint in the gemspec is not respected at install time.
-# Keep this version in sync with the one in the gemspec !
-gem 'mini_portile2', '~> 2.0'
-require 'mini_portile2'
-require_relative './extconsts'
-
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-
-# Shamelessly copied from nokogiri
-#
-
-def do_help
-  print <<HELP
-usage: ruby #{$0} [options]
-
-    --enable-system-freetds / --disable-system-freetds
-    --enable-system-iconv   / --disable-system-iconv
-    --enable-system-openssl / --disable-system-openssl
-      Force use of system or builtin freetds/iconv/openssl library.
-      Default is to prefer system libraries and fallback to builtin.
-
-    --with-freetds-dir=DIR
-      Use the freetds library placed under DIR.
-
-    --enable-lookup
-      Search for freetds through all paths in the PATH environment variable.
-
-    --disable-openssl
-      Disable OpenSSL for freetds build. No effect on system-freetds.
-
-    --enable-gnutls
-      Use GnuTLS instead of OpenSSL for freetds build.
-
-    --enable-cross-build
-      Do cross-build.
-HELP
-  exit! 0
-end
-
-do_help if arg_config('--help')
-
-FREETDSDIR = ENV['FREETDS_DIR']
-
-if FREETDSDIR.nil? || FREETDSDIR.empty?
-  LIBDIR     = RbConfig::CONFIG['libdir']
-  INCLUDEDIR = RbConfig::CONFIG['includedir']
-else
-  puts "Will use #{FREETDSDIR}"
-  LIBDIR = "#{FREETDSDIR}/lib"
-  INCLUDEDIR = "#{FREETDSDIR}/include"
-end
-
-$CFLAGS  << " #{ENV["CFLAGS"]}"
-$LDFLAGS << " #{ENV["LDFLAGS"]}"
-$LIBS    << " #{ENV["LIBS"]}"
-
-SEARCHABLE_PATHS = begin
-  eop_regexp = /#{File::SEPARATOR}bin$/
-  paths = ENV['PATH']
-  paths = paths.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
-  paths = paths.split(File::PATH_SEPARATOR)
-  bin_paths = paths.select{ |p| p =~ eop_regexp }
-  bin_paths.map{ |p| p.sub(eop_regexp,'') }.compact.reject{ |p| p.empty? }.uniq
+require "mkmf"
+require_relative "extconsts"
+
+if ENV["MAINTAINER_MODE"]
+  warn "Maintainer mode enabled."
+  $CFLAGS << # standard:disable Style/GlobalVars
+    " -Wall" \
+    " -ggdb" \
+    " -DDEBUG" \
+    " -pedantic"
+  $LDFLAGS << # standard:disable Style/GlobalVars
+    " -ggdb"
 end
 
-def searchable_paths_with_directories(*directories)
-  SEARCHABLE_PATHS.map do |path|
-    directories.map do |paths|
-      dir = File.join path, *paths
-      File.directory?(dir) ? dir : nil
-    end.flatten.compact
-  end.flatten.compact
-end
+if (gem_platform = with_config("cross-build"))
+  require "mini_portile2"
 
-class BuildRecipe < MiniPortile
-  def initialize(name, version, files)
-    super(name, version)
-    self.files = files
-    self.target = File.expand_path('../../../ports', __FILE__)
-    self.host = consolidated_host(RbConfig::CONFIG["host"])
-    self.patch_files = Dir[File.join(self.target, "patches", self.name, self.version, "*.diff")].sort
-  end
+  openssl_platform = with_config("openssl-platform")
 
-  def consolidated_host(name)
-     # Host name and prefix of build tools are different on Windows 32 bit.
-    name.gsub('i686-pc-mingw32', 'i686-w64-mingw32')
-  end
+  class BuildRecipe < MiniPortile
+    attr_accessor :gem_platform
 
-  def configure_defaults
-    [
-      "--host=#{host}",    # build for specific target (host)
-      "--disable-static",
-      "--enable-shared",
-    ]
-  end
-
-  # Use the same path for all recipes, so that only one include/lib path is required.
-  def port_path
-    "#{target}/#{host}"
-  end
-
-  # We use the same port_path for all recipes. That breaks the standard installed? method.
-  def installed?
-    false
-  end
+    def initialize(name, version, files)
+      super(name, version)
+      self.files = files
+      rootdir = File.expand_path("../../..", __FILE__)
+      self.target = File.join(rootdir, "ports")
+      self.patch_files = Dir[File.join("patches", self.name, self.version, "*.patch")].sort
+    end
 
-  # When using rake-compiler-dock on Windows, the underlying Virtualbox shared
-  # folders don't support symlinks, but libiconv expects it for a build on
-  # Linux. We work around this limitation by using the temp dir for cooking.
-  def chdir_for_build
-    build_dir = ENV['RCD_HOST_RUBY_PLATFORM'].to_s =~ /mingw|mswin|cygwin/ ? '/tmp' : '.'
-    Dir.chdir(build_dir) do
-      yield
+    # this will yield all ports into the same directory, making our path configuration for the linker easier
+    def port_path
+      "#{@target}/#{gem_platform}"
     end
-  end
 
-  def cook_and_activate
-    checkpoint = File.join(self.target, "#{self.name}-#{self.version}-#{self.host}.installed")
-    unless File.exist?(checkpoint)
-      chdir_for_build do
-        self.cook
+    def cook_and_activate
+      checkpoint = File.join(target, "#{name}-#{version}-#{gem_platform}.installed")
+
+      unless File.exist?(checkpoint)
+        cook
+        FileUtils.touch checkpoint
       end
-      FileUtils.touch checkpoint
+
+      activate
+      self
     end
-    self.activate
-    self
   end
-end
 
-def define_libssl_recipe(host)
-  BuildRecipe.new("openssl", OPENSSL_VERSION, [OPENSSL_SOURCE_URI]).tap do |recipe|
+  openssl_recipe = BuildRecipe.new("openssl", OPENSSL_VERSION, [OPENSSL_SOURCE_URI]).tap do |recipe|
     class << recipe
-      def extract_file(file, target)
-        filename = File.basename(file)
-        FileUtils.mkdir_p target
-
-        message "Extracting #{filename} into #{target}... "
-        result = `#{tar_exe} #{tar_compression_switch(filename)}xf "#{file}" -C "#{target}" 2>&1`
-        if $?.success?
-          output "OK"
-        else
-          # tar on windows returns error exit code, because it can not extract symlinks
-          output "ERROR (ignored)"
-        end
-      end
+      attr_accessor :openssl_platform
 
       def configure
-        config = if host=~/mingw/
-          host=~/x86_64/ ? 'mingw64' : 'mingw'
-        end
-        args = [ "CFLAGS=-DDSO_WIN32",
-            "./Configure",
-            "no-shared",
-            configure_prefix,
-            config,
-          ]
-        args.unshift("CROSS_COMPILE=#{host}-") if enable_config("cross-build")
-
-        execute "configure", "sh -c \"#{args.join(" ")}\""
+        envs = []
+        envs << "CFLAGS=-DDSO_WIN32 -DOPENSSL_THREADS" if MiniPortile.windows?
+        envs << "CFLAGS=-fPIC -DOPENSSL_THREADS" if MiniPortile.linux?
+        execute("configure", ["env", *envs, "./Configure", openssl_platform, "threads", "-static", "CROSS_COMPILE=#{host}-", configure_prefix, "--libdir=lib"], altlog: "config.log")
       end
 
       def compile
-        super
-        # OpenSSL DLLs are called "libeay32.dll" and "ssleay32.dll" per default,
-        # regardless to the version. This is best suited to meet the Windows DLL hell.
-        # To avoid any conflicts we do a static build and build DLLs afterwards,
-        # with our own naming scheme.
-        execute "mkdef-libeay32", "(perl util/mkdef.pl 32 libeay >libeay32.def)"
-        execute "mkdef-ssleay32", "(perl util/mkdef.pl 32 ssleay >ssleay32.def)"
-        dllwrap = consolidated_host(RbConfig::CONFIG["DLLWRAP"])
-        execute "dllwrap-libeay32", "#{dllwrap} --dllname libeay32-#{version}-#{host}.dll --output-lib libcrypto.dll.a --def libeay32.def libcrypto.a -lwsock32 -lgdi32 -lcrypt32"
-        execute "dllwrap-ssleay32", "#{dllwrap} --dllname ssleay32-#{version}-#{host}.dll --output-lib libssl.dll.a --def ssleay32.def libssl.a libcrypto.dll.a"
+        execute("compile", "#{make_cmd} build_libs")
       end
 
       def install
-        super
-        FileUtils.cp "#{work_path}/libeay32-#{version}-#{host}.dll", "#{path}/bin/"
-        FileUtils.cp "#{work_path}/ssleay32-#{version}-#{host}.dll", "#{path}/bin/"
-        FileUtils.cp "#{work_path}/libcrypto.dll.a", "#{path}/lib/"
-        FileUtils.cp "#{work_path}/libssl.dll.a", "#{path}/lib/"
+        execute("install", "#{make_cmd} install_dev")
       end
     end
+
+    recipe.gem_platform = gem_platform
+    recipe.openssl_platform = openssl_platform
+    recipe.cook_and_activate
   end
-end
 
-def define_libiconv_recipe(host)
-  BuildRecipe.new("libiconv", ICONV_VERSION, [ICONV_SOURCE_URI]).tap do |recipe|
-    # always produce position independent code
-    recipe.configure_options << "CFLAGS=-fPIC"
+  libiconv_recipe = BuildRecipe.new("libiconv", ICONV_VERSION, [ICONV_SOURCE_URI]).tap do |recipe|
+    recipe.configure_options << "CFLAGS=-fPIC" if MiniPortile.linux?
+    recipe.gem_platform = gem_platform
+
+    recipe.cook_and_activate
   end
-end
 
-def define_freetds_recipe(host, libiconv, libssl, gnutls)
-  BuildRecipe.new("freetds", FREETDS_VERSION, [FREETDS_SOURCE_URI]).tap do |recipe|
-    with_tdsver = FREETDS_VERSION =~ /0\.91/ ? "--with-tdsver=7.1" : "--with-tdsver=7.3"
-    for_windows = recipe.host =~ /mswin|mingw/i
-    recipe.configure_options << '--with-pic'
-    recipe.configure_options << "--with-libiconv-prefix=#{libiconv.path}" if libiconv
-    if true == libssl
-      recipe.configure_options << "--with-openssl"
-    elsif libssl
-      recipe.configure_options << "--with-openssl=#{libssl.path}"
-    end
-    recipe.configure_options << "--with-gnutls" if gnutls
-    recipe.configure_options << '--sysconfdir=C:\Sites' if for_windows
-    recipe.configure_options << '--enable-sspi' if for_windows
-    recipe.configure_options << "--disable-odbc"
-    recipe.configure_options << with_tdsver
-    if libiconv
-      # For some reason freetds doesn't honor --with-libiconv-prefix
-      # so we have do add it by hand:
-      recipe.configure_options << "CFLAGS=-I#{libiconv.path}/include"
-      recipe.configure_options << "LDFLAGS=-L#{libiconv.path}/lib -liconv"
-    end
+  # remove the ".la" files, otherwise libtool starts to complain when linking into FreeTDS
+  Dir.glob(File.join(libiconv_recipe.path, "lib", "**", "*.la")).each do |la_file|
+    File.delete(la_file)
+  end
 
+  freetds_recipe = BuildRecipe.new("freetds", FREETDS_VERSION, [FREETDS_SOURCE_URI]).tap do |recipe|
     class << recipe
-
-      def install
-        super_value = super
-        # Install binstub target binaries.
-        if super_value
-          bin_path = File.expand_path File.join(path, 'bin')
-          exe_path = File.expand_path File.join(target, '..', 'exe')
-          return unless File.directory?(bin_path)
-          ['tsql', 'defncopy'].each do |bin|
-            ['.exe', ''].each do |ext|
-              exe = File.join bin_path, "#{bin}#{ext}"
-              next unless File.exists?(exe)
-              next unless File.executable?(exe)
-              FileUtils.cp exe, exe_path
-            end
-          end
-        end
-        super_value
+      def configure_defaults
+        [
+          "--host=#{@host}",
+          "--enable-shared",
+          "--disable-static",
+          "--disable-odbc"
+        ]
       end
+    end
 
+    # i am not 100% what is going on behind the scenes
+    # it seems that FreeTDS build system prefers OPENSSL_CFLAGS and OPENSSL_LIBS
+    # but the linker still relies on LIBS and CPPFLAGS
+    # removing one or the other leads to build failures in any case of FreeTDS
+    if MiniPortile.linux?
+      recipe.configure_options << "CFLAGS=-fPIC"
+    elsif MiniPortile.windows?
+      recipe.configure_options << "--enable-sspi"
     end
 
+    # pass an additional runtime path to the linker so defncopy and tsql can find our shared sybdb
+    recipe.configure_options << "LDFLAGS=-L#{openssl_recipe.path}/lib #{"-Wl,-rpath='$$ORIGIN/../lib'" if MiniPortile.linux?}"
+    recipe.configure_options << "LIBS=-liconv -lssl -lcrypto #{"-lwsock32 -lgdi32 -lws2_32 -lcrypt32" if MiniPortile.windows?} #{"-ldl -lpthread" if MiniPortile.linux?}"
+    recipe.configure_options << "CPPFLAGS=-I#{openssl_recipe.path}/include"
+
+    recipe.configure_options << "OPENSSL_CFLAGS=-L#{openssl_recipe.path}/lib"
+    recipe.configure_options << "OPENSSL_LIBS=-lssl -lcrypto #{"-lwsock32 -lgdi32 -lws2_32 -lcrypt32" if MiniPortile.windows?} #{"-ldl -lpthread" if MiniPortile.linux?}"
+
+    recipe.configure_options << "--with-openssl=#{openssl_recipe.path}"
+    recipe.configure_options << "--with-libiconv-prefix=#{libiconv_recipe.path}"
+    recipe.configure_options << "--sysconfdir=C:/Sites" if MiniPortile.windows?
+
+    recipe.gem_platform = gem_platform
+    recipe.cook_and_activate
   end
-end
 
-if RbConfig::CONFIG['target_os'] =~ /mswin32|mingw32/
-  lib_prefix = 'lib' unless RbConfig::CONFIG['target_os'] =~ /mingw32/
-  # There's no default include/lib dir on Windows. Let's just add the Ruby ones
-  # and resort on the search path specified by INCLUDE and LIB environment
-  # variables
-  HEADER_DIRS = [INCLUDEDIR]
-  LIB_DIRS = [LIBDIR]
+  # enable relative path to later load the FreeTDS shared library
+  $LDFLAGS << " '-Wl,-rpath=$$ORIGIN/../../../ports/#{gem_platform}/lib'" # standard:disable Style/GlobalVars
+
+  dir_config("freetds", "#{freetds_recipe.path}/include", "#{freetds_recipe.path}/lib")
 else
-  lib_prefix = ''
-  HEADER_DIRS = [
-    # First search /opt/local for macports
-    '/opt/local/include',
-    # Then search /usr/local for people that installed from source
-    '/usr/local/include',
-    # Check the ruby install locations
-    INCLUDEDIR,
-    # Finally fall back to /usr
-    '/usr/include'
-  ].reject{ |dir| !File.directory?(dir) }
-  LIB_DIRS = [
-    # First search /opt/local for macports
-    '/opt/local/lib',
-    # Then search /usr/local for people that installed from source
-    '/usr/local/lib',
-    # Check the ruby install locations
-    LIBDIR,
-    # Finally fall back to /usr
-    '/usr/lib',
-  ].reject{ |dir| !File.directory?(dir) }
-end
+  # Make sure to check the ports path for the configured host
+  architecture = RbConfig::CONFIG["arch"]
+
+  project_dir = File.expand_path("../../..", __FILE__)
+  freetds_ports_dir = File.join(project_dir, "ports", architecture, "freetds", FREETDS_VERSION)
+  freetds_ports_dir = File.expand_path(freetds_ports_dir)
+
+  # Add all the special path searching from the original tiny_tds build
+  # order is important here! First in, first searched.
+  DIRS = %w[
+    /opt/local
+    /usr/local
+  ]
+
+  if /darwin/i.match?(RbConfig::CONFIG["host_os"])
+    # Ruby below 2.7 seems to label the host CPU on Apple Silicon as aarch64
+    # 2.7 and above print is as ARM64
+    target_host_cpu = (Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7")) ? "aarch64" : "arm64"
+
+    if RbConfig::CONFIG["host_cpu"] == target_host_cpu
+      # Homebrew on Apple Silicon installs into /opt/hombrew
+      # https://docs.brew.sh/Installation
+      # On Intel Macs, it is /usr/local, so no changes necessary to DIRS
+      DIRS.unshift("/opt/homebrew")
+    end
+  end
 
-FREETDS_HEADER_DIRS = (searchable_paths_with_directories(['include'],['include','freetds']) + HEADER_DIRS).uniq
-FREETDS_LIB_DIRS = (searchable_paths_with_directories(['lib'],['lib','freetds']) + LIB_DIRS).uniq
+  if ENV["RI_DEVKIT"] && ENV["MINGW_PREFIX"] # RubyInstaller Support
+    DIRS.unshift(File.join(ENV["RI_DEVKIT"], ENV["MINGW_PREFIX"]))
+  end
 
-# lookup over searchable paths is great for native compilation, however, when
-# cross compiling we need to specify our own paths.
-if enable_config("lookup", true)
-  dir_config('freetds', FREETDS_HEADER_DIRS, FREETDS_LIB_DIRS)
-else
-  dir_config('freetds')
+  # Add the ports directory if it exists for local developer builds
+  DIRS.unshift(freetds_ports_dir) if File.directory?(freetds_ports_dir)
 
-  # remove LDFLAGS
-  $LDFLAGS = ENV.fetch("LDFLAGS", "")
-end
+  # Grab freetds environment variable for use by people on services like
+  # Heroku who they can't easily use bundler config to set directories
+  DIRS.unshift(ENV["FREETDS_DIR"]) if ENV.has_key?("FREETDS_DIR")
 
-def asplode(lib)
-  msg = "-----\n"
-  msg << "#{lib} is missing.\n"
-  msg << "Do you have FreeTDS 0.95.80 or higher installed?\n" if lib == 'freetds'
-  msg << "-----"
-  abort(msg)
-end
+  # Add the search paths for freetds configured above
+  ldirs = DIRS.flat_map do |path|
+    ldir = "#{path}/lib"
+    [ldir, "#{ldir}/freetds"]
+  end
 
-def freetds_usable?(lib_prefix)
-  have_header('sybfront.h') && have_header('sybdb.h') &&
-    find_library("#{lib_prefix}sybdb", 'tdsdbopen') &&
-    find_library("#{lib_prefix}sybdb", 'dbanydatecrack')
-end
+  idirs = DIRS.flat_map do |path|
+    idir = "#{path}/include"
+    [idir, "#{idir}/freetds"]
+  end
 
-# We use freetds, when available already, and fallback to compilation of ports
-system_freetds = enable_config('system-freetds', ENV['TINYTDS_SKIP_PORTS'] || freetds_usable?(lib_prefix))
-
-# We expect to have iconv and OpenSSL available on non-Windows systems
-host = RbConfig::CONFIG["host"]
-system_iconv = enable_config('system-iconv', host =~ /mingw|mswin/ ? false : true)
-system_openssl = enable_config('system-openssl', host =~ /mingw|mswin/ ? false : true )
-enable_gnutls = enable_config('gnutls', false )
-enable_openssl = enable_config('openssl', !enable_gnutls )
-
-unless system_freetds
-  libssl = define_libssl_recipe(host).cook_and_activate unless system_openssl
-  libiconv = define_libiconv_recipe(host).cook_and_activate unless system_iconv
-  freetds = define_freetds_recipe(host, libiconv, libssl || enable_openssl, enable_gnutls).cook_and_activate
-  dir_config('freetds', freetds.path + "/include", freetds.path + "/lib")
+  puts "looking for freetds headers in the following directories:\n#{idirs.map { |a| " - #{a}\n" }.join}"
+  puts "looking for freetds library in the following directories:\n#{ldirs.map { |a| " - #{a}\n" }.join}"
+  dir_config("freetds", idirs, ldirs)
 end
 
-asplode 'freetds'  unless freetds_usable?(lib_prefix)
+find_header("sybfront.h") or abort "Can't find the 'sybfront.h' header"
+find_header("sybdb.h") or abort "Can't find the 'sybdb.h' header"
 
-create_makefile('tiny_tds/tiny_tds')
+unless have_library("sybdb", "dbanydatecrack")
+  abort "Failed! Do you have FreeTDS 1.0.0 or higher installed?"
+end
 
-# :startdoc:
+create_makefile("tiny_tds/tiny_tds")

data/ext/tiny_tds/extconsts.rb

@@ -1,15 +1,8 @@
-
-ICONV_VERSION = ENV['TINYTDS_ICONV_VERSION'] || "1.14"
+ICONV_VERSION = ENV["TINYTDS_ICONV_VERSION"] || "1.18"
 ICONV_SOURCE_URI = "http://ftp.gnu.org/pub/gnu/libiconv/libiconv-#{ICONV_VERSION}.tar.gz"
 
-OPENSSL_VERSION = ENV['TINYTDS_OPENSSL_VERSION'] || '1.0.2g'
+OPENSSL_VERSION = ENV["TINYTDS_OPENSSL_VERSION"] || "3.4.0"
 OPENSSL_SOURCE_URI = "https://www.openssl.org/source/openssl-#{OPENSSL_VERSION}.tar.gz"
 
-FREETDS_VERSION = ENV['TINYTDS_FREETDS_VERSION'] || "1.00"
-FREETDS_VERSION_INFO = Hash.new { |h,k|
-  h[k] = {files: "ftp://ftp.freetds.org/pub/freetds/stable/freetds-#{k}.tar.bz2"}
-}
-FREETDS_VERSION_INFO['1.00'] = {files: 'ftp://ftp.freetds.org/pub/freetds/stable/freetds-1.00.tar.bz2'}
-FREETDS_VERSION_INFO['0.99'] = {files: 'ftp://ftp.freetds.org/pub/freetds/current/freetds-dev.0.99.678.tar.gz'}
-FREETDS_VERSION_INFO['0.95'] = {files: 'ftp://ftp.freetds.org/pub/freetds/stable/freetds-0.95.92.tar.gz'}
-FREETDS_SOURCE_URI = FREETDS_VERSION_INFO[FREETDS_VERSION][:files]
+FREETDS_VERSION = ENV["TINYTDS_FREETDS_VERSION"] || "1.4.26"
+FREETDS_SOURCE_URI = "http://www.freetds.org/files/stable/freetds-#{FREETDS_VERSION}.tar.bz2"