mysql2 0.1.9 → 0.2.0

data/ext/mysql2/client.h

@@ -0,0 +1,40 @@
+#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;
+  short int active;
+  MYSQL client;
+} mysql_client_wrapper;
+
+#endif

data/ext/mysql2/extconf.rb

@@ -10,7 +10,7 @@ have_func('rb_thread_blocking_region')
 
 # borrowed from mysqlplus
 # http://github.com/oldmoe/mysqlplus/blob/master/ext/extconf.rb
-dirs = ENV['PATH'].split(':') + %w[
+dirs = ENV['PATH'].split(File::PATH_SEPARATOR) + %w[
   /opt
   /opt/local
   /opt/local/mysql
@@ -24,7 +24,7 @@ dirs = ENV['PATH'].split(':') + %w[
 
 GLOB = "{#{dirs.join(',')}}/{mysql_config,mysql_config5}"
 
-if /mswin32/ =~ RUBY_PLATFORM
+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
@@ -57,7 +57,9 @@ end
   asplode h unless have_header h
 end
 
-$CFLAGS << ' -Wall -Wextra -funroll-loops'
-# $CFLAGS << ' -O0 -ggdb3'
+unless RUBY_PLATFORM =~ /mswin/
+  $CFLAGS << ' -Wall -funroll-loops'
+end
+# $CFLAGS << ' -O0 -ggdb3 -Wextra'
 
 create_makefile('mysql2/mysql2')

data/ext/mysql2/mysql2_ext.c

@@ -1,496 +1,12 @@
 #include <mysql2_ext.h>
 
-VALUE mMysql2, cMysql2Client;
-VALUE cMysql2Error, intern_encoding_from_charset;
-ID sym_id, sym_version, sym_async;
-
-#define REQUIRE_OPEN_DB(_ctxt) \
-  if(!_ctxt->net.vio) { \
-    rb_raise(cMysql2Error, "closed MySQL connection"); \
-    return Qnil; \
-  }
-
-/*
- * non-blocking mysql_*() functions that we won't be wrapping since
- * they do not appear to hit the network nor issue any interruptible
- * or blocking system calls.
- *
- * - mysql_affected_rows()
- * - mysql_error()
- * - mysql_fetch_fields()
- * - mysql_fetch_lengths() - calls cli_fetch_lengths or emb_fetch_lengths
- * - mysql_field_count()
- * - mysql_get_client_info()
- * - mysql_get_client_version()
- * - mysql_get_server_info()
- * - mysql_get_server_version()
- * - mysql_insert_id()
- * - mysql_num_fields()
- * - mysql_num_rows()
- * - mysql_options()
- * - mysql_real_escape_string()
- * - mysql_ssl_set()
- */
-
-static VALUE rb_raise_mysql2_error(MYSQL *client) {
-  VALUE e = rb_exc_new2(cMysql2Error, mysql_error(client));
-  rb_funcall(e, rb_intern("error_number="), 1, INT2NUM(mysql_errno(client)));
-  rb_funcall(e, rb_intern("sql_state="), 1, rb_tainted_str_new2(mysql_sqlstate(client)));
-  rb_exc_raise(e);
-  return Qnil;
-}
-
-static VALUE nogvl_init(void *ptr) {
-  MYSQL * client = (MYSQL *)ptr;
-
-  /* may initialize embedded server and read /etc/services off disk */
-  mysql_init(client);
-
-  return client ? Qtrue : Qfalse;
-}
-
-static VALUE nogvl_connect(void *ptr) {
-  struct nogvl_connect_args *args = ptr;
-  MYSQL *client;
-
-  client = mysql_real_connect(args->mysql, args->host,
-                              args->user, args->passwd,
-                              args->db, args->port, args->unix_socket,
-                              args->client_flag);
-
-  return client ? Qtrue : Qfalse;
-}
-
-static void rb_mysql_client_free(void * ptr) {
-  MYSQL * client = (MYSQL *)ptr;
-
-  /*
-   * we'll send a QUIT message to the server, but that message is more of a
-   * formality than a hard requirement since the socket is getting shutdown
-   * anyways, so ensure the socket write does not block our interpreter
-   */
-  int fd = client->net.fd;
-  int flags;
-
-  if (fd >= 0) {
-    /*
-     * if the socket is dead we have no chance of blocking,
-     * so ignore any potential fcntl errors since they don't matter
-     */
-    flags = fcntl(fd, F_GETFL);
-    if (flags > 0 && !(flags & O_NONBLOCK))
-      fcntl(fd, F_SETFL, flags | O_NONBLOCK);
-  }
-
-  /* It's safe to call mysql_close() on an already closed connection. */
-  mysql_close(client);
-  xfree(ptr);
-}
-
-static VALUE nogvl_close(void * ptr) {
-  mysql_close((MYSQL *)ptr);
-  return Qnil;
-}
-
-static VALUE allocate(VALUE klass)
-{
-  MYSQL * client;
-
-  return Data_Make_Struct(
-      klass,
-      MYSQL,
-      NULL,
-      rb_mysql_client_free,
-      client
-  );
-}
-
-static VALUE rb_connect(VALUE self, VALUE user, VALUE pass, VALUE host, VALUE port, VALUE database, VALUE socket)
-{
-  MYSQL * client;
-  struct nogvl_connect_args args;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  args.host = NIL_P(host) ? "localhost" : StringValuePtr(host);
-  args.unix_socket = NIL_P(socket) ? NULL : StringValuePtr(socket);
-  args.port = NIL_P(port) ? 3306 : NUM2INT(port);
-  args.user = NIL_P(user) ? NULL : StringValuePtr(user);
-  args.passwd = NIL_P(pass) ? NULL : StringValuePtr(pass);
-  args.db = NIL_P(database) ? NULL : StringValuePtr(database);
-  args.mysql = client;
-  args.client_flag = 0;
-
-  if (rb_thread_blocking_region(nogvl_connect, &args, RUBY_UBF_IO, 0) == Qfalse)
-  {
-    // unable to connect
-    return rb_raise_mysql2_error(client);
-  }
-
-  return self;
-}
-
-/*
- * Immediately disconnect from the server, normally the garbage collector
- * will disconnect automatically when a connection is no longer needed.
- * Explicitly closing this will free up server resources sooner than waiting
- * for the garbage collector.
- */
-static VALUE rb_mysql_client_close(VALUE self) {
-  MYSQL *client;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  REQUIRE_OPEN_DB(client);
-  rb_thread_blocking_region(nogvl_close, client, RUBY_UBF_IO, 0);
-
-  return Qnil;
-}
-
-/*
- * mysql_send_query is unlikely to block since most queries are small
- * enough to fit in a socket buffer, but sometimes large UPDATE and
- * INSERTs will cause the process to block
- */
-static VALUE nogvl_send_query(void *ptr) {
-  struct nogvl_send_query_args *args = ptr;
-  int rv;
-  const char *sql = StringValuePtr(args->sql);
-  long sql_len = RSTRING_LEN(args->sql);
-
-  rv = mysql_send_query(args->mysql, sql, sql_len);
-
-  return rv == 0 ? Qtrue : Qfalse;
-}
-
-/*
- * even though we did rb_thread_select before calling this, a large
- * response can overflow the socket buffers and cause us to eventually
- * block while calling mysql_read_query_result
- */
-static VALUE nogvl_read_query_result(void *ptr) {
-  MYSQL * client = ptr;
-  my_bool res = mysql_read_query_result(client);
-
-  return res == 0 ? Qtrue : Qfalse;
-}
-
-/* mysql_store_result may (unlikely) read rows off the socket */
-static VALUE nogvl_store_result(void *ptr) {
-  MYSQL * client = ptr;
-  return (VALUE)mysql_store_result(client);
-}
-
-static VALUE rb_mysql_client_async_result(VALUE self) {
-  MYSQL * client;
-  MYSQL_RES * result;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  REQUIRE_OPEN_DB(client);
-  if (rb_thread_blocking_region(nogvl_read_query_result, client, RUBY_UBF_IO, 0) == Qfalse) {
-    return rb_raise_mysql2_error(client);
-  }
-
-  result = (MYSQL_RES *)rb_thread_blocking_region(nogvl_store_result, client, RUBY_UBF_IO, 0);
-  if (result == NULL) {
-    if (mysql_field_count(client) != 0) {
-      rb_raise_mysql2_error(client);
-    }
-    return Qnil;
-  }
-
-  VALUE resultObj = rb_mysql_result_to_obj(result);
-  rb_iv_set(resultObj, "@encoding", rb_iv_get(self, "@encoding"));
-  return resultObj;
-}
-
-static VALUE rb_mysql_client_query(int argc, VALUE * argv, VALUE self) {
-  struct nogvl_send_query_args args;
-  fd_set fdset;
-  int fd, retval;
-  int async = 0;
-  VALUE opts;
-  VALUE rb_async;
-
-  MYSQL * client;
-
-  if (rb_scan_args(argc, argv, "11", &args.sql, &opts) == 2) {
-    if ((rb_async = rb_hash_aref(opts, sym_async)) != Qnil) {
-      async = rb_async == Qtrue ? 1 : 0;
-    }
-  }
-
-  Check_Type(args.sql, T_STRING);
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_encoding *conn_enc = rb_to_encoding(rb_iv_get(self, "@encoding"));
-  // ensure the string is in the encoding the connection is expecting
-  args.sql = rb_str_export_to_enc(args.sql, conn_enc);
-#endif
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  REQUIRE_OPEN_DB(client);
-
-  args.mysql = client;
-  if (rb_thread_blocking_region(nogvl_send_query, &args, RUBY_UBF_IO, 0) == Qfalse) {
-    return rb_raise_mysql2_error(client);
-  }
-
-  if (!async) {
-    // the below code is largely from do_mysql
-    // http://github.com/datamapper/do
-    fd = client->net.fd;
-    for(;;) {
-      FD_ZERO(&fdset);
-      FD_SET(fd, &fdset);
-
-      retval = rb_thread_select(fd + 1, &fdset, NULL, NULL, NULL);
-
-      if (retval < 0) {
-          rb_sys_fail(0);
-      }
-
-      if (retval > 0) {
-          break;
-      }
-    }
-
-    return rb_mysql_client_async_result(self);
-  } else {
-    return Qnil;
-  }
-}
-
-static VALUE rb_mysql_client_escape(VALUE self, VALUE str) {
-  MYSQL * client;
-  VALUE newStr;
-  unsigned long newLen, oldLen;
-
-  Check_Type(str, T_STRING);
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_encoding *default_internal_enc = rb_default_internal_encoding();
-  rb_encoding *conn_enc = rb_to_encoding(rb_iv_get(self, "@encoding"));
-  // ensure the string is in the encoding the connection is expecting
-  str = rb_str_export_to_enc(str, conn_enc);
-#endif
-
-  oldLen = RSTRING_LEN(str);
-  char escaped[(oldLen*2)+1];
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  REQUIRE_OPEN_DB(client);
-  newLen = mysql_real_escape_string(client, escaped, StringValuePtr(str), RSTRING_LEN(str));
-  if (newLen == oldLen) {
-    // no need to return a new ruby string if nothing changed
-    return str;
-  } else {
-    newStr = rb_str_new(escaped, newLen);
-#ifdef HAVE_RUBY_ENCODING_H
-    rb_enc_associate(newStr, conn_enc);
-    if (default_internal_enc) {
-      newStr = rb_str_export_to_enc(newStr, default_internal_enc);
-    }
-#endif
-    return newStr;
-  }
-}
-
-static VALUE rb_mysql_client_info(RB_MYSQL_UNUSED VALUE self) {
-  VALUE version = rb_hash_new(), client_info;
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_encoding *default_internal_enc = rb_default_internal_encoding();
-  rb_encoding *conn_enc = rb_to_encoding(rb_iv_get(self, "@encoding"));
-#endif
-
-  rb_hash_aset(version, sym_id, LONG2NUM(mysql_get_client_version()));
-  client_info = rb_str_new2(mysql_get_client_info());
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_enc_associate(client_info, conn_enc);
-  if (default_internal_enc) {
-    client_info = rb_str_export_to_enc(client_info, default_internal_enc);
-  }
-#endif
-  rb_hash_aset(version, sym_version, client_info);
-  return version;
-}
-
-static VALUE rb_mysql_client_server_info(VALUE self) {
-  MYSQL * client;
-  VALUE version, server_info;
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_encoding *default_internal_enc = rb_default_internal_encoding();
-  rb_encoding *conn_enc = rb_to_encoding(rb_iv_get(self, "@encoding"));
-#endif
-
-  Data_Get_Struct(self, MYSQL, client);
-  REQUIRE_OPEN_DB(client);
-
-  version = rb_hash_new();
-  rb_hash_aset(version, sym_id, LONG2FIX(mysql_get_server_version(client)));
-  server_info = rb_str_new2(mysql_get_server_info(client));
-#ifdef HAVE_RUBY_ENCODING_H
-  rb_enc_associate(server_info, conn_enc);
-  if (default_internal_enc) {
-    server_info = rb_str_export_to_enc(server_info, default_internal_enc);
-  }
-#endif
-  rb_hash_aset(version, sym_version, server_info);
-  return version;
-}
-
-static VALUE rb_mysql_client_socket(VALUE self) {
-  MYSQL * client;
-  Data_Get_Struct(self, MYSQL, client);
-  REQUIRE_OPEN_DB(client);
-  return INT2NUM(client->net.fd);
-}
-
-static VALUE rb_mysql_client_last_id(VALUE self) {
-  MYSQL * client;
-  Data_Get_Struct(self, MYSQL, client);
-  REQUIRE_OPEN_DB(client);
-  return ULL2NUM(mysql_insert_id(client));
-}
-
-static VALUE rb_mysql_client_affected_rows(VALUE self) {
-  MYSQL * client;
-  Data_Get_Struct(self, MYSQL, client);
-  REQUIRE_OPEN_DB(client);
-  return ULL2NUM(mysql_affected_rows(client));
-}
-
-static VALUE set_reconnect(VALUE self, VALUE value)
-{
-  my_bool reconnect;
-  MYSQL * client;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  if(!NIL_P(value)) {
-    reconnect = value == Qfalse ? 0 : 1;
-
-    /* set default reconnect behavior */
-    if (mysql_options(client, MYSQL_OPT_RECONNECT, &reconnect)) {
-      /* TODO: warning - unable to set reconnect behavior */
-      rb_warn("%s\n", mysql_error(client));
-    }
-  }
-  return value;
-}
-
-static VALUE set_connect_timeout(VALUE self, VALUE value)
-{
-  unsigned int connect_timeout = 0;
-  MYSQL * client;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-  if(!NIL_P(value)) {
-    connect_timeout = NUM2INT(value);
-    if(0 == connect_timeout) return value;
-
-    /* set default connection timeout behavior */
-    if (mysql_options(client, MYSQL_OPT_CONNECT_TIMEOUT, &connect_timeout)) {
-      /* TODO: warning - unable to set connection timeout */
-      rb_warn("%s\n", mysql_error(client));
-    }
-  }
-  return value;
-}
-
-static VALUE set_charset_name(VALUE self, VALUE value)
-{
-  char * charset_name;
-  MYSQL * client;
-
-  Data_Get_Struct(self, MYSQL, client);
-
-#ifdef HAVE_RUBY_ENCODING_H
-  VALUE new_encoding, old_encoding;
-  new_encoding = rb_funcall(cMysql2Client, intern_encoding_from_charset, 1, value);
-  if (new_encoding == Qnil) {
-    rb_raise(cMysql2Error, "Unsupported charset: '%s'", RSTRING_PTR(value));
-  } else {
-    old_encoding = rb_iv_get(self, "@encoding");
-    if (old_encoding == Qnil) {
-      rb_iv_set(self, "@encoding", new_encoding);
-    }
-  }
-#endif
-
-  charset_name = StringValuePtr(value);
-
-  if (mysql_options(client, MYSQL_SET_CHARSET_NAME, charset_name)) {
-    /* TODO: warning - unable to set charset */
-    rb_warn("%s\n", mysql_error(client));
-  }
-
-  return value;
-}
-
-static VALUE set_ssl_options(VALUE self, VALUE key, VALUE cert, VALUE ca, VALUE capath, VALUE cipher)
-{
-  MYSQL * client;
-  Data_Get_Struct(self, MYSQL, client);
-
-  if(!NIL_P(ca) || !NIL_P(key)) {
-    mysql_ssl_set(client,
-        NIL_P(key) ? NULL : StringValuePtr(key),
-        NIL_P(cert) ? NULL : StringValuePtr(cert),
-        NIL_P(ca) ? NULL : StringValuePtr(ca),
-        NIL_P(capath) ? NULL : StringValuePtr(capath),
-        NIL_P(cipher) ? NULL : StringValuePtr(cipher));
-  }
-
-  return self;
-}
-
-static VALUE init_connection(VALUE self)
-{
-  MYSQL * client;
-  Data_Get_Struct(self, MYSQL, client);
-
-  if (rb_thread_blocking_region(nogvl_init, client, RUBY_UBF_IO, 0) == Qfalse) {
-    /* TODO: warning - not enough memory? */
-    return rb_raise_mysql2_error(client);
-  }
-
-  return self;
-}
+VALUE mMysql2, cMysql2Error;
 
 /* Ruby Extension initializer */
 void Init_mysql2() {
-  mMysql2 = rb_define_module("Mysql2");
-  cMysql2Client = rb_define_class_under(mMysql2, "Client", rb_cObject);
-
-  rb_define_alloc_func(cMysql2Client, allocate);
-
-  rb_define_method(cMysql2Client, "close", rb_mysql_client_close, 0);
-  rb_define_method(cMysql2Client, "query", rb_mysql_client_query, -1);
-  rb_define_method(cMysql2Client, "escape", rb_mysql_client_escape, 1);
-  rb_define_method(cMysql2Client, "info", rb_mysql_client_info, 0);
-  rb_define_method(cMysql2Client, "server_info", rb_mysql_client_server_info, 0);
-  rb_define_method(cMysql2Client, "socket", rb_mysql_client_socket, 0);
-  rb_define_method(cMysql2Client, "async_result", rb_mysql_client_async_result, 0);
-  rb_define_method(cMysql2Client, "last_id", rb_mysql_client_last_id, 0);
-  rb_define_method(cMysql2Client, "affected_rows", rb_mysql_client_affected_rows, 0);
-
-  rb_define_private_method(cMysql2Client, "reconnect=", set_reconnect, 1);
-  rb_define_private_method(cMysql2Client, "connect_timeout=", set_connect_timeout, 1);
-  rb_define_private_method(cMysql2Client, "charset_name=", set_charset_name, 1);
-  rb_define_private_method(cMysql2Client, "ssl_set", set_ssl_options, 5);
-  rb_define_private_method(cMysql2Client, "init_connection", init_connection, 0);
-  rb_define_private_method(cMysql2Client, "connect", rb_connect, 6);
-
+  mMysql2      = rb_define_module("Mysql2");
   cMysql2Error = rb_const_get(mMysql2, rb_intern("Error"));
 
+  init_mysql2_client();
   init_mysql2_result();
-
-  sym_id = ID2SYM(rb_intern("id"));
-  sym_version = ID2SYM(rb_intern("version"));
-  sym_async = ID2SYM(rb_intern("async"));
-
-  intern_encoding_from_charset = rb_intern("encoding_from_charset");
 }