mysql2 0.3.10 → 0.5.3

data/ext/mysql2/client.h

@@ -1,42 +1,28 @@
 #ifndef MYSQL2_CLIENT_H
 #define MYSQL2_CLIENT_H
 
-/*
- * partial emulation of the 1.9 rb_thread_blocking_region under 1.8,
- * this is enough for dealing with blocking I/O functions in the
- * presence of threads.
- */
-#ifndef HAVE_RB_THREAD_BLOCKING_REGION
-
-#include <rubysig.h>
-#define RUBY_UBF_IO ((rb_unblock_function_t *)-1)
-typedef void rb_unblock_function_t(void *);
-typedef VALUE rb_blocking_function_t(void *);
-static VALUE
-rb_thread_blocking_region(
-  rb_blocking_function_t *func, void *data1,
-  RB_MYSQL_UNUSED rb_unblock_function_t *ubf,
-  RB_MYSQL_UNUSED void *data2)
-{
-  VALUE rv;
-
-  TRAP_BEG;
-  rv = func(data1);
-  TRAP_END;
-
-  return rv;
-}
-
-#endif /* ! HAVE_RB_THREAD_BLOCKING_REGION */
-
-void init_mysql2_client();
-
 typedef struct {
   VALUE encoding;
-  int active;
+  VALUE active_thread; /* rb_thread_current() or Qnil */
+  long server_version;
   int reconnect_enabled;
+  unsigned int connect_timeout;
+  int active;
+  int automatic_close;
+  int initialized;
+  int refcount;
   int closed;
   MYSQL *client;
 } mysql_client_wrapper;
 
-#endif
+void rb_mysql_client_set_active_thread(VALUE self);
+void rb_mysql_set_server_query_flags(MYSQL *client, VALUE result);
+
+#define GET_CLIENT(self) \
+  mysql_client_wrapper *wrapper; \
+  Data_Get_Struct(self, mysql_client_wrapper, wrapper);
+
+void init_mysql2_client(void);
+void decr_mysql2_client(mysql_client_wrapper *wrapper);
+
+#endif

data/ext/mysql2/extconf.rb

@@ -1,73 +1,264 @@
-# encoding: UTF-8
 require 'mkmf'
+require 'English'
 
-def asplode lib
-  abort "-----\n#{lib} is missing.  please check your installation of mysql and try again.\n-----"
+def asplode(lib)
+  if RUBY_PLATFORM =~ /mingw|mswin/
+    abort "-----\n#{lib} is missing. Check your installation of MySQL or Connector/C, and try again.\n-----"
+  elsif RUBY_PLATFORM =~ /darwin/
+    abort "-----\n#{lib} is missing. You may need to 'brew install mysql' or 'port install mysql', and try again.\n-----"
+  else
+    abort "-----\n#{lib} is missing. You may need to 'sudo apt-get install libmariadb-dev', 'sudo apt-get install libmysqlclient-dev' or 'sudo yum install mysql-devel', and try again.\n-----"
+  end
 end
 
-# 1.9-only
-have_func('rb_thread_blocking_region')
+def add_ssl_defines(header)
+  all_modes_found = %w[SSL_MODE_DISABLED SSL_MODE_PREFERRED SSL_MODE_REQUIRED SSL_MODE_VERIFY_CA SSL_MODE_VERIFY_IDENTITY].inject(true) do |m, ssl_mode|
+    m && have_const(ssl_mode, header)
+  end
+  $CFLAGS << ' -DFULL_SSL_MODE_SUPPORT' if all_modes_found
+  # if we only have ssl toggle (--ssl,--disable-ssl) from 5.7.3 to 5.7.10
+  has_no_support = all_modes_found ? false : !have_const('MYSQL_OPT_SSL_ENFORCE', header)
+  $CFLAGS << ' -DNO_SSL_MODE_SUPPORT' if has_no_support
+end
+
+# 2.1+
+have_func('rb_absint_size')
+have_func('rb_absint_singlebit_p')
+
+# Missing in RBX (https://github.com/rubinius/rubinius/issues/3771)
 have_func('rb_wait_for_single_fd')
 
 # borrowed from mysqlplus
 # http://github.com/oldmoe/mysqlplus/blob/master/ext/extconf.rb
