mg-dbx 2.3.25-a → 2.4.27-a

package/README.md

@@ -3,9 +3,9 @@
 High speed Synchronous and Asynchronous access to InterSystems Cache/IRIS and YottaDB from Node.js.
 
 Chris Munt <cmunt@mgateway.com>  
-22 April 2021, M/Gateway Developments Ltd [http://www.mgateway.com](http://www.mgateway.com)
+25 April 2022, M/Gateway Developments Ltd [http://www.mgateway.com](http://www.mgateway.com)
 
-* Verified to work with Node.js v8 to v16.
+* Verified to work with Node.js v8 to v18.
 * Two connectivity models to the InterSystems or YottaDB database are provided: High performance via the local database API or network based.
 * [Release Notes](#RelNotes) can be found at the end of this document.
 
@@ -83,7 +83,7 @@ Change to your development UCI and check the installation:
        do ^%zmgsi
 
        M/Gateway Developments Ltd - Service Integration Gateway
-       Version: 4.2; Revision 20 (20 April 2021)
+       Version: 4.4; Revision 25 (2 September 2021)
 
 
 #### Installation for YottaDB
@@ -112,7 +112,7 @@ Link all the **zmgsi** routines and check the installation:
        do ^%zmgsi
 
        M/Gateway Developments Ltd - Service Integration Gateway
-       Version: 4.2; Revision 20 (20 April 2021)
+       Version: 4.4; Revision 25 (2 September 2021)
 
 Note that the version of **zmgsi** is successfully displayed.
 
@@ -255,7 +255,7 @@ Assuming YottaDB is accessed via **localhost** listening on TCP port **7041**
 
 * **timeout**: The timeout (in seconds) to be applied to database operations invoked via network based connections.  The default value is 10 seconds.
 
-* **dberror_exceptions**: A boolean value to be set to 'true' or 'false' (default: **dberror_exceptions: false**).  Set this property to 'true' to instruct **mg\-dbx** to throw Node.js exceptions if synchronous invocation of database operations result in an error condition.  If this property is not set, any error condition resulting from the previous database operation can be retrieved using the **db.geterrormessage()** method.
+* **dberror\_exceptions**: A boolean value to be set to 'true' or 'false' (default: **dberror_exceptions: false**).  Set this property to 'true' to instruct **mg\-dbx** to throw Node.js exceptions if synchronous invocation of database operations result in an error condition.  If this property is not set, any error condition resulting from the previous database operation can be retrieved using the **db.geterrormessage()** method.
 
 
 ### Return the version of mg-dbx
@@ -286,7 +286,7 @@ Example 2 (Change the current Namespace):
 
 ### Returning (and optionally changing) the current character set
 
-UTF-8 is the default character encoding for **mg-dbx**.  The other option is the 8-bit ASCII character set (characters of the range ASCII 0 to ASCII 255).  The ASCII character set is a better option when exchanging single-byte binary data with the database.
+UTF-8 is the default character encoding for **mg-dbx**.  The other option is the 8-bit ASCII character set (characters of the range ASCII 0 to ASCII 255).  Native Unicode (as UTF-16) is supported for InterSystems DB Servers. The ASCII character set is a better option when exchanging single-byte binary data with the database.
 
        current_charset = db.charset([<new_charset>]);
 
@@ -298,8 +298,12 @@ Example 2 (Change the current character set):
 
        var new_charset = db.charset('ascii');
 
+Example 3 (Native Unicode support for InterSystems DB Servers): 
+
+       var new_charset = db.charset('utf-16');
+
 * If the operation is successful this method will echo back the new character set name.  If not successful, the method will return the name of the current (unchanged) character set.
-* Currently supported character sets and encoding schemes: 'ascii' and 'utf-8'.
+* Currently supported character sets and encoding schemes: 'ascii', 'utf-8' and 'utf-16' for InterSystems DB Servers.
 
 
 ### Setting (or resetting) the timeout for the connection
@@ -1017,7 +1021,7 @@ Logging can be switched off by calling the **setloglevel** function without spec
 
 ## <a name="License"></a> License
 
-Copyright (c) 2018-2021 M/Gateway Developments Ltd,
+Copyright (c) 2018-2022 M/Gateway Developments Ltd,
 Surrey UK.                                                      
 All rights reserved.
  
@@ -1186,4 +1190,20 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 ### v2.3.25a (22 April 2021)
 
-* Verify that **mg-dbx** will build and work with Node.js v16.x.x.
+* Verify that **mg-dbx** will build and work with Node.js v16.x.x.
+
+### v2.4.26 (2 September 2021)
+
+* Introduce native Unicode support for InterSystems DB Servers - as character set/encoding UTF-16.
+	* db.charset('utf-16')
+* For network-based connectivity, DB Superserver version 4.4.25 (or later) should be used.
+* This update should be regarded as a beta-release. It is recommended that only those who need native support for Unicode on InterSystems DB Servers should upgrade to this release at this time.
+
+### v2.4.27 (20 October 2021)
+
+* Verify that **mg-dbx** will build and work with Node.js v17.x.x.
+
+### v2.4.27a (25 April 2022)
+
+* Verify that **mg-dbx** will build and work with Node.js v18.x.x.
+

package/package.json

@@ -2,7 +2,7 @@
   "author": "Chris Munt <cmunt@mgateway.com> (http://www.gateway.com/)",
   "name": "mg-dbx",
   "description": "High speed Synchronous and Asynchronous access to InterSystems Cache/IRIS and YottaDB from Node.js.",
-  "version": "2.3.25a",
+  "version": "2.4.27a",
   "maintainers": "Chris Munt <cmunt@mgateway.com>",
   "homepage": "https://github.com/chrisemunt/mg-dbx",
   "repository": {

package/src/mg-class.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2016-2022 M/Gateway Developments Ltd,                      |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |
@@ -19,7 +19,7 @@
    | 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.                                           |      
+   | limitations under the License.                                           |
    |                                                                          |
    ----------------------------------------------------------------------------
 */
@@ -99,6 +99,7 @@ void mclass::New(const FunctionCallbackInfo<Value>& args)
    DBXCON *pcon = NULL;
    DBXMETH *pmeth = NULL;
    Local<Object> obj;
+   Local<String> cname;
 
    /* 1.4.10 */
    argc = args.Length();
@@ -128,10 +129,20 @@ void mclass::New(const FunctionCallbackInfo<Value>& args)
          }
          obj->c = c;
          pcon = c->pcon;
-         pmeth = dbx_request_memory(pcon, 1);
+         pmeth = dbx_request_memory(pcon, 1, 1);
          pmeth->argc = argc;
          if (argc > 1) {
-            dbx_write_char8(isolate, DBX_TO_STRING(args[1]), obj->class_name, obj->c->pcon->utf8);
+            cname = DBX_TO_STRING(args[1]);
+            dbx_write_char8(isolate, cname, obj->class_name, obj->c->pcon->utf8);
+            obj->class_name_len = (int) strlen(obj->class_name);
+            if (pcon->utf16) {
+               dbx_write_char16(isolate, cname, obj->class_name16);
+               obj->class_name16_len = (int) dbx_string16_length(isolate, cname);
+            }
+            else {
+               obj->class_name16[0] = 0;
+               obj->class_name16_len = 0;
+            }
             if (argc > 2) {
                DBX_DBFUN_START(c, c->pcon, pmeth);
                pmeth->ibuffer_used = 0;
@@ -244,10 +255,13 @@ void mclass::ClassMethodEx(const FunctionCallbackInfo<Value>& args, int binary)
    if (pcon->log_functions) {
       c->LogFunction(c, args, (void *) clx, (char *) "mclass::classmethod");
    }
-   pmeth = dbx_request_memory(pcon, 0);
+   pmeth = dbx_request_memory(pcon, 1, 0);
 
    pmeth->binary = binary;
    cref.class_name = clx->class_name;
+   cref.class_name_len = clx->class_name_len;
+   cref.class_name16 = clx->class_name16;
+   cref.class_name16_len = clx->class_name16_len;
    cref.oref = clx->oref;
 
    DBX_CALLBACK_FUN(pmeth->argc, async);
@@ -316,7 +330,7 @@ void mclass::ClassMethodEx(const FunctionCallbackInfo<Value>& args, int binary)
          args.GetReturnValue().Set(bx);
       }
       else {
-         str = dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
+         str = pcon->utf16 ? dbx_new_string16n(isolate, pmeth->output_val.cvalue.buf16_addr, pmeth->output_val.cvalue.len_used) : dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
          args.GetReturnValue().Set(str);
       }
       dbx_request_memory_free(pcon, pmeth, 0);
@@ -329,7 +343,11 @@ void mclass::ClassMethodEx(const FunctionCallbackInfo<Value>& args, int binary)
 
    clx1->c = c;
    clx1->oref =  pmeth->output_val.num.oref;
-   strcpy(clx1->class_name, "");
+   clx1->class_name[0] = '\0';
+   clx1->class_name_len = 0;
+   clx1->class_name16[0] = 0;
+   clx1->class_name16_len = 0;
+
    dbx_request_memory_free(pcon, pmeth, 0);
    return;
 }
@@ -365,10 +383,13 @@ void mclass::MethodEx(const FunctionCallbackInfo<Value>& args, int binary)
    if (pcon->log_functions) {
       c->LogFunction(c, args, (void *) clx, (char *) "mclass::method");
    }
-   pmeth = dbx_request_memory(pcon, 0);
+   pmeth = dbx_request_memory(pcon, 1, 0);
 
    pmeth->binary = binary;
    cref.class_name = clx->class_name;
+   cref.class_name_len = clx->class_name_len;
+   cref.class_name16 = clx->class_name16;
+   cref.class_name16_len = clx->class_name16_len;
    cref.oref = clx->oref;
 
    DBX_CALLBACK_FUN(pmeth->argc, async);
@@ -437,7 +458,7 @@ void mclass::MethodEx(const FunctionCallbackInfo<Value>& args, int binary)
          args.GetReturnValue().Set(bx);
       }
       else {
-         str = dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
+         str = pcon->utf16 ? dbx_new_string16n(isolate, pmeth->output_val.cvalue.buf16_addr, pmeth->output_val.cvalue.len_used) : dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
          args.GetReturnValue().Set(str);
       }
       dbx_request_memory_free(pcon, pmeth, 0);
@@ -450,7 +471,11 @@ void mclass::MethodEx(const FunctionCallbackInfo<Value>& args, int binary)
 
    clx1->c = c;
    clx1->oref =  pmeth->output_val.num.oref;
-   strcpy(clx1->class_name, "");
+   clx1->class_name[0] = '\0';
+   clx1->class_name_len = 0;
+   clx1->class_name16[0] = 0;
+   clx1->class_name16_len = 0;
+
    dbx_request_memory_free(pcon, pmeth, 0);
    return;
 }
@@ -474,9 +499,12 @@ void mclass::SetProperty(const FunctionCallbackInfo<Value>& args)
    if (pcon->log_functions) {
       c->LogFunction(c, args, (void *) clx, (char *) "mclass::setproperty");
    }
-   pmeth = dbx_request_memory(pcon, 0);
+   pmeth = dbx_request_memory(pcon, 1, 0);
 
    cref.class_name = clx->class_name;
+   cref.class_name_len = clx->class_name_len;
+   cref.class_name16 = clx->class_name16;
+   cref.class_name16_len = clx->class_name16_len;
    cref.oref = clx->oref;
 
    DBX_CALLBACK_FUN(pmeth->argc, async);
@@ -576,10 +604,13 @@ void mclass::GetPropertyEx(const FunctionCallbackInfo<Value>& args, int binary)
    if (pcon->log_functions) {
       c->LogFunction(c, args, (void *) clx, (char *) "mclass::getproperty");
    }
-   pmeth = dbx_request_memory(pcon, 0);
+   pmeth = dbx_request_memory(pcon, 1, 0);
 
    pmeth->binary = binary;
    cref.class_name = clx->class_name;
+   cref.class_name_len = clx->class_name_len;
+   cref.class_name16 = clx->class_name16;
+   cref.class_name16_len = clx->class_name16_len;
    cref.oref = clx->oref;
 
    DBX_CALLBACK_FUN(pmeth->argc, async);
@@ -648,7 +679,7 @@ void mclass::GetPropertyEx(const FunctionCallbackInfo<Value>& args, int binary)
          args.GetReturnValue().Set(bx);
       }
       else {
-         str = dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
+         str = pcon->utf16 ? dbx_new_string16n(isolate, pmeth->output_val.cvalue.buf16_addr, pmeth->output_val.cvalue.len_used) : dbx_new_string8n(isolate, pmeth->output_val.svalue.buf_addr, pmeth->output_val.svalue.len_used, pcon->utf8);
          args.GetReturnValue().Set(str);
       }
       dbx_request_memory_free(pcon, pmeth, 0);
