ruby-oci8 1.0.7 → 2.0.0

data/ext/oci8/encoding.c

@@ -0,0 +1,196 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
+/*
+ * encoding.c - part of ruby-oci8
+ *
+ * Copyright (C) 2008 KUBO Takehiro <kubo@jiubao.org>
+ *
+ */
+#include "oci8.h"
+
+#ifndef OCI_NLS_MAXBUFSZ
+#define OCI_NLS_MAXBUFSZ 100
+#endif
+
+/* type of callback function's argument */
+typedef struct {
+    oci8_svcctx_t *svcctx;
+    OCIStmt *stmtp;
+    union {
+        VALUE name;
+        int csid;
+    } u;
+} cb_arg_t;
+
+/* Oracle charset id -> Oracle charset name */
+static VALUE csid2name;
+
+/* Oracle charset name -> Oracle charset id */
+static ID id_upcase;
+static VALUE csname2id;
+static VALUE oci8_charset_name2id(VALUE svc, VALUE name);
+#ifdef HAVE_TYPE_RB_ENCODING
+rb_encoding *oci8_encoding;
+#endif
+
+VALUE oci8_charset_id2name(VALUE svc, VALUE csid)
+{
+    VALUE name = rb_hash_aref(csid2name, csid);
+
+    if (!NIL_P(name)) {
+        return name;
+    }
+    Check_Type(csid, T_FIXNUM);
+    if (have_OCINlsCharSetIdToName) {
+        /* Oracle 9iR2 or upper */
+        char buf[OCI_NLS_MAXBUFSZ];
+        sword rv;
+
+        rv = OCINlsCharSetIdToName(oci8_envhp, TO_ORATEXT(buf), sizeof(buf), FIX2INT(csid));
+        if (rv != OCI_SUCCESS) {
+            return Qnil;
+        }
+        name = rb_usascii_str_new_cstr(buf);
+    } else {
+        /* Oracle 9iR1 or lower */
+        oci8_exec_sql_var_t bind_vars[2];
+        char buf[OCI_NLS_MAXBUFSZ];
+        ub2 buflen = 0;
+        int ival = FIX2INT(csid);
+
+        /* :name */
+        bind_vars[0].valuep = buf;
+        bind_vars[0].value_sz = OCI_NLS_MAXBUFSZ;
+        bind_vars[0].dty = SQLT_CHR;
+        bind_vars[0].indp = NULL;
+        bind_vars[0].alenp = &buflen;
+        /* :csid */
+        bind_vars[1].valuep = &ival;
+        bind_vars[1].value_sz = sizeof(int);
+        bind_vars[1].dty = SQLT_INT;
+        bind_vars[1].indp = NULL;
+        bind_vars[1].alenp = NULL;
+
+        /* convert chaset id to charset name by querying Oracle server. */
+        oci8_exec_sql(oci8_get_svcctx(svc), "BEGIN :name := nls_charset_name(:csid); END;", 0, NULL, 2, bind_vars, 1);
+        if (buflen == 0) {
+            return Qnil;
+        }
+        name = rb_usascii_str_new(buf, buflen);
+    }
+    OBJ_FREEZE(name);
+    rb_hash_aset(csid2name, csid, name);
+    rb_hash_aset(csname2id, name, csid);
+    return name;
+}
+
+static VALUE oci8_charset_name2id(VALUE svc, VALUE name)
+{
+    VALUE csid;
+
+    name = rb_funcall(name, id_upcase, 0);
+    csid = rb_hash_aref(csname2id, StringValue(name));
+    if (!NIL_P(csid)) {
+        return csid;
+    }
+    if (have_OCINlsCharSetNameToId) {
+        /* Oracle 9iR2 or upper */
+        ub2 rv;
+
+        rv = OCINlsCharSetNameToId(oci8_envhp, RSTRING_ORATEXT(name));
+        if (rv == 0) {
+            return Qnil;
+        }
+        csid = INT2FIX(rv);
+    } else {
+        /* Oracle 9iR1 or lower */
+        oci8_exec_sql_var_t bind_vars[2];
+        int ival;
+        sb2 ind = 0; /* null indicator */
+
+        /* :csid */
+        bind_vars[0].valuep = &ival;
+        bind_vars[0].value_sz = sizeof(int);
+        bind_vars[0].dty = SQLT_INT;
+        bind_vars[0].indp = &ind;
+        bind_vars[0].alenp = NULL;
+        /* :name */
+        bind_vars[1].valuep = RSTRING_PTR(name);
+        bind_vars[1].value_sz = RSTRING_LEN(name);
+        bind_vars[1].dty = SQLT_CHR;
+        bind_vars[1].indp = NULL;
+        bind_vars[1].alenp = NULL;
+
+        /* convert chaset name to charset id by querying Oracle server. */
+        oci8_exec_sql(oci8_get_svcctx(svc), "BEGIN :csid := nls_charset_id(:name); END;", 0, NULL, 2, bind_vars, 1);
+        if (ind) {
+            return Qnil;
+        }
+        csid = INT2FIX(ival);
+    }
+    rb_hash_aset(csid2name, csid, name);
+    rb_hash_aset(csname2id, name, csid);
+    return csid;
+}
+
+#ifdef HAVE_TYPE_RB_ENCODING
+
+/*
+ * call-seq:
+ *   OCI8.encoding -> enc
+ *
+ * (new in ruby 1.9)
+ *
+ * Returns Oracle client encoding.
+ *
+ * String values passed to Oracle, such as SQL statements,
+ * bind values etc., are converted from their encoding to
+ * the Oracle client encoding.
+ *
+ * If <code>Encoding.default_internal</code> is nil,
+ * string values got from Oracle are tagged by
+ * <code>OCI8.encoding</code>. If not nil, they are
+ * converted from <code>OCI8.encoding</code> to
+ * <code>Encoding.default_internal</code> by default.
+ *
+ * If it is 'ASCII-8BIT', no encoding conversions are done.
+ */
+static VALUE oci8_get_encoding(VALUE klass)
+{
+    return rb_enc_from_encoding(oci8_encoding);
+}
+
+/*
+ * call-seq:
+ *   OCI8.encoding = enc or nil
+ *
+ * (new in ruby 1.9)
+ *
+ * Sets Oracle client encoding.
+ */
+static VALUE oci8_set_encoding(VALUE klass, VALUE encoding)
+{
+    if (NIL_P(encoding)) {
+        oci8_encoding = NULL;
+    } else {
+        oci8_encoding = rb_to_encoding(encoding);
+    }
+    return encoding;
+}
+#endif
+
+void Init_oci8_encoding(VALUE cOCI8)
+{
+    csid2name = rb_hash_new();
+    rb_global_variable(&csid2name);
+
+    id_upcase = rb_intern("upcase");
+    csname2id = rb_hash_new();
+    rb_global_variable(&csname2id);
+
+    rb_define_method(cOCI8, "charset_name2id", oci8_charset_name2id, 1);
+    rb_define_method(cOCI8, "charset_id2name", oci8_charset_id2name, 1);
+#ifdef HAVE_TYPE_RB_ENCODING
+    rb_define_singleton_method(cOCI8, "encoding", oci8_get_encoding, 0);
+    rb_define_singleton_method(cOCI8, "encoding=", oci8_set_encoding, 1);
+#endif
+}