-dirs = ENV['PATH'].split(File::PATH_SEPARATOR) + %w[
+dirs = ENV.fetch('PATH').split(File::PATH_SEPARATOR) + %w[
   /opt
   /opt/local
   /opt/local/mysql
-  /opt/local/lib/mysql5
+  /opt/local/lib/mysql5*
   /usr
+  /usr/mysql
   /usr/local
   /usr/local/mysql
   /usr/local/mysql-*
-  /usr/local/lib/mysql5
-].map{|dir| "#{dir}/bin" }
+  /usr/local/lib/mysql5*
+  /usr/local/opt/mysql5*
+].map { |dir| dir << '/bin' }
 
-GLOB = "{#{dirs.join(',')}}/{mysql_config,mysql_config5}"
+# For those without HOMEBREW_ROOT in PATH
+dirs << "#{ENV['HOMEBREW_ROOT']}/bin" if ENV['HOMEBREW_ROOT']
 
-if RUBY_PLATFORM =~ /mswin|mingw/
-  inc, lib = dir_config('mysql')
-  exit 1 unless have_library("libmysql")
-elsif mc = (with_config('mysql-config') || Dir[GLOB].first) then
+GLOB = "{#{dirs.join(',')}}/{mysql_config,mysql_config5,mariadb_config}".freeze
+
+# If the user has provided a --with-mysql-dir argument, we must respect it or fail.
+inc, lib = dir_config('mysql')
+if inc && lib
+  # Ruby versions below 2.0 on Unix and below 2.1 on Windows
+  # do not properly search for lib directories, and must be corrected:
+  # https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39717
+  unless lib && lib[-3, 3] == 'lib'
+    @libdir_basename = 'lib'
+    inc, lib = dir_config('mysql')
+  end
+  abort "-----\nCannot find include dir(s) #{inc}\n-----" unless inc && inc.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
+  abort "-----\nCannot find library dir(s) #{lib}\n-----" unless lib && lib.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
+  warn "-----\nUsing --with-mysql-dir=#{File.dirname inc}\n-----"
+  rpath_dir = lib
+  have_library('mysqlclient')
+elsif (mc = (with_config('mysql-config') || Dir[GLOB].first))
+  # If the user has provided a --with-mysql-config argument, we must respect it or fail.
+  # If the user gave --with-mysql-config with no argument means we should try to find it.
   mc = Dir[GLOB].first if mc == true
-  cflags = `#{mc} --cflags`.chomp
-  exit 1 if $? != 0
+  abort "-----\nCannot find mysql_config at #{mc}\n-----" unless mc && File.exist?(mc)
+  abort "-----\nCannot execute mysql_config at #{mc}\n-----" unless File.executable?(mc)
+  warn "-----\nUsing mysql_config at #{mc}\n-----"
+  ver = `#{mc} --version`.chomp.to_f
+  includes = `#{mc} --include`.chomp
+  abort unless $CHILD_STATUS.success?
   libs = `#{mc} --libs_r`.chomp
-  if libs.empty?
-    libs = `#{mc} --libs`.chomp
-  end
-  exit 1 if $? != 0
-  $CPPFLAGS += ' ' + cflags
+  # MySQL 5.5 and above already have re-entrant code in libmysqlclient (no _r).
+  libs = `#{mc} --libs`.chomp if ver >= 5.5 || libs.empty?
+  abort unless $CHILD_STATUS.success?
+  $INCFLAGS += ' ' + includes
   $libs = libs + " " + $libs
+  rpath_dir = libs
 else
-  inc, lib = dir_config('mysql', '/usr/local')
-  libs = ['m', 'z', 'socket', 'nsl', 'mygcc']
-  while not find_library('mysqlclient', 'mysql_query', lib, "#{lib}/mysql") do
-    exit 1 if libs.empty?
-    have_library(libs.shift)
-  end
+  _, usr_local_lib = dir_config('mysql', '/usr/local')
+
+  asplode("mysql client") unless find_library('mysqlclient', nil, usr_local_lib, "#{usr_local_lib}/mysql")
+
+  rpath_dir = usr_local_lib
 end
 
