mshtml: Added IHTMLWindow6::get_sessionStorage implementation.
[wine] / dlls / vbscript / vbdisp.c
1 /*
2  * Copyright 2011 Jacek Caban for CodeWeavers
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17  */
18
19 #include <assert.h>
20
21 #include "vbscript.h"
22
23 #include "wine/debug.h"
24
25 WINE_DEFAULT_DEBUG_CHANNEL(vbscript);
26
27 #define FDEX_VERSION_MASK 0xf0000000
28
29 static inline BOOL is_func_id(vbdisp_t *This, DISPID id)
30 {
31     return id < This->desc->func_cnt;
32 }
33
34 static BOOL get_func_id(vbdisp_t *This, const WCHAR *name, vbdisp_invoke_type_t invoke_type, BOOL search_private, DISPID *id)
35 {
36     unsigned i;
37
38     for(i = invoke_type == VBDISP_ANY ? 0 : 1; i < This->desc->func_cnt; i++) {
39         if(invoke_type == VBDISP_ANY) {
40             if(!search_private && !This->desc->funcs[i].is_public)
41                 continue;
42             if(!i && !This->desc->funcs[0].name) /* default value may not exist */
43                 continue;
44         }else {
45             if(!This->desc->funcs[i].entries[invoke_type]
46                 || (!search_private && !This->desc->funcs[i].entries[invoke_type]->is_public))
47                 continue;
48         }
49
50         if(!strcmpiW(This->desc->funcs[i].name, name)) {
51             *id = i;
52             return TRUE;
53         }
54     }
55
56     return FALSE;
57 }
58
59 HRESULT vbdisp_get_id(vbdisp_t *This, BSTR name, vbdisp_invoke_type_t invoke_type, BOOL search_private, DISPID *id)
60 {
61     unsigned i;
62
63     if(get_func_id(This, name, invoke_type, search_private, id))
64         return S_OK;
65
66     for(i=0; i < This->desc->prop_cnt; i++) {
67         if(!search_private && !This->desc->props[i].is_public)
68             continue;
69
70         if(!strcmpiW(This->desc->props[i].name, name)) {
71             *id = i + This->desc->func_cnt;
72             return S_OK;
73         }
74     }
75
76     if(This->desc->typeinfo) {
77         HRESULT hres;
78
79         hres = ITypeInfo_GetIDsOfNames(This->desc->typeinfo, &name, 1, id);
80         if(SUCCEEDED(hres))
81             return S_OK;
82     }
83
84     *id = -1;
85     return DISP_E_UNKNOWNNAME;
86 }
87
88 static VARIANT *get_propput_arg(const DISPPARAMS *dp)
89 {
90     unsigned i;
91
92     for(i=0; i < dp->cNamedArgs; i++) {
93         if(dp->rgdispidNamedArgs[i] == DISPID_PROPERTYPUT)
94             return dp->rgvarg+i;
95     }
96
97     return NULL;
98 }
99
100 static HRESULT invoke_variant_prop(vbdisp_t *This, VARIANT *v, WORD flags, DISPPARAMS *dp, VARIANT *res)
101 {
102     HRESULT hres;
103
104     switch(flags) {
105     case DISPATCH_PROPERTYGET|DISPATCH_METHOD:
106         if(dp->cArgs) {
107             WARN("called with arguments\n");
108             return DISP_E_MEMBERNOTFOUND; /* That's what tests show */
109         }
110
111         hres = VariantCopy(res, v);
112         break;
113
114     case DISPATCH_PROPERTYPUT: {
115         VARIANT *put_val;
116
117         put_val = get_propput_arg(dp);
118         if(!put_val) {
119             WARN("no value to set\n");
120             return DISP_E_PARAMNOTOPTIONAL;
121         }
122
123         if(res)
124             V_VT(res) = VT_EMPTY;
125
126         hres = VariantCopy(v, put_val);
127         break;
128     }
129
130     default:
131         FIXME("unimplemented flags %x\n", flags);
132         return E_NOTIMPL;
133     }
134
135     return hres;
136 }
137
138 static HRESULT invoke_builtin(vbdisp_t *This, const builtin_prop_t *prop, WORD flags, DISPPARAMS *dp, VARIANT *res)
139 {
140     VARIANT *args, arg_buf[8];
141     unsigned argn;
142
143     switch(flags) {
144     case DISPATCH_PROPERTYGET:
145         if(!(prop->flags & (BP_GET|BP_GETPUT))) {
146             FIXME("property does not support DISPATCH_PROPERTYGET\n");
147             return E_FAIL;
148         }
149         break;
150     case DISPATCH_PROPERTYGET|DISPATCH_METHOD:
151         break;
152     case DISPATCH_METHOD:
153         if(prop->flags & (BP_GET|BP_GETPUT)) {
154             FIXME("Call on property\n");
155             return E_FAIL;
156         }
157         break;
158     case DISPATCH_PROPERTYPUT:
159         if(!(prop->flags & (BP_GET|BP_GETPUT))) {
160             FIXME("property does not support DISPATCH_PROPERTYPUT\n");
161             return E_FAIL;
162         }
163
164         FIXME("call put\n");
165         return E_NOTIMPL;
166     default:
167         FIXME("unsupported flags %x\n", flags);
168         return E_NOTIMPL;
169     }
170
171     argn = arg_cnt(dp);
172
173     if(argn < prop->min_args || argn > (prop->max_args ? prop->max_args : prop->min_args)) {
174         FIXME("invalid number of arguments\n");
175         return E_FAIL;
176     }
177
178     args = dp->rgvarg;
179
180     if(argn == 1) {
181         if(V_VT(dp->rgvarg) == (VT_BYREF|VT_VARIANT))
182             args = V_VARIANTREF(dp->rgvarg);
183     }else {
184         unsigned i;
185
186         assert(argn < sizeof(arg_buf)/sizeof(*arg_buf));
187
188         for(i=0; i < argn; i++) {
189             if(V_VT(dp->rgvarg+i) == (VT_BYREF|VT_VARIANT)) {
190                 for(i=0; i < argn; i++) {
191                     if(V_VT(dp->rgvarg+i) == (VT_BYREF|VT_VARIANT))
192                         arg_buf[i] = *V_VARIANTREF(dp->rgvarg+i);
193                     else
194                         arg_buf[i] = dp->rgvarg[i];
195                 }
196                 args = arg_buf;
197                 break;
198             }
199         }
200     }
201
202     return prop->proc(This, args, dp->cArgs, res);
203 }
204
205 static BOOL run_terminator(vbdisp_t *This)
206 {
207     DISPPARAMS dp = {0};
208
209     if(This->terminator_ran)
210         return TRUE;
211     This->terminator_ran = TRUE;
212
213     if(!This->desc->class_terminate_id)
214         return TRUE;
215
216     This->ref++;
217     exec_script(This->desc->ctx, This->desc->funcs[This->desc->class_terminate_id].entries[VBDISP_CALLGET],
218             (IDispatch*)&This->IDispatchEx_iface, &dp, NULL);
219     return !--This->ref;
220 }
221
222 static void clean_props(vbdisp_t *This)
223 {
224     unsigned i;
225
226     if(!This->desc)
227         return;
228
229     for(i=0; i < This->desc->prop_cnt; i++)
230         VariantClear(This->props+i);
231 }
232
233 static inline vbdisp_t *impl_from_IDispatchEx(IDispatchEx *iface)
234 {
235     return CONTAINING_RECORD(iface, vbdisp_t, IDispatchEx_iface);
236 }
237
238 static HRESULT WINAPI DispatchEx_QueryInterface(IDispatchEx *iface, REFIID riid, void **ppv)
239 {
240     vbdisp_t *This = impl_from_IDispatchEx(iface);
241
242     if(IsEqualGUID(&IID_IUnknown, riid)) {
243         TRACE("(%p)->(IID_IUnknown %p)\n", This, ppv);
244         *ppv = &This->IDispatchEx_iface;
245     }else if(IsEqualGUID(&IID_IDispatch, riid)) {
246         TRACE("(%p)->(IID_IDispatch %p)\n", This, ppv);
247         *ppv = &This->IDispatchEx_iface;
248     }else if(IsEqualGUID(&IID_IDispatchEx, riid)) {
249         TRACE("(%p)->(IID_IDispatchEx %p)\n", This, ppv);
250         *ppv = &This->IDispatchEx_iface;
251     }else {
252         WARN("(%p)->(%s %p)\n", This, debugstr_guid(riid), ppv);
253         *ppv = NULL;
254         return E_NOINTERFACE;
255     }
256
257     IUnknown_AddRef((IUnknown*)*ppv);
258     return S_OK;
259 }
260
261 static ULONG WINAPI DispatchEx_AddRef(IDispatchEx *iface)
262 {
263     vbdisp_t *This = impl_from_IDispatchEx(iface);
264     LONG ref = InterlockedIncrement(&This->ref);
265
266     TRACE("(%p) ref=%d\n", This, ref);
267
268     return ref;
269 }
270
271 static ULONG WINAPI DispatchEx_Release(IDispatchEx *iface)
272 {
273     vbdisp_t *This = impl_from_IDispatchEx(iface);
274     LONG ref = InterlockedDecrement(&This->ref);
275
276     TRACE("(%p) ref=%d\n", This, ref);
277
278     if(!ref && run_terminator(This)) {
279         clean_props(This);
280         list_remove(&This->entry);
281         heap_free(This);
282     }
283
284     return ref;
285 }
286
287 static HRESULT WINAPI DispatchEx_GetTypeInfoCount(IDispatchEx *iface, UINT *pctinfo)
288 {
289     vbdisp_t *This = impl_from_IDispatchEx(iface);
290
291     TRACE("(%p)->(%p)\n", This, pctinfo);
292
293     *pctinfo = 1;
294     return S_OK;
295 }
296
297 static HRESULT WINAPI DispatchEx_GetTypeInfo(IDispatchEx *iface, UINT iTInfo, LCID lcid,
298                                               ITypeInfo **ppTInfo)
299 {
300     vbdisp_t *This = impl_from_IDispatchEx(iface);
301     FIXME("(%p)->(%u %u %p)\n", This, iTInfo, lcid, ppTInfo);
302     return E_NOTIMPL;
303 }
304
305 static HRESULT WINAPI DispatchEx_GetIDsOfNames(IDispatchEx *iface, REFIID riid,
306                                                 LPOLESTR *rgszNames, UINT cNames, LCID lcid,
307                                                 DISPID *rgDispId)
308 {
309     vbdisp_t *This = impl_from_IDispatchEx(iface);
310     FIXME("(%p)->(%s %p %u %u %p)\n", This, debugstr_guid(riid), rgszNames, cNames,
311           lcid, rgDispId);
312     return E_NOTIMPL;
313 }
314
315 static HRESULT WINAPI DispatchEx_Invoke(IDispatchEx *iface, DISPID dispIdMember,
316                                         REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams,
317                             VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)
318 {
319     vbdisp_t *This = impl_from_IDispatchEx(iface);
320     FIXME("(%p)->(%d %s %d %d %p %p %p %p)\n", This, dispIdMember, debugstr_guid(riid),
321           lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
322     return E_NOTIMPL;
323 }
324
325 static HRESULT WINAPI DispatchEx_GetDispID(IDispatchEx *iface, BSTR bstrName, DWORD grfdex, DISPID *pid)
326 {
327     vbdisp_t *This = impl_from_IDispatchEx(iface);
328
329     TRACE("(%p)->(%s %x %p)\n", This, debugstr_w(bstrName), grfdex, pid);
330
331     grfdex &= ~FDEX_VERSION_MASK;
332
333     if(!This->desc)
334         return E_UNEXPECTED;
335
336     /* Tests show that fdexNameCaseSensitive is ignored */
337
338     if(grfdex & ~(fdexNameEnsure|fdexNameCaseInsensitive|fdexNameCaseSensitive)) {
339         FIXME("unsupported flags %x\n", grfdex);
340         return E_NOTIMPL;
341     }
342
343     return vbdisp_get_id(This, bstrName, VBDISP_ANY, FALSE, pid);
344 }
345
346 static HRESULT WINAPI DispatchEx_InvokeEx(IDispatchEx *iface, DISPID id, LCID lcid, WORD wFlags, DISPPARAMS *pdp,
347         VARIANT *pvarRes, EXCEPINFO *pei, IServiceProvider *pspCaller)
348 {
349     vbdisp_t *This = impl_from_IDispatchEx(iface);
350
351     TRACE("(%p)->(%x %x %x %p %p %p %p)\n", This, id, lcid, wFlags, pdp, pvarRes, pei, pspCaller);
352
353     if(!This->desc)
354         return E_UNEXPECTED;
355
356     if(pvarRes)
357         V_VT(pvarRes) = VT_EMPTY;
358
359     if(id < 0)
360         return DISP_E_MEMBERNOTFOUND;
361
362     if(is_func_id(This, id)) {
363         function_t *func;
364
365         switch(wFlags) {
366         case DISPATCH_METHOD:
367         case DISPATCH_METHOD|DISPATCH_PROPERTYGET:
368             func = This->desc->funcs[id].entries[VBDISP_CALLGET];
369             if(!func) {
370                 FIXME("no invoke/getter\n");
371                 return DISP_E_MEMBERNOTFOUND;
372             }
373
374             return exec_script(This->desc->ctx, func, (IDispatch*)&This->IDispatchEx_iface, pdp, pvarRes);
375         case DISPATCH_PROPERTYPUT: {
376             VARIANT *put_val;
377             DISPPARAMS dp = {NULL, NULL, 1, 0};
378
379             if(arg_cnt(pdp)) {
380                 FIXME("arguments not implemented\n");
381                 return E_NOTIMPL;
382             }
383
384             put_val = get_propput_arg(pdp);
385             if(!put_val) {
386                 WARN("no value to set\n");
387                 return DISP_E_PARAMNOTOPTIONAL;
388             }
389
390             dp.rgvarg = put_val;
391             func = This->desc->funcs[id].entries[V_VT(put_val) == VT_DISPATCH ? VBDISP_SET : VBDISP_LET];
392             if(!func) {
393                 FIXME("no letter/setter\n");
394                 return DISP_E_MEMBERNOTFOUND;
395             }
396
397             return exec_script(This->desc->ctx, func, (IDispatch*)&This->IDispatchEx_iface, &dp, NULL);
398         }
399         default:
400             FIXME("flags %x\n", wFlags);
401             return DISP_E_MEMBERNOTFOUND;
402         }
403     }
404
405     if(id < This->desc->prop_cnt + This->desc->func_cnt)
406         return invoke_variant_prop(This, This->props+(id-This->desc->func_cnt), wFlags, pdp, pvarRes);
407
408     if(This->desc->builtin_prop_cnt) {
409         unsigned min = 0, max = This->desc->builtin_prop_cnt-1, i;
410
411         while(min <= max) {
412             i = (min+max)/2;
413             if(This->desc->builtin_props[i].id == id)
414                 return invoke_builtin(This, This->desc->builtin_props+i, wFlags, pdp, pvarRes);
415             if(This->desc->builtin_props[i].id < id)
416                 min = i+1;
417             else
418                 max = i-1;
419         }
420     }
421
422     return DISP_E_MEMBERNOTFOUND;
423 }
424
425 static HRESULT WINAPI DispatchEx_DeleteMemberByName(IDispatchEx *iface, BSTR bstrName, DWORD grfdex)
426 {
427     vbdisp_t *This = impl_from_IDispatchEx(iface);
428     FIXME("(%p)->(%s %x)\n", This, debugstr_w(bstrName), grfdex);
429     return E_NOTIMPL;
430 }
431
432 static HRESULT WINAPI DispatchEx_DeleteMemberByDispID(IDispatchEx *iface, DISPID id)
433 {
434     vbdisp_t *This = impl_from_IDispatchEx(iface);
435     FIXME("(%p)->(%x)\n", This, id);
436     return E_NOTIMPL;
437 }
438
439 static HRESULT WINAPI DispatchEx_GetMemberProperties(IDispatchEx *iface, DISPID id, DWORD grfdexFetch, DWORD *pgrfdex)
440 {
441     vbdisp_t *This = impl_from_IDispatchEx(iface);
442     FIXME("(%p)->(%x %x %p)\n", This, id, grfdexFetch, pgrfdex);
443     return E_NOTIMPL;
444 }
445
446 static HRESULT WINAPI DispatchEx_GetMemberName(IDispatchEx *iface, DISPID id, BSTR *pbstrName)
447 {
448     vbdisp_t *This = impl_from_IDispatchEx(iface);
449     FIXME("(%p)->(%x %p)\n", This, id, pbstrName);
450     return E_NOTIMPL;
451 }
452
453 static HRESULT WINAPI DispatchEx_GetNextDispID(IDispatchEx *iface, DWORD grfdex, DISPID id, DISPID *pid)
454 {
455     vbdisp_t *This = impl_from_IDispatchEx(iface);
456     FIXME("(%p)->(%x %x %p)\n", This, grfdex, id, pid);
457     return E_NOTIMPL;
458 }
459
460 static HRESULT WINAPI DispatchEx_GetNameSpaceParent(IDispatchEx *iface, IUnknown **ppunk)
461 {
462     vbdisp_t *This = impl_from_IDispatchEx(iface);
463     FIXME("(%p)->(%p)\n", This, ppunk);
464     return E_NOTIMPL;
465 }
466
467 static IDispatchExVtbl DispatchExVtbl = {
468     DispatchEx_QueryInterface,
469     DispatchEx_AddRef,
470     DispatchEx_Release,
471     DispatchEx_GetTypeInfoCount,
472     DispatchEx_GetTypeInfo,
473     DispatchEx_GetIDsOfNames,
474     DispatchEx_Invoke,
475     DispatchEx_GetDispID,
476     DispatchEx_InvokeEx,
477     DispatchEx_DeleteMemberByName,
478     DispatchEx_DeleteMemberByDispID,
479     DispatchEx_GetMemberProperties,
480     DispatchEx_GetMemberName,
481     DispatchEx_GetNextDispID,
482     DispatchEx_GetNameSpaceParent
483 };
484
485 static inline vbdisp_t *unsafe_impl_from_IDispatch(IDispatch *iface)
486 {
487     return iface->lpVtbl == (IDispatchVtbl*)&DispatchExVtbl
488         ? CONTAINING_RECORD(iface, vbdisp_t, IDispatchEx_iface)
489         : NULL;
490 }
491
492 HRESULT create_vbdisp(const class_desc_t *desc, vbdisp_t **ret)
493 {
494     vbdisp_t *vbdisp;
495
496     vbdisp = heap_alloc_zero( FIELD_OFFSET( vbdisp_t, props[desc->prop_cnt] ));
497     if(!vbdisp)
498         return E_OUTOFMEMORY;
499
500     vbdisp->IDispatchEx_iface.lpVtbl = &DispatchExVtbl;
501     vbdisp->ref = 1;
502     vbdisp->desc = desc;
503
504     if(desc->class_initialize_id) {
505         DISPPARAMS dp = {0};
506         HRESULT hres;
507
508         hres = exec_script(desc->ctx, desc->funcs[desc->class_initialize_id].entries[VBDISP_CALLGET],
509                            (IDispatch*)&vbdisp->IDispatchEx_iface, &dp, NULL);
510         if(FAILED(hres)) {
511             IDispatchEx_Release(&vbdisp->IDispatchEx_iface);
512             return hres;
513         }
514     }
515
516     list_add_tail(&desc->ctx->objects, &vbdisp->entry);
517     *ret = vbdisp;
518     return S_OK;
519 }
520
521 void collect_objects(script_ctx_t *ctx)
522 {
523     vbdisp_t *iter, *iter2;
524
525     LIST_FOR_EACH_ENTRY_SAFE(iter, iter2, &ctx->objects, vbdisp_t, entry)
526         run_terminator(iter);
527
528     while(!list_empty(&ctx->objects)) {
529         iter = LIST_ENTRY(list_head(&ctx->objects), vbdisp_t, entry);
530
531         IDispatchEx_AddRef(&iter->IDispatchEx_iface);
532         clean_props(iter);
533         iter->desc = NULL;
534         list_remove(&iter->entry);
535         list_init(&iter->entry);
536         IDispatchEx_Release(&iter->IDispatchEx_iface);
537     }
538 }
539
540 HRESULT disp_get_id(IDispatch *disp, BSTR name, vbdisp_invoke_type_t invoke_type, BOOL search_private, DISPID *id)
541 {
542     IDispatchEx *dispex;
543     vbdisp_t *vbdisp;
544     HRESULT hres;
545
546     vbdisp = unsafe_impl_from_IDispatch(disp);
547     if(vbdisp)
548         return vbdisp_get_id(vbdisp, name, invoke_type, search_private, id);
549
550     hres = IDispatch_QueryInterface(disp, &IID_IDispatchEx, (void**)&dispex);
551     if(FAILED(hres)) {
552         TRACE("using IDispatch\n");
553         return IDispatch_GetIDsOfNames(disp, &IID_NULL, &name, 1, 0, id);
554     }
555
556     hres = IDispatchEx_GetDispID(dispex, name, fdexNameCaseInsensitive, id);
557     IDispatchEx_Release(dispex);
558     return hres;
559 }
560
561 HRESULT disp_call(script_ctx_t *ctx, IDispatch *disp, DISPID id, DISPPARAMS *dp, VARIANT *retv)
562 {
563     const WORD flags = DISPATCH_METHOD|(retv ? DISPATCH_PROPERTYGET : 0);
564     IDispatchEx *dispex;
565     EXCEPINFO ei;
566     HRESULT hres;
567
568     memset(&ei, 0, sizeof(ei));
569     if(retv)
570         V_VT(retv) = VT_EMPTY;
571
572     hres = IDispatch_QueryInterface(disp, &IID_IDispatchEx, (void**)&dispex);
573     if(FAILED(hres)) {
574         UINT err = 0;
575
576         TRACE("using IDispatch\n");
577         return IDispatch_Invoke(disp, id, &IID_NULL, ctx->lcid, flags, dp, retv, &ei, &err);
578     }
579
580     hres = IDispatchEx_InvokeEx(dispex, id, ctx->lcid, flags, dp, retv, &ei, NULL /* CALLER_FIXME */);
581     IDispatchEx_Release(dispex);
582     return hres;
583 }
584
585 HRESULT disp_propput(script_ctx_t *ctx, IDispatch *disp, DISPID id, DISPPARAMS *dp)
586 {
587     IDispatchEx *dispex;
588     EXCEPINFO ei = {0};
589     HRESULT hres;
590
591     hres = IDispatch_QueryInterface(disp, &IID_IDispatchEx, (void**)&dispex);
592     if(SUCCEEDED(hres)) {
593         hres = IDispatchEx_InvokeEx(dispex, id, ctx->lcid, DISPATCH_PROPERTYPUT, dp, NULL, &ei, NULL /* FIXME! */);
594         IDispatchEx_Release(dispex);
595     }else {
596         ULONG err = 0;
597
598         TRACE("using IDispatch\n");
599         hres = IDispatch_Invoke(disp, id, &IID_NULL, ctx->lcid, DISPATCH_PROPERTYPUT, dp, NULL, &ei, &err);
600     }
601
602     return hres;
603 }