ruby-oci8 2.0.3 → 2.0.4

data/ChangeLog

@@ -1,3 +1,83 @@
+2010-02-28  KUBO Takehiro  <kubo@jiubao.org>
+	* NEWS: add changes between 2.0.3 and 2.0.4.
+	* VERSION: change the version to 2.0.3.
+	* ext/oci8/stmt.c: fix segmentation fault when OCI8::Cursor#fetch
+	    is called prior to OCI8::Cursor#exec.
+	* ext/oci8/oci8.c: minor fix in rdoc comment.
+
+2010-02-27  KUBO Takehiro  <kubo@jiubao.org>
+	* lib/oci8/datetime.rb: fix a problem that fractional seconds are lost
+	    when Time value is bound to TIMESTAMP.
+	    (reported by Raimonds Simanovskis)
+
+2010-02-27  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/error.c, ext/oci8/extconf.rb, ext/oci8/oci8.h: fix for
+	    old Oracle versions, which lack declarations of OCIMsg, oraub8,
+	    orasb8 and OCI_DURATION_PROCESS.
+	* ext/oci8/ocihandle.c: fix for mingw compiler.
+
+2010-02-27  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/apiwrap.yml, ext/oci8/error.c, ext/oci8/oci8.h,
+	  ext/oci8/ocinumber.c: fix for Oracle 8.0 client, which doesn't
+	    have OCIMessageOpen() and OCIMessageGet().
+	* ext/oci8/oci8.c: add a new method OCI8.error_message to get
+	    a error message which depends on NLS_LANGUAGE.
+
+2010-02-09  KUBO Takehiro  <kubo@jiubao.org>
+	* dist-files: add ext/oci8/oranumber_util.c and
+	    ext/oci8/oranumber_util.h.
+	    (reported by Raimonds Simanovskis)
+
+2010-02-07  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/ocinumber.c, ext/oci8/oranumber_util.c,
+	  ext/oci8/oranumber_util.h: change the declaration of
+	    oranumber_to_str() to prevent buffer overflow by
+	    unexpected invalid Oracle number internal data.
+
+2010-02-07  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/error.c, ext/oci8/oci8.h: add oci8_raise_by_msgno()
+	    to retrieve a Oracle error message which depends on NLS_LANGUAGE.
+	* ext/oci8/oranumber_util.c, ext/oci8/oranumber_util.h,
+	  ext/oci8/extconf.rb: add handwritten conversion functions from
+	    OCINumber internal representation to string and vice versa.
+	* ext/oci8/ocinumber.c: 1. use handwritten conversion functions
+	    instead of OCI functions to convert OraNumber to string
+	    and vice varse. 2. add OraNumber#dump.
+	* test/test_oranumber.rb: add test cases to check conversion from
+	    OraNumber to string and vice varse.
+
+2010-02-02  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/ocinumber.c: fix to support NUMBERS with scale larger
+	    than 38 by using scientific number notation to convert OraNumber
+	    to BigDecimal. OraNumber#to_i is also fixed.
+	    (reported by Raimonds Simanovskis)
+
+2010-01-24  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/error.c: Use OCIErrorGet() to retrieve the error message
+	    when the OCI return code is OCI_NO_DATA.
+	    (reported by Raimonds Simanovskis)
+
+2009-12-06  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/object.c: 1. fix segv when GC starts while initializing
+	    a bind object for object type. (reported by Remi Gagnon)
+	    2. fix memory leak about 30 bytes per one bind object for object
+	    type.
+
+2009-11-03  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/object.c: fix segv when binding a collection of string.
+	    (reported by Raimonds Simanovskis)
+
+2009-10-26  KUBO Takehiro  <kubo@jiubao.org>
+	* NEW: fix typo.
+	* dist-files, ext/oci8/.document: add ocihandle.c.
+	* ext/oci8/ocihandle.c: add private methods OCIHandle#attr_get_*,
+	    OCIHandle#attr_set_* and their rdoc comments.
+
+2009-10-23  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, ext/oci8/oci8.h, ext/oci8/oci8lib.c,
+	  ext/oci8/ocihandle.c: add ocihandle.c and move OCIHandle
+	    definitions from oci8lib.c to the file.
+
 2009-10-21  KUBO Takehiro  <kubo@jiubao.org>
 	* NEWS: add changes between 2.0.2 and 2.0.3.
 	* VERSION, Makefile: change the version to 2.0.3.

