mysql2 0.5.0 → 0.5.5

data/ext/mysql2/extconf.rb

@@ -1,13 +1,15 @@
 require 'mkmf'
 require 'English'
 
+### Some helper functions
+
 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 'apt-get install libmysqlclient-dev' or 'yum install mysql-devel', and try again.\n-----"
+    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
 
@@ -15,19 +17,57 @@ 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
+  if all_modes_found
+    $CFLAGS << ' -DFULL_SSL_MODE_SUPPORT'
+  else
+    # if we only have ssl toggle (--ssl,--disable-ssl) from 5.7.3 to 5.7.10
+    # and the verify server cert option. This is also the case for MariaDB.
+    has_verify_support  = have_const('MYSQL_OPT_SSL_VERIFY_SERVER_CERT', header)
+    has_enforce_support = have_const('MYSQL_OPT_SSL_ENFORCE', header)
+    $CFLAGS << ' -DNO_SSL_MODE_SUPPORT' if !has_verify_support && !has_enforce_support
+  end
 end
 
+### Check for Ruby C extention interfaces
+
 # 2.1+
 have_func('rb_absint_size')
 have_func('rb_absint_singlebit_p')
 
+# 2.7+
+have_func('rb_gc_mark_movable')
+
 # Missing in RBX (https://github.com/rubinius/rubinius/issues/3771)
 have_func('rb_wait_for_single_fd')
 
