ruby-oci8 2.0.1 → 2.0.2

data/ext/oci8/attr.c

@@ -3,7 +3,7 @@
  * attr.c
  *
  * $Author: kubo $
- * $Date: 2009-01-12 00:11:09 +0900 (Mon, 12 Jan 2009) $
+ * $Date: 2009-05-17 22:07:16 +0900 (Sun, 17 May 2009) $
  *
  * Copyright (C) 2002-2007 KUBO Takehiro <kubo@jiubao.org>
  */
@@ -106,7 +106,8 @@ static VALUE get_rowid_attr(rowid_arg_t *arg)
          * Oracle Server.
          */
         oci8_base_t *svc;
-        oci8_exec_sql_var_t bind_vars[2];
+        oci8_exec_sql_var_t define_var;
+        oci8_exec_sql_var_t bind_var;
 
         /* search a connection from the handle */
         svc = base;
@@ -117,19 +118,19 @@ static VALUE get_rowid_attr(rowid_arg_t *arg)
             }
         }
         /* :strval */
-        bind_vars[0].valuep = buf;
-        bind_vars[0].value_sz = sizeof(buf);
-        bind_vars[0].dty = SQLT_CHR;
-        bind_vars[0].indp = NULL;
-        bind_vars[0].alenp = &buflen;
+        define_var.valuep = buf;
+        define_var.value_sz = sizeof(buf);
+        define_var.dty = SQLT_CHR;
+        define_var.indp = NULL;
+        define_var.alenp = &buflen;
         /* :rowid */
-        bind_vars[1].valuep = &arg->ridp;
-        bind_vars[1].value_sz = sizeof(void *);
-        bind_vars[1].dty = SQLT_RDD;
-        bind_vars[1].indp = NULL;
-        bind_vars[1].alenp = NULL;
+        bind_var.valuep = &arg->ridp;
+        bind_var.value_sz = sizeof(void *);
+        bind_var.dty = SQLT_RDD;
+        bind_var.indp = NULL;
+        bind_var.alenp = NULL;
         /* convert the rowid descriptor to a string value by querying Oracle server. */
-        oci8_exec_sql((oci8_svcctx_t*)svc, "BEGIN :strval := :rowid; END;", 0, NULL, 2, bind_vars, 1);
+        oci8_exec_sql((oci8_svcctx_t*)svc, "SELECT :rid FROM dual", 1, &define_var, 1, &bind_var, 1);
         if (buflen == 0) {
             return Qnil;
         }

data/ext/oci8/bind.c

@@ -3,7 +3,7 @@
  * bind.c
  *
  * $Author: kubo $
- * $Date: 2009-02-10 22:50:40 +0900 (Tue, 10 Feb 2009) $
+ * $Date: 2009-05-17 22:07:16 +0900 (Sun, 17 May 2009) $
  *
  * Copyright (C) 2002-2008 KUBO Takehiro <kubo@jiubao.org>
  */
@@ -46,7 +46,7 @@ static void bind_string_init(oci8_bind_t *obind, VALUE svc, VALUE val, VALUE len
     } else {
         sz = NUM2INT(length);
     }