data/NEWS

@@ -1,6 +1,61 @@
+2.0.4:
+
+* New Features
+
+  - OCI8.error_message(message_no) -> string
+
+    Gets the Oracle error message specified by message id.
+    Its language depends on NLS_LANGUAGE.
+
+    Note: This method is unavailable if the Oracle client
+          version is 8.0.
+
+      # When NLS_LANG is AMERICAN_AMERICA.AL32UTF8
+      OCI8.error_message(1)
+      # => "ORA-00001: unique constraint (%s.%s) violated"
+
+      # When NLS_LANG is FRENCH_FRANCE.AL32UTF8
+      OCI8.error_message(1)
+      # => "ORA-00001: violation de contrainte unique (%s.%s)"
+
+  - OraNumber#dump -> string
+
+    Returns OraNumber's internal representation whose format
+    is same with the return value of Oracle SQL function DUMP().
+  
+      OraNumber.new(100).dump #=> "Typ=2 Len=2: 194,2"
+      OraNumber.new(123).dump #=> "Typ=2 Len=3: 194,2,24"
+      OraNumber.new(0.1).dump #=> "Typ=2 Len=2: 192,11"
+
+* Fixed issues
+
+  - Fractional second part is lost when ruby's Time instance is bound
+    to Oracle datatype TIMESTAMP.
+    (reported by Raimonds Simanovskis)
+
+  - OraNumber#to_i and OraNumber#to_s fail when its scale is larger
+    than 38.
+    (reported by Raimonds Simanovskis)
+
+  - Memory leak about 30 bytes per one place holder for object type.
+ 
+  - Segmentation fault when a collection of string is bound.
+    (reported by Raimonds Simanovskis)
+
+  - Segmentation fault when GC starts while initializing a bind
+    object for object type.
+    (reported by Remi Gagnon)
+
+  - Segmentation fault when OCI8::Cursor#fetch is called prior to
+    OCI8::Cursor#exec.
+
+  - Detailed error message is not reported when PL/SQL NO_DATA_FOUND
+    exception is raised.
+    (reported by Raimonds Simanovskis)
+
 2.0.3:
 
-* Imcompatible Changes
+* Incompatible Changes
 
   - Number column in a SQL statement
 

data/VERSION

@@ -1 +1 @@
-2.0.3
+2.0.4

data/dist-files

@@ -31,9 +31,12 @@ ext/oci8/oci8.c
 ext/oci8/oci8.h
 ext/oci8/oci8lib.c
 ext/oci8/ocidatetime.c
+ext/oci8/ocihandle.c
 ext/oci8/ocinumber.c
 ext/oci8/oraconf.rb
 ext/oci8/oradate.c
+ext/oci8/oranumber_util.c
+ext/oci8/oranumber_util.h
 ext/oci8/post-config.rb
 ext/oci8/stmt.c
 ext/oci8/object.c

data/ext/oci8/.document

@@ -3,6 +3,7 @@
 #env.c
 
 oci8.c
+ocihandle.c
 bind.c
 stmt.c
 encoding.c

data/ext/oci8/apiwrap.yml

@@ -947,6 +947,23 @@ OCILobOpen_nb:
             - OCILobLocator *locp
             - ub1 mode
 
+OCIMessageOpen:
+  :version: 810
+  :args:    - dvoid *envhp
+            - OCIError *errhp
+            - OCIMsg **msghp
+            - CONST OraText *product
+            - CONST OraText *facility
+            - OCIDuration dur
+
+OCIMessageGet:
+  :version: 810
+  :ret:     OraText *
+  :args:    - OCIMsg *msgh
+            - ub4 msgno
+            - OraText *msgbuf
+            - size_t buflen
+
 # round trip: 0
 OCINumberIsInt:
   :version: 810

data/ext/oci8/attr.c

@@ -3,7 +3,7 @@
  * attr.c
  *
  * $Author: kubo $
- * $Date: 2009-10-21 22:50:01 +0900 (Wed, 21 Oct 2009) $
+ * $Date: 2009-05-17 19:08:39 +0900 (Sun, 17 May 2009) $
  *
  * Copyright (C) 2002-2007 KUBO Takehiro <kubo@jiubao.org>
  */