-if have_header('mysql.h') then
+if have_header('mysql.h')
   prefix = nil
-elsif have_header('mysql/mysql.h') then
+elsif have_header('mysql/mysql.h')
   prefix = 'mysql'
 else
   asplode 'mysql.h'
 end
 
-%w{ errmsg.h mysqld_error.h }.each do |h|
-  header = [prefix, h].compact.join '/'
-  asplode h unless have_header h
+%w[errmsg.h].each do |h|
+  header = [prefix, h].compact.join('/')
+  asplode h unless have_header header
 end
 
-unless RUBY_PLATFORM =~ /mswin/ or RUBY_PLATFORM =~ /sparc/
-  $CFLAGS << ' -Wall -funroll-loops'
+mysql_h = [prefix, 'mysql.h'].compact.join('/')
+add_ssl_defines(mysql_h)
+have_struct_member('MYSQL', 'net.vio', mysql_h)
+have_struct_member('MYSQL', 'net.pvio', mysql_h)
+
+# These constants are actually enums, so they cannot be detected by #ifdef in C code.
+have_const('MYSQL_ENABLE_CLEARTEXT_PLUGIN', mysql_h)
+have_const('SERVER_QUERY_NO_GOOD_INDEX_USED', mysql_h)
+have_const('SERVER_QUERY_NO_INDEX_USED', mysql_h)
+have_const('SERVER_QUERY_WAS_SLOW', mysql_h)
+have_const('MYSQL_OPTION_MULTI_STATEMENTS_ON', mysql_h)
+have_const('MYSQL_OPTION_MULTI_STATEMENTS_OFF', mysql_h)
+
+# my_bool is replaced by C99 bool in MySQL 8.0, but we want
+# to retain compatibility with the typedef in earlier MySQLs.
+have_type('my_bool', mysql_h)
+
+# This is our wishlist. We use whichever flags work on the host.
+# -Wall and -Wextra are included by default.
+wishlist = [
+  '-Weverything',
+  '-Wno-bad-function-cast', # rb_thread_call_without_gvl returns void * that we cast to VALUE
+  '-Wno-conditional-uninitialized', # false positive in client.c
+  '-Wno-covered-switch-default', # result.c -- enum_field_types (when fully covered, e.g. mysql 5.5)
+  '-Wno-declaration-after-statement', # GET_CLIENT followed by GET_STATEMENT in statement.c
+  '-Wno-disabled-macro-expansion', # rubby :(
+  '-Wno-documentation-unknown-command', # rubby :(
+  '-Wno-missing-field-initializers', # gperf generates bad code
+  '-Wno-missing-variable-declarations', # missing symbols due to ruby native ext initialization
+  '-Wno-padded', # mysql :(
+  '-Wno-reserved-id-macro', # rubby :(
+  '-Wno-sign-conversion', # gperf generates bad code
+  '-Wno-static-in-inline', # gperf generates bad code
+  '-Wno-switch-enum', # result.c -- enum_field_types (when not fully covered, e.g. mysql 5.6+)
+  '-Wno-undef', # rubinius :(
+  '-Wno-unreachable-code', # rubby :(
+  '-Wno-used-but-marked-unused', # rubby :(
+]
+
+usable_flags = wishlist.select do |flag|
+  try_link('int main() {return 0;}',  "-Werror #{flag}")
 end
-# $CFLAGS << ' -O0 -ggdb3 -Wextra'
 
