[0.4.12] [JSCRIPT] Fix regression CORE-13810 "Vypress Chat 2.1.9 MSI setup fatal error"

The regression was unhidden by MSI-winesync 1.5.10 almost 7years ago:
8939969e21

Finally we can fix it by adding MS enumerator extension to Jscript.
Many thanks to the patches author
Andreas Maier <staubim@quantentunnel.de>
JIRA-nick: andy-123

The patch is WIP and was not committed to master yet.

https://reactos.org/testman/compare.php?ids=67482,67485

dll/win32/jscript/CMakeLists.txt

@@ -16,6 +16,7 @@ list(APPEND SOURCE
     decode.c
     dispex.c
     engine.c
+    enumerator.c
     error.c
     function.c
     global.c

dll/win32/jscript/enumerator.c

@@ -0,0 +1,363 @@
+/*
+ * Copyright 2019 Andreas Maier
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+#include <assert.h>
+
+#include "jscript.h"
+
+#include "wine/debug.h"
+
+WINE_DEFAULT_DEBUG_CHANNEL(jscript);
+
+typedef struct {
+    jsdisp_t dispex;
+    /* IEnumVARIANT returned by _NewEnum */
+    IEnumVARIANT *enumvar;
+    /* current item */
+    jsval_t item;
+    BOOL atend;
+} EnumeratorInstance;
+
+static const WCHAR atEndW[] = {'a','t','E','n','d',0};
+static const WCHAR itemW[] = {'i','t','e','m',0};
+static const WCHAR moveFirstW[] = {'m','o','v','e','F','i','r','s','t',0};
+static const WCHAR moveNextW[] = {'m','o','v','e','N','e','x','t',0};
+
+static inline EnumeratorInstance *enumerator_from_jsdisp(jsdisp_t *jsdisp)
+{
+    return CONTAINING_RECORD(jsdisp, EnumeratorInstance, dispex);
+}
+
+static inline EnumeratorInstance *enumerator_from_vdisp(vdisp_t *vdisp)
+{
+    return enumerator_from_jsdisp(vdisp->u.jsdisp);
+}
+
+static inline EnumeratorInstance *enumerator_this(vdisp_t *jsthis)
+{
+    return is_vclass(jsthis, JSCLASS_ENUMERATOR) ? enumerator_from_vdisp(jsthis) : NULL;
+}
+
+static inline HRESULT enumvar_get_next_item(EnumeratorInstance *This)
+{
+    HRESULT hres;
+    VARIANT nextitem;
+
+    if (This->atend)
+        return S_OK;
+
+    /* dont leak pervious value */
+    jsval_release(This->item);
+
+    /* not at end ... get next item */
+    VariantInit(&nextitem);
+    hres = IEnumVARIANT_Next(This->enumvar, 1, &nextitem, NULL);
+    if (hres == S_OK)
+    {
+        hres = variant_to_jsval(&nextitem, &This->item);
+        if (FAILED(hres))
+        {
+            WARN("failed to convert jsval to variant!");
+            This->item = jsval_undefined();
+        }
+    }
+    else
+    {
+        This->item = jsval_undefined();
+        This->atend = TRUE;
+    }
+    VariantClear(&nextitem);
+
+    return S_OK;
+}
+
+static void Enumerator_destructor(jsdisp_t *dispex)
+{
+    EnumeratorInstance *This = enumerator_from_jsdisp(dispex);
+
+    TRACE("\n");
+
+    jsval_release(This->item);
+    heap_free(dispex);
+}
+
+static HRESULT Enumerator_atEnd(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
+        jsval_t *r)
+{
+    EnumeratorInstance *This;
+
+    if (!(This = enumerator_this(jsthis)))
+        return throw_type_error(ctx, JS_E_ENUMERATOR_EXPECTED, NULL);
+
+    if (r)
+        *r = jsval_bool(This->atend);
+
+    TRACE("%d\n", This->atend);
+
+    return S_OK;
+}
+
+static HRESULT Enumerator_item(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
+        jsval_t *r)
+{
+    EnumeratorInstance *This;
+
+    TRACE("\n");
+
+    if (!(This = enumerator_this(jsthis)))
+        return throw_type_error(ctx, JS_E_ENUMERATOR_EXPECTED, NULL);
+
+    return r ? jsval_copy(This->item, r) : S_OK;
+}
+
+static HRESULT Enumerator_moveFirst(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
+        jsval_t *r)
+{
+    EnumeratorInstance *This;
+    HRESULT hres = S_OK;
+
+    TRACE("\n");
+
+    if (!(This = enumerator_this(jsthis)))
+        return throw_type_error(ctx, JS_E_ENUMERATOR_EXPECTED, NULL);
+
+    if (This->enumvar)
+    {
+        This->atend = FALSE;
+        hres = IEnumVARIANT_Reset(This->enumvar);
+        if (!FAILED(hres))
+            hres = enumvar_get_next_item(This);
+    }
+
+    if (r)
+        *r = jsval_undefined();
+
+    return hres;
+}
+
+static HRESULT Enumerator_moveNext(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
+        jsval_t *r)
+{
+    EnumeratorInstance *This;
+    HRESULT hres = S_OK;
+
+    TRACE("\n");
+
+    if (!(This = enumerator_this(jsthis)))
+        return throw_type_error(ctx, JS_E_ENUMERATOR_EXPECTED, NULL);
+
+    if (This->enumvar)
+        hres = enumvar_get_next_item(This);
+
+    if (r)
+        *r = jsval_undefined();
+
+    return hres;
+}
+
+static const builtin_prop_t Enumerator_props[] = {
+    {atEndW,     Enumerator_atEnd,     PROPF_METHOD},
+    {itemW,      Enumerator_item,      PROPF_METHOD},
+    {moveFirstW, Enumerator_moveFirst, PROPF_METHOD},
+    {moveNextW,  Enumerator_moveNext,  PROPF_METHOD},
+};
+
+static const builtin_info_t Enumerator_info = {
+    JSCLASS_ENUMERATOR,
+    {NULL, NULL, 0},
+    ARRAY_SIZE(Enumerator_props),
+    Enumerator_props,
+    NULL,
+    NULL
+};
+
+static const builtin_info_t EnumeratorInst_info = {
+    JSCLASS_ENUMERATOR,
+    {NULL, NULL, 0, NULL},
+    0,
+    NULL,
+    Enumerator_destructor,
+    NULL
+};
+
+static HRESULT EnumeratorConstr_value(script_ctx_t *ctx, vdisp_t *vthis, WORD flags, unsigned argc, jsval_t *argv,
+        jsval_t *r)
+{
+    jsdisp_t *obj;
+    jsval_t *arg0;
+    HRESULT hres;
+
+    TRACE("\n");
+
+    switch(flags) {
+    case DISPATCH_CONSTRUCT: {
+        if (argc > 1)
+            return throw_syntax_error(ctx, JS_E_INVALIDARG, NULL);
+
+        arg0 = (argc == 1) ? &argv[0] : 0;
+        hres = create_enumerator(ctx, arg0, &obj);
+        if(FAILED(hres))
+            return hres;
+
+        *r = jsval_obj(obj);
+        break;
+    }
+    default:
+        FIXME("unimplemented flags: %x\n", flags);
+        return E_NOTIMPL;
+    }
+
+    return S_OK;
+}
+
+static HRESULT alloc_enumerator(script_ctx_t *ctx, jsdisp_t *object_prototype, EnumeratorInstance **ret)
+{
+    EnumeratorInstance *enumerator;
+    HRESULT hres;
+
+    enumerator = heap_alloc_zero(sizeof(EnumeratorInstance));
+    if(!enumerator)
+        return E_OUTOFMEMORY;
+
+    if(object_prototype)
+        hres = init_dispex(&enumerator->dispex, ctx, &Enumerator_info, object_prototype);
+    else
+        hres = init_dispex_from_constr(&enumerator->dispex, ctx, &EnumeratorInst_info,
+                                       ctx->enumerator_constr);
+
+    if(FAILED(hres))
+    {
+        heap_free(enumerator);
+        return hres;
+    }
+
+    *ret = enumerator;
+    return S_OK;
+}
+
+static const builtin_info_t EnumeratorConstr_info = {
+    JSCLASS_FUNCTION,
+    DEFAULT_FUNCTION_VALUE,
+    0,
+    NULL,
+    NULL,
+    NULL
+};
+
+HRESULT create_enumerator_constr(script_ctx_t *ctx, jsdisp_t *object_prototype, jsdisp_t **ret)
+{
+    EnumeratorInstance *enumerator;
+    HRESULT hres;
+    static const WCHAR EnumeratorW[] = {'E','n','u','m','e','r','a','t','o','r',0};
+
+    hres = alloc_enumerator(ctx, object_prototype, &enumerator);
+    if(FAILED(hres))
+        return hres;
+
+    hres = create_builtin_constructor(ctx, EnumeratorConstr_value,
+                                     EnumeratorW, &EnumeratorConstr_info,
+                                     PROPF_CONSTR|7, &enumerator->dispex, ret);
+    jsdisp_release(&enumerator->dispex);
+
+    return hres;
+}
+
+HRESULT create_enumerator(script_ctx_t *ctx, jsval_t *argv, jsdisp_t **ret)
+{
+    EnumeratorInstance *enumerator;
+    HRESULT hres;
+    IDispatch *obj;
+    DISPPARAMS dispparams = {NULL, NULL, 0, 0};
+    VARIANT varresult;
+    BOOL atend;
+
+    IEnumVARIANT *enumvar;
+
+    memset(&varresult, 0, sizeof(VARIANT));
+    VariantInit(&varresult);
+
+    /* new Enumerator() */
+    if (argv == NULL)
+    {
+        enumvar = NULL;
+        atend = TRUE;
+    }
+    else if (is_object_instance(*argv))
+    {
+        obj = get_object(*argv);
+
+        /* Try to get a IEnumVARIANT by _NewEnum */
+        hres = IDispatch_Invoke(obj,
+            DISPID_NEWENUM, &IID_NULL, LOCALE_NEUTRAL,
+            DISPATCH_METHOD, &dispparams, &varresult,
+            NULL, NULL);
+        if (FAILED(hres))
+        {
+            WARN("Enumerator: no DISPID_NEWENUM.\n");
+            hres = E_INVALIDARG;
+            goto cleanuperr;
+        }
+
+        if ((V_VT(&varresult) == VT_DISPATCH) ||
+            (V_VT(&varresult) == VT_UNKNOWN))
+        {
+            hres = IUnknown_QueryInterface(V_UNKNOWN(&varresult),
+                &IID_IEnumVARIANT, (void**)&enumvar);
+            if (FAILED(hres))
+            {
+                hres = E_INVALIDARG;
+                goto cleanuperr;
+            }
+        }
+        else
+        {
+            FIXME("Enumerator: NewEnum unexpected type of varresult (%d).\n", V_VT(&varresult));
+            hres = E_INVALIDARG;
+            goto cleanuperr;
+        }
+        VariantClear(&varresult);
+
+        atend = FALSE;
+    }
+    else
+    {
+        FIXME("I don't know how to handle this type!\n");
+        hres = E_NOTIMPL;
+        goto cleanuperr;
+    }
+
+    hres = alloc_enumerator(ctx, NULL, &enumerator);
+    if(FAILED(hres))
+        goto cleanuperr;
+
+    enumerator->atend = atend;
+    enumerator->enumvar = enumvar;
+
+    hres = enumvar_get_next_item(enumerator);
+    if (FAILED(hres))
+        goto cleanuperr;
+
+    *ret = &enumerator->dispex;
+
+    return S_OK;
+cleanuperr:
+    VariantClear(&varresult);
+    if (enumerator)
+        heap_free(enumerator);
+    return hres;
+}

