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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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"
40 #include "msvcrt/fcntl.h"
47 #include "wine/unicode.h"
51 WINE_DEFAULT_DEBUG_CHANNEL(msi
);
53 #define CUSTOM_ACTION_TYPE_MASK 0x3F
54 static const WCHAR c_collen
[] = {'C',':','\\',0};
55 static const WCHAR cszTempFolder
[]= {'T','e','m','p','F','o','l','d','e','r',0};
57 typedef struct tagMSIRUNNINGACTION
64 static UINT
HANDLE_CustomType1(MSIPACKAGE
*package
, LPCWSTR source
,
65 LPCWSTR target
, const INT type
, LPCWSTR action
);
66 static UINT
HANDLE_CustomType2(MSIPACKAGE
*package
, LPCWSTR source
,
67 LPCWSTR target
, const INT type
, LPCWSTR action
);
68 static UINT
HANDLE_CustomType18(MSIPACKAGE
*package
, LPCWSTR source
,
69 LPCWSTR target
, const INT type
, LPCWSTR action
);
70 static UINT
HANDLE_CustomType50(MSIPACKAGE
*package
, LPCWSTR source
,
71 LPCWSTR target
, const INT type
, LPCWSTR action
);
72 static UINT
HANDLE_CustomType34(MSIPACKAGE
*package
, LPCWSTR source
,
73 LPCWSTR target
, const INT type
, LPCWSTR action
);
75 UINT
ACTION_CustomAction(MSIPACKAGE
*package
,LPCWSTR action
, BOOL execute
)
77 UINT rc
= ERROR_SUCCESS
;
80 static const WCHAR ExecSeqQuery
[] =
81 {'s','e','l','e','c','t',' ','*',' ','f','r','o','m',' ','C','u','s','t','o'
82 ,'m','A','c','t','i','o','n',' ','w','h','e','r','e',' ','`','A','c','t','i'
83 ,'o','n','`',' ','=',' ','`','%','s','`',0};
87 WCHAR
*deformated
=NULL
;
89 rc
= MSI_OpenQuery(package
->db
, &view
, ExecSeqQuery
, action
);
90 if (rc
!= ERROR_SUCCESS
)
93 rc
= MSI_ViewExecute(view
, 0);
94 if (rc
!= ERROR_SUCCESS
)
97 msiobj_release(&view
->hdr
);
101 rc
= MSI_ViewFetch(view
,&row
);
102 if (rc
!= ERROR_SUCCESS
)
105 msiobj_release(&view
->hdr
);
109 type
= MSI_RecordGetInteger(row
,2);
111 source
= load_dynamic_stringW(row
,3);
112 target
= load_dynamic_stringW(row
,4);
114 TRACE("Handling custom action %s (%x %s %s)\n",debugstr_w(action
),type
,
115 debugstr_w(source
), debugstr_w(target
));
117 /* handle some of the deferred actions */
122 FIXME("Rollback only action... rollbacks not supported yet\n");
123 HeapFree(GetProcessHeap(),0,source
);
124 HeapFree(GetProcessHeap(),0,target
);
125 msiobj_release(&row
->hdr
);
127 msiobj_release(&view
->hdr
);
128 return ERROR_SUCCESS
;
132 LPWSTR
*newbuf
= NULL
;
136 TRACE("Deferring Commit Action!\n");
137 count
= package
->CommitActionCount
;
138 package
->CommitActionCount
++;
140 newbuf
= HeapReAlloc(GetProcessHeap(),0,
141 package
->CommitAction
,
142 package
->CommitActionCount
* sizeof(LPWSTR
));
144 newbuf
= HeapAlloc(GetProcessHeap(),0, sizeof(LPWSTR
));
146 newbuf
[count
] = dupstrW(action
);
147 package
->CommitAction
= newbuf
;
151 TRACE("Deferring Action!\n");
152 count
= package
->DeferredActionCount
;
153 package
->DeferredActionCount
++;
155 newbuf
= HeapReAlloc(GetProcessHeap(),0,
156 package
->DeferredAction
,
157 package
->DeferredActionCount
* sizeof(LPWSTR
));
159 newbuf
= HeapAlloc(GetProcessHeap(),0, sizeof(LPWSTR
));
161 newbuf
[count
] = dupstrW(action
);
162 package
->DeferredAction
= newbuf
;
165 HeapFree(GetProcessHeap(),0,source
);
166 HeapFree(GetProcessHeap(),0,target
);
167 msiobj_release(&row
->hdr
);
169 msiobj_release(&view
->hdr
);
170 return ERROR_SUCCESS
;
176 static const WCHAR szActionData
[] = {
177 'C','u','s','t','o','m','A','c','t','i','o','n','D','a','t','a',0};
178 LPWSTR actiondata
= load_dynamic_property(package
,action
,NULL
);
180 MSI_SetPropertyW(package
,szActionData
,actiondata
);
184 switch (type
& CUSTOM_ACTION_TYPE_MASK
)
186 case 1: /* DLL file stored in a Binary table stream */
187 rc
= HANDLE_CustomType1(package
,source
,target
,type
,action
);
189 case 2: /* EXE file stored in a Binary table strem */
190 rc
= HANDLE_CustomType2(package
,source
,target
,type
,action
);
192 case 18: /*EXE file installed with package */
193 rc
= HANDLE_CustomType18(package
,source
,target
,type
,action
);
195 case 50: /*EXE file specified by a property value */
196 rc
= HANDLE_CustomType50(package
,source
,target
,type
,action
);
198 case 34: /*EXE to be run in specified directory */
199 rc
= HANDLE_CustomType34(package
,source
,target
,type
,action
);
201 case 35: /* Directory set with formatted text. */
202 deformat_string(package
,target
,&deformated
);
203 MSI_SetTargetPathW(package
, source
, deformated
);
204 HeapFree(GetProcessHeap(),0,deformated
);
206 case 51: /* Property set with formatted text. */
207 deformat_string(package
,target
,&deformated
);
208 rc
= MSI_SetPropertyW(package
,source
,deformated
);
209 HeapFree(GetProcessHeap(),0,deformated
);
212 FIXME("UNHANDLED ACTION TYPE %i (%s %s)\n",
213 type
& CUSTOM_ACTION_TYPE_MASK
, debugstr_w(source
),
217 HeapFree(GetProcessHeap(),0,source
);
218 HeapFree(GetProcessHeap(),0,target
);
219 msiobj_release(&row
->hdr
);
221 msiobj_release(&view
->hdr
);
226 static UINT
store_binary_to_temp(MSIPACKAGE
*package
, LPCWSTR source
,
231 if (MSI_GetPropertyW(package
, cszTempFolder
, tmp_file
, &sz
)
233 GetTempPathW(MAX_PATH
,tmp_file
);
235 strcatW(tmp_file
,source
);
237 if (GetFileAttributesW(tmp_file
) != INVALID_FILE_ATTRIBUTES
)
239 TRACE("File already exists\n");
240 return ERROR_SUCCESS
;
244 /* write out the file */
248 static const WCHAR fmt
[] =
249 {'s','e','l','e','c','t',' ','*',' ','f','r','o','m',' ','B','i'
250 ,'n','a','r','y',' ','w','h','e','r','e',' ','N','a','m','e','=','`','%','s','`',0};
254 if (track_tempfile(package
, source
, tmp_file
)!=0)
255 FIXME("File Name in temp tracking collision\n");
257 the_file
= CreateFileW(tmp_file
, GENERIC_WRITE
, 0, NULL
, CREATE_ALWAYS
,
258 FILE_ATTRIBUTE_NORMAL
, NULL
);
260 if (the_file
== INVALID_HANDLE_VALUE
)
261 return ERROR_FUNCTION_FAILED
;
263 rc
= MSI_OpenQuery(package
->db
, &view
, fmt
, source
);
264 if (rc
!= ERROR_SUCCESS
)
267 rc
= MSI_ViewExecute(view
, 0);
268 if (rc
!= ERROR_SUCCESS
)
271 msiobj_release(&view
->hdr
);
275 rc
= MSI_ViewFetch(view
,&row
);
276 if (rc
!= ERROR_SUCCESS
)
279 msiobj_release(&view
->hdr
);
287 rc
= MSI_RecordReadStream(row
,2,buffer
,&sz
);
288 if (rc
!= ERROR_SUCCESS
)
290 ERR("Failed to get stream\n");
291 CloseHandle(the_file
);
292 DeleteFileW(tmp_file
);
295 WriteFile(the_file
,buffer
,sz
,&write
,NULL
);
296 } while (sz
== 1024);
298 CloseHandle(the_file
);
300 msiobj_release(&row
->hdr
);
302 msiobj_release(&view
->hdr
);
305 return ERROR_SUCCESS
;
308 static void file_running_action(MSIPACKAGE
* package
, HANDLE Handle
,
309 BOOL process
, LPCWSTR name
)
311 MSIRUNNINGACTION
*newbuf
= NULL
;
313 count
= package
->RunningActionCount
;
314 package
->RunningActionCount
++;
316 newbuf
= HeapReAlloc(GetProcessHeap(),0,
317 package
->RunningAction
,
318 package
->RunningActionCount
* sizeof(MSIRUNNINGACTION
));
320 newbuf
= HeapAlloc(GetProcessHeap(),0, sizeof(MSIRUNNINGACTION
));
322 newbuf
[count
].handle
= Handle
;
323 newbuf
[count
].process
= process
;
324 newbuf
[count
].name
= dupstrW(name
);
326 package
->RunningAction
= newbuf
;
329 static UINT
process_action_return_value(UINT type
, HANDLE ThreadHandle
)
335 GetExitCodeProcess(ThreadHandle
,&rc
);
338 return ERROR_SUCCESS
;
340 return ERROR_FUNCTION_FAILED
;
343 GetExitCodeThread(ThreadHandle
,&rc
);
347 case ERROR_FUNCTION_NOT_CALLED
:
349 case ERROR_INSTALL_USEREXIT
:
350 case ERROR_INSTALL_FAILURE
:
352 case ERROR_NO_MORE_ITEMS
:
353 return ERROR_SUCCESS
;
355 return ERROR_FUNCTION_FAILED
;
359 static UINT
process_handle(MSIPACKAGE
* package
, UINT type
,
360 HANDLE ThreadHandle
, HANDLE ProcessHandle
,
363 UINT rc
= ERROR_SUCCESS
;
368 TRACE("Syncronous Execution of action %s\n",debugstr_w(Name
));
370 WaitForSingleObject(ProcessHandle
,INFINITE
);
372 WaitForSingleObject(ThreadHandle
,INFINITE
);
377 rc
= process_action_return_value(2,ProcessHandle
);
379 rc
= process_action_return_value(1,ThreadHandle
);
382 CloseHandle(ThreadHandle
);
384 CloseHandle(ProcessHandle
);
388 TRACE("Asyncronous Execution of action %s\n",debugstr_w(Name
));
394 file_running_action(package
, ProcessHandle
, TRUE
, Name
);
395 CloseHandle(ThreadHandle
);
398 file_running_action(package
, ThreadHandle
, FALSE
, Name
);
402 CloseHandle(ThreadHandle
);
404 CloseHandle(ProcessHandle
);
412 typedef UINT __stdcall
CustomEntry(MSIHANDLE
);
421 static DWORD WINAPI
ACTION_CallDllFunction(thread_struct
*stuff
)
426 DWORD rc
= ERROR_SUCCESS
;
428 TRACE("calling function (%s, %s) \n", debugstr_w(stuff
->source
),
429 debugstr_w(stuff
->target
));
431 hModule
= LoadLibraryW(stuff
->source
);
434 proc
= strdupWtoA( stuff
->target
);
435 fn
= (CustomEntry
*)GetProcAddress(hModule
,proc
);
439 MSIPACKAGE
*package
= stuff
->package
;
441 TRACE("Calling function %s\n", proc
);
442 hPackage
= msiobj_findhandle( &package
->hdr
);
446 msiobj_release( &package
->hdr
);
449 ERR("Handle for object %p not found\n", package
);
452 ERR("Cannot load functon\n");
454 HeapFree(GetProcessHeap(),0,proc
);
455 FreeLibrary(hModule
);
458 ERR("Unable to load library\n");
459 msiobj_release( &stuff
->package
->hdr
);
460 HeapFree(GetProcessHeap(),0,stuff
->source
);
461 HeapFree(GetProcessHeap(),0,stuff
->target
);
462 HeapFree(GetProcessHeap(), 0, stuff
);
466 static DWORD WINAPI
DllThread(LPVOID info
)
468 thread_struct
*stuff
;
471 TRACE("MSI Thread (0x%lx) started for custom action\n",
472 GetCurrentThreadId());
474 stuff
= (thread_struct
*)info
;
475 rc
= ACTION_CallDllFunction(stuff
);
477 TRACE("MSI Thread (0x%lx) finished\n",GetCurrentThreadId());
478 /* clse all handles for this thread */
479 MsiCloseAllHandles();
483 static UINT
HANDLE_CustomType1(MSIPACKAGE
*package
, LPCWSTR source
,
484 LPCWSTR target
, const INT type
, LPCWSTR action
)
486 WCHAR tmp_file
[MAX_PATH
];
490 UINT rc
= ERROR_SUCCESS
;
492 store_binary_to_temp(package
, source
, tmp_file
);
494 TRACE("Calling function %s from %s\n",debugstr_w(target
),
495 debugstr_w(tmp_file
));
497 if (!strchrW(tmp_file
,'.'))
499 static const WCHAR dot
[]={'.',0};
500 strcatW(tmp_file
,dot
);
503 info
= HeapAlloc( GetProcessHeap(), 0, sizeof(*info
) );
504 msiobj_addref( &package
->hdr
);
505 info
->package
= package
;
506 info
->target
= dupstrW(target
);
507 info
->source
= dupstrW(tmp_file
);
509 ThreadHandle
= CreateThread(NULL
,0,DllThread
,(LPVOID
)info
,0,&ThreadId
);
511 rc
= process_handle(package
, type
, ThreadHandle
, NULL
, action
);
516 static UINT
HANDLE_CustomType2(MSIPACKAGE
*package
, LPCWSTR source
,
517 LPCWSTR target
, const INT type
, LPCWSTR action
)
519 WCHAR tmp_file
[MAX_PATH
];
521 PROCESS_INFORMATION info
;
526 static const WCHAR spc
[] = {' ',0};
527 UINT prc
= ERROR_SUCCESS
;
529 memset(&si
,0,sizeof(STARTUPINFOW
));
531 store_binary_to_temp(package
, source
, tmp_file
);
533 deformat_string(package
,target
,&deformated
);
535 len
= strlenW(tmp_file
)+2;
538 len
+= strlenW(deformated
);
540 cmd
= (WCHAR
*)HeapAlloc(GetProcessHeap(),0,sizeof(WCHAR
)*len
);
542 strcpyW(cmd
,tmp_file
);
546 strcatW(cmd
,deformated
);
548 HeapFree(GetProcessHeap(),0,deformated
);
551 TRACE("executing exe %s \n",debugstr_w(cmd
));
553 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
554 c_collen
, &si
, &info
);
556 HeapFree(GetProcessHeap(),0,cmd
);
560 ERR("Unable to execute command\n");
561 return ERROR_SUCCESS
;
564 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
);
569 static UINT
HANDLE_CustomType18(MSIPACKAGE
*package
, LPCWSTR source
,
570 LPCWSTR target
, const INT type
, LPCWSTR action
)
573 PROCESS_INFORMATION info
;
578 static const WCHAR spc
[] = {' ',0};
582 memset(&si
,0,sizeof(STARTUPINFOW
));
584 index
= get_loaded_file(package
,source
);
586 len
= strlenW(package
->files
[index
].TargetPath
);
588 deformat_string(package
,target
,&deformated
);
590 len
+= strlenW(deformated
);
593 cmd
= (WCHAR
*)HeapAlloc(GetProcessHeap(),0,len
* sizeof(WCHAR
));
595 strcpyW(cmd
, package
->files
[index
].TargetPath
);
599 strcatW(cmd
, deformated
);
601 HeapFree(GetProcessHeap(),0,deformated
);
604 TRACE("executing exe %s \n",debugstr_w(cmd
));
606 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
607 c_collen
, &si
, &info
);
609 HeapFree(GetProcessHeap(),0,cmd
);
613 ERR("Unable to execute command\n");
614 return ERROR_SUCCESS
;
617 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
);
622 static UINT
HANDLE_CustomType50(MSIPACKAGE
*package
, LPCWSTR source
,
623 LPCWSTR target
, const INT type
, LPCWSTR action
)
626 PROCESS_INFORMATION info
;
633 static const WCHAR spc
[] = {' ',0};
635 memset(&si
,0,sizeof(STARTUPINFOW
));
636 memset(&info
,0,sizeof(PROCESS_INFORMATION
));
638 prop
= load_dynamic_property(package
,source
,&prc
);
642 deformat_string(package
,target
,&deformated
);
643 len
= strlenW(prop
) + 2;
645 len
+= strlenW(deformated
);
647 cmd
= (WCHAR
*)HeapAlloc(GetProcessHeap(),0,sizeof(WCHAR
)*len
);
653 strcatW(cmd
,deformated
);
655 HeapFree(GetProcessHeap(),0,deformated
);
658 TRACE("executing exe %s \n",debugstr_w(cmd
));
660 rc
= CreateProcessW(NULL
, cmd
, NULL
, NULL
, FALSE
, 0, NULL
,
661 c_collen
, &si
, &info
);
663 HeapFree(GetProcessHeap(),0,cmd
);
667 ERR("Unable to execute command\n");
668 return ERROR_SUCCESS
;
671 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
);
676 static UINT
HANDLE_CustomType34(MSIPACKAGE
*package
, LPCWSTR source
,
677 LPCWSTR target
, const INT type
, LPCWSTR action
)
679 LPWSTR filename
, deformated
;
681 PROCESS_INFORMATION info
;
685 memset(&si
,0,sizeof(STARTUPINFOW
));
687 filename
= resolve_folder(package
, source
, FALSE
, FALSE
, NULL
);
690 return ERROR_FUNCTION_FAILED
;
692 SetCurrentDirectoryW(filename
);
693 HeapFree(GetProcessHeap(),0,filename
);
695 deformat_string(package
,target
,&deformated
);
698 return ERROR_FUNCTION_FAILED
;
700 TRACE("executing exe %s \n",debugstr_w(deformated
));
702 rc
= CreateProcessW(NULL
, deformated
, NULL
, NULL
, FALSE
, 0, NULL
,
703 c_collen
, &si
, &info
);
704 HeapFree(GetProcessHeap(),0,deformated
);
708 ERR("Unable to execute command\n");
709 return ERROR_SUCCESS
;
712 prc
= process_handle(package
, type
, info
.hThread
, info
.hProcess
, action
);
718 void ACTION_FinishCustomActions(MSIPACKAGE
* package
)
723 for (i
= 0; i
< package
->RunningActionCount
; i
++)
725 TRACE("Checking on action %s\n",
726 debugstr_w(package
->RunningAction
[i
].name
));
728 if (package
->RunningAction
[i
].process
)
729 GetExitCodeProcess(package
->RunningAction
[i
].handle
, &rc
);
731 GetExitCodeThread(package
->RunningAction
[i
].handle
, &rc
);
733 if (rc
== STILL_ACTIVE
)
735 TRACE("Waiting on action %s\n",
736 debugstr_w(package
->RunningAction
[i
].name
));
737 WaitForSingleObject(package
->RunningAction
[i
].handle
, INFINITE
);
740 HeapFree(GetProcessHeap(),0,package
->RunningAction
[i
].name
);
741 CloseHandle(package
->RunningAction
[i
].handle
);
744 HeapFree(GetProcessHeap(),0,package
->RunningAction
);