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 static 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 );
171 msi_free(action_copy);
172 return ERROR_CALL_NOT_IMPLEMENTED;
175 type = MSI_RecordGetInteger(row,2);
177 source = MSI_RecordGetString(row,3);
178 target = MSI_RecordGetString(row,4);
180 TRACE("Handling custom action %s (%x %s %s)\n",debugstr_w(action),type,
181 debugstr_w(source), debugstr_w(target));
183 /* handle some of the deferred actions */
184 if (type & msidbCustomActionTypeTSAware)
185 FIXME("msidbCustomActionTypeTSAware not handled\n");
187 if (type & msidbCustomActionTypeInScript)
189 if (type & msidbCustomActionTypeNoImpersonate)
190 FIXME("msidbCustomActionTypeNoImpersonate not handled\n");
192 if (type & msidbCustomActionTypeRollback)
194 FIXME("Rollback only action... rollbacks not supported yet\n");
195 schedule_action(package, ROLLBACK_SCRIPT, action);
201 LPWSTR actiondata = msi_dup_property(package, action);
202 LPWSTR deferred = msi_get_deferred_action(action, actiondata);
204 if (type & msidbCustomActionTypeCommit)
206 TRACE("Deferring Commit Action!\n");
207 schedule_action(package, COMMIT_SCRIPT, deferred);
211 TRACE("Deferring Action!\n");
212 schedule_action(package, INSTALL_SCRIPT, deferred);
223 static const WCHAR szActionData[] = {
224 'C','u','s','t','o','m','A','c','t','i','o','n','D','a','t','a',0};
225 static const WCHAR szBlank[] = {0};
226 LPWSTR actiondata = msi_dup_property( package, action );
228 MSI_SetPropertyW(package,szActionData,deferred_data);
230 MSI_SetPropertyW(package,szActionData,actiondata);
232 MSI_SetPropertyW(package,szActionData,szBlank);
233 msi_free(actiondata);
236 else if (!check_execution_scheduling_options(package,action,type))
242 switch (type & CUSTOM_ACTION_TYPE_MASK)
244 case 1: /* DLL file stored in a Binary table stream */
245 rc = HANDLE_CustomType1(package,source,target,type,action);
247 case 2: /* EXE file stored in a Binary table strem */
248 rc = HANDLE_CustomType2(package,source,target,type,action);
250 case 18: /*EXE file installed with package */
251 rc = HANDLE_CustomType18(package,source,target,type,action);
253 case 19: /* Error that halts install */
254 rc = HANDLE_CustomType19(package,source,target,type,action);
257 rc = HANDLE_CustomType17(package,source,target,type,action);
259 case 50: /*EXE file specified by a property value */
260 rc = HANDLE_CustomType50(package,source,target,type,action);
262 case 34: /*EXE to be run in specified directory */
263 rc = HANDLE_CustomType34(package,source,target,type,action);
265 case 35: /* Directory set with formatted text. */
266 deformat_string(package,target,&deformated);
267 MSI_SetTargetPathW(package, source, deformated);
268 msi_free(deformated);
270 case 51: /* Property set with formatted text. */
271 deformat_string(package,target,&deformated);
272 rc = MSI_SetPropertyW(package,source,deformated);
273 msi_free(deformated);
276 FIXME("UNHANDLED ACTION TYPE %i (%s %s)\n",
277 type & CUSTOM_ACTION_TYPE_MASK, debugstr_w(source),
282 msi_free(action_copy);
283 msiobj_release(&row->hdr);
288 static UINT store_binary_to_temp(MSIPACKAGE *package, LPCWSTR source,
292 static const WCHAR f1[] = {'m','s','i',0};
295 if (MSI_GetPropertyW(package, cszTempFolder, fmt, &sz) != ERROR_SUCCESS)
296 GetTempPathW(MAX_PATH,fmt);
298 if (GetTempFileNameW(fmt,f1,0,tmp_file) == 0)
300 TRACE("Unable to create file\n");
301 return ERROR_FUNCTION_FAILED;
305 /* write out the file */
308 static const WCHAR fmt[] =
309 {'S','E','L','E','C','T',' ','*',' ','F','R','O','M',' ',
310 '`','B','i' ,'n','a','r','y','`',' ','W','H','E','R','E',
311 ' ','`','N','a','m','e','`',' ','=',' ','\'','%','s','\'',0};
315 the_file = CreateFileW(tmp_file, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
316 FILE_ATTRIBUTE_NORMAL, NULL);
318 if (the_file == INVALID_HANDLE_VALUE)
319 return ERROR_FUNCTION_FAILED;
321 row = MSI_QueryGetRecord(package->db, fmt, source);
323 return ERROR_FUNCTION_FAILED;
329 rc = MSI_RecordReadStream(row,2,buffer,&sz);
330 if (rc != ERROR_SUCCESS)
332 ERR("Failed to get stream\n");
333 CloseHandle(the_file);
334 DeleteFileW(tmp_file);
337 WriteFile(the_file,buffer,sz,&write,NULL);
338 } while (sz == 1024);
340 CloseHandle(the_file);
342 msiobj_release(&row->hdr);
345 return ERROR_SUCCESS;
348 static void file_running_action(MSIPACKAGE* package, HANDLE Handle,
349 BOOL process, LPCWSTR name)
351 MSIRUNNINGACTION *action;
353 action = msi_alloc( sizeof(MSIRUNNINGACTION) );
355 action->handle = Handle;
356 action->process = process;
357 action->name = strdupW(name);
359 list_add_tail( &package->RunningActions, &action->entry );
362 static UINT process_action_return_value(UINT type, HANDLE ThreadHandle)
368 GetExitCodeProcess(ThreadHandle,&rc);
371 return ERROR_SUCCESS;
373 return ERROR_FUNCTION_FAILED;
376 GetExitCodeThread(ThreadHandle,&rc);
380 case ERROR_FUNCTION_NOT_CALLED:
382 case ERROR_INSTALL_USEREXIT:
383 case ERROR_INSTALL_FAILURE:
385 case ERROR_NO_MORE_ITEMS:
386 return ERROR_SUCCESS;
388 ERR("Invalid Return Code %d\n",rc);
389 return ERROR_INSTALL_FAILURE;
393 static UINT process_handle(MSIPACKAGE* package, UINT type,
394 HANDLE ThreadHandle, HANDLE ProcessHandle,
395 LPCWSTR Name, BOOL *finished)
397 UINT rc = ERROR_SUCCESS;
399 if (!(type & msidbCustomActionTypeAsync))
402 TRACE("Synchronous Execution of action %s\n",debugstr_w(Name));
404 msi_dialog_check_messages(ProcessHandle);
406 msi_dialog_check_messages(ThreadHandle);
408 if (!(type & msidbCustomActionTypeContinue))
411 rc = process_action_return_value(2,ProcessHandle);
413 rc = process_action_return_value(1,ThreadHandle);
416 CloseHandle(ThreadHandle);
418 CloseHandle(ProcessHandle);
424 TRACE("Asynchronous Execution of action %s\n",debugstr_w(Name));
426 if (type & msidbCustomActionTypeContinue)
430 file_running_action(package, ProcessHandle, TRUE, Name);
431 CloseHandle(ThreadHandle);
434 file_running_action(package, ThreadHandle, FALSE, Name);
438 CloseHandle(ThreadHandle);
440 CloseHandle(ProcessHandle);
450 typedef UINT __stdcall CustomEntry(MSIHANDLE);
459 static DWORD WINAPI ACTION_CallDllFunction(thread_struct *stuff)
464 DWORD rc = ERROR_SUCCESS;
466 TRACE("calling function (%s, %s)\n", debugstr_w(stuff->source),
467 debugstr_w(stuff->target));
469 hModule = LoadLibraryW(stuff->source);
472 proc = strdupWtoA( stuff->target );
473 fn = (CustomEntry*)GetProcAddress(hModule,proc);
477 MSIPACKAGE *package = stuff->package;
479 TRACE("Calling function %s\n", proc);
480 hPackage = alloc_msihandle( &package->hdr );
484 MsiCloseHandle( hPackage );
487 ERR("Handle for object %p not found\n", package );
490 ERR("failed to resolve functon %s\n", debugstr_a(proc));
493 FreeLibrary(hModule);
496 ERR("failed to load dll %s\n", debugstr_w(stuff->source));
497 msiobj_release( &stuff->package->hdr );
498 msi_free(stuff->source);
499 msi_free(stuff->target);
504 static DWORD WINAPI DllThread(LPVOID info)
506 thread_struct *stuff;
509 TRACE("MSI Thread (%x) started for custom action\n", GetCurrentThreadId());
511 stuff = (thread_struct*)info;
512 rc = ACTION_CallDllFunction(stuff);
514 TRACE("MSI Thread (%x) finished (rc %i)\n",GetCurrentThreadId(), rc);
515 /* clse all handles for this thread */
516 MsiCloseAllHandles();
520 static HANDLE do_msidbCustomActionTypeDll(MSIPACKAGE *package, LPCWSTR dll, LPCWSTR target)
524 info = msi_alloc( sizeof(*info) );
525 msiobj_addref( &package->hdr );
526 info->package = package;
527 info->target = strdupW(target);
528 info->source = strdupW(dll);
530 return CreateThread(NULL, 0, DllThread, info, 0, NULL);
533 static UINT HANDLE_CustomType1(MSIPACKAGE *package, LPCWSTR source,
534 LPCWSTR target, const INT type, LPCWSTR action)
536 WCHAR tmp_file[MAX_PATH];
537 UINT rc = ERROR_SUCCESS;
538 BOOL finished = FALSE;
541 store_binary_to_temp(package, source, tmp_file);
543 TRACE("Calling function %s from %s\n",debugstr_w(target),
544 debugstr_w(tmp_file));
546 if (!strchrW(tmp_file,'.'))
548 static const WCHAR dot[]={'.',0};
549 strcatW(tmp_file,dot);
552 ThreadHandle = do_msidbCustomActionTypeDll( package, tmp_file, target );
554 rc = process_handle(package, type, ThreadHandle, NULL, action, &finished );
557 track_tempfile(package, tmp_file, tmp_file);
559 DeleteFileW(tmp_file);
564 static UINT HANDLE_CustomType2(MSIPACKAGE *package, LPCWSTR source,
565 LPCWSTR target, const INT type, LPCWSTR action)
567 WCHAR tmp_file[MAX_PATH];
569 PROCESS_INFORMATION info;
574 static const WCHAR spc[] = {' ',0};
575 UINT prc = ERROR_SUCCESS;
576 BOOL finished = FALSE;
578 memset(&si,0,sizeof(STARTUPINFOW));
580 store_binary_to_temp(package, source, tmp_file);
582 deformat_string(package,target,&deformated);
584 len = strlenW(tmp_file)+2;
587 len += strlenW(deformated);
589 cmd = msi_alloc(sizeof(WCHAR)*len);
591 strcpyW(cmd,tmp_file);
595 strcatW(cmd,deformated);
597 msi_free(deformated);
600 TRACE("executing exe %s\n", debugstr_w(cmd));
602 rc = CreateProcessW(NULL, cmd, NULL, NULL, FALSE, 0, NULL,
603 c_collen, &si, &info);
608 ERR("Unable to execute command %s\n", debugstr_w(cmd));
610 return ERROR_SUCCESS;
614 prc = process_handle(package, type, info.hThread, info.hProcess, action,
618 track_tempfile(package, tmp_file, tmp_file);
620 DeleteFileW(tmp_file);
625 static UINT HANDLE_CustomType17(MSIPACKAGE *package, LPCWSTR source,
626 LPCWSTR target, const INT type, LPCWSTR action)
631 TRACE("%s %s\n", debugstr_w(source), debugstr_w(target));
633 file = get_loaded_file( package, source );
636 ERR("invalid file key %s\n", debugstr_w( source ));
637 return ERROR_FUNCTION_FAILED;
640 hThread = do_msidbCustomActionTypeDll( package, file->TargetPath, target );
642 return process_handle(package, type, hThread, NULL, action, NULL );
645 static UINT HANDLE_CustomType18(MSIPACKAGE *package, LPCWSTR source,
646 LPCWSTR target, const INT type, LPCWSTR action)
649 PROCESS_INFORMATION info;
654 static const WCHAR spc[] = {' ',0};
658 memset(&si,0,sizeof(STARTUPINFOW));
660 file = get_loaded_file(package,source);
662 return ERROR_FUNCTION_FAILED;
664 len = lstrlenW( file->TargetPath );
666 deformat_string(package,target,&deformated);
668 len += strlenW(deformated);
671 cmd = msi_alloc(len * sizeof(WCHAR));
673 lstrcpyW( cmd, file->TargetPath);
677 strcatW(cmd, deformated);
679 msi_free(deformated);
682 TRACE("executing exe %s\n", debugstr_w(cmd));
684 rc = CreateProcessW(NULL, cmd, NULL, NULL, FALSE, 0, NULL,
685 c_collen, &si, &info);
690 ERR("Unable to execute command %s\n", debugstr_w(cmd));
692 return ERROR_SUCCESS;
696 prc = process_handle(package, type, info.hThread, info.hProcess, action,
702 static UINT HANDLE_CustomType19(MSIPACKAGE *package, LPCWSTR source,
703 LPCWSTR target, const INT type, LPCWSTR action)
705 static const WCHAR query[] = {
706 'S','E','L','E','C','T',' ','`','M','e','s','s','a','g','e','`',' ',
707 'F','R','O','M',' ','`','E','r','r','o','r','`',' ',
708 'W','H','E','R','E',' ','`','E','r','r','o','r','`',' ','=',' ',
712 LPWSTR deformated = NULL;
714 deformat_string( package, target, &deformated );
716 /* first try treat the error as a number */
717 row = MSI_QueryGetRecord( package->db, query, deformated );
720 LPCWSTR error = MSI_RecordGetString( row, 1 );
721 MessageBoxW( NULL, error, NULL, MB_OK );
722 msiobj_release( &row->hdr );
725 MessageBoxW( NULL, deformated, NULL, MB_OK );
727 msi_free( deformated );
729 return ERROR_FUNCTION_FAILED;
732 static UINT HANDLE_CustomType50(MSIPACKAGE *package, LPCWSTR source,
733 LPCWSTR target, const INT type, LPCWSTR action)
736 PROCESS_INFORMATION info;
742 static const WCHAR spc[] = {' ',0};
744 memset(&si,0,sizeof(STARTUPINFOW));
745 memset(&info,0,sizeof(PROCESS_INFORMATION));
747 prop = msi_dup_property( package, source );
749 return ERROR_SUCCESS;
751 deformat_string(package,target,&deformated);
752 len = strlenW(prop) + 2;
754 len += strlenW(deformated);
756 cmd = msi_alloc(sizeof(WCHAR)*len);
762 strcatW(cmd,deformated);
764 msi_free(deformated);
768 TRACE("executing exe %s\n", debugstr_w(cmd));
770 rc = CreateProcessW(NULL, cmd, NULL, NULL, FALSE, 0, NULL,
771 c_collen, &si, &info);
776 ERR("Unable to execute command %s\n", debugstr_w(cmd));
778 return ERROR_SUCCESS;
782 return process_handle(package, type, info.hThread, info.hProcess, action, NULL);
785 static UINT HANDLE_CustomType34(MSIPACKAGE *package, LPCWSTR source,
786 LPCWSTR target, const INT type, LPCWSTR action)
788 LPWSTR filename, deformated;
790 PROCESS_INFORMATION info;
794 memset(&si,0,sizeof(STARTUPINFOW));
796 filename = resolve_folder(package, source, FALSE, FALSE, NULL);
799 return ERROR_FUNCTION_FAILED;
801 SetCurrentDirectoryW(filename);
804 deformat_string(package,target,&deformated);
807 return ERROR_FUNCTION_FAILED;
809 TRACE("executing exe %s\n", debugstr_w(deformated));
811 rc = CreateProcessW(NULL, deformated, NULL, NULL, FALSE, 0, NULL,
812 c_collen, &si, &info);
816 ERR("Unable to execute command %s\n", debugstr_w(deformated));
817 msi_free(deformated);
818 return ERROR_SUCCESS;
820 msi_free(deformated);
822 prc = process_handle(package, type, info.hThread, info.hProcess, action,
829 void ACTION_FinishCustomActions(MSIPACKAGE* package)
831 struct list *item, *cursor;
834 LIST_FOR_EACH_SAFE( item, cursor, &package->RunningActions )
836 MSIRUNNINGACTION *action = LIST_ENTRY( item, MSIRUNNINGACTION, entry );
838 TRACE("Checking on action %s\n", debugstr_w(action->name));
840 list_remove( &action->entry );
843 GetExitCodeProcess( action->handle, &rc );
845 GetExitCodeThread( action->handle, &rc );
847 if (rc == STILL_ACTIVE)
849 TRACE("Waiting on action %s\n", debugstr_w( action->name) );
850 msi_dialog_check_messages( action->handle );
853 CloseHandle( action->handle );
854 msi_free( action->name );