data/ext/oci8/env.c

@@ -1,276 +1,107 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
 /*
   env.c - part of ruby-oci8
 
-  Copyright (C) 2002 KUBO Takehiro <kubo@jiubao.org>
+  Copyright (C) 2002-2008 KUBO Takehiro <kubo@jiubao.org>
 
-=begin
-== OCIEnv
-The environment handle is the source of all OCI objects.
-Usually there is one instance per one application.
-
-super class: ((<OCIHandle>))
-
-correspond native OCI datatype: ((|OCIEnv|))
-=end
 */
 #include "oci8.h"
-#include <util.h> /* ruby_setenv */
-
-RBOCI_NORETURN(static void oci8_raise_init_error(void));
-
-static void oci8_raise_init_error(void)
-{
-  VALUE msg = rb_str_new2("OCI Library Initialization Error");
-  VALUE exc = rb_funcall(eOCIError, oci8_id_new, 1, msg);
-  rb_ivar_set(exc, oci8_id_code, rb_ary_new3(1, INT2FIX(-1)));
-  rb_ivar_set(exc, oci8_id_message, rb_ary_new3(1, msg));
-  rb_exc_raise(exc);
-}
-
-static VALUE oci8_env_s_initialize(int argc, VALUE *argv, VALUE klass)
-{
-  VALUE vmode;
-  ub4 mode;
-  sword rv;
-
-#ifndef WIN32
-  /* workaround code.
-   *
-   * Some instant clients set the environment variables
-   * ORA_NLS_PROFILE33, ORA_NLS10 and ORACLE_HOME if they aren't
-   * set. It causes problems on some platforms.
-   */
-  if (RTEST(rb_eval_string("RUBY_VERSION == \"1.8.4\""))) {
-    if (getenv("ORA_NLS_PROFILE33") == NULL) {
-      ruby_setenv("ORA_NLS_PROFILE33", "");
-    }
-    if (getenv("ORA_NLS10") == NULL) {
-      ruby_setenv("ORA_NLS10", "");
-    }
-    if (getenv("ORACLE_HOME") == NULL) {
-      ruby_setenv("ORACLE_HOME", ".");
-    }
-  }
-#endif /* WIN32 */
-
-  rb_scan_args(argc, argv, "01", &vmode);
-  Get_Int_With_Default(argc, 1, vmode, mode, OCI_DEFAULT); /* 1 */
-  
-  rv = OCIInitialize(mode, NULL, NULL, NULL, NULL);
-  return INT2FIX(rv);
-}
-
-static VALUE oci8_env_s_init(int argc, VALUE *argv, VALUE klass)
-{
-  VALUE vmode;
-  ub4 mode;
-  OCIEnv *envhp = NULL;
-  OCIError *errhp;
-  oci8_handle_t *h;
-  sword rv;
-
-  rb_scan_args(argc, argv, "01", &vmode);
-  Get_Int_With_Default(argc, 1, vmode, mode, OCI_DEFAULT); /* 1 */
-  
-  rv = OCIEnvInit(&envhp, OCI_DEFAULT, 0, NULL);
-  if (envhp == NULL) {
-    oci8_raise_init_error();
-  }
-  if (rv != OCI_SUCCESS)
-    oci8_env_raise(envhp, rv);
-  rv = OCIHandleAlloc(envhp, (dvoid *)&errhp, OCI_HTYPE_ERROR, 0, NULL);
-  if (rv != OCI_SUCCESS)
-    oci8_env_raise(envhp, rv);
-  h = oci8_make_handle(OCI_HTYPE_ENV, envhp, errhp, NULL, 0);
-  return h->self;
-}
-
-/*
-=begin
---- OCIEnv.create([mode])
-     create the environment handle. Don't call `new'.
-
-     :mode
-        ((|OCI_DEFAULT|)), ((|OCI_THREADED|)), ((|OCI_OBJECT|)), ((|OCI_SHARED|))
-        or these combination.
-        But I test only ((|OCI_DEFAULT|)). Default value is ((|OCI_DEFAULT|)).
-
-        ((|OCI_THREADED|)): if your application use native thread(not ruby's thread), use this.
-
-        ((|OCI_OBJECT|)): for OCI objects. But current implementation doesn't support OCI Object-Relational functions.
-        This is for ((*far future*)) extension, because my plan doesn't include `OCI object support'.
-
-        ((|OCI_SHARED|))(Oracle 8i or later): for ((<Shared Data Mode>)).
-
-     :return value
-        A instance of ((<OCIEnv>)).
-
-     correspond native OCI function: ((|OCIEnvCreate|)) (if ((|OCIEnvCreate|)) is not found, the combination of ((|OCIInitialize|)) and ((|OCIEnvInit|)).)
-=end
-*/
-#ifdef HAVE_OCIENVCREATE
-static VALUE oci8_env_s_create(int argc, VALUE *argv, VALUE klass)
-{
-  VALUE vmode;
-  ub4 mode;
-  OCIEnv *envhp = NULL;
-  OCIError *errhp;
-  oci8_handle_t *h;
-  sword rv;
 
-  rb_scan_args(argc, argv, "01", &vmode);
-  Get_Int_With_Default(argc, 1, vmode, mode, OCI_DEFAULT); /* 1 */
-
-  rv = OCIEnvCreate(&envhp, mode, NULL, NULL, NULL, NULL, 0, NULL);
-  if (envhp == NULL) {
-    oci8_raise_init_error();
-  }
-  if (rv != OCI_SUCCESS)
-    oci8_env_raise(envhp, rv);
-  rv = OCIHandleAlloc(envhp, (dvoid *)&errhp, OCI_HTYPE_ERROR, 0, NULL);
-  if (rv != OCI_SUCCESS)
-    oci8_env_raise(envhp, rv);
-  h = oci8_make_handle(OCI_HTYPE_ENV, envhp, errhp, NULL, 0);
-  return h->self;
-}
+#if !defined(RUBY_VM)
+/* ruby_setenv for workaround ruby 1.8.4 */
+#include <util.h>
 #endif
 