data/ext/oci8/bind.c

@@ -3,7 +3,7 @@
  * bind.c
  *
  * $Author: kubo $
- * $Date: 2009-10-21 22:50:01 +0900 (Wed, 21 Oct 2009) $
+ * $Date: 2009-05-19 21:51:28 +0900 (Tue, 19 May 2009) $
  *
  * Copyright (C) 2002-2008 KUBO Takehiro <kubo@jiubao.org>
  */

data/ext/oci8/error.c

@@ -2,7 +2,7 @@
 /*
   error.c - part of ruby-oci8
 
-  Copyright (C) 2002-2007 KUBO Takehiro <kubo@jiubao.org>
+  Copyright (C) 2002-2010 KUBO Takehiro <kubo@jiubao.org>
 
 =begin
 == OCIError
@@ -28,9 +28,58 @@ static ID oci8_id_sql;
 static ID oci8_id_caller;
 static ID oci8_id_set_backtrace;
 
+#define ERRBUF_EXPAND_LEN 256
+static char *errbuf;
+static ub4 errbufsiz;
+
+static OCIMsg *msghp;
+
+#ifndef OCI_DURATION_PROCESS
+#define OCI_DURATION_PROCESS ((OCIDuration)5)
+#endif
+
 NORETURN(static void oci8_raise2(dvoid *errhp, sword status, ub4 type, OCIStmt *stmthp, const char *file, int line));
 NORETURN(static void set_backtrace_and_raise(VALUE exc, const char *file, int line));
 
+static VALUE get_error_msg(dvoid *errhp, ub4 type, const char *default_msg, sb4 *errcode_p)
+{
+    sword rv;
+    size_t len;
+
+retry:
+    errbuf[0] = '\0';
+    rv = OCIErrorGet(errhp, 1, NULL, errcode_p, TO_ORATEXT(errbuf), errbufsiz, type);
+    /* OCI manual says:
+     *   If type is set to OCI_HTYPE_ERROR, then the return
+     *   code during truncation for OCIErrorGet() is
+     *   OCI_ERROR. The client can then specify a bigger
+     *   buffer and call OCIErrorGet() again.
+     *
+     * But as far as I tested on Oracle XE 10.2.0.1, the return
+     * code is OCI_SUCCESS when the message is truncated.
+     */
+    len = strlen(errbuf);
+    if (errbufsiz - len <= 7) {
+        /* The error message may be truncated.
+         * The magic number 7 means the maximum length of one utf-8
+         * character plus the length of a nul terminator.
+         */
+        errbufsiz += ERRBUF_EXPAND_LEN;
+        errbuf = xrealloc(errbuf, errbufsiz);
+        goto retry;
+    }
+    if (rv != OCI_SUCCESS) {
+        /* No message is found. Use the default message. */
+        return rb_usascii_str_new_cstr(default_msg);
+    }
+
+    /* truncate trailing CR and LF */
+    while (len > 0 && (errbuf[len - 1] == '\n' || errbuf[len - 1] == '\r')) {
+        len--;
+    }
+    return rb_external_str_new_with_enc(errbuf, len, oci8_encoding);
+}
+
 static void oci8_raise2(dvoid *errhp, sword status, ub4 type, OCIStmt *stmthp, const char *file, int line)
 {
     VALUE vcodes = Qnil;
@@ -103,7 +152,7 @@ static void oci8_raise2(dvoid *errhp, sword status, ub4 type, OCIStmt *stmthp, c
         break;
     case OCI_NO_DATA:
         exc = eOCINoData;
-        msg = rb_usascii_str_new_cstr("No Data");
+        msg = get_error_msg(errhp, type, "No Data", &errcode);
         break;
     case OCI_INVALID_HANDLE:
         exc = eOCIInvalidHandle;
@@ -252,6 +301,9 @@ sb4 oci8_get_error_code(OCIError *errhp)
 
 void Init_oci8_error(void)
 {
+    errbufsiz = ERRBUF_EXPAND_LEN;
+    errbuf = xmalloc(errbufsiz);
+
     oci8_id_code = rb_intern("code");
     oci8_id_message = rb_intern("message");
     oci8_id_parse_error_offset = rb_intern("parse_error_offset");
@@ -301,3 +353,40 @@ void oci8_do_raise_init_error(const char *file, int line)
     rb_ivar_set(exc, oci8_id_message, rb_ary_new3(1, msg));
     set_backtrace_and_raise(exc, file, line);
 }
+
+VALUE oci8_get_error_message(ub4 msgno, const char *default_msg)
+{
+    char head[32];
+    size_t headsz;
+    const char *errmsg = NULL;
+    char msgbuf[64];
+
+    if (have_OCIMessageGet) {
+        if (msghp == NULL) {
+            oci_lc(OCIMessageOpen(oci8_envhp, oci8_errhp, &msghp, TO_ORATEXT("rdbms"), TO_ORATEXT("ora"), OCI_DURATION_PROCESS));
+        }
+        errmsg = TO_CHARPTR(OCIMessageGet(msghp, msgno, NULL, 0));
+    }
+    if (errmsg == NULL) {
+        if (default_msg != NULL) {
+            errmsg = default_msg;
+        } else {
+            /* last resort */
+            snprintf(msgbuf, sizeof(msgbuf), "Message %u not found;  product=rdbms; facility=ora", msgno);
+            errmsg = msgbuf;
+        }
+    }
+    headsz = snprintf(head, sizeof(head), "ORA-%05u: ", msgno);
+    return rb_str_append(rb_usascii_str_new(head, headsz),
+                         rb_external_str_new_with_enc(errmsg, strlen(errmsg), oci8_encoding));
+}
+
+void oci8_do_raise_by_msgno(ub4 msgno, const char *default_msg, const char *file, int line)
+{
+    VALUE msg = oci8_get_error_message(msgno, default_msg);
+    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));
+    set_backtrace_and_raise(exc, file, line);
+}