-    if (sz <= 0) {
+    if (sz < 0) {
         rb_raise(rb_eArgError, "invalid bind length %d", sz);
     }
     sz += sizeof(sb4);
@@ -284,8 +284,8 @@ static VALUE bind_float_get(oci8_bind_t *obind, void *data, void *null_struct)
 
 static void bind_float_set(oci8_bind_t *obind, void *data, void **null_structp, VALUE val)
 {
-    Check_Type(val, T_FLOAT);
-    *(double*)data = RFLOAT_VALUE(val);
+    /* val is converted to Float if it isn't Float. */
+    *(double*)data = RFLOAT_VALUE(rb_Float(val));
 }
 
 static void bind_float_init(oci8_bind_t *obind, VALUE svc, VALUE val, VALUE length)

data/ext/oci8/encoding.c

@@ -45,7 +45,7 @@ VALUE oci8_charset_id2name(VALUE svc, VALUE csid)
         char buf[OCI_NLS_MAXBUFSZ];
         sword rv;
 
-        rv = OCINlsCharSetIdToName(oci8_envhp, TO_ORATEXT(buf), sizeof(buf), FIX2INT(csid));
+        rv = OCINlsCharSetIdToName(oci8_envhp, TO_ORATEXT(buf), sizeof(buf), (ub2)FIX2INT(csid));
         if (rv != OCI_SUCCESS) {
             return Qnil;
         }

data/ext/oci8/env.c

@@ -1,10 +1,9 @@
 /* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
 /*
-  env.c - part of ruby-oci8
-
-  Copyright (C) 2002-2008 KUBO Takehiro <kubo@jiubao.org>
-
-*/
+ * env.c - part of ruby-oci8
+ *
+ * Copyright (C) 2002-2009 KUBO Takehiro <kubo@jiubao.org>
+ */
 #include "oci8.h"
 
 #if !defined(RUBY_VM)
@@ -12,7 +11,37 @@
 #include <util.h>
 #endif
 
-OCIEnv *oci8_envhp;
+#ifdef _WIN32
+#ifdef HAVE_RUBY_WIN32_H
+#include <ruby/win32.h> /* for rb_w32_getenv() */
+#else
+#include <win32/win32.h> /* for rb_w32_getenv() */
+#endif
+#endif
+
+#ifdef HAVE_RUBY_UTIL_H
+#include <ruby/util.h>
+#endif
+
+#ifdef RUBY_VM
+ub4 oci8_env_mode = OCI_OBJECT | OCI_THREADED;
+#else
+ub4 oci8_env_mode = OCI_OBJECT;
+#endif
+
+OCIEnv *oci8_global_envhp;
+
+OCIEnv *oci8_make_envhp(void)
+{
+    sword rv;
+
+    rv = OCIEnvCreate(&oci8_global_envhp, oci8_env_mode, NULL, NULL, NULL, NULL, 0, NULL);
+    if (rv != OCI_SUCCESS) {
+        oci8_raise_init_error();
+    }
+    return oci8_global_envhp;
+}
+
 #ifdef RUBY_VM
 /*
  * oci8_errhp is a thread local object in ruby 1.9.
@@ -53,17 +82,23 @@ OCIError *oci8_make_errhp(void)
 /*
  * oci8_errhp is global in ruby 1.8.
  */
-OCIError *oci8_errhp;
+OCIError *oci8_global_errhp;
+
+OCIError *oci8_make_errhp(void)
+{
+    sword rv;
+
+    rv = OCIHandleAlloc(oci8_envhp, (dvoid *)&oci8_global_errhp, OCI_HTYPE_ERROR, 0, NULL);
+    if (rv != OCI_SUCCESS)
+        oci8_env_raise(oci8_envhp, rv);
+    return oci8_global_errhp;
+}
 #endif
 
 void Init_oci8_env(void)
 {
-    sword rv;
 #ifdef RUBY_VM
-    ub4 mode = OCI_OBJECT | OCI_THREADED;
     int error;
-#else
-    ub4 mode = OCI_OBJECT;
 #endif
 
 #if !defined(RUBY_VM) && !defined(_WIN32)
@@ -85,23 +120,38 @@ void Init_oci8_env(void)
         }
     }
 #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();
+
+    /* workaround code.
+     *
+     * When ORACLE_HOME ends with '/' and the Oracle client is
+     * an instant client lower than 10.2.0.3, OCIEvnCreate()
+     * doesn't work even though the combination of OCIInitialize()
+     * and OCIEnvInit() works fine. Delete the last slash for
+     * a workaround.
+     */
+    if (oracle_client_version < ORAVERNUM(10, 2, 0, 3, 0)) {
+#ifdef _WIN32
+#define DIR_SEP '\\'
+#else
+#define DIR_SEP '/'
+#endif
+        char *home = getenv("ORACLE_HOME");
+        if (home != NULL) {
+            size_t homelen = strlen(home);
+            if (homelen > 0 && home[homelen - 1] == DIR_SEP) {
+                home = ruby_strdup(home);
+                home[homelen - 1] = '\0';
+                ruby_setenv("ORACLE_HOME", home);
+                xfree(home);
+            }
+        }
     }