@@ -663,7 +694,11 @@ void mclass::GetPropertyEx(const FunctionCallbackInfo<Value>& args, int binary)
 
    clx1->c = c;
    clx1->oref =  pmeth->output_val.num.oref;
-   strcpy(clx1->class_name, "");
+   clx1->class_name[0] = '\0';
+   clx1->class_name_len = 0;
+   clx1->class_name16[0] = 0;
+   clx1->class_name16_len = 0;
+
    dbx_request_memory_free(pcon, pmeth, 0);
    return;
 }
@@ -678,6 +713,7 @@ void mclass::Reset(const FunctionCallbackInfo<Value>& args)
    DBXMETH *pmeth;
    Local<Object> obj;
    Local<String> str;
+   Local<String> cname;
    mclass *clx = ObjectWrap::Unwrap<mclass>(args.This());
    MG_CLASS_CHECK_CLASS(clx);
    DBX_DBNAME *c = clx->c;
@@ -688,7 +724,7 @@ void mclass::Reset(const FunctionCallbackInfo<Value>& args)
    if (pcon->log_functions) {
       c->LogFunction(c, args, (void *) clx, (char *) "mclass::reset");
    }
-   pmeth = dbx_request_memory(pcon, 0);
+   pmeth = dbx_request_memory(pcon, 1, 0);
 
    DBX_CALLBACK_FUN(pmeth->argc, async);
 