data/ext/oci8/extconf.rb

@@ -69,6 +69,7 @@ have_type('OCIInterval*', 'ociap.h')
 have_type('OCICallbackLobRead2', 'ociap.h')
 have_type('OCICallbackLobWrite2', 'ociap.h')
 have_type('OCIAdmin*', 'ociap.h')
+have_type('OCIMsg*', 'ociap.h')
 
 if with_config('oracle-version')
   oci_client_version = OCI8::OracleVersion.new(with_config('oracle-version')).to_i
@@ -82,11 +83,11 @@ if with_config('runtime-check')
   $libs = saved_libs
 end
 
-$objs = ["oci8lib.o", "env.o", "error.o", "oci8.o",
+$objs = ["oci8lib.o", "env.o", "error.o", "oci8.o", "ocihandle.o",
          "stmt.o", "bind.o", "metadata.o", "attr.o",
          "lob.o", "oradate.o",
          "ocinumber.o", "ocidatetime.o", "object.o", "apiwrap.o",
-         "encoding.o", "xmldb.o"]
+         "encoding.o", "xmldb.o", "oranumber_util.o"]
 
 if RUBY_PLATFORM =~ /mswin32|cygwin|mingw32|bccwin32/
   $defs << "-DUSE_WIN32_C"

data/ext/oci8/object.c

