ruby-oci8 2.1.8 → 2.2.0.1

data/ext/oci8/thread_util.h

@@ -4,7 +4,6 @@
  *
  * Copyright (C) 2011 KUBO Takehiro <kubo@jiubao.org>
  */
-#ifdef USE_THREAD_LOCAL_ERRHP
 
 /*
  * Prepare to execute thread-related functions.
@@ -17,14 +16,3 @@ void Init_oci8_thread_util(void);
  * The return value is errno.
  */
 int oci8_run_native_thread(void *(*func)(void *), void *arg);
-
-#else
-
-/*
- * For ruby 1.8 configured without --enable-pthread on Unix.
- */
-
-#define Init_oci8_thread_util() do {} while (0)
-#define oci8_run_native_thread(func, arg) ((func)(arg), 0)
-
-#endif

data/ext/oci8/util.c

@@ -0,0 +1,71 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
+/*
+  util.c - part of ruby-oci8
+
+  Copyright (C) 2015 Kubo Takehiro <kubo@jiubao.org>
+*/
+#if defined __linux && !defined(_GNU_SOURCE)
+#define _GNU_SOURCE 1
+#endif
+#include "oci8.h"
+#ifdef HAVE_DLADDR
+#include <dlfcn.h>
+#endif
+#ifdef __CYGWIN__
+#undef boolean
+#include <windows.h>
+#endif
+
+const char *oci8_dll_path(void)
+{
+#if defined _WIN32 || defined __CYGWIN__
+    HMODULE hMod = GetModuleHandleA("OCI.DLL");
+    static char buf[MAX_PATH];
+    if (hMod != NULL) {
+        if (GetModuleFileName(hMod, buf, sizeof(buf))) {
+            return buf;
+        }
+    }
+#elif defined HAVE_DLADDR && defined RTLD_DEFAULT
+    void *addr = dlsym(RTLD_DEFAULT, "OCIEnvCreate");
+    Dl_info info;
+    if (addr != NULL && dladdr(addr, &info)) {
+        return info.dli_fname;
+    }
+#elif defined HAVE_DLMODINFO && defined HAVE_DLGETNAME && defined RTLD_DEFAULT
+    void *addr = dlsym(RTLD_DEFAULT, "OCIEnvCreate");
+    if (addr != NULL) {
+        struct load_module_desc desc;
+        if (dlmodinfo((uint64_t)addr, &desc, sizeof(desc), NULL, 0, 0) != 0) {
+            return dlgetname(&desc, sizeof(desc), NULL, 0, 0);
+        }
+    }
+#endif
+    return NULL;
+}
+
+/*
+ *  Returns the full path of Oracle client library used by the current process.
+ *
+ *  @return [String]
+ */
+static VALUE dll_path(VALUE module)
+{
+    const char *path = oci8_dll_path();
+    if (path == NULL) {
+        return Qnil;
+    }
+    return rb_external_str_new_with_enc(path, strlen(path), rb_filesystem_encoding());
+}
+
+void Init_oci8_util(VALUE cOCI8)
+{
+#if 0
+    /* for yard */
+    cOCIHandle = rb_define_class("OCIHandle", rb_cObject);
+    cOCI8 = rb_define_class("OCI8", cOCIHandle);
+#endif
+    VALUE mUtil = rb_define_module_under(cOCI8, "Util");
+
+    rb_define_module_function(mUtil, "dll_path", dll_path, 0);
+}

data/ext/oci8/win32.c

@@ -2,7 +2,7 @@
 /*
   win32.c - part of ruby-oci8
 
-  Copyright (C) 2009-2010 KUBO Takehiro <kubo@jiubao.org>
+  Copyright (C) 2009-2015 Kubo Takehiro <kubo@jiubao.org>
 */
 #include "oci8.h"
 #ifdef __CYGWIN__
@@ -41,29 +41,6 @@ static void raise_error(void)
     rb_raise(rb_eRuntimeError, "%s", msg);
 }
 
