VBoxStub.cpp@ 73097

Last change on this file since 73097 was 73097, checked in by vboxsync, 6 years ago
*: Made RT_UOFFSETOF, RT_OFFSETOF, RT_UOFFSETOF_ADD and RT_OFFSETOF_ADD work like builtin_offsetof() and require compile time resolvable requests, adding RT_UOFFSETOF_DYN for the dynamic questions that can only be answered at runtime.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 40.4 KB

Line
1	/* $Id: VBoxStub.cpp 73097 2018-07-12 21:06:33Z vboxsync $ */
2	/** @file
3	* VBoxStub - VirtualBox's Windows installer stub.
4	*/
5
6	/*
7	* Copyright (C) 2010-2017 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0501
23	# undef _WIN32_WINNT
24	# define _WIN32_WINNT 0x0501 /* AttachConsole() / FreeConsole(). */
25	#endif
26
27	#include <iprt/win/windows.h>
28	#include <commctrl.h>
29	#include <fcntl.h>
30	#include <io.h>
31	#include <lmerr.h>
32	#include <msiquery.h>
33	#include <iprt/win/objbase.h>
34
35	#include <iprt/win/shlobj.h>
36	#include <stdlib.h>
37	#include <stdio.h>
38	#include <string.h>
39	#include <strsafe.h>
40
41	#include <VBox/version.h>
42
43	#include <iprt/assert.h>
44	#include <iprt/dir.h>
45	#include <iprt/file.h>
46	#include <iprt/getopt.h>
47	#include <iprt/initterm.h>
48	#include <iprt/list.h>
49	#include <iprt/mem.h>
50	#include <iprt/message.h>
51	#include <iprt/param.h>
52	#include <iprt/path.h>
53	#include <iprt/stream.h>
54	#include <iprt/string.h>
55	#include <iprt/thread.h>
56
57	#include "VBoxStub.h"
58	#include "../StubBld/VBoxStubBld.h"
59	#include "resource.h"
60
61	#ifdef VBOX_WITH_CODE_SIGNING
62	# include "VBoxStubCertUtil.h"
63	# include "VBoxStubPublicCert.h"
64	#endif
65
66	#ifndef TARGET_NT4
67	/* Use an own console window if run in verbose mode. */
68	# define VBOX_STUB_WITH_OWN_CONSOLE
69	#endif
70
71
72	/*********************************************************************************************************************************
73	* Defined Constants And Macros *
74	*********************************************************************************************************************************/
75	#define MY_UNICODE_SUB(str) L ##str
76	#define MY_UNICODE(str) MY_UNICODE_SUB(str)
77
78
79	/*********************************************************************************************************************************
80	* Structures and Typedefs *
81	*********************************************************************************************************************************/
82	/**
83	* Cleanup record.
84	*/
85	typedef struct STUBCLEANUPREC
86	{
87	/** List entry. */
88	RTLISTNODE ListEntry;
89	/** True if file, false if directory. */
90	bool fFile;
91	/** The path to the file or directory to clean up. */
92	char szPath[1];
93	} STUBCLEANUPREC;
94	/** Pointer to a cleanup record. */
95	typedef STUBCLEANUPREC *PSTUBCLEANUPREC;
96
97
98	/*********************************************************************************************************************************
99	* Global Variables *
100	*********************************************************************************************************************************/
101	/** Whether it's a silent or interactive GUI driven install. */
102	static bool g_fSilent = false;
103	/** List of temporary files. */
104	static RTLISTANCHOR g_TmpFiles;
105	/** Verbosity flag. */
106	static int g_iVerbosity = 0;
107
108
109
110	/**
111	* Shows an error message box with a printf() style formatted string.
112	*
113	* @returns RTEXITCODE_FAILURE
114	* @param pszFmt Printf-style format string to show in the message box body.
115	*
116	*/
117	static RTEXITCODE ShowError(const char *pszFmt, ...)
118	{
119	char *pszMsg;
120	va_list va;
121
122	va_start(va, pszFmt);
123	if (RTStrAPrintfV(&pszMsg, pszFmt, va))
124	{
125	if (g_fSilent)
126	RTMsgError("%s", pszMsg);
127	else
128	{
129	PRTUTF16 pwszMsg;
130	int rc = RTStrToUtf16(pszMsg, &pwszMsg);
131	if (RT_SUCCESS(rc))
132	{
133	MessageBoxW(GetDesktopWindow(), pwszMsg, MY_UNICODE(VBOX_STUB_TITLE), MB_ICONERROR);
134	RTUtf16Free(pwszMsg);
135	}
136	else
137	MessageBoxA(GetDesktopWindow(), pszMsg, VBOX_STUB_TITLE, MB_ICONERROR);
138	}
139	RTStrFree(pszMsg);
140	}
141	else /* Should never happen! */
142	AssertMsgFailed(("Failed to format error text of format string: %s!\n", pszFmt));
143	va_end(va);
144	return RTEXITCODE_FAILURE;
145	}
146
147
148	/**
149	* Shows a message box with a printf() style formatted string.
150	*
151	* @param uType Type of the message box (see MSDN).
152	* @param pszFmt Printf-style format string to show in the message box body.
153	*
154	*/
155	static void ShowInfo(const char *pszFmt, ...)
156	{
157	char *pszMsg;
158	va_list va;
159	va_start(va, pszFmt);
160	int rc = RTStrAPrintfV(&pszMsg, pszFmt, va);
161	va_end(va);
162	if (rc >= 0)
163	{
164	if (g_fSilent)
165	RTPrintf("%s\n", pszMsg);
166	else
167	{
168	PRTUTF16 pwszMsg;
169	int rc = RTStrToUtf16(pszMsg, &pwszMsg);
170	if (RT_SUCCESS(rc))
171	{
172	MessageBoxW(GetDesktopWindow(), pwszMsg, MY_UNICODE(VBOX_STUB_TITLE), MB_ICONINFORMATION);
173	RTUtf16Free(pwszMsg);
174	}
175	else
176	MessageBoxA(GetDesktopWindow(), pszMsg, VBOX_STUB_TITLE, MB_ICONINFORMATION);
177	}
178	}
179	else /* Should never happen! */
180	AssertMsgFailed(("Failed to format error text of format string: %s!\n", pszFmt));
181	RTStrFree(pszMsg);
182	}
183
184
185	/**
186	* Finds the specified in the resource section of the executable.
187	*
188	* @returns IPRT status code.
189	*
190	* @param pszDataName Name of resource to read.
191	* @param ppvResource Where to return the pointer to the data.
192	* @param pdwSize Where to return the size of the data (if found).
193	* Optional.
194	*/
195	static int FindData(const char pszDataName, PVOID ppvResource, DWORD *pdwSize)
196	{
197	AssertReturn(pszDataName, VERR_INVALID_PARAMETER);
198	HINSTANCE hInst = NULL; /* indicates the executable image */
199
200	/* Find our resource. */
201	PRTUTF16 pwszDataName;
202	int rc = RTStrToUtf16(pszDataName, &pwszDataName);
203	AssertRCReturn(rc, rc);
204	HRSRC hRsrc = FindResourceExW(hInst,
205	(LPWSTR)RT_RCDATA,
206	pwszDataName,
207	MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL));
208	RTUtf16Free(pwszDataName);
209	AssertReturn(hRsrc, VERR_IO_GEN_FAILURE);
210
211	/* Get resource size. */
212	DWORD cb = SizeofResource(hInst, hRsrc);
213	AssertReturn(cb > 0, VERR_NO_DATA);
214	if (pdwSize)
215	*pdwSize = cb;
216
217	/* Get pointer to resource. */
218	HGLOBAL hData = LoadResource(hInst, hRsrc);
219	AssertReturn(hData, VERR_IO_GEN_FAILURE);
220
221	/* Lock resource. */
222	*ppvResource = LockResource(hData);
223	AssertReturn(*ppvResource, VERR_IO_GEN_FAILURE);
224	return VINF_SUCCESS;
225	}
226
227
228	/**
229	* Finds the header for the given package.
230	*
231	* @returns Pointer to the package header on success. On failure NULL is
232	* returned after ShowError has been invoked.
233	* @param iPackage The package number.
234	*/
235	static PVBOXSTUBPKG FindPackageHeader(unsigned iPackage)
236	{
237	char szHeaderName[32];
238	RTStrPrintf(szHeaderName, sizeof(szHeaderName), "HDR_%02d", iPackage);
239
240	PVBOXSTUBPKG pPackage;
241	int rc = FindData(szHeaderName, (PVOID *)&pPackage, NULL);
242	if (RT_FAILURE(rc))
243	{
244	ShowError("Internal error: Could not find package header #%u: %Rrc", iPackage, rc);
245	return NULL;
246	}
247
248	/** @todo validate it. */
249	return pPackage;
250	}
251
252
253
254	/**
255	* Constructs a full temporary file path from the given parameters.
256	*
257	* @returns iprt status code.
258	*
259	* @param pszTempPath The pure path to use for construction.
260	* @param pszTargetFileName The pure file name to use for construction.
261	* @param ppszTempFile Pointer to the constructed string. Must be freed
262	* using RTStrFree().
263	*/
264	static int GetTempFileAlloc(const char *pszTempPath,
265	const char *pszTargetFileName,
266	char **ppszTempFile)
267	{
268	if (RTStrAPrintf(ppszTempFile, "%s\\%s", pszTempPath, pszTargetFileName) >= 0)
269	return VINF_SUCCESS;
270	return VERR_NO_STR_MEMORY;
271	}
272
273
274	/**
275	* Extracts a built-in resource to disk.
276	*
277	* @returns iprt status code.
278	*
279	* @param pszResourceName The resource name to extract.
280	* @param pszTempFile The full file path + name to extract the resource to.
281	*
282	*/
283	static int ExtractFile(const char *pszResourceName,
284	const char *pszTempFile)
285	{
286	#if 0 /* Another example of how unnecessarily complicated things get with
287	do-break-while-false and you end up with buggy code using uninitialized
288	variables. */
289	int rc;
290	RTFILE fh;
291	BOOL bCreatedFile = FALSE;
292
293	do
294	{
295	AssertMsgBreak(pszResourceName, ("Resource pointer invalid!\n")); /* rc is not initialized here, we'll return garbage. */
296	AssertMsgBreak(pszTempFile, ("Temp file pointer invalid!")); /* Ditto. */
297
298	/* Read the data of the built-in resource. */
299	PVOID pvData = NULL;
300	DWORD dwDataSize = 0;
301	rc = FindData(pszResourceName, &pvData, &dwDataSize);
302	AssertMsgRCBreak(rc, ("Could not read resource data!\n"));
303
304	/* Create new (and replace an old) file. */
305	rc = RTFileOpen(&fh, pszTempFile,
306	RTFILE_O_CREATE_REPLACE
307	\| RTFILE_O_WRITE
308	\| RTFILE_O_DENY_NOT_DELETE
309	\| RTFILE_O_DENY_WRITE);
310	AssertMsgRCBreak(rc, ("Could not open file for writing!\n"));
311	bCreatedFile = TRUE;
312
313	/* Write contents to new file. */
314	size_t cbWritten = 0;
315	rc = RTFileWrite(fh, pvData, dwDataSize, &cbWritten);
316	AssertMsgRCBreak(rc, ("Could not open file for writing!\n"));
317	AssertMsgBreak(dwDataSize == cbWritten, ("File was not extracted completely! Disk full?\n"));
318
319	} while (0);
320
321	if (RTFileIsValid(fh)) /* fh is unused uninitalized (MSC agrees) */
322	RTFileClose(fh);
323
324	if (RT_FAILURE(rc))
325	{
326	if (bCreatedFile)
327	RTFileDelete(pszTempFile);
328	}
329
330	#else /* This is exactly the same as above, except no bug and better assertion
331	message. Note only the return-success statment is indented, indicating
332	that the whole do-break-while-false approach was totally unnecessary. */
333
334	AssertPtrReturn(pszResourceName, VERR_INVALID_POINTER);
335	AssertPtrReturn(pszTempFile, VERR_INVALID_POINTER);
336
337	/* Read the data of the built-in resource. */
338	PVOID pvData = NULL;
339	DWORD dwDataSize = 0;
340	int rc = FindData(pszResourceName, &pvData, &dwDataSize);
341	AssertMsgRCReturn(rc, ("Could not read resource data: %Rrc\n", rc), rc);
342
343	/* Create new (and replace an old) file. */
344	RTFILE hFile;
345	rc = RTFileOpen(&hFile, pszTempFile,
346	RTFILE_O_CREATE_REPLACE
347	\| RTFILE_O_WRITE
348	\| RTFILE_O_DENY_NOT_DELETE
349	\| RTFILE_O_DENY_WRITE);
350	AssertMsgRCReturn(rc, ("Could not open '%s' for writing: %Rrc\n", pszTempFile, rc), rc);
351
352	/* Write contents to new file. */
353	size_t cbWritten = 0;
354	rc = RTFileWrite(hFile, pvData, dwDataSize, &cbWritten);
355	AssertMsgStmt(cbWritten == dwDataSize \|\| RT_FAILURE_NP(rc), ("%#zx vs %#x\n", cbWritten, dwDataSize), rc = VERR_WRITE_ERROR);
356
357	int rc2 = RTFileClose(hFile);
358	AssertRC(rc2);
359
360	if (RT_SUCCESS(rc))
361	return VINF_SUCCESS;
362
363	RTFileDelete(pszTempFile);
364
365	#endif
366	return rc;
367	}
368
369
370	/**
371	* Extracts a built-in resource to disk.
372	*
373	* @returns iprt status code.
374	*
375	* @param pPackage Pointer to a VBOXSTUBPKG struct that contains the resource.
376	* @param pszTempFile The full file path + name to extract the resource to.
377	*
378	*/
379	static int Extract(const PVBOXSTUBPKG pPackage,
380	const char *pszTempFile)
381	{
382	return ExtractFile(pPackage->szResourceName, pszTempFile);
383	}
384
385
386	/**
387	* Detects whether we're running on a 32- or 64-bit platform and returns the result.
388	*
389	* @returns TRUE if we're running on a 64-bit OS, FALSE if not.
390	*
391	*/
392	static BOOL IsWow64(void)
393	{
394	BOOL bIsWow64 = TRUE;
395	fnIsWow64Process = (LPFN_ISWOW64PROCESS)GetProcAddress(GetModuleHandle(TEXT("kernel32")), "IsWow64Process");
396	if (NULL != fnIsWow64Process)
397	{
398	if (!fnIsWow64Process(GetCurrentProcess(), &bIsWow64))
399	{
400	/* Error in retrieving process type - assume that we're running on 32bit. */
401	return FALSE;
402	}
403	}
404	return bIsWow64;
405	}
406
407
408	/**
409	* Decides whether we need a specified package to handle or not.
410	*
411	* @returns @c true if we need to handle the specified package, @c false if not.
412	*
413	* @param pPackage Pointer to a VBOXSTUBPKG struct that contains the resource.
414	*
415	*/
416	static bool PackageIsNeeded(PVBOXSTUBPKG pPackage)
417	{
418	if (pPackage->byArch == VBOXSTUBPKGARCH_ALL)
419	return true;
420	VBOXSTUBPKGARCH enmArch = IsWow64() ? VBOXSTUBPKGARCH_AMD64 : VBOXSTUBPKGARCH_X86;
421	return pPackage->byArch == enmArch;
422	}
423
424
425	/**
426	* Adds a cleanup record.
427	*
428	* @returns Fully complained boolean success indicator.
429	* @param pszPath The path to the file or directory to clean up.
430	* @param fFile @c true if file, @c false if directory.
431	*/
432	static bool AddCleanupRec(const char *pszPath, bool fFile)
433	{
434	size_t cchPath = strlen(pszPath); Assert(cchPath > 0);
435	PSTUBCLEANUPREC pRec = (PSTUBCLEANUPREC)RTMemAlloc(RT_UOFFSETOF_DYN(STUBCLEANUPREC, szPath[cchPath + 1]));
436	if (!pRec)
437	{
438	ShowError("Out of memory!");
439	return false;
440	}
441	pRec->fFile = fFile;
442	memcpy(pRec->szPath, pszPath, cchPath + 1);
443
444	RTListPrepend(&g_TmpFiles, &pRec->ListEntry);
445	return true;
446	}
447
448
449	/**
450	* Cleans up all the extracted files and optionally removes the package
451	* directory.
452	*
453	* @param pszPkgDir The package directory, NULL if it shouldn't be
454	* removed.
455	*/
456	static void CleanUp(const char *pszPkgDir)
457	{
458	for (int i = 0; i < 5; i++)
459	{
460	int rc;
461	bool fFinalTry = i == 4;
462
463	PSTUBCLEANUPREC pCur, pNext;
464	RTListForEachSafe(&g_TmpFiles, pCur, pNext, STUBCLEANUPREC, ListEntry)
465	{
466	if (pCur->fFile)
467	rc = RTFileDelete(pCur->szPath);
468	else
469	{
470	rc = RTDirRemoveRecursive(pCur->szPath, RTDIRRMREC_F_CONTENT_AND_DIR);
471	if (rc == VERR_DIR_NOT_EMPTY && fFinalTry)
472	rc = VINF_SUCCESS;
473	}
474	if (rc == VERR_FILE_NOT_FOUND \|\| rc == VERR_PATH_NOT_FOUND)
475	rc = VINF_SUCCESS;
476	if (RT_SUCCESS(rc))
477	{
478	RTListNodeRemove(&pCur->ListEntry);
479	RTMemFree(pCur);
480	}
481	else if (fFinalTry)
482	{
483	if (pCur->fFile)
484	ShowError("Failed to delete temporary file '%s': %Rrc", pCur->szPath, rc);
485	else
486	ShowError("Failed to delete temporary directory '%s': %Rrc", pCur->szPath, rc);
487	}
488	}
489
490	if (RTListIsEmpty(&g_TmpFiles) \|\| fFinalTry)
491	{
492	if (!pszPkgDir)
493	return;
494	rc = RTDirRemove(pszPkgDir);
495	if (RT_SUCCESS(rc) \|\| rc == VERR_FILE_NOT_FOUND \|\| rc == VERR_PATH_NOT_FOUND \|\| fFinalTry)
496	return;
497	}
498
499	/* Delay a little and try again. */
500	RTThreadSleep(i == 0 ? 100 : 3000);
501	}
502	}
503
504
505	/**
506	* Processes an MSI package.
507	*
508	* @returns Fully complained exit code.
509	* @param pszMsi The path to the MSI to process.
510	* @param pszMsiArgs Any additional installer (MSI) argument
511	* @param fLogging Whether to enable installer logging.
512	*/
513	static RTEXITCODE ProcessMsiPackage(const char pszMsi, const char pszMsiArgs, bool fLogging)
514	{
515	int rc;
516
517	/*
518	* Set UI level.
519	*/
520	INSTALLUILEVEL enmDesiredUiLevel = g_fSilent ? INSTALLUILEVEL_NONE : INSTALLUILEVEL_FULL;
521	INSTALLUILEVEL enmRet = MsiSetInternalUI(enmDesiredUiLevel, NULL);
522	if (enmRet == INSTALLUILEVEL_NOCHANGE /* means error */)
523	return ShowError("Internal error: MsiSetInternalUI failed.");
524
525	/*
526	* Enable logging?
527	*/
528	if (fLogging)
529	{
530	char szLogFile[RTPATH_MAX];
531	rc = RTStrCopy(szLogFile, sizeof(szLogFile), pszMsi);
532	if (RT_SUCCESS(rc))
533	{
534	RTPathStripFilename(szLogFile);
535	rc = RTPathAppend(szLogFile, sizeof(szLogFile), "VBoxInstallLog.txt");
536	}
537	if (RT_FAILURE(rc))
538	return ShowError("Internal error: Filename path too long.");
539
540	PRTUTF16 pwszLogFile;
541	rc = RTStrToUtf16(szLogFile, &pwszLogFile);
542	if (RT_FAILURE(rc))
543	return ShowError("RTStrToUtf16 failed on '%s': %Rrc", szLogFile, rc);
544
545	UINT uLogLevel = MsiEnableLogW(INSTALLLOGMODE_VERBOSE,
546	pwszLogFile,
547	INSTALLLOGATTRIBUTES_FLUSHEACHLINE);
548	RTUtf16Free(pwszLogFile);
549	if (uLogLevel != ERROR_SUCCESS)
550	return ShowError("MsiEnableLogW failed");
551	}
552
553	/*
554	* Initialize the common controls (extended version). This is necessary to
555	* run the actual .MSI installers with the new fancy visual control
556	* styles (XP+). Also, an integrated manifest is required.
557	*/
558	INITCOMMONCONTROLSEX ccEx;
559	ccEx.dwSize = sizeof(INITCOMMONCONTROLSEX);
560	ccEx.dwICC = ICC_LINK_CLASS \| ICC_LISTVIEW_CLASSES \| ICC_PAGESCROLLER_CLASS \|
561	ICC_PROGRESS_CLASS \| ICC_STANDARD_CLASSES \| ICC_TAB_CLASSES \| ICC_TREEVIEW_CLASSES \|
562	ICC_UPDOWN_CLASS \| ICC_USEREX_CLASSES \| ICC_WIN95_CLASSES;
563	InitCommonControlsEx(&ccEx); /* Ignore failure. */
564
565	/*
566	* Convert both strings to UTF-16 and start the installation.
567	*/
568	PRTUTF16 pwszMsi;
569	rc = RTStrToUtf16(pszMsi, &pwszMsi);
570	if (RT_FAILURE(rc))
571	return ShowError("RTStrToUtf16 failed on '%s': %Rrc", pszMsi, rc);
572	PRTUTF16 pwszMsiArgs;
573	rc = RTStrToUtf16(pszMsiArgs, &pwszMsiArgs);
574	if (RT_FAILURE(rc))
575	{
576	RTUtf16Free(pwszMsi);
577	return ShowError("RTStrToUtf16 failed on '%s': %Rrc", pszMsi, rc);
578	}
579
580	UINT uStatus = MsiInstallProductW(pwszMsi, pwszMsiArgs);
581	RTUtf16Free(pwszMsi);
582	RTUtf16Free(pwszMsiArgs);
583
584	if (uStatus == ERROR_SUCCESS)
585	return RTEXITCODE_SUCCESS;
586	if (uStatus == ERROR_SUCCESS_REBOOT_REQUIRED)
587	return RTEXITCODE_SUCCESS; /* we currently don't indicate this */
588
589	/*
590	* Installation failed. Figure out what to say.
591	*/
592	switch (uStatus)
593	{
594	case ERROR_INSTALL_USEREXIT:
595	/* Don't say anything? */
596	break;
597
598	case ERROR_INSTALL_PACKAGE_VERSION:
599	ShowError("This installation package cannot be installed by the Windows Installer service.\n"
600	"You must install a Windows service pack that contains a newer version of the Windows Installer service.");
601	break;
602
603	case ERROR_INSTALL_PLATFORM_UNSUPPORTED:
604	ShowError("This installation package is not supported on this platform.");
605	break;
606
607	default:
608	{
609	/*
610	* Try get windows to format the message.
611	*/
612	DWORD dwFormatFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER
613	\| FORMAT_MESSAGE_IGNORE_INSERTS
614	\| FORMAT_MESSAGE_FROM_SYSTEM;
615	HMODULE hModule = NULL;
616	if (uStatus >= NERR_BASE && uStatus <= MAX_NERR)
617	{
618	hModule = LoadLibraryExW(L"netmsg.dll",
619	NULL,
620	LOAD_LIBRARY_AS_DATAFILE);
621	if (hModule != NULL)
622	dwFormatFlags \|= FORMAT_MESSAGE_FROM_HMODULE;
623	}
624
625	PWSTR pwszMsg;
626	if (FormatMessageW(dwFormatFlags,
627	hModule, /* If NULL, load system stuff. */
628	uStatus,
629	MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
630	(PWSTR)&pwszMsg,
631	0,
632	NULL) > 0)
633	{
634	ShowError("Installation failed! Error: %ls", pwszMsg);
635	LocalFree(pwszMsg);
636	}
637	else /* If text lookup failed, show at least the error number. */
638	ShowError("Installation failed! Error: %u", uStatus);
639
640	if (hModule)
641	FreeLibrary(hModule);
642	break;
643	}
644	}
645
646	return RTEXITCODE_FAILURE;
647	}
648
649
650	/**
651	* Processes a package.
652	*
653	* @returns Fully complained exit code.
654	* @param iPackage The package number.
655	* @param pszPkgDir The package directory (aka extraction dir).
656	* @param pszMsiArgs Any additional installer (MSI) argument
657	* @param fLogging Whether to enable installer logging.
658	*/
659	static RTEXITCODE ProcessPackage(unsigned iPackage, const char pszPkgDir, const char pszMsiArgs, bool fLogging)
660	{
661	/*
662	* Get the package header and check if it's needed.
663	*/
664	PVBOXSTUBPKG pPackage = FindPackageHeader(iPackage);
665	if (pPackage == NULL)
666	return RTEXITCODE_FAILURE;
667
668	if (!PackageIsNeeded(pPackage))
669	return RTEXITCODE_SUCCESS;
670
671	/*
672	* Deal with the file based on it's extension.
673	*/
674	char szPkgFile[RTPATH_MAX];
675	int rc = RTPathJoin(szPkgFile, sizeof(szPkgFile), pszPkgDir, pPackage->szFileName);
676	if (RT_FAILURE(rc))
677	return ShowError("Internal error: RTPathJoin failed: %Rrc", rc);
678	RTPathChangeToDosSlashes(szPkgFile, true /* Force conversion. /); / paranoia */
679
680	RTEXITCODE rcExit;
681	const char *pszSuff = RTPathSuffix(szPkgFile);
682	if (RTStrICmp(pszSuff, ".msi") == 0)
683	rcExit = ProcessMsiPackage(szPkgFile, pszMsiArgs, fLogging);
684	else if (RTStrICmp(pszSuff, ".cab") == 0)
685	rcExit = RTEXITCODE_SUCCESS; /* Ignore .cab files, they're generally referenced by other files. */
686	else
687	rcExit = ShowError("Internal error: Do not know how to handle file '%s'.", pPackage->szFileName);
688
689	return rcExit;
690	}
691
692
693	#ifdef VBOX_WITH_CODE_SIGNING
694	/**
695	* Install the public certificate into TrustedPublishers so the installer won't
696	* prompt the user during silent installs.
697	*
698	* @returns Fully complained exit code.
699	*/
700	static RTEXITCODE InstallCertificates(void)
701	{
702	for (uint32_t i = 0; i < RT_ELEMENTS(g_aVBoxStubTrustedCerts); i++)
703	{
704	if (!addCertToStore(CERT_SYSTEM_STORE_LOCAL_MACHINE,
705	"TrustedPublisher",
706	g_aVBoxStubTrustedCerts[i].pab,
707	g_aVBoxStubTrustedCerts[i].cb))
708	return ShowError("Failed to construct install certificate.");
709	}
710	return RTEXITCODE_SUCCESS;
711	}
712	#endif /* VBOX_WITH_CODE_SIGNING */
713
714
715	/**
716	* Copies the "<exepath>.custom" directory to the extraction path if it exists.
717	*
718	* This is used by the MSI packages from the resource section.
719	*
720	* @returns Fully complained exit code.
721	* @param pszDstDir The destination directory.
722	*/
723	static RTEXITCODE CopyCustomDir(const char *pszDstDir)
724	{
725	char szSrcDir[RTPATH_MAX];
726	int rc = RTPathExecDir(szSrcDir, sizeof(szSrcDir));
727	if (RT_SUCCESS(rc))
728	rc = RTPathAppend(szSrcDir, sizeof(szSrcDir), ".custom");
729	if (RT_FAILURE(rc))
730	return ShowError("Failed to construct '.custom' dir path: %Rrc", rc);
731
732	if (RTDirExists(szSrcDir))
733	{
734	/*
735	* Use SHFileOperation w/ FO_COPY to do the job. This API requires an
736	* extra zero at the end of both source and destination paths.
737	*/
738	size_t cwc;
739	RTUTF16 wszSrcDir[RTPATH_MAX + 1];
740	PRTUTF16 pwszSrcDir = wszSrcDir;
741	rc = RTStrToUtf16Ex(szSrcDir, RTSTR_MAX, &pwszSrcDir, RTPATH_MAX, &cwc);
742	if (RT_FAILURE(rc))
743	return ShowError("RTStrToUtf16Ex failed on '%s': %Rrc", szSrcDir, rc);
744	wszSrcDir[cwc] = '\0';
745
746	RTUTF16 wszDstDir[RTPATH_MAX + 1];
747	PRTUTF16 pwszDstDir = wszSrcDir;
748	rc = RTStrToUtf16Ex(pszDstDir, RTSTR_MAX, &pwszDstDir, RTPATH_MAX, &cwc);
749	if (RT_FAILURE(rc))
750	return ShowError("RTStrToUtf16Ex failed on '%s': %Rrc", pszDstDir, rc);
751	wszDstDir[cwc] = '\0';
752
753	SHFILEOPSTRUCTW FileOp;
754	RT_ZERO(FileOp); /* paranoia */
755	FileOp.hwnd = NULL;
756	FileOp.wFunc = FO_COPY;
757	FileOp.pFrom = wszSrcDir;
758	FileOp.pTo = wszDstDir;
759	FileOp.fFlags = FOF_SILENT
760	\| FOF_NOCONFIRMATION
761	\| FOF_NOCONFIRMMKDIR
762	\| FOF_NOERRORUI;
763	FileOp.fAnyOperationsAborted = FALSE;
764	FileOp.hNameMappings = NULL;
765	FileOp.lpszProgressTitle = NULL;
766
767	rc = SHFileOperationW(&FileOp);
768	if (rc != 0) /* Not a Win32 status code! */
769	return ShowError("Copying the '.custom' dir failed: %#x", rc);
770
771	/*
772	* Add a cleanup record for recursively deleting the destination
773	* .custom directory. We should actually add this prior to calling
774	* SHFileOperationW since it may partially succeed...
775	*/
776	char *pszDstSubDir = RTPathJoinA(pszDstDir, ".custom");
777	if (!pszDstSubDir)
778	return ShowError("Out of memory!");
779	bool fRc = AddCleanupRec(pszDstSubDir, false /fFile/);
780	RTStrFree(pszDstSubDir);
781	if (!fRc)
782	return RTEXITCODE_FAILURE;
783	}
784
785	return RTEXITCODE_SUCCESS;
786	}
787
788
789	static RTEXITCODE ExtractFiles(unsigned cPackages, const char pszDstDir, bool fExtractOnly, bool pfCreatedExtractDir)
790	{
791	int rc;
792
793	/*
794	* Make sure the directory exists.
795	*/
796	*pfCreatedExtractDir = false;
797	if (!RTDirExists(pszDstDir))
798	{
799	rc = RTDirCreate(pszDstDir, 0700, 0);
800	if (RT_FAILURE(rc))
801	return ShowError("Failed to create extraction path '%s': %Rrc", pszDstDir, rc);
802	*pfCreatedExtractDir = true;
803	}
804
805	/*
806	* Extract files.
807	*/
808	for (unsigned k = 0; k < cPackages; k++)
809	{
810	PVBOXSTUBPKG pPackage = FindPackageHeader(k);
811	if (!pPackage)
812	return RTEXITCODE_FAILURE; /* Done complaining already. */
813
814	if (fExtractOnly \|\| PackageIsNeeded(pPackage))
815	{
816	char szDstFile[RTPATH_MAX];
817	rc = RTPathJoin(szDstFile, sizeof(szDstFile), pszDstDir, pPackage->szFileName);
818	if (RT_FAILURE(rc))
819	return ShowError("Internal error: RTPathJoin failed: %Rrc", rc);
820
821	rc = Extract(pPackage, szDstFile);
822	if (RT_FAILURE(rc))
823	return ShowError("Error extracting package #%u: %Rrc", k, rc);
824
825	if (!fExtractOnly && !AddCleanupRec(szDstFile, true /fFile/))
826	{
827	RTFileDelete(szDstFile);
828	return RTEXITCODE_FAILURE;
829	}
830	}
831	}
832
833	return RTEXITCODE_SUCCESS;
834	}
835
836
837	int WINAPI WinMain(HINSTANCE hInstance,
838	HINSTANCE hPrevInstance,
839	char *lpCmdLine,
840	int nCmdShow)
841	{
842	RT_NOREF(hInstance, hPrevInstance, lpCmdLine, nCmdShow);
843	char **argv = __argv;
844	int argc = __argc;
845
846	/*
847	* Init IPRT. This is _always_ the very first thing we do.
848	*/
849	int vrc = RTR3InitExe(argc, &argv, RTR3INIT_FLAGS_STANDALONE_APP);
850	if (RT_FAILURE(vrc))
851	return RTMsgInitFailure(vrc);
852
853	/*
854	* Check if we're already running and jump out if so.
855	*
856	* Note! Do not use a global namespace ("Global\\") for mutex name here,
857	* will blow up NT4 compatibility!
858	*/
859	HANDLE hMutexAppRunning = CreateMutex(NULL, FALSE, "VBoxStubInstaller");
860	if ( hMutexAppRunning != NULL
861	&& GetLastError() == ERROR_ALREADY_EXISTS)
862	{
863	/* Close the mutex for this application instance. */
864	CloseHandle(hMutexAppRunning);
865	hMutexAppRunning = NULL;
866	return RTEXITCODE_FAILURE;
867	}
868
869	/*
870	* Parse arguments.
871	*/
872
873	/* Parameter variables. */
874	bool fExtractOnly = false;
875	bool fEnableLogging = false;
876	#ifdef VBOX_WITH_CODE_SIGNING
877	bool fEnableSilentCert = true;
878	#endif
879	char szExtractPath[RTPATH_MAX] = {0};
880	char szMSIArgs[_4K] = {0};
881
882	/* Parameter definitions. */
883	static const RTGETOPTDEF s_aOptions[] =
884	{
885	/** @todo Replace short parameters with enums since they're not
886	* used (and not documented to the public). */
887	{ "--extract", 'x', RTGETOPT_REQ_NOTHING },
888	{ "-extract", 'x', RTGETOPT_REQ_NOTHING },
889	{ "/extract", 'x', RTGETOPT_REQ_NOTHING },
890	{ "--silent", 's', RTGETOPT_REQ_NOTHING },
891	{ "-silent", 's', RTGETOPT_REQ_NOTHING },
892	{ "/silent", 's', RTGETOPT_REQ_NOTHING },
893	#ifdef VBOX_WITH_CODE_SIGNING
894	{ "--no-silent-cert", 'c', RTGETOPT_REQ_NOTHING },
895	{ "-no-silent-cert", 'c', RTGETOPT_REQ_NOTHING },
896	{ "/no-silent-cert", 'c', RTGETOPT_REQ_NOTHING },
897	#endif
898	{ "--logging", 'l', RTGETOPT_REQ_NOTHING },
899	{ "-logging", 'l', RTGETOPT_REQ_NOTHING },
900	{ "/logging", 'l', RTGETOPT_REQ_NOTHING },
901	{ "--path", 'p', RTGETOPT_REQ_STRING },
902	{ "-path", 'p', RTGETOPT_REQ_STRING },
903	{ "/path", 'p', RTGETOPT_REQ_STRING },
904	{ "--msiparams", 'm', RTGETOPT_REQ_STRING },
905	{ "-msiparams", 'm', RTGETOPT_REQ_STRING },
906	{ "--reinstall", 'f', RTGETOPT_REQ_NOTHING },
907	{ "-reinstall", 'f', RTGETOPT_REQ_NOTHING },
908	{ "/reinstall", 'f', RTGETOPT_REQ_NOTHING },
909	{ "--verbose", 'v', RTGETOPT_REQ_NOTHING },
910	{ "-verbose", 'v', RTGETOPT_REQ_NOTHING },
911	{ "/verbose", 'v', RTGETOPT_REQ_NOTHING },
912	{ "--version", 'V', RTGETOPT_REQ_NOTHING },
913	{ "-version", 'V', RTGETOPT_REQ_NOTHING },
914	{ "/version", 'V', RTGETOPT_REQ_NOTHING },
915	{ "-v", 'V', RTGETOPT_REQ_NOTHING },
916	{ "--help", 'h', RTGETOPT_REQ_NOTHING },
917	{ "-help", 'h', RTGETOPT_REQ_NOTHING },
918	{ "/help", 'h', RTGETOPT_REQ_NOTHING },
919	{ "/?", 'h', RTGETOPT_REQ_NOTHING },
920	};
921
922	RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
923
924	/* Parse the parameters. */
925	int ch;
926	bool fExitEarly = false;
927	RTGETOPTUNION ValueUnion;
928	RTGETOPTSTATE GetState;
929	RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
930	while ( (ch = RTGetOpt(&GetState, &ValueUnion))
931	&& rcExit == RTEXITCODE_SUCCESS
932	&& !fExitEarly)
933	{
934	switch (ch)
935	{
936	case 'f': /* Force re-installation. */
937	if (szMSIArgs[0])
938	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs), " ");
939	if (RT_SUCCESS(vrc))
940	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs),
941	"REINSTALLMODE=vomus REINSTALL=ALL");
942	if (RT_FAILURE(vrc))
943	rcExit = ShowError("MSI parameters are too long.");
944	break;
945
946	case 'x':
947	fExtractOnly = true;
948	break;
949
950	case 's':
951	g_fSilent = true;
952	break;
953
954	#ifdef VBOX_WITH_CODE_SIGNING
955	case 'c':
956	fEnableSilentCert = false;
957	break;
958	#endif
959	case 'l':
960	fEnableLogging = true;
961	break;
962
963	case 'p':
964	vrc = RTStrCopy(szExtractPath, sizeof(szExtractPath), ValueUnion.psz);
965	if (RT_FAILURE(vrc))
966	rcExit = ShowError("Extraction path is too long.");
967	break;
968
969	case 'm':
970	if (szMSIArgs[0])
971	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs), " ");
972	if (RT_SUCCESS(vrc))
973	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs), ValueUnion.psz);
974	if (RT_FAILURE(vrc))
975	rcExit = ShowError("MSI parameters are too long.");
976	break;
977
978	case 'V':
979	ShowInfo("Version: %d.%d.%d.%d",
980	VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD,
981	VBOX_SVN_REV);
982	fExitEarly = true;
983	break;
984
985	case 'v':
986	g_iVerbosity++;
987	break;
988
989	case 'h':
990	ShowInfo("-- %s v%d.%d.%d.%d --\n"
991	"\n"
992	"Command Line Parameters:\n\n"
993	"--extract - Extract file contents to temporary directory\n"
994	"--help - Print this help and exit\n"
995	"--logging - Enables installer logging\n"
996	"--msiparams <parameters> - Specifies extra parameters for the MSI installers\n"
997	"--no-silent-cert - Do not install VirtualBox Certificate automatically when --silent option is specified\n"
998	"--path - Sets the path of the extraction directory\n"
999	"--reinstall - Forces VirtualBox to get re-installed\n"
1000	"--silent - Enables silent mode installation\n"
1001	"--version - Print version number and exit\n\n"
1002	"Examples:\n"
1003	"%s --msiparams INSTALLDIR=C:\\VBox\n"
1004	"%s --extract -path C:\\VBox",
1005	VBOX_STUB_TITLE, VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV,
1006	argv[0], argv[0]);
1007	fExitEarly = true;
1008	break;
1009
1010	case VINF_GETOPT_NOT_OPTION:
1011	/* Are (optional) MSI parameters specified and this is the last
1012	* parameter? Append everything to the MSI parameter list then. */
1013	if (szMSIArgs[0])
1014	{
1015	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs), " ");
1016	if (RT_SUCCESS(vrc))
1017	vrc = RTStrCat(szMSIArgs, sizeof(szMSIArgs), ValueUnion.psz);
1018	if (RT_FAILURE(vrc))
1019	rcExit = ShowError("MSI parameters are too long.");
1020	continue;
1021	}
1022	/* Fall through is intentional. */
1023
1024	default:
1025	if (g_fSilent)
1026	rcExit = RTGetOptPrintError(ch, &ValueUnion);
1027	if (ch == VERR_GETOPT_UNKNOWN_OPTION)
1028	rcExit = ShowError("Unknown option \"%s\"\n"
1029	"Please refer to the command line help by specifying \"/?\"\n"
1030	"to get more information.", ValueUnion.psz);
1031	else
1032	rcExit = ShowError("Parameter parsing error: %Rrc\n"
1033	"Please refer to the command line help by specifying \"/?\"\n"
1034	"to get more information.", ch);
1035	break;
1036	}
1037	}
1038
1039	/* Check if we can bail out early. */
1040	if (fExitEarly)
1041	return rcExit;
1042
1043	if (rcExit != RTEXITCODE_SUCCESS)
1044	vrc = VERR_PARSE_ERROR;
1045
1046	/** @todo
1047	*
1048	* Split the remainder up in functions and simplify the code flow!!
1049	*
1050	* */
1051
1052	#if defined(_WIN32_WINNT) && _WIN32_WINNT >= 0x0501
1053	# ifdef VBOX_STUB_WITH_OWN_CONSOLE /* Use an own console window if run in debug mode. */
1054	if ( RT_SUCCESS(vrc)
1055	&& g_iVerbosity)
1056	{
1057	if (!AllocConsole())
1058	{
1059	DWORD dwErr = GetLastError();
1060	ShowError("Unable to allocate console, error = %ld\n",
1061	dwErr);
1062
1063	/* Close the mutex for this application instance. */
1064	CloseHandle(hMutexAppRunning);
1065	hMutexAppRunning = NULL;
1066	return RTEXITCODE_FAILURE;
1067	}
1068
1069	freopen("CONOUT$", "w", stdout);
1070	setvbuf(stdout, NULL, _IONBF, 0);
1071
1072	freopen("CONOUT$", "w", stderr);
1073	}
1074	# endif /* VBOX_STUB_WITH_OWN_CONSOLE */
1075	#endif
1076
1077	if ( RT_SUCCESS(vrc)
1078	&& g_iVerbosity)
1079	{
1080	RTPrintf("Silent installation : %RTbool\n", g_fSilent);
1081	RTPrintf("Logging enabled : %RTbool\n", fEnableLogging);
1082	#ifdef VBOX_WITH_CODE_SIGNING
1083	RTPrintf("Certificate installation : %RTbool\n", fEnableSilentCert);
1084	#endif
1085	RTPrintf("Additional MSI parameters: %s\n",
1086	szMSIArgs[0] ? szMSIArgs : "<None>");
1087	}
1088
1089	if (RT_SUCCESS(vrc))
1090	{
1091	/*
1092	* Determine the extration path if not given by the user, and gather some
1093	* other bits we'll be needing later.
1094	*/
1095	if (szExtractPath[0] == '\0')
1096	{
1097	vrc = RTPathTemp(szExtractPath, sizeof(szExtractPath));
1098	if (RT_SUCCESS(vrc))
1099	vrc = RTPathAppend(szExtractPath, sizeof(szExtractPath), "VirtualBox");
1100	if (RT_FAILURE(vrc))
1101	ShowError("Failed to determine extraction path (%Rrc)", vrc);
1102
1103	}
1104	else
1105	{
1106	/** @todo should check if there is a .custom subdirectory there or not. */
1107	}
1108	RTPathChangeToDosSlashes(szExtractPath,
1109	true /* Force conversion. /); / MSI requirement. */
1110	}
1111
1112	/* Read our manifest. */
1113	if (RT_SUCCESS(vrc))
1114	{
1115	PVBOXSTUBPKGHEADER pHeader;
1116	vrc = FindData("MANIFEST", (PVOID *)&pHeader, NULL);
1117	if (RT_SUCCESS(vrc))
1118	{
1119	/** @todo If we could, we should validate the header. Only the magic isn't
1120	* commonly defined, nor the version number... */
1121
1122	RTListInit(&g_TmpFiles);
1123
1124	/*
1125	* Up to this point, we haven't done anything that requires any cleanup.
1126	* From here on, we do everything in function so we can counter clean up.
1127	*/
1128	bool fCreatedExtractDir;
1129	rcExit = ExtractFiles(pHeader->byCntPkgs, szExtractPath,
1130	fExtractOnly, &fCreatedExtractDir);
1131	if (rcExit == RTEXITCODE_SUCCESS)
1132	{
1133	if (fExtractOnly)
1134	ShowInfo("Files were extracted to: %s", szExtractPath);
1135	else
1136	{
1137	rcExit = CopyCustomDir(szExtractPath);
1138	#ifdef VBOX_WITH_CODE_SIGNING
1139	if (rcExit == RTEXITCODE_SUCCESS && fEnableSilentCert && g_fSilent)
1140	rcExit = InstallCertificates();
1141	#endif
1142	unsigned iPackage = 0;
1143	while ( iPackage < pHeader->byCntPkgs
1144	&& rcExit == RTEXITCODE_SUCCESS)
1145	{
1146	rcExit = ProcessPackage(iPackage, szExtractPath,
1147	szMSIArgs, fEnableLogging);
1148	iPackage++;
1149	}
1150
1151	/* Don't fail if cleanup fail. At least for now. */
1152	CleanUp( !fEnableLogging
1153	&& fCreatedExtractDir ? szExtractPath : NULL);
1154	}
1155	}
1156
1157	/* Free any left behind cleanup records (not strictly needed). */
1158	PSTUBCLEANUPREC pCur, pNext;
1159	RTListForEachSafe(&g_TmpFiles, pCur, pNext, STUBCLEANUPREC, ListEntry)
1160	{
1161	RTListNodeRemove(&pCur->ListEntry);
1162	RTMemFree(pCur);
1163	}
1164	}
1165	else
1166	rcExit = ShowError("Internal package error: Manifest not found (%Rrc)", vrc);
1167	}
1168
1169	#if defined(_WIN32_WINNT) && _WIN32_WINNT >= 0x0501
1170	# ifdef VBOX_STUB_WITH_OWN_CONSOLE
1171	if (g_iVerbosity)
1172	FreeConsole();
1173	# endif /* VBOX_STUB_WITH_OWN_CONSOLE */
1174	#endif
1175
1176	/*
1177	* Release instance mutex.
1178	*/
1179	if (hMutexAppRunning != NULL)
1180	{
1181	CloseHandle(hMutexAppRunning);
1182	hMutexAppRunning = NULL;
1183	}
1184
1185	return rcExit;
1186	}
1187

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Installer/win/Stub/VBoxStub.cpp@ 73097

Download in other formats: