ruby-staci 2.2.9

data/ext/oci8/error.c

@@ -0,0 +1,385 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: nil -*- */
+/*
+  error.c - part of ruby-oci8
+
+  Copyright (C) 2002-2015 Kubo Takehiro <kubo@jiubao.org>
+
+*/
+#include "oci8.h"
+
+#ifndef DLEXT
+#define DLEXT ".so"
+#endif
+
+/* Exception */
+VALUE eOCIException;
+VALUE eOCIBreak;
+static VALUE eOCINoData;
+static VALUE eACIError;
+static VALUE eOCIInvalidHandle;
+static VALUE eOCINeedData;
+static VALUE eOCIStillExecuting;
+static VALUE eOCIContinue;
+static VALUE eOCISuccessWithInfo;
+
+static ID oci8_id_at_code;
+static ID oci8_id_at_sql;
+static ID oci8_id_at_parse_error_offset;
+static ID oci8_id_caller;
+static ID oci8_id_set_backtrace;
+
+#define ERRBUF_EXPAND_LEN 256
+static char *errbuf;
+static ub4 errbufsiz;
+
+static ACIMsg *msghp;
+
+static VALUE set_backtrace(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 = ACIErrorGet(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);
+}
+
+/*
+ * Don't call rb_class_new_instance() with more than one argument in this function.
+ * This may be called before OCIError#initialize is defined in lib/oci8/oci8.rb.
+ */
+static VALUE oci_exception_new(VALUE klass, VALUE msg, VALUE code, VALUE sql, VALUE parse_error_offset)
+{
+    VALUE obj = rb_class_new_instance(NIL_P(msg) ? 0 : 1, &msg, klass);
+    if (rb_obj_is_kind_of(obj, eACIError)) {
+        rb_ivar_set(obj, oci8_id_at_code, code);
+        rb_ivar_set(obj, oci8_id_at_sql, sql);
+        rb_ivar_set(obj, oci8_id_at_parse_error_offset, parse_error_offset);
+    }
+    return obj;
+}
+
+static VALUE oci8_make_exc(dvoid *errhp, sword status, ub4 type, ACIStmt *stmthp, const char *file, int line)
+{
+    VALUE exc;
+    char errmsg[128];
+    sb4 errcode = -1;
+    VALUE msg;
+    VALUE parse_error_offset = Qnil;
+    VALUE sql = Qnil;
+    int rv;
+
+    switch (status) {
+    case OCI_ERROR:
+        exc = eACIError;
+        msg = get_error_msg(errhp, type, "Error", &errcode);
+        break;
+    case OCI_SUCCESS_WITH_INFO:
+        exc = eOCISuccessWithInfo;
+        msg = get_error_msg(errhp, type, "Error", &errcode);
+        break;
+    case ACI_NO_DATA:
+        exc = eOCINoData;
+        msg = get_error_msg(errhp, type, "No Data", &errcode);
+        break;
+    case ACI_INVALID_HANDLE:
+        exc = eOCIInvalidHandle;
+        msg = rb_usascii_str_new_cstr("Invalid Handle");
+        break;
+    case ACI_NEED_DATA:
+        exc = eOCINeedData;
+        msg = rb_usascii_str_new_cstr("Need Data");
+        break;
+    case ACI_STILL_EXECUTING:
+        exc = eOCIStillExecuting;
+        msg = rb_usascii_str_new_cstr("Still Executing");
+        break;
+    case ACI_CONTINUE:
+        exc = eOCIContinue;
+        msg = rb_usascii_str_new_cstr("Continue");
+        break;
+    default:
+        sprintf(errmsg, "Unknown error (%d)", status);
+        exc = eOCIException;
+        msg = rb_usascii_str_new_cstr(errmsg);
+    }
+    if (stmthp != NULL) {
+        ub2 offset;
+        text *text;
+        ub4 size;
+
+        rv = ACIAttrGet(stmthp, ACI_HTYPE_STMT, &offset, 0, ACI_ATTR_PARSE_ERROR_OFFSET, errhp);
+        if (rv == ACI_SUCCESS) {
+            parse_error_offset = INT2FIX(offset);
+        }
+        rv = ACIAttrGet(stmthp, ACI_HTYPE_STMT, &text, &size, ACI_ATTR_STATEMENT, errhp);
+        if (rv == ACI_SUCCESS) {
+            sql = rb_external_str_new_with_enc(TO_CHARPTR(text), size, oci8_encoding);
+        }
+    }
+    exc = oci_exception_new(exc, msg, INT2FIX(errcode), sql, parse_error_offset);
+    return set_backtrace(exc, file, line);
+}
+
+static VALUE set_backtrace(VALUE exc, const char *file, int line)
+{
+    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 " 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);
+    }
+    return exc;
+}
+
+sb4 oci8_get_error_code(ACIError *errhp)
+{
+    sb4 errcode = -1;
+    ACIErrorGet(oci8_errhp, 1, NULL, &errcode, NULL, 0, ACI_HTYPE_ERROR);
+    return errcode;
+}
+
+void Init_oci8_error(void)
+{
+    errbufsiz = ERRBUF_EXPAND_LEN;
+    errbuf = xmalloc(errbufsiz);
+
+    oci8_id_at_code = rb_intern("@code");
+    oci8_id_at_sql = rb_intern("@sql");
+    oci8_id_at_parse_error_offset = rb_intern("@parse_error_offset");
+    oci8_id_caller = rb_intern("caller");
+    oci8_id_set_backtrace = rb_intern("set_backtrace");
+
+    eOCIException = rb_define_class("ACIException", rb_eStandardError);
+    eOCIBreak = rb_define_class("ACIBreak", eOCIException);
+
+    eACIError = rb_define_class("ACIError", eOCIException);
+    eOCINoData = rb_define_class("ACINoData", eACIError);
+    eOCIInvalidHandle = rb_define_class("ACIInvalidHandle", eOCIException);
+    eOCINeedData = rb_define_class("ACINeedData", eOCIException);
+    eOCIStillExecuting = rb_define_class("ACIStillExecuting", eOCIException);
+    eOCIContinue = rb_define_class("ACIContinue", eOCIException);
+    eOCISuccessWithInfo = rb_define_class("ACISuccessWithInfo", eACIError);
+
+    /*
+     * @attr_reader [Integer] code  error code
+     */
+    rb_define_attr(eACIError, "code", 1, 0);
+    rb_define_attr(eACIError, "sql", 1, 0);
+    rb_define_attr(eACIError, "parse_error_offset", 1, 0);
+    rb_define_alias(eACIError, "parseErrorOffset", "parse_error_offset");
+}
+
+void oci8_do_raise(ACIError *errhp, sword status, ACIStmt *stmthp, const char *file, int line)
+{
+    rb_exc_raise(oci8_make_exc(errhp, status, ACI_HTYPE_ERROR, stmthp, file, line));
+}
+
+void oci8_do_env_raise(ACIEnv *envhp, sword status, int free_envhp, const char *file, int line)
+{
+    VALUE exc = oci8_make_exc(envhp, status, ACI_HTYPE_ENV, NULL, file, line);
+    if (free_envhp) {
+        ACIHandleFree(envhp, ACI_HTYPE_ENV);
+    }
+    rb_exc_raise(exc);
+}
+
+void oci8_do_raise_init_error(const char *file, int line)
+{
+    VALUE msg = rb_usascii_str_new_cstr("ACI Library Initialization Error");
+    VALUE exc;
+    const char *dll_path = oci8_dll_path();
+
+    if (dll_path != NULL) {
+        msg = rb_str_buf_cat_ascii(msg, " - ");
+        msg = rb_enc_str_buf_cat(msg, dll_path, strlen(dll_path), rb_filesystem_encoding());
+    }
+    exc = rb_class_new_instance(1, &msg, eACIError);
+    rb_exc_raise(set_backtrace(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 (msghp == NULL) {
+        chkerr(ACIMessageOpen(oci8_envhp, oci8_errhp, &msghp, TO_CONST_ORATEXT("rdbms"), TO_CONST_ORATEXT("ora"), ACI_DURATION_PROCESS));
+    }*/
+    /*errmsg = TO_CHARPTR(ACIMessageGet(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 = oci_exception_new(eACIError, msg, INT2FIX(-1), Qnil, Qnil);
+
+    rb_exc_raise(set_backtrace(exc, file, line));
+}
+
+void oci8_check_error_(sword status, oci8_base_t *base, ACIStmt *stmthp, const char *file, int line)
+{
+    if (status != ACI_SUCCESS) {
+        VALUE exc = oci8_make_exc(oci8_errhp, status, ACI_HTYPE_ERROR, stmthp, file, line);
+        while (base != NULL) {
+            if (base->type == ACI_HTYPE_SVCCTX) {
+                rb_ivar_set(base->self, oci8_id_at_last_error, exc);
+                break;
+            }
+            base = base->parent;
+        }
+        if (status != ACI_SUCCESS_WITH_INFO) {
+            rb_exc_raise(exc);
+        }
+    }
+}
+
+/*
+ * Document-class: OCIException
+ *
+ * The superclass for all exceptions raised by ruby-oci8.
+ *
+ * The following exceptions are defined as subclasses of OCIException
+ * These exceptions are raised when Oracle Call Interface functions
+ * return with an error status.
+ *
+ * - {OCIBreak}
+ * - {OCIError}
+ *   - {OCISuccessWithInfo}
+ *   - {OCINoData} (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
+ * - {OCIInvalidHandle}
+ */
+
+/*
+ * Document-class: OCIBreak
+ *
+ * Subclass of OCIException
+ *
+ * Raised when a SQL execution is cancelled by {STACI#break}.
+ */
+
+/*
+ * Document-class: OCINoData
+ *
+ * Subclass of OCIError from ruby-oci8 2.1.
+ * It had been a subclass of OCIException until ruby-oci8 2.0.
+ *
+ * Raised when PL/SQL NO_DATA_FOUND exception is got.
+ */
+
+/*
+ * Document-class: OCIError
+ *
+ * Subclass of OCIException
+ *
+ * The following exceptions are defined as subclasses of OCIError.
+ *
+ * - OCISuccessWithInfo
+ * - OCINoData (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
+ *
+ * Raised when underlying Oracle Call Interface failed with an Oracle error code
+ * such as ORA-00001.
+ *
+ * @attr_reader [Integer] code  error code
+ * @attr_reader [String] sql    SQL statement
+ * @attr_reader [Integer] parse_error_offset position
+ */
+
+/*
+ * Document-class: OCIInvalidHandle
+ *
+ * Subclass of OCIException
+ *
+ * Raised when an invalid handle is passed to underlying Oracle Call Interface.
+ * Report to the ruby-oci8 author if it is raised.
+ */
+
+/*
+ * Document-class: OCINeedData
+ *
+ * Subclass of OCIException
+ *
+ * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
+ */
+
+/*
+ * Document-class: OCIStillExecuting
+ *
+ * Subclass of OCIError
+ *
+ * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
+ */
+
+/*
+ * Document-class: OCIContinue
+ *
+ * Subclass of OCIException
+ *
+ * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
+ */
+
+/*
+ * Document-class: OCISuccessWithInfo
+ *
+ * Subclass of OCIError
+ *
+ */

data/ext/oci8/extconf.rb

@@ -0,0 +1,219 @@
+if RUBY_VERSION < "1.9"
+  puts "Ruby-oci8 doesn't work ruby 1.8 since ruby-oci8 2.2.0."
+  exit 1
+end
+
+begin
+  require 'mkmf'
+rescue LoadError
+  if /linux/ =~ RUBY_PLATFORM
+    raise <<EOS
+You need to install a ruby development package ruby-devel, ruby-dev or so.
+EOS
+  end
+  raise
+end
+
+require File.dirname(__FILE__) + '/oraconf'
+require File.dirname(__FILE__) + '/apiwrap'
+require File.dirname(__FILE__) + '/../../lib/oci8/oracle_version.rb'
+require File.dirname(__FILE__) + '/../../lib/oci8/version.rb'
+
+oraconf = OraConf.get()
+
+$CFLAGS += oraconf.cflags
+saved_libs = $libs
+$libs += oraconf.libs
+
+saved_defs = $defs.clone
+fmt = "%s"
+def fmt.%(x)
+  x ? super : "failed"
+end
+oci_major_version = 11
+if oci_major_version
+  oci_minor_version = 1
+else
+  if have_func('OCILobGetLength2')
+    oci_major_version = 10
+    oci_minor_version = 1
+  elsif have_func('OCIStmtPrepare2')
+    raise "Ruby-oci8 #{STACI::VERSION} doesn't support Oracle 9iR2. Use ruby-oci8 2.1.x instead."
+  elsif have_func('OCILogon2')
+    raise "Ruby-oci8 #{STACI::VERSION} doesn't support Oracle 9iR1. Use ruby-oci8 2.1.x instead."
+  elsif have_func('OCIEnvCreate')
+    raise "Ruby-oci8 #{STACI::VERSION} doesn't support Oracle 8i. Use ruby-oci8 2.0.x instead."
+  else
+    raise "Ruby-oci8 #{STACI::VERSION} doesn't support Oracle 8. Use ruby-oci8 2.0.x instead."
+  end
+end
+$defs = saved_defs
+
+if with_config('oracle-version')
+  oraver = STACI::OracleVersion.new(with_config('oracle-version'))
+else
+  oraver = STACI::OracleVersion.new(oci_major_version, oci_minor_version)
+end
+$defs << "-DORACLE_CLIENT_VERSION=#{format('0x%08x', oraver.to_i)}"
+
+if with_config('runtime-check')
+  $defs << "-DRUNTIME_API_CHECK=1"
+  $libs = saved_libs
+end
+
+$objs = ["oci8lib.o", "env.o", "error.o", "oci8.o", "ocihandle.o",
+         "connection_pool.o",
+         "stmt.o", "bind.o", "metadata.o", "attr.o",
+         "lob.o", "oradate.o",
+         "ocinumber.o", "ocidatetime.o", "object.o", "apiwrap.o",
+         "encoding.o", "oranumber_util.o", "thread_util.o", "util.o"]
+
+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")
+have_func("dladdr")
+have_func("dlmodinfo")
+have_func("dlgetname")
+
+# ruby 2.0.0 headers
+have_header("ruby/thread.h")
+
+have_func("rb_class_superclass", "ruby.h")
+have_func("rb_thread_call_without_gvl", "ruby/thread.h")
+have_func("rb_sym2str", "ruby.h")
+if (defined? RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  have_func("rb_str_buf_cat_ascii", "ruby.h")
+  have_func("rb_enc_str_buf_cat", "ruby.h")
+end
+
+ruby_engine = (defined? RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+
+so_basename = 'stacilib_'
+case ruby_engine
+when 'ruby'
+  # The extension library name includes the ruby ABI (application binary interface)
+  # version. It is for binary gems which contain more than one extension library
+  # and use correct one depending on the ABI version.
+  #
+  #  ruby version |  ABI version
+  # --------------+--------------
+  #    1.8.6      |   1.8
+  #    1.8.7      |   1.8
+  # --------------+--------------
+  #    1.9.0      |   1.9.0
+  #    1.9.1      |   1.9.1
+  #    1.9.2      |   1.9.1
+  #    1.9.3      |   1.9.1
+  # --------------+--------------
+  #    2.0.0      |   2.0.0
+  # --------------+--------------
+  #    2.1.0      |   2.1.0
+  #     ...       |    ...
+  #
+  # The ABI version of ruby 2.1.1 will be 2.1.0.
+  # See "ABI Compatibility" in <URL:http://www.ruby-lang.org/en/news/2013/12/21/semantic-versioning-after-2-1-0/>.
+  #
+  case RUBY_VERSION
+  when /^1\.9\.0/
+    raise 'unsupported ruby version: 1.9.0'
+  when /^1\.9/
+    so_basename += '191'
+  when /^1\.8/
+    so_basename += '18'
+  else
+    so_basename += RUBY_VERSION.gsub(/(\d+)\.(\d+).(.*)/, '\1\20')
+  end
+when 'rbx'
+  so_basename += 'rbx'
+when 'jruby'
+  raise "Ruby-oci8 doesn't support jruby because its C extension support is in development in jruby 1.6 and deprecated in jruby 1.7."
+when 'truffleruby'
+  so_basename += 'truffleruby'
+else
+  raise 'unsupported ruby engine: ' + RUBY_ENGINE
+end
+
+print "checking for plthook... "
+STDOUT.flush
+case RUBY_PLATFORM
+when /mswin32|cygwin|mingw32|bccwin32/
+  plthook_src = "plthook_win32.c"
+when /darwin/
+  plthook_src = "plthook_osx.c"
+else
+  plthook_src = "plthook_elf.c"
+end
+FileUtils.copy(File.dirname(__FILE__) + "/" + plthook_src, CONFTEST_C)
+if xsystem(cc_command(""))
+  FileUtils.rm_f("#{CONFTEST}.#{$OBJEXT}")
+  puts plthook_src
+  $objs << plthook_src.gsub(/\.c$/, '.o')
+  $objs << "hook_funcs.o"
+  $defs << "-DHAVE_PLTHOOK"
+  have_library('dbghelp', 'ImageDirectoryEntryToData', ['windows.h', 'dbghelp.h']) if RUBY_PLATFORM =~ /cygwin/
+  $libs += ' -lws2_32' if RUBY_PLATFORM =~ /cygwin/
+else
+  puts "no"
+end
+
+$defs << "-DInit_oci8lib=Init_#{so_basename}"
+$defs << "-Doci8lib=#{so_basename}"
+$defs << "-DOCI8LIB_VERSION=\\\"#{STACI::VERSION}\\\""
+$defs << "-DCHAR_IS_NOT_A_SHORTCUT_TO_ID" if ruby_engine != 'ruby'
+
+create_header()
+
+# make dependency file
+open("depend", "w") do |f|
+  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 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()
+
+case RUBY_PLATFORM
+when /mingw32/
+  # Drop '-s' option from LDSHARED and explicitly run 'strip' to get the map file.
+  if RbConfig::MAKEFILE_CONFIG["LDSHARED"].gsub!(/-s\b/, '')
+    alias :oci8_configuration_orig :configuration
+    def configuration(*args)
+      prefix = [nil].pack('P').size == 4 ? '_' : ''
+      oci8_configuration_orig(*args) << <<EOS
+
+# Dirty hack to get the map file.
+all__: all
+	nm $(DLLIB) | grep ' [TtBb] #{prefix}[A-Za-z]' > $(TARGET).map
+	strip -s $(DLLIB)
+EOS
+    end
+  end
+end
+
+create_makefile(so_basename)
+
+exit 0