-if hard_mysql_path = $libs[%r{-L(/[^ ]+)}, 1]
-	$LDFLAGS << " -Wl,-rpath,#{hard_mysql_path}"
+$CFLAGS << ' ' << usable_flags.join(' ')
+
+enabled_sanitizers = disabled_sanitizers = []
+# Specify a commna-separated list of sanitizers, or try them all by default
+sanitizers = with_config('sanitize')
+case sanitizers
+when true
+  # Try them all, turn on whatever we can
+  enabled_sanitizers = %w[address cfi integer memory thread undefined].select do |s|
+    try_link('int main() {return 0;}',  "-Werror -fsanitize=#{s}")
+  end
+  abort "-----\nCould not enable any sanitizers!\n-----" if enabled_sanitizers.empty?
+when String
+  # Figure out which sanitizers are supported
+  enabled_sanitizers, disabled_sanitizers = sanitizers.split(',').partition do |s|
+    try_link('int main() {return 0;}',  "-Werror -fsanitize=#{s}")
+  end
+end
+
+unless disabled_sanitizers.empty?
+  abort "-----\nCould not enable requested sanitizers: #{disabled_sanitizers.join(',')}\n-----"
+end
+
+unless enabled_sanitizers.empty?
+  warn "-----\nEnabling sanitizers: #{enabled_sanitizers.join(',')}\n-----"
+  enabled_sanitizers.each do |s|
+    # address sanitizer requires runtime support
+    if s == 'address' # rubocop:disable Style/IfUnlessModifier
+      have_library('asan') || $LDFLAGS << ' -fsanitize=address'
+    end
+    $CFLAGS << " -fsanitize=#{s}"
+  end
+  # Options for line numbers in backtraces
+  $CFLAGS << ' -g -fno-omit-frame-pointer'
+end
+
+if RUBY_PLATFORM =~ /mswin|mingw/ && !defined?(RubyInstaller)
+  # Build libmysql.a interface link library
+  require 'rake'
+
+  # Build libmysql.a interface link library
+  # Use rake to rebuild only if these files change
+  deffile = File.expand_path('../../../support/libmysql.def', __FILE__)
+  libfile = File.expand_path(File.join(rpath_dir, 'libmysql.lib'))
+  file 'libmysql.a' => [deffile, libfile] do
+    when_writing 'building libmysql.a' do
+      # Ruby kindly shows us where dllwrap is, but that tool does more than we want.
+      # Maybe in the future Ruby could provide RbConfig::CONFIG['DLLTOOL'] directly.
+      dlltool = RbConfig::CONFIG['DLLWRAP'].gsub('dllwrap', 'dlltool')
+      sh dlltool, '--kill-at',
+         '--dllname', 'libmysql.dll',
+         '--output-lib', 'libmysql.a',
+         '--input-def', deffile, libfile
+    end
+  end
+
+  Rake::Task['libmysql.a'].invoke
+  $LOCAL_LIBS << ' ' << 'libmysql.a'
+
+  # Make sure the generated interface library works (if cross-compiling, trust without verifying)
+  unless RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+    abort "-----\nCannot find libmysql.a\n-----" unless have_library('libmysql')
+    abort "-----\nCannot link to libmysql.a (my_init)\n-----" unless have_func('my_init')
+  end
+
+  # Vendor libmysql.dll
+  vendordir = File.expand_path('../../../vendor/', __FILE__)
+  directory vendordir
+
+  vendordll = File.join(vendordir, 'libmysql.dll')
+  dllfile = File.expand_path(File.join(rpath_dir, 'libmysql.dll'))
+  file vendordll => [dllfile, vendordir] do
+    when_writing 'copying libmysql.dll' do
+      cp dllfile, vendordll
+    end
+  end
+
+  # Copy libmysql.dll to the local vendor directory by default
+  if arg_config('--no-vendor-libmysql')
+    # Fine, don't.
+    puts "--no-vendor-libmysql"
+  else # Default: arg_config('--vendor-libmysql')
+    # Let's do it!
+    Rake::Task[vendordll].invoke
+  end
+else
+  case explicit_rpath = with_config('mysql-rpath')
+  when true
+    abort "-----\nOption --with-mysql-rpath must have an argument\n-----"
+  when false
+    warn "-----\nOption --with-mysql-rpath has been disabled at your request\n-----"
+  when String
+    # The user gave us a value so use it
+    rpath_flags = " -Wl,-rpath,#{explicit_rpath}"
+    warn "-----\nSetting mysql rpath to #{explicit_rpath}\n-----"
+    $LDFLAGS << rpath_flags
+  else
+    if (libdir = rpath_dir[%r{(-L)?(/[^ ]+)}, 2])
+      rpath_flags = " -Wl,-rpath,#{libdir}"
+      if RbConfig::CONFIG["RPATHFLAG"].to_s.empty? && try_link('int main() {return 0;}', rpath_flags)
+        # Usually Ruby sets RPATHFLAG the right way for each system, but not on OS X.
+        warn "-----\nSetting rpath to #{libdir}\n-----"
+        $LDFLAGS << rpath_flags
+      else
+        if RbConfig::CONFIG["RPATHFLAG"].to_s.empty?
+          # If we got here because try_link failed, warn the user
+          warn "-----\nDon't know how to set rpath on your system, if MySQL libraries are not in path mysql2 may not load\n-----"
+        end
+        # Make sure that LIBPATH gets set if we didn't explicitly set the rpath.
+        warn "-----\nSetting libpath to #{libdir}\n-----"
+        $LIBPATH << libdir unless $LIBPATH.include?(libdir)
+      end
+    end
+  end
 end
 
 create_makefile('mysql2/mysql2')