+# 3.0+
+have_func('rb_enc_interned_str', 'ruby.h')
+
+### Find OpenSSL library
+
+# User-specified OpenSSL if explicitly specified
+if with_config('openssl-dir')
+  _, lib = dir_config('openssl')
+  if 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'
+      _, lib = dir_config('openssl')
+    end
+    abort "-----\nCannot find library dir(s) #{lib}\n-----" unless lib && lib.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
+    warn "-----\nUsing --with-openssl-dir=#{File.dirname lib}\n-----"
+    $LDFLAGS << " -L#{lib}"
+  end
+# Homebrew OpenSSL on MacOS
+elsif RUBY_PLATFORM =~ /darwin/ && system('command -v brew')
+  openssl_location = `brew --prefix openssl`.strip
+  $LDFLAGS << " -L#{openssl_location}/lib" if openssl_location
+end
+
+### Find MySQL client library
+
 # borrowed from mysqlplus
 # http://github.com/oldmoe/mysqlplus/blob/master/ext/extconf.rb
 dirs = ENV.fetch('PATH').split(File::PATH_SEPARATOR) + %w[
@@ -35,6 +75,7 @@ dirs = ENV.fetch('PATH').split(File::PATH_SEPARATOR) + %w[
   /opt/local
   /opt/local/mysql
   /opt/local/lib/mysql5*
+  /opt/homebrew/opt/mysql*
   /usr
   /usr/mysql
   /usr/local
@@ -42,6 +83,9 @@ dirs = ENV.fetch('PATH').split(File::PATH_SEPARATOR) + %w[
   /usr/local/mysql-*
   /usr/local/lib/mysql5*
   /usr/local/opt/mysql5*
+  /usr/local/opt/mysql@*
+  /usr/local/opt/mysql-client
+  /usr/local/opt/mysql-client@*
 ].map { |dir| dir << '/bin' }
 
 # For those without HOMEBREW_ROOT in PATH
@@ -63,6 +107,7 @@ if inc && lib
   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.
@@ -107,6 +152,7 @@ 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_DEFAULT_AUTH', mysql_h)
 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)
@@ -118,10 +164,13 @@ have_const('MYSQL_OPTION_MULTI_STATEMENTS_OFF', mysql_h)
 # to retain compatibility with the typedef in earlier MySQLs.
 have_type('my_bool', mysql_h)
 
+### Compiler flags to help catch errors
+
 # This is our wishlist. We use whichever flags work on the host.
 # -Wall and -Wextra are included by default.
 wishlist = [
   '-Weverything',
+  '-Wno-compound-token-split-by-macro', # Fixed in Ruby 2.7+ at https://bugs.ruby-lang.org/issues/17865
   '-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)
@@ -146,8 +195,10 @@ end
 
 $CFLAGS << ' ' << usable_flags.join(' ')
 
+### Sanitizers to help with debugging -- many are available on both Clang/LLVM and GCC
+
 enabled_sanitizers = disabled_sanitizers = []
-# Specify a commna-separated list of sanitizers, or try them all by default
+# Specify a comma-separated list of sanitizers, or try them all by default
 sanitizers = with_config('sanitize')
 case sanitizers
 when true
@@ -163,7 +214,7 @@ when String
   end
 end
 
-unless disabled_sanitizers.empty?
+unless disabled_sanitizers.empty? # rubocop:disable Style/IfUnlessModifier
   abort "-----\nCould not enable requested sanitizers: #{disabled_sanitizers.join(',')}\n-----"
 end
 
@@ -180,6 +231,8 @@ unless enabled_sanitizers.empty?
   $CFLAGS << ' -g -fno-omit-frame-pointer'
 end
 
+### Find MySQL Client on Windows, set RPATH to find the library at runtime
+
 if RUBY_PLATFORM =~ /mswin|mingw/ && !defined?(RubyInstaller)
   # Build libmysql.a interface link library
   require 'rake'

data/ext/mysql2/mysql2_ext.c

@@ -4,9 +4,14 @@ VALUE mMysql2, cMysql2Error, cMysql2TimeoutError;
 
 /* Ruby Extension initializer */
 void Init_mysql2() {
-  mMysql2      = rb_define_module("Mysql2");
+  mMysql2 = rb_define_module("Mysql2");
+  rb_global_variable(&mMysql2);
+
   cMysql2Error = rb_const_get(mMysql2, rb_intern("Error"));
+  rb_global_variable(&cMysql2Error);
+
   cMysql2TimeoutError = rb_const_get(cMysql2Error, rb_intern("TimeoutError"));
+  rb_global_variable(&cMysql2TimeoutError);
 
   init_mysql2_client();
   init_mysql2_result();

data/ext/mysql2/mysql2_ext.h

@@ -36,6 +36,19 @@ void Init_mysql2(void);
 typedef bool my_bool;
 #endif
 
+// ruby 2.7+
+#ifdef HAVE_RB_GC_MARK_MOVABLE
+#define rb_mysql2_gc_location(ptr) ptr = rb_gc_location(ptr)
+#else
+#define rb_gc_mark_movable(ptr) rb_gc_mark(ptr)
+#define rb_mysql2_gc_location(ptr)
+#endif
+
+// ruby 2.2+
+#ifdef TypedData_Make_Struct
+#define NEW_TYPEDDATA_WRAPPER 1
+#endif
+
 #include <client.h>
 #include <statement.h>
 #include <result.h>

data/ext/mysql2/mysql_enc_name_to_ruby.h

@@ -30,7 +30,7 @@ error "gperf generated tables don't work with this execution character set. Plea
 #endif
 
 struct mysql2_mysql_enc_name_to_rb_map { const char *name; const char *rb_name; };
-/* maximum key range = 66, duplicates = 0 */
+/* maximum key range = 71, duplicates = 0 */
 
 #ifdef __GNUC__
 __inline
@@ -46,32 +46,32 @@ mysql2_mysql_enc_name_to_rb_hash (str, len)
 {
   static const unsigned char asso_values[] =
     {
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 40,  5,
-       0, 69,  0, 40, 25, 20, 10, 55, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 35,  5,  0,
-      10,  0, 20,  0,  5,  5, 69,  0, 10, 15,
-       0,  0, 69, 69, 25,  5,  5,  0, 69, 30,
-      69,  0, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69, 69, 69, 69, 69,
-      69, 69, 69, 69, 69, 69
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 15,  5,
+       0, 74,  5, 25, 40, 10, 20, 50, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 40,  5,  0,
+      15, 10,  0,  0,  0,  5, 74,  0, 25,  5,
+       0,  5, 74, 74, 20,  5,  5,  0, 74, 45,
+      74,  0, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74, 74, 74, 74, 74,
+      74, 74, 74, 74, 74, 74
     };
   return len + asso_values[(unsigned char)str[2]] + asso_values[(unsigned char)str[0]] + asso_values[(unsigned char)str[len - 1]];
 }
@@ -89,11 +89,11 @@ mysql2_mysql_enc_name_to_rb (str, len)
 {
   enum
     {
-      TOTAL_KEYWORDS = 39,
+      TOTAL_KEYWORDS = 41,
       MIN_WORD_LENGTH = 3,
       MAX_WORD_LENGTH = 8,
       MIN_HASH_VALUE = 3,
-      MAX_HASH_VALUE = 68
+      MAX_HASH_VALUE = 73
     };
 
   static const struct mysql2_mysql_enc_name_to_rb_map wordlist[] =
@@ -101,54 +101,58 @@ mysql2_mysql_enc_name_to_rb (str, len)
       {""}, {""}, {""},
       {"gbk", "GBK"},
       {""},
-      {"greek", "ISO-8859-7"},
+      {"utf32", "UTF-32"},
       {"gb2312", "GB2312"},
       {"keybcs2", NULL},
       {""},
       {"ucs2", "UTF-16BE"},
       {"koi8u", "KOI8-R"},
       {"binary", "ASCII-8BIT"},
-      {"eucjpms", "eucJP-ms"},
-      {""},
+      {"utf8mb4", "UTF-8"},
+      {"macroman", "macRoman"},
       {"ujis", "eucJP-ms"},
-      {"cp852", "CP852"},
+      {"greek", "ISO-8859-7"},
       {"cp1251", "Windows-1251"},
-      {"geostd8", NULL},
+      {"utf16le", "UTF-16LE"},
       {""},
       {"sjis", "Shift_JIS"},
       {"macce", "macCentEuro"},
-      {"latin2", "ISO-8859-2"},
+      {"cp1257", "Windows-1257"},
+      {"eucjpms", "eucJP-ms"},
+      {""},
+      {"utf8", "UTF-8"},
+      {"cp852", "CP852"},
+      {"cp1250", "Windows-1250"},
+      {"gb18030", "GB18030"},
       {""},
-      {"macroman", "macRoman"},
-      {"dec8", NULL},
-      {"utf32", "UTF-32"},
-      {"latin1", "ISO-8859-1"},
-      {"utf8mb4", "UTF-8"},
-      {"hp8", NULL},
       {"swe7", NULL},
+      {"koi8r", "KOI8-R"},
+      {"tis620", "TIS-620"},
+      {"geostd8", NULL},
+      {""},
+      {"big5", "Big5"},
       {"euckr", "EUC-KR"},
-      {"cp1257", "Windows-1257"},
+      {"latin2", "ISO-8859-2"},
       {""}, {""},
-      {"utf8", "UTF-8"},
-      {"koi8r", "KOI8-R"},
-      {"cp1256", "Windows-1256"},
-      {""}, {""}, {""},
-      {"cp866", "IBM866"},
+      {"dec8", NULL},
+      {"cp850", "CP850"},
+      {"latin1", "ISO-8859-1"},
+      {""},
+      {"hp8", NULL},
+      {""},
+      {"utf16", "UTF-16"},
       {"latin7", "ISO-8859-13"},
       {""}, {""}, {""},
       {"ascii", "US-ASCII"},
-      {"hebrew", "ISO-8859-8"},
-      {""}, {""},
-      {"big5", "Big5"},
-      {"utf16", "UTF-16"},
-      {"cp1250", "Windows-1250"},
-      {""}, {""}, {""},
-      {"cp850", "CP850"},
-      {"tis620", "TIS-620"},
+      {"cp1256", "Windows-1256"},
       {""}, {""}, {""},
       {"cp932", "Windows-31J"},
+      {"hebrew", "ISO-8859-8"},
+      {""}, {""}, {""}, {""},
       {"latin5", "ISO-8859-9"},
-      {""}, {""}, {""}, {""}, {""}, {""},
+      {""}, {""}, {""},
+      {"cp866", "IBM866"},
+      {""}, {""}, {""}, {""}, {""}, {""}, {""},
       {"armscii8", NULL}
     };
 

data/ext/mysql2/mysql_enc_to_ruby.h

@@ -54,13 +54,13 @@ static const char *mysql2_mysql_enc_to_rb[] = {
   "macRoman",
   "UTF-16",
   "UTF-16",
-  "",
+  "UTF-16LE",
   "Windows-1256",
   "Windows-1257",
   "Windows-1257",
   "UTF-32",
   "UTF-32",
-  "",
+  "UTF-16LE",
   "ASCII-8BIT",
   NULL,
   "US-ASCII",
@@ -74,7 +74,7 @@ static const char *mysql2_mysql_enc_to_rb[] = {
   NULL,
   "KOI8-R",
   "KOI8-R",
-  NULL,
+  "UTF-8",
   "ISO-8859-2",
   "ISO-8859-9",
   "ISO-8859-13",
@@ -245,5 +245,66 @@ static const char *mysql2_mysql_enc_to_rb[] = {
   "UTF-8",
   "UTF-8",
   "UTF-8",
+  "UTF-8",
+  "GB18030",
+  "GB18030",
+  "GB18030",
+  NULL,
+  NULL,
+  NULL,
+  NULL,
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  NULL,
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  NULL,
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  NULL,
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  NULL,
+  "UTF-8",
+  NULL,
+  NULL,
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
+  "UTF-8",
   "UTF-8"
 };