ruby-oci8 1.0.7 → 2.0.0

data/ext/oci8/error.c

@@ -1,7 +1,8 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
 /*
   error.c - part of ruby-oci8
 
-  Copyright (C) 2002 KUBO Takehiro <kubo@jiubao.org>
+  Copyright (C) 2002-2007 KUBO Takehiro <kubo@jiubao.org>
 
 =begin
 == OCIError
@@ -9,133 +10,173 @@
 */
 #include "oci8.h"
 
+/* Exception */
+VALUE eOCIException;
+VALUE eOCIBreak;
+static VALUE eOCINoData;
+static VALUE eOCIError;
+static VALUE eOCIInvalidHandle;
+static VALUE eOCINeedData;
+static VALUE eOCIStillExecuting;
+static VALUE eOCIContinue;
+static VALUE eOCISuccessWithInfo;
+
+static ID oci8_id_code;
+static ID oci8_id_message;
+static ID oci8_id_parse_error_offset;
+static ID oci8_id_sql;
 static ID oci8_id_caller;
 static ID oci8_id_set_backtrace;
 
-RBOCI_NORETURN(static void oci8_raise2(dvoid *errhp, sword status, ub4 type, OCIStmt *stmthp, const char *file, int line));
+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 void oci8_raise2(dvoid *errhp, sword status, ub4 type, OCIStmt *stmthp, const char *file, int line)
 {
-  VALUE vcodes = Qnil;
-  VALUE vmessages = Qnil;
-  VALUE exc;
-  char errmsg[1024];
-  sb4 errcode;
-  ub4 recodeno;
-  VALUE msg;
+    VALUE vcodes = Qnil;
+    VALUE vmessages = Qnil;
+    VALUE exc;
+    char errmsg[1024];
+    sb4 errcode;
+    ub4 recodeno;
+    VALUE msg;
 #ifdef OCI_ATTR_PARSE_ERROR_OFFSET
-  VALUE vparse_error_offset = Qnil;
+    VALUE vparse_error_offset = Qnil;
 #endif
 #ifdef OCI_ATTR_STATEMENT
-  VALUE vsql = Qnil;
-#endif
-  int i;
-  int rv;
-  VALUE backtrace;
-#if defined(_WIN32) || defined(WIN32)
-  char *p = strrchr(file, '\\');
-  if (p != NULL)
-    file = p + 1;
+    VALUE vsql = Qnil;
 #endif
+    int i;
+    int rv;
 
-  switch (status) {
-  case OCI_ERROR:
-  case OCI_SUCCESS_WITH_INFO:
-    vcodes = rb_ary_new();
-    vmessages = rb_ary_new();
-    for (recodeno = 1;;recodeno++) {
-      /* get error string */
-      rv = OCIErrorGet(errhp, recodeno, NULL, &errcode, TO_ORATEXT(errmsg), sizeof(errmsg), type);
-      if (rv != OCI_SUCCESS) {
+    switch (status) {
+    case OCI_ERROR:
+    case OCI_SUCCESS_WITH_INFO:
+        vcodes = rb_ary_new();
+        vmessages = rb_ary_new();
+        for (recodeno = 1;;recodeno++) {
+            /* get error string */
+            rv = OCIErrorGet(errhp, recodeno, NULL, &errcode, TO_ORATEXT(errmsg), sizeof(errmsg), type);
+            if (rv != OCI_SUCCESS) {
+                break;
+            }
+            /* chop error string */
+            for (i = strlen(errmsg) - 1;i >= 0;i--) {
+                if (errmsg[i] == '\n' || errmsg[i] == '\r') {
+                    errmsg[i] = '\0';
+                } else {
+                    break;
+                }
+            }
+            rb_ary_push(vcodes, INT2FIX(errcode));
+            rb_ary_push(vmessages, rb_external_str_new_with_enc(errmsg, strlen(errmsg), oci8_encoding));
+        }
+        if (RARRAY_LEN(vmessages) > 0) {
+            msg = RARRAY_PTR(vmessages)[0];
+        } else {
+            msg = rb_usascii_str_new_cstr("ERROR");
+        }
+        if (status == OCI_ERROR) {
+            exc = eOCIError;
+        } else {
+            exc = eOCISuccessWithInfo;
+        }
+#ifdef OCI_ATTR_PARSE_ERROR_OFFSET
+        if (stmthp != NULL) {
+            ub2 offset;
+            rv = OCIAttrGet(stmthp, OCI_HTYPE_STMT, &offset, 0, OCI_ATTR_PARSE_ERROR_OFFSET, errhp);
+            if (rv == OCI_SUCCESS) {
+                vparse_error_offset = INT2FIX(offset);
+            }
+        }
+#endif
+#ifdef OCI_ATTR_STATEMENT
+        if (stmthp != NULL) {
+            text *sql;
+            ub4 size;
+            rv = OCIAttrGet(stmthp, OCI_HTYPE_STMT, &sql, &size, OCI_ATTR_STATEMENT, errhp);
+            if (rv == OCI_SUCCESS) {
+                vsql = rb_external_str_new_with_enc(TO_CHARPTR(sql), size, oci8_encoding);
+            }
+        }
+#endif
+        break;
+    case OCI_NO_DATA:
+        exc = eOCINoData;
+        msg = rb_usascii_str_new_cstr("No Data");
+        break;
+    case OCI_INVALID_HANDLE:
+        exc = eOCIInvalidHandle;
+        msg = rb_usascii_str_new_cstr("Invalid Handle");
+        break;
+    case OCI_NEED_DATA:
+        exc = eOCINeedData;
+        msg = rb_usascii_str_new_cstr("Need Data");
         break;
-      }
-      /* chop error string */
-      for (i = strlen(errmsg) - 1;i >= 0;i--) {
-	if (errmsg[i] == '\n' || errmsg[i] == '\r') {
-	  errmsg[i] = '\0';
-	} else {
-	  break;
-	}
-      }
-      rb_ary_push(vcodes, INT2FIX(errcode));
-      rb_ary_push(vmessages, rb_str_new2(errmsg));
+    case OCI_STILL_EXECUTING:
+        exc = eOCIStillExecuting;
+        msg = rb_usascii_str_new_cstr("Still Executing");
+        break;
+    case OCI_CONTINUE:
+        exc = eOCIContinue;
+        msg = rb_usascii_str_new_cstr("Continue");
+        break;
+    default:
+        sprintf(errmsg, "Unknown error (%d)", status);
+        exc = rb_eStandardError;
+        msg = rb_usascii_str_new_cstr(errmsg);
     }
-    if (RARRAY_LEN(vmessages) > 0) {
-      msg = RARRAY_PTR(vmessages)[0];
-    } else {
-      msg = rb_str_new2("ERROR");
+    exc = rb_funcall(exc, oci8_id_new, 1, msg);
+    if (!NIL_P(vcodes)) {
+        rb_ivar_set(exc, oci8_id_code, vcodes);
     }
-    if (status == OCI_ERROR) {
-      exc = eOCIError;
-    } else {
-      exc = eOCISuccessWithInfo;
+    if (!NIL_P(vmessages)) {
+        rb_ivar_set(exc, oci8_id_message, vmessages);
     }
-    break;
-  case OCI_NO_DATA:
-    exc = eOCINoData;
-    msg = rb_str_new2("No Data");
-    break;
-  case OCI_INVALID_HANDLE:
-    exc = eOCIInvalidHandle;
-    msg = rb_str_new2("Invalid Handle");
-    break;
-  case OCI_NEED_DATA:
-    exc = eOCINeedData;
-    msg = rb_str_new2("Need Data");
-    break;
-  case OCI_STILL_EXECUTING:
-    exc = eOCIStillExecuting;
-    msg = rb_str_new2("Still Executing");
-    break;
-  case OCI_CONTINUE:
-    exc = eOCIContinue;
-    msg = rb_str_new2("Continue");
-    break;
-  default:
-    sprintf(errmsg, "Unknown error (%d)", status);
-    exc = rb_eStandardError;
-    msg = rb_str_new2(errmsg);
-  }
-  exc = rb_funcall(exc, oci8_id_new, 1, msg);
-  if (!NIL_P(vcodes)) {
-    rb_ivar_set(exc, oci8_id_code, vcodes);
-  }
-  if (!NIL_P(vmessages)) {
-    rb_ivar_set(exc, oci8_id_message, vmessages);
-  }
 #ifdef OCI_ATTR_PARSE_ERROR_OFFSET
-  if (!NIL_P(vparse_error_offset)) {
-    rb_ivar_set(exc, oci8_id_parse_error_offset, vparse_error_offset);
-  }
+    if (!NIL_P(vparse_error_offset)) {
+        rb_ivar_set(exc, oci8_id_parse_error_offset, vparse_error_offset);
+    }
 #endif
 #ifdef OCI_ATTR_STATEMENT
-  if (!NIL_P(vsql)) {
-    rb_ivar_set(exc, oci8_id_sql, vsql);
-  }
+    if (!NIL_P(vsql)) {
+        rb_ivar_set(exc, oci8_id_sql, vsql);
+    }
 #endif
-  /*
-   * make error line in C code.
-   */
-  backtrace = rb_funcall(rb_cObject, rb_intern("caller"), 0);
-  sprintf(errmsg, "%s:%d:in oci8lib.so", file, line);
-  rb_ary_unshift(backtrace, rb_str_new2(errmsg));
-  rb_funcall(exc, rb_intern("set_backtrace"), 1, backtrace);
-  rb_exc_raise(exc);
+    set_backtrace_and_raise(exc, file, line);
 }
 
-static VALUE oci8_error_initialize(int argc, VALUE *argv, VALUE self)
+static void set_backtrace_and_raise(VALUE exc, const char *file, int line)
 {
-  VALUE msg;
-  VALUE code;
-
-  rb_scan_args(argc, argv, "02", &msg, &code);
-  rb_call_super(argc > 1 ? 1 : argc, argv);
-  if (!NIL_P(code)) {
-    rb_ivar_set(self, oci8_id_code, rb_ary_new3(1, code));
-  }
-  return Qnil;
+    char errmsg[64];
+    VALUE backtrace;
+#ifdef _WIN32
+    char *p = strrchr(file, '\\');
+    if (p != NULL)
+        file = p + 1;
+#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);
+        errmsg[sizeof(errmsg) - 1] = '\0';
+        rb_ary_unshift(backtrace, rb_usascii_str_new_cstr(errmsg));
+        rb_funcall(exc, oci8_id_set_backtrace, 1, backtrace);
+    }
+    rb_exc_raise(exc);
 }
 
+static VALUE oci8_error_initialize(int argc, VALUE *argv, VALUE self)
+{
+    VALUE msg;
+    VALUE code;
+
+    rb_scan_args(argc, argv, "02", &msg, &code);
+    rb_call_super(argc > 1 ? 1 : argc, argv);
+    if (!NIL_P(code)) {
+        rb_ivar_set(self, oci8_id_code, rb_ary_new3(1, code));
+    }
+    return Qnil;
+}
 
 /*
 =begin
@@ -144,15 +185,11 @@ static VALUE oci8_error_initialize(int argc, VALUE *argv, VALUE self)
 */
 static VALUE oci8_error_code(VALUE self)
 {
-  VALUE ary = rb_ivar_get(self, oci8_id_code);
-  if (NIL_P(ary)) {
-    return Qnil;
-  }
-  Check_Type(ary, T_ARRAY);
-  if (RARRAY_LEN(ary) == 0) {
-    return Qnil;
-  }
-  return RARRAY_PTR(ary)[0];
+    VALUE ary = rb_ivar_get(self, oci8_id_code);
+    if (RARRAY_LEN(ary) == 0) {
+        return Qnil;
+    }
+    return RARRAY_PTR(ary)[0];
 }
 
 /*
@@ -162,7 +199,7 @@ static VALUE oci8_error_code(VALUE self)
 */
 static VALUE oci8_error_code_array(VALUE self)
 {
-  return rb_ivar_get(self, oci8_id_code);
+    return rb_ivar_get(self, oci8_id_code);
 }
 
 /*
@@ -178,7 +215,7 @@ static VALUE oci8_error_code_array(VALUE self)
 */
 static VALUE oci8_error_message_array(VALUE self)
 {
-  return rb_ivar_get(self, oci8_id_message);
+    return rb_ivar_get(self, oci8_id_message);
 }
 
 #ifdef OCI_ATTR_PARSE_ERROR_OFFSET
@@ -189,7 +226,7 @@ static VALUE oci8_error_message_array(VALUE self)
 */
 static VALUE oci8_error_parse_error_offset(VALUE self)
 {
-  return rb_ivar_get(self, oci8_id_parse_error_offset);
+    return rb_ivar_get(self, oci8_id_parse_error_offset);
 }
 #endif
 
@@ -202,33 +239,65 @@ static VALUE oci8_error_parse_error_offset(VALUE self)
 */
 static VALUE oci8_error_sql(VALUE self)
 {
-  return rb_ivar_get(self, oci8_id_sql);
+    return rb_ivar_get(self, oci8_id_sql);
 }
 #endif
 
+sb4 oci8_get_error_code(OCIError *errhp)
+{
+    sb4 errcode = -1;
+    OCIErrorGet(oci8_errhp, 1, NULL, &errcode, NULL, 0, OCI_HTYPE_ERROR);
+    return errcode;
+}
+
 void Init_oci8_error(void)
 {
-  oci8_id_caller = rb_intern("caller");
-  oci8_id_set_backtrace = rb_intern("set_backtrace");
+    oci8_id_code = rb_intern("code");
+    oci8_id_message = rb_intern("message");
+    oci8_id_parse_error_offset = rb_intern("parse_error_offset");
+    oci8_id_sql = rb_intern("sql");
+    oci8_id_caller = rb_intern("caller");
+    oci8_id_set_backtrace = rb_intern("set_backtrace");
+
+    eOCIException = rb_define_class("OCIException", rb_eStandardError);
+    eOCIBreak = rb_define_class("OCIBreak", eOCIException);
+
+    eOCINoData = rb_define_class("OCINoData", eOCIException);
+    eOCIError = rb_define_class("OCIError", eOCIException);
+    eOCIInvalidHandle = rb_define_class("OCIInvalidHandle", eOCIException);
+    eOCINeedData = rb_define_class("OCINeedData", eOCIException);
+    eOCIStillExecuting = rb_define_class("OCIStillExecuting", eOCIException);
+    eOCIContinue = rb_define_class("OCIContinue", eOCIException);
+    eOCISuccessWithInfo = rb_define_class("OCISuccessWithInfo", eOCIError);
 
-  rb_define_method(eOCIError, "initialize", oci8_error_initialize, -1);
-  rb_define_method(eOCIError, "code", oci8_error_code, 0);
-  rb_define_method(eOCIError, "codes", oci8_error_code_array, 0);
-  rb_define_method(eOCIError, "messages", oci8_error_message_array, 0);
+    rb_define_method(eOCIError, "initialize", oci8_error_initialize, -1);
+    rb_define_method(eOCIError, "code", oci8_error_code, 0);
+    rb_define_method(eOCIError, "codes", oci8_error_code_array, 0);
+    rb_define_method(eOCIError, "messages", oci8_error_message_array, 0);
 #ifdef OCI_ATTR_PARSE_ERROR_OFFSET
-  rb_define_method(eOCIError, "parseErrorOffset", oci8_error_parse_error_offset, 0);
+    rb_define_method(eOCIError, "parseErrorOffset", oci8_error_parse_error_offset, 0);
 #endif
 #ifdef OCI_ATTR_STATEMENT
-  rb_define_method(eOCIError, "sql", oci8_error_sql, 0);
+    rb_define_method(eOCIError, "sql", oci8_error_sql, 0);
 #endif
 }
 
 void oci8_do_raise(OCIError *errhp, sword status, OCIStmt *stmthp, const char *file, int line)
 {
-  oci8_raise2(errhp, status, OCI_HTYPE_ERROR, stmthp, file, line);
+    oci8_raise2(errhp, status, OCI_HTYPE_ERROR, stmthp, file, line);
 }
 
 void oci8_do_env_raise(OCIEnv *envhp, sword status, const char *file, int line)
 {
-  oci8_raise2(envhp, status, OCI_HTYPE_ENV, NULL, file, line);
+    oci8_raise2(envhp, status, OCI_HTYPE_ENV, NULL, file, line);
+}
+
+void oci8_do_raise_init_error(const char *file, int line)
+{
+    VALUE msg = rb_usascii_str_new_cstr("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));
+    set_backtrace_and_raise(exc, file, line);
 }

data/ext/oci8/extconf.rb

@@ -1,11 +1,3 @@
-raise <<EOS if RUBY_VERSION.index("1.9") == 0
----------------------------------------------------
-error message:
-ruby-oci8 1.0 is not supported by ruby #{RUBY_VERSION}.
-Use ruby-oci8 2.0 in SVN trunk.
----------------------------------------------------
-EOS
-
 begin
   require 'mkmf'
 rescue LoadError
@@ -18,8 +10,9 @@ EOS
 end
 
 require File.dirname(__FILE__) + '/oraconf'
+require File.dirname(__FILE__) + '/apiwrap'
 
-RUBY_OCI8_VERSION = open("#{File.dirname(__FILE__)}/../../VERSION") {|f| f.read}.chomp
+RUBY_OCI8_VERSION = File.read("#{File.dirname(__FILE__)}/../../VERSION").chomp
 
 oraconf = OraConf.get()
 
@@ -36,58 +29,81 @@ def replace_keyword(source, target, replace)
   }        
 end
 
-$objs = ["oci8.o", "handle.o", "const.o", "env.o", "error.o", "svcctx.o",
-         "server.o", "session.o", "stmt.o", "define.o", "bind.o",
-         "describe.o", "descriptor.o", "param.o", "lob.o",
-         "oradate.o", "oranumber.o", "ocinumber.o", "attr.o"]
-
 $CFLAGS += oraconf.cflags
+saved_libs = $libs
 $libs += oraconf.libs
 
-have_type('oratext', 'ociap.h')
-
-# OCIEnvCreate
-#   8.0.5  - NG
-#   9.0.1  - OK
-have_func("OCIEnvCreate")
-
-# OCITerminate
-#   8.0.5  - NG
-#   9.0.1  - OK
-have_func("OCITerminate")
-
-# OCIServerRelease
-#   8.1.5  - NG
-#   8.1.7  - OK
-#have_func("OCIServerRelease")
-
-# OCILobOpen
-#   8.0.5  - NG
-#   9.0.1  - OK
-have_func("OCILobOpen")
-
-# OCILobClose
-#   8.0.5  - NG
-#   9.0.1  - OK
-have_func("OCILobClose")
+oci_actual_client_version = 0x08000000
+funcs = {}
+YAML.load(open(File.dirname(__FILE__) + '/apiwrap.yml')).each do |key, val|
+  key = key[0..-4] if key[-3..-1] == '_nb'
+  ver = val[:version]
+  ver_major = (ver / 100)
+  ver_minor = (ver / 10) % 10
+  ver_update = ver % 10
+  ver = ((ver_major << 24) | (ver_minor << 20) | (ver_update << 12))
+  funcs[ver] ||= []
+  funcs[ver] << key
+end
+funcs.keys.sort.each do |version|
+  next if version == 0x08000000
+  verstr = format('%d.%d.%d', ((version >> 24) & 0xFF), ((version >> 20) & 0xF), ((version >> 12) & 0xFF))
+  puts "checking for Oracle #{verstr} API - start"
+  result = catch :result do
+    funcs[version].sort.each do |func|
+      unless have_func(func)
+        throw :result, "fail"
+      end
+    end
+    oci_actual_client_version = version
+    "pass"
+  end
+  puts "checking for Oracle #{verstr} API - #{result}"
+  break if result == 'fail'
+end
+$defs << "-DACTUAL_ORACLE_CLIENT_VERSION=#{format('0x%08x', oci_actual_client_version)}"
 
-# OCILobCreateTemporary
-#   8.0.5  - NG
-#   8.1.5  - OK
-have_func("OCILobCreateTemporary")
+if with_config('oracle-version')
+  oci_client_version = with_config('oracle-version').to_i
+else
+  oci_client_version = oci_actual_client_version
+end
+$defs << "-DORACLE_CLIENT_VERSION=#{format('0x%08x', oci_client_version)}"
 
-have_func("OCILobGetChunkSize")
-have_func("OCILobLocatorAssign")
+if with_config('runtime-check')
+  $defs << "-DRUNTIME_API_CHECK=1"
+  $libs = saved_libs
+end
 
-have_func("OCIRowidToChar")
+$objs = ["oci8lib.o", "env.o", "error.o", "oci8.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"]
 
-$defs.push("-DHAVE_OCIRESET") unless /80./ =~ oraconf.version
+if RUBY_PLATFORM =~ /mswin32|cygwin|mingw32|bccwin32/
+  $defs << "-DUSE_WIN32_C"
+  $objs << "win32.o"
+end
 
 # Checking gcc or not
 if oraconf.cc_is_gcc
   $CFLAGS += " -Wall"
 end
 
+have_func("localtime_r")
+
+# ruby 1.8 headers
+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
+have_var("ruby_errinfo", "ruby.h") # ruby 1.8
+have_func("rb_errinfo", "ruby.h")  # ruby 1.9
+
 # replace files
 replace = {
   'OCI8_CLIENT_VERSION' => oraconf.version,
@@ -98,25 +114,32 @@ replace = {
 replace_keyword(File.dirname(__FILE__) + '/../../lib/oci8.rb.in', '../../lib/oci8.rb', replace)
 
 create_header()
-$defs = []
 
 # make dependency file
 open("depend", "w") do |f|
-  f.puts("Makefile: extconf.rb oraconf.rb")
-  f.puts("\t$(RUBY) extconf.rb")
+  extconf_opt = ''
+  ['oracle-version', 'runtime-check'].each do |arg|
+    opt = with_config(arg)
+    case opt
+    when String
+      extconf_opt += " --with-#{arg}=#{opt}"
+    when true
+      extconf_opt += " --with-#{arg}=yes"
+    when false
+      extconf_opt += " --with-#{arg}=no"
+    end
+  end
+  f.puts("Makefile: $(srcdir)/extconf.rb $(srcdir)/oraconf.rb")
+  f.puts("\t$(RUBY) $(srcdir)/extconf.rb#{extconf_opt}")
   $objs.each do |obj|
-    f.puts("#{obj}: $(srcdir)/#{obj.sub(/\.o$/, ".c")} $(srcdir)/oci8.h Makefile")
+    f.puts("#{obj}: $(srcdir)/#{obj.sub(/\.o$/, ".c")} $(srcdir)/oci8.h apiwrap.h Makefile")
   end
+  f.puts("apiwrap.c apiwrap.h: $(srcdir)/apiwrap.c.tmpl $(srcdir)/apiwrap.h.tmpl $(srcdir)/apiwrap.yml $(srcdir)/apiwrap.rb")
+  f.puts("\t$(RUBY) $(srcdir)/apiwrap.rb")
 end
 
+create_apiwrap()
 
 create_makefile("oci8lib")
 
-# append version info to extconf.h
-open("extconf.h", "a") do |f|
-  replace.each do |key, value|
-    f.puts("#define #{key} \"#{value}\"")
-  end
-end
-
 exit 0