data/ext/mysql2/infile.c

@@ -0,0 +1,122 @@
+#include <mysql2_ext.h>
+
+#include <errno.h>
+#ifndef _MSC_VER
+#include <unistd.h>
+#endif
+#include <fcntl.h>
+
+#define ERROR_LEN 1024
+typedef struct
+{
+  int fd;
+  char *filename;
+  char error[ERROR_LEN];
+  mysql_client_wrapper *wrapper;
+} mysql2_local_infile_data;
+
+/* MySQL calls this function when a user begins a LOAD DATA LOCAL INFILE query.
+ *
+ * Allocate a data struct and pass it back through the data pointer.
+ *
+ * Returns:
+ * 0 on success
+ * 1 on error
+ */
+static int
+mysql2_local_infile_init(void **ptr, const char *filename, void *userdata)
+{
+  mysql2_local_infile_data *data = malloc(sizeof(mysql2_local_infile_data));
+  if (!data) return 1;
+
+  *ptr = data;
+  data->error[0] = 0;
+  data->wrapper = userdata;
+
+  data->filename = strdup(filename);
+  if (!data->filename) {
+    snprintf(data->error, ERROR_LEN, "%s: %s", strerror(errno), filename);
+    return 1;
+  }
+
+  data->fd = open(filename, O_RDONLY);
+  if (data->fd < 0) {
+    snprintf(data->error, ERROR_LEN, "%s: %s", strerror(errno), filename);
+    return 1;
+  }
+
+  return 0;
+}
+
+/* MySQL calls this function to read data from the local file.
+ *
+ * Returns:
+ * > 0   number of bytes read
+ * == 0  end of file
+ * < 0   error
+ */
+static int
+mysql2_local_infile_read(void *ptr, char *buf, unsigned int buf_len)
+{
+  int count;
+  mysql2_local_infile_data *data = (mysql2_local_infile_data *)ptr;
+
+  count = (int)read(data->fd, buf, buf_len);
+  if (count < 0) {
+    snprintf(data->error, ERROR_LEN, "%s: %s", strerror(errno), data->filename);
+  }
+
+  return count;
+}
+
+/* MySQL calls this function when we're done with the LOCAL INFILE query.
+ *
+ * ptr will be null if the init function failed.
+ */
+static void
+mysql2_local_infile_end(void *ptr)
+{
+  mysql2_local_infile_data *data = (mysql2_local_infile_data *)ptr;
+  if (data) {
+    if (data->fd >= 0)
+      close(data->fd);
+    if (data->filename)
+      free(data->filename);
+    free(data);
+  }
+}
+
+/* MySQL calls this function if any of the functions above returned an error.
+ *
+ * This function is called even if init failed, with whatever ptr value
+ * init has set, regardless of the return value of the init function.
+ *
+ * Returns:
+ * Error message number (see http://dev.mysql.com/doc/refman/5.0/en/error-messages-client.html)
+ */
+static int
+mysql2_local_infile_error(void *ptr, char *error_msg, unsigned int error_msg_len)
+{
+  mysql2_local_infile_data *data = (mysql2_local_infile_data *) ptr;
+
+  if (data) {
+    snprintf(error_msg, error_msg_len, "%s", data->error);
+    return CR_UNKNOWN_ERROR;
+  }
+
+  snprintf(error_msg, error_msg_len, "Out of memory");
+  return CR_OUT_OF_MEMORY;
+}
+
+/* Tell MySQL Client to use our own local_infile functions.
+ * This is both due to bugginess in the default handlers,
+ * and to improve the Rubyness of the handlers here.
+ */
+void mysql2_set_local_infile(MYSQL *mysql, void *userdata)
+{
+  mysql_set_local_infile_handler(mysql,
+                                 mysql2_local_infile_init,
+                                 mysql2_local_infile_read,
+                                 mysql2_local_infile_end,
+                                 mysql2_local_infile_error, userdata);
+}