@@ -300,11 +300,11 @@ static VALUE oci8_named_coll_set_coll_element(VALUE self, VALUE datatype, VALUE
     switch (FIX2INT(datatype)) {
     case ATTR_STRING:
         oci_lc(OCIObjectNew(oci8_envhp, oci8_errhp, svcctx->hp.svc, OCI_TYPECODE_VARCHAR2, NULL, NULL, OCI_DURATION_SESSION, TRUE, &cb_data.data.ptr));
-        oci_lc(OCIObjectGetInd(oci8_envhp, oci8_errhp, cb_data.data.ptr, (dvoid**)&cb_data.indp));
+        cb_data.indp = &cb_data.ind;
         break;
     case ATTR_RAW:
         oci_lc(OCIObjectNew(oci8_envhp, oci8_errhp, svcctx->hp.svc, OCI_TYPECODE_RAW, NULL, NULL, OCI_DURATION_SESSION, TRUE, &cb_data.data.ptr));
-        oci_lc(OCIObjectGetInd(oci8_envhp, oci8_errhp, cb_data.data.ptr, (dvoid**)&cb_data.indp));
+        cb_data.indp = &cb_data.ind;
         break;
     case ATTR_OCINUMBER:
     case ATTR_FLOAT:
@@ -498,11 +498,14 @@ static void bind_named_type_mark(oci8_base_t *base)
 {
     oci8_bind_t *obind = (oci8_bind_t *)base;
     oci8_hp_obj_t *oho = (oci8_hp_obj_t *)obind->valuep;
-    ub4 idx = 0;
 
-    do {
-        rb_gc_mark(oho[idx].obj);
-    } while (++idx < obind->maxar_sz);
+    if (oho != NULL) {
+        ub4 idx = 0;
+
+        do {
+            rb_gc_mark(oho[idx].obj);
+        } while (++idx < obind->maxar_sz);
+    }
     rb_gc_mark(obind->tdo);
 }
 
@@ -510,14 +513,18 @@ static void bind_named_type_free(oci8_base_t *base)
 {
     oci8_bind_t *obind = (oci8_bind_t *)base;
     oci8_hp_obj_t *oho = (oci8_hp_obj_t *)obind->valuep;
-    ub4 idx = 0;
 
-    do {
-        if (oho[idx].hp != NULL) {
-            OCIObjectFree(oci8_envhp, oci8_errhp, oho[idx].hp, OCI_DEFAULT);
-            oho[idx].hp = NULL;
-        }
-    } while (++idx < obind->maxar_sz);
+    if (oho != NULL) {
+        ub4 idx = 0;
+
+        do {
+            if (oho[idx].hp != NULL) {
+                OCIObjectFree(oci8_envhp, oci8_errhp, oho[idx].hp, OCI_DEFAULT);
+                oho[idx].hp = NULL;
+            }
+        } while (++idx < obind->maxar_sz);
+    }
+    oci8_bind_free(base);
 }
 
 static VALUE bind_named_type_get(oci8_bind_t *obind, void *data, void *null_struct)

data/ext/oci8/oci8.c

@@ -64,6 +64,28 @@ static VALUE oci8_s_oracle_client_vernum(VALUE klass)
     return oracle_client_vernum;
 }
 
+/*
+ * call-seq:
+ *   OCI8.error_message(message_no) -> string
+ *
+ * Get the Oracle error message specified by message_no.
+ * Its language depends on NLS_LANGUAGE.
+ *
+ * Note: This method is unavailable if the Oracle client version is 8.0.
+ *
+ * example:
+ *   # When NLS_LANG is AMERICAN_AMERICA.AL32UTF8
+ *   OCI8.error_message(1) # => "ORA-00001: unique constraint (%s.%s) violated"
+ *   
+ *   # When NLS_LANG is FRENCH_FRANCE.AL32UTF8
+ *   OCI8.error_message(1) # => "ORA-00001: violation de contrainte unique (%s.%s)"
+ *
+ */
+static VALUE oci8_s_error_message(VALUE klass, VALUE msgid)
+{
+    return oci8_get_error_message(NUM2UINT(msgid), NULL);
+}
+
 #define CONN_STR_REGEX "/^([^(\\s|\\@)]*)\\/([^(\\s|\\@)]*)(?:\\@(\\S+))?(?:\\s+as\\s+(\\S*)\\s*)?$/i"
 static void oci8_do_parse_connect_string(VALUE conn_str, VALUE *user, VALUE *pass, VALUE *dbname, VALUE *mode)
 {
@@ -942,6 +964,9 @@ VALUE Init_oci8(void)
     id_set_prefetch_rows = rb_intern("prefetch_rows=");
 
     rb_define_singleton_method_nodoc(cOCI8, "oracle_client_vernum", oci8_s_oracle_client_vernum, 0);
+    if (have_OCIMessageOpen && have_OCIMessageGet) {
+        rb_define_singleton_method(cOCI8, "error_message", oci8_s_error_message, 1);
+    }
     rb_define_private_method(cOCI8, "parse_connect_string", oci8_parse_connect_string, 1);
     rb_define_method(cOCI8, "initialize", oci8_svcctx_initialize, -1);
     rb_define_method(cOCI8, "logoff", oci8_svcctx_logoff, 0);