riched20: Fix test crash on WinXP-SP2.
[wine] / dlls / msi / script.c
1 /*
2  * Implementation of scripting for Microsoft Installer (msi.dll)
3  *
4  * Copyright 2007 Misha Koshelev
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #define COBJMACROS
22
23 #include <stdarg.h>
24 #include "windef.h"
25 #include "winbase.h"
26 #include "winerror.h"
27 #include "winuser.h"
28 #include "msidefs.h"
29 #include "msipriv.h"
30 #include "activscp.h"
31 #include "oleauto.h"
32 #include "wine/debug.h"
33 #include "wine/unicode.h"
34
35 #include "msiserver.h"
36
37 WINE_DEFAULT_DEBUG_CHANNEL(msi);
38
39 static const WCHAR szJScript[] = { 'J','S','c','r','i','p','t',0};
40 static const WCHAR szVBScript[] = { 'V','B','S','c','r','i','p','t',0};
41 static const WCHAR szSession[] = {'S','e','s','s','i','o','n',0};
42
43 /*
44  * MsiActiveScriptSite - Our IActiveScriptSite implementation.
45  */
46
47 typedef struct {
48     IActiveScriptSite lpVtbl;
49     IDispatch *pInstaller;
50     IDispatch *pSession;
51     LONG ref;
52 } MsiActiveScriptSite;
53
54 static const struct IActiveScriptSiteVtbl ASS_Vtbl;
55
56 static HRESULT create_ActiveScriptSite(IUnknown *pUnkOuter, LPVOID *ppObj)
57 {
58     MsiActiveScriptSite* object;
59
60     TRACE("(%p,%p)\n", pUnkOuter, ppObj);
61
62     if( pUnkOuter )
63         return CLASS_E_NOAGGREGATION;
64
65     object = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(MsiActiveScriptSite));
66
67     object->lpVtbl.lpVtbl = &ASS_Vtbl;
68     object->ref = 1;
69     object->pInstaller = NULL;
70     object->pSession = NULL;
71
72     *ppObj = object;
73
74     return S_OK;
75 }
76
77 /*
78  * Call a script.
79  */
80 DWORD call_script(MSIHANDLE hPackage, INT type, LPCWSTR script, LPCWSTR function, LPCWSTR action)
81 {
82     HRESULT hr;
83     IActiveScript *pActiveScript = NULL;
84     IActiveScriptParse *pActiveScriptParse = NULL;
85     MsiActiveScriptSite *pActiveScriptSite = NULL;
86     IDispatch *pDispatch = NULL;
87     DISPPARAMS dispparamsNoArgs = {NULL, NULL, 0, 0};
88     DISPID dispid;
89     CLSID clsid;
90     VARIANT var;
91
92     /* Return success by default (if Windows Script not installed) - not native behavior. This
93      * should be here until we implement wine scripting. */
94     DWORD ret = ERROR_SUCCESS;
95
96     CoInitialize(NULL);
97
98     /* Create MsiActiveScriptSite object */
99     hr = create_ActiveScriptSite(NULL, (void **)&pActiveScriptSite);
100     if (hr != S_OK) goto done;
101
102     /* Create an installer object */
103     hr = create_msiserver(NULL, (LPVOID *)&pActiveScriptSite->pInstaller);
104     if (hr != S_OK) goto done;
105     IUnknown_AddRef((IUnknown *)pActiveScriptSite->pInstaller);
106
107     /* Create a session object */
108     hr = create_session(hPackage, pActiveScriptSite->pInstaller, &pActiveScriptSite->pSession);
109     if (hr != S_OK) goto done;
110     IUnknown_AddRef((IUnknown *)pActiveScriptSite->pSession);
111
112     /* Create the scripting engine */
113     if ((type & 7) == msidbCustomActionTypeJScript)
114         hr = CLSIDFromProgID(szJScript, &clsid);
115     else if ((type & 7) == msidbCustomActionTypeVBScript)
116         hr = CLSIDFromProgID(szVBScript, &clsid);
117     else {
118         ERR("Unknown script type %d\n", type);
119         goto done;
120     }
121     if (FAILED(hr)) {
122         ERR("Could not find CLSID for Windows Script\n");
123         goto done;
124     }
125     hr = CoCreateInstance(&clsid, NULL, CLSCTX_INPROC_SERVER, &IID_IActiveScript, (void **)&pActiveScript);
126     if (FAILED(hr)) {
127         ERR("Could not instantiate class for Windows Script\n");
128         goto done;
129     }
130
131     /* If we got this far, Windows Script is installed, so don't return success by default anymore */
132     ret = ERROR_INSTALL_FAILURE;
133
134     /* Get the IActiveScriptParse engine interface */
135     hr = IActiveScript_QueryInterface(pActiveScript, &IID_IActiveScriptParse, (void **)&pActiveScriptParse);
136     if (FAILED(hr)) goto done;
137
138     /* Give our host to the engine */
139     hr = IActiveScript_SetScriptSite(pActiveScript, (IActiveScriptSite *)pActiveScriptSite);
140     if (FAILED(hr)) goto done;
141
142     /* Initialize the script engine */
143     hr = IActiveScriptParse_InitNew(pActiveScriptParse);
144     if (FAILED(hr)) goto done;
145
146     /* Add the session object */
147     hr = IActiveScript_AddNamedItem(pActiveScript, szSession, SCRIPTITEM_ISVISIBLE);
148
149     /* Pass the script to the engine */
150     hr = IActiveScriptParse_ParseScriptText(pActiveScriptParse, script, NULL, NULL, NULL, 0, 0, 0L, NULL, NULL);
151     if (FAILED(hr)) goto done;
152
153     /* Start processing the script */
154     hr = IActiveScript_SetScriptState(pActiveScript, SCRIPTSTATE_CONNECTED);
155     if (FAILED(hr)) goto done;
156
157     /* Call a function if necessary through the IDispatch interface */
158     if (function != NULL && strlenW(function) > 0) {
159         TRACE("Calling function %s\n", debugstr_w(function));
160
161         hr = IActiveScript_GetScriptDispatch(pActiveScript, NULL, &pDispatch);
162         if (FAILED(hr)) goto done;
163
164         hr = IDispatch_GetIDsOfNames(pDispatch, &IID_NULL, (WCHAR **)&function, 1,LOCALE_USER_DEFAULT, &dispid);
165         if (FAILED(hr)) goto done;
166
167         hr = IDispatch_Invoke(pDispatch, dispid, &IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_METHOD, &dispparamsNoArgs, &var, NULL, NULL);
168         if (FAILED(hr)) goto done;
169
170         /* Check return value, if it's not IDOK we failed */
171         hr = VariantChangeType(&var, &var, 0, VT_I4);
172         if (FAILED(hr)) goto done;
173
174         if (V_I4(&var) == IDOK)
175             ret = ERROR_SUCCESS;
176         else ret = ERROR_INSTALL_FAILURE;
177
178         VariantClear(&var);
179     } else {
180         /* If no function to be called, MSI behavior is to succeed */
181         ret = ERROR_SUCCESS;
182     }
183
184 done:
185
186     /* Free everything that needs to be freed */
187     if (pDispatch) IDispatch_Release(pDispatch);
188     if (pActiveScript) IActiveScriptSite_Release(pActiveScript);
189     if (pActiveScriptSite &&
190         pActiveScriptSite->pSession) IUnknown_Release((IUnknown *)pActiveScriptSite->pSession);
191     if (pActiveScriptSite &&
192         pActiveScriptSite->pInstaller) IUnknown_Release((IUnknown *)pActiveScriptSite->pInstaller);
193     if (pActiveScriptSite) IUnknown_Release((IUnknown *)pActiveScriptSite);
194
195     CoUninitialize();    /* must call even if CoInitialize failed */
196
197     return ret;
198 }
199
200 /*
201  * MsiActiveScriptSite
202  */
203
204 /*** IUnknown methods ***/
205 static HRESULT WINAPI MsiActiveScriptSite_QueryInterface(IActiveScriptSite* iface, REFIID riid, void** ppvObject)
206 {
207     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
208
209     TRACE("(%p/%p)->(%s,%p)\n", iface, This, debugstr_guid(riid), ppvObject);
210
211     if (IsEqualGUID(riid, &IID_IUnknown) ||
212         IsEqualGUID(riid, &IID_IActiveScriptSite))
213     {
214         IClassFactory_AddRef(iface);
215         *ppvObject = This;
216         return S_OK;
217     }
218
219     TRACE("(%p)->(%s,%p),not found\n",This,debugstr_guid(riid),ppvObject);
220
221     return E_NOINTERFACE;
222 }
223
224 static ULONG WINAPI MsiActiveScriptSite_AddRef(IActiveScriptSite* iface)
225 {
226     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
227
228     TRACE("(%p/%p)\n", iface, This);
229
230     return InterlockedIncrement(&This->ref);
231 }
232
233 static ULONG WINAPI MsiActiveScriptSite_Release(IActiveScriptSite* iface)
234 {
235     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
236     ULONG ref = InterlockedDecrement(&This->ref);
237
238     TRACE("(%p/%p)\n", iface, This);
239
240     if (!ref)
241         HeapFree(GetProcessHeap(), 0, This);
242
243     return ref;
244 }
245
246 /*** IActiveScriptSite methods **/
247 static HRESULT WINAPI MsiActiveScriptSite_GetLCID(IActiveScriptSite* iface, LCID* plcid)
248 {
249     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
250     TRACE("(%p/%p)->(%p)\n", This, iface, plcid);
251     return E_NOTIMPL;  /* Script will use system-defined locale */
252 }
253
254 static HRESULT WINAPI MsiActiveScriptSite_GetItemInfo(IActiveScriptSite* iface, LPCOLESTR pstrName, DWORD dwReturnMask, IUnknown** ppiunkItem, ITypeInfo** ppti)
255 {
256     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
257     TRACE("(%p/%p)->(%p,%d,%p,%p)\n", This, iface, pstrName, dwReturnMask, ppiunkItem, ppti);
258
259     /* Determine the kind of pointer that is requested, and make sure placeholder is valid */
260     if (dwReturnMask & SCRIPTINFO_ITYPEINFO) {
261         if (!ppti) return E_INVALIDARG;
262         *ppti = NULL;
263     }
264     if (dwReturnMask & SCRIPTINFO_IUNKNOWN) {
265         if (!ppiunkItem) return E_INVALIDARG;
266         *ppiunkItem = NULL;
267     }
268
269     /* Are we looking for the session object? */
270     if (!strcmpW(szSession, pstrName)) {
271         if (dwReturnMask & SCRIPTINFO_ITYPEINFO)
272             return load_type_info(This->pSession, ppti, &DIID_Session, 0);
273         else if (dwReturnMask & SCRIPTINFO_IUNKNOWN) {
274             IDispatch_QueryInterface(This->pSession, &IID_IUnknown, (void **)ppiunkItem);
275             return S_OK;
276         }
277     }
278
279     return TYPE_E_ELEMENTNOTFOUND;
280 }
281
282 static HRESULT WINAPI MsiActiveScriptSite_GetDocVersionString(IActiveScriptSite* iface, BSTR* pbstrVersion)
283 {
284     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
285     TRACE("(%p/%p)->(%p)\n", This, iface, pbstrVersion);
286     return E_NOTIMPL;
287 }
288
289 static HRESULT WINAPI MsiActiveScriptSite_OnScriptTerminate(IActiveScriptSite* iface, const VARIANT* pvarResult, const EXCEPINFO* pexcepinfo)
290 {
291     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
292     TRACE("(%p/%p)->(%p,%p)\n", This, iface, pvarResult, pexcepinfo);
293     return S_OK;
294 }
295
296 static HRESULT WINAPI MsiActiveScriptSite_OnStateChange(IActiveScriptSite* iface, SCRIPTSTATE ssScriptState)
297 {
298     switch (ssScriptState) {
299         case SCRIPTSTATE_UNINITIALIZED:
300               TRACE("State: Uninitialized.\n");
301               break;
302
303         case SCRIPTSTATE_INITIALIZED:
304               TRACE("State: Initialized.\n");
305               break;
306
307         case SCRIPTSTATE_STARTED:
308               TRACE("State: Started.\n");
309               break;
310
311         case SCRIPTSTATE_CONNECTED:
312               TRACE("State: Connected.\n");
313               break;
314
315         case SCRIPTSTATE_DISCONNECTED:
316               TRACE("State: Disconnected.\n");
317               break;
318
319         case SCRIPTSTATE_CLOSED:
320               TRACE("State: Closed.\n");
321               break;
322
323         default:
324               ERR("Unknown State: %d\n", ssScriptState);
325               break;
326     }
327
328     return S_OK;
329 }
330
331 static HRESULT WINAPI MsiActiveScriptSite_OnScriptError(IActiveScriptSite* iface, IActiveScriptError* pscripterror)
332 {
333     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
334     EXCEPINFO exception;
335     HRESULT hr;
336
337     TRACE("(%p/%p)->(%p)\n", This, iface, pscripterror);
338
339     memset(&exception, 0, sizeof(EXCEPINFO));
340     hr = IActiveScriptError_GetExceptionInfo(pscripterror, &exception);
341     if (SUCCEEDED(hr))
342     {
343         ERR("script error: %s\n", debugstr_w(exception.bstrDescription));
344         SysFreeString(exception.bstrSource);
345         SysFreeString(exception.bstrDescription);
346         SysFreeString(exception.bstrHelpFile);
347     }
348
349     return S_OK;
350 }
351
352 static HRESULT WINAPI MsiActiveScriptSite_OnEnterScript(IActiveScriptSite* iface)
353 {
354     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
355     TRACE("(%p/%p)\n", This, iface);
356     return S_OK;
357 }
358
359 static HRESULT WINAPI MsiActiveScriptSite_OnLeaveScript(IActiveScriptSite* iface)
360 {
361     MsiActiveScriptSite *This = (MsiActiveScriptSite *)iface;
362     TRACE("(%p/%p)\n", This, iface);
363     return S_OK;
364 }
365
366 static const struct IActiveScriptSiteVtbl ASS_Vtbl =
367 {
368     MsiActiveScriptSite_QueryInterface,
369     MsiActiveScriptSite_AddRef,
370     MsiActiveScriptSite_Release,
371     MsiActiveScriptSite_GetLCID,
372     MsiActiveScriptSite_GetItemInfo,
373     MsiActiveScriptSite_GetDocVersionString,
374     MsiActiveScriptSite_OnScriptTerminate,
375     MsiActiveScriptSite_OnStateChange,
376     MsiActiveScriptSite_OnScriptError,
377     MsiActiveScriptSite_OnEnterScript,
378     MsiActiveScriptSite_OnLeaveScript
379 };