+OCIEnv *oci8_envhp;
+#ifdef RUBY_VM
 /*
-=begin
---- OCIEnv.terminate([mode])
-     :mode
-        ((|OCI_DEFAULT|)) only valid. Default value is ((|OCI__DEFAULT|)).
-
-     correspond native OCI function: ((|OCITerminate|))
-=end
-*/
-#ifdef HAVE_OCITERMINATE
-static VALUE oci8_env_s_terminate(int argc, VALUE *argv, VALUE klass)
-{
-  VALUE vmode;
-  ub4 mode;
-
-  if (rb_scan_args(argc, argv, "01", &vmode) == 1) {
-    Check_Type(vmode, T_FIXNUM);
-    mode = FIX2INT(vmode);
-  } else {
-    mode = OCI_DEFAULT;
-  }
-
-  OCITerminate(mode);
-  return Qnil;
-}
-#endif
+ * oci8_errhp is a thread local object in ruby 1.9.
+ */
 
-/*
-=begin
---- OCIEnv#alloc(handle)
-     create a new OCI handle.
-     :handle
-        The valid values are ((<OCISvcCtx>)), ((<OCIStmt>)),
-        ((<OCIServer>)), ((<OCISession>)), and ((<OCIDescribe>)).
-     :return value
-        A newly created handle.
+oci8_tls_key_t oci8_tls_key; /* native thread key */
+static ID id_thread_key;     /* ruby's thread key */
 