+
 #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
 }

data/ext/oci8/error.c

@@ -157,7 +157,7 @@ static void set_backtrace_and_raise(VALUE exc, const char *file, int line)
 #endif
     backtrace = rb_funcall(rb_cObject, oci8_id_caller, 0);
     if (TYPE(backtrace) == T_ARRAY) {
-        snprintf(errmsg, sizeof(errmsg), "%s:%d:in oci8lib.so", file, line);
+        snprintf(errmsg, sizeof(errmsg), "%s:%d:in " STRINGIZE(oci8lib) DLEXT, file, line);
         errmsg[sizeof(errmsg) - 1] = '\0';
         rb_ary_unshift(backtrace, rb_usascii_str_new_cstr(errmsg));
         rb_funcall(exc, oci8_id_set_backtrace, 1, backtrace);

data/ext/oci8/extconf.rb

@@ -61,7 +61,13 @@ funcs.keys.sort.each do |version|
   puts "checking for Oracle #{verstr} API - #{result}"
   break if result == 'fail'
 end
-$defs << "-DACTUAL_ORACLE_CLIENT_VERSION=#{format('0x%08x', oci_actual_client_version)}"
+
+have_type('oratext', 'ociap.h')
+have_type('OCIDateTime*', 'ociap.h')
+have_type('OCIInterval*', 'ociap.h')
+have_type('OCICallbackLobRead2', 'ociap.h')
+have_type('OCICallbackLobWrite2', 'ociap.h')
+have_type('OCIAdmin*', 'ociap.h')
 
 if with_config('oracle-version')
   oci_client_version = with_config('oracle-version').to_i
@@ -97,7 +103,6 @@ have_func("localtime_r")
 have_header("intern.h")
 have_header("util.h")
 # ruby 1.9 headers
-have_header("ruby/util.h")
 have_type('rb_encoding', ['ruby/ruby.h', 'ruby/encoding.h'])
 
 # $! in C API
@@ -122,6 +127,7 @@ else
   raise 'unsupported ruby version: ' + RUBY_VERSION
 end
 $defs << "-DInit_oci8lib=Init_#{so_basename}"
+$defs << "-Doci8lib=#{so_basename}"
 
 create_header()
 

data/ext/oci8/lob.c

@@ -26,6 +26,7 @@ typedef struct {
     ub4 pos;
     int char_width;
     ub1 csfrm;
+    ub1 lobtype;
     enum state state;
 } oci8_lob_t;
 
@@ -149,6 +150,7 @@ static VALUE oci8_lob_do_initialize(int argc, VALUE *argv, VALUE self, ub1 csfrm
     lob->pos = 0;
     lob->char_width = 1;
     lob->csfrm = csfrm;
+    lob->lobtype = lobtype;
     lob->state = S_NO_OPEN_CLOSE;
     oci8_link_to_parent((oci8_base_t*)lob, (oci8_base_t*)DATA_PTR(svc));
     if (!NIL_P(val)) {
@@ -360,8 +362,14 @@ static VALUE oci8_lob_read(int argc, VALUE *argv, VALUE self)
     }
     v = rb_ary_join(v, Qnil);
     OBJ_TAINT(v);
-    rb_enc_associate(v, oci8_encoding);
-    return rb_str_conv_enc(v, oci8_encoding, rb_default_internal_encoding());
+    if (lob->lobtype == OCI_TEMP_CLOB) {
+        /* set encoding */
+        rb_enc_associate(v, oci8_encoding);
+        return rb_str_conv_enc(v, oci8_encoding, rb_default_internal_encoding());
+    } else {
+        /* ASCII-8BIT */
+        return v;
+    }
 }
 
 static VALUE oci8_lob_write(VALUE self, VALUE data)
@@ -371,7 +379,11 @@ static VALUE oci8_lob_write(VALUE self, VALUE data)
     ub4 amt;
 
     lob_open(lob);
-    OCI8StringValue(data);
+    if (lob->lobtype == OCI_TEMP_CLOB) {
+        OCI8StringValue(data);
+    } else {
+        StringValue(data);
+    }
     amt = RSTRING_LEN(data);
     oci_lc(OCILobWrite_nb(svcctx, svcctx->base.hp.svc, oci8_errhp, lob->base.hp.lob, &amt, lob->pos + 1, RSTRING_PTR(data), amt, OCI_ONE_PIECE, NULL, NULL, 0, lob->csfrm));
     lob->pos += amt;
@@ -483,9 +495,15 @@ static void oci8_bfile_set_name(VALUE self, VALUE dir_alias, VALUE filename)
     oci8_lob_t *lob = DATA_PTR(self);
 
     bfile_close(lob);
+    if (RSTRING_LEN(dir_alias) > UB2MAXVAL) {
+        rb_raise(rb_eRuntimeError, "dir_alias is too long.");
+    }
+    if (RSTRING_LEN(filename) > UB2MAXVAL) {
+        rb_raise(rb_eRuntimeError, "filename is too long.");
+    }
     oci_lc(OCILobFileSetName(oci8_envhp, oci8_errhp, &lob->base.hp.lob,
-                             RSTRING_ORATEXT(dir_alias), RSTRING_LEN(dir_alias),
-                             RSTRING_ORATEXT(filename), RSTRING_LEN(filename)));
+                             RSTRING_ORATEXT(dir_alias), (ub2)RSTRING_LEN(dir_alias),
+                             RSTRING_ORATEXT(filename), (ub2)RSTRING_LEN(filename)));
 }
 
 static VALUE oci8_bfile_initialize(int argc, VALUE *argv, VALUE self)
