2 * Custom Action processing for 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp
36 #include "wine/debug.h"
41 #include "msvcrt/fcntl.h"
48 #include "wine/unicode.h"
52 WINE_DEFAULT_DEBUG_CHANNEL(msi
);
54 #define CUSTOM_ACTION_TYPE_MASK 0x3F
55 static const WCHAR c_collen
[] = {'C',':','\\',0};
56 static const WCHAR cszTempFolder
[]= {'T','e','m','p','F','o','l','d','e','r',0};
58 typedef struct tagMSIRUNNINGACTION
66 static UINT
HANDLE_CustomType1(MSIPACKAGE
*package
, LPCWSTR source
,
67 LPCWSTR target
, const INT type
, LPCWSTR action
);
68 static UINT
HANDLE_CustomType2(MSIPACKAGE
*package
, LPCWSTR source
,
69 LPCWSTR target
, const INT type
, LPCWSTR action
);
70 static UINT
HANDLE_CustomType17(MSIPACKAGE
*package
, LPCWSTR source
,
71 LPCWSTR target
, const INT type
, LPCWSTR action
);
72 static UINT
HANDLE_CustomType18(MSIPACKAGE
*package
, LPCWSTR source
,
73 LPCWSTR target
, const INT type
, LPCWSTR action
);
74 static UINT
HANDLE_CustomType19(MSIPACKAGE
*package
, LPCWSTR source
,
75 LPCWSTR target
, const INT type
, LPCWSTR action
);
76 static UINT
HANDLE_CustomType50(MSIPACKAGE
*package
, LPCWSTR source
,
77 LPCWSTR target
, const INT type
, LPCWSTR action
);
78 static UINT
HANDLE_CustomType34(MSIPACKAGE
*package
, LPCWSTR source
,
79 LPCWSTR target
, const INT type
, LPCWSTR action
);
82 static BOOL
check_execution_scheduling_options(MSIPACKAGE
*package
, LPCWSTR action
, UINT options
)
87 if ((options
& msidbCustomActionTypeClientRepeat
) ==
88 msidbCustomActionTypeClientRepeat
)
90 if (!(package
->script
->InWhatSequence
& SEQUENCE_UI
&&
91 package
->script
->InWhatSequence
& SEQUENCE_EXEC
))
93 TRACE("Skipping action due to dbCustomActionTypeClientRepeat option.\n");
97 else if (options
& msidbCustomActionTypeFirstSequence
)
99 if (package
->script
->InWhatSequence
& SEQUENCE_UI
&&
100 package
->script
->InWhatSequence
& SEQUENCE_EXEC
)
102 TRACE("Skipping action due to msidbCustomActionTypeFirstSequence option.\n");
106 else if (options
& msidbCustomActionTypeOncePerProcess
)
108 if (check_unique_action(package
,action
))
110 TRACE("Skipping action due to msidbCustomActionTypeOncePerProcess option.\n");
114 register_unique_action(package
,action
);
120 /* stores the CustomActionData before the action:
121 * [CustomActionData]Action
123 LPWSTR
msi_get_deferred_action(LPCWSTR action
, LPWSTR actiondata
)
128 static const WCHAR begin
[] = {'[',0};
129 static const WCHAR end
[] = {']',0};
132 return strdupW(action
);
134 len
= lstrlenW(action
) + lstrlenW(actiondata
) + 3;
135 deferred
= msi_alloc(len
* sizeof(WCHAR
));
137 lstrcpyW(deferred
, begin
);
138 lstrcatW(deferred
, actiondata
);
139 lstrcatW(deferred
, end
);
140 lstrcatW(deferred
, action
);
145 UINT
ACTION_CustomAction(MSIPACKAGE
*package
,LPCWSTR action
, BOOL execute
)
147 UINT rc
= ERROR_SUCCESS
;
149 static const WCHAR ExecSeqQuery
[] =
150 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
151 '`','C','u','s','t','o' ,'m','A','c','t','i','o','n','`',
152 ' ','W','H','E','R','E',' ','`','A','c','t','i' ,'o','n','`',' ',
153 '=',' ','\'','%','s','\'',0};
155 LPCWSTR source
, target
;
156 LPWSTR ptr
, deferred_data
= NULL
;
157 LPWSTR action_copy
= strdupW(action
);
158 WCHAR
*deformated
=NULL
;
160 /* deferred action: [CustomActionData]Action */
161 if ((ptr
= strchrW(action_copy
, ']')))
163 deferred_data
= action_copy
+ 1;
168 row
= MSI_QueryGetRecord( package
->db
, ExecSeqQuery
, action
);
170 return ERROR_CALL_NOT_IMPLEMENTED
;
172 type
= MSI_RecordGetInteger(row
,2);
174 source
= MSI_RecordGetString(row
,3);
175 target
= MSI_RecordGetString(row
,4);
177 TRACE("Handling custom action %s (%x %s %s)\n",debugstr_w(action
),type
,
178 debugstr_w(source
), debugstr_w(target
));
180 /* handle some of the deferred actions */
181 if (type
& msidbCustomActionTypeTSAware
)
182 FIXME("msidbCustomActionTypeTSAware not handled\n");
184 if (type
& msidbCustomActionTypeInScript
)
186 if (type
& msidbCustomActionTypeNoImpersonate
)
187 FIXME("msidbCustomActionTypeNoImpersonate not handled\n");
189 if (type
& msidbCustomActionTypeRollback
)
191 FIXME("Rollback only action... rollbacks not supported yet\n");
192 schedule_action(package
, ROLLBACK_SCRIPT
, action
);
198 LPWSTR actiondata
= msi_dup_property(package
, action
);
199 LPWSTR deferred
= msi_get_deferred_action(action
, actiondata
);
201 if (type
& msidbCustomActionTypeCommit
)
203 TRACE("Deferring Commit Action!\n");
204 schedule_action(package
, COMMIT_SCRIPT
, deferred
);
208 TRACE("Deferring Action!\n");
209 schedule_action(package
, INSTALL_SCRIPT
, deferred
);
220 static const WCHAR szActionData
[] = {
221 'C','u','s','t','o','m','A','c','t','i','o','n','D','a','t','a',0};
222 static const WCHAR szBlank
[] = {0};
223 LPWSTR actiondata
= msi_dup_property( package
, action
);
225 MSI_SetPropertyW(package
,szActionData
,deferred_data
);
227 MSI_SetPropertyW(package
,szActionData
,actiondata
);
229 MSI_SetPropertyW(package
,szActionData
,szBlank
);
230 msi_free(actiondata
);
233 else if (!check_execution_scheduling_options(package
,action
,type
))
239 switch (type
& CUSTOM_ACTION_TYPE_MASK
)
241 case 1: /* DLL file stored in a Binary table stream */
242 rc
= HANDLE_CustomType1(package
,source
,target
,type
,action
);
244 case 2: /* EXE file stored in a Binary table strem */
245 rc
= HANDLE_CustomType2(package
,source
,target
,type
,action
);
247 case 18: /*EXE file installed with package */
248 rc
= HANDLE_CustomType18(package
,source
,target
,type
,action
);
250 case 19: /* Error that halts install */
251 rc
= HANDLE_CustomType19(package
,source
,target
,type
,action
);
254 rc
= HANDLE_CustomType17(package
,source
,target
,type
,action
);
256 case 50: /*EXE file specified by a property value */
257 rc
= HANDLE_CustomType50(package
,source
,target
,type
,action
);
259 case 34: /*EXE to be run in specified directory */
260 rc
= HANDLE_CustomType34(package
,source
,target
,type
,action
);
262 case 35: /* Directory set with formatted text. */
263 deformat_string(package
,target
,&deformated
);
264 MSI_SetTargetPathW(package
, source
, deformated
);
265 msi_free(deformated
);
267 case 51: /* Property set with formatted text. */
268 deformat_string(package
,target
,&deformated
);
269 rc
= MSI_SetPropertyW(package
,source
,deformated
);
270 msi_free(deformated
);
273 FIXME("UNHANDLED ACTION TYPE %i (%s %s)\n",
274 type
& CUSTOM_ACTION_TYPE_MASK
, debugstr_w(source
),
279 msi_free(action_copy
);
280 msiobj_release(&row
->hdr
);
285 static UINT
store_binary_to_temp(MSIPACKAGE
*package
, LPCWSTR source
,
289 static const WCHAR f1
[] = {'m','s','i',0};
292 if (MSI_GetPropertyW(package
, cszTempFolder
, fmt
, &sz
) != ERROR_SUCCESS
)
293 GetTempPathW(MAX_PATH
,fmt
);
295 if (GetTempFileNameW(fmt
,f1
,0,tmp_file
) == 0)
297 TRACE("Unable to create file\n");
298 return ERROR_FUNCTION_FAILED
;
302 /* write out the file */
305 static const WCHAR fmt
[] =
306 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
307 '`','B','i' ,'n','a','r','y','`',' ','W','H','E','R','E',
308 ' ','`','N','a','m','e','`',' ','=',' ','\'','%','s','\'',0};
312 the_file
= CreateFileW(tmp_file
, GENERIC_WRITE
, 0, NULL
, CREATE_ALWAYS
,
313 FILE_ATTRIBUTE_NORMAL
, NULL
);
315 if (the_file
== INVALID_HANDLE_VALUE
)
316 return ERROR_FUNCTION_FAILED
;
318 row
= MSI_QueryGetRecord(package
->db
, fmt
, source
);
320 return ERROR_FUNCTION_FAILED
;
326 rc
= MSI_RecordReadStream(row
,2,buffer
,&sz
);
327 if (rc
!= ERROR_SUCCESS
)
329 ERR("Failed to get stream\n");
330 CloseHandle(the_file
);
331 DeleteFileW(tmp_file
);
334 WriteFile(the_file
,buffer
,sz
,&write
,NULL
);
335 } while (sz
== 1024);
337 CloseHandle(the_file
);
339 msiobj_release(&row
->hdr
);
342 return ERROR_SUCCESS
;
345 static void file_running_action(MSIPACKAGE
* package
, HANDLE Handle
,
346 BOOL process
, LPCWSTR name
)
348 MSIRUNNINGACTION
*action
;
350 action
= msi_alloc( sizeof(MSIRUNNINGACTION
) );
352 action
->handle
= Handle
;
353 action
->process
= process
;
354 action
->name
= strdupW(name
);
356 list_add_tail( &package
->RunningActions
, &action
->entry
);
359 static UINT
process_action_return_value(UINT type
, HANDLE ThreadHandle
)
365 GetExitCodeProcess(ThreadHandle
,&rc
);
368 return ERROR_SUCCESS
;
370 return ERROR_FUNCTION_FAILED
;
373 GetExitCodeThread(ThreadHandle
,&rc
);
377 case ERROR_FUNCTION_NOT_CALLED
:
379 case ERROR_INSTALL_USEREXIT
:
380 case ERROR_INSTALL_FAILURE
:
382 case ERROR_NO_MORE_ITEMS
:
383 return ERROR_SUCCESS
;
385 ERR("Invalid Return Code %d\n",rc
);
386 return ERROR_INSTALL_FAILURE
;
390 static UINT
process_handle(MSIPACKAGE
* package
, UINT type
,
391 HANDLE ThreadHandle
, HANDLE ProcessHandle
,
392 LPCWSTR Name
, BOOL
*finished
)
394 UINT rc
= ERROR_SUCCESS
;
396 if (!(type
& msidbCustomActionTypeAsync
))
399 TRACE("Synchronous Execution of action %s\n",debugstr_w(Name
));
401 msi_dialog_check_messages(ProcessHandle
);
403 msi_dialog_check_messages(ThreadHandle
);
405 if (!(type
& msidbCustomActionTypeContinue
))
408 rc
= process_action_return_value(2,ProcessHandle
);
410 rc
= process_action_return_value(1,ThreadHandle
);
413 CloseHandle(ThreadHandle
);
415 CloseHandle(ProcessHandle
);
421 TRACE("Asynchronous Execution of action %s\n",debugstr_w(Name
));
423 if (type
& msidbCustomActionTypeContinue
)
427 file_running_action(package
, ProcessHandle
, TRUE
, Name
);
428 CloseHandle(ThreadHandle
);
431 file_running_action(package
, ThreadHandle
, FALSE
, Name
);
435 CloseHandle(ThreadHandle
);
437 CloseHandle(ProcessHandle
);
447 typedef UINT __stdcall
CustomEntry(MSIHANDLE
);
456 static DWORD WINAPI
ACTION_CallDllFunction(thread_struct
*stuff
)
461 DWORD rc
= ERROR_SUCCESS
;
463 TRACE("calling function (%s, %s)\n", debugstr_w(stuff
->source
),
464 debugstr_w(stuff
->target
));
466 hModule
= LoadLibraryW(stuff
->source
);
469 proc
= strdupWtoA( stuff
->target
);
470 fn
= (CustomEntry
*)GetProcAddress(hModule
,proc
);
474 MSIPACKAGE
*package
= stuff
->package
;
476 TRACE("Calling function %s\n", proc
);
477 hPackage
= alloc_msihandle( &package
->hdr
);
481 MsiCloseHandle( hPackage
);
484 ERR("Handle for object %p not found\n", package
);
487 ERR("failed to resolve functon %s\n", debugstr_a(proc
));
490 FreeLibrary(hModule
);
493 ERR("failed to load dll %s\n", debugstr_w(stuff
->source
));
494 msiobj_release( &stuff
->package
->hdr
);
495 msi_free(stuff
->source
);
496 msi_free(stuff
->target
);
501 static DWORD WINAPI
DllThread(LPVOID info
)
503 thread_struct
*stuff
;
506 TRACE("MSI Thread (%x) started for custom action\n", GetCurrentThreadId());
508 stuff
= (thread_struct
*)info
;
509 rc
= ACTION_CallDllFunction(stuff
);
511 TRACE("MSI Thread (%x) finished (rc %i)\n",GetCurrentThreadId(), rc
);
512 /* clse all handles for this thread */
513 MsiCloseAllHandles();
517 static HANDLE
do_msidbCustomActionTypeDll(MSIPACKAGE
*package
, LPCWSTR dll
, LPCWSTR target
)
521 info
= msi_alloc( sizeof(*info
) );
522 msiobj_addref( &package
->hdr
);
523 info
->package
= package
;
524 info
->target
= strdupW(target
);
525 info
->source
= strdupW(dll
);
527 return CreateThread(NULL
, 0, DllThread
, info
, 0, NULL
);
530 static UINT
HANDLE_CustomType1(MSIPACKAGE
*package
, LPCWSTR source
,
531 LPCWSTR target
, const INT type
, LPCWSTR action
)
533 WCHAR tmp_file
[MAX_PATH
];
534 UINT rc
= ERROR_SUCCESS
;
535 BOOL finished
= FALSE
;
538 store_binary_to_temp(package
, source
, tmp_file
);
540 TRACE("Calling function %s from %s\n",debugstr_w(target
),
541 debugstr_w(tmp_file
));
543 if (!strchrW(tmp_file
,'.'))
545 static const WCHAR dot
[]={'.',0};
546 strcatW(tmp_file
,dot
);
549 ThreadHandle
= do_msidbCustomActionTypeDll( package
, tmp_file
, target
);
551 rc
= process_handle(package
, type
, ThreadHandle
, NULL
, action
, &finished
);
554 track_tempfile(package
, tmp_file
, tmp_file
);
556 DeleteFileW(tmp_file
);
561 static UINT
HANDLE_CustomType2(MSIPACKAGE
*package
, LPCWSTR source
,
562 LPCWSTR target
, const INT type
, LPCWSTR action
)
564 WCHAR tmp_file
[MAX_PATH
];
566 PROCESS_INFORMATION info
;
571 static const WCHAR spc
[] = {' ',0};
572 UINT prc
= ERROR_SUCCESS
;
573 BOOL finished
= FALSE
;
575 memset(&si
,0,sizeof(STARTUPINFOW
));
577 store_binary_to_temp(package
, source
, tmp_file
);
579 deformat_string(package
,target
,&deformated
);
581 len
= strlenW(tmp_file
)+2;
584 len
+= strlenW(deformated
);
586 cmd
= msi_alloc(sizeof(WCHAR
)*len
);
588 strcpyW(cmd
,tmp_file
);
592 strcatW(cmd
,deformated
);
594 msi_free(deformated
);
597 TRACE("executing exe %s\n", debugstr_w(cmd
));
599 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
600 c_collen
, &si
, &info
);
605 ERR("Unable to execute command %s\n", debugstr_w(cmd
));
607 return ERROR_SUCCESS
;
611 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
,
615 track_tempfile(package
, tmp_file
, tmp_file
);
617 DeleteFileW(tmp_file
);
622 static UINT
HANDLE_CustomType17(MSIPACKAGE
*package
, LPCWSTR source
,
623 LPCWSTR target
, const INT type
, LPCWSTR action
)
628 TRACE("%s %s\n", debugstr_w(source
), debugstr_w(target
));
630 file
= get_loaded_file( package
, source
);
633 ERR("invalid file key %s\n", debugstr_w( source
));
634 return ERROR_FUNCTION_FAILED
;
637 hThread
= do_msidbCustomActionTypeDll( package
, file
->TargetPath
, target
);
639 return process_handle(package
, type
, hThread
, NULL
, action
, NULL
);
642 static UINT
HANDLE_CustomType18(MSIPACKAGE
*package
, LPCWSTR source
,
643 LPCWSTR target
, const INT type
, LPCWSTR action
)
646 PROCESS_INFORMATION info
;
651 static const WCHAR spc
[] = {' ',0};
655 memset(&si
,0,sizeof(STARTUPINFOW
));
657 file
= get_loaded_file(package
,source
);
659 return ERROR_FUNCTION_FAILED
;
661 len
= lstrlenW( file
->TargetPath
);
663 deformat_string(package
,target
,&deformated
);
665 len
+= strlenW(deformated
);
668 cmd
= msi_alloc(len
* sizeof(WCHAR
));
670 lstrcpyW( cmd
, file
->TargetPath
);
674 strcatW(cmd
, deformated
);
676 msi_free(deformated
);
679 TRACE("executing exe %s\n", debugstr_w(cmd
));
681 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
682 c_collen
, &si
, &info
);
687 ERR("Unable to execute command %s\n", debugstr_w(cmd
));
689 return ERROR_SUCCESS
;
693 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
,
699 static UINT
HANDLE_CustomType19(MSIPACKAGE
*package
, LPCWSTR source
,
700 LPCWSTR target
, const INT type
, LPCWSTR action
)
702 static const WCHAR query
[] = {
703 'S','E','L','E','C','T',' ','`','M','e','s','s','a','g','e','`',' ',
704 'F','R','O','M',' ','`','E','r','r','o','r','`',' ',
705 'W','H','E','R','E',' ','`','E','r','r','o','r','`',' ','=',' ',
709 LPWSTR deformated
= NULL
;
711 deformat_string( package
, target
, &deformated
);
713 /* first try treat the error as a number */
714 row
= MSI_QueryGetRecord( package
->db
, query
, deformated
);
717 LPCWSTR error
= MSI_RecordGetString( row
, 1 );
718 MessageBoxW( NULL
, error
, NULL
, MB_OK
);
719 msiobj_release( &row
->hdr
);
722 MessageBoxW( NULL
, deformated
, NULL
, MB_OK
);
724 msi_free( deformated
);
726 return ERROR_FUNCTION_FAILED
;
729 static UINT
HANDLE_CustomType50(MSIPACKAGE
*package
, LPCWSTR source
,
730 LPCWSTR target
, const INT type
, LPCWSTR action
)
733 PROCESS_INFORMATION info
;
739 static const WCHAR spc
[] = {' ',0};
741 memset(&si
,0,sizeof(STARTUPINFOW
));
742 memset(&info
,0,sizeof(PROCESS_INFORMATION
));
744 prop
= msi_dup_property( package
, source
);
746 return ERROR_SUCCESS
;
748 deformat_string(package
,target
,&deformated
);
749 len
= strlenW(prop
) + 2;
751 len
+= strlenW(deformated
);
753 cmd
= msi_alloc(sizeof(WCHAR
)*len
);
759 strcatW(cmd
,deformated
);
761 msi_free(deformated
);
765 TRACE("executing exe %s\n", debugstr_w(cmd
));
767 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
768 c_collen
, &si
, &info
);
773 ERR("Unable to execute command %s\n", debugstr_w(cmd
));
775 return ERROR_SUCCESS
;
779 return process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
, NULL
);
782 static UINT
HANDLE_CustomType34(MSIPACKAGE
*package
, LPCWSTR source
,
783 LPCWSTR target
, const INT type
, LPCWSTR action
)
785 LPWSTR filename
, deformated
;
787 PROCESS_INFORMATION info
;
791 memset(&si
,0,sizeof(STARTUPINFOW
));
793 filename
= resolve_folder(package
, source
, FALSE
, FALSE
, NULL
);
796 return ERROR_FUNCTION_FAILED
;
798 SetCurrentDirectoryW(filename
);
801 deformat_string(package
,target
,&deformated
);
804 return ERROR_FUNCTION_FAILED
;
806 TRACE("executing exe %s\n", debugstr_w(deformated
));
808 rc
= CreateProcessW(NULL
, deformated
, NULL
, NULL
, FALSE
, 0, NULL
,
809 c_collen
, &si
, &info
);
813 ERR("Unable to execute command %s\n", debugstr_w(deformated
));
814 msi_free(deformated
);
815 return ERROR_SUCCESS
;
817 msi_free(deformated
);
819 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
,
826 void ACTION_FinishCustomActions(MSIPACKAGE
* package
)
828 struct list
*item
, *cursor
;
831 LIST_FOR_EACH_SAFE( item
, cursor
, &package
->RunningActions
)
833 MSIRUNNINGACTION
*action
= LIST_ENTRY( item
, MSIRUNNINGACTION
, entry
);
835 TRACE("Checking on action %s\n", debugstr_w(action
->name
));
837 list_remove( &action
->entry
);
840 GetExitCodeProcess( action
->handle
, &rc
);
842 GetExitCodeThread( action
->handle
, &rc
);
844 if (rc
== STILL_ACTIVE
)
846 TRACE("Waiting on action %s\n", debugstr_w( action
->name
) );
847 msi_dialog_check_messages( action
->handle
);
850 CloseHandle( action
->handle
);
851 msi_free( action
->name
);