dll/win32/jscript/global.c

@@ -113,13 +113,6 @@ static WCHAR int_to_char(int i)
     return 'A'+i-10;
 }
 
-static HRESULT JSGlobal_Enumerator(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
-        jsval_t *r)
-{
-    FIXME("\n");
-    return E_NOTIMPL;
-}
-
 static HRESULT JSGlobal_escape(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
         jsval_t *r)
 {
@@ -942,7 +935,6 @@ static HRESULT JSGlobal_decodeURIComponent(script_ctx_t *ctx, vdisp_t *jsthis, W
 
 static const builtin_prop_t JSGlobal_props[] = {
     {CollectGarbageW,            JSGlobal_CollectGarbage,            PROPF_METHOD},
-    {EnumeratorW,                JSGlobal_Enumerator,                PROPF_METHOD|7},
     {_GetObjectW,                JSGlobal_GetObject,                 PROPF_METHOD|2},
     {ScriptEngineW,              JSGlobal_ScriptEngine,              PROPF_METHOD},
     {ScriptEngineBuildVersionW,  JSGlobal_ScriptEngineBuildVersion,  PROPF_METHOD},
@@ -1019,6 +1011,15 @@ static HRESULT init_constructors(script_ctx_t *ctx, jsdisp_t *object_prototype)
     if(FAILED(hres))
         return hres;
 
+    hres = create_enumerator_constr(ctx, object_prototype, &ctx->enumerator_constr);
+    if(FAILED(hres))
+        return hres;
+
+    hres = jsdisp_define_data_property(ctx->global, EnumeratorW, PROPF_WRITABLE,
+                                       jsval_obj(ctx->enumerator_constr));
+    if(FAILED(hres))
+        return hres;
+
     hres = init_error_constr(ctx, object_prototype);
     if(FAILED(hres))
         return hres;

dll/win32/jscript/jscript.h

@@ -118,6 +118,7 @@ typedef enum {
     JSCLASS_ARRAY,
     JSCLASS_BOOLEAN,
     JSCLASS_DATE,
+    JSCLASS_ENUMERATOR,
     JSCLASS_ERROR,
     JSCLASS_FUNCTION,
     JSCLASS_GLOBAL,
@@ -328,6 +329,7 @@ HRESULT create_bool(script_ctx_t*,BOOL,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_number(script_ctx_t*,double,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_vbarray(script_ctx_t*,SAFEARRAY*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_json(script_ctx_t*,jsdisp_t**) DECLSPEC_HIDDEN;
+HRESULT create_enumerator(script_ctx_t *ctx, jsval_t *argv, jsdisp_t **ret) DECLSPEC_HIDDEN;
 
 typedef enum {
     NO_HINT,
@@ -438,6 +440,7 @@ struct _script_ctx_t {
     jsdisp_t *array_constr;
     jsdisp_t *bool_constr;
     jsdisp_t *date_constr;
+    jsdisp_t *enumerator_constr;
     jsdisp_t *error_constr;
     jsdisp_t *eval_error_constr;
     jsdisp_t *range_error_constr;
@@ -470,6 +473,7 @@ HRESULT create_array_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_bool_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_date_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT init_error_constr(script_ctx_t*,jsdisp_t*) DECLSPEC_HIDDEN;
+HRESULT create_enumerator_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_number_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_object_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 HRESULT create_regexp_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**) DECLSPEC_HIDDEN;
@@ -560,6 +564,7 @@ static inline DWORD make_grfdex(script_ctx_t *ctx, DWORD flags)
 #define JS_E_VBARRAY_EXPECTED        MAKE_JSERROR(IDS_NOT_VBARRAY)
 #define JS_E_INVALID_DELETE          MAKE_JSERROR(IDS_INVALID_DELETE)
 #define JS_E_JSCRIPT_EXPECTED        MAKE_JSERROR(IDS_JSCRIPT_EXPECTED)
+#define JS_E_ENUMERATOR_EXPECTED     MAKE_JSERROR(IDS_NOT_ENUMERATOR)
 #define JS_E_REGEXP_SYNTAX           MAKE_JSERROR(IDS_REGEXP_SYNTAX_ERROR)
 #define JS_E_INVALID_URI_CODING      MAKE_JSERROR(IDS_URI_INVALID_CODING)
 #define JS_E_INVALID_URI_CHAR        MAKE_JSERROR(IDS_URI_INVALID_CHAR)

dll/win32/jscript/object.c

@@ -66,7 +66,7 @@ static HRESULT Object_toString(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, u
     static const WCHAR regexpW[] = {'R','e','g','E','x','p',0};
     static const WCHAR stringW[] = {'S','t','r','i','n','g',0};
     /* Keep in sync with jsclass_t enum */
-    static const WCHAR *names[] = {NULL, arrayW, booleanW, dateW, errorW,
+    static const WCHAR *names[] = {NULL, arrayW, booleanW, dateW, objectW, errorW,
         functionW, NULL, mathW, numberW, objectW, regexpW, stringW, objectW, objectW, objectW};
 
     TRACE("\n");

dll/win32/jscript/resource.h

@@ -58,6 +58,7 @@
 #define IDS_INVALID_DELETE                  0x1394
 #define IDS_NOT_VBARRAY                     0x1395
 #define IDS_JSCRIPT_EXPECTED                0x1396
+#define IDS_NOT_ENUMERATOR                  0x1397
 #define IDS_REGEXP_SYNTAX_ERROR             0x1399
 #define IDS_URI_INVALID_CHAR                0x13A0
 #define IDS_URI_INVALID_CODING              0x13A1