@@ -503,6 +521,7 @@ static VALUE oci8_bfile_initialize(int argc, VALUE *argv, VALUE self)
     lob->pos = 0;
     lob->char_width = 1;
     lob->csfrm = SQLCS_IMPLICIT;
+    lob->lobtype = OCI_TEMP_BLOB;
     lob->state = S_BFILE_CLOSE;
     if (argc != 1) {
         OCI8SafeStringValue(dir_alias);

data/ext/oci8/metadata.c

@@ -2,7 +2,7 @@
 /*
  * metadata.c
  *
- * Copyright (C) 2006-2007 KUBO Takehiro <kubo@jiubao.org>
+ * Copyright (C) 2006-2009 KUBO Takehiro <kubo@jiubao.org>
  *
  * implement private methods of classes in OCI8::Metadata module.
  *
@@ -210,7 +210,7 @@ static VALUE metadata_get_oraint(VALUE self, VALUE idx)
     memset(&on, 0, sizeof(on));
     on.OCINumberPart[0] = size;
     memcpy(&on.OCINumberPart[1], value, size);
-    return oci8_make_integer(&on);
+    return oci8_make_integer(&on, oci8_errhp);
 }
 
 static VALUE metadata_get_param(VALUE self, VALUE idx)
@@ -277,7 +277,7 @@ static VALUE oci8_do_describe(VALUE self, void *objptr, ub4 objlen, ub1 objtype,
         oci_lc(OCIAttrSet(desc->hp.dschp, OCI_HTYPE_DESCRIBE, &val, 0, OCI_ATTR_DESC_PUBLIC, oci8_errhp));
     }
     oci_lc(OCIDescribeAny_nb(svcctx, svcctx->base.hp.svc, oci8_errhp, objptr, objlen,
-                             objtype, OCI_DEFAULT, FIX2INT(type), desc->hp.dschp));
+                             objtype, OCI_DEFAULT, (ub1)FIX2INT(type), desc->hp.dschp));
     oci_lc(OCIAttrGet(desc->hp.dschp, OCI_HTYPE_DESCRIBE, &parmhp, 0, OCI_ATTR_PARAM, oci8_errhp));
     return oci8_metadata_create(parmhp, self, obj);
 }

data/ext/oci8/object.c

@@ -1,5 +1,10 @@
 /* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
 /*
+ * Copyright (C) 2002-2009 KUBO Takehiro <kubo@jiubao.org>
+ */
+
+/*
+ *
  * Document-class: OCI8::TDO
  *
  * OCI8::TDO is the class for Type Descriptor Object, which describe
@@ -157,11 +162,11 @@ static VALUE get_attribute(VALUE self, VALUE datatype, VALUE typeinfo, void *dat
         return rb_str_new(TO_CHARPTR(OCIRawPtr(oci8_envhp, *(OCIRaw **)data)),
                           OCIRawSize(oci8_envhp, *(OCIRaw **)data));
     case ATTR_OCINUMBER:
-        return oci8_make_ocinumber((OCINumber *)data);
+        return oci8_make_ocinumber((OCINumber *)data, oci8_errhp);
     case ATTR_FLOAT:
-        return oci8_make_float((OCINumber *)data);
+        return oci8_make_float((OCINumber *)data, oci8_errhp);
     case ATTR_INTEGER:
-        return oci8_make_integer((OCINumber *)data);
+        return oci8_make_integer((OCINumber *)data, oci8_errhp);
     case ATTR_BINARY_DOUBLE:
         return rb_float_new(*(double*)data);
     case ATTR_BINARY_FLOAT:
@@ -431,10 +436,10 @@ static void set_attribute(VALUE self, VALUE datatype, VALUE typeinfo, void *data
         break;
     case ATTR_OCINUMBER:
     case ATTR_FLOAT:
-        oci8_set_ocinumber((OCINumber*)data, val);
+        oci8_set_ocinumber((OCINumber*)data, val, oci8_errhp);
         break;
     case ATTR_INTEGER:
-        oci8_set_integer((OCINumber*)data, val);
+        oci8_set_integer((OCINumber*)data, val, oci8_errhp);
         break;
     case ATTR_BINARY_DOUBLE:
         *(double*)data = NUM2DBL(val);

data/ext/oci8/oci8.c

@@ -17,6 +17,10 @@ extern rb_pid_t rb_w32_getpid(void);
 #endif
 #endif
 
+#ifndef OCI_ATTR_CLIENT_IDENTIFIER
+#define OCI_ATTR_CLIENT_IDENTIFIER 278
+#endif
+
 /*
  * Document-class: OCI8
  *
@@ -538,11 +542,11 @@ static VALUE oci8_oracle_server_vernum(VALUE self)
 
     if (have_OCIServerRelease) {
         /* Oracle 9i or later */
-        oci_lc(OCIServerRelease(svcctx->base.hp.ptr, oci8_errhp, (text*)buf, sizeof(buf), svcctx->base.type, &version));
+        oci_lc(OCIServerRelease(svcctx->base.hp.ptr, oci8_errhp, (text*)buf, sizeof(buf), (ub1)svcctx->base.type, &version));
         return UINT2NUM(version);
     } else {
         /* Oracle 8.x */
-        oci_lc(OCIServerVersion(svcctx->base.hp.ptr, oci8_errhp, (text*)buf, sizeof(buf), svcctx->base.type));
+        oci_lc(OCIServerVersion(svcctx->base.hp.ptr, oci8_errhp, (text*)buf, sizeof(buf), (ub1)svcctx->base.type));
         if ((p = strchr(buf, '.')) != NULL) {
             unsigned int major, minor, update, patch, port_update;
             while (p >= buf && *p != ' ') {
@@ -556,6 +560,85 @@ static VALUE oci8_oracle_server_vernum(VALUE self)
     }
 }
 
+/*
+ * call-seq:
+ *   ping -> true or false
+ *
+ * Verifies that the Oracle connection is alive.
+ *
+ * OCI8#ping also can be used to flush all the pending OCI client-side calls
+ * to the server if any exist. See: OCI8#client_identifier=.
+ *
+ * For Oracle 10.2 client or upper, a dummy round trip call is made by a newly
+ * added OCI function in Oracle 10.2.
+ *
+ * For Oracle 10.1 client or lower, a simple PL/SQL block "BEGIN NULL; END;"
+ * is executed to make a round trip call.
+ */
+static VALUE oci8_ping(VALUE self)
+{
+    oci8_svcctx_t *svcctx = oci8_get_svcctx(self);
+    sword rv;
+
+    if (have_OCIPing_nb) {
+        /* Oracle 10.2 or upper */
+        rv = OCIPing_nb(svcctx, svcctx->base.hp.svc, oci8_errhp, OCI_DEFAULT);
+    } else {
+        /* Oracle 10.1 or lower */
+        rv = oci8_exec_sql(svcctx, "BEGIN NULL; END;", 0U, NULL, 0U, NULL, 0);
+    }
+    return rv == OCI_SUCCESS ? Qtrue : FALSE;
+}
+
+/*
+ * call-seq:
+ *   client_identifier = string
+ *
+ * Sets the CLIENT_IDENTIFIER column in the V$SESSION dictionary view.
+ * This can be up to 64 bytes long. The first character should not be ':'.
+ *
+ * If the Oracle client is 9i or upper, the change is not reflected to the
+ * server immediately. It is postponed until the next round trip call for
+ * example OCI8#exec, OCI8#ping, etc.
+ *
+ * This call is equivalent to "DBMS_SESSION.SET_IDENTIFIER(client_id VARCHAR2);"
+ * and available when the server is Oracle 9i or upper.
+ */
+static VALUE oci8_set_client_identifier(VALUE self, VALUE val)
+{
+    OCISession *sess = oci8_get_oci_session(self);
+    char *ptr;
+    ub4 size;
+
+    if (!NIL_P(val)) {
+        OCI8SafeStringValue(val);
+        ptr = RSTRING_PTR(val);
+        size = RSTRING_LEN(val);
+    } else {
+        ptr = "";
+        size = 0;
+    }
+    if (oracle_client_version >= 900) {
+        if (size > 0 && ptr[0] == ':') {
+            rb_raise(rb_eArgError, "client identifier should not start with ':'.");
+        }
+        oci_lc(OCIAttrSet(sess, OCI_HTYPE_SESSION, ptr,
+                          size, OCI_ATTR_CLIENT_IDENTIFIER, oci8_errhp));
+    } else {
+        oci8_exec_sql_var_t bind_vars[1];
+
+        /* :client_id */
+        bind_vars[0].valuep = ptr;
+        bind_vars[0].value_sz = size;
+        bind_vars[0].dty = SQLT_CHR;
+        bind_vars[0].indp = NULL;
+        bind_vars[0].alenp = NULL;
+
+        oci8_exec_sql(oci8_get_svcctx(self), "BEGIN DBMS_SESSION.SET_IDENTIFIER(:client_id); END;", 0, NULL, 1, bind_vars, 1);
+    }
+    return val;
+}
+
 VALUE Init_oci8(void)
 {
     cOCI8 = oci8_define_class("OCI8", &oci8_svcctx_class);
@@ -589,6 +672,8 @@ VALUE Init_oci8(void)
     rb_define_method(cOCI8, "break", oci8_break, 0);
     rb_define_method(cOCI8, "prefetch_rows=", oci8_set_prefetch_rows, 1);
     rb_define_private_method(cOCI8, "oracle_server_vernum", oci8_oracle_server_vernum, 0);
+    rb_define_method(cOCI8, "ping", oci8_ping, 0);
+    rb_define_method(cOCI8, "client_identifier=", oci8_set_client_identifier, 1);
     return cOCI8;
 }