data/ext/mysql2/infile.h

@@ -0,0 +1 @@
+void mysql2_set_local_infile(MYSQL *mysql, void *userdata);

data/ext/mysql2/mysql2_ext.c

@@ -1,12 +1,14 @@
 #include <mysql2_ext.h>
 
-VALUE mMysql2, cMysql2Error;
+VALUE mMysql2, cMysql2Error, cMysql2TimeoutError;
 
 /* Ruby Extension initializer */
 void Init_mysql2() {
   mMysql2      = rb_define_module("Mysql2");
   cMysql2Error = rb_const_get(mMysql2, rb_intern("Error"));
+  cMysql2TimeoutError = rb_const_get(cMysql2Error, rb_intern("TimeoutError"));
 
   init_mysql2_client();
   init_mysql2_result();
+  init_mysql2_statement();
 }

data/ext/mysql2/mysql2_ext.h

@@ -1,42 +1,44 @@
 #ifndef MYSQL2_EXT
 #define MYSQL2_EXT
 
-// tell rbx not to use it's caching compat layer
-// by doing this we're making a promize to RBX that
-// we'll never modify the pointers we get back from RSTRING_PTR
+void Init_mysql2(void);
+
+/* tell rbx not to use it's caching compat layer
+   by doing this we're making a promise to RBX that
+   we'll never modify the pointers we get back from RSTRING_PTR */
 #define RSTRING_NOT_MODIFIED
 #include <ruby.h>
-#include <fcntl.h>
-
-#ifndef HAVE_UINT
-#define HAVE_UINT
-typedef unsigned short    ushort;
-typedef unsigned int    uint;
-#endif
 
 #ifdef HAVE_MYSQL_H
 #include <mysql.h>
-#include <mysql_com.h>
 #include <errmsg.h>
-#include <mysqld_error.h>
 #else
 #include <mysql/mysql.h>
-#include <mysql/mysql_com.h>
 #include <mysql/errmsg.h>
-#include <mysql/mysqld_error.h>
 #endif
 
-#ifdef HAVE_RUBY_ENCODING_H
 #include <ruby/encoding.h>
-#endif
+#include <ruby/thread.h>
 
 #if defined(__GNUC__) && (__GNUC__ >= 3)
+#define RB_MYSQL_NORETURN __attribute__ ((noreturn))
 #define RB_MYSQL_UNUSED __attribute__ ((unused))
 #else
+#define RB_MYSQL_NORETURN
 #define RB_MYSQL_UNUSED
 #endif
 
+/* MySQL 8.0 replaces my_bool with C99 bool. Earlier versions of MySQL had
+ * a typedef to char. Gem users reported failures on big endian systems when
+ * using C99 bool types with older MySQLs due to mismatched behavior. */
+#ifndef HAVE_TYPE_MY_BOOL
+#include <stdbool.h>
+typedef bool my_bool;
+#endif
+
 #include <client.h>
+#include <statement.h>
 #include <result.h>
+#include <infile.h>
 
 #endif