-     correspond native OCI function: ((|OCIHandleAlloc|))
-=end
-*/
-typedef sword (*alloc_func_t)(CONST dvoid *, dvoid **, CONST ub4, CONST size_t, dvoid **);
-static VALUE oci8_handle_alloc(VALUE self, VALUE klass)
+static void oci8_free_errhp(OCIError *errhp)
 {
-  sword rv;
-  dvoid *hp;
-  oci8_handle_t *envh;
-  oci8_handle_t *h;
-  int i;
-  struct {
-    VALUE *klass;
-    ub4 type;
-    alloc_func_t alloc_func;
-  } alloc_map[] = {
-    {&cOCISvcCtx,   OCI_HTYPE_SVCCTX,   (alloc_func_t)OCIHandleAlloc},
-    {&cOCIStmt,     OCI_HTYPE_STMT,     (alloc_func_t)OCIHandleAlloc},
-    {&cOCIServer,   OCI_HTYPE_SERVER,   (alloc_func_t)OCIHandleAlloc},
-    {&cOCISession,  OCI_HTYPE_SESSION,  (alloc_func_t)OCIHandleAlloc},
-    {&cOCIDescribe, OCI_HTYPE_DESCRIBE, (alloc_func_t)OCIHandleAlloc},
-    {&cOCILobLocator, OCI_DTYPE_LOB,    (alloc_func_t)OCIDescriptorAlloc},
-    {&cOCIFileLocator, OCI_DTYPE_FILE,  (alloc_func_t)OCIDescriptorAlloc},
-  };
-#define ALLOC_MAP_SIZE (sizeof(alloc_map) / sizeof(alloc_map[0]))
-
-  Get_Handle(self, envh);
-  for (i = 0;i < ALLOC_MAP_SIZE;i++) {
-    if (alloc_map[i].klass[0] == klass)
-      break;
-  }
-  if (i == ALLOC_MAP_SIZE) {
-    rb_raise(rb_eTypeError, "not valid handle type %s", rb_class2name(CLASS_OF(klass)));
-  }
-
-  rv = alloc_map[i].alloc_func(envh->hp, &hp, alloc_map[i].type, 0, NULL);
-  if (rv != OCI_SUCCESS)
-    oci8_env_raise(envh->hp, rv);
-  h = oci8_make_handle(alloc_map[i].type, hp, envh->errhp, envh, 0);
-  return h->self;
+    OCIHandleFree(errhp, OCI_HTYPE_ERROR);
 }
 
