2 * Implementation of the Microsoft Installer (msi.dll)
4 * Copyright 2005 Aric Stewart for CodeWeavers
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/controlevent_overview.asp
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(msi
);
41 typedef UINT (*EVENTHANDLER
)(MSIPACKAGE
*,LPCWSTR
,msi_dialog
*);
55 UINT
ControlEvent_HandleControlEvent(MSIPACKAGE
*, LPCWSTR
, LPCWSTR
, msi_dialog
*);
58 * Create a dialog box and run it if it's modal
60 static UINT
event_do_dialog( MSIPACKAGE
*package
, LPCWSTR name
, BOOL destroy_modeless
)
65 /* create a new dialog */
66 dialog
= msi_dialog_create( package
, name
,
67 ControlEvent_HandleControlEvent
);
70 /* kill the current modeless dialog */
71 if( destroy_modeless
&& package
->dialog
)
73 msi_dialog_destroy( package
->dialog
);
74 package
->dialog
= NULL
;
77 /* modeless dialogs return an error message */
78 r
= msi_dialog_run_message_loop( dialog
);
79 if( r
== ERROR_SUCCESS
)
80 msi_dialog_destroy( dialog
);
82 package
->dialog
= dialog
;
85 r
= ERROR_FUNCTION_FAILED
;
92 * End a modal dialog box
94 static UINT
ControlEvent_EndDialog(MSIPACKAGE
* package
, LPCWSTR argument
,
97 static const WCHAR szExit
[] = {
99 static const WCHAR szRetry
[] = {
100 'R','e','t','r','y',0};
101 static const WCHAR szIgnore
[] = {
102 'I','g','n','o','r','e',0};
103 static const WCHAR szReturn
[] = {
104 'R','e','t','u','r','n',0};
106 if (lstrcmpW(argument
,szExit
)==0)
107 package
->CurrentInstallState
= ERROR_INSTALL_USEREXIT
;
108 else if (lstrcmpW(argument
, szRetry
) == 0)
109 package
->CurrentInstallState
= ERROR_INSTALL_SUSPEND
;
110 else if (lstrcmpW(argument
, szIgnore
) == 0)
111 package
->CurrentInstallState
= -1;
112 else if (lstrcmpW(argument
, szReturn
) == 0)
113 package
->CurrentInstallState
= ERROR_SUCCESS
;
116 ERR("Unknown argument string %s\n",debugstr_w(argument
));
117 package
->CurrentInstallState
= ERROR_FUNCTION_FAILED
;
120 ControlEvent_CleanupSubscriptions(package
);
121 msi_dialog_end_dialog( dialog
);
122 return ERROR_SUCCESS
;
126 * transition from one modal dialog to another modal dialog
128 static UINT
ControlEvent_NewDialog(MSIPACKAGE
* package
, LPCWSTR argument
,
131 /* store the name of the next dialog, and signal this one to end */
132 package
->next_dialog
= strdupW(argument
);
133 ControlEvent_CleanupSubscriptions(package
);
134 msi_dialog_end_dialog( dialog
);
135 return ERROR_SUCCESS
;
139 * Create a new child dialog of an existing modal dialog
141 static UINT
ControlEvent_SpawnDialog(MSIPACKAGE
* package
, LPCWSTR argument
,
144 /* don't destroy a modeless dialogs that might be our parent */
145 event_do_dialog( package
, argument
, FALSE
);
146 if( package
->CurrentInstallState
!= ERROR_SUCCESS
)
147 msi_dialog_end_dialog( dialog
);
148 return ERROR_SUCCESS
;
152 * Creates a dialog that remains up for a period of time
153 * based on a condition
155 static UINT
ControlEvent_SpawnWaitDialog(MSIPACKAGE
* package
, LPCWSTR argument
,
158 FIXME("Doing Nothing\n");
159 return ERROR_SUCCESS
;
162 static UINT
ControlEvent_DoAction(MSIPACKAGE
* package
, LPCWSTR argument
,
165 ACTION_PerformAction(package
,argument
,TRUE
);
166 return ERROR_SUCCESS
;
169 static UINT
ControlEvent_AddLocal(MSIPACKAGE
* package
, LPCWSTR argument
,
172 static const WCHAR szAll
[] = {'A','L','L',0};
173 MSIFEATURE
*feature
= NULL
;
175 if (lstrcmpW(szAll
,argument
))
177 MSI_SetFeatureStateW(package
,argument
,INSTALLSTATE_LOCAL
);
181 LIST_FOR_EACH_ENTRY( feature
, &package
->features
, MSIFEATURE
, entry
)
183 feature
->ActionRequest
= INSTALLSTATE_LOCAL
;
184 feature
->Action
= INSTALLSTATE_LOCAL
;
186 ACTION_UpdateComponentStates(package
,argument
);
188 return ERROR_SUCCESS
;
191 static UINT
ControlEvent_Remove(MSIPACKAGE
* package
, LPCWSTR argument
,
194 static const WCHAR szAll
[] = {'A','L','L',0};
195 MSIFEATURE
*feature
= NULL
;
197 if (lstrcmpW(szAll
,argument
))
199 MSI_SetFeatureStateW(package
,argument
,INSTALLSTATE_ABSENT
);
203 LIST_FOR_EACH_ENTRY( feature
, &package
->features
, MSIFEATURE
, entry
)
205 feature
->ActionRequest
= INSTALLSTATE_ABSENT
;
206 feature
->Action
= INSTALLSTATE_ABSENT
;
208 ACTION_UpdateComponentStates(package
,argument
);
210 return ERROR_SUCCESS
;
213 static UINT
ControlEvent_AddSource(MSIPACKAGE
* package
, LPCWSTR argument
,
216 static const WCHAR szAll
[] = {'A','L','L',0};
217 MSIFEATURE
*feature
= NULL
;
219 if (lstrcmpW(szAll
,argument
))
221 MSI_SetFeatureStateW(package
,argument
,INSTALLSTATE_SOURCE
);
225 LIST_FOR_EACH_ENTRY( feature
, &package
->features
, MSIFEATURE
, entry
)
227 feature
->ActionRequest
= INSTALLSTATE_SOURCE
;
228 feature
->Action
= INSTALLSTATE_SOURCE
;
230 ACTION_UpdateComponentStates(package
,argument
);
232 return ERROR_SUCCESS
;
235 static UINT
ControlEvent_SetTargetPath(MSIPACKAGE
* package
, LPCWSTR argument
,
238 LPWSTR path
= load_dynamic_property(package
,argument
, NULL
);
239 /* failure to set the path halts the executing of control events */
240 return MSI_SetTargetPathW(package
, argument
, path
);
246 static void free_subscriber( struct subscriber
*sub
)
248 HeapFree(GetProcessHeap(),0,sub
->event
);
249 HeapFree(GetProcessHeap(),0,sub
->control
);
250 HeapFree(GetProcessHeap(),0,sub
->attribute
);
251 HeapFree(GetProcessHeap(),0,sub
);
254 VOID
ControlEvent_SubscribeToEvent( MSIPACKAGE
*package
, LPCWSTR event
,
255 LPCWSTR control
, LPCWSTR attribute
)
257 struct subscriber
*sub
;
259 sub
= HeapAlloc(GetProcessHeap(),0,sizeof (*sub
));
262 sub
->event
= strdupW(event
);
263 sub
->control
= strdupW(control
);
264 sub
->attribute
= strdupW(attribute
);
265 list_add_tail( &package
->subscriptions
, &sub
->entry
);
268 VOID
ControlEvent_UnSubscribeToEvent( MSIPACKAGE
*package
, LPCWSTR event
,
269 LPCWSTR control
, LPCWSTR attribute
)
272 struct subscriber
*sub
;
274 LIST_FOR_EACH_SAFE( i
, t
, &package
->subscriptions
)
276 sub
= LIST_ENTRY( i
, struct subscriber
, entry
);
278 if( lstrcmpiW(sub
->control
,control
) )
280 if( lstrcmpiW(sub
->attribute
,attribute
) )
282 if( lstrcmpiW(sub
->event
,event
) )
284 list_remove( &sub
->entry
);
285 free_subscriber( sub
);
289 VOID
ControlEvent_FireSubscribedEvent( MSIPACKAGE
*package
, LPCWSTR event
,
292 struct subscriber
*sub
;
294 TRACE("Firing Event %s\n",debugstr_w(event
));
296 if (!package
->dialog
)
299 LIST_FOR_EACH_ENTRY( sub
, &package
->subscriptions
, struct subscriber
, entry
)
301 if (lstrcmpiW(sub
->event
, event
))
303 msi_dialog_handle_event( package
->dialog
, sub
->control
,
304 sub
->attribute
, rec
);
308 VOID
ControlEvent_CleanupSubscriptions(MSIPACKAGE
*package
)
311 struct subscriber
*sub
;
313 LIST_FOR_EACH_SAFE( i
, t
, &package
->subscriptions
)
315 sub
= LIST_ENTRY( i
, struct subscriber
, entry
);
317 list_remove( &sub
->entry
);
318 free_subscriber( sub
);
325 * Return ERROR_SUCCESS if dialog is process and ERROR_FUNCTION_FAILED
326 * if the given parameter is not a dialog box
328 UINT
ACTION_DialogBox( MSIPACKAGE
* package
, LPCWSTR szDialogName
)
330 UINT r
= ERROR_SUCCESS
;
332 if( package
->next_dialog
)
333 ERR("Already a next dialog... ignoring it\n");
334 package
->next_dialog
= NULL
;
337 * Dialogs are chained by filling in the next_dialog member
338 * of the package structure, then terminating the current dialog.
339 * The code below sees the next_dialog member set, and runs the
341 * We fall out of the loop below if we come across a modeless
342 * dialog, as it returns ERROR_IO_PENDING when we try to run
345 r
= event_do_dialog( package
, szDialogName
, TRUE
);
346 while( r
== ERROR_SUCCESS
&& package
->next_dialog
)
348 LPWSTR name
= package
->next_dialog
;
350 package
->next_dialog
= NULL
;
351 r
= event_do_dialog( package
, name
, TRUE
);
352 HeapFree( GetProcessHeap(), 0, name
);
355 if( r
== ERROR_IO_PENDING
)
361 struct _events Events
[] = {
362 { "EndDialog",ControlEvent_EndDialog
},
363 { "NewDialog",ControlEvent_NewDialog
},
364 { "SpawnDialog",ControlEvent_SpawnDialog
},
365 { "SpawnWaitDialog",ControlEvent_SpawnWaitDialog
},
366 { "DoAction",ControlEvent_DoAction
},
367 { "AddLocal",ControlEvent_AddLocal
},
368 { "Remove",ControlEvent_Remove
},
369 { "AddSource",ControlEvent_AddSource
},
370 { "SetTargetPath",ControlEvent_SetTargetPath
},
374 UINT
ControlEvent_HandleControlEvent(MSIPACKAGE
*package
, LPCWSTR event
,
375 LPCWSTR argument
, msi_dialog
* dialog
)
378 UINT rc
= ERROR_SUCCESS
;
380 TRACE("Handling Control Event %s\n",debugstr_w(event
));
384 while( Events
[i
].event
!= NULL
)
386 LPWSTR wevent
= strdupAtoW(Events
[i
].event
);
387 if (lstrcmpW(wevent
,event
)==0)
389 HeapFree(GetProcessHeap(),0,wevent
);
390 rc
= Events
[i
].handler(package
,argument
,dialog
);
393 HeapFree(GetProcessHeap(),0,wevent
);
396 FIXME("unhandled control event %s arg(%s)\n",
397 debugstr_w(event
), debugstr_w(argument
));