@@ -700,7 +736,8 @@ void mclass::Reset(const FunctionCallbackInfo<Value>& args)
       return;
    }
 
-   dbx_write_char8(isolate, DBX_TO_STRING(args[0]), class_name, pcon->utf8);
+   cname = DBX_TO_STRING(args[0]);
+   dbx_write_char8(isolate, cname, class_name, pcon->utf8);
    if (class_name[0] == '\0') {
       isolate->ThrowException(Exception::Error(dbx_new_string8(isolate, (char *) "The class:reset method takes at least one argument (the class name)", 1)));
       dbx_request_memory_free(pcon, pmeth, 0);
@@ -740,6 +777,15 @@ void mclass::Reset(const FunctionCallbackInfo<Value>& args)
 
    clx->oref =  pmeth->output_val.num.oref;
    strcpy(clx->class_name, class_name);
+   clx->class_name_len = (int) strlen(clx->class_name);
+   if (pcon->utf16) {
+      dbx_write_char16(isolate, cname, clx->class_name16);
+      clx->class_name16_len = dbx_string16_length(isolate, cname);
+   }
+   else {
+      clx->class_name16[0] = 0;
+      clx->class_name16_len = 0;
+   }
 
    dbx_request_memory_free(pcon, pmeth, 0);
    return;

package/src/mg-class.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2016-2022 M/Gateway Developments Ltd,                      |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |
@@ -19,7 +19,7 @@
    | 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.                                           |      
+   | limitations under the License.                                           |
    |                                                                          |
    ----------------------------------------------------------------------------
 */
@@ -42,6 +42,9 @@ class mclass : public node::ObjectWrap
    int            dbx_count;
    int            oref;
    char           class_name[256];
+   int            class_name_len;
+   unsigned short class_name16[256];
+   int            class_name16_len;
    DBX_DBNAME     *c;