-/*
-=begin
---- OCIEnv#logon(username, password, dbname)
-     Logon to the Oracle server.
-
-     See ((<Simplified Logon>)) and ((<Explicit Attach and Begin Session>))
-
-     :username
-        the username.
-     :password
-        the user's password.
-     :dbname
-        the name of the database, or nil.
-     :return value
-        A instance of ((<OCISvcCtx>))
-     For example:
-       env = OCIEnv.create()
-       svc = env.logon("SCOTT", "TIGER", nil)
-         or
-       svc = env.logon("SCOTT", "TIGER", "ORCL.WORLD")
-
-     correspond native OCI function: ((|OCILogon|))
-=end
-*/
-static VALUE oci8_logon(VALUE self, VALUE username, VALUE password, VALUE dbname)
+OCIError *oci8_make_errhp(void)
 {
-  oci8_handle_t *envh;
-  oci8_handle_t *svch;
-  OCISvcCtx *svchp;
-  oci8_string_t u, p, d;
-  VALUE obj;
-  sword rv;
-
-  Get_Handle(self, envh);
-  Get_String(username, u);
-  Get_String(password, p);
-  Get_String(dbname, d);
-  rv = OCILogon(envh->hp, envh->errhp, &svchp,
-		    u.ptr, u.len, p.ptr, p.len, d.ptr, d.len);
-  if (rv != OCI_SUCCESS) {
-    oci8_raise(envh->errhp, rv, NULL);
-  }
-  svch = oci8_make_handle(OCI_HTYPE_SVCCTX, svchp, envh->errhp, envh, 0);
-  obj = svch->self;
-  return obj;
+    OCIError *errhp;
+    VALUE obj;
+    sword rv;
+
+    /* create a new errhp. */
+    rv = OCIHandleAlloc(oci8_envhp, (dvoid *)&errhp, OCI_HTYPE_ERROR, 0, NULL);
+    if (rv != OCI_SUCCESS) {
+        oci8_env_raise(oci8_envhp, rv);
+    }
+    /* create a new ruby object which contains errhp to make
+     * sure that the errhp is freed when it become unnecessary.
+     */
+    obj = Data_Wrap_Struct(rb_cObject, NULL, oci8_free_errhp, errhp);
+    /* set the ruby object to ruby's thread local storage to prevent
+     * it from being freed while the thread is available.
+     */
+    rb_thread_local_aset(rb_thread_current(), id_thread_key, obj);
+
+    oci8_tls_set(oci8_tls_key, (void*)errhp);
+    return errhp;
 }
+#else
+/*
+ * oci8_errhp is global in ruby 1.8.
+ */
+OCIError *oci8_errhp;
+#endif
 
 void Init_oci8_env(void)
 {
-  rb_define_singleton_method(cOCIEnv, "initialise", oci8_env_s_initialize, -1);
-  rb_define_singleton_method(cOCIEnv, "init", oci8_env_s_init, -1);
-#ifdef HAVE_OCIENVCREATE
-  rb_define_singleton_method(cOCIEnv, "create", oci8_env_s_create, -1);
+    sword rv;
+#ifdef RUBY_VM
+    ub4 mode = OCI_OBJECT | OCI_THREADED;
+    int error;
+#else
+    ub4 mode = OCI_OBJECT;
 #endif
-#ifdef HAVE_OCITERMINATE
-  rb_define_singleton_method(cOCIEnv, "terminate", oci8_env_s_terminate, -1);
+
+#if !defined(RUBY_VM) && !defined(_WIN32)
+    /* workaround code.
+     *
+     * Some instant clients set the environment variables
+     * ORA_NLS_PROFILE33, ORA_NLS10 and ORACLE_HOME if they aren't
+     * set. It causes problems on some platforms.
+     */
+    if (RTEST(rb_eval_string("RUBY_VERSION == \"1.8.4\""))) {
+        if (getenv("ORA_NLS_PROFILE33") == NULL) {
+            ruby_setenv("ORA_NLS_PROFILE33", "");
+        }
+        if (getenv("ORA_NLS10") == NULL) {
+            ruby_setenv("ORA_NLS10", "");
+        }
+        if (getenv("ORACLE_HOME") == NULL) {
+            ruby_setenv("ORACLE_HOME", ".");
+        }
+    }
+#endif /* WIN32 */
+    rv = OCIInitialize(mode, NULL, NULL, NULL, NULL);
+    if (rv != OCI_SUCCESS) {
+        oci8_raise_init_error();
+    }
+    rv = OCIEnvInit(&oci8_envhp, OCI_DEFAULT, 0, NULL);
+    if (rv != OCI_SUCCESS) {
+        oci8_raise_init_error();
+    }
+#ifdef RUBY_VM
+    id_thread_key = rb_intern("__oci8_errhp__");
+    error = oci8_tls_key_init(&oci8_tls_key);
+    if (error != 0) {
+        rb_raise(rb_eRuntimeError, "Cannot create thread local key (errno = %d)", error);
+    }
+#else /* RUBY_VM */
+    rv = OCIHandleAlloc(oci8_envhp, (dvoid *)&oci8_errhp, OCI_HTYPE_ERROR, 0, NULL);
+    if (rv != OCI_SUCCESS)
+        oci8_env_raise(oci8_envhp, rv);
 #endif
-  rb_define_method(cOCIEnv, "alloc", oci8_handle_alloc, 1);
-  rb_define_method(cOCIEnv, "logon", oci8_logon, 3);
 }