-/*
- *  Returns the full path of OCI.DLL used by the current process.
- *
- *  @return [String]
- */
-static VALUE dll_path(VALUE module)
-{
-    HMODULE hModule;
-    DWORD len;
-    char path[1024];
-
-    hModule = GetModuleHandle("OCI.DLL");
-    if (hModule == NULL) {
-        raise_error();
-    }
-    len = GetModuleFileName(hModule, path, sizeof(path));
-    if (len == 0) {
-        raise_error();
-    }
-    return rb_external_str_new_with_enc(path, len, rb_filesystem_encoding());
-}
-
-
 typedef struct {
     HKEY hKey;
     HKEY hSubKey;
@@ -154,6 +131,5 @@ void Init_oci8_win32(VALUE cOCI8)
 {
     VALUE mWin32Util = rb_define_module_under(cOCI8, "Win32Util");
 
-    rb_define_module_function(mWin32Util, "dll_path", dll_path, 0);
     rb_define_module_function(mWin32Util, "enum_homes", enum_homes, 0);
 }

data/lib/{oci8.rb.in → oci8.rb}

@@ -67,12 +67,20 @@ when 'jruby'
 else
   raise 'unsupported ruby engine: ' + RUBY_ENGINE
 end
-require so_basename
 
-if OCI8::VERSION != '@@OCI8_MODULE_VERSION@@'
+begin
+  require so_basename
+rescue LoadError, OCIError
+  require 'oci8/check_load_error'
+  OCI8::Util::check_load_error($!)
+  raise
+end
+
+require 'oci8/version.rb'
+if OCI8::VERSION != OCI8::LIB_VERSION
   require 'rbconfig'
   so_name = so_basename + "." + RbConfig::CONFIG['DLEXT']
-  raise "VERSION MISMATCH! #{so_name} version is #{OCI8::VERSION}, but oci8.rb version is @@OCI8_MODULE_VERSION@@."
+  raise "VERSION MISMATCH! #{so_name} version is #{OCI8::LIB_VERSION}, but oci8.rb version is #{OCI8::VERSION}."
 end
 
 require 'oci8/encoding-init.rb'

data/lib/oci8/bindtype.rb

@@ -115,18 +115,12 @@ class OCI8
                 param[:length] = val.size
               else
                 # byte semantics
-                if OCI8.respond_to? :encoding and OCI8.encoding != val.encoding
+                if OCI8.encoding != val.encoding
                   # If the string encoding is different with NLS_LANG character set,
                   # convert it to get the length.
                   val = val.encode(OCI8.encoding)
                 end
-                if val.respond_to? :bytesize
-                  # ruby 1.8.7 or upper
-                  param[:length] = val.bytesize
-                else
-                  # ruby 1.8.6 or lower
-                  param[:length] = val.size
-                end
+                param[:length] = val.bytesize
               end
             else
               param[:length] = @@minimum_bind_length
@@ -166,11 +160,7 @@ class OCI8
           unless param[:length]
             if val.respond_to? :to_str
               val = val.to_str
-              if val.respond_to? :bytesize
-                param[:length] = val.bytesize
-              else
-                param[:length] = val.size
-              end
+              param[:length] = val.bytesize
             else
               param[:length] = 400
             end

data/lib/oci8/check_load_error.rb

@@ -0,0 +1,99 @@
+# This file is loaded only on LoadError.
+
+class OCI8
+  module Util
+
+    case RUBY_PLATFORM
+    when /mswin32|cygwin|mingw32|bccwin32/
+
+      require 'Win32API'
+      MAX_PATH = 260
+      GetModuleFileNameA = Win32API.new('kernel32', 'GetModuleFileNameA', 'PPL', 'L')
+      GetSystemDirectoryA = Win32API.new('kernel32', 'GetSystemDirectoryA', 'PL', 'L')
+      GetWindowsDirectoryA = Win32API.new('kernel32', 'GetWindowsDirectoryA', 'PL', 'L')
+
+      def self.check_os_specific_load_error(exc)
+        case exc.message
+        when /^193: / # "193: %1 is not a valid Win32 application." in English
+          check_win32_pe_arch(exc.message.split(' - ')[1], "ruby-oci8")
+          dll_load_path_list.each do |path|
+            check_win32_pe_arch(File.join(path, '\OCI.DLL'), "Oracle client")
+          end
+        end
+      end # self.check_os_specific_load_error
+
+      def self.dll_load_path_list
+        buf = "\0" * MAX_PATH
+        paths = []
+        paths << buf[0, GetModuleFileNameA.call(nil, buf, MAX_PATH)].force_encoding("locale").gsub(/\\[^\\]*$/, '')
+        paths << buf[0, GetSystemDirectoryA.call(buf, MAX_PATH)].force_encoding("locale")
+        paths << buf[0, GetWindowsDirectoryA.call(buf, MAX_PATH)].force_encoding("locale")
+        paths << "."
+        paths + ENV['PATH'].split(';')
+      end # self.dll_load_path_list
+
+      def self.check_win32_pe_arch(filename, package)
+        open(filename, 'rb') do |f|
+          # DOS header.
+          if f.read(2) == 'MZ'
+            f.seek(60, IO::SEEK_SET)
+            pe_offset = f.read(4).unpack('V')[0]
+            f.seek(pe_offset)
+            # PE header.
+            if f.read(4) == "PE\000\000"
+              case f.read(2).unpack('v')[0]
+              when 0x8664
+                if [nil].pack('P').size == 4
+                  raise LoadError, "\"#{filename}\" is x64 DLL. Use 32-bit #{package} instead."
+                end
+                return true
+              when 0x014c
+                if [nil].pack('P').size == 8
+                  raise LoadError, "\"#{filename}\" is 32-bit DLL. Use x64 #{package} instead."
+                end
+                return true
+              end
+            end
+          end
+          raise LoadError, "\"#{filename}\" is not a valid Win32 application."
+        end
+        nil
+      rescue
+        nil
+      end # self.check_win32_pe_arch
+
+    when /linux/
+
+      def self.check_os_specific_load_error(exc)
+        case exc.message
+        when /^libaio\.so\.1:/ # "libaio.so.1: cannot open shared object file: No such file or directory" in English
+          install_cmd = if File.executable? '/usr/bin/apt-get'
+                          'apt-get install libaio1'
+                        elsif File.executable? '/usr/bin/yum'
+                          'yum install libaio'
+                        end
+          if install_cmd
+            raise LoadError, "You need to install libaio.so.1. Run '#{install_cmd}'."
+          else
+            raise LoadError, "You need to install libaio.so.1."
+          end
+        end
+      end # self.check_os_specific_load_error
+
+    else
+
+      def self.check_os_specific_load_error(exc)
+      end
+
+    end # case RUBY_PLATFORM
+
+    def self.check_load_error(exc)
+      check_os_specific_load_error(exc)
+      case exc.message
+      when /^OCI Library Initialization Error/
+        # TODO
+      end
+    end
+
+  end # module Util
+end

data/lib/oci8/encoding-init.rb

@@ -5,75 +5,41 @@
 #
 class OCI8
 
-  # get the environment variable NLS_LANG.
-  nls_lang = ENV['NLS_LANG']
+  @@client_charset_name = charset_id2name(@@environment_handle.send(:attr_get_ub2, 31))
+  # 31 is OCI_ATTR_ENV_CHARSET_ID.
 
-  if nls_lang.is_a? String and nls_lang.length == 0
-    nls_lang = nil
-  end
-
-  # if NLS_LANG is not set, get it from the Windows registry.
-  if nls_lang.nil? and defined? OCI8::Win32Util
-    dll_path = OCI8::Win32Util.dll_path.upcase
-    if dll_path =~ %r{\\BIN\\OCI.DLL}
-      oracle_home = $`
-      OCI8::Win32Util.enum_homes do |home, lang|
-        if oracle_home == home.upcase
-          nls_lang = lang
-          break
+  if @@client_charset_name == 'US7ASCII'
+    # Check whether US7ASCII is explicitly set by NLS_LANG or not.
+    nls_lang = ENV['NLS_LANG']
+    if nls_lang.nil? and defined? OCI8::Win32Util
+      if OCI8::Util::dll_path =~ /\\BIN\\OCI\.DLL$/i
+        oracle_home = $`
+        OCI8::Win32Util.enum_homes do |home, lang|
+          if oracle_home == home.upcase
+            nls_lang = lang
+            break
+          end
         end
       end
     end
-  end
-
-  # extract the charset name.
-  if nls_lang
-    if nls_lang =~ /\.([[:alnum:]]+)$/
-      @@client_charset_name = $1.upcase
-    else
-      raise "Invalid NLS_LANG format: #{nls_lang}"
+    if nls_lang.nil?
+      warn "Warning: NLS_LANG is not set. fallback to US7ASCII."
     end
-  else
-    warn "Warning: NLS_LANG is not set. fallback to US7ASCII."
-    # @private
-    @@client_charset_name = 'US7ASCII'
   end
 
-  # Ruby encoding name for ruby 1.9.
-  if OCI8.respond_to? :encoding
-    if defined? DEFAULT_OCI8_ENCODING
-      enc = DEFAULT_OCI8_ENCODING
-    else
-      require 'yaml'
-      enc = YAML::load_file(File.dirname(__FILE__) + '/encoding.yml')[@@client_charset_name]
-      if enc.nil?
-        raise "Ruby encoding name is not found in encoding.yml for NLS_LANG #{nls_lang}."
-      end
-      if enc.is_a? Array
-        # Use the first available encoding in the array.
-        enc = enc.find do |e| Encoding.find(e) rescue false; end
-      end
-    end
-    OCI8.encoding = enc
+  if defined? DEFAULT_OCI8_ENCODING
+    enc = DEFAULT_OCI8_ENCODING
   else
-    # NLS ratio, maximum number of bytes per one chracter
-    case @@client_charset_name
-    when 'UTF8'
-      OCI8.nls_ratio = 3
-    when 'AL16UTF16'
-      OCI8.nls_ratio = 4
-    when /^[[:alpha:]]+(\d+)/
-      # convert maximum number of bits per one chracter to NLS ratio.
-      #   charset name  max bits  max bytes
-      #   ------------  --------  ---------
-      #   US7ASCII          7         1
-      #   WE8ISO8859P1      8         1
-      #   JA16SJIS         16         2
-      #   AL32UTF8         32         4
-      #   ...
-      OCI8.nls_ratio = (($1.to_i + 7) >> 3)
-    else
-      raise "Unknown NLS character set name format: #{@@client_charset_name}"
+    require 'yaml'
+    yaml_file = File.dirname(__FILE__) + '/encoding.yml'
+    enc = YAML::load_file(yaml_file)[@@client_charset_name]
+    if enc.nil?
+      raise "Cannot convert Oracle charset name #{@@client_charset_name} to Ruby encoding name in #{yaml_file}."
+    end
+    if enc.is_a? Array
+      # Use the first available encoding in the array.
+      enc = enc.find do |e| Encoding.find(e) rescue false; end
     end
   end
+  OCI8.encoding = enc
 end

data/lib/oci8/metadata.rb

@@ -996,20 +996,14 @@ class OCI8
         __charset_form
       end
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # The fractional seconds precision of a datetime or interval.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def fsprecision
-          attr_get_ub1(OCI_ATTR_FSPRECISION)
-        end
+      # The fractional seconds precision of a datetime or interval.
+      def fsprecision
+        attr_get_ub1(OCI_ATTR_FSPRECISION)
+      end
 
-        # The leading field precision of an interval
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def lfprecision
-          attr_get_ub1(OCI_ATTR_LFPRECISION)
-        end
+      # The leading field precision of an interval
+      def lfprecision
+        attr_get_ub1(OCI_ATTR_LFPRECISION)
       end
 
       # character set name if the type attribute is of a string/character type.
@@ -1339,30 +1333,18 @@ class OCI8
 
       ## Table 6-13 Attributes Belonging to Columns of Tables or Views
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # returns the type of length semantics of the column.
-        # [<tt>:byte</tt>]  byte-length semantics
-        # [<tt>:char</tt>]  character-length semantics.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def char_used?
-          attr_get_ub1(OCI_ATTR_CHAR_USED) != 0
-        end
-
-        # returns the column character length which is the number of
-        # characters allowed in the column. It is the counterpart of
-        # OCI8::Metadata::Column#data_size which gets the byte length.
-        def char_size
-          attr_get_ub2(OCI_ATTR_CHAR_SIZE)
-        end
-      else
-        def char_used?
-          false
-        end
+      # returns the type of length semantics of the column.
+      # [<tt>:byte</tt>]  byte-length semantics
+      # [<tt>:char</tt>]  character-length semantics.
+      def char_used?
+        attr_get_ub1(OCI_ATTR_CHAR_USED) != 0
+      end
 
-        def char_size
-          data_size
-        end
+      # returns the column character length which is the number of
+      # characters allowed in the column. It is the counterpart of
+      # OCI8::Metadata::Column#data_size which gets the byte length.
+      def char_size
+        attr_get_ub2(OCI_ATTR_CHAR_SIZE)
       end
 
       # The maximum size of the column. This length is
@@ -1445,20 +1427,14 @@ class OCI8
       ## Table 6-8 Attributes Belonging to Type Attributes
       ## But Column also have these.
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # The fractional seconds precision of a datetime or interval.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def fsprecision
-          attr_get_ub1(OCI_ATTR_FSPRECISION)
-        end
+      # The fractional seconds precision of a datetime or interval.
+      def fsprecision
+        attr_get_ub1(OCI_ATTR_FSPRECISION)
+      end
 
-        # The leading field precision of an interval
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def lfprecision
-          attr_get_ub1(OCI_ATTR_LFPRECISION)
-        end
+      # The leading field precision of an interval
+      def lfprecision
+        attr_get_ub1(OCI_ATTR_LFPRECISION)
       end
 
       # The character set name, if the column is of a string/character type
@@ -1677,14 +1653,8 @@ class OCI8
 
       ## Table 6-15 List Attributes
 
-      if OCI8::oracle_client_version < OCI8::ORAVER_8_1
-        def ltype
-          raise "This feature is unavailable on Oracle 8.0"
-        end
-      else
-        def ltype
-          attr_get_ub2(OCI_ATTR_LTYPE)
-        end
+      def ltype
+        attr_get_ub2(OCI_ATTR_LTYPE)
       end
 
       # convert to array