oracledb 3.0.0 → 3.1.2

package/src/njsCommon.h

@@ -1,484 +0,0 @@
-/* Copyright (c) 2015, 2018, Oracle and/or its affiliates.
-   All rights reserved. */
-
-/******************************************************************************
- *
- * You may not use the identified files except in compliance with the Apache
- * License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at
- * http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * This file uses NAN:
- *
- * Copyright (c) 2015 NAN contributors
- *
- * NAN contributors listed at https://github.com/rvagg/nan#contributors
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * NAME
- *  njsCommon.h
- *
- * DESCRIPTION
- *  Common classes used throughout driver.
- *
- *****************************************************************************/
-
-#ifndef __NJSCOMMON_H__
-#define __NJSCOMMON_H__
-
-#include <v8.h>
-#include <node.h>
-#include "nan.h"
-#include <string>
-#include <cstring>
-#include <vector>
-#include <stdlib.h>
-#include <stdio.h>
-
-extern "C" {
-#include "dpi.h"
-}
-
-#include "njsMessages.h"
-
-using namespace v8;
-using namespace node;
-
-class njsBaton;
-class njsOracledb;
-class njsProtoILob;
-class njsSubscription;
-
-//-----------------------------------------------------------------------------
-// njsBindDir
-//   User defined bind directions.
-//-----------------------------------------------------------------------------
-typedef enum {
-    NJS_BIND_IN       = 3001,
-    NJS_BIND_INOUT    = 3002,
-    NJS_BIND_OUT      = 3003
-} njsBindDir;
-
-
-//-----------------------------------------------------------------------------
-// njsRowsType
-//   Values used for "outFormat".
-//-----------------------------------------------------------------------------
-typedef enum {
-    NJS_ROWS_ARRAY    = 4001,
-    NJS_ROWS_OBJECT   = 4002
-} njsRowsType;
-
-
-//-----------------------------------------------------------------------------
-// njsDataType
-//   User defined data types for binds and defines.
-//-----------------------------------------------------------------------------
-typedef enum {
-    NJS_DATATYPE_UNKNOWN  = -1,
-    NJS_DATATYPE_DEFAULT  = 0,  // Used in FetchInfo Context only (use DB type)
-    NJS_DATATYPE_STR      = 2001,
-    NJS_DATATYPE_NUM      = 2002,
-    NJS_DATATYPE_DATE     = 2003,
-    NJS_DATATYPE_CURSOR   = 2004,
-    NJS_DATATYPE_BUFFER   = 2005,
-    NJS_DATATYPE_CLOB     = 2006,
-    NJS_DATATYPE_BLOB     = 2007,
-    NJS_DATATYPE_INT      = 2008
-} njsDataType;
-
-
-//-----------------------------------------------------------------------------
-// njsDBType
-//   Database types used for extended meta data
-//-----------------------------------------------------------------------------
-typedef enum {
-    NJS_DB_TYPE_UNKNOWN        = -1,
-    NJS_DB_TYPE_DEFAULT        = 0,
-    NJS_DB_TYPE_VARCHAR        = 1,
-    NJS_DB_TYPE_NUMBER         = 2,
-    NJS_DB_TYPE_LONG           = 8,
-    NJS_DB_TYPE_DATE           = 12,
-    NJS_DB_TYPE_RAW            = 23,
-    NJS_DB_TYPE_LONG_RAW       = 24,
-    NJS_DB_TYPE_CHAR           = 96,
-    NJS_DB_TYPE_BINARY_FLOAT   = 100,
-    NJS_DB_TYPE_BINARY_DOUBLE  = 101,
-    NJS_DB_TYPE_ROWID          = 104,
-    NJS_DB_TYPE_CLOB           = 112,
-    NJS_DB_TYPE_BLOB           = 113,
-    NJS_DB_TYPE_TIMESTAMP      = 187,
-    NJS_DB_TYPE_TIMESTAMP_TZ   = 188,
-    NJS_DB_TYPE_TIMESTAMP_LTZ  = 232,
-
-    /* Pseudo types */
-    NJS_DB_TYPE_NCHAR          = 1096,
-    NJS_DB_TYPE_NVARCHAR       = 1001,
-    NJS_DB_TYPE_NCLOB          = 1112,
-} njsDBType;
-
-
-//-----------------------------------------------------------------------------
-// njsSodaMapMode
-//   Soda-Collection creation Map mode
-//-----------------------------------------------------------------------------
-typedef enum {
-    NJS_SODA_COLL_CREATE_MODE_DEFAULT = 0,
-    NJS_SODA_COLL_CREATE_MODE_MAP = 5001
-} njsSodaMapMode;
-
-
-//-----------------------------------------------------------------------------
-// njsVariableBuffer
-//   Class used for keeping track of ODPI-C buffers and proto ILob objects.
-//-----------------------------------------------------------------------------
-class njsVariableBuffer {
-public:
-    uint32_t numElements;
-    dpiData *dpiVarData;
-    njsProtoILob *lobs;
-
-    njsVariableBuffer() : numElements(0), dpiVarData(NULL), lobs(NULL) {}
-    ~njsVariableBuffer();
-};
-
-
-//-----------------------------------------------------------------------------
-// njsVariable
-//   Class used for keeping track of variables used for binding/fetching data.
-//-----------------------------------------------------------------------------
-class njsVariable {
-public:
-    std::string name;
-    uint32_t pos;
-    dpiOracleTypeNum dbTypeNum;
-    dpiOracleTypeNum varTypeNum;
-    dpiNativeTypeNum nativeTypeNum;
-    dpiVar *dpiVarHandle;
-    njsBindDir bindDir;
-    njsDataType bindDataType;
-    uint32_t maxArraySize;
-    uint32_t maxSize;
-    uint32_t dbSizeInBytes;
-    int16_t precision;
-    int8_t scale;
-    bool isArray;
-    bool isNullable;
-    njsVariableBuffer buffer;
-    njsVariableBuffer* dmlReturningBuffers;
-    uint32_t numQueryVars;
-    njsVariable *queryVars;
-
-    njsVariable() : pos(0), dbTypeNum(DPI_ORACLE_TYPE_VARCHAR),
-            varTypeNum(DPI_ORACLE_TYPE_VARCHAR),
-            nativeTypeNum(DPI_NATIVE_TYPE_BYTES), dpiVarHandle(NULL),
-            bindDir(NJS_BIND_IN), bindDataType(NJS_DATATYPE_DEFAULT),
-            maxArraySize(0), maxSize(0), dbSizeInBytes(0), precision(0),
-            scale(0), isArray(false), isNullable(false),
-            dmlReturningBuffers(NULL), numQueryVars(0), queryVars(NULL) {}
-    ~njsVariable();
-    njsDataType DataType();
-    njsDBType DBType();
-};
-
-
-//-----------------------------------------------------------------------------
-// njsFetchInfo
-//   Class used for keeping track of which data types have been specifically
-// requested from JS.
-//-----------------------------------------------------------------------------
-class njsFetchInfo {
-public:
-    std::string name;
-    njsDataType type;
-
-    njsFetchInfo() : type(NJS_DATATYPE_DEFAULT) {}
-};
-
-
-//-----------------------------------------------------------------------------
-// njsCommon
-//   Class used for all objects that are exposed to JS.
-//-----------------------------------------------------------------------------
-class njsCommon : public Nan::ObjectWrap {
-friend class njsBaton;
-protected:
-
-    virtual njsErrorType GetInvalidErrorType() const = 0;
-    virtual bool IsValid() const = 0;
-
-    static bool Validate(njsCommon *obj, bool checkValid);
-    static njsCommon *ValidateGetter(Nan::NAN_GETTER_ARGS_TYPE args);
-    static njsCommon *ValidateSetter(Nan::NAN_SETTER_ARGS_TYPE args);
-    static njsCommon *ValidateArgs(Nan::NAN_METHOD_ARGS_TYPE args,
-            int minArgs, int maxArgs);
-    static void PropertyIsReadOnly(const char *name);
-
-    njsBaton *CreateBaton(Nan::NAN_METHOD_ARGS_TYPE args);
-    bool GetObjectArg(Nan::NAN_METHOD_ARGS_TYPE args, int index,
-            Local<Object> &value);
-    bool GetStringArg(Nan::NAN_METHOD_ARGS_TYPE args, int index,
-            std::string &value);
-    bool GetUnsignedIntArg(Nan::NAN_METHOD_ARGS_TYPE args, int index,
-            uint32_t *value);
-    bool SetPropBool(Local<Value> value, bool *valuePtr, const char *name);
-    bool SetPropInt(Local<Value> value, int32_t *valuePtr, const char *name);
-    bool SetPropPositiveInt(Local<Value> value, uint32_t *valuePtr,
-            const char *name);
-    bool SetPropString(Local<Value> value, std::string *valuePtr,
-            const char *name);
-    bool SetPropUnsignedInt(Local<Value> value, uint32_t *valuePtr,
-            const char *name);
-
-    // used to prevent multiple asynchronous methods from acting upon this
-    // object at the same time
-    njsBaton *activeBaton;
-};
-
-
-//-----------------------------------------------------------------------------
-// njsBaton
-//   Baton used for asynchronous methods. Node.js does not allow objects to be
-// created on one thread and used on another so any data needs to be passed
-// between threads using this class. This class also simplifies the code
-// required to make asynchronous calls.
-//-----------------------------------------------------------------------------
-class njsBaton {
-public:
-    std::string error;
-    std::string sql;
-    std::string user;
-    std::string password;
-    std::string newPassword;
-    std::string connectString;
-    std::string connClass;
-    std::string edition;
-    std::string ipAddress;
-    std::string name;
-    uint32_t poolMin;
-    uint32_t poolMax;
-    uint32_t poolIncrement;
-    uint32_t poolTimeout;
-    int32_t poolPingInterval;
-    dpiPool *dpiPoolHandle;
-    dpiConn *dpiConnHandle;
-    dpiStmt *dpiStmtHandle;
-    dpiLob *dpiLobHandle;
-    dpiSubscr *dpiSubscrHandle;
-    dpiStmtInfo stmtInfo;
-    uint32_t stmtCacheSize;
-    uint32_t lobPrefetchSize;
-    uint32_t maxRows;
-    uint32_t bindArraySize;
-    uint32_t fetchArraySize;
-    uint32_t privilege;
-    uint32_t rowsFetched;
-    uint32_t bufferRowIndex;
-    uint64_t rowsAffected;
-    unsigned int outFormat;
-    uint32_t numQueryVars;
-    njsVariable *queryVars;
-    uint32_t numBindVars;
-    njsVariable *bindVars;
-    uint32_t numFetchInfo;
-    njsFetchInfo *fetchInfo;
-    uint32_t numFetchAsStringTypes;
-    njsDataType *fetchAsStringTypes;
-    uint32_t numFetchAsBufferTypes;
-    njsDataType *fetchAsBufferTypes;
-    njsProtoILob *protoILob;
-    bool externalAuth;
-    bool homogeneous;                 // True: one user, false: multiple user
-    bool getRS;
-    bool autoCommit;
-    bool extendedMetaData;
-    bool isReturning;
-    bool isPLSQL;
-    bool events;
-    bool batchErrors;
-    bool dmlRowCounts;
-    uint64_t bufferSize;
-    char *bufferPtr;
-    uint64_t lobOffset;
-    uint64_t lobAmount;
-    uint32_t numRowCounts;
-    uint64_t *rowCounts;
-    uint32_t timeout;
-    uint32_t qos;
-    uint32_t operations;
-    uint32_t numBatchErrorInfos;
-    dpiErrorInfo *batchErrorInfos;
-    dpiErrorInfo errorInfo;
-    bool dpiError;
-    uint32_t portNumber;
-    uint32_t subscrGroupingClass;
-    uint32_t subscrGroupingValue;
-    uint32_t subscrGroupingType;
-    njsSubscription *subscription;
-    njsCommon *callingObj;
-
-    std::string sodaCollName;
-    std::string sodaMetaData;
-    dpiSodaDb *dpiSodaDbHandle;
-    dpiSodaColl *dpiSodaCollHandle;
-
-    // getCollectionNames
-    int32_t limit;
-    std::string startsWith;
-    dpiSodaCollNames *sodaCollNames;
-    uint32_t  createCollectionMode;
-    int32_t   isDropped;
-
-    dpiSodaDoc *dpiSodaDocHandle;
-
-    // index
-    std::string indexSpec;
-    std::string indexName;
-    int32_t     replaced;
-
-    // createDocument
-    std::string content;
-    std::string key;
-    std::string mediaType;
-
-    // findOne
-    uint64_t    docCount;
-    std::string filter;
-    std::string version;
-    uint64_t    docsDeleted;
-    dpiSodaDocCursor *dpiSodaDocCursorHandle;
-    std::vector<dpiSodaDoc*> dpiSodaDocsVec;
-    std::vector<std::string> keysVec;
-
-    dpiSodaOperOptions *sodaOperOptions;
-
-    uint32_t callTimeout;
-    int setCallTimeout;
-
-    Nan::Persistent<Object> jsCallingObj;
-    Nan::Persistent<Object> jsOracledb;
-    Nan::Persistent<Object> jsBuffer;
-    Nan::Persistent<Object> jsSubscription;
-    Nan::Persistent<Function> jsCallback;
-    bool force;
-
-    njsBaton(Local<Function> callback, Local<Object> callingObj) :
-            poolMin(0), poolMax(0), poolIncrement(0), poolTimeout(0),
-            poolPingInterval(0), dpiPoolHandle(NULL), dpiConnHandle(NULL),
-            dpiStmtHandle(NULL), dpiLobHandle(NULL), dpiSubscrHandle(NULL),
-            stmtCacheSize(0), lobPrefetchSize(0), maxRows(0), bindArraySize(1),
-            fetchArraySize(0), privilege(0), rowsFetched(0), bufferRowIndex(0),
-            rowsAffected(0), outFormat(0), numQueryVars(0), queryVars(NULL),
-            numBindVars(0), bindVars(NULL), numFetchInfo(0), fetchInfo(NULL),
-            numFetchAsStringTypes(0), fetchAsStringTypes(NULL),
-            numFetchAsBufferTypes(0), fetchAsBufferTypes(NULL),
-            protoILob(NULL), externalAuth(false), homogeneous(true),
-            getRS(false), autoCommit(false), extendedMetaData(false),
-            isReturning(false), isPLSQL(false), events(false),
-            batchErrors(false), dmlRowCounts(false), bufferSize(0),
-            bufferPtr(NULL), lobOffset(0), lobAmount(0), numRowCounts(0),
-            rowCounts(NULL), timeout(0), qos(0), operations(0),
-            numBatchErrorInfos(0), batchErrorInfos(NULL),
-            dpiError(false), portNumber(0), subscrGroupingClass(0),
-            subscrGroupingValue(0), subscrGroupingType(0),
-            subscription(NULL), dpiSodaDbHandle(NULL), dpiSodaCollHandle(NULL),
-            limit(0), sodaCollNames(NULL),
-            createCollectionMode(NJS_SODA_COLL_CREATE_MODE_DEFAULT),
-            isDropped(0), dpiSodaDocHandle(NULL), docCount(0),
-            docsDeleted(0), dpiSodaDocCursorHandle(NULL),
-            sodaOperOptions(NULL), callTimeout(0), setCallTimeout(0),
-            force(false) {
-        this->jsCallback.Reset(callback);
-        this->jsCallingObj.Reset(callingObj);
-        this->callingObj = Nan::ObjectWrap::Unwrap<njsCommon>(callingObj);
-        req.data = this;
-    }
-    ~njsBaton();
-
-    // methods for getting information from JS objects stored on baton
-    njsOracledb *GetOracledb();
-
-    // methods for getting DPI errors
-    void GetDPIError(void);
-
-    // method for checking for a JavaScript exception
-    void CheckJSException(Nan::TryCatch *tryCatch);
-
-    // clear all data used in asynchronous operations
-    void ClearAsyncData(void);
-
-    // methods for setting DPI handles
-    void SetDPIConnHandle(dpiConn *handle);
-    void SetDPIPoolHandle(dpiPool *handle);
-    void SetDPIStmtHandle(dpiStmt *handle);
-    void SetDPILobHandle(dpiLob *handle);
-    void SetDPISubscrHandle(dpiSubscr *handle);
-    void SetDPISodaDbHandle(dpiSodaDb *handle);
-    void SetDPISodaCollHandle(dpiSodaColl *handle);
-    void SetDPISodaDocHandle(dpiSodaDoc *handle);
-    void SetDPISodaDocCursorHandle(dpiSodaDocCursor *handle);
-
-    // methods for getting values from JSON
-    bool GetBoolFromJSON(Local<Object> obj, const char *key, int index,
-            bool *value);
-    bool GetFunctionFromJSON(Local<Object> obj, const char *key, int index,
-            Local<Function> *value);
-    bool GetStringFromJSON(Local<Object> obj, const char *key, int index,
-            string &value);
-    bool GetPositiveIntFromJSON(Local<Object> obj, const char *key, int index,
-            uint32_t *value);
-    bool GetIntFromJSON(Local<Object> obj, const char *key, int index,
-            int32_t *value);
-    bool GetUnsignedIntFromJSON(Local<Object> obj, const char *key, int index,
-            uint32_t *value);
-
-    // method for handling SODA document or buffer
-    bool GetSodaDocument(Local<Object> obj, dpiSodaDb *db);
-
-    // convenience methods
-    uint32_t GetNumOutBinds();
-
-    // methods for queuing work on the thread queue
-    void QueueWork(const char *methodName, void (*workCallback)(njsBaton*),
-            void (*afterWorkCallback)(njsBaton*, Local<Value>[]),
-            unsigned int numCallbackArgs);
-
-private:
-    uv_work_t req;
-    const char *methodName;
-    void (*workCallback)(njsBaton*);
-    void (*afterWorkCallback)(njsBaton*, Local<Value> callbackArgs[]);
-    unsigned int numCallbackArgs;
-
-    static void AsyncWorkCallback(uv_work_t *req);
-    static void AsyncAfterWorkCallback(uv_work_t *req, int status);
